igb_uio: fix compability on old kernel
[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/msi.h>
33 #include <linux/version.h>
34
35 #ifdef CONFIG_XEN_DOM0
36 #include <xen/xen.h>
37 #endif
38 #include <rte_pci_dev_features.h>
39
40 #include "compat.h"
41
42 #ifdef RTE_PCI_CONFIG
43 #define PCI_SYS_FILE_BUF_SIZE      10
44 #define PCI_DEV_CAP_REG            0xA4
45 #define PCI_DEV_CTRL_REG           0xA8
46 #define PCI_DEV_CAP_EXT_TAG_MASK   0x20
47 #define PCI_DEV_CTRL_EXT_TAG_SHIFT 8
48 #define PCI_DEV_CTRL_EXT_TAG_MASK  (1 << PCI_DEV_CTRL_EXT_TAG_SHIFT)
49 #endif
50
51 /**
52  * A structure describing the private information for a uio device.
53  */
54 struct rte_uio_pci_dev {
55         struct uio_info info;
56         struct pci_dev *pdev;
57         enum rte_intr_mode mode;
58 };
59
60 static char *intr_mode = NULL;
61 static enum rte_intr_mode igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
62
63 static inline struct rte_uio_pci_dev *
64 igbuio_get_uio_pci_dev(struct uio_info *info)
65 {
66         return container_of(info, struct rte_uio_pci_dev, info);
67 }
68
69 /* sriov sysfs */
70 static ssize_t
71 show_max_vfs(struct device *dev, struct device_attribute *attr,
72              char *buf)
73 {
74         return snprintf(buf, 10, "%u\n",
75                         pci_num_vf(container_of(dev, struct pci_dev, dev)));
76 }
77
78 static ssize_t
79 store_max_vfs(struct device *dev, struct device_attribute *attr,
80               const char *buf, size_t count)
81 {
82         int err = 0;
83         unsigned long max_vfs;
84         struct pci_dev *pdev = container_of(dev, struct pci_dev, dev);
85
86         if (0 != strict_strtoul(buf, 0, &max_vfs))
87                 return -EINVAL;
88
89         if (0 == max_vfs)
90                 pci_disable_sriov(pdev);
91         else if (0 == pci_num_vf(pdev))
92                 err = pci_enable_sriov(pdev, max_vfs);
93         else /* do nothing if change max_vfs number */
94                 err = -EINVAL;
95
96         return err ? err : count;
97 }
98
99 #ifdef RTE_PCI_CONFIG
100 static ssize_t
101 show_extended_tag(struct device *dev, struct device_attribute *attr, char *buf)
102 {
103         struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
104         uint32_t val = 0;
105
106         pci_read_config_dword(pci_dev, PCI_DEV_CAP_REG, &val);
107         if (!(val & PCI_DEV_CAP_EXT_TAG_MASK)) /* Not supported */
108                 return snprintf(buf, PCI_SYS_FILE_BUF_SIZE, "%s\n", "invalid");
109
110         val = 0;
111         pci_bus_read_config_dword(pci_dev->bus, pci_dev->devfn,
112                                         PCI_DEV_CTRL_REG, &val);
113
114         return snprintf(buf, PCI_SYS_FILE_BUF_SIZE, "%s\n",
115                 (val & PCI_DEV_CTRL_EXT_TAG_MASK) ? "on" : "off");
116 }
117
118 static ssize_t
119 store_extended_tag(struct device *dev,
120                    struct device_attribute *attr,
121                    const char *buf,
122                    size_t count)
123 {
124         struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
125         uint32_t val = 0, enable;
126
127         if (strncmp(buf, "on", 2) == 0)
128                 enable = 1;
129         else if (strncmp(buf, "off", 3) == 0)
130                 enable = 0;
131         else
132                 return -EINVAL;
133
134         pci_cfg_access_lock(pci_dev);
135         pci_bus_read_config_dword(pci_dev->bus, pci_dev->devfn,
136                                         PCI_DEV_CAP_REG, &val);
137         if (!(val & PCI_DEV_CAP_EXT_TAG_MASK)) { /* Not supported */
138                 pci_cfg_access_unlock(pci_dev);
139                 return -EPERM;
140         }
141
142         val = 0;
143         pci_bus_read_config_dword(pci_dev->bus, pci_dev->devfn,
144                                         PCI_DEV_CTRL_REG, &val);
145         if (enable)
146                 val |= PCI_DEV_CTRL_EXT_TAG_MASK;
147         else
148                 val &= ~PCI_DEV_CTRL_EXT_TAG_MASK;
149         pci_bus_write_config_dword(pci_dev->bus, pci_dev->devfn,
150                                         PCI_DEV_CTRL_REG, val);
151         pci_cfg_access_unlock(pci_dev);
152
153         return count;
154 }
155
156 static ssize_t
157 show_max_read_request_size(struct device *dev,
158                            struct device_attribute *attr,
159                            char *buf)
160 {
161         struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
162         int val = pcie_get_readrq(pci_dev);
163
164         return snprintf(buf, PCI_SYS_FILE_BUF_SIZE, "%d\n", val);
165 }
166
167 static ssize_t
168 store_max_read_request_size(struct device *dev,
169                             struct device_attribute *attr,
170                             const char *buf,
171                             size_t count)
172 {
173         struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
174         unsigned long size = 0;
175         int ret;
176
177         if (strict_strtoul(buf, 0, &size) != 0)
178                 return -EINVAL;
179
180         ret = pcie_set_readrq(pci_dev, (int)size);
181         if (ret < 0)
182                 return ret;
183
184         return count;
185 }
186 #endif
187
188 static DEVICE_ATTR(max_vfs, S_IRUGO | S_IWUSR, show_max_vfs, store_max_vfs);
189 #ifdef RTE_PCI_CONFIG
190 static DEVICE_ATTR(extended_tag, S_IRUGO | S_IWUSR, show_extended_tag,
191         store_extended_tag);
192 static DEVICE_ATTR(max_read_request_size, S_IRUGO | S_IWUSR,
193         show_max_read_request_size, store_max_read_request_size);
194 #endif
195
196 static struct attribute *dev_attrs[] = {
197         &dev_attr_max_vfs.attr,
198 #ifdef RTE_PCI_CONFIG
199         &dev_attr_extended_tag.attr,
200         &dev_attr_max_read_request_size.attr,
201 #endif
202         NULL,
203 };
204
205 static const struct attribute_group dev_attr_grp = {
206         .attrs = dev_attrs,
207 };
208 /*
209  * It masks the msix on/off of generating MSI-X messages.
210  */
211 static void
212 igbuio_msix_mask_irq(struct msi_desc *desc, int32_t state)
213 {
214         u32 mask_bits = desc->masked;
215         unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
216                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
217
218         if (state != 0)
219                 mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
220         else
221                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
222
223         if (mask_bits != desc->masked) {
224                 writel(mask_bits, desc->mask_base + offset);
225                 readl(desc->mask_base);
226                 desc->masked = mask_bits;
227         }
228 }
229
230 static void
231 igbuio_msi_mask_irq(struct irq_data *data, u32 enable)
232 {
233         struct msi_desc *desc = irq_data_get_msi(data);
234         u32 mask_bits = desc->masked;
235         unsigned offset = data->irq - desc->dev->irq;
236         u32 mask = 1 << offset;
237         u32 flag = enable << offset;
238
239         mask_bits &= ~mask;
240         mask_bits |= flag;
241
242         if (desc->msi_attrib.maskbit && mask_bits != desc->masked) {
243                 pci_write_config_dword(desc->dev, desc->mask_pos, mask_bits);
244                 desc->masked = mask_bits;
245         }
246 }
247
248 /**
249  * This is the irqcontrol callback to be registered to uio_info.
250  * It can be used to disable/enable interrupt from user space processes.
251  *
252  * @param info
253  *  pointer to uio_info.
254  * @param irq_state
255  *  state value. 1 to enable interrupt, 0 to disable interrupt.
256  *
257  * @return
258  *  - On success, 0.
259  *  - On failure, a negative value.
260  */
261 static int
262 igbuio_pci_irqcontrol(struct uio_info *info, s32 irq_state)
263 {
264         struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
265         struct pci_dev *pdev = udev->pdev;
266
267         pci_cfg_access_lock(pdev);
268         if (udev->mode == RTE_INTR_MODE_LEGACY)
269                 pci_intx(pdev, !!irq_state);
270         else if (udev->mode == RTE_INTR_MODE_MSI) {
271                 struct irq_data *data = irq_get_irq_data(pdev->irq);
272
273                 igbuio_msi_mask_irq(data, !!irq_state);
274         } else if (udev->mode == RTE_INTR_MODE_MSIX) {
275                 struct msi_desc *desc;
276
277                 list_for_each_entry(desc, &pdev->msi_list, list)
278                         igbuio_msix_mask_irq(desc, irq_state);
279         }
280         pci_cfg_access_unlock(pdev);
281
282         return 0;
283 }
284
285 /**
286  * This is interrupt handler which will check if the interrupt is for the right device.
287  * If yes, disable it here and will be enable later.
288  */
289 static irqreturn_t
290 igbuio_pci_irqhandler(int irq, struct uio_info *info)
291 {
292         struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
293
294         /* Legacy mode need to mask in hardware */
295         if (udev->mode == RTE_INTR_MODE_LEGACY &&
296             !pci_check_and_mask_intx(udev->pdev))
297                 return IRQ_NONE;
298
299         /* Message signal mode, no share IRQ and automasked */
300         return IRQ_HANDLED;
301 }
302
303 #ifdef CONFIG_XEN_DOM0
304 static int
305 igbuio_dom0_mmap_phys(struct uio_info *info, struct vm_area_struct *vma)
306 {
307         int idx;
308
309         idx = (int)vma->vm_pgoff;
310         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
311         vma->vm_page_prot.pgprot |= _PAGE_IOMAP;
312
313         return remap_pfn_range(vma,
314                         vma->vm_start,
315                         info->mem[idx].addr >> PAGE_SHIFT,
316                         vma->vm_end - vma->vm_start,
317                         vma->vm_page_prot);
318 }
319
320 /**
321  * This is uio device mmap method which will use igbuio mmap for Xen
322  * Dom0 environment.
323  */
324 static int
325 igbuio_dom0_pci_mmap(struct uio_info *info, struct vm_area_struct *vma)
326 {
327         int idx;
328
329         if (vma->vm_pgoff >= MAX_UIO_MAPS)
330                 return -EINVAL;
331
332         if (info->mem[vma->vm_pgoff].size == 0)
333                 return -EINVAL;
334
335         idx = (int)vma->vm_pgoff;
336         switch (info->mem[idx].memtype) {
337         case UIO_MEM_PHYS:
338                 return igbuio_dom0_mmap_phys(info, vma);
339         case UIO_MEM_LOGICAL:
340         case UIO_MEM_VIRTUAL:
341         default:
342                 return -EINVAL;
343         }
344 }
345 #endif
346
347 /* Remap pci resources described by bar #pci_bar in uio resource n. */
348 static int
349 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
350                        int n, int pci_bar, const char *name)
351 {
352         unsigned long addr, len;
353         void *internal_addr;
354
355         if (sizeof(info->mem) / sizeof(info->mem[0]) <= n)
356                 return -EINVAL;
357
358         addr = pci_resource_start(dev, pci_bar);
359         len = pci_resource_len(dev, pci_bar);
360         if (addr == 0 || len == 0)
361                 return -1;
362         internal_addr = ioremap(addr, len);
363         if (internal_addr == NULL)
364                 return -1;
365         info->mem[n].name = name;
366         info->mem[n].addr = addr;
367         info->mem[n].internal_addr = internal_addr;
368         info->mem[n].size = len;
369         info->mem[n].memtype = UIO_MEM_PHYS;
370         return 0;
371 }
372
373 /* Get pci port io resources described by bar #pci_bar in uio resource n. */
374 static int
375 igbuio_pci_setup_ioport(struct pci_dev *dev, struct uio_info *info,
376                 int n, int pci_bar, const char *name)
377 {
378         unsigned long addr, len;
379
380         if (sizeof(info->port) / sizeof(info->port[0]) <= n)
381                 return -EINVAL;
382
383         addr = pci_resource_start(dev, pci_bar);
384         len = pci_resource_len(dev, pci_bar);
385         if (addr == 0 || len == 0)
386                 return -EINVAL;
387
388         info->port[n].name = name;
389         info->port[n].start = addr;
390         info->port[n].size = len;
391         info->port[n].porttype = UIO_PORT_X86;
392
393         return 0;
394 }
395
396 /* Unmap previously ioremap'd resources */
397 static void
398 igbuio_pci_release_iomem(struct uio_info *info)
399 {
400         int i;
401
402         for (i = 0; i < MAX_UIO_MAPS; i++) {
403                 if (info->mem[i].internal_addr)
404                         iounmap(info->mem[i].internal_addr);
405         }
406 }
407
408 static int
409 igbuio_setup_bars(struct pci_dev *dev, struct uio_info *info)
410 {
411         int i, iom, iop, ret;
412         unsigned long flags;
413         static const char *bar_names[PCI_STD_RESOURCE_END + 1]  = {
414                 "BAR0",
415                 "BAR1",
416                 "BAR2",
417                 "BAR3",
418                 "BAR4",
419                 "BAR5",
420         };
421
422         iom = 0;
423         iop = 0;
424
425         for (i = 0; i != sizeof(bar_names) / sizeof(bar_names[0]); i++) {
426                 if (pci_resource_len(dev, i) != 0 &&
427                                 pci_resource_start(dev, i) != 0) {
428                         flags = pci_resource_flags(dev, i);
429                         if (flags & IORESOURCE_MEM) {
430                                 ret = igbuio_pci_setup_iomem(dev, info, iom,
431                                                              i, bar_names[i]);
432                                 if (ret != 0)
433                                         return ret;
434                                 iom++;
435                         } else if (flags & IORESOURCE_IO) {
436                                 ret = igbuio_pci_setup_ioport(dev, info, iop,
437                                                               i, bar_names[i]);
438                                 if (ret != 0)
439                                         return ret;
440                                 iop++;
441                         }
442                 }
443         }
444
445         return (iom != 0) ? ret : -ENOENT;
446 }
447
448 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0)
449 static int __devinit
450 #else
451 static int
452 #endif
453 igbuio_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
454 {
455         struct rte_uio_pci_dev *udev;
456         struct msix_entry msix_entry;
457         int err;
458
459         udev = kzalloc(sizeof(struct rte_uio_pci_dev), GFP_KERNEL);
460         if (!udev)
461                 return -ENOMEM;
462
463         /*
464          * enable device: ask low-level code to enable I/O and
465          * memory
466          */
467         err = pci_enable_device(dev);
468         if (err != 0) {
469                 dev_err(&dev->dev, "Cannot enable PCI device\n");
470                 goto fail_free;
471         }
472
473         /*
474          * reserve device's PCI memory regions for use by this
475          * module
476          */
477         err = pci_request_regions(dev, "igb_uio");
478         if (err != 0) {
479                 dev_err(&dev->dev, "Cannot request regions\n");
480                 goto fail_disable;
481         }
482
483         /* enable bus mastering on the device */
484         pci_set_master(dev);
485
486         /* remap IO memory */
487         err = igbuio_setup_bars(dev, &udev->info);
488         if (err != 0)
489                 goto fail_release_iomem;
490
491         /* set 64-bit DMA mask */
492         err = pci_set_dma_mask(dev,  DMA_BIT_MASK(64));
493         if (err != 0) {
494                 dev_err(&dev->dev, "Cannot set DMA mask\n");
495                 goto fail_release_iomem;
496         }
497
498         err = pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(64));
499         if (err != 0) {
500                 dev_err(&dev->dev, "Cannot set consistent DMA mask\n");
501                 goto fail_release_iomem;
502         }
503
504         /* fill uio infos */
505         udev->info.name = "igb_uio";
506         udev->info.version = "0.1";
507         udev->info.handler = igbuio_pci_irqhandler;
508         udev->info.irqcontrol = igbuio_pci_irqcontrol;
509         udev->info.irq = dev->irq;
510 #ifdef CONFIG_XEN_DOM0
511         /* check if the driver run on Xen Dom0 */
512         if (xen_initial_domain())
513                 udev->info.mmap = igbuio_dom0_pci_mmap;
514 #endif
515         udev->info.priv = udev;
516         udev->pdev = dev;
517
518         switch (igbuio_intr_mode_preferred) {
519         case RTE_INTR_MODE_NONE:
520                 udev->info.irq = 0;
521                 break;
522         case RTE_INTR_MODE_MSIX:
523                 /* Only 1 msi-x vector needed */
524                 msix_entry.entry = 0;
525                 if (pci_enable_msix(dev, &msix_entry, 1) == 0) {
526                         dev_dbg(&dev->dev, "using MSI-X");
527                         udev->info.irq = msix_entry.vector;
528                         udev->mode = RTE_INTR_MODE_MSIX;
529                         break;
530                 }
531                 /* fall back to MSI */
532         case RTE_INTR_MODE_MSI:
533                 if (pci_enable_msi(dev) == 0) {
534                         dev_dbg(&dev->dev, "using MSI");
535                         udev->mode = RTE_INTR_MODE_MSI;
536                         break;
537                 }
538                 /* fall back to INTX */
539         case RTE_INTR_MODE_LEGACY:
540                 if (pci_intx_mask_supported(dev)) {
541                         dev_dbg(&dev->dev, "using INTX");
542                         udev->info.irq_flags = IRQF_SHARED;
543                         udev->mode = RTE_INTR_MODE_LEGACY;
544                 } else {
545                         dev_err(&dev->dev, "PCI INTX mask not supported\n");
546                         err = -EIO;
547                         goto fail_release_iomem;
548                 }
549                 break;
550         default:
551                 dev_err(&dev->dev, "invalid IRQ mode %u",
552                         igbuio_intr_mode_preferred);
553                 err = -EINVAL;
554                 goto fail_release_iomem;
555         }
556
557         err = sysfs_create_group(&dev->dev.kobj, &dev_attr_grp);
558         if (err != 0)
559                 goto fail_release_iomem;
560
561         /* register uio driver */
562         err = uio_register_device(&dev->dev, &udev->info);
563         if (err != 0)
564                 goto fail_remove_group;
565
566         pci_set_drvdata(dev, udev);
567
568         dev_info(&dev->dev, "uio device registered with irq %lx\n",
569                  udev->info.irq);
570
571         return 0;
572
573 fail_remove_group:
574         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
575 fail_release_iomem:
576         igbuio_pci_release_iomem(&udev->info);
577         if (udev->mode == RTE_INTR_MODE_MSIX)
578                 pci_disable_msix(udev->pdev);
579         else if (udev->mode == RTE_INTR_MODE_MSI)
580                 pci_disable_msi(udev->pdev);
581         pci_release_regions(dev);
582 fail_disable:
583         pci_disable_device(dev);
584 fail_free:
585         kfree(udev);
586
587         return err;
588 }
589
590 static void
591 igbuio_pci_remove(struct pci_dev *dev)
592 {
593         struct uio_info *info = pci_get_drvdata(dev);
594         struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
595
596         if (info->priv == NULL) {
597                 pr_notice("Not igbuio device\n");
598                 return;
599         }
600
601         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
602         uio_unregister_device(info);
603         igbuio_pci_release_iomem(info);
604         if (udev->mode == RTE_INTR_MODE_MSIX)
605                 pci_disable_msix(dev);
606         else if (udev->mode == RTE_INTR_MODE_MSI)
607                 pci_disable_msi(dev);
608         pci_release_regions(dev);
609         pci_disable_device(dev);
610         pci_set_drvdata(dev, NULL);
611         kfree(info);
612 }
613
614 static int
615 igbuio_config_intr_mode(char *intr_str)
616 {
617         if (!intr_str) {
618                 pr_info("Use MSIX interrupt by default\n");
619                 return 0;
620         }
621
622         if (!strcmp(intr_str, RTE_INTR_MODE_MSIX_NAME)) {
623                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
624                 pr_info("Use MSIX interrupt\n");
625         } else if (!strcmp(intr_str, RTE_INTR_MODE_MSI_NAME)) {
626                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSI;
627                 pr_info("Use MSI interrupt\n");
628         } else if (!strcmp(intr_str, RTE_INTR_MODE_LEGACY_NAME)) {
629                 igbuio_intr_mode_preferred = RTE_INTR_MODE_LEGACY;
630                 pr_info("Use legacy interrupt\n");
631         } else {
632                 pr_info("Error: bad parameter - %s\n", intr_str);
633                 return -EINVAL;
634         }
635
636         return 0;
637 }
638
639 static struct pci_driver igbuio_pci_driver = {
640         .name = "igb_uio",
641         .id_table = NULL,
642         .probe = igbuio_pci_probe,
643         .remove = igbuio_pci_remove,
644 };
645
646 static int __init
647 igbuio_pci_init_module(void)
648 {
649         int ret;
650
651         ret = igbuio_config_intr_mode(intr_mode);
652         if (ret < 0)
653                 return ret;
654
655         return pci_register_driver(&igbuio_pci_driver);
656 }
657
658 static void __exit
659 igbuio_pci_exit_module(void)
660 {
661         pci_unregister_driver(&igbuio_pci_driver);
662 }
663
664 module_init(igbuio_pci_init_module);
665 module_exit(igbuio_pci_exit_module);
666
667 module_param(intr_mode, charp, S_IRUGO);
668 MODULE_PARM_DESC(intr_mode,
669 "igb_uio interrupt mode (default=msix):\n"
670 "    " RTE_INTR_MODE_MSIX_NAME "       Use MSIX interrupt\n"
671 "    " RTE_INTR_MODE_MSI_NAME "        Use MSI interrupt\n"
672 "    " RTE_INTR_MODE_LEGACY_NAME "     Use Legacy interrupt\n"
673 "\n");
674
675 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
676 MODULE_LICENSE("GPL");
677 MODULE_AUTHOR("Intel Corporation");