1 // SPDX-License-Identifier: GPL-2.0-only
5 * driver for the TEWS TPCI-200 device
7 * Copyright (C) 2009-2012 CERN (www.cern.ch)
8 * Author: Nicolas Serafini, EIC2 SA
9 * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
12 #include <linux/module.h>
13 #include <linux/slab.h>
16 static const u16 tpci200_status_timeout[] = {
23 static const u16 tpci200_status_error[] = {
30 static const size_t tpci200_space_size[IPACK_SPACE_COUNT] = {
31 [IPACK_IO_SPACE] = TPCI200_IO_SPACE_SIZE,
32 [IPACK_ID_SPACE] = TPCI200_ID_SPACE_SIZE,
33 [IPACK_INT_SPACE] = TPCI200_INT_SPACE_SIZE,
34 [IPACK_MEM8_SPACE] = TPCI200_MEM8_SPACE_SIZE,
35 [IPACK_MEM16_SPACE] = TPCI200_MEM16_SPACE_SIZE,
38 static const size_t tpci200_space_interval[IPACK_SPACE_COUNT] = {
39 [IPACK_IO_SPACE] = TPCI200_IO_SPACE_INTERVAL,
40 [IPACK_ID_SPACE] = TPCI200_ID_SPACE_INTERVAL,
41 [IPACK_INT_SPACE] = TPCI200_INT_SPACE_INTERVAL,
42 [IPACK_MEM8_SPACE] = TPCI200_MEM8_SPACE_INTERVAL,
43 [IPACK_MEM16_SPACE] = TPCI200_MEM16_SPACE_INTERVAL,
46 static struct tpci200_board *check_slot(struct ipack_device *dev)
48 struct tpci200_board *tpci200;
54 tpci200 = dev_get_drvdata(dev->bus->parent);
56 if (tpci200 == NULL) {
57 dev_info(&dev->dev, "carrier board not found\n");
61 if (dev->slot >= TPCI200_NB_SLOT) {
63 "Slot [%d:%d] doesn't exist! Last tpci200 slot is %d.\n",
64 dev->bus->bus_nr, dev->slot, TPCI200_NB_SLOT-1);
71 static void tpci200_clear_mask(struct tpci200_board *tpci200,
72 __le16 __iomem *addr, u16 mask)
75 spin_lock_irqsave(&tpci200->regs_lock, flags);
76 iowrite16(ioread16(addr) & (~mask), addr);
77 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
80 static void tpci200_set_mask(struct tpci200_board *tpci200,
81 __le16 __iomem *addr, u16 mask)
84 spin_lock_irqsave(&tpci200->regs_lock, flags);
85 iowrite16(ioread16(addr) | mask, addr);
86 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
89 static void tpci200_unregister(struct tpci200_board *tpci200)
91 free_irq(tpci200->info->pdev->irq, (void *) tpci200);
93 pci_iounmap(tpci200->info->pdev, tpci200->info->interface_regs);
95 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
96 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
97 pci_release_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR);
98 pci_release_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR);
100 pci_disable_device(tpci200->info->pdev);
103 static void tpci200_enable_irq(struct tpci200_board *tpci200,
106 tpci200_set_mask(tpci200,
107 &tpci200->info->interface_regs->control[islot],
108 TPCI200_INT0_EN | TPCI200_INT1_EN);
111 static void tpci200_disable_irq(struct tpci200_board *tpci200,
114 tpci200_clear_mask(tpci200,
115 &tpci200->info->interface_regs->control[islot],
116 TPCI200_INT0_EN | TPCI200_INT1_EN);
119 static irqreturn_t tpci200_slot_irq(struct slot_irq *slot_irq)
125 ret = slot_irq->handler(slot_irq->arg);
130 static irqreturn_t tpci200_interrupt(int irq, void *dev_id)
132 struct tpci200_board *tpci200 = (struct tpci200_board *) dev_id;
133 struct slot_irq *slot_irq;
138 /* Read status register */
139 status_reg = ioread16(&tpci200->info->interface_regs->status);
141 /* Did we cause the interrupt? */
142 if (!(status_reg & TPCI200_SLOT_INT_MASK))
145 /* callback to the IRQ handler for the corresponding slot */
147 for (i = 0; i < TPCI200_NB_SLOT; i++) {
148 if (!(status_reg & ((TPCI200_A_INT0 | TPCI200_A_INT1) << (2 * i))))
150 slot_irq = rcu_dereference(tpci200->slots[i].irq);
151 ret = tpci200_slot_irq(slot_irq);
152 if (ret == -ENODEV) {
153 dev_info(&tpci200->info->pdev->dev,
154 "No registered ISR for slot [%d:%d]!. IRQ will be disabled.\n",
156 tpci200_disable_irq(tpci200, i);
164 static int tpci200_free_irq(struct ipack_device *dev)
166 struct slot_irq *slot_irq;
167 struct tpci200_board *tpci200;
169 tpci200 = check_slot(dev);
173 if (mutex_lock_interruptible(&tpci200->mutex))
176 if (tpci200->slots[dev->slot].irq == NULL) {
177 mutex_unlock(&tpci200->mutex);
181 tpci200_disable_irq(tpci200, dev->slot);
182 slot_irq = tpci200->slots[dev->slot].irq;
183 /* uninstall handler */
184 RCU_INIT_POINTER(tpci200->slots[dev->slot].irq, NULL);
187 mutex_unlock(&tpci200->mutex);
191 static int tpci200_request_irq(struct ipack_device *dev,
192 irqreturn_t (*handler)(void *), void *arg)
195 struct slot_irq *slot_irq;
196 struct tpci200_board *tpci200;
198 tpci200 = check_slot(dev);
202 if (mutex_lock_interruptible(&tpci200->mutex))
205 if (tpci200->slots[dev->slot].irq != NULL) {
207 "Slot [%d:%d] IRQ already registered !\n",
214 slot_irq = kzalloc(sizeof(struct slot_irq), GFP_KERNEL);
215 if (slot_irq == NULL) {
217 "Slot [%d:%d] unable to allocate memory for IRQ !\n",
218 dev->bus->bus_nr, dev->slot);
224 * WARNING: Setup Interrupt Vector in the IndustryPack device
225 * before an IRQ request.
226 * Read the User Manual of your IndustryPack device to know
227 * where to write the vector in memory.
229 slot_irq->handler = handler;
231 slot_irq->holder = dev;
233 rcu_assign_pointer(tpci200->slots[dev->slot].irq, slot_irq);
234 tpci200_enable_irq(tpci200, dev->slot);
237 mutex_unlock(&tpci200->mutex);
241 static int tpci200_register(struct tpci200_board *tpci200)
245 phys_addr_t ioidint_base;
246 unsigned short slot_ctrl;
248 if (pci_enable_device(tpci200->info->pdev) < 0)
251 /* Request IP interface register (Bar 2) */
252 res = pci_request_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR,
253 "Carrier IP interface registers");
255 dev_err(&tpci200->info->pdev->dev,
256 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 2 !",
257 tpci200->info->pdev->bus->number,
258 tpci200->info->pdev->devfn);
259 goto err_disable_device;
262 /* Request IO ID INT space (Bar 3) */
263 res = pci_request_region(tpci200->info->pdev,
264 TPCI200_IO_ID_INT_SPACES_BAR,
265 "Carrier IO ID INT space");
267 dev_err(&tpci200->info->pdev->dev,
268 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 3 !",
269 tpci200->info->pdev->bus->number,
270 tpci200->info->pdev->devfn);
271 goto err_ip_interface_bar;
274 /* Request MEM8 space (Bar 5) */
275 res = pci_request_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR,
276 "Carrier MEM8 space");
278 dev_err(&tpci200->info->pdev->dev,
279 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 5!",
280 tpci200->info->pdev->bus->number,
281 tpci200->info->pdev->devfn);
282 goto err_io_id_int_spaces_bar;
285 /* Request MEM16 space (Bar 4) */
286 res = pci_request_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR,
287 "Carrier MEM16 space");
289 dev_err(&tpci200->info->pdev->dev,
290 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 4!",
291 tpci200->info->pdev->bus->number,
292 tpci200->info->pdev->devfn);
293 goto err_mem8_space_bar;
296 /* Map internal tpci200 driver user space */
297 tpci200->info->interface_regs =
298 ioremap(pci_resource_start(tpci200->info->pdev,
299 TPCI200_IP_INTERFACE_BAR),
301 if (!tpci200->info->interface_regs) {
302 dev_err(&tpci200->info->pdev->dev,
303 "(bn 0x%X, sn 0x%X) failed to map driver user space!",
304 tpci200->info->pdev->bus->number,
305 tpci200->info->pdev->devfn);
307 goto err_mem16_space_bar;
310 /* Initialize lock that protects interface_regs */
311 spin_lock_init(&tpci200->regs_lock);
313 ioidint_base = pci_resource_start(tpci200->info->pdev,
314 TPCI200_IO_ID_INT_SPACES_BAR);
315 tpci200->mod_mem[IPACK_IO_SPACE] = ioidint_base + TPCI200_IO_SPACE_OFF;
316 tpci200->mod_mem[IPACK_ID_SPACE] = ioidint_base + TPCI200_ID_SPACE_OFF;
317 tpci200->mod_mem[IPACK_INT_SPACE] =
318 ioidint_base + TPCI200_INT_SPACE_OFF;
319 tpci200->mod_mem[IPACK_MEM8_SPACE] =
320 pci_resource_start(tpci200->info->pdev,
321 TPCI200_MEM8_SPACE_BAR);
322 tpci200->mod_mem[IPACK_MEM16_SPACE] =
323 pci_resource_start(tpci200->info->pdev,
324 TPCI200_MEM16_SPACE_BAR);
326 /* Set the default parameters of the slot
327 * INT0 disabled, level sensitive
328 * INT1 disabled, level sensitive
329 * error interrupt disabled
330 * timeout interrupt disabled
331 * recover time disabled
335 for (i = 0; i < TPCI200_NB_SLOT; i++)
336 writew(slot_ctrl, &tpci200->info->interface_regs->control[i]);
338 res = request_irq(tpci200->info->pdev->irq,
339 tpci200_interrupt, IRQF_SHARED,
340 KBUILD_MODNAME, (void *) tpci200);
342 dev_err(&tpci200->info->pdev->dev,
343 "(bn 0x%X, sn 0x%X) unable to register IRQ !",
344 tpci200->info->pdev->bus->number,
345 tpci200->info->pdev->devfn);
346 goto err_interface_regs;
352 pci_iounmap(tpci200->info->pdev, tpci200->info->interface_regs);
354 pci_release_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR);
356 pci_release_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR);
357 err_io_id_int_spaces_bar:
358 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
359 err_ip_interface_bar:
360 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
362 pci_disable_device(tpci200->info->pdev);
366 static int tpci200_get_clockrate(struct ipack_device *dev)
368 struct tpci200_board *tpci200 = check_slot(dev);
369 __le16 __iomem *addr;
374 addr = &tpci200->info->interface_regs->control[dev->slot];
375 return (ioread16(addr) & TPCI200_CLK32) ? 32 : 8;
378 static int tpci200_set_clockrate(struct ipack_device *dev, int mherz)
380 struct tpci200_board *tpci200 = check_slot(dev);
381 __le16 __iomem *addr;
386 addr = &tpci200->info->interface_regs->control[dev->slot];
390 tpci200_clear_mask(tpci200, addr, TPCI200_CLK32);
393 tpci200_set_mask(tpci200, addr, TPCI200_CLK32);
401 static int tpci200_get_error(struct ipack_device *dev)
403 struct tpci200_board *tpci200 = check_slot(dev);
404 __le16 __iomem *addr;
410 addr = &tpci200->info->interface_regs->status;
411 mask = tpci200_status_error[dev->slot];
412 return (ioread16(addr) & mask) ? 1 : 0;
415 static int tpci200_get_timeout(struct ipack_device *dev)
417 struct tpci200_board *tpci200 = check_slot(dev);
418 __le16 __iomem *addr;
424 addr = &tpci200->info->interface_regs->status;
425 mask = tpci200_status_timeout[dev->slot];
427 return (ioread16(addr) & mask) ? 1 : 0;
430 static int tpci200_reset_timeout(struct ipack_device *dev)
432 struct tpci200_board *tpci200 = check_slot(dev);
433 __le16 __iomem *addr;
439 addr = &tpci200->info->interface_regs->status;
440 mask = tpci200_status_timeout[dev->slot];
442 iowrite16(mask, addr);
446 static void tpci200_uninstall(struct tpci200_board *tpci200)
448 tpci200_unregister(tpci200);
449 kfree(tpci200->slots);
452 static const struct ipack_bus_ops tpci200_bus_ops = {
453 .request_irq = tpci200_request_irq,
454 .free_irq = tpci200_free_irq,
455 .get_clockrate = tpci200_get_clockrate,
456 .set_clockrate = tpci200_set_clockrate,
457 .get_error = tpci200_get_error,
458 .get_timeout = tpci200_get_timeout,
459 .reset_timeout = tpci200_reset_timeout,
462 static int tpci200_install(struct tpci200_board *tpci200)
466 tpci200->slots = kcalloc(TPCI200_NB_SLOT, sizeof(struct tpci200_slot),
468 if (tpci200->slots == NULL)
471 res = tpci200_register(tpci200);
473 kfree(tpci200->slots);
474 tpci200->slots = NULL;
478 mutex_init(&tpci200->mutex);
482 static void tpci200_release_device(struct ipack_device *dev)
487 static int tpci200_create_device(struct tpci200_board *tpci200, int i)
490 enum ipack_space space;
491 struct ipack_device *dev =
492 kzalloc(sizeof(struct ipack_device), GFP_KERNEL);
496 dev->bus = tpci200->info->ipack_bus;
497 dev->release = tpci200_release_device;
499 for (space = 0; space < IPACK_SPACE_COUNT; space++) {
500 dev->region[space].start =
501 tpci200->mod_mem[space]
502 + tpci200_space_interval[space] * i;
503 dev->region[space].size = tpci200_space_size[space];
506 ret = ipack_device_init(dev);
508 ipack_put_device(dev);
512 ret = ipack_device_add(dev);
514 ipack_put_device(dev);
519 static int tpci200_pci_probe(struct pci_dev *pdev,
520 const struct pci_device_id *id)
523 struct tpci200_board *tpci200;
526 tpci200 = kzalloc(sizeof(struct tpci200_board), GFP_KERNEL);
530 tpci200->info = kzalloc(sizeof(struct tpci200_infos), GFP_KERNEL);
531 if (!tpci200->info) {
538 /* Obtain a mapping of the carrier's PCI configuration registers */
539 ret = pci_request_region(pdev, TPCI200_CFG_MEM_BAR,
540 KBUILD_MODNAME " Configuration Memory");
542 dev_err(&pdev->dev, "Failed to allocate PCI Configuration Memory");
544 goto err_tpci200_info;
546 tpci200->info->cfg_regs = ioremap(
547 pci_resource_start(pdev, TPCI200_CFG_MEM_BAR),
548 pci_resource_len(pdev, TPCI200_CFG_MEM_BAR));
549 if (!tpci200->info->cfg_regs) {
550 dev_err(&pdev->dev, "Failed to map PCI Configuration Memory");
552 goto err_request_region;
555 /* Disable byte swapping for 16 bit IP module access. This will ensure
556 * that the Industrypack big endian byte order is preserved by the
558 reg32 = ioread32(tpci200->info->cfg_regs + LAS1_DESC);
559 reg32 |= 1 << LAS_BIT_BIGENDIAN;
560 iowrite32(reg32, tpci200->info->cfg_regs + LAS1_DESC);
562 reg32 = ioread32(tpci200->info->cfg_regs + LAS2_DESC);
563 reg32 |= 1 << LAS_BIT_BIGENDIAN;
564 iowrite32(reg32, tpci200->info->cfg_regs + LAS2_DESC);
566 /* Save struct pci_dev pointer */
567 tpci200->info->pdev = pdev;
568 tpci200->info->id_table = (struct pci_device_id *)id;
570 /* register the device and initialize it */
571 ret = tpci200_install(tpci200);
573 dev_err(&pdev->dev, "error during tpci200 install\n");
578 /* Register the carrier in the industry pack bus driver */
579 tpci200->info->ipack_bus = ipack_bus_register(&pdev->dev,
583 if (!tpci200->info->ipack_bus) {
585 "error registering the carrier on ipack driver\n");
587 goto err_tpci200_install;
590 /* save the bus number given by ipack to logging purpose */
591 tpci200->number = tpci200->info->ipack_bus->bus_nr;
592 dev_set_drvdata(&pdev->dev, tpci200);
594 for (i = 0; i < TPCI200_NB_SLOT; i++)
595 tpci200_create_device(tpci200, i);
599 tpci200_uninstall(tpci200);
601 pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
603 pci_release_region(pdev, TPCI200_CFG_MEM_BAR);
605 kfree(tpci200->info);
612 static void __tpci200_pci_remove(struct tpci200_board *tpci200)
614 ipack_bus_unregister(tpci200->info->ipack_bus);
615 tpci200_uninstall(tpci200);
617 pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
619 pci_release_region(tpci200->info->pdev, TPCI200_CFG_MEM_BAR);
621 pci_dev_put(tpci200->info->pdev);
623 kfree(tpci200->info);
627 static void tpci200_pci_remove(struct pci_dev *dev)
629 struct tpci200_board *tpci200 = pci_get_drvdata(dev);
631 __tpci200_pci_remove(tpci200);
634 static const struct pci_device_id tpci200_idtable[] = {
635 { TPCI200_VENDOR_ID, TPCI200_DEVICE_ID, TPCI200_SUBVENDOR_ID,
636 TPCI200_SUBDEVICE_ID },
640 MODULE_DEVICE_TABLE(pci, tpci200_idtable);
642 static struct pci_driver tpci200_pci_drv = {
644 .id_table = tpci200_idtable,
645 .probe = tpci200_pci_probe,
646 .remove = tpci200_pci_remove,
649 module_pci_driver(tpci200_pci_drv);
651 MODULE_DESCRIPTION("TEWS TPCI-200 device driver");
652 MODULE_LICENSE("GPL");