pcie_wb.c

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/kdev_t.h>
#include <linux/poll.h>
#include <linux/interrupt.h>
#include <linux/cdev.h>
#include <linux/aer.h>
#include <linux/sched.h>
#include <linux/version.h>
#include <linux/miscdevice.h>

#include <asm/io.h>
#include <asm/spinlock.h>
#include <asm/byteorder.h>

#include "pcie_wb.h"
#include "wishbone.h"

#if defined(__BIG_ENDIAN)
#define endian_addr(width, shift) (sizeof(wb_data_t)-width)-shift
#elif defined(__LITTLE_ENDIAN)
#define endian_addr(width, shift) shift
#else
#error "unknown machine byte order (endian)"
#endif

static unsigned int debug     = 0; /* module parameter, enable debug prints */
static unsigned int debug_irq = 0; /* module parameter, enable debug prints in irq handler*/
static unsigned int pmcintx   = 0; /* module parameter, force INTx interrupt for PCI/PMC card */

#if LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,28)

/* Missing in 2.6.28. Present in 2.6.29. */
static void compat_pci_clear_master(struct pci_dev *dev)
{
	u16 old_cmd, cmd;

	pci_read_config_word(dev, PCI_COMMAND, &old_cmd);
	cmd = old_cmd & ~PCI_COMMAND_MASTER;
	pci_write_config_word(dev, PCI_COMMAND, cmd);
	dev->is_busmaster = false;
}

/* Override with backwards compatible version */
#define pci_clear_master compat_pci_clear_master
#endif

static void pcie_int_enable(struct pcie_wb_dev *dev, int on)
{
	int enable;

	/* enable/disable interrupts for pmc device */
	if(dev->pci_dev->device == PMC_WB_DEVICE_ID){
		iowrite32((on ? 0x20000000UL:0) + 0x10000000UL, dev->pci_res[0].addr + CONTROL_REGISTER_HIGH);
		ioread32(dev->pci_res[0].addr + CONTROL_REGISTER_HIGH); /*dummy read to be sure that write was executed*/
	}
	/* enable/disable interrupts for pcie device */
	else{
		enable = on && !dev->msi;
		iowrite32((enable ? 0x20000000UL:0) + 0x10000000UL, dev->pci_res[0].addr + CONTROL_REGISTER_HIGH);
  }
}

static void wb_cycle(struct wishbone* wb, int on)
{
	struct pcie_wb_dev* dev;
	unsigned char* control;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;

	if (unlikely(debug))
		printk(KERN_ALERT PCIE_WB ": cycle(%d)\n", on);

	iowrite32((on?0x80000000UL:0) + 0x40000000UL, control + CONTROL_REGISTER_HIGH);
}

static void wb_byteenable(struct wishbone* wb, unsigned char be)
{
	struct pcie_wb_dev* dev;

	dev = container_of(wb, struct pcie_wb_dev, wb);

	switch (be) {
	case 0x1:
		dev->width = 1;
		dev->shift = 0;
		dev->low_addr = endian_addr(1, 0);
		break;
	case 0x2:
		dev->width = 1;
		dev->shift = 8;
		dev->low_addr = endian_addr(1, 1);
		break;
	case 0x4:
		dev->width = 1;
		dev->shift = 16;
		dev->low_addr = endian_addr(1, 2);
		break;
	case 0x8:
		dev->width = 1;
		dev->shift = 24;
		dev->low_addr = endian_addr(1, 3);
		break;
	case 0x3:
		dev->width = 2;
		dev->shift = 0;
		dev->low_addr = endian_addr(2, 0);
		break;
	case 0xC:
		dev->width = 2;
		dev->shift = 16;
		dev->low_addr = endian_addr(2, 2);
		break;
	case 0xF:
		dev->width = 4;
		dev->shift = 0;
		dev->low_addr = endian_addr(4, 0);
		break;
	default:
		/* noop -- ignore the strange bitmask */
		break;
	}
}

