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