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