static void wb_write(struct wishbone* wb, wb_addr_t addr, wb_data_t data)
{
	struct pcie_wb_dev* dev;
	unsigned char* control;
	unsigned char* window;
	wb_addr_t window_offset;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;
	window = dev->pci_res[1].addr;

	window_offset = addr & WINDOW_HIGH;
	if (unlikely(window_offset != dev->window_offset)) {
		iowrite32(window_offset, control + WINDOW_OFFSET_LOW);
		dev->window_offset = window_offset;
	}

	switch (dev->width) {
	case 4:
		if (unlikely(debug)) printk(KERN_DEBUG PCIE_WB ": iowrite32 A:0x%08x, D:0x%08x\n", addr & ~3, data);
		iowrite32(data, window + (addr & WINDOW_LOW));
		break;
	case 2:
		if (unlikely(debug)) printk(KERN_DEBUG PCIE_WB ": iowrite16 A:0x%08x, D:0x%08x\n", (addr & ~3) + dev->low_addr, data >> dev->shift);
		iowrite16(data >> dev->shift, window + (addr & WINDOW_LOW) + dev->low_addr);
		break;
	case 1:
		if (unlikely(debug)) printk(KERN_DEBUG PCIE_WB ": iowrite8 A:0x%08x, D:0x%08x\n", (addr & ~3) + dev->low_addr, data >> dev->shift);
		iowrite8 (data >> dev->shift, window + (addr & WINDOW_LOW) + dev->low_addr);
		break;
	}
}

static wb_data_t wb_read(struct wishbone* wb, wb_addr_t addr)
{
	wb_data_t out;
	struct pcie_wb_dev* dev;
	unsigned char* control;
	unsigned char* window;
	wb_addr_t window_offset;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;
	window = dev->pci_res[1].addr;

	window_offset = addr & WINDOW_HIGH;
	if (unlikely(window_offset != dev->window_offset)) {
		iowrite32(window_offset, control + WINDOW_OFFSET_LOW);
		dev->window_offset = window_offset;
	}

	switch (dev->width) {
	case 4:
		if (unlikely(debug)) printk(KERN_ALERT PCIE_WB ": ioread32(0x%x)\n", addr & ~3);
		out = ((wb_data_t)ioread32(window + (addr & WINDOW_LOW)));
		break;
	case 2:
		if (unlikely(debug)) printk(KERN_ALERT PCIE_WB ": ioread16(0x%x)\n", (addr & ~3) + dev->low_addr);
		out = ((wb_data_t)ioread16(window + (addr & WINDOW_LOW) + dev->low_addr)) << dev->shift;
		break;
	case 1:
		if (unlikely(debug)) printk(KERN_ALERT PCIE_WB ": ioread8(0x%x)\n", (addr & ~3) + dev->low_addr);
		out = ((wb_data_t)ioread8 (window + (addr & WINDOW_LOW) + dev->low_addr)) << dev->shift;
		break;
	default: /* technically should be unreachable */
		out = 0;
		break;
	}

	mb(); /* ensure serial ordering of non-posted operations for wishbone */

	return out;
}

static wb_data_t wb_read_cfg(struct wishbone *wb, wb_addr_t addr)
{
	wb_data_t out;
	struct pcie_wb_dev* dev;
	unsigned char* control;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;

	switch (addr) {
	case 0:  out = ioread32(control + ERROR_FLAG_HIGH);   break;
	case 4:  out = ioread32(control + ERROR_FLAG_LOW);    break;
	case 8:  out = ioread32(control + SDWB_ADDRESS_HIGH); break;
	case 12: out = ioread32(control + SDWB_ADDRESS_LOW);  break;
	default: out = 0; break;
	}

	mb(); /* ensure serial ordering of non-posted operations for wishbone */

	return out;
}

static int wb_request(struct wishbone *wb, struct wishbone_request *req)
{
	struct pcie_wb_dev* dev;
	unsigned char* control;
	uint32_t ctl;
	int out;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;

	ctl        = ioread32(control + MASTER_CTL_HIGH);
	req->addr  = ioread32(control + MASTER_ADR_LOW);
	req->data  = ioread32(control + MASTER_DAT_LOW);
	req->mask  = ctl & 0xf;
	req->write = (ctl & 0x40000000) != 0;

	out = (ctl & 0x80000000) != 0;

	if (out) iowrite32(1, control + MASTER_CTL_HIGH); /* dequeue operation */

	pcie_int_enable(dev, 1);

	return out;
}

static void wb_reply(struct wishbone *wb, int err, wb_data_t data)
{
	struct pcie_wb_dev* dev;
	unsigned char* control;

	dev = container_of(wb, struct pcie_wb_dev, wb);
	control = dev->pci_res[0].addr;

	iowrite32(data, control + MASTER_DAT_LOW);
	iowrite32(err+2, control + MASTER_CTL_HIGH);
}

