4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
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.
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.
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.
21 * Contact Information:
25 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27 #include <linux/device.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/uio_driver.h>
32 #include <linux/msi.h>
33 #include <linux/version.h>
35 #ifdef CONFIG_XEN_DOM0
38 #include <rte_pci_dev_features.h>
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)
52 * A structure describing the private information for a uio device.
54 struct rte_uio_pci_dev {
57 enum rte_intr_mode mode;
60 static char *intr_mode = NULL;
61 static enum rte_intr_mode igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
63 static inline struct rte_uio_pci_dev *
64 igbuio_get_uio_pci_dev(struct uio_info *info)
66 return container_of(info, struct rte_uio_pci_dev, info);
71 show_max_vfs(struct device *dev, struct device_attribute *attr,
74 return snprintf(buf, 10, "%u\n",
75 pci_num_vf(container_of(dev, struct pci_dev, dev)));
79 store_max_vfs(struct device *dev, struct device_attribute *attr,
80 const char *buf, size_t count)
83 unsigned long max_vfs;
84 struct pci_dev *pdev = container_of(dev, struct pci_dev, dev);
86 if (0 != kstrtoul(buf, 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 */
96 return err ? err : count;
101 show_extended_tag(struct device *dev, struct device_attribute *attr, char *buf)
103 struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
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");
111 pci_bus_read_config_dword(pci_dev->bus, pci_dev->devfn,
112 PCI_DEV_CTRL_REG, &val);
114 return snprintf(buf, PCI_SYS_FILE_BUF_SIZE, "%s\n",
115 (val & PCI_DEV_CTRL_EXT_TAG_MASK) ? "on" : "off");
119 store_extended_tag(struct device *dev,
120 struct device_attribute *attr,
124 struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
125 uint32_t val = 0, enable;
127 if (strncmp(buf, "on", 2) == 0)
129 else if (strncmp(buf, "off", 3) == 0)
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);
143 pci_bus_read_config_dword(pci_dev->bus, pci_dev->devfn,
144 PCI_DEV_CTRL_REG, &val);
146 val |= PCI_DEV_CTRL_EXT_TAG_MASK;
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);
157 show_max_read_request_size(struct device *dev,
158 struct device_attribute *attr,
161 struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
162 int val = pcie_get_readrq(pci_dev);
164 return snprintf(buf, PCI_SYS_FILE_BUF_SIZE, "%d\n", val);
168 store_max_read_request_size(struct device *dev,
169 struct device_attribute *attr,
173 struct pci_dev *pci_dev = container_of(dev, struct pci_dev, dev);
174 unsigned long size = 0;
177 if (0 != kstrtoul(buf, 0, &size))
180 ret = pcie_set_readrq(pci_dev, (int)size);
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,
192 static DEVICE_ATTR(max_read_request_size, S_IRUGO | S_IWUSR,
193 show_max_read_request_size, store_max_read_request_size);
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,
205 static const struct attribute_group dev_attr_grp = {
209 * It masks the msix on/off of generating MSI-X messages.
212 igbuio_msix_mask_irq(struct msi_desc *desc, int32_t state)
214 u32 mask_bits = desc->masked;
215 unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
216 PCI_MSIX_ENTRY_VECTOR_CTRL;
219 mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
221 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
223 if (mask_bits != desc->masked) {
224 writel(mask_bits, desc->mask_base + offset);
225 readl(desc->mask_base);
226 desc->masked = mask_bits;
231 * This is the irqcontrol callback to be registered to uio_info.
232 * It can be used to disable/enable interrupt from user space processes.
235 * pointer to uio_info.
237 * state value. 1 to enable interrupt, 0 to disable interrupt.
241 * - On failure, a negative value.
244 igbuio_pci_irqcontrol(struct uio_info *info, s32 irq_state)
246 struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
247 struct pci_dev *pdev = udev->pdev;
249 pci_cfg_access_lock(pdev);
250 if (udev->mode == RTE_INTR_MODE_LEGACY)
251 pci_intx(pdev, !!irq_state);
253 else if (udev->mode == RTE_INTR_MODE_MSIX) {
254 struct msi_desc *desc;
256 list_for_each_entry(desc, &pdev->msi_list, list)
257 igbuio_msix_mask_irq(desc, irq_state);
259 pci_cfg_access_unlock(pdev);
265 * This is interrupt handler which will check if the interrupt is for the right device.
266 * If yes, disable it here and will be enable later.
269 igbuio_pci_irqhandler(int irq, struct uio_info *info)
271 struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
273 /* Legacy mode need to mask in hardware */
274 if (udev->mode == RTE_INTR_MODE_LEGACY &&
275 !pci_check_and_mask_intx(udev->pdev))
278 /* Message signal mode, no share IRQ and automasked */
282 #ifdef CONFIG_XEN_DOM0
284 igbuio_dom0_mmap_phys(struct uio_info *info, struct vm_area_struct *vma)
288 idx = (int)vma->vm_pgoff;
289 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
290 #ifdef HAVE_PTE_MASK_PAGE_IOMAP
291 vma->vm_page_prot.pgprot |= _PAGE_IOMAP;
294 return remap_pfn_range(vma,
296 info->mem[idx].addr >> PAGE_SHIFT,
297 vma->vm_end - vma->vm_start,
302 * This is uio device mmap method which will use igbuio mmap for Xen
306 igbuio_dom0_pci_mmap(struct uio_info *info, struct vm_area_struct *vma)
310 if (vma->vm_pgoff >= MAX_UIO_MAPS)
313 if (info->mem[vma->vm_pgoff].size == 0)
316 idx = (int)vma->vm_pgoff;
317 switch (info->mem[idx].memtype) {
319 return igbuio_dom0_mmap_phys(info, vma);
320 case UIO_MEM_LOGICAL:
321 case UIO_MEM_VIRTUAL:
328 /* Remap pci resources described by bar #pci_bar in uio resource n. */
330 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
331 int n, int pci_bar, const char *name)
333 unsigned long addr, len;
336 if (sizeof(info->mem) / sizeof(info->mem[0]) <= n)
339 addr = pci_resource_start(dev, pci_bar);
340 len = pci_resource_len(dev, pci_bar);
341 if (addr == 0 || len == 0)
343 internal_addr = ioremap(addr, len);
344 if (internal_addr == NULL)
346 info->mem[n].name = name;
347 info->mem[n].addr = addr;
348 info->mem[n].internal_addr = internal_addr;
349 info->mem[n].size = len;
350 info->mem[n].memtype = UIO_MEM_PHYS;
354 /* Get pci port io resources described by bar #pci_bar in uio resource n. */
356 igbuio_pci_setup_ioport(struct pci_dev *dev, struct uio_info *info,
357 int n, int pci_bar, const char *name)
359 unsigned long addr, len;
361 if (sizeof(info->port) / sizeof(info->port[0]) <= n)
364 addr = pci_resource_start(dev, pci_bar);
365 len = pci_resource_len(dev, pci_bar);
366 if (addr == 0 || len == 0)
369 info->port[n].name = name;
370 info->port[n].start = addr;
371 info->port[n].size = len;
372 info->port[n].porttype = UIO_PORT_X86;
377 /* Unmap previously ioremap'd resources */
379 igbuio_pci_release_iomem(struct uio_info *info)
383 for (i = 0; i < MAX_UIO_MAPS; i++) {
384 if (info->mem[i].internal_addr)
385 iounmap(info->mem[i].internal_addr);
390 igbuio_setup_bars(struct pci_dev *dev, struct uio_info *info)
392 int i, iom, iop, ret;
394 static const char *bar_names[PCI_STD_RESOURCE_END + 1] = {
406 for (i = 0; i != sizeof(bar_names) / sizeof(bar_names[0]); i++) {
407 if (pci_resource_len(dev, i) != 0 &&
408 pci_resource_start(dev, i) != 0) {
409 flags = pci_resource_flags(dev, i);
410 if (flags & IORESOURCE_MEM) {
411 ret = igbuio_pci_setup_iomem(dev, info, iom,
416 } else if (flags & IORESOURCE_IO) {
417 ret = igbuio_pci_setup_ioport(dev, info, iop,
426 return (iom != 0) ? ret : -ENOENT;
429 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0)
434 igbuio_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
436 struct rte_uio_pci_dev *udev;
437 struct msix_entry msix_entry;
440 udev = kzalloc(sizeof(struct rte_uio_pci_dev), GFP_KERNEL);
445 * enable device: ask low-level code to enable I/O and
448 err = pci_enable_device(dev);
450 dev_err(&dev->dev, "Cannot enable PCI device\n");
455 * reserve device's PCI memory regions for use by this
458 err = pci_request_regions(dev, "igb_uio");
460 dev_err(&dev->dev, "Cannot request regions\n");
464 /* enable bus mastering on the device */
467 /* remap IO memory */
468 err = igbuio_setup_bars(dev, &udev->info);
470 goto fail_release_iomem;
472 /* set 64-bit DMA mask */
473 err = pci_set_dma_mask(dev, DMA_BIT_MASK(64));
475 dev_err(&dev->dev, "Cannot set DMA mask\n");
476 goto fail_release_iomem;
479 err = pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(64));
481 dev_err(&dev->dev, "Cannot set consistent DMA mask\n");
482 goto fail_release_iomem;
486 udev->info.name = "igb_uio";
487 udev->info.version = "0.1";
488 udev->info.handler = igbuio_pci_irqhandler;
489 udev->info.irqcontrol = igbuio_pci_irqcontrol;
490 #ifdef CONFIG_XEN_DOM0
491 /* check if the driver run on Xen Dom0 */
492 if (xen_initial_domain())
493 udev->info.mmap = igbuio_dom0_pci_mmap;
495 udev->info.priv = udev;
498 switch (igbuio_intr_mode_preferred) {
499 case RTE_INTR_MODE_MSIX:
500 /* Only 1 msi-x vector needed */
501 msix_entry.entry = 0;
502 if (pci_enable_msix(dev, &msix_entry, 1) == 0) {
503 dev_dbg(&dev->dev, "using MSI-X");
504 udev->info.irq = msix_entry.vector;
505 udev->mode = RTE_INTR_MODE_MSIX;
508 /* fall back to INTX */
509 case RTE_INTR_MODE_LEGACY:
510 if (pci_intx_mask_supported(dev)) {
511 dev_dbg(&dev->dev, "using INTX");
512 udev->info.irq_flags = IRQF_SHARED;
513 udev->info.irq = dev->irq;
514 udev->mode = RTE_INTR_MODE_LEGACY;
517 dev_notice(&dev->dev, "PCI INTX mask not supported\n");
518 /* fall back to no IRQ */
519 case RTE_INTR_MODE_NONE:
520 udev->mode = RTE_INTR_MODE_NONE;
525 dev_err(&dev->dev, "invalid IRQ mode %u",
526 igbuio_intr_mode_preferred);
528 goto fail_release_iomem;
531 err = sysfs_create_group(&dev->dev.kobj, &dev_attr_grp);
533 goto fail_release_iomem;
535 /* register uio driver */
536 err = uio_register_device(&dev->dev, &udev->info);
538 goto fail_remove_group;
540 pci_set_drvdata(dev, udev);
542 dev_info(&dev->dev, "uio device registered with irq %lx\n",
548 sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
550 igbuio_pci_release_iomem(&udev->info);
551 if (udev->mode == RTE_INTR_MODE_MSIX)
552 pci_disable_msix(udev->pdev);
553 pci_release_regions(dev);
555 pci_disable_device(dev);
563 igbuio_pci_remove(struct pci_dev *dev)
565 struct uio_info *info = pci_get_drvdata(dev);
566 struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
568 if (info->priv == NULL) {
569 pr_notice("Not igbuio device\n");
573 sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
574 uio_unregister_device(info);
575 igbuio_pci_release_iomem(info);
576 if (udev->mode == RTE_INTR_MODE_MSIX)
577 pci_disable_msix(dev);
578 pci_release_regions(dev);
579 pci_disable_device(dev);
580 pci_set_drvdata(dev, NULL);
585 igbuio_config_intr_mode(char *intr_str)
588 pr_info("Use MSIX interrupt by default\n");
592 if (!strcmp(intr_str, RTE_INTR_MODE_MSIX_NAME)) {
593 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
594 pr_info("Use MSIX interrupt\n");
595 } else if (!strcmp(intr_str, RTE_INTR_MODE_LEGACY_NAME)) {
596 igbuio_intr_mode_preferred = RTE_INTR_MODE_LEGACY;
597 pr_info("Use legacy interrupt\n");
599 pr_info("Error: bad parameter - %s\n", intr_str);
606 static struct pci_driver igbuio_pci_driver = {
609 .probe = igbuio_pci_probe,
610 .remove = igbuio_pci_remove,
614 igbuio_pci_init_module(void)
618 ret = igbuio_config_intr_mode(intr_mode);
622 return pci_register_driver(&igbuio_pci_driver);
626 igbuio_pci_exit_module(void)
628 pci_unregister_driver(&igbuio_pci_driver);
631 module_init(igbuio_pci_init_module);
632 module_exit(igbuio_pci_exit_module);
634 module_param(intr_mode, charp, S_IRUGO);
635 MODULE_PARM_DESC(intr_mode,
636 "igb_uio interrupt mode (default=msix):\n"
637 " " RTE_INTR_MODE_MSIX_NAME " Use MSIX interrupt\n"
638 " " RTE_INTR_MODE_LEGACY_NAME " Use Legacy interrupt\n"
641 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
642 MODULE_LICENSE("GPL");
643 MODULE_AUTHOR("Intel Corporation");