4 * driver for the TEWS TPCI-200 device
6 * Copyright (C) 2009-2012 CERN (www.cern.ch)
7 * Author: Nicolas Serafini, EIC2 SA
8 * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; version 2 of the License.
15 #include <linux/module.h>
16 #include <linux/slab.h>
19 static const u16 tpci200_status_timeout[] = {
26 static const u16 tpci200_status_error[] = {
33 static const size_t tpci200_space_size[IPACK_SPACE_COUNT] = {
34 [IPACK_IO_SPACE] = TPCI200_IO_SPACE_SIZE,
35 [IPACK_ID_SPACE] = TPCI200_ID_SPACE_SIZE,
36 [IPACK_INT_SPACE] = TPCI200_INT_SPACE_SIZE,
37 [IPACK_MEM8_SPACE] = TPCI200_MEM8_SPACE_SIZE,
38 [IPACK_MEM16_SPACE] = TPCI200_MEM16_SPACE_SIZE,
41 static const size_t tpci200_space_interval[IPACK_SPACE_COUNT] = {
42 [IPACK_IO_SPACE] = TPCI200_IO_SPACE_INTERVAL,
43 [IPACK_ID_SPACE] = TPCI200_ID_SPACE_INTERVAL,
44 [IPACK_INT_SPACE] = TPCI200_INT_SPACE_INTERVAL,
45 [IPACK_MEM8_SPACE] = TPCI200_MEM8_SPACE_INTERVAL,
46 [IPACK_MEM16_SPACE] = TPCI200_MEM16_SPACE_INTERVAL,
49 static struct tpci200_board *check_slot(struct ipack_device *dev)
51 struct tpci200_board *tpci200;
57 tpci200 = dev_get_drvdata(dev->bus->parent);
59 if (tpci200 == NULL) {
60 dev_info(&dev->dev, "carrier board not found\n");
64 if (dev->slot >= TPCI200_NB_SLOT) {
66 "Slot [%d:%d] doesn't exist! Last tpci200 slot is %d.\n",
67 dev->bus->bus_nr, dev->slot, TPCI200_NB_SLOT-1);
74 static void tpci200_clear_mask(struct tpci200_board *tpci200,
75 __le16 __iomem *addr, u16 mask)
78 spin_lock_irqsave(&tpci200->regs_lock, flags);
79 iowrite16(ioread16(addr) & (~mask), addr);
80 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
83 static void tpci200_set_mask(struct tpci200_board *tpci200,
84 __le16 __iomem *addr, u16 mask)
87 spin_lock_irqsave(&tpci200->regs_lock, flags);
88 iowrite16(ioread16(addr) | mask, addr);
89 spin_unlock_irqrestore(&tpci200->regs_lock, flags);
92 static void tpci200_unregister(struct tpci200_board *tpci200)
94 free_irq(tpci200->info->pdev->irq, (void *) tpci200);
96 pci_iounmap(tpci200->info->pdev, tpci200->info->interface_regs);
98 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
99 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
100 pci_release_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR);
101 pci_release_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR);
103 pci_disable_device(tpci200->info->pdev);
106 static void tpci200_enable_irq(struct tpci200_board *tpci200,
109 tpci200_set_mask(tpci200,
110 &tpci200->info->interface_regs->control[islot],
111 TPCI200_INT0_EN | TPCI200_INT1_EN);
114 static void tpci200_disable_irq(struct tpci200_board *tpci200,
117 tpci200_clear_mask(tpci200,
118 &tpci200->info->interface_regs->control[islot],
119 TPCI200_INT0_EN | TPCI200_INT1_EN);
122 static irqreturn_t tpci200_slot_irq(struct slot_irq *slot_irq)
128 ret = slot_irq->handler(slot_irq->arg);
133 static irqreturn_t tpci200_interrupt(int irq, void *dev_id)
135 struct tpci200_board *tpci200 = (struct tpci200_board *) dev_id;
136 struct slot_irq *slot_irq;
141 /* Read status register */
142 status_reg = ioread16(&tpci200->info->interface_regs->status);
144 /* Did we cause the interrupt? */
145 if (!(status_reg & TPCI200_SLOT_INT_MASK))
148 /* callback to the IRQ handler for the corresponding slot */
150 for (i = 0; i < TPCI200_NB_SLOT; i++) {
151 if (!(status_reg & ((TPCI200_A_INT0 | TPCI200_A_INT1) << (2 * i))))
153 slot_irq = rcu_dereference(tpci200->slots[i].irq);
154 ret = tpci200_slot_irq(slot_irq);
155 if (ret == -ENODEV) {
156 dev_info(&tpci200->info->pdev->dev,
157 "No registered ISR for slot [%d:%d]!. IRQ will be disabled.\n",
159 tpci200_disable_irq(tpci200, i);
167 static int tpci200_free_irq(struct ipack_device *dev)
169 struct slot_irq *slot_irq;
170 struct tpci200_board *tpci200;
172 tpci200 = check_slot(dev);
176 if (mutex_lock_interruptible(&tpci200->mutex))
179 if (tpci200->slots[dev->slot].irq == NULL) {
180 mutex_unlock(&tpci200->mutex);
184 tpci200_disable_irq(tpci200, dev->slot);
185 slot_irq = tpci200->slots[dev->slot].irq;
186 /* uninstall handler */
187 RCU_INIT_POINTER(tpci200->slots[dev->slot].irq, NULL);
190 mutex_unlock(&tpci200->mutex);
194 static int tpci200_request_irq(struct ipack_device *dev,
195 irqreturn_t (*handler)(void *), void *arg)
198 struct slot_irq *slot_irq;
199 struct tpci200_board *tpci200;
201 tpci200 = check_slot(dev);
205 if (mutex_lock_interruptible(&tpci200->mutex))
208 if (tpci200->slots[dev->slot].irq != NULL) {
210 "Slot [%d:%d] IRQ already registered !\n",
217 slot_irq = kzalloc(sizeof(struct slot_irq), GFP_KERNEL);
218 if (slot_irq == NULL) {
220 "Slot [%d:%d] unable to allocate memory for IRQ !\n",
221 dev->bus->bus_nr, dev->slot);
227 * WARNING: Setup Interrupt Vector in the IndustryPack device
228 * before an IRQ request.
229 * Read the User Manual of your IndustryPack device to know
230 * where to write the vector in memory.
232 slot_irq->handler = handler;
234 slot_irq->holder = dev;
236 rcu_assign_pointer(tpci200->slots[dev->slot].irq, slot_irq);
237 tpci200_enable_irq(tpci200, dev->slot);
240 mutex_unlock(&tpci200->mutex);
244 static int tpci200_register(struct tpci200_board *tpci200)
248 phys_addr_t ioidint_base;
249 unsigned short slot_ctrl;
251 if (pci_enable_device(tpci200->info->pdev) < 0)
254 /* Request IP interface register (Bar 2) */
255 res = pci_request_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR,
256 "Carrier IP interface registers");
258 dev_err(&tpci200->info->pdev->dev,
259 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 2 !",
260 tpci200->info->pdev->bus->number,
261 tpci200->info->pdev->devfn);
262 goto out_disable_pci;
265 /* Request IO ID INT space (Bar 3) */
266 res = pci_request_region(tpci200->info->pdev,
267 TPCI200_IO_ID_INT_SPACES_BAR,
268 "Carrier IO ID INT space");
270 dev_err(&tpci200->info->pdev->dev,
271 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 3 !",
272 tpci200->info->pdev->bus->number,
273 tpci200->info->pdev->devfn);
274 goto out_release_ip_space;
277 /* Request MEM8 space (Bar 5) */
278 res = pci_request_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR,
279 "Carrier MEM8 space");
281 dev_err(&tpci200->info->pdev->dev,
282 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 5!",
283 tpci200->info->pdev->bus->number,
284 tpci200->info->pdev->devfn);
285 goto out_release_ioid_int_space;
288 /* Request MEM16 space (Bar 4) */
289 res = pci_request_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR,
290 "Carrier MEM16 space");
292 dev_err(&tpci200->info->pdev->dev,
293 "(bn 0x%X, sn 0x%X) failed to allocate PCI resource for BAR 4!",
294 tpci200->info->pdev->bus->number,
295 tpci200->info->pdev->devfn);
296 goto out_release_mem8_space;
299 /* Map internal tpci200 driver user space */
300 tpci200->info->interface_regs =
301 ioremap_nocache(pci_resource_start(tpci200->info->pdev,
302 TPCI200_IP_INTERFACE_BAR),
305 /* Initialize lock that protects interface_regs */
306 spin_lock_init(&tpci200->regs_lock);
308 ioidint_base = pci_resource_start(tpci200->info->pdev,
309 TPCI200_IO_ID_INT_SPACES_BAR);
310 tpci200->mod_mem[IPACK_IO_SPACE] = ioidint_base + TPCI200_IO_SPACE_OFF;
311 tpci200->mod_mem[IPACK_ID_SPACE] = ioidint_base + TPCI200_ID_SPACE_OFF;
312 tpci200->mod_mem[IPACK_INT_SPACE] =
313 ioidint_base + TPCI200_INT_SPACE_OFF;
314 tpci200->mod_mem[IPACK_MEM8_SPACE] =
315 pci_resource_start(tpci200->info->pdev,
316 TPCI200_MEM8_SPACE_BAR);
317 tpci200->mod_mem[IPACK_MEM16_SPACE] =
318 pci_resource_start(tpci200->info->pdev,
319 TPCI200_MEM16_SPACE_BAR);
321 /* Set the default parameters of the slot
322 * INT0 disabled, level sensitive
323 * INT1 disabled, level sensitive
324 * error interrupt disabled
325 * timeout interrupt disabled
326 * recover time disabled
330 for (i = 0; i < TPCI200_NB_SLOT; i++)
331 writew(slot_ctrl, &tpci200->info->interface_regs->control[i]);
333 res = request_irq(tpci200->info->pdev->irq,
334 tpci200_interrupt, IRQF_SHARED,
335 KBUILD_MODNAME, (void *) tpci200);
337 dev_err(&tpci200->info->pdev->dev,
338 "(bn 0x%X, sn 0x%X) unable to register IRQ !",
339 tpci200->info->pdev->bus->number,
340 tpci200->info->pdev->devfn);
341 goto out_release_ioid_int_space;
346 out_release_mem8_space:
347 pci_release_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR);
348 out_release_ioid_int_space:
349 pci_release_region(tpci200->info->pdev, TPCI200_IO_ID_INT_SPACES_BAR);
350 out_release_ip_space:
351 pci_release_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR);
353 pci_disable_device(tpci200->info->pdev);
357 static int tpci200_get_clockrate(struct ipack_device *dev)
359 struct tpci200_board *tpci200 = check_slot(dev);
360 __le16 __iomem *addr;
365 addr = &tpci200->info->interface_regs->control[dev->slot];
366 return (ioread16(addr) & TPCI200_CLK32) ? 32 : 8;
369 static int tpci200_set_clockrate(struct ipack_device *dev, int mherz)
371 struct tpci200_board *tpci200 = check_slot(dev);
372 __le16 __iomem *addr;
377 addr = &tpci200->info->interface_regs->control[dev->slot];
381 tpci200_clear_mask(tpci200, addr, TPCI200_CLK32);
384 tpci200_set_mask(tpci200, addr, TPCI200_CLK32);
392 static int tpci200_get_error(struct ipack_device *dev)
394 struct tpci200_board *tpci200 = check_slot(dev);
395 __le16 __iomem *addr;
401 addr = &tpci200->info->interface_regs->status;
402 mask = tpci200_status_error[dev->slot];
403 return (ioread16(addr) & mask) ? 1 : 0;
406 static int tpci200_get_timeout(struct ipack_device *dev)
408 struct tpci200_board *tpci200 = check_slot(dev);
409 __le16 __iomem *addr;
415 addr = &tpci200->info->interface_regs->status;
416 mask = tpci200_status_timeout[dev->slot];
418 return (ioread16(addr) & mask) ? 1 : 0;
421 static int tpci200_reset_timeout(struct ipack_device *dev)
423 struct tpci200_board *tpci200 = check_slot(dev);
424 __le16 __iomem *addr;
430 addr = &tpci200->info->interface_regs->status;
431 mask = tpci200_status_timeout[dev->slot];
433 iowrite16(mask, addr);
437 static void tpci200_uninstall(struct tpci200_board *tpci200)
439 tpci200_unregister(tpci200);
440 kfree(tpci200->slots);
443 static const struct ipack_bus_ops tpci200_bus_ops = {
444 .request_irq = tpci200_request_irq,
445 .free_irq = tpci200_free_irq,
446 .get_clockrate = tpci200_get_clockrate,
447 .set_clockrate = tpci200_set_clockrate,
448 .get_error = tpci200_get_error,
449 .get_timeout = tpci200_get_timeout,
450 .reset_timeout = tpci200_reset_timeout,
453 static int tpci200_install(struct tpci200_board *tpci200)
457 tpci200->slots = kzalloc(
458 TPCI200_NB_SLOT * sizeof(struct tpci200_slot), GFP_KERNEL);
459 if (tpci200->slots == NULL)
462 res = tpci200_register(tpci200);
464 kfree(tpci200->slots);
465 tpci200->slots = NULL;
469 mutex_init(&tpci200->mutex);
473 static void tpci200_release_device(struct ipack_device *dev)
478 static int tpci200_create_device(struct tpci200_board *tpci200, int i)
481 enum ipack_space space;
482 struct ipack_device *dev =
483 kzalloc(sizeof(struct ipack_device), GFP_KERNEL);
487 dev->bus = tpci200->info->ipack_bus;
488 dev->release = tpci200_release_device;
490 for (space = 0; space < IPACK_SPACE_COUNT; space++) {
491 dev->region[space].start =
492 tpci200->mod_mem[space]
493 + tpci200_space_interval[space] * i;
494 dev->region[space].size = tpci200_space_size[space];
497 ret = ipack_device_init(dev);
499 ipack_put_device(dev);
503 ret = ipack_device_add(dev);
505 ipack_put_device(dev);
510 static int tpci200_pci_probe(struct pci_dev *pdev,
511 const struct pci_device_id *id)
514 struct tpci200_board *tpci200;
517 tpci200 = kzalloc(sizeof(struct tpci200_board), GFP_KERNEL);
521 tpci200->info = kzalloc(sizeof(struct tpci200_infos), GFP_KERNEL);
522 if (!tpci200->info) {
529 /* Obtain a mapping of the carrier's PCI configuration registers */
530 ret = pci_request_region(pdev, TPCI200_CFG_MEM_BAR,
531 KBUILD_MODNAME " Configuration Memory");
533 dev_err(&pdev->dev, "Failed to allocate PCI Configuration Memory");
535 goto err_tpci200_info;
537 tpci200->info->cfg_regs = ioremap_nocache(
538 pci_resource_start(pdev, TPCI200_CFG_MEM_BAR),
539 pci_resource_len(pdev, TPCI200_CFG_MEM_BAR));
540 if (!tpci200->info->cfg_regs) {
541 dev_err(&pdev->dev, "Failed to map PCI Configuration Memory");
543 goto err_request_region;
546 /* Disable byte swapping for 16 bit IP module access. This will ensure
547 * that the Industrypack big endian byte order is preserved by the
549 reg32 = ioread32(tpci200->info->cfg_regs + LAS1_DESC);
550 reg32 |= 1 << LAS_BIT_BIGENDIAN;
551 iowrite32(reg32, tpci200->info->cfg_regs + LAS1_DESC);
553 reg32 = ioread32(tpci200->info->cfg_regs + LAS2_DESC);
554 reg32 |= 1 << LAS_BIT_BIGENDIAN;
555 iowrite32(reg32, tpci200->info->cfg_regs + LAS2_DESC);
557 /* Save struct pci_dev pointer */
558 tpci200->info->pdev = pdev;
559 tpci200->info->id_table = (struct pci_device_id *)id;
561 /* register the device and initialize it */
562 ret = tpci200_install(tpci200);
564 dev_err(&pdev->dev, "error during tpci200 install\n");
569 /* Register the carrier in the industry pack bus driver */
570 tpci200->info->ipack_bus = ipack_bus_register(&pdev->dev,
574 if (!tpci200->info->ipack_bus) {
576 "error registering the carrier on ipack driver\n");
578 goto err_tpci200_install;
581 /* save the bus number given by ipack to logging purpose */
582 tpci200->number = tpci200->info->ipack_bus->bus_nr;
583 dev_set_drvdata(&pdev->dev, tpci200);
585 for (i = 0; i < TPCI200_NB_SLOT; i++)
586 tpci200_create_device(tpci200, i);
590 tpci200_uninstall(tpci200);
592 pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
594 pci_release_region(pdev, TPCI200_CFG_MEM_BAR);
596 kfree(tpci200->info);
603 static void __tpci200_pci_remove(struct tpci200_board *tpci200)
605 ipack_bus_unregister(tpci200->info->ipack_bus);
606 tpci200_uninstall(tpci200);
608 pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
610 pci_release_region(tpci200->info->pdev, TPCI200_CFG_MEM_BAR);
612 pci_dev_put(tpci200->info->pdev);
614 kfree(tpci200->info);
618 static void tpci200_pci_remove(struct pci_dev *dev)
620 struct tpci200_board *tpci200 = pci_get_drvdata(dev);
622 __tpci200_pci_remove(tpci200);
625 static const struct pci_device_id tpci200_idtable[] = {
626 { TPCI200_VENDOR_ID, TPCI200_DEVICE_ID, TPCI200_SUBVENDOR_ID,
627 TPCI200_SUBDEVICE_ID },
631 MODULE_DEVICE_TABLE(pci, tpci200_idtable);
633 static struct pci_driver tpci200_pci_drv = {
635 .id_table = tpci200_idtable,
636 .probe = tpci200_pci_probe,
637 .remove = tpci200_pci_remove,
640 module_pci_driver(tpci200_pci_drv);
642 MODULE_DESCRIPTION("TEWS TPCI-200 device driver");
643 MODULE_LICENSE("GPL");