static const struct wishbone_operations wb_ops = {
	.owner      = THIS_MODULE,
	.cycle      = wb_cycle,
	.byteenable = wb_byteenable,
	.write      = wb_write,
	.read       = wb_read,
	.read_cfg   = wb_read_cfg,
	.request    = wb_request,
	.reply      = wb_reply,
};

static irqreturn_t irq_handler(int irq, void *dev_id)
{
	struct pcie_wb_dev *dev = dev_id;
	unsigned char* wb_conf;
	uint32_t wb_cfg_data;

	/* if card is PMC with IntX interrupts  */
	/* it is likely that irq line is shared */
	if (!(dev->msi) && (dev->pci_dev->device == PMC_WB_DEVICE_ID)){
		/* check that pmc card has requested IRQ */
		/* if it has not then exit               */
		wb_conf = dev->pci_res[2].addr;
		wb_cfg_data = ioread32(wb_conf + WB_CONF_ISR_REG);
		if (!(wb_cfg_data & WB_CONF_IRQ_STATUS_MASK)){
			return IRQ_NONE;
		}
	}

	pcie_int_enable(dev, 0); /* disable IRQ on Etherbone layer - Etherbone */
	wishbone_slave_ready(&dev->wb);

	return IRQ_HANDLED;
}

static int setup_bar(struct pci_dev* pdev, struct pcie_wb_resource* res, int bar)
{
	res->start = pci_resource_start(pdev, bar);
	res->end = pci_resource_end(pdev, bar);
	res->size = res->end - res->start + 1;

	if (debug)
		printk(KERN_INFO PCIE_WB "/BAR%d  0x%lx - 0x%lx\n", bar, res->start, res->end);

	if ((pci_resource_flags(pdev, 0) & IORESOURCE_MEM) == 0) {
		printk(KERN_ALERT PCIE_WB "/BAR%d is not a memory resource\n", bar);
		return -ENOMEM;
	}

	if (!request_mem_region(res->start, res->size, PCIE_WB)) {
		printk(KERN_ALERT PCIE_WB "/BAR%d: request_mem_region failed\n", bar);
		return -ENOMEM;
	}

	#if LINUX_VERSION_CODE < KERNEL_VERSION(5,0,0)
		res->addr = ioremap_nocache(res->start, res->size);
	#else
	#warning Using ioremap_cache (instead of ioremap_nocache)
		res->addr = ioremap_cache(res->start, res->size);
	#endif
	if (debug)
		printk(KERN_ALERT PCIE_WB "/BAR%d: ioremap to %lx\n", bar, (unsigned long)res->addr);

	return 0;
}

static void destroy_bar(struct pcie_wb_resource* res)
{
	if (debug)
		printk(KERN_ALERT "released io 0x%lx\n", res->start);

	iounmap(res->addr);
	release_mem_region(res->start, res->size);
}

