igb_uio: fix interrupt enablement after FLR in VM
[dpdk.git] / lib / librte_eal / linuxapp / igb_uio / igb_uio.c
1 /*-
2  * GPL LICENSE SUMMARY
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of version 2 of the GNU General Public License as
8  *   published by the Free Software Foundation.
9  *
10  *   This program is distributed in the hope that it will be useful, but
11  *   WITHOUT ANY WARRANTY; without even the implied warranty of
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *   General Public License for more details.
14  *
15  *   You should have received a copy of the GNU General Public License
16  *   along with this program; if not, write to the Free Software
17  *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18  *   The full GNU General Public License is included in this distribution
19  *   in the file called LICENSE.GPL.
20  *
21  *   Contact Information:
22  *   Intel Corporation
23  */
24
25 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
26
27 #include <linux/device.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/uio_driver.h>
31 #include <linux/io.h>
32 #include <linux/irq.h>
33 #include <linux/msi.h>
34 #include <linux/version.h>
35 #include <linux/slab.h>
36
37 #include <rte_pci_dev_features.h>
38
39 #include "compat.h"
40
41 /**
42  * A structure describing the private information for a uio device.
43  */
44 struct rte_uio_pci_dev {
45         struct uio_info info;
46         struct pci_dev *pdev;
47         enum rte_intr_mode mode;
48 };
49
50 static char *intr_mode;
51 static enum rte_intr_mode igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
52 /* sriov sysfs */
53 static ssize_t
54 show_max_vfs(struct device *dev, struct device_attribute *attr,
55              char *buf)
56 {
57         return snprintf(buf, 10, "%u\n", dev_num_vf(dev));
58 }
59
60 static ssize_t
61 store_max_vfs(struct device *dev, struct device_attribute *attr,
62               const char *buf, size_t count)
63 {
64         int err = 0;
65         unsigned long max_vfs;
66         struct pci_dev *pdev = to_pci_dev(dev);
67
68         if (0 != kstrtoul(buf, 0, &max_vfs))
69                 return -EINVAL;
70
71         if (0 == max_vfs)
72                 pci_disable_sriov(pdev);
73         else if (0 == pci_num_vf(pdev))
74                 err = pci_enable_sriov(pdev, max_vfs);
75         else /* do nothing if change max_vfs number */
76                 err = -EINVAL;
77
78         return err ? err : count;
79 }
80
81 static DEVICE_ATTR(max_vfs, S_IRUGO | S_IWUSR, show_max_vfs, store_max_vfs);
82
83 static struct attribute *dev_attrs[] = {
84         &dev_attr_max_vfs.attr,
85         NULL,
86 };
87
88 static const struct attribute_group dev_attr_grp = {
89         .attrs = dev_attrs,
90 };
91
92 #ifndef HAVE_PCI_MSI_MASK_IRQ
93 /*
94  * It masks the msix on/off of generating MSI-X messages.
95  */
96 static void
97 igbuio_msix_mask_irq(struct msi_desc *desc, s32 state)
98 {
99         u32 mask_bits = desc->masked;
100         unsigned int offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
101                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
102
103         if (state != 0)
104                 mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
105         else
106                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
107
108         if (mask_bits != desc->masked) {
109                 writel(mask_bits, desc->mask_base + offset);
110                 readl(desc->mask_base);
111                 desc->masked = mask_bits;
112         }
113 }
114
115 /*
116  * It masks the msi on/off of generating MSI messages.
117  */
118 static void
119 igbuio_msi_mask_irq(struct pci_dev *pdev, struct msi_desc *desc, int32_t state)
120 {
121         u32 mask_bits = desc->masked;
122         u32 offset = desc->irq - pdev->irq;
123         u32 mask = 1 << offset;
124
125         if (!desc->msi_attrib.maskbit)
126                 return;
127
128         if (state != 0)
129                 mask_bits &= ~mask;
130         else
131                 mask_bits |= mask;
132
133         if (mask_bits != desc->masked) {
134                 pci_write_config_dword(pdev, desc->mask_pos, mask_bits);
135                 desc->masked = mask_bits;
136         }
137 }
138
139 static void
140 igbuio_mask_irq(struct pci_dev *pdev, enum rte_intr_mode mode, s32 irq_state)
141 {
142         struct msi_desc *desc;
143         struct list_head *msi_list;
144
145 #ifdef HAVE_MSI_LIST_IN_GENERIC_DEVICE
146         msi_list = &pdev->dev.msi_list;
147 #else
148         msi_list = &pdev->msi_list;
149 #endif
150
151         if (mode == RTE_INTR_MODE_MSIX) {
152                 list_for_each_entry(desc, msi_list, list)
153                         igbuio_msix_mask_irq(desc, irq_state);
154         } else if (mode == RTE_INTR_MODE_MSI) {
155                 list_for_each_entry(desc, msi_list, list)
156                         igbuio_msi_mask_irq(pdev, desc, irq_state);
157         }
158 }
159 #endif
160
161 /**
162  * This is the irqcontrol callback to be registered to uio_info.
163  * It can be used to disable/enable interrupt from user space processes.
164  *
165  * @param info
166  *  pointer to uio_info.
167  * @param irq_state
168  *  state value. 1 to enable interrupt, 0 to disable interrupt.
169  *
170  * @return
171  *  - On success, 0.
172  *  - On failure, a negative value.
173  */
174 static int
175 igbuio_pci_irqcontrol(struct uio_info *info, s32 irq_state)
176 {
177         struct rte_uio_pci_dev *udev = info->priv;
178         struct pci_dev *pdev = udev->pdev;
179
180 #ifdef HAVE_PCI_MSI_MASK_IRQ
181         struct irq_data *irq = irq_get_irq_data(udev->info.irq);
182 #endif
183
184         pci_cfg_access_lock(pdev);
185
186         if (udev->mode == RTE_INTR_MODE_MSIX || udev->mode == RTE_INTR_MODE_MSI) {
187 #ifdef HAVE_PCI_MSI_MASK_IRQ
188                 if (irq_state == 1)
189                         pci_msi_unmask_irq(irq);
190                 else
191                         pci_msi_mask_irq(irq);
192 #else
193                 igbuio_mask_irq(pdev, udev->mode, irq_state);
194 #endif
195         }
196
197         if (udev->mode == RTE_INTR_MODE_LEGACY)
198                 pci_intx(pdev, !!irq_state);
199
200         pci_cfg_access_unlock(pdev);
201
202         return 0;
203 }
204
205 /**
206  * This is interrupt handler which will check if the interrupt is for the right device.
207  * If yes, disable it here and will be enable later.
208  */
209 static irqreturn_t
210 igbuio_pci_irqhandler(int irq, void *dev_id)
211 {
212         struct uio_device *idev = (struct uio_device *)dev_id;
213         struct uio_info *info = idev->info;
214         struct rte_uio_pci_dev *udev = info->priv;
215
216         /* Legacy mode need to mask in hardware */
217         if (udev->mode == RTE_INTR_MODE_LEGACY &&
218             !pci_check_and_mask_intx(udev->pdev))
219                 return IRQ_NONE;
220
221         uio_event_notify(info);
222
223         /* Message signal mode, no share IRQ and automasked */
224         return IRQ_HANDLED;
225 }
226
227 static int
228 igbuio_pci_enable_interrupts(struct rte_uio_pci_dev *udev)
229 {
230         int err = 0;
231 #ifndef HAVE_ALLOC_IRQ_VECTORS
232         struct msix_entry msix_entry;
233 #endif
234
235         switch (igbuio_intr_mode_preferred) {
236         case RTE_INTR_MODE_MSIX:
237                 /* Only 1 msi-x vector needed */
238 #ifndef HAVE_ALLOC_IRQ_VECTORS
239                 msix_entry.entry = 0;
240                 if (pci_enable_msix(udev->pdev, &msix_entry, 1) == 0) {
241                         dev_dbg(&udev->pdev->dev, "using MSI-X");
242                         udev->info.irq_flags = IRQF_NO_THREAD;
243                         udev->info.irq = msix_entry.vector;
244                         udev->mode = RTE_INTR_MODE_MSIX;
245                         break;
246                 }
247 #else
248                 if (pci_alloc_irq_vectors(udev->pdev, 1, 1, PCI_IRQ_MSIX) == 1) {
249                         dev_dbg(&udev->pdev->dev, "using MSI-X");
250                         udev->info.irq_flags = IRQF_NO_THREAD;
251                         udev->info.irq = pci_irq_vector(udev->pdev, 0);
252                         udev->mode = RTE_INTR_MODE_MSIX;
253                         break;
254                 }
255 #endif
256
257         /* fall back to MSI */
258         case RTE_INTR_MODE_MSI:
259 #ifndef HAVE_ALLOC_IRQ_VECTORS
260                 if (pci_enable_msi(udev->pdev) == 0) {
261                         dev_dbg(&udev->pdev->dev, "using MSI");
262                         udev->info.irq_flags = IRQF_NO_THREAD;
263                         udev->info.irq = udev->pdev->irq;
264                         udev->mode = RTE_INTR_MODE_MSI;
265                         break;
266                 }
267 #else
268                 if (pci_alloc_irq_vectors(udev->pdev, 1, 1, PCI_IRQ_MSI) == 1) {
269                         dev_dbg(&udev->pdev->dev, "using MSI");
270                         udev->info.irq_flags = IRQF_NO_THREAD;
271                         udev->info.irq = pci_irq_vector(udev->pdev, 0);
272                         udev->mode = RTE_INTR_MODE_MSI;
273                         break;
274                 }
275 #endif
276         /* fall back to INTX */
277         case RTE_INTR_MODE_LEGACY:
278                 if (pci_intx_mask_supported(udev->pdev)) {
279                         dev_dbg(&udev->pdev->dev, "using INTX");
280                         udev->info.irq_flags = IRQF_SHARED | IRQF_NO_THREAD;
281                         udev->info.irq = udev->pdev->irq;
282                         udev->mode = RTE_INTR_MODE_LEGACY;
283                         break;
284                 }
285                 dev_notice(&udev->pdev->dev, "PCI INTX mask not supported\n");
286         /* fall back to no IRQ */
287         case RTE_INTR_MODE_NONE:
288                 udev->mode = RTE_INTR_MODE_NONE;
289                 udev->info.irq = UIO_IRQ_NONE;
290                 break;
291
292         default:
293                 dev_err(&udev->pdev->dev, "invalid IRQ mode %u",
294                         igbuio_intr_mode_preferred);
295                 udev->info.irq = UIO_IRQ_NONE;
296                 err = -EINVAL;
297         }
298
299         if (udev->info.irq != UIO_IRQ_NONE)
300                 err = request_irq(udev->info.irq, igbuio_pci_irqhandler,
301                                   udev->info.irq_flags, udev->info.name,
302                                   udev->info.uio_dev);
303         dev_info(&udev->pdev->dev, "uio device registered with irq %lx\n",
304                  udev->info.irq);
305
306         return err;
307 }
308
309 static void
310 igbuio_pci_disable_interrupts(struct rte_uio_pci_dev *udev)
311 {
312         if (udev->info.irq) {
313                 free_irq(udev->info.irq, udev->info.uio_dev);
314                 udev->info.irq = 0;
315         }
316
317 #ifndef HAVE_ALLOC_IRQ_VECTORS
318         if (udev->mode == RTE_INTR_MODE_MSIX)
319                 pci_disable_msix(udev->pdev);
320         if (udev->mode == RTE_INTR_MODE_MSI)
321                 pci_disable_msi(udev->pdev);
322 #else
323         if (udev->mode == RTE_INTR_MODE_MSIX ||
324             udev->mode == RTE_INTR_MODE_MSI)
325                 pci_free_irq_vectors(udev->pdev);
326 #endif
327 }
328
329
330 /**
331  * This gets called while opening uio device file.
332  */
333 static int
334 igbuio_pci_open(struct uio_info *info, struct inode *inode)
335 {
336         struct rte_uio_pci_dev *udev = info->priv;
337         struct pci_dev *dev = udev->pdev;
338         int err;
339
340         pci_reset_function(dev);
341
342         /* set bus master, which was cleared by the reset function */
343         pci_set_master(dev);
344
345         /* enable interrupts */
346         err = igbuio_pci_enable_interrupts(udev);
347         if (err) {
348                 dev_err(&dev->dev, "Enable interrupt fails\n");
349                 return err;
350         }
351         return 0;
352 }
353
354 static int
355 igbuio_pci_release(struct uio_info *info, struct inode *inode)
356 {
357         struct rte_uio_pci_dev *udev = info->priv;
358         struct pci_dev *dev = udev->pdev;
359
360         /* disable interrupts */
361         igbuio_pci_disable_interrupts(udev);
362
363         /* stop the device from further DMA */
364         pci_clear_master(dev);
365
366         pci_reset_function(dev);
367
368         return 0;
369 }
370
371 /* Remap pci resources described by bar #pci_bar in uio resource n. */
372 static int
373 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
374                        int n, int pci_bar, const char *name)
375 {
376         unsigned long addr, len;
377         void *internal_addr;
378
379         if (n >= ARRAY_SIZE(info->mem))
380                 return -EINVAL;
381
382         addr = pci_resource_start(dev, pci_bar);
383         len = pci_resource_len(dev, pci_bar);
384         if (addr == 0 || len == 0)
385                 return -1;
386         internal_addr = ioremap(addr, len);
387         if (internal_addr == NULL)
388                 return -1;
389         info->mem[n].name = name;
390         info->mem[n].addr = addr;
391         info->mem[n].internal_addr = internal_addr;
392         info->mem[n].size = len;
393         info->mem[n].memtype = UIO_MEM_PHYS;
394         return 0;
395 }
396
397 /* Get pci port io resources described by bar #pci_bar in uio resource n. */
398 static int
399 igbuio_pci_setup_ioport(struct pci_dev *dev, struct uio_info *info,
400                 int n, int pci_bar, const char *name)
401 {
402         unsigned long addr, len;
403
404         if (n >= ARRAY_SIZE(info->port))
405                 return -EINVAL;
406
407         addr = pci_resource_start(dev, pci_bar);
408         len = pci_resource_len(dev, pci_bar);
409         if (addr == 0 || len == 0)
410                 return -EINVAL;
411
412         info->port[n].name = name;
413         info->port[n].start = addr;
414         info->port[n].size = len;
415         info->port[n].porttype = UIO_PORT_X86;
416
417         return 0;
418 }
419
420 /* Unmap previously ioremap'd resources */
421 static void
422 igbuio_pci_release_iomem(struct uio_info *info)
423 {
424         int i;
425
426         for (i = 0; i < MAX_UIO_MAPS; i++) {
427                 if (info->mem[i].internal_addr)
428                         iounmap(info->mem[i].internal_addr);
429         }
430 }
431
432 static int
433 igbuio_setup_bars(struct pci_dev *dev, struct uio_info *info)
434 {
435         int i, iom, iop, ret;
436         unsigned long flags;
437         static const char *bar_names[PCI_STD_RESOURCE_END + 1]  = {
438                 "BAR0",
439                 "BAR1",
440                 "BAR2",
441                 "BAR3",
442                 "BAR4",
443                 "BAR5",
444         };
445
446         iom = 0;
447         iop = 0;
448
449         for (i = 0; i < ARRAY_SIZE(bar_names); i++) {
450                 if (pci_resource_len(dev, i) != 0 &&
451                                 pci_resource_start(dev, i) != 0) {
452                         flags = pci_resource_flags(dev, i);
453                         if (flags & IORESOURCE_MEM) {
454                                 ret = igbuio_pci_setup_iomem(dev, info, iom,
455                                                              i, bar_names[i]);
456                                 if (ret != 0)
457                                         return ret;
458                                 iom++;
459                         } else if (flags & IORESOURCE_IO) {
460                                 ret = igbuio_pci_setup_ioport(dev, info, iop,
461                                                               i, bar_names[i]);
462                                 if (ret != 0)
463                                         return ret;
464                                 iop++;
465                         }
466                 }
467         }
468
469         return (iom != 0 || iop != 0) ? ret : -ENOENT;
470 }
471
472 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0)
473 static int __devinit
474 #else
475 static int
476 #endif
477 igbuio_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
478 {
479         struct rte_uio_pci_dev *udev;
480         dma_addr_t map_dma_addr;
481         void *map_addr;
482         int err;
483
484         udev = kzalloc(sizeof(struct rte_uio_pci_dev), GFP_KERNEL);
485         if (!udev)
486                 return -ENOMEM;
487
488         /*
489          * enable device: ask low-level code to enable I/O and
490          * memory
491          */
492         err = pci_enable_device(dev);
493         if (err != 0) {
494                 dev_err(&dev->dev, "Cannot enable PCI device\n");
495                 goto fail_free;
496         }
497
498         /* enable bus mastering on the device */
499         pci_set_master(dev);
500
501         /* remap IO memory */
502         err = igbuio_setup_bars(dev, &udev->info);
503         if (err != 0)
504                 goto fail_release_iomem;
505
506         /* set 64-bit DMA mask */
507         err = pci_set_dma_mask(dev,  DMA_BIT_MASK(64));
508         if (err != 0) {
509                 dev_err(&dev->dev, "Cannot set DMA mask\n");
510                 goto fail_release_iomem;
511         }
512
513         err = pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(64));
514         if (err != 0) {
515                 dev_err(&dev->dev, "Cannot set consistent DMA mask\n");
516                 goto fail_release_iomem;
517         }
518
519         /* fill uio infos */
520         udev->info.name = "igb_uio";
521         udev->info.version = "0.1";
522         udev->info.irqcontrol = igbuio_pci_irqcontrol;
523         udev->info.open = igbuio_pci_open;
524         udev->info.release = igbuio_pci_release;
525         udev->info.priv = udev;
526         udev->pdev = dev;
527
528         err = sysfs_create_group(&dev->dev.kobj, &dev_attr_grp);
529         if (err != 0)
530                 goto fail_release_iomem;
531
532         /* register uio driver */
533         err = uio_register_device(&dev->dev, &udev->info);
534         if (err != 0)
535                 goto fail_remove_group;
536
537         pci_set_drvdata(dev, udev);
538
539         /*
540          * Doing a harmless dma mapping for attaching the device to
541          * the iommu identity mapping if kernel boots with iommu=pt.
542          * Note this is not a problem if no IOMMU at all.
543          */
544         map_addr = dma_alloc_coherent(&dev->dev, 1024, &map_dma_addr,
545                         GFP_KERNEL);
546         if (map_addr)
547                 memset(map_addr, 0, 1024);
548
549         if (!map_addr)
550                 dev_info(&dev->dev, "dma mapping failed\n");
551         else {
552                 dev_info(&dev->dev, "mapping 1K dma=%#llx host=%p\n",
553                          (unsigned long long)map_dma_addr, map_addr);
554
555                 dma_free_coherent(&dev->dev, 1024, map_addr, map_dma_addr);
556                 dev_info(&dev->dev, "unmapping 1K dma=%#llx host=%p\n",
557                          (unsigned long long)map_dma_addr, map_addr);
558         }
559
560         return 0;
561
562 fail_remove_group:
563         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
564 fail_release_iomem:
565         igbuio_pci_release_iomem(&udev->info);
566         pci_disable_device(dev);
567 fail_free:
568         kfree(udev);
569
570         return err;
571 }
572
573 static void
574 igbuio_pci_remove(struct pci_dev *dev)
575 {
576         struct rte_uio_pci_dev *udev = pci_get_drvdata(dev);
577
578         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
579         uio_unregister_device(&udev->info);
580         igbuio_pci_release_iomem(&udev->info);
581         pci_disable_device(dev);
582         pci_set_drvdata(dev, NULL);
583         kfree(udev);
584 }
585
586 static int
587 igbuio_config_intr_mode(char *intr_str)
588 {
589         if (!intr_str) {
590                 pr_info("Use MSIX interrupt by default\n");
591                 return 0;
592         }
593
594         if (!strcmp(intr_str, RTE_INTR_MODE_MSIX_NAME)) {
595                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
596                 pr_info("Use MSIX interrupt\n");
597         } else if (!strcmp(intr_str, RTE_INTR_MODE_MSI_NAME)) {
598                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSI;
599                 pr_info("Use MSI interrupt\n");
600         } else if (!strcmp(intr_str, RTE_INTR_MODE_LEGACY_NAME)) {
601                 igbuio_intr_mode_preferred = RTE_INTR_MODE_LEGACY;
602                 pr_info("Use legacy interrupt\n");
603         } else {
604                 pr_info("Error: bad parameter - %s\n", intr_str);
605                 return -EINVAL;
606         }
607
608         return 0;
609 }
610
611 static struct pci_driver igbuio_pci_driver = {
612         .name = "igb_uio",
613         .id_table = NULL,
614         .probe = igbuio_pci_probe,
615         .remove = igbuio_pci_remove,
616 };
617
618 static int __init
619 igbuio_pci_init_module(void)
620 {
621         int ret;
622
623         ret = igbuio_config_intr_mode(intr_mode);
624         if (ret < 0)
625                 return ret;
626
627         return pci_register_driver(&igbuio_pci_driver);
628 }
629
630 static void __exit
631 igbuio_pci_exit_module(void)
632 {
633         pci_unregister_driver(&igbuio_pci_driver);
634 }
635
636 module_init(igbuio_pci_init_module);
637 module_exit(igbuio_pci_exit_module);
638
639 module_param(intr_mode, charp, S_IRUGO);
640 MODULE_PARM_DESC(intr_mode,
641 "igb_uio interrupt mode (default=msix):\n"
642 "    " RTE_INTR_MODE_MSIX_NAME "       Use MSIX interrupt\n"
643 "    " RTE_INTR_MODE_MSI_NAME "        Use MSI interrupt\n"
644 "    " RTE_INTR_MODE_LEGACY_NAME "     Use Legacy interrupt\n"
645 "\n");
646
647 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
648 MODULE_LICENSE("GPL");
649 MODULE_AUTHOR("Intel Corporation");