GNU Linux-libre 4.14.302-gnu1
[releases.git] / drivers / ipack / carriers / tpci200.c
1 /**
2  * tpci200.c
3  *
4  * driver for the TEWS TPCI-200 device
5  *
6  * Copyright (C) 2009-2012 CERN (www.cern.ch)
7  * Author: Nicolas Serafini, EIC2 SA
8  * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
9  *
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.
13  */
14
15 #include <linux/module.h>
16 #include <linux/slab.h>
17 #include "tpci200.h"
18
19 static const u16 tpci200_status_timeout[] = {
20         TPCI200_A_TIMEOUT,
21         TPCI200_B_TIMEOUT,
22         TPCI200_C_TIMEOUT,
23         TPCI200_D_TIMEOUT,
24 };
25
26 static const u16 tpci200_status_error[] = {
27         TPCI200_A_ERROR,
28         TPCI200_B_ERROR,
29         TPCI200_C_ERROR,
30         TPCI200_D_ERROR,
31 };
32
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,
39 };
40
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,
47 };
48
49 static struct tpci200_board *check_slot(struct ipack_device *dev)
50 {
51         struct tpci200_board *tpci200;
52
53         if (dev == NULL)
54                 return NULL;
55
56
57         tpci200 = dev_get_drvdata(dev->bus->parent);
58
59         if (tpci200 == NULL) {
60                 dev_info(&dev->dev, "carrier board not found\n");
61                 return NULL;
62         }
63
64         if (dev->slot >= TPCI200_NB_SLOT) {
65                 dev_info(&dev->dev,
66                          "Slot [%d:%d] doesn't exist! Last tpci200 slot is %d.\n",
67                          dev->bus->bus_nr, dev->slot, TPCI200_NB_SLOT-1);
68                 return NULL;
69         }
70
71         return tpci200;
72 }
73
74 static void tpci200_clear_mask(struct tpci200_board *tpci200,
75                                __le16 __iomem *addr, u16 mask)
76 {
77         unsigned long flags;
78         spin_lock_irqsave(&tpci200->regs_lock, flags);
79         iowrite16(ioread16(addr) & (~mask), addr);
80         spin_unlock_irqrestore(&tpci200->regs_lock, flags);
81 }
82
83 static void tpci200_set_mask(struct tpci200_board *tpci200,
84                              __le16 __iomem *addr, u16 mask)
85 {
86         unsigned long flags;
87         spin_lock_irqsave(&tpci200->regs_lock, flags);
88         iowrite16(ioread16(addr) | mask, addr);
89         spin_unlock_irqrestore(&tpci200->regs_lock, flags);
90 }
91
92 static void tpci200_unregister(struct tpci200_board *tpci200)
93 {
94         free_irq(tpci200->info->pdev->irq, (void *) tpci200);
95
96         pci_iounmap(tpci200->info->pdev, tpci200->info->interface_regs);
97
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);
102
103         pci_disable_device(tpci200->info->pdev);
104 }
105
106 static void tpci200_enable_irq(struct tpci200_board *tpci200,
107                                int islot)
108 {
109         tpci200_set_mask(tpci200,
110                         &tpci200->info->interface_regs->control[islot],
111                         TPCI200_INT0_EN | TPCI200_INT1_EN);
112 }
113
114 static void tpci200_disable_irq(struct tpci200_board *tpci200,
115                                 int islot)
116 {
117         tpci200_clear_mask(tpci200,
118                         &tpci200->info->interface_regs->control[islot],
119                         TPCI200_INT0_EN | TPCI200_INT1_EN);
120 }
121
122 static irqreturn_t tpci200_slot_irq(struct slot_irq *slot_irq)
123 {
124         irqreturn_t ret;
125
126         if (!slot_irq)
127                 return -ENODEV;
128         ret = slot_irq->handler(slot_irq->arg);
129
130         return ret;
131 }
132
133 static irqreturn_t tpci200_interrupt(int irq, void *dev_id)
134 {
135         struct tpci200_board *tpci200 = (struct tpci200_board *) dev_id;
136         struct slot_irq *slot_irq;
137         irqreturn_t ret;
138         u16 status_reg;
139         int i;
140
141         /* Read status register */
142         status_reg = ioread16(&tpci200->info->interface_regs->status);
143
144         /* Did we cause the interrupt? */
145         if (!(status_reg & TPCI200_SLOT_INT_MASK))
146                 return IRQ_NONE;
147
148         /* callback to the IRQ handler for the corresponding slot */
149         rcu_read_lock();
150         for (i = 0; i < TPCI200_NB_SLOT; i++) {
151                 if (!(status_reg & ((TPCI200_A_INT0 | TPCI200_A_INT1) << (2 * i))))
152                         continue;
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",
158                                  tpci200->number, i);
159                         tpci200_disable_irq(tpci200, i);
160                 }
161         }
162         rcu_read_unlock();
163
164         return IRQ_HANDLED;
165 }
166
167 static int tpci200_free_irq(struct ipack_device *dev)
168 {
169         struct slot_irq *slot_irq;
170         struct tpci200_board *tpci200;
171
172         tpci200 = check_slot(dev);
173         if (tpci200 == NULL)
174                 return -EINVAL;
175
176         if (mutex_lock_interruptible(&tpci200->mutex))
177                 return -ERESTARTSYS;
178
179         if (tpci200->slots[dev->slot].irq == NULL) {
180                 mutex_unlock(&tpci200->mutex);
181                 return -EINVAL;
182         }
183
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);
188         synchronize_rcu();
189         kfree(slot_irq);
190         mutex_unlock(&tpci200->mutex);
191         return 0;
192 }
193
194 static int tpci200_request_irq(struct ipack_device *dev,
195                                irqreturn_t (*handler)(void *), void *arg)
196 {
197         int res = 0;
198         struct slot_irq *slot_irq;
199         struct tpci200_board *tpci200;
200
201         tpci200 = check_slot(dev);
202         if (tpci200 == NULL)
203                 return -EINVAL;
204
205         if (mutex_lock_interruptible(&tpci200->mutex))
206                 return -ERESTARTSYS;
207
208         if (tpci200->slots[dev->slot].irq != NULL) {
209                 dev_err(&dev->dev,
210                         "Slot [%d:%d] IRQ already registered !\n",
211                         dev->bus->bus_nr,
212                         dev->slot);
213                 res = -EINVAL;
214                 goto out_unlock;
215         }
216
217         slot_irq = kzalloc(sizeof(struct slot_irq), GFP_KERNEL);
218         if (slot_irq == NULL) {
219                 dev_err(&dev->dev,
220                         "Slot [%d:%d] unable to allocate memory for IRQ !\n",
221                         dev->bus->bus_nr, dev->slot);
222                 res = -ENOMEM;
223                 goto out_unlock;
224         }
225
226         /*
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.
231          */
232         slot_irq->handler = handler;
233         slot_irq->arg = arg;
234         slot_irq->holder = dev;
235
236         rcu_assign_pointer(tpci200->slots[dev->slot].irq, slot_irq);
237         tpci200_enable_irq(tpci200, dev->slot);
238
239 out_unlock:
240         mutex_unlock(&tpci200->mutex);
241         return res;
242 }
243
244 static int tpci200_register(struct tpci200_board *tpci200)
245 {
246         int i;
247         int res;
248         phys_addr_t ioidint_base;
249         unsigned short slot_ctrl;
250
251         if (pci_enable_device(tpci200->info->pdev) < 0)
252                 return -ENODEV;
253
254         /* Request IP interface register (Bar 2) */
255         res = pci_request_region(tpci200->info->pdev, TPCI200_IP_INTERFACE_BAR,
256                                  "Carrier IP interface registers");
257         if (res) {
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;
263         }
264
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");
269         if (res) {
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;
275         }
276
277         /* Request MEM8 space (Bar 5) */
278         res = pci_request_region(tpci200->info->pdev, TPCI200_MEM8_SPACE_BAR,
279                                  "Carrier MEM8 space");
280         if (res) {
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;
286         }
287
288         /* Request MEM16 space (Bar 4) */
289         res = pci_request_region(tpci200->info->pdev, TPCI200_MEM16_SPACE_BAR,
290                                  "Carrier MEM16 space");
291         if (res) {
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;
297         }
298
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),
303                         TPCI200_IFACE_SIZE);
304
305         /* Initialize lock that protects interface_regs */
306         spin_lock_init(&tpci200->regs_lock);
307
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);
320
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
327          * clock rate 8 MHz
328          */
329         slot_ctrl = 0;
330         for (i = 0; i < TPCI200_NB_SLOT; i++)
331                 writew(slot_ctrl, &tpci200->info->interface_regs->control[i]);
332
333         res = request_irq(tpci200->info->pdev->irq,
334                           tpci200_interrupt, IRQF_SHARED,
335                           KBUILD_MODNAME, (void *) tpci200);
336         if (res) {
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;
342         }
343
344         return 0;
345
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);
352 out_disable_pci:
353         pci_disable_device(tpci200->info->pdev);
354         return res;
355 }
356
357 static int tpci200_get_clockrate(struct ipack_device *dev)
358 {
359         struct tpci200_board *tpci200 = check_slot(dev);
360         __le16 __iomem *addr;
361
362         if (!tpci200)
363                 return -ENODEV;
364
365         addr = &tpci200->info->interface_regs->control[dev->slot];
366         return (ioread16(addr) & TPCI200_CLK32) ? 32 : 8;
367 }
368
369 static int tpci200_set_clockrate(struct ipack_device *dev, int mherz)
370 {
371         struct tpci200_board *tpci200 = check_slot(dev);
372         __le16 __iomem *addr;
373
374         if (!tpci200)
375                 return -ENODEV;
376
377         addr = &tpci200->info->interface_regs->control[dev->slot];
378
379         switch (mherz) {
380         case 8:
381                 tpci200_clear_mask(tpci200, addr, TPCI200_CLK32);
382                 break;
383         case 32:
384                 tpci200_set_mask(tpci200, addr, TPCI200_CLK32);
385                 break;
386         default:
387                 return -EINVAL;
388         }
389         return 0;
390 }
391
392 static int tpci200_get_error(struct ipack_device *dev)
393 {
394         struct tpci200_board *tpci200 = check_slot(dev);
395         __le16 __iomem *addr;
396         u16 mask;
397
398         if (!tpci200)
399                 return -ENODEV;
400
401         addr = &tpci200->info->interface_regs->status;
402         mask = tpci200_status_error[dev->slot];
403         return (ioread16(addr) & mask) ? 1 : 0;
404 }
405
406 static int tpci200_get_timeout(struct ipack_device *dev)
407 {
408         struct tpci200_board *tpci200 = check_slot(dev);
409         __le16 __iomem *addr;
410         u16 mask;
411
412         if (!tpci200)
413                 return -ENODEV;
414
415         addr = &tpci200->info->interface_regs->status;
416         mask = tpci200_status_timeout[dev->slot];
417
418         return (ioread16(addr) & mask) ? 1 : 0;
419 }
420
421 static int tpci200_reset_timeout(struct ipack_device *dev)
422 {
423         struct tpci200_board *tpci200 = check_slot(dev);
424         __le16 __iomem *addr;
425         u16 mask;
426
427         if (!tpci200)
428                 return -ENODEV;
429
430         addr = &tpci200->info->interface_regs->status;
431         mask = tpci200_status_timeout[dev->slot];
432
433         iowrite16(mask, addr);
434         return 0;
435 }
436
437 static void tpci200_uninstall(struct tpci200_board *tpci200)
438 {
439         tpci200_unregister(tpci200);
440         kfree(tpci200->slots);
441 }
442
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,
451 };
452
453 static int tpci200_install(struct tpci200_board *tpci200)
454 {
455         int res;
456
457         tpci200->slots = kzalloc(
458                 TPCI200_NB_SLOT * sizeof(struct tpci200_slot), GFP_KERNEL);
459         if (tpci200->slots == NULL)
460                 return -ENOMEM;
461
462         res = tpci200_register(tpci200);
463         if (res) {
464                 kfree(tpci200->slots);
465                 tpci200->slots = NULL;
466                 return res;
467         }
468
469         mutex_init(&tpci200->mutex);
470         return 0;
471 }
472
473 static void tpci200_release_device(struct ipack_device *dev)
474 {
475         kfree(dev);
476 }
477
478 static int tpci200_create_device(struct tpci200_board *tpci200, int i)
479 {
480         int ret;
481         enum ipack_space space;
482         struct ipack_device *dev =
483                 kzalloc(sizeof(struct ipack_device), GFP_KERNEL);
484         if (!dev)
485                 return -ENOMEM;
486         dev->slot = i;
487         dev->bus = tpci200->info->ipack_bus;
488         dev->release = tpci200_release_device;
489
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];
495         }
496
497         ret = ipack_device_init(dev);
498         if (ret < 0) {
499                 ipack_put_device(dev);
500                 return ret;
501         }
502
503         ret = ipack_device_add(dev);
504         if (ret < 0)
505                 ipack_put_device(dev);
506
507         return ret;
508 }
509
510 static int tpci200_pci_probe(struct pci_dev *pdev,
511                              const struct pci_device_id *id)
512 {
513         int ret, i;
514         struct tpci200_board *tpci200;
515         u32 reg32;
516
517         tpci200 = kzalloc(sizeof(struct tpci200_board), GFP_KERNEL);
518         if (!tpci200)
519                 return -ENOMEM;
520
521         tpci200->info = kzalloc(sizeof(struct tpci200_infos), GFP_KERNEL);
522         if (!tpci200->info) {
523                 ret = -ENOMEM;
524                 goto err_tpci200;
525         }
526
527         pci_dev_get(pdev);
528
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");
532         if (ret) {
533                 dev_err(&pdev->dev, "Failed to allocate PCI Configuration Memory");
534                 ret = -EBUSY;
535                 goto err_tpci200_info;
536         }
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");
542                 ret = -EFAULT;
543                 goto err_request_region;
544         }
545
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
548          * carrier. */
549         reg32 = ioread32(tpci200->info->cfg_regs + LAS1_DESC);
550         reg32 |= 1 << LAS_BIT_BIGENDIAN;
551         iowrite32(reg32, tpci200->info->cfg_regs + LAS1_DESC);
552
553         reg32 = ioread32(tpci200->info->cfg_regs + LAS2_DESC);
554         reg32 |= 1 << LAS_BIT_BIGENDIAN;
555         iowrite32(reg32, tpci200->info->cfg_regs + LAS2_DESC);
556
557         /* Save struct pci_dev pointer */
558         tpci200->info->pdev = pdev;
559         tpci200->info->id_table = (struct pci_device_id *)id;
560
561         /* register the device and initialize it */
562         ret = tpci200_install(tpci200);
563         if (ret) {
564                 dev_err(&pdev->dev, "error during tpci200 install\n");
565                 ret = -ENODEV;
566                 goto err_cfg_regs;
567         }
568
569         /* Register the carrier in the industry pack bus driver */
570         tpci200->info->ipack_bus = ipack_bus_register(&pdev->dev,
571                                                       TPCI200_NB_SLOT,
572                                                       &tpci200_bus_ops,
573                                                       THIS_MODULE);
574         if (!tpci200->info->ipack_bus) {
575                 dev_err(&pdev->dev,
576                         "error registering the carrier on ipack driver\n");
577                 ret = -EFAULT;
578                 goto err_tpci200_install;
579         }
580
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);
584
585         for (i = 0; i < TPCI200_NB_SLOT; i++)
586                 tpci200_create_device(tpci200, i);
587         return 0;
588
589 err_tpci200_install:
590         tpci200_uninstall(tpci200);
591 err_cfg_regs:
592         pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
593 err_request_region:
594         pci_release_region(pdev, TPCI200_CFG_MEM_BAR);
595 err_tpci200_info:
596         kfree(tpci200->info);
597         pci_dev_put(pdev);
598 err_tpci200:
599         kfree(tpci200);
600         return ret;
601 }
602
603 static void __tpci200_pci_remove(struct tpci200_board *tpci200)
604 {
605         ipack_bus_unregister(tpci200->info->ipack_bus);
606         tpci200_uninstall(tpci200);
607
608         pci_iounmap(tpci200->info->pdev, tpci200->info->cfg_regs);
609
610         pci_release_region(tpci200->info->pdev, TPCI200_CFG_MEM_BAR);
611
612         pci_dev_put(tpci200->info->pdev);
613
614         kfree(tpci200->info);
615         kfree(tpci200);
616 }
617
618 static void tpci200_pci_remove(struct pci_dev *dev)
619 {
620         struct tpci200_board *tpci200 = pci_get_drvdata(dev);
621
622         __tpci200_pci_remove(tpci200);
623 }
624
625 static const struct pci_device_id tpci200_idtable[] = {
626         { TPCI200_VENDOR_ID, TPCI200_DEVICE_ID, TPCI200_SUBVENDOR_ID,
627           TPCI200_SUBDEVICE_ID },
628         { 0, },
629 };
630
631 MODULE_DEVICE_TABLE(pci, tpci200_idtable);
632
633 static struct pci_driver tpci200_pci_drv = {
634         .name = "tpci200",
635         .id_table = tpci200_idtable,
636         .probe = tpci200_pci_probe,
637         .remove = tpci200_pci_remove,
638 };
639
640 module_pci_driver(tpci200_pci_drv);
641
642 MODULE_DESCRIPTION("TEWS TPCI-200 device driver");
643 MODULE_LICENSE("GPL");