lib/librte_eal/linuxapp/igb_uio/igb_uio.c

   1 /*-
   2  * GPL LICENSE SUMMARY
   3  *
   4  *   Copyright(c) 2010-2012 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
  26 #include <linux/device.h>
  27 #include <linux/module.h>
  28 #include <linux/pci.h>
  29 #include <linux/uio_driver.h>
  30 #include <linux/io.h>
  31 #include <linux/msi.h>
  32 #include <linux/version.h>
  33
  34 /**
  35  * MSI-X related macros, copy from linux/pci_regs.h in kernel 2.6.39,
  36  * but none of them in kernel 2.6.35.
  37  */
  38 #ifndef PCI_MSIX_ENTRY_SIZE
  39 #define PCI_MSIX_ENTRY_SIZE             16
  40 #define PCI_MSIX_ENTRY_LOWER_ADDR       0
  41 #define PCI_MSIX_ENTRY_UPPER_ADDR       4
  42 #define PCI_MSIX_ENTRY_DATA             8
  43 #define PCI_MSIX_ENTRY_VECTOR_CTRL      12
  44 #define PCI_MSIX_ENTRY_CTRL_MASKBIT     1
  45 #endif
  46
  47 #define IGBUIO_NUM_MSI_VECTORS 1
  48
  49 /* interrupt mode */
  50 enum igbuio_intr_mode {
  51         IGBUIO_LEGACY_INTR_MODE = 0,
  52         IGBUIO_MSI_INTR_MODE,
  53         IGBUIO_MSIX_INTR_MODE,
  54         IGBUIO_INTR_MODE_MAX
  55 };
  56
  57 /**
  58  * A structure describing the private information for a uio device.
  59  */
  60 struct rte_uio_pci_dev {
  61         struct uio_info info;
  62         struct pci_dev *pdev;
  63         spinlock_t lock; /* spinlock for accessing PCI config space or msix data in multi tasks/isr */
  64         enum igbuio_intr_mode mode;
  65         struct msix_entry \
  66                 msix_entries[IGBUIO_NUM_MSI_VECTORS]; /* pointer to the msix vectors to be allocated later */
  67 };
  68
  69 static char *intr_mode = NULL;
  70 static enum igbuio_intr_mode igbuio_intr_mode_preferred = IGBUIO_MSIX_INTR_MODE;
  71
  72 /* PCI device id table */
  73 static struct pci_device_id igbuio_pci_ids[] = {
  74 #define RTE_PCI_DEV_ID_DECL_EM(vend, dev) {PCI_DEVICE(vend, dev)},
  75 #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) {PCI_DEVICE(vend, dev)},
  76 #define RTE_PCI_DEV_ID_DECL_IGBVF(vend, dev) {PCI_DEVICE(vend, dev)},
  77 #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) {PCI_DEVICE(vend, dev)},
  78 #define RTE_PCI_DEV_ID_DECL_IXGBEVF(vend, dev) {PCI_DEVICE(vend, dev)},
  79 #include <rte_pci_dev_ids.h>
  80 { 0, },
  81 };
  82
  83 MODULE_DEVICE_TABLE(pci, igbuio_pci_ids);
  84
  85 static inline struct rte_uio_pci_dev *
  86 igbuio_get_uio_pci_dev(struct uio_info *info)
  87 {
  88         return container_of(info, struct rte_uio_pci_dev, info);
  89 }
  90
  91 static inline int
  92 pci_lock(struct pci_dev * pdev)
  93 {
  94         /* Some function names changes between 3.2.0 and 3.3.0... */
  95 #if LINUX_VERSION_CODE < KERNEL_VERSION(3,3,0)
  96         pci_block_user_cfg_access(pdev);
  97         return 1;
  98 #else
  99         return pci_cfg_access_trylock(pdev);
 100 #endif
 101 }
 102
 103 static inline void
 104 pci_unlock(struct pci_dev * pdev)
 105 {
 106         /* Some function names changes between 3.2.0 and 3.3.0... */
 107 #if LINUX_VERSION_CODE < KERNEL_VERSION(3,3,0)
 108         pci_unblock_user_cfg_access(pdev);
 109 #else
 110         pci_cfg_access_unlock(pdev);
 111 #endif
 112 }
 113
 114 /**
 115  * It masks the msix on/off of generating MSI-X messages.
 116  */
 117 static int
 118 igbuio_msix_mask_irq(struct msi_desc *desc, int32_t state)
 119 {
 120         uint32_t mask_bits = desc->masked;
 121         unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
 122                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 123
 124         if (state != 0)
 125                 mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
 126         else
 127                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
 128
 129         if (mask_bits != desc->masked) {
 130                 writel(mask_bits, desc->mask_base + offset);
 131                 readl(desc->mask_base);
 132                 desc->masked = mask_bits;
 133         }
 134
 135         return 0;
 136 }
 137
 138 /**
 139  * This function sets/clears the masks for generating LSC interrupts.
 140  *
 141  * @param info
 142  *   The pointer to struct uio_info.
 143  * @param on
 144  *   The on/off flag of masking LSC.
 145  * @return
 146  *   -On success, zero value.
 147  *   -On failure, a negative value.
 148  */
 149 static int
 150 igbuio_set_interrupt_mask(struct rte_uio_pci_dev *udev, int32_t state)
 151 {
 152         struct pci_dev *pdev = udev->pdev;
 153
 154         if (udev->mode == IGBUIO_MSIX_INTR_MODE) {
 155                 struct msi_desc *desc;
 156
 157                 list_for_each_entry(desc, &pdev->msi_list, list) {
 158                         igbuio_msix_mask_irq(desc, state);
 159                 }
 160         }
 161         else if (udev->mode == IGBUIO_LEGACY_INTR_MODE) {
 162                 uint32_t status;
 163                 uint16_t old, new;
 164
 165                 pci_read_config_dword(pdev, PCI_COMMAND, &status);
 166                 old = status;
 167                 if (state != 0)
 168                         new = old & (~PCI_COMMAND_INTX_DISABLE);
 169                 else
 170                         new = old | PCI_COMMAND_INTX_DISABLE;
 171
 172                 if (old != new)
 173                         pci_write_config_word(pdev, PCI_COMMAND, new);
 174         }
 175
 176         return 0;
 177 }
 178
 179 /**
 180  * This is the irqcontrol callback to be registered to uio_info.
 181  * It can be used to disable/enable interrupt from user space processes.
 182  *
 183  * @param info
 184  *  pointer to uio_info.
 185  * @param irq_state
 186  *  state value. 1 to enable interrupt, 0 to disable interrupt.
 187  *
 188  * @return
 189  *  - On success, 0.
 190  *  - On failure, a negative value.
 191  */
 192 static int
 193 igbuio_pci_irqcontrol(struct uio_info *info, s32 irq_state)
 194 {
 195         unsigned long flags;
 196         struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
 197         struct pci_dev *pdev = udev->pdev;
 198
 199         spin_lock_irqsave(&udev->lock, flags);
 200         if (!pci_lock(pdev)) {
 201                 spin_unlock_irqrestore(&udev->lock, flags);
 202                 return -1;
 203         }
 204
 205         igbuio_set_interrupt_mask(udev, irq_state);
 206
 207         pci_unlock(pdev);
 208         spin_unlock_irqrestore(&udev->lock, flags);
 209
 210         return 0;
 211 }
 212
 213 /**
 214  * This is interrupt handler which will check if the interrupt is for the right device.
 215  * If yes, disable it here and will be enable later.
 216  */
 217 static irqreturn_t
 218 igbuio_pci_irqhandler(int irq, struct uio_info *info)
 219 {
 220         irqreturn_t ret = IRQ_NONE;
 221         unsigned long flags;
 222         struct rte_uio_pci_dev *udev = igbuio_get_uio_pci_dev(info);
 223         struct pci_dev *pdev = udev->pdev;
 224         uint32_t cmd_status_dword;
 225         uint16_t status;
 226
 227         spin_lock_irqsave(&udev->lock, flags);
 228         /* block userspace PCI config reads/writes */
 229         if (!pci_lock(pdev))
 230                 goto spin_unlock;
 231
 232         /* for legacy mode, interrupt maybe shared */
 233         if (udev->mode == IGBUIO_LEGACY_INTR_MODE) {
 234                 pci_read_config_dword(pdev, PCI_COMMAND, &cmd_status_dword);
 235                 status = cmd_status_dword >> 16;
 236                 /* interrupt is not ours, goes to out */
 237                 if (!(status & PCI_STATUS_INTERRUPT))
 238                         goto done;
 239         }
 240
 241         igbuio_set_interrupt_mask(udev, 0);
 242         ret = IRQ_HANDLED;
 243 done:
 244         /* unblock userspace PCI config reads/writes */
 245         pci_unlock(pdev);
 246 spin_unlock:
 247         spin_unlock_irqrestore(&udev->lock, flags);
 248         printk(KERN_INFO "irq 0x%x %s\n", irq, (ret == IRQ_HANDLED) ? "handled" : "not handled");
 249
 250         return ret;
 251 }
 252
 253 /* Remap pci resources described by bar #pci_bar in uio resource n. */
 254 static int
 255 igbuio_pci_setup_iomem(struct pci_dev *dev, struct uio_info *info,
 256                        int n, int pci_bar, const char *name)
 257 {
 258         unsigned long addr, len;
 259         void *internal_addr;
 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 /* Unmap previously ioremap'd resources */
 277 static void
 278 igbuio_pci_release_iomem(struct uio_info *info)
 279 {
 280         int i;
 281         for (i = 0; i < MAX_UIO_MAPS; i++) {
 282                 if (info->mem[i].internal_addr)
 283                         iounmap(info->mem[i].internal_addr);
 284         }
 285 }
 286
 287 #if LINUX_VERSION_CODE < KERNEL_VERSION(3,8,0)
 288 static int __devinit
 289 #else
 290 static int
 291 #endif
 292 igbuio_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
 293 {
 294         struct rte_uio_pci_dev *udev;
 295
 296         udev = kzalloc(sizeof(struct rte_uio_pci_dev), GFP_KERNEL);
 297         if (!udev)
 298                 return -ENOMEM;
 299
 300         /*
 301          * enable device: ask low-level code to enable I/O and
 302          * memory
 303          */
 304         if (pci_enable_device(dev)) {
 305                 printk(KERN_ERR "Cannot enable PCI device\n");
 306                 goto fail_free;
 307         }
 308
 309         /* XXX should we use 64 bits ? */
 310         /* set 32-bit DMA mask */
 311         if (pci_set_dma_mask(dev,(uint64_t)0xffffffff)) {
 312                 printk(KERN_ERR "Cannot set DMA mask\n");
 313                 goto fail_disable;
 314         }
 315
 316         /*
 317          * reserve device's PCI memory regions for use by this
 318          * module
 319          */
 320         if (pci_request_regions(dev, "igb_uio")) {
 321                 printk(KERN_ERR "Cannot request regions\n");
 322                 goto fail_disable;
 323         }
 324
 325         /* enable bus mastering on the device */
 326         pci_set_master(dev);
 327
 328         /* remap IO memory */
 329         if (igbuio_pci_setup_iomem(dev, &udev->info, 0, 0, "config"))
 330                 goto fail_release_regions;
 331
 332         /* fill uio infos */
 333         udev->info.name = "Intel IGB UIO";
 334         udev->info.version = "0.1";
 335         udev->info.handler = igbuio_pci_irqhandler;
 336         udev->info.irqcontrol = igbuio_pci_irqcontrol;
 337         udev->info.priv = udev;
 338         udev->pdev = dev;
 339         udev->mode = 0; /* set the default value for interrupt mode */
 340         spin_lock_init(&udev->lock);
 341
 342         /* check if it need to try msix first */
 343         if (igbuio_intr_mode_preferred == IGBUIO_MSIX_INTR_MODE) {
 344                 int vector;
 345
 346                 for (vector = 0; vector < IGBUIO_NUM_MSI_VECTORS; vector ++)
 347                         udev->msix_entries[vector].entry = vector;
 348
 349                 if (pci_enable_msix(udev->pdev, udev->msix_entries, IGBUIO_NUM_MSI_VECTORS) == 0) {
 350                         udev->mode = IGBUIO_MSIX_INTR_MODE;
 351                 }
 352                 else {
 353                         pci_disable_msix(udev->pdev);
 354                         printk(KERN_INFO "fail to enable pci msix, or not enough msix entries\n");
 355                 }
 356         }
 357         switch (udev->mode) {
 358         case IGBUIO_MSIX_INTR_MODE:
 359                 udev->info.irq_flags = 0;
 360                 udev->info.irq = udev->msix_entries[0].vector;
 361                 break;
 362         case IGBUIO_MSI_INTR_MODE:
 363                 break;
 364         case IGBUIO_LEGACY_INTR_MODE:
 365                 udev->info.irq_flags = IRQF_SHARED;
 366                 udev->info.irq = dev->irq;
 367                 break;
 368         default:
 369                 break;
 370         }
 371
 372         pci_set_drvdata(dev, udev);
 373         igbuio_pci_irqcontrol(&udev->info, 0);
 374
 375         /* register uio driver */
 376         if (uio_register_device(&dev->dev, &udev->info))
 377                 goto fail_release_iomem;
 378
 379         printk(KERN_INFO "uio device registered with irq %lx\n", udev->info.irq);
 380
 381         return 0;
 382
 383 fail_release_iomem:
 384         igbuio_pci_release_iomem(&udev->info);
 385         if (udev->mode == IGBUIO_MSIX_INTR_MODE)
 386                 pci_disable_msix(udev->pdev);
 387 fail_release_regions:
 388         pci_release_regions(dev);
 389 fail_disable:
 390         pci_disable_device(dev);
 391 fail_free:
 392         kfree(udev);
 393
 394         return -ENODEV;
 395 }
 396
 397 static void
 398 igbuio_pci_remove(struct pci_dev *dev)
 399 {
 400         struct uio_info *info = pci_get_drvdata(dev);
 401
 402         if (info->priv == NULL) {
 403                 printk(KERN_DEBUG "Not igbuio device\n");
 404                 return;
 405         }
 406
 407         uio_unregister_device(info);
 408         igbuio_pci_release_iomem(info);
 409         if (((struct rte_uio_pci_dev *)info->priv)->mode ==
 410                                         IGBUIO_MSIX_INTR_MODE)
 411                 pci_disable_msix(dev);
 412         pci_release_regions(dev);
 413         pci_disable_device(dev);
 414         pci_set_drvdata(dev, NULL);
 415         kfree(info);
 416 }
 417
 418 static int
 419 igbuio_config_intr_mode(char *intr_str)
 420 {
 421         if (!intr_str) {
 422                 printk(KERN_INFO "Use MSIX interrupt by default\n");
 423                 return 0;
 424         }
 425
 426         if (!strcmp(intr_str, "msix")) {
 427                 igbuio_intr_mode_preferred = IGBUIO_MSIX_INTR_MODE;
 428                 printk(KERN_INFO "Use MSIX interrupt\n");
 429         } else if (!strcmp(intr_str, "legacy")) {
 430                 igbuio_intr_mode_preferred = IGBUIO_LEGACY_INTR_MODE;
 431                 printk(KERN_INFO "Use legacy interrupt\n");
 432         } else {
 433                 printk(KERN_INFO "Error: bad parameter - %s\n", intr_str);
 434                 return -EINVAL;
 435         }
 436
 437         return 0;
 438 }
 439
 440 static struct pci_driver igbuio_pci_driver = {
 441         .name = "igb_uio",
 442         .id_table = igbuio_pci_ids,
 443         .probe = igbuio_pci_probe,
 444         .remove = igbuio_pci_remove,
 445 };
 446
 447 static int __init
 448 igbuio_pci_init_module(void)
 449 {
 450         int ret;
 451
 452         ret = igbuio_config_intr_mode(intr_mode);
 453         if (ret < 0)
 454                 return ret;
 455
 456         return pci_register_driver(&igbuio_pci_driver);
 457 }
 458
 459 static void __exit
 460 igbuio_pci_exit_module(void)
 461 {
 462         pci_unregister_driver(&igbuio_pci_driver);
 463 }
 464
 465 module_init(igbuio_pci_init_module);
 466 module_exit(igbuio_pci_exit_module);
 467
 468 module_param(intr_mode, charp, S_IRUGO | S_IWUSR);
 469 MODULE_PARM_DESC(intr_mode,
 470 "igb_uio interrupt mode (default=msix):\n"
 471 "    msix       Use MSIX interrupt\n"
 472 "    legacy     Use Legacy interrupt\n"
 473 "\n");
 474
 475 MODULE_DESCRIPTION("UIO driver for Intel IGB PCI cards");
 476 MODULE_LICENSE("GPL");
 477 MODULE_AUTHOR("Intel Corporation");