4 * driver for the TEWS TPCI-200 device
5 * Copyright (c) 2009 Nicolas Serafini, EIC2 SA
6 * Copyright (c) 2010,2011 Samuel Iglesias Gonsalvez <siglesia@cern.ch>, CERN
7 * Copyright (c) 2012 Samuel Iglesias Gonsalvez <siglesias@igalia.com>, Igalia
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the Free
11 * Software Foundation; version 2 of the License.
14 #include <linux/module.h>
17 static u16 tpci200_status_timeout[] = {
24 static u16 tpci200_status_error[] = {
31 static struct tpci200_board *check_slot(struct ipack_device *dev)
33 struct tpci200_board *tpci200;
39 tpci200 = dev_get_drvdata(dev->bus->parent);
41 if (tpci200 == NULL) {
42 dev_info(&dev->dev, "carrier board not found\n");
46 if (dev->slot >= TPCI200_NB_SLOT) {
48 "Slot [%d:%d] doesn't exist! Last tpci200 slot is %d.\n",
49 dev->bus_nr, dev->slot, TPCI200_NB_SLOT-1);
56 static void tpci200_clear_mask(struct tpci200_board *tpci200,
57 __le16 __iomem *addr, u16 mask)
60 spin_lock_irqsave(&tpci200->regs_lock, flags);
61 iowrite16(ioread16(addr) & (~mask), addr);
62 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
65 static void tpci200_set_mask(struct tpci200_board *tpci200,
66 __le16 __iomem *addr, u16 mask)
69 spin_lock_irqsave(&tpci200->regs_lock, flags);
70 iowrite16(ioread16(addr) | mask, addr);
71 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
74 static void tpci200_unregister(struct tpci200_board *tpci200)
78 free_irq(tpci200->info->pdev->irq, (void *) tpci200);
80 pci_iounmap(tpci200->info->pdev, tpci200->info->interface_regs);
81 pci_iounmap(tpci200->info->pdev, tpci200->info->ioidint_space);
82 pci_iounmap(tpci200->info->pdev, tpci200->info->mem8_space);
83 pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
85 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
86 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
87 pci_release_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR);
88 pci_release_region(tpci200->info->pdev, TPCI200_CFG_MEM_BAR);
90 pci_disable_device(tpci200->info->pdev);
91 pci_dev_put(tpci200->info->pdev);
93 for (i = 0; i < TPCI200_NB_SLOT; i++) {
94 tpci200->slots[i].io_phys.address = NULL;
95 tpci200->slots[i].io_phys.size = 0;
96 tpci200->slots[i].id_phys.address = NULL;
97 tpci200->slots[i].id_phys.size = 0;
98 tpci200->slots[i].int_phys.address = NULL;
99 tpci200->slots[i].int_phys.size = 0;
100 tpci200->slots[i].mem_phys.address = NULL;
101 tpci200->slots[i].mem_phys.size = 0;
105 static void tpci200_enable_irq(struct tpci200_board *tpci200,
108 tpci200_set_mask(tpci200,
109 &tpci200->info->interface_regs->control[islot],
110 TPCI200_INT0_EN | TPCI200_INT1_EN);
113 static void tpci200_disable_irq(struct tpci200_board *tpci200,
116 tpci200_clear_mask(tpci200,
117 &tpci200->info->interface_regs->control[islot],
118 TPCI200_INT0_EN | TPCI200_INT1_EN);
121 static irqreturn_t tpci200_slot_irq(struct slot_irq *slot_irq)
127 ret = slot_irq->handler(slot_irq->arg);
132 static irqreturn_t tpci200_interrupt(int irq, void *dev_id)
134 struct tpci200_board *tpci200 = (struct tpci200_board *) dev_id;
135 struct slot_irq *slot_irq;
140 /* Read status register */
141 status_reg = ioread16(&tpci200->info->interface_regs->status);
143 /* Did we cause the interrupt? */
144 if (!(status_reg & TPCI200_SLOT_INT_MASK))
147 /* callback to the IRQ handler for the corresponding slot */
149 for (i = 0; i < TPCI200_NB_SLOT; i++) {
150 if (!(status_reg & ((TPCI200_A_INT0 | TPCI200_A_INT1) << (2 * i))))
152 slot_irq = rcu_dereference(tpci200->slots[i].irq);
153 ret = tpci200_slot_irq(slot_irq);
154 if (ret == -ENODEV) {
155 dev_info(&tpci200->info->pdev->dev,
156 "No registered ISR for slot [%d:%d]!. IRQ will be disabled.\n",
158 tpci200_disable_irq(tpci200, i);
166 static int tpci200_free_irq(struct ipack_device *dev)
168 struct slot_irq *slot_irq;
169 struct tpci200_board *tpci200;
171 tpci200 = check_slot(dev);
175 if (mutex_lock_interruptible(&tpci200->mutex))
178 if (tpci200->slots[dev->slot].irq == NULL) {
179 mutex_unlock(&tpci200->mutex);
183 tpci200_disable_irq(tpci200, dev->slot);
184 slot_irq = tpci200->slots[dev->slot].irq;
185 /* uninstall handler */
186 RCU_INIT_POINTER(tpci200->slots[dev->slot].irq, NULL);
189 mutex_unlock(&tpci200->mutex);
193 static int tpci200_request_irq(struct ipack_device *dev,
194 irqreturn_t (*handler)(void *), void *arg)
197 struct slot_irq *slot_irq;
198 struct tpci200_board *tpci200;
200 tpci200 = check_slot(dev);
204 if (mutex_lock_interruptible(&tpci200->mutex))
207 if (tpci200->slots[dev->slot].irq != NULL) {
209 "Slot [%d:%d] IRQ already registered !\n", dev->bus_nr,
215 slot_irq = kzalloc(sizeof(struct slot_irq), GFP_KERNEL);
216 if (slot_irq == NULL) {
218 "Slot [%d:%d] unable to allocate memory for IRQ !\n",
219 dev->bus_nr, dev->slot);
225 * WARNING: Setup Interrupt Vector in the IndustryPack device
226 * before an IRQ request.
227 * Read the User Manual of your IndustryPack device to know
228 * where to write the vector in memory.
230 slot_irq->handler = handler;
232 slot_irq->holder = dev;
234 rcu_assign_pointer(tpci200->slots[dev->slot].irq, slot_irq);
235 tpci200_enable_irq(tpci200, dev->slot);
238 mutex_unlock(&tpci200->mutex);
242 static int tpci200_register(struct tpci200_board *tpci200)
246 unsigned long ioidint_base;
247 unsigned long mem_base;
248 unsigned short slot_ctrl;
250 if (pci_enable_device(tpci200->info->pdev) < 0)
253 /* Request IP interface register (Bar 2) */
254 res = pci_request_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR,
255 "Carrier IP interface registers");
257 dev_err(&tpci200->info->pdev->dev,
258 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 2 !",
259 tpci200->info->pdev->bus->number,
260 tpci200->info->pdev->devfn);
261 goto out_disable_pci;
264 /* Request IO ID INT space (Bar 3) */
265 res = pci_request_region(tpci200->info->pdev,
266 TPCI200_IO_ID_INT_SPACES_BAR,
267 "Carrier IO ID INT space");
269 dev_err(&tpci200->info->pdev->dev,
270 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 3 !",
271 tpci200->info->pdev->bus->number,
272 tpci200->info->pdev->devfn);
273 goto out_release_ip_space;
276 /* Request MEM space (Bar 4) */
277 res = pci_request_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR,
278 "Carrier MEM space");
280 dev_err(&tpci200->info->pdev->dev,
281 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 4!",
282 tpci200->info->pdev->bus->number,
283 tpci200->info->pdev->devfn);
284 goto out_release_ioid_int_space;
287 /* Map internal tpci200 driver user space */
288 tpci200->info->interface_regs =
289 ioremap_nocache(pci_resource_start(tpci200->info->pdev,
290 TPCI200_IP_INTERFACE_BAR),
292 tpci200->info->ioidint_space =
293 ioremap_nocache(pci_resource_start(tpci200->info->pdev,
294 TPCI200_IO_ID_INT_SPACES_BAR),
295 TPCI200_IOIDINT_SIZE);
296 tpci200->info->mem8_space =
297 ioremap_nocache(pci_resource_start(tpci200->info->pdev,
298 TPCI200_MEM8_SPACE_BAR),
301 /* Initialize lock that protects interface_regs */
302 spin_lock_init(&tpci200->regs_lock);
304 ioidint_base = pci_resource_start(tpci200->info->pdev,
305 TPCI200_IO_ID_INT_SPACES_BAR);
306 mem_base = pci_resource_start(tpci200->info->pdev,
307 TPCI200_MEM8_SPACE_BAR);
309 /* Set the default parameters of the slot
310 * INT0 disabled, level sensitive
311 * INT1 disabled, level sensitive
312 * error interrupt disabled
313 * timeout interrupt disabled
314 * recover time disabled
319 /* Set all slot physical address space */
320 for (i = 0; i < TPCI200_NB_SLOT; i++) {
321 tpci200->slots[i].io_phys.address =
322 (void __iomem *)ioidint_base +
323 TPCI200_IO_SPACE_OFF + TPCI200_IO_SPACE_GAP*i;
324 tpci200->slots[i].io_phys.size = TPCI200_IO_SPACE_SIZE;
326 tpci200->slots[i].id_phys.address =
327 (void __iomem *)ioidint_base +
328 TPCI200_ID_SPACE_OFF + TPCI200_ID_SPACE_GAP*i;
329 tpci200->slots[i].id_phys.size = TPCI200_ID_SPACE_SIZE;
331 tpci200->slots[i].int_phys.address =
332 (void __iomem *)ioidint_base +
333 TPCI200_INT_SPACE_OFF + TPCI200_INT_SPACE_GAP * i;
334 tpci200->slots[i].int_phys.size = TPCI200_INT_SPACE_SIZE;
336 tpci200->slots[i].mem_phys.address =
337 (void __iomem *)mem_base + TPCI200_MEM8_GAP*i;
338 tpci200->slots[i].mem_phys.size = TPCI200_MEM8_SIZE;
340 writew(slot_ctrl, &tpci200->info->interface_regs->control[i]);
343 res = request_irq(tpci200->info->pdev->irq,
344 tpci200_interrupt, IRQF_SHARED,
345 KBUILD_MODNAME, (void *) tpci200);
347 dev_err(&tpci200->info->pdev->dev,
348 "(bn 0x%X, sn 0x%X) unable to register IRQ !",
349 tpci200->info->pdev->bus->number,
350 tpci200->info->pdev->devfn);
351 goto out_release_ioid_int_space;
356 out_release_ioid_int_space:
357 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
358 out_release_ip_space:
359 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
361 pci_disable_device(tpci200->info->pdev);
365 static int tpci200_slot_unmap_space(struct ipack_device *dev, int space)
367 struct ipack_addr_space *virt_addr_space;
368 struct tpci200_board *tpci200;
370 tpci200 = check_slot(dev);
374 if (mutex_lock_interruptible(&tpci200->mutex))
379 if (dev->io_space.address == NULL) {
381 "Slot [%d:%d] IO space not mapped !\n",
382 dev->bus_nr, dev->slot);
385 virt_addr_space = &dev->io_space;
388 if (dev->id_space.address == NULL) {
390 "Slot [%d:%d] ID space not mapped !\n",
391 dev->bus_nr, dev->slot);
394 virt_addr_space = &dev->id_space;
396 case IPACK_INT_SPACE:
397 if (dev->int_space.address == NULL) {
399 "Slot [%d:%d] INT space not mapped !\n",
400 dev->bus_nr, dev->slot);
403 virt_addr_space = &dev->int_space;
405 case IPACK_MEM_SPACE:
406 if (dev->mem_space.address == NULL) {
408 "Slot [%d:%d] MEM space not mapped !\n",
409 dev->bus_nr, dev->slot);
412 virt_addr_space = &dev->mem_space;
416 "Slot [%d:%d] space number %d doesn't exist !\n",
417 dev->bus_nr, dev->slot, space);
418 mutex_unlock(&tpci200->mutex);
422 iounmap(virt_addr_space->address);
424 virt_addr_space->address = NULL;
425 virt_addr_space->size = 0;
427 mutex_unlock(&tpci200->mutex);
431 static int tpci200_slot_map_space(struct ipack_device *dev,
432 unsigned int memory_size, int space)
435 unsigned int size_to_map;
436 void __iomem *phys_address;
437 struct ipack_addr_space *virt_addr_space;
438 struct tpci200_board *tpci200;
440 tpci200 = check_slot(dev);
444 if (mutex_lock_interruptible(&tpci200->mutex))
449 if (dev->io_space.address != NULL) {
451 "Slot [%d:%d] IO space already mapped !\n",
452 tpci200->number, dev->slot);
456 virt_addr_space = &dev->io_space;
458 phys_address = tpci200->slots[dev->slot].io_phys.address;
459 size_to_map = tpci200->slots[dev->slot].io_phys.size;
462 if (dev->id_space.address != NULL) {
464 "Slot [%d:%d] ID space already mapped !\n",
465 tpci200->number, dev->slot);
469 virt_addr_space = &dev->id_space;
471 phys_address = tpci200->slots[dev->slot].id_phys.address;
472 size_to_map = tpci200->slots[dev->slot].id_phys.size;
474 case IPACK_INT_SPACE:
475 if (dev->int_space.address != NULL) {
477 "Slot [%d:%d] INT space already mapped !\n",
478 tpci200->number, dev->slot);
482 virt_addr_space = &dev->int_space;
484 phys_address = tpci200->slots[dev->slot].int_phys.address;
485 size_to_map = tpci200->slots[dev->slot].int_phys.size;
487 case IPACK_MEM_SPACE:
488 if (dev->mem_space.address != NULL) {
490 "Slot [%d:%d] MEM space already mapped !\n",
491 tpci200->number, dev->slot);
495 virt_addr_space = &dev->mem_space;
497 if (memory_size > tpci200->slots[dev->slot].mem_phys.size) {
499 "Slot [%d:%d] request is 0x%X memory, only 0x%X available !\n",
500 dev->bus_nr, dev->slot, memory_size,
501 tpci200->slots[dev->slot].mem_phys.size);
506 phys_address = tpci200->slots[dev->slot].mem_phys.address;
507 size_to_map = memory_size;
510 dev_err(&dev->dev, "Slot [%d:%d] space %d doesn't exist !\n",
511 tpci200->number, dev->slot, space);
516 virt_addr_space->size = size_to_map;
517 virt_addr_space->address =
518 ioremap_nocache((unsigned long)phys_address, size_to_map);
521 mutex_unlock(&tpci200->mutex);
525 static int tpci200_get_clockrate(struct ipack_device *dev)
527 struct tpci200_board *tpci200 = check_slot(dev);
528 __le16 __iomem *addr;
533 addr = &tpci200->info->interface_regs->control[dev->slot];
534 return (ioread16(addr) & TPCI200_CLK32) ? 32 : 8;
537 static int tpci200_set_clockrate(struct ipack_device *dev, int mherz)
539 struct tpci200_board *tpci200 = check_slot(dev);
540 __le16 __iomem *addr;
545 addr = &tpci200->info->interface_regs->control[dev->slot];
549 tpci200_clear_mask(tpci200, addr, TPCI200_CLK32);
552 tpci200_set_mask(tpci200, addr, TPCI200_CLK32);
560 static int tpci200_get_error(struct ipack_device *dev)
562 struct tpci200_board *tpci200 = check_slot(dev);
563 __le16 __iomem *addr;
569 addr = &tpci200->info->interface_regs->status;
570 mask = tpci200_status_error[dev->slot];
571 return (ioread16(addr) & mask) ? 1 : 0;
574 static int tpci200_get_timeout(struct ipack_device *dev)
576 struct tpci200_board *tpci200 = check_slot(dev);
577 __le16 __iomem *addr;
583 addr = &tpci200->info->interface_regs->status;
584 mask = tpci200_status_timeout[dev->slot];
586 return (ioread16(addr) & mask) ? 1 : 0;
589 static int tpci200_reset_timeout(struct ipack_device *dev)
591 struct tpci200_board *tpci200 = check_slot(dev);
592 __le16 __iomem *addr;
598 addr = &tpci200->info->interface_regs->status;
599 mask = tpci200_status_timeout[dev->slot];
601 iowrite16(mask, addr);
605 static void tpci200_uninstall(struct tpci200_board *tpci200)
607 tpci200_unregister(tpci200);
608 kfree(tpci200->slots);
611 static const struct ipack_bus_ops tpci200_bus_ops = {
612 .map_space = tpci200_slot_map_space,
613 .unmap_space = tpci200_slot_unmap_space,
614 .request_irq = tpci200_request_irq,
615 .free_irq = tpci200_free_irq,
616 .get_clockrate = tpci200_get_clockrate,
617 .set_clockrate = tpci200_set_clockrate,
618 .get_error = tpci200_get_error,
619 .get_timeout = tpci200_get_timeout,
620 .reset_timeout = tpci200_reset_timeout,
623 static int tpci200_install(struct tpci200_board *tpci200)
627 tpci200->slots = kzalloc(
628 TPCI200_NB_SLOT * sizeof(struct tpci200_slot), GFP_KERNEL);
629 if (tpci200->slots == NULL)
632 res = tpci200_register(tpci200);
634 kfree(tpci200->slots);
635 tpci200->slots = NULL;
639 mutex_init(&tpci200->mutex);
643 static int tpci200_pci_probe(struct pci_dev *pdev,
644 const struct pci_device_id *id)
647 struct tpci200_board *tpci200;
650 tpci200 = kzalloc(sizeof(struct tpci200_board), GFP_KERNEL);
654 tpci200->info = kzalloc(sizeof(struct tpci200_infos), GFP_KERNEL);
655 if (!tpci200->info) {
662 /* Obtain a mapping of the carrier's PCI configuration registers */
663 ret = pci_request_region(pdev, TPCI200_CFG_MEM_BAR,
664 KBUILD_MODNAME " Configuration Memory");
666 dev_err(&pdev->dev, "Failed to allocate PCI Configuration Memory");
668 goto out_err_pci_request;
670 tpci200->info->cfg_regs = ioremap_nocache(
671 pci_resource_start(pdev, TPCI200_CFG_MEM_BAR),
672 pci_resource_len(pdev, TPCI200_CFG_MEM_BAR));
673 if (!tpci200->info->cfg_regs) {
674 dev_err(&pdev->dev, "Failed to map PCI Configuration Memory");
676 goto out_err_ioremap;
679 /* Disable byte swapping for 16 bit IP module access. This will ensure
680 * that the Industrypack big endian byte order is preserved by the
682 reg32 = ioread32(tpci200->info->cfg_regs + LAS1_DESC);
683 reg32 |= 1 << LAS_BIT_BIGENDIAN;
684 iowrite32(reg32, tpci200->info->cfg_regs + LAS1_DESC);
686 reg32 = ioread32(tpci200->info->cfg_regs + LAS2_DESC);
687 reg32 |= 1 << LAS_BIT_BIGENDIAN;
688 iowrite32(reg32, tpci200->info->cfg_regs + LAS2_DESC);
690 /* Save struct pci_dev pointer */
691 tpci200->info->pdev = pdev;
692 tpci200->info->id_table = (struct pci_device_id *)id;
694 /* register the device and initialize it */
695 ret = tpci200_install(tpci200);
697 dev_err(&pdev->dev, "error during tpci200 install\n");
699 goto out_err_install;
702 /* Register the carrier in the industry pack bus driver */
703 tpci200->info->ipack_bus = ipack_bus_register(&pdev->dev,
706 if (!tpci200->info->ipack_bus) {
708 "error registering the carrier on ipack driver\n");
710 goto out_err_bus_register;
713 /* save the bus number given by ipack to logging purpose */
714 tpci200->number = tpci200->info->ipack_bus->bus_nr;
715 dev_set_drvdata(&pdev->dev, tpci200);
717 for (i = 0; i < TPCI200_NB_SLOT; i++)
718 ipack_device_register(tpci200->info->ipack_bus, i);
721 out_err_bus_register:
722 tpci200_uninstall(tpci200);
724 iounmap(tpci200->info->cfg_regs);
726 pci_release_region(pdev, TPCI200_CFG_MEM_BAR);
729 kfree(tpci200->info);
735 static void __tpci200_pci_remove(struct tpci200_board *tpci200)
737 ipack_bus_unregister(tpci200->info->ipack_bus);
738 tpci200_uninstall(tpci200);
740 kfree(tpci200->info);
744 static void __devexit tpci200_pci_remove(struct pci_dev *dev)
746 struct tpci200_board *tpci200 = pci_get_drvdata(dev);
748 __tpci200_pci_remove(tpci200);
751 static DEFINE_PCI_DEVICE_TABLE(tpci200_idtable) = {
752 { TPCI200_VENDOR_ID, TPCI200_DEVICE_ID, TPCI200_SUBVENDOR_ID,
753 TPCI200_SUBDEVICE_ID },
757 MODULE_DEVICE_TABLE(pci, tpci200_idtable);
759 static struct pci_driver tpci200_pci_drv = {
761 .id_table = tpci200_idtable,
762 .probe = tpci200_pci_probe,
763 .remove = __devexit_p(tpci200_pci_remove),
766 static int __init tpci200_drvr_init_module(void)
768 return pci_register_driver(&tpci200_pci_drv);
771 static void __exit tpci200_drvr_exit_module(void)
773 pci_unregister_driver(&tpci200_pci_drv);
776 MODULE_DESCRIPTION("TEWS TPCI-200 device driver");
777 MODULE_LICENSE("GPL");
778 module_init(tpci200_drvr_init_module);
779 module_exit(tpci200_drvr_exit_module);