static int probe(struct pci_dev *pdev, const struct pci_device_id *id)
{
	/* Do probing type stuff here.
	 * Like calling request_region();
	 * reading BARs
	 * reading IRQ
	 * register char dev
	 */
	struct pcie_wb_dev *dev;
	unsigned char* control;
	unsigned char* wb_conf;

	if(unlikely(debug)){
		printk(KERN_INFO PCIE_WB ":-----------------------------\n");
		printk(KERN_INFO PCIE_WB ": PCI Device info\n");
		printk(KERN_INFO PCIE_WB ": vendor        : %04x\n", pdev->vendor);
		printk(KERN_INFO PCIE_WB ": device        : %04x\n", pdev->device);
		printk(KERN_INFO PCIE_WB ": PCIe capable  : %04x\n", pdev->pcie_cap);
		printk(KERN_INFO PCIE_WB ": irq number    : %d\n"  , pdev->irq);
		printk(KERN_INFO PCIE_WB ":-----------------------------\n");
	}

	if (pdev->revision != 0x01) {
		printk(KERN_ALERT PCIE_WB ": revision ID wrong!\n");
		goto fail_out;
	}

	if (pci_enable_device(pdev) < 0) {
		printk(KERN_ALERT PCIE_WB ": could not enable device!\n");
		goto fail_out;
	}

	dev = kmalloc(sizeof(struct pcie_wb_dev), GFP_KERNEL);
	if (!dev) {
		printk(KERN_ALERT PCIE_WB ": could not allocate memory for pcie_wb_dev structure!\n");
		goto fail_disable;
	}

	/* Initialize structure */
	dev->pci_dev = pdev;
	dev->msi = 1;
	dev->wb.wops = &wb_ops;
	dev->wb.parent = &pdev->dev;
	dev->wb.mask = 0xffff;
	dev->window_offset = 0;
	dev->low_addr = 0;
	dev->width = 4;
	dev->shift = 0;

	pci_set_drvdata(pdev, dev);

  /* check which device is being installed: PMC or PCIe and setup bars accordingly */
	if (pdev->device == PMC_WB_DEVICE_ID) {
		printk(KERN_INFO PCIE_WB ": Requesting BARs for PMC Device : %04x:%04x\n", pdev->vendor, pdev->device);
		/* BAR1 - etherbone configuration space */
		if (setup_bar(pdev, &dev->pci_res[0], 1) < 0) goto fail_free;
		/* BAR2 - wishbone */
		if (setup_bar(pdev, &dev->pci_res[1], 2) < 0) goto fail_bar0;
		/* BAR0 -  PCI/WB bridge configuration space */
		if (setup_bar(pdev, &dev->pci_res[2], 0) < 0) goto fail_bar1;
	}
	else{
		printk(KERN_INFO PCIE_WB ": Requesting BARs for PCIe Device : %04x:%04x\n", pdev->vendor, pdev->device);
		/* BAR0 - etherbone configuration space */
		if (setup_bar(pdev, &dev->pci_res[0], 0) < 0) goto fail_free;
		/* BAR1 - wishbone */
		if (setup_bar(pdev, &dev->pci_res[1], 1) < 0) goto fail_bar0;
	}

	/* Initialize device registers */
	control = dev->pci_res[0].addr;
	iowrite32(0, control + WINDOW_OFFSET_LOW);
	iowrite32(0, control + CONTROL_REGISTER_HIGH);
	/* Configure interrupts*/
	/* configure if device is PCIe and wants MSI */
	if(pdev->device != PMC_WB_DEVICE_ID){
		if(pdev->pcie_cap && dev->msi){
			pci_set_master(pdev); /* enable bus mastering => needed for MSI */

			/* enable message signaled interrupts */
			if (pci_enable_msi(pdev) != 0) {
			/* resort to legacy interrupts if MSI enable failed*/
			printk(KERN_ALERT PCIE_WB ": Could not enable MSI interrupting (using legacy)\n");
			dev->msi = 0;
			pci_clear_master(pdev);
			pci_intx(pdev, 1); /* enable legacy INTx interrupts for PCIe device*/
			printk(KERN_INFO PCIE_WB ": Enabled legacy interrupts for PCIe Device : %04x:%04x\n", pdev->vendor, pdev->device);
		}
		else{
			/* disable legacy interrupts when using MSI */
			printk(KERN_INFO PCIE_WB ": Enabled MSI, disabling INTx interrupts for PCIe Device : %04x:%04x\n", pdev->vendor, pdev->device);
			pci_intx(pdev, 0);
			}
		}
	}
	else{
		/* configure interrupts for pmc device */
		wb_conf = dev->pci_res[2].addr;

		/* Enable INTx interrupts on PMC device */
		if(pmcintx){
			iowrite32(1, wb_conf + WB_CONF_ICR_REG); /* enable wishbone interrupts to the PCI core */
			iowrite32(0x10, control + PMC_IRQ_CONTROL); /* enable INTx interrupts to wishbone */

			dev->msi = 0;
			pci_intx(pdev, 1); /* enable INTx interrupts on PMC device */
			printk(KERN_INFO PCIE_WB ": Enabled INTx interrupts for PMC Device : %04x:%04x\n", pdev->vendor, pdev->device);
	}
	else{ /* enable MSI */
		pci_set_master(pdev); /* enable bus mastering => needed for MSI */

			/* enable message signaled interrupts */
			if (pci_enable_msi(pdev) != 0) {
				printk(KERN_ALERT PCIE_WB ": Could not enable MSI interrupting on PMC device\n");
				dev->msi = 0;
				pci_clear_master(pdev);
			}
			else{
				iowrite32(0x1, control + PMC_IRQ_CONTROL); /* enable MSI interrupts to wishbone */
			}
		}
	}

	if (wishbone_register(&dev->wb) < 0) {
		printk(KERN_ALERT PCIE_WB ": could not register wishbone bus\n");
		goto fail_msi;
	}

	if (request_irq(pdev->irq, irq_handler, IRQF_SHARED, "pcie_wb", dev) < 0) {
		printk(KERN_ALERT PCIE_WB ": could not register interrupt handler\n");
		goto fail_reg;
	}

	/* Enable interrupts from wishbone */
	pcie_int_enable(dev, 1);

  return 0;

fail_reg:
	wishbone_unregister(&dev->wb);
fail_msi:
	if (dev->msi) {
		pci_intx(pdev,0 );
		pci_disable_msi(pdev);
	}
/*fail_master:*/
	pci_clear_master(pdev);
fail_bar1:
	destroy_bar(&dev->pci_res[1]);
fail_bar0:
	destroy_bar(&dev->pci_res[0]);
fail_free:
	kfree(dev);
fail_disable:
	pci_disable_device(pdev);
fail_out:
	return -EIO;
}

