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