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 /**
  96  * This is the irqcontrol callback to be registered to uio_info.
  97  * It can be used to disable/enable interrupt from user space processes.
  98  *
  99  * @param info
 100  *  pointer to uio_info.
 101  * @param irq_state
 102  *  state value. 1 to enable interrupt, 0 to disable interrupt.
 103  *
 104  * @return
 105  *  - On success, 0.
 106  *  - On failure, a negative value.
 107  */
 108 static int
 109 igbuio_pci_irqcontrol(struct uio_info *info, s32 irq_state)
 110 {
 111         struct rte_uio_pci_dev *udev = info->priv;
 112         struct pci_dev *pdev = udev->pdev;
 113
 114 #ifdef HAVE_IRQ_DATA
 115         struct irq_data *irq = irq_get_irq_data(udev->info.irq);
 116 #else
 117         unsigned int irq = udev->info.irq;
 118 #endif
 119
 120         pci_cfg_access_lock(pdev);
 121
 122         if (udev->mode == RTE_INTR_MODE_MSIX || udev->mode == RTE_INTR_MODE_MSI) {
 123 #ifdef HAVE_PCI_MSI_MASK_IRQ
 124                 if (irq_state == 1)
 125                         pci_msi_unmask_irq(irq);
 126                 else
 127                         pci_msi_mask_irq(irq);
 128 #else
 129                 if (irq_state == 1)
 130                         unmask_msi_irq(irq);
 131                 else
 132                         mask_msi_irq(irq);
 133 #endif
 134         }
 135
 136         if (udev->mode == RTE_INTR_MODE_LEGACY)
 137                 pci_intx(pdev, !!irq_state);
 138
 139         pci_cfg_access_unlock(pdev);
 140
 141         return 0;
 142 }
 143
 144 /**
 145  * This is interrupt handler which will check if the interrupt is for the right device.
 146  * If yes, disable it here and will be enable later.
 147  */
 148 static irqreturn_t
 149 igbuio_pci_irqhandler(int irq, struct uio_info *info)
 150 {
 151         struct rte_uio_pci_dev *udev = info->priv;
 152
 153         /* Legacy mode need to mask in hardware */
 154         if (udev->mode == RTE_INTR_MODE_LEGACY &&
 155             !pci_check_and_mask_intx(udev->pdev))
 156                 return IRQ_NONE;
 157
 158         /* Message signal mode, no share IRQ and automasked */
 159         return IRQ_HANDLED;
 160 }
 161
 162 /**
 163  * This gets called while opening uio device file.
 164  */
 165 static int
 166 igbuio_pci_open(struct uio_info *info, struct inode *inode)
 167 {
 168         struct rte_uio_pci_dev *udev = info->priv;
 169         struct pci_dev *dev = udev->pdev;
 170
 171         pci_reset_function(dev);
 172
 173         /* set bus master, which was cleared by the reset function */
 174         pci_set_master(dev);
 175
 176         return 0;
 177 }
 178
 179 static int
 180 igbuio_pci_release(struct uio_info *info, struct inode *inode)
 181 {
 182         struct rte_uio_pci_dev *udev = info->priv;
 183         struct pci_dev *dev = udev->pdev;
 184
 185         /* stop the device from further DMA */
 186         pci_clear_master(dev);
 187
 188         pci_reset_function(dev);
 189
 190         return 0;
 191 }
 192
 193 #ifdef CONFIG_XEN_DOM0
 194 static int
 195 igbuio_dom0_mmap_phys(struct uio_info *info, struct vm_area_struct *vma)
 196 {
 197         int idx;
 198
 199         idx = (int)vma->vm_pgoff;
 200         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
 201 #ifdef HAVE_PTE_MASK_PAGE_IOMAP
 202         vma->vm_page_prot.pgprot |= _PAGE_IOMAP;
 203 #endif
 204
 205         return remap_pfn_range(vma,
 206                         vma->vm_start,
 207                         info->mem[idx].addr >> PAGE_SHIFT,
 208                         vma->vm_end - vma->vm_start,
 209                         vma->vm_page_prot);
 210 }
 211
 212 /**
 213  * This is uio device mmap method which will use igbuio mmap for Xen
 214  * Dom0 environment.
 215  */
 216 static int
 217 igbuio_dom0_pci_mmap(struct uio_info *info, struct vm_area_struct *vma)
 218 {
 219         int idx;
 220
 221         if (vma->vm_pgoff >= MAX_UIO_MAPS)
 222                 return -EINVAL;
 223
 224         if (info->mem[vma->vm_pgoff].size == 0)
 225                 return -EINVAL;
 226
 227         idx = (int)vma->vm_pgoff;
 228         switch (info->mem[idx].memtype) {
 229         case UIO_MEM_PHYS:
 230                 return igbuio_dom0_mmap_phys(info, vma);
 231         case UIO_MEM_LOGICAL:
 232         case UIO_MEM_VIRTUAL:
 233         default:
 234                 return -EINVAL;
 235         }
 236 }
 237 #endif
 238
 239 /* Remap pci resources described by bar #pci_bar in uio resource n. */
 240 static int
 241 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
 242                        int n, int pci_bar, const char *name)
 243 {
 244         unsigned long addr, len;
 245         void *internal_addr;
 246
 247         if (n >= ARRAY_SIZE(info->mem))
 248                 return -EINVAL;
 249
 250         addr = pci_resource_start(dev, pci_bar);
 251         len = pci_resource_len(dev, pci_bar);
 252         if (addr == 0 || len == 0)
 253                 return -1;
 254         internal_addr = ioremap(addr, len);
 255         if (internal_addr == NULL)
 256                 return -1;
 257         info->mem[n].name = name;
 258         info->mem[n].addr = addr;
 259         info->mem[n].internal_addr = internal_addr;
 260         info->mem[n].size = len;
 261         info->mem[n].memtype = UIO_MEM_PHYS;
 262         return 0;
 263 }
 264
 265 /* Get pci port io resources described by bar #pci_bar in uio resource n. */
 266 static int
 267 igbuio_pci_setup_ioport(struct pci_dev *dev, struct uio_info *info,
 268                 int n, int pci_bar, const char *name)
 269 {
 270         unsigned long addr, len;
 271
 272         if (n >= ARRAY_SIZE(info->port))
 273                 return -EINVAL;
 274
 275         addr = pci_resource_start(dev, pci_bar);
 276         len = pci_resource_len(dev, pci_bar);
 277         if (addr == 0 || len == 0)
 278                 return -EINVAL;
 279
 280         info->port[n].name = name;
 281         info->port[n].start = addr;
 282         info->port[n].size = len;
 283         info->port[n].porttype = UIO_PORT_X86;
 284
 285         return 0;
 286 }
 287
 288 /* Unmap previously ioremap'd resources */
 289 static void
 290 igbuio_pci_release_iomem(struct uio_info *info)
 291 {
 292         int i;
 293
 294         for (i = 0; i < MAX_UIO_MAPS; i++) {
 295                 if (info->mem[i].internal_addr)
 296                         iounmap(info->mem[i].internal_addr);
 297         }
 298 }
 299
 300 static int
 301 igbuio_pci_enable_interrupts(struct rte_uio_pci_dev *udev)
 302 {
 303         int err = 0;
 304 #ifndef HAVE_ALLOC_IRQ_VECTORS
 305         struct msix_entry msix_entry;
 306 #endif
 307
 308         switch (igbuio_intr_mode_preferred) {
 309         case RTE_INTR_MODE_MSIX:
 310                 /* Only 1 msi-x vector needed */
 311 #ifndef HAVE_ALLOC_IRQ_VECTORS
 312                 msix_entry.entry = 0;
 313                 if (pci_enable_msix(udev->pdev, &msix_entry, 1) == 0) {
 314                         dev_dbg(&udev->pdev->dev, "using MSI-X");
 315                         udev->info.irq_flags = IRQF_NO_THREAD;
 316                         udev->info.irq = msix_entry.vector;
 317                         udev->mode = RTE_INTR_MODE_MSIX;
 318                         break;
 319                 }
 320 #else
 321                 if (pci_alloc_irq_vectors(udev->pdev, 1, 1, PCI_IRQ_MSIX) == 1) {
 322                         dev_dbg(&udev->pdev->dev, "using MSI-X");
 323                         udev->info.irq_flags = IRQF_NO_THREAD;
 324                         udev->info.irq = pci_irq_vector(udev->pdev, 0);
 325                         udev->mode = RTE_INTR_MODE_MSIX;
 326                         break;
 327                 }
 328 #endif
 329         /* fall back to MSI */
 330         case RTE_INTR_MODE_MSI:
 331 #ifndef HAVE_ALLOC_IRQ_VECTORS
 332                 if (pci_enable_msi(udev->pdev) == 0) {
 333                         dev_dbg(&udev->pdev->dev, "using MSI");
 334                         udev->info.irq_flags = IRQF_NO_THREAD;
 335                         udev->info.irq = udev->pdev->irq;
 336                         udev->mode = RTE_INTR_MODE_MSI;
 337                         break;
 338                 }
 339 #else
 340                 if (pci_alloc_irq_vectors(udev->pdev, 1, 1, PCI_IRQ_MSI) == 1) {
 341                         dev_dbg(&udev->pdev->dev, "using MSI");
 342                         udev->info.irq_flags = IRQF_NO_THREAD;
 343                         udev->info.irq = pci_irq_vector(udev->pdev, 0);
 344                         udev->mode = RTE_INTR_MODE_MSI;
 345                         break;
 346                 }
 347 #endif
 348         /* fall back to INTX */
 349         case RTE_INTR_MODE_LEGACY:
 350                 if (pci_intx_mask_supported(udev->pdev)) {
 351                         dev_dbg(&udev->pdev->dev, "using INTX");
 352                         udev->info.irq_flags = IRQF_SHARED | IRQF_NO_THREAD;
 353                         udev->info.irq = udev->pdev->irq;
 354                         udev->mode = RTE_INTR_MODE_LEGACY;
 355                         break;
 356                 }
 357                 dev_notice(&udev->pdev->dev, "PCI INTX mask not supported\n");
 358         /* fall back to no IRQ */
 359         case RTE_INTR_MODE_NONE:
 360                 udev->mode = RTE_INTR_MODE_NONE;
 361                 udev->info.irq = UIO_IRQ_NONE;
 362                 break;
 363
 364         default:
 365                 dev_err(&udev->pdev->dev, "invalid IRQ mode %u",
 366                         igbuio_intr_mode_preferred);
 367                 err = -EINVAL;
 368         }
 369
 370         return err;
 371 }
 372
 373 static void
 374 igbuio_pci_disable_interrupts(struct rte_uio_pci_dev *udev)
 375 {
 376 #ifndef HAVE_ALLOC_IRQ_VECTORS
 377         if (udev->mode == RTE_INTR_MODE_MSIX)
 378                 pci_disable_msix(udev->pdev);
 379         if (udev->mode == RTE_INTR_MODE_MSI)
 380                 pci_disable_msi(udev->pdev);
 381 #else
 382         if (udev->mode == RTE_INTR_MODE_MSIX ||
 383             udev->mode == RTE_INTR_MODE_MSI)
 384                 pci_free_irq_vectors(udev->pdev);
 385 #endif
 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 || iop != 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         dma_addr_t map_dma_addr;
 437         void *map_addr;
 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         /* enable bus mastering on the device */
 455         pci_set_master(dev);
 456
 457         /* remap IO memory */
 458         err = igbuio_setup_bars(dev, &udev->info);
 459         if (err != 0)
 460                 goto fail_release_iomem;
 461
 462         /* set 64-bit DMA mask */
 463         err = pci_set_dma_mask(dev,  DMA_BIT_MASK(64));
 464         if (err != 0) {
 465                 dev_err(&dev->dev, "Cannot set DMA mask\n");
 466                 goto fail_release_iomem;
 467         }
 468
 469         err = pci_set_consistent_dma_mask(dev, DMA_BIT_MASK(64));
 470         if (err != 0) {
 471                 dev_err(&dev->dev, "Cannot set consistent DMA mask\n");
 472                 goto fail_release_iomem;
 473         }
 474
 475         /* fill uio infos */
 476         udev->info.name = "igb_uio";
 477         udev->info.version = "0.1";
 478         udev->info.handler = igbuio_pci_irqhandler;
 479         udev->info.irqcontrol = igbuio_pci_irqcontrol;
 480         udev->info.open = igbuio_pci_open;
 481         udev->info.release = igbuio_pci_release;
 482 #ifdef CONFIG_XEN_DOM0
 483         /* check if the driver run on Xen Dom0 */
 484         if (xen_initial_domain())
 485                 udev->info.mmap = igbuio_dom0_pci_mmap;
 486 #endif
 487         udev->info.priv = udev;
 488         udev->pdev = dev;
 489
 490         err = igbuio_pci_enable_interrupts(udev);
 491         if (err != 0)
 492                 goto fail_release_iomem;
 493
 494         err = sysfs_create_group(&dev->dev.kobj, &dev_attr_grp);
 495         if (err != 0)
 496                 goto fail_disable_interrupts;
 497
 498         /* register uio driver */
 499         err = uio_register_device(&dev->dev, &udev->info);
 500         if (err != 0)
 501                 goto fail_remove_group;
 502
 503         pci_set_drvdata(dev, udev);
 504
 505         dev_info(&dev->dev, "uio device registered with irq %lx\n",
 506                  udev->info.irq);
 507
 508         /*
 509          * Doing a harmless dma mapping for attaching the device to
 510          * the iommu identity mapping if kernel boots with iommu=pt.
 511          * Note this is not a problem if no IOMMU at all.
 512          */
 513         map_addr = dma_alloc_coherent(&dev->dev, 1024, &map_dma_addr,
 514                         GFP_KERNEL);
 515         if (map_addr)
 516                 memset(map_addr, 0, 1024);
 517
 518         if (!map_addr)
 519                 dev_info(&dev->dev, "dma mapping failed\n");
 520         else {
 521                 dev_info(&dev->dev, "mapping 1K dma=%#llx host=%p\n",
 522                          (unsigned long long)map_dma_addr, map_addr);
 523
 524                 dma_free_coherent(&dev->dev, 1024, map_addr, map_dma_addr);
 525                 dev_info(&dev->dev, "unmapping 1K dma=%#llx host=%p\n",
 526                          (unsigned long long)map_dma_addr, map_addr);
 527         }
 528
 529         return 0;
 530
 531 fail_remove_group:
 532         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
 533 fail_disable_interrupts:
 534         igbuio_pci_disable_interrupts(udev);
 535 fail_release_iomem:
 536         igbuio_pci_release_iomem(&udev->info);
 537         pci_disable_device(dev);
 538 fail_free:
 539         kfree(udev);
 540
 541         return err;
 542 }
 543
 544 static void
 545 igbuio_pci_remove(struct pci_dev *dev)
 546 {
 547         struct rte_uio_pci_dev *udev = pci_get_drvdata(dev);
 548
 549         sysfs_remove_group(&dev->dev.kobj, &dev_attr_grp);
 550         uio_unregister_device(&udev->info);
 551         igbuio_pci_disable_interrupts(udev);
 552         igbuio_pci_release_iomem(&udev->info);
 553         pci_disable_device(dev);
 554         pci_set_drvdata(dev, NULL);
 555         kfree(udev);
 556 }
 557
 558 static int
 559 igbuio_config_intr_mode(char *intr_str)
 560 {
 561         if (!intr_str) {
 562                 pr_info("Use MSIX interrupt by default\n");
 563                 return 0;
 564         }
 565
 566         if (!strcmp(intr_str, RTE_INTR_MODE_MSIX_NAME)) {
 567                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSIX;
 568                 pr_info("Use MSIX interrupt\n");
 569         } else if (!strcmp(intr_str, RTE_INTR_MODE_MSI_NAME)) {
 570                 igbuio_intr_mode_preferred = RTE_INTR_MODE_MSI;
 571                 pr_info("Use MSI interrupt\n");
 572         } else if (!strcmp(intr_str, RTE_INTR_MODE_LEGACY_NAME)) {
 573                 igbuio_intr_mode_preferred = RTE_INTR_MODE_LEGACY;
 574                 pr_info("Use legacy interrupt\n");
 575         } else {
 576                 pr_info("Error: bad parameter - %s\n", intr_str);
 577                 return -EINVAL;
 578         }
 579
 580         return 0;
 581 }
 582
 583 static struct pci_driver igbuio_pci_driver = {
 584         .name = "igb_uio",
 585         .id_table = NULL,
 586         .probe = igbuio_pci_probe,
 587         .remove = igbuio_pci_remove,
 588 };
 589
 590 static int __init
 591 igbuio_pci_init_module(void)
 592 {
 593         int ret;
 594
 595         ret = igbuio_config_intr_mode(intr_mode);
 596         if (ret < 0)
 597                 return ret;
 598
 599         return pci_register_driver(&igbuio_pci_driver);
 600 }
 601
 602 static void __exit
 603 igbuio_pci_exit_module(void)
 604 {
 605         pci_unregister_driver(&igbuio_pci_driver);
 606 }
 607
 608 module_init(igbuio_pci_init_module);
 609 module_exit(igbuio_pci_exit_module);
 610
 611 module_param(intr_mode, charp, S_IRUGO);
 612 MODULE_PARM_DESC(intr_mode,
 613 "igb_uio interrupt mode (default=msix):\n"
 614 "    " RTE_INTR_MODE_MSIX_NAME "       Use MSIX interrupt\n"
 615 "    " RTE_INTR_MODE_MSI_NAME "        Use MSI interrupt\n"
 616 "    " RTE_INTR_MODE_LEGACY_NAME "     Use Legacy interrupt\n"
 617 "\n");
 618
 619 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
 620 MODULE_LICENSE("GPL");
 621 MODULE_AUTHOR("Intel Corporation");