static void remove(struct pci_dev *pdev)
{
	struct pcie_wb_dev *dev;

	if(unlikely(debug)){
		printk(KERN_INFO PCIE_WB ":-------------------------\n");
		printk(KERN_INFO PCIE_WB ": Removing PCI Device : \n");
		printk(KERN_INFO PCIE_WB ": vendor        : %04x\n", pdev->vendor);
		printk(KERN_INFO PCIE_WB ": device        : %04x\n", pdev->device);
		printk(KERN_INFO PCIE_WB ": PCIe capable  : %04x\n", pdev->pcie_cap);
		printk(KERN_INFO PCIE_WB ": irq number    : %d\n", pdev->irq);
		printk(KERN_INFO PCIE_WB ":-------------------------\n");
        }

        dev = pci_get_drvdata(pdev);
	/* disable/remove interrupts*/
	pcie_int_enable(dev, 0);
	free_irq(dev->pci_dev->irq, dev);
	wishbone_unregister(&dev->wb);
	if(dev->msi){
		pci_disable_msi(pdev);
		pci_clear_master(pdev);
	}else{
		pci_intx(pdev, 0);
	}

	if(pdev->device == PMC_WB_DEVICE_ID){
		destroy_bar(&dev->pci_res[2]);
  }
  destroy_bar(&dev->pci_res[1]);
	destroy_bar(&dev->pci_res[0]);
	kfree(dev);

	printk(KERN_INFO PCIE_WB ": Removed Device %04x:%04x\n", pdev->vendor, pdev->device);
	pci_disable_device(pdev);
}

static struct pci_device_id ids[] = {
	{ PCI_DEVICE(PCIE_WB_VENDOR_ID, PCIE_WB_DEVICE_ID), },
  { PCI_DEVICE(PCIE_WB_VENDOR_ID, PMC_WB_DEVICE_ID ), },
	{ 0, }
};
MODULE_DEVICE_TABLE(pci, ids);

static struct pci_driver pcie_wb_driver = {
	.name = PCIE_WB,
	.id_table = ids,
	.probe = probe,
	.remove = remove,
};

static int __init pcie_wb_init(void)
{
	return pci_register_driver(&pcie_wb_driver);
}

static void __exit pcie_wb_exit(void)
{
	pci_unregister_driver(&pcie_wb_driver);
}

MODULE_AUTHOR("Stefan Rauch <s.rauch@gsi.de> Dusan Slavinec <dusan.slavinec@cosylab.com>");
MODULE_DESCRIPTION("GSI Altera-Wishbone bridge driver");
module_param(debug, int, 0644);
MODULE_PARM_DESC(debug, "Enable debugging information");

module_param(debug_irq, int, 0644);
MODULE_PARM_DESC(debug_irq, "Enable debugging information in interrupt handler");

module_param(pmcintx, int, 0644);
MODULE_PARM_DESC(pmcintx, "Force INTx interrupt for PMC card");

MODULE_LICENSE("GPL");
MODULE_VERSION(PCIE_WB_VERSION);

module_init(pcie_wb_init);
module_exit(pcie_wb_exit);