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                 list_for_each_entry(desc, &pdev->msi_list, list)
 252                         igbuio_msix_mask_irq(desc, irq_state);
 253         }
 254         pci_cfg_access_unlock(pdev);
 255
 256         return 0;
 257 }
 258
 259 /**
 260  * This is interrupt handler which will check if the interrupt is for the right device.
 261  * If yes, disable it here and will be enable later.
 262  */
 263 static irqreturn_t
 264 igbuio_pci_irqhandler(int irq, struct uio_info *info)
 265 {
 266         struct rte_uio_pci_dev *udev = info->priv;
 267
 268         /* Legacy mode need to mask in hardware */
 269         if (udev->mode == RTE_INTR_MODE_LEGACY &&
 270             !pci_check_and_mask_intx(udev->pdev))
 271                 return IRQ_NONE;
 272
 273         /* Message signal mode, no share IRQ and automasked */
 274         return IRQ_HANDLED;
 275 }
 276
 277 #ifdef CONFIG_XEN_DOM0
 278 static int
 279 igbuio_dom0_mmap_phys(struct uio_info *info, struct vm_area_struct *vma)
 280 {
 281         int idx;
 282
 283         idx = (int)vma->vm_pgoff;
 284         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
 285 #ifdef HAVE_PTE_MASK_PAGE_IOMAP
 286         vma->vm_page_prot.pgprot |= _PAGE_IOMAP;
 287 #endif
 288
 289         return remap_pfn_range(vma,
 290                         vma->vm_start,
 291                         info->mem[idx].addr >> PAGE_SHIFT,
 292                         vma->vm_end - vma->vm_start,
 293                         vma->vm_page_prot);
 294 }
 295
 296 /**
 297  * This is uio device mmap method which will use igbuio mmap for Xen
 298  * Dom0 environment.
 299  */
 300 static int
 301 igbuio_dom0_pci_mmap(struct uio_info *info, struct vm_area_struct *vma)
 302 {
 303         int idx;
 304
 305         if (vma->vm_pgoff >= MAX_UIO_MAPS)
 306                 return -EINVAL;
 307
 308         if (info->mem[vma->vm_pgoff].size == 0)
 309                 return -EINVAL;
 310
 311         idx = (int)vma->vm_pgoff;
 312         switch (info->mem[idx].memtype) {
 313         case UIO_MEM_PHYS:
 314                 return igbuio_dom0_mmap_phys(info, vma);
 315         case UIO_MEM_LOGICAL:
 316         case UIO_MEM_VIRTUAL:
 317         default:
 318                 return -EINVAL;
 319         }
 320 }
 321 #endif
 322
 323 /* Remap pci resources described by bar #pci_bar in uio resource n. */
 324 static int
 325 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
 326                        int n, int pci_bar, const char *name)
 327 {
 328         unsigned long addr, len;
 329         void *internal_addr;
 330
 331         if (sizeof(info->mem) / sizeof(info->mem[0]) <= n)
 332                 return -EINVAL;
 333
 334         addr = pci_resource_start(dev, pci_bar);
 335         len = pci_resource_len(dev, pci_bar);
 336         if (addr == 0 || len == 0)
 337                 return -1;
 338         internal_addr = ioremap(addr, len);
 339         if (internal_addr == NULL)
 340                 return -1;
 341         info->mem[n].name = name;
 342         info->mem[n].addr = addr;
 343         info->mem[n].internal_addr = internal_addr;
 344         info->mem[n].size = len;
 345         info->mem[n].memtype = UIO_MEM_PHYS;
 346         return 0;
 347 }
 348
 349 /* Get pci port io resources described by bar #pci_bar in uio resource n. */
 350 static int
 351 igbuio_pci_setup_ioport(struct pci_dev *dev, struct uio_info *info,
 352                 int n, int pci_bar, const char *name)
 353 {
 354         unsigned long addr, len;
 355
 356         if (sizeof(info->port) / sizeof(info->port[0]) <= n)
 357                 return -EINVAL;
 358
 359         addr = pci_resource_start(dev, pci_bar);
 360         len = pci_resource_len(dev, pci_bar);
 361         if (addr == 0 || len == 0)
 362                 return -EINVAL;
 363
 364         info->port[n].name = name;
 365         info->port[n].start = addr;
 366         info->port[n].size = len;
 367         info->port[n].porttype = UIO_PORT_X86;
 368
 369         return 0;
 370 }
 371
 372 /* Unmap previously ioremap'd resources */
 373 static void
 374 igbuio_pci_release_iomem(struct uio_info *info)
 375 {
 376         int i;
 377
 378         for (i = 0; i < MAX_UIO_MAPS; i++) {
 379                 if (info->mem[i].internal_addr)
 380                         iounmap(info->mem[i].internal_addr);
 381         }
 382 }
 383
 384 static int
 385 igbuio_setup_bars(struct pci_dev *dev, struct uio_info *info)
 386 {
 387         int i, iom, iop, ret;
 388         unsigned long flags;
 389         static const char *bar_names[PCI_STD_RESOURCE_END + 1]  = {
 390                 "BAR0",
 391                 "BAR1",
 392                 "BAR2",
 393                 "BAR3",
 394                 "BAR4",
 395                 "BAR5",
 396         };
 397
 398         iom = 0;
 399         iop = 0;
 400
 401         for (i = 0; i != sizeof(bar_names) / sizeof(bar_names[0]); i++) {
 402                 if (pci_resource_len(dev, i) != 0 &&
 403                                 pci_resource_start(dev, i) != 0) {
 404                         flags = pci_resource_flags(dev, i);
 405                         if (flags & IORESOURCE_MEM) {
 406                                 ret = igbuio_pci_setup_iomem(dev, info, iom,
 407                                                              i, bar_names[i]);
 408                                 if (ret != 0)
 409                                         return ret;
 410                                 iom++;
 411                         } else if (flags & IORESOURCE_IO) {
 412                                 ret = igbuio_pci_setup_ioport(dev, info, iop,
 413                                                               i, bar_names[i]);
 414                                 if (ret != 0)
 415                                         return ret;
 416                                 iop++;
 417                         }
 418                 }
 419         }
 420
 421         return (iom != 0) ? ret : -ENOENT;
 422 }
 423
 424 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 8, 0)
 425 static int __devinit
 426 #else
 427 static int
 428 #endif
 429 igbuio_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
 430 {
 431         struct rte_uio_pci_dev *udev;
 432         struct msix_entry msix_entry;
 433         int err;
 434
 435         udev = kzalloc(sizeof(struct rte_uio_pci_dev), GFP_KERNEL);
 436         if (!udev)
 437                 return -ENOMEM;
 438
 439         /*
 440          * enable device: ask low-level code to enable I/O and
 441          * memory
 442          */
 443         err = pci_enable_device(dev);
 444         if (err != 0) {
 445                 dev_err(&dev->dev, "Cannot enable PCI device\n");
 446                 goto fail_free;
 447         }
 448
 449         /*
 450          * reserve device's PCI memory regions for use by this
 451          * module
 452          */
 453         err = pci_request_regions(dev, "igb_uio");
 454         if (err != 0) {
 455                 dev_err(&dev->dev, "Cannot request regions\n");
 456                 goto fail_disable;
 457         }
 458
 459         /* enable bus mastering on the device */
 460         pci_set_master(dev);
 461
 462         /* remap IO memory */
 463         err = igbuio_setup_bars(dev, &udev->info);
 464         if (err != 0)
 465                 goto fail_release_iomem;
 466
 467         /* set 64-bit DMA mask */
 468         err = pci_set_dma_mask(dev,  DMA_BIT_MASK(64));
 469         if (err != 0) {
 470                 dev_err(&dev->dev, "Cannot set DMA mask\n");
 471                 goto fail_release_iomem;
 472         }
 473
 474         err = pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(64));
 475         if (err != 0) {
 476                 dev_err(&dev->dev, "Cannot set consistent DMA mask\n");
 477                 goto fail_release_iomem;
 478         }
 479
 480         /* fill uio infos */
 481         udev->info.name = "igb_uio";
 482         udev->info.version = "0.1";
 483         udev->info.handler = igbuio_pci_irqhandler;
 484         udev->info.irqcontrol = igbuio_pci_irqcontrol;
 485 #ifdef CONFIG_XEN_DOM0
 486         /* check if the driver run on Xen Dom0 */
 487         if (xen_initial_domain())
 488                 udev->info.mmap = igbuio_dom0_pci_mmap;
 489 #endif
 490         udev->info.priv = udev;
 491         udev->pdev = dev;
 492
 493         switch (igbuio_intr_mode_preferred) {
 494         case RTE_INTR_MODE_MSIX:
 495                 /* Only 1 msi-x vector needed */
 496                 msix_entry.entry = 0;
 497                 if (pci_enable_msix(dev, &msix_entry, 1) == 0) {
 498                         dev_dbg(&dev->dev, "using MSI-X");
 499                         udev->info.irq = msix_entry.vector;
 500                         udev->mode = RTE_INTR_MODE_MSIX;
 501                         break;
 502                 }
 503                 /* fall back to INTX */
 504         case RTE_INTR_MODE_LEGACY:
 505                 if (pci_intx_mask_supported(dev)) {
 506                         dev_dbg(&dev->dev, "using INTX");
 507                         udev->info.irq_flags = IRQF_SHARED;
 508                         udev->info.irq = dev->irq;
 509                         udev->mode = RTE_INTR_MODE_LEGACY;
 510                         break;
 511                 }
 512                 dev_notice(&dev->dev, "PCI INTX mask not supported\n");
 513                 /* fall back to no IRQ */
 514         case RTE_INTR_MODE_NONE:
 515                 udev->mode = RTE_INTR_MODE_NONE;
 516                 udev->info.irq = 0;
 517                 break;
 518
 519         default:
 520                 dev_err(&dev->dev, "invalid IRQ mode %u",
 521                         igbuio_intr_mode_preferred);
 522                 err = -EINVAL;
 523                 goto fail_release_iomem;
 524         }
 525
 526         err = sysfs_create_group(&dev->dev.kobj, &dev_attr_grp);
 527         if (err != 0)
 528                 goto fail_release_iomem;
 529
 530         /* register uio driver */
 531         err = uio_register_device(&dev->dev, &udev->info);
 532         if (err != 0)
 533                 goto fail_remove_group;
 534
 535         pci_set_drvdata(dev, udev);
 536
 537         dev_info(&dev->dev, "uio device registered with irq %lx\n",
 538                  udev->info.irq);
 539
 540         return 0;
 541
 542 fail_remove_group:
 543         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
 544 fail_release_iomem:
 545         igbuio_pci_release_iomem(&udev->info);
 546         if (udev->mode == RTE_INTR_MODE_MSIX)
 547                 pci_disable_msix(udev->pdev);
 548         pci_release_regions(dev);
 549 fail_disable:
 550         pci_disable_device(dev);
 551 fail_free:
 552         kfree(udev);
 553
 554         return err;
 555 }
 556
 557 static void
 558 igbuio_pci_remove(struct pci_dev *dev)
 559 {
 560         struct uio_info *info = pci_get_drvdata(dev);
 561         struct rte_uio_pci_dev *udev;
 562
 563         if (info->priv == NULL) {
 564                 pr_notice("Not igbuio device\n");
 565                 return;
 566         }
 567         udev = info->priv;
 568
 569         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
 570         uio_unregister_device(info);
 571         igbuio_pci_release_iomem(info);
 572         if (udev->mode == RTE_INTR_MODE_MSIX)
 573                 pci_disable_msix(dev);
 574         pci_release_regions(dev);
 575         pci_disable_device(dev);
 576         pci_set_drvdata(dev, NULL);
 577         kfree(info);
 578 }
 579
 580 static int
 581 igbuio_config_intr_mode(char *intr_str)
 582 {
 583         if (!intr_str) {
 584                 pr_info("Use MSIX interrupt by default\n");
 585                 return 0;
 586         }
 587
 588         if (!strcmp(intr_str, RTE_INTR_MODE_MSIX_NAME)) {
 589                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
 590                 pr_info("Use MSIX interrupt\n");
 591         } else if (!strcmp(intr_str, RTE_INTR_MODE_LEGACY_NAME)) {
 592                 igbuio_intr_mode_preferred = RTE_INTR_MODE_LEGACY;
 593                 pr_info("Use legacy interrupt\n");
 594         } else {
 595                 pr_info("Error: bad parameter - %s\n", intr_str);
 596                 return -EINVAL;
 597         }
 598
 599         return 0;
 600 }
 601
 602 static struct pci_driver igbuio_pci_driver = {
 603         .name = "igb_uio",
 604         .id_table = NULL,
 605         .probe = igbuio_pci_probe,
 606         .remove = igbuio_pci_remove,
 607 };
 608
 609 static int __init
 610 igbuio_pci_init_module(void)
 611 {
 612         int ret;
 613
 614         ret = igbuio_config_intr_mode(intr_mode);
 615         if (ret < 0)
 616                 return ret;
 617
 618         return pci_register_driver(&igbuio_pci_driver);
 619 }
 620
 621 static void __exit
 622 igbuio_pci_exit_module(void)
 623 {
 624         pci_unregister_driver(&igbuio_pci_driver);
 625 }
 626
 627 module_init(igbuio_pci_init_module);
 628 module_exit(igbuio_pci_exit_module);
 629
 630 module_param(intr_mode, charp, S_IRUGO);
 631 MODULE_PARM_DESC(intr_mode,
 632 "igb_uio interrupt mode (default=msix):\n"
 633 "    " RTE_INTR_MODE_MSIX_NAME "       Use MSIX interrupt\n"
 634 "    " RTE_INTR_MODE_LEGACY_NAME "     Use Legacy interrupt\n"
 635 "\n");
 636
 637 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
 638 MODULE_LICENSE("GPL");
 639 MODULE_AUTHOR("Intel Corporation");