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