drivers/pci/msi.c

   1 /*
   2  * File:        msi.c
   3  * Purpose:     PCI Message Signaled Interrupt (MSI)
   4  *
   5  * Copyright (C) 2003-2004 Intel
   6  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
   7  */
   8
   9 #include <linux/err.h>
  10 #include <linux/mm.h>
  11 #include <linux/irq.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/init.h>
  14 #include <linux/export.h>
  15 #include <linux/ioport.h>
  16 #include <linux/pci.h>
  17 #include <linux/proc_fs.h>
  18 #include <linux/msi.h>
  19 #include <linux/smp.h>
  20 #include <linux/errno.h>
  21 #include <linux/io.h>
  22 #include <linux/slab.h>
  23
  24 #include "pci.h"
  25 #include "msi.h"
  26
  27 static int pci_msi_enable = 1;
  28
  29 #define msix_table_size(flags)  ((flags & PCI_MSIX_FLAGS_QSIZE) + 1)
  30
  31
  32 /* Arch hooks */
  33
  34 #ifndef arch_msi_check_device
  35 int arch_msi_check_device(struct pci_dev *dev, int nvec, int type)
  36 {
  37         return 0;
  38 }
  39 #endif
  40
  41 #ifndef arch_setup_msi_irqs
  42 # define arch_setup_msi_irqs default_setup_msi_irqs
  43 # define HAVE_DEFAULT_MSI_SETUP_IRQS
  44 #endif
  45
  46 #ifdef HAVE_DEFAULT_MSI_SETUP_IRQS
  47 int default_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
  48 {
  49         struct msi_desc *entry;
  50         int ret;
  51
  52         /*
  53          * If an architecture wants to support multiple MSI, it needs to
  54          * override arch_setup_msi_irqs()
  55          */
  56         if (type == PCI_CAP_ID_MSI && nvec > 1)
  57                 return 1;
  58
  59         list_for_each_entry(entry, &dev->msi_list, list) {
  60                 ret = arch_setup_msi_irq(dev, entry);
  61                 if (ret < 0)
  62                         return ret;
  63                 if (ret > 0)
  64                         return -ENOSPC;
  65         }
  66
  67         return 0;
  68 }
  69 #endif
  70
  71 #ifndef arch_teardown_msi_irqs
  72 # define arch_teardown_msi_irqs default_teardown_msi_irqs
  73 # define HAVE_DEFAULT_MSI_TEARDOWN_IRQS
  74 #endif
  75
  76 #ifdef HAVE_DEFAULT_MSI_TEARDOWN_IRQS
  77 void default_teardown_msi_irqs(struct pci_dev *dev)
  78 {
  79         struct msi_desc *entry;
  80
  81         list_for_each_entry(entry, &dev->msi_list, list) {
  82                 int i, nvec;
  83                 if (entry->irq == 0)
  84                         continue;
  85                 nvec = 1 << entry->msi_attrib.multiple;
  86                 for (i = 0; i < nvec; i++)
  87                         arch_teardown_msi_irq(entry->irq + i);
  88         }
  89 }
  90 #endif
  91
  92 #ifndef arch_restore_msi_irqs
  93 # define arch_restore_msi_irqs default_restore_msi_irqs
  94 # define HAVE_DEFAULT_MSI_RESTORE_IRQS
  95 #endif
  96
  97 #ifdef HAVE_DEFAULT_MSI_RESTORE_IRQS
  98 void default_restore_msi_irqs(struct pci_dev *dev, int irq)
  99 {
 100         struct msi_desc *entry;
 101
 102         entry = NULL;
 103         if (dev->msix_enabled) {
 104                 list_for_each_entry(entry, &dev->msi_list, list) {
 105                         if (irq == entry->irq)
 106                                 break;
 107                 }
 108         } else if (dev->msi_enabled)  {
 109                 entry = irq_get_msi_desc(irq);
 110         }
 111
 112         if (entry)
 113                 write_msi_msg(irq, &entry->msg);
 114 }
 115 #endif
 116
 117 static void msi_set_enable(struct pci_dev *dev, int enable)
 118 {
 119         u16 control;
 120
 121         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 122         control &= ~PCI_MSI_FLAGS_ENABLE;
 123         if (enable)
 124                 control |= PCI_MSI_FLAGS_ENABLE;
 125         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 126 }
 127
 128 static void msix_set_enable(struct pci_dev *dev, int enable)
 129 {
 130         u16 control;
 131
 132         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 133         control &= ~PCI_MSIX_FLAGS_ENABLE;
 134         if (enable)
 135                 control |= PCI_MSIX_FLAGS_ENABLE;
 136         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 137 }
 138
 139 static inline __attribute_const__ u32 msi_mask(unsigned x)
 140 {
 141         /* Don't shift by >= width of type */
 142         if (x >= 5)
 143                 return 0xffffffff;
 144         return (1 << (1 << x)) - 1;
 145 }
 146
 147 static inline __attribute_const__ u32 msi_capable_mask(u16 control)
 148 {
 149         return msi_mask((control >> 1) & 7);
 150 }
 151
 152 static inline __attribute_const__ u32 msi_enabled_mask(u16 control)
 153 {
 154         return msi_mask((control >> 4) & 7);
 155 }
 156
 157 /*
 158  * PCI 2.3 does not specify mask bits for each MSI interrupt.  Attempting to
 159  * mask all MSI interrupts by clearing the MSI enable bit does not work
 160  * reliably as devices without an INTx disable bit will then generate a
 161  * level IRQ which will never be cleared.
 162  */
 163 static u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 164 {
 165         u32 mask_bits = desc->masked;
 166
 167         if (!desc->msi_attrib.maskbit)
 168                 return 0;
 169
 170         mask_bits &= ~mask;
 171         mask_bits |= flag;
 172         pci_write_config_dword(desc->dev, desc->mask_pos, mask_bits);
 173
 174         return mask_bits;
 175 }
 176
 177 static void msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 178 {
 179         desc->masked = __msi_mask_irq(desc, mask, flag);
 180 }
 181
 182 /*
 183  * This internal function does not flush PCI writes to the device.
 184  * All users must ensure that they read from the device before either
 185  * assuming that the device state is up to date, or returning out of this
 186  * file.  This saves a few milliseconds when initialising devices with lots
 187  * of MSI-X interrupts.
 188  */
 189 static u32 __msix_mask_irq(struct msi_desc *desc, u32 flag)
 190 {
 191         u32 mask_bits = desc->masked;
 192         unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
 193                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 194         mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
 195         if (flag)
 196                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
 197         writel(mask_bits, desc->mask_base + offset);
 198
 199         return mask_bits;
 200 }
 201
 202 static void msix_mask_irq(struct msi_desc *desc, u32 flag)
 203 {
 204         desc->masked = __msix_mask_irq(desc, flag);
 205 }
 206
 207 #ifdef CONFIG_GENERIC_HARDIRQS
 208
 209 static void msi_set_mask_bit(struct irq_data *data, u32 flag)
 210 {
 211         struct msi_desc *desc = irq_data_get_msi(data);
 212
 213         if (desc->msi_attrib.is_msix) {
 214                 msix_mask_irq(desc, flag);
 215                 readl(desc->mask_base);         /* Flush write to device */
 216         } else {
 217                 unsigned offset = data->irq - desc->dev->irq;
 218                 msi_mask_irq(desc, 1 << offset, flag << offset);
 219         }
 220 }
 221
 222 void mask_msi_irq(struct irq_data *data)
 223 {
 224         msi_set_mask_bit(data, 1);
 225 }
 226
 227 void unmask_msi_irq(struct irq_data *data)
 228 {
 229         msi_set_mask_bit(data, 0);
 230 }
 231
 232 #endif /* CONFIG_GENERIC_HARDIRQS */
 233
 234 void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 235 {
 236         BUG_ON(entry->dev->current_state != PCI_D0);
 237
 238         if (entry->msi_attrib.is_msix) {
 239                 void __iomem *base = entry->mask_base +
 240                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 241
 242                 msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR);
 243                 msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR);
 244                 msg->data = readl(base + PCI_MSIX_ENTRY_DATA);
 245         } else {
 246                 struct pci_dev *dev = entry->dev;
 247                 int pos = dev->msi_cap;
 248                 u16 data;
 249
 250                 pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 251                                       &msg->address_lo);
 252                 if (entry->msi_attrib.is_64) {
 253                         pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 254                                               &msg->address_hi);
 255                         pci_read_config_word(dev, pos + PCI_MSI_DATA_64, &data);
 256                 } else {
 257                         msg->address_hi = 0;
 258                         pci_read_config_word(dev, pos + PCI_MSI_DATA_32, &data);
 259                 }
 260                 msg->data = data;
 261         }
 262 }
 263
 264 void read_msi_msg(unsigned int irq, struct msi_msg *msg)
 265 {
 266         struct msi_desc *entry = irq_get_msi_desc(irq);
 267
 268         __read_msi_msg(entry, msg);
 269 }
 270
 271 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 272 {
 273         /* Assert that the cache is valid, assuming that
 274          * valid messages are not all-zeroes. */
 275         BUG_ON(!(entry->msg.address_hi | entry->msg.address_lo |
 276                  entry->msg.data));
 277
 278         *msg = entry->msg;
 279 }
 280
 281 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
 282 {
 283         struct msi_desc *entry = irq_get_msi_desc(irq);
 284
 285         __get_cached_msi_msg(entry, msg);
 286 }
 287
 288 void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 289 {
 290         if (entry->dev->current_state != PCI_D0) {
 291                 /* Don't touch the hardware now */
 292         } else if (entry->msi_attrib.is_msix) {
 293                 void __iomem *base;
 294                 base = entry->mask_base +
 295                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 296
 297                 writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
 298                 writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
 299                 writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
 300         } else {
 301                 struct pci_dev *dev = entry->dev;
 302                 int pos = dev->msi_cap;
 303                 u16 msgctl;
 304
 305                 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
 306                 msgctl &= ~PCI_MSI_FLAGS_QSIZE;
 307                 msgctl |= entry->msi_attrib.multiple << 4;
 308                 pci_write_config_word(dev, pos + PCI_MSI_FLAGS, msgctl);
 309
 310                 pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 311                                        msg->address_lo);
 312                 if (entry->msi_attrib.is_64) {
 313                         pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 314                                                msg->address_hi);
 315                         pci_write_config_word(dev, pos + PCI_MSI_DATA_64,
 316                                               msg->data);
 317                 } else {
 318                         pci_write_config_word(dev, pos + PCI_MSI_DATA_32,
 319                                               msg->data);
 320                 }
 321         }
 322         entry->msg = *msg;
 323 }
 324
 325 void write_msi_msg(unsigned int irq, struct msi_msg *msg)
 326 {
 327         struct msi_desc *entry = irq_get_msi_desc(irq);
 328
 329         __write_msi_msg(entry, msg);
 330 }
 331
 332 static void free_msi_irqs(struct pci_dev *dev)
 333 {
 334         struct msi_desc *entry, *tmp;
 335
 336         list_for_each_entry(entry, &dev->msi_list, list) {
 337                 int i, nvec;
 338                 if (!entry->irq)
 339                         continue;
 340                 nvec = 1 << entry->msi_attrib.multiple;
 341 #ifdef CONFIG_GENERIC_HARDIRQS
 342                 for (i = 0; i < nvec; i++)
 343                         BUG_ON(irq_has_action(entry->irq + i));
 344 #endif
 345         }
 346
 347         arch_teardown_msi_irqs(dev);
 348
 349         list_for_each_entry_safe(entry, tmp, &dev->msi_list, list) {
 350                 if (entry->msi_attrib.is_msix) {
 351                         if (list_is_last(&entry->list, &dev->msi_list))
 352                                 iounmap(entry->mask_base);
 353                 }
 354
 355                 /*
 356                  * Its possible that we get into this path
 357                  * When populate_msi_sysfs fails, which means the entries
 358                  * were not registered with sysfs.  In that case don't
 359                  * unregister them.
 360                  */
 361                 if (entry->kobj.parent) {
 362                         kobject_del(&entry->kobj);
 363                         kobject_put(&entry->kobj);
 364                 }
 365
 366                 list_del(&entry->list);
 367                 kfree(entry);
 368         }
 369 }
 370
 371 static struct msi_desc *alloc_msi_entry(struct pci_dev *dev)
 372 {
 373         struct msi_desc *desc = kzalloc(sizeof(*desc), GFP_KERNEL);
 374         if (!desc)
 375                 return NULL;
 376
 377         INIT_LIST_HEAD(&desc->list);
 378         desc->dev = dev;
 379
 380         return desc;
 381 }
 382
 383 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
 384 {
 385         if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
 386                 pci_intx(dev, enable);
 387 }
 388
 389 static void __pci_restore_msi_state(struct pci_dev *dev)
 390 {
 391         u16 control;
 392         struct msi_desc *entry;
 393
 394         if (!dev->msi_enabled)
 395                 return;
 396
 397         entry = irq_get_msi_desc(dev->irq);
 398
 399         pci_intx_for_msi(dev, 0);
 400         msi_set_enable(dev, 0);
 401         arch_restore_msi_irqs(dev, dev->irq);
 402
 403         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 404         msi_mask_irq(entry, msi_capable_mask(control), entry->masked);
 405         control &= ~PCI_MSI_FLAGS_QSIZE;
 406         control |= (entry->msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
 407         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 408 }
 409
 410 static void __pci_restore_msix_state(struct pci_dev *dev)
 411 {
 412         struct msi_desc *entry;
 413         u16 control;
 414
 415         if (!dev->msix_enabled)
 416                 return;
 417         BUG_ON(list_empty(&dev->msi_list));
 418         entry = list_first_entry(&dev->msi_list, struct msi_desc, list);
 419         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 420
 421         /* route the table */
 422         pci_intx_for_msi(dev, 0);
 423         control |= PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL;
 424         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 425
 426         list_for_each_entry(entry, &dev->msi_list, list) {
 427                 arch_restore_msi_irqs(dev, entry->irq);
 428                 msix_mask_irq(entry, entry->masked);
 429         }
 430
 431         control &= ~PCI_MSIX_FLAGS_MASKALL;
 432         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 433 }
 434
 435 void pci_restore_msi_state(struct pci_dev *dev)
 436 {
 437         __pci_restore_msi_state(dev);
 438         __pci_restore_msix_state(dev);
 439 }
 440 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
 441
 442
 443 #define to_msi_attr(obj) container_of(obj, struct msi_attribute, attr)
 444 #define to_msi_desc(obj) container_of(obj, struct msi_desc, kobj)
 445
 446 struct msi_attribute {
 447         struct attribute        attr;
 448         ssize_t (*show)(struct msi_desc *entry, struct msi_attribute *attr,
 449                         char *buf);
 450         ssize_t (*store)(struct msi_desc *entry, struct msi_attribute *attr,
 451                          const char *buf, size_t count);
 452 };
 453
 454 static ssize_t show_msi_mode(struct msi_desc *entry, struct msi_attribute *atr,
 455                              char *buf)
 456 {
 457         return sprintf(buf, "%s\n", entry->msi_attrib.is_msix ? "msix" : "msi");
 458 }
 459
 460 static ssize_t msi_irq_attr_show(struct kobject *kobj,
 461                                  struct attribute *attr, char *buf)
 462 {
 463         struct msi_attribute *attribute = to_msi_attr(attr);
 464         struct msi_desc *entry = to_msi_desc(kobj);
 465
 466         if (!attribute->show)
 467                 return -EIO;
 468
 469         return attribute->show(entry, attribute, buf);
 470 }
 471
 472 static const struct sysfs_ops msi_irq_sysfs_ops = {
 473         .show = msi_irq_attr_show,
 474 };
 475
 476 static struct msi_attribute mode_attribute =
 477         __ATTR(mode, S_IRUGO, show_msi_mode, NULL);
 478
 479
 480 struct attribute *msi_irq_default_attrs[] = {
 481         &mode_attribute.attr,
 482         NULL
 483 };
 484
 485 void msi_kobj_release(struct kobject *kobj)
 486 {
 487         struct msi_desc *entry = to_msi_desc(kobj);
 488
 489         pci_dev_put(entry->dev);
 490 }
 491
 492 static struct kobj_type msi_irq_ktype = {
 493         .release = msi_kobj_release,
 494         .sysfs_ops = &msi_irq_sysfs_ops,
 495         .default_attrs = msi_irq_default_attrs,
 496 };
 497
 498 static int populate_msi_sysfs(struct pci_dev *pdev)
 499 {
 500         struct msi_desc *entry;
 501         struct kobject *kobj;
 502         int ret;
 503         int count = 0;
 504
 505         pdev->msi_kset = kset_create_and_add("msi_irqs", NULL, &pdev->dev.kobj);
 506         if (!pdev->msi_kset)
 507                 return -ENOMEM;
 508
 509         list_for_each_entry(entry, &pdev->msi_list, list) {
 510                 kobj = &entry->kobj;
 511                 kobj->kset = pdev->msi_kset;
 512                 pci_dev_get(pdev);
 513                 ret = kobject_init_and_add(kobj, &msi_irq_ktype, NULL,
 514                                      "%u", entry->irq);
 515                 if (ret)
 516                         goto out_unroll;
 517
 518                 count++;
 519         }
 520
 521         return 0;
 522
 523 out_unroll:
 524         list_for_each_entry(entry, &pdev->msi_list, list) {
 525                 if (!count)
 526                         break;
 527                 kobject_del(&entry->kobj);
 528                 kobject_put(&entry->kobj);
 529                 count--;
 530         }
 531         return ret;
 532 }
 533
 534 /**
 535  * msi_capability_init - configure device's MSI capability structure
 536  * @dev: pointer to the pci_dev data structure of MSI device function
 537  * @nvec: number of interrupts to allocate
 538  *
 539  * Setup the MSI capability structure of the device with the requested
 540  * number of interrupts.  A return value of zero indicates the successful
 541  * setup of an entry with the new MSI irq.  A negative return value indicates
 542  * an error, and a positive return value indicates the number of interrupts
 543  * which could have been allocated.
 544  */
 545 static int msi_capability_init(struct pci_dev *dev, int nvec)
 546 {
 547         struct msi_desc *entry;
 548         int ret;
 549         u16 control;
 550         unsigned mask;
 551
 552         msi_set_enable(dev, 0); /* Disable MSI during set up */
 553
 554         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 555         /* MSI Entry Initialization */
 556         entry = alloc_msi_entry(dev);
 557         if (!entry)
 558                 return -ENOMEM;
 559
 560         entry->msi_attrib.is_msix       = 0;
 561         entry->msi_attrib.is_64         = !!(control & PCI_MSI_FLAGS_64BIT);
 562         entry->msi_attrib.entry_nr      = 0;
 563         entry->msi_attrib.maskbit       = !!(control & PCI_MSI_FLAGS_MASKBIT);
 564         entry->msi_attrib.default_irq   = dev->irq;     /* Save IOAPIC IRQ */
 565         entry->msi_attrib.pos           = dev->msi_cap;
 566
 567         entry->mask_pos = msi_mask_reg(dev->msi_cap, entry->msi_attrib.is_64);
 568         /* All MSIs are unmasked by default, Mask them all */
 569         if (entry->msi_attrib.maskbit)
 570                 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
 571         mask = msi_capable_mask(control);
 572         msi_mask_irq(entry, mask, mask);
 573
 574         list_add_tail(&entry->list, &dev->msi_list);
 575
 576         /* Configure MSI capability structure */
 577         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 578         if (ret) {
 579                 msi_mask_irq(entry, mask, ~mask);
 580                 free_msi_irqs(dev);
 581                 return ret;
 582         }
 583
 584         ret = populate_msi_sysfs(dev);
 585         if (ret) {
 586                 msi_mask_irq(entry, mask, ~mask);
 587                 free_msi_irqs(dev);
 588                 return ret;
 589         }
 590
 591         /* Set MSI enabled bits  */
 592         pci_intx_for_msi(dev, 0);
 593         msi_set_enable(dev, 1);
 594         dev->msi_enabled = 1;
 595
 596         dev->irq = entry->irq;
 597         return 0;
 598 }
 599
 600 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
 601 {
 602         resource_size_t phys_addr;
 603         u32 table_offset;
 604         u8 bir;
 605
 606         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 607                               &table_offset);
 608         bir = (u8)(table_offset & PCI_MSIX_FLAGS_BIRMASK);
 609         table_offset &= ~PCI_MSIX_FLAGS_BIRMASK;
 610         phys_addr = pci_resource_start(dev, bir) + table_offset;
 611
 612         return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 613 }
 614
 615 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 616                               struct msix_entry *entries, int nvec)
 617 {
 618         struct msi_desc *entry;
 619         int i;
 620
 621         for (i = 0; i < nvec; i++) {
 622                 entry = alloc_msi_entry(dev);
 623                 if (!entry) {
 624                         if (!i)
 625                                 iounmap(base);
 626                         else
 627                                 free_msi_irqs(dev);
 628                         /* No enough memory. Don't try again */
 629                         return -ENOMEM;
 630                 }
 631
 632                 entry->msi_attrib.is_msix       = 1;
 633                 entry->msi_attrib.is_64         = 1;
 634                 entry->msi_attrib.entry_nr      = entries[i].entry;
 635                 entry->msi_attrib.default_irq   = dev->irq;
 636                 entry->msi_attrib.pos           = dev->msix_cap;
 637                 entry->mask_base                = base;
 638
 639                 list_add_tail(&entry->list, &dev->msi_list);
 640         }
 641
 642         return 0;
 643 }
 644
 645 static void msix_program_entries(struct pci_dev *dev,
 646                                  struct msix_entry *entries)
 647 {
 648         struct msi_desc *entry;
 649         int i = 0;
 650
 651         list_for_each_entry(entry, &dev->msi_list, list) {
 652                 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
 653                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 654
 655                 entries[i].vector = entry->irq;
 656                 irq_set_msi_desc(entry->irq, entry);
 657                 entry->masked = readl(entry->mask_base + offset);
 658                 msix_mask_irq(entry, 1);
 659                 i++;
 660         }
 661 }
 662
 663 /**
 664  * msix_capability_init - configure device's MSI-X capability
 665  * @dev: pointer to the pci_dev data structure of MSI-X device function
 666  * @entries: pointer to an array of struct msix_entry entries
 667  * @nvec: number of @entries
 668  *
 669  * Setup the MSI-X capability structure of device function with a
 670  * single MSI-X irq. A return of zero indicates the successful setup of
 671  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
 672  **/
 673 static int msix_capability_init(struct pci_dev *dev,
 674                                 struct msix_entry *entries, int nvec)
 675 {
 676         int ret;
 677         u16 control;
 678         void __iomem *base;
 679
 680         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 681
 682         /* Ensure MSI-X is disabled while it is set up */
 683         control &= ~PCI_MSIX_FLAGS_ENABLE;
 684         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 685
 686         /* Request & Map MSI-X table region */
 687         base = msix_map_region(dev, msix_table_size(control));
 688         if (!base)
 689                 return -ENOMEM;
 690
 691         ret = msix_setup_entries(dev, base, entries, nvec);
 692         if (ret)
 693                 return ret;
 694
 695         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 696         if (ret)
 697                 goto error;
 698
 699         /*
 700          * Some devices require MSI-X to be enabled before we can touch the
 701          * MSI-X registers.  We need to mask all the vectors to prevent
 702          * interrupts coming in before they're fully set up.
 703          */
 704         control |= PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE;
 705         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 706
 707         msix_program_entries(dev, entries);
 708
 709         ret = populate_msi_sysfs(dev);
 710         if (ret) {
 711                 ret = 0;
 712                 goto error;
 713         }
 714
 715         /* Set MSI-X enabled bits and unmask the function */
 716         pci_intx_for_msi(dev, 0);
 717         dev->msix_enabled = 1;
 718
 719         control &= ~PCI_MSIX_FLAGS_MASKALL;
 720         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, control);
 721
 722         return 0;
 723
 724 error:
 725         if (ret < 0) {
 726                 /*
 727                  * If we had some success, report the number of irqs
 728                  * we succeeded in setting up.
 729                  */
 730                 struct msi_desc *entry;
 731                 int avail = 0;
 732
 733                 list_for_each_entry(entry, &dev->msi_list, list) {
 734                         if (entry->irq != 0)
 735                                 avail++;
 736                 }
 737                 if (avail != 0)
 738                         ret = avail;
 739         }
 740
 741         free_msi_irqs(dev);
 742
 743         return ret;
 744 }
 745
 746 /**
 747  * pci_msi_check_device - check whether MSI may be enabled on a device
 748  * @dev: pointer to the pci_dev data structure of MSI device function
 749  * @nvec: how many MSIs have been requested ?
 750  * @type: are we checking for MSI or MSI-X ?
 751  *
 752  * Look at global flags, the device itself, and its parent busses
 753  * to determine if MSI/-X are supported for the device. If MSI/-X is
 754  * supported return 0, else return an error code.
 755  **/
 756 static int pci_msi_check_device(struct pci_dev *dev, int nvec, int type)
 757 {
 758         struct pci_bus *bus;
 759         int ret;
 760
 761         /* MSI must be globally enabled and supported by the device */
 762         if (!pci_msi_enable || !dev || dev->no_msi)
 763                 return -EINVAL;
 764
 765         /*
 766          * You can't ask to have 0 or less MSIs configured.
 767          *  a) it's stupid ..
 768          *  b) the list manipulation code assumes nvec >= 1.
 769          */
 770         if (nvec < 1)
 771                 return -ERANGE;
 772
 773         /*
 774          * Any bridge which does NOT route MSI transactions from its
 775          * secondary bus to its primary bus must set NO_MSI flag on
 776          * the secondary pci_bus.
 777          * We expect only arch-specific PCI host bus controller driver
 778          * or quirks for specific PCI bridges to be setting NO_MSI.
 779          */
 780         for (bus = dev->bus; bus; bus = bus->parent)
 781                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 782                         return -EINVAL;
 783
 784         ret = arch_msi_check_device(dev, nvec, type);
 785         if (ret)
 786                 return ret;
 787
 788         return 0;
 789 }
 790
 791 /**
 792  * pci_enable_msi_block - configure device's MSI capability structure
 793  * @dev: device to configure
 794  * @nvec: number of interrupts to configure
 795  *
 796  * Allocate IRQs for a device with the MSI capability.
 797  * This function returns a negative errno if an error occurs.  If it
 798  * is unable to allocate the number of interrupts requested, it returns
 799  * the number of interrupts it might be able to allocate.  If it successfully
 800  * allocates at least the number of interrupts requested, it returns 0 and
 801  * updates the @dev's irq member to the lowest new interrupt number; the
 802  * other interrupt numbers allocated to this device are consecutive.
 803  */
 804 int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
 805 {
 806         int status, maxvec;
 807         u16 msgctl;
 808
 809         if (!dev->msi_cap)
 810                 return -EINVAL;
 811
 812         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 813         maxvec = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 814         if (nvec > maxvec)
 815                 return maxvec;
 816
 817         status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSI);
 818         if (status)
 819                 return status;
 820
 821         WARN_ON(!!dev->msi_enabled);
 822
 823         /* Check whether driver already requested MSI-X irqs */
 824         if (dev->msix_enabled) {
 825                 dev_info(&dev->dev, "can't enable MSI "
 826                          "(MSI-X already enabled)\n");
 827                 return -EINVAL;
 828         }
 829
 830         status = msi_capability_init(dev, nvec);
 831         return status;
 832 }
 833 EXPORT_SYMBOL(pci_enable_msi_block);
 834
 835 int pci_enable_msi_block_auto(struct pci_dev *dev, unsigned int *maxvec)
 836 {
 837         int ret, nvec;
 838         u16 msgctl;
 839
 840         if (!dev->msi_cap)
 841                 return -EINVAL;
 842
 843         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 844         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 845
 846         if (maxvec)
 847                 *maxvec = ret;
 848
 849         do {
 850                 nvec = ret;
 851                 ret = pci_enable_msi_block(dev, nvec);
 852         } while (ret > 0);
 853
 854         if (ret < 0)
 855                 return ret;
 856         return nvec;
 857 }
 858 EXPORT_SYMBOL(pci_enable_msi_block_auto);
 859
 860 void pci_msi_shutdown(struct pci_dev *dev)
 861 {
 862         struct msi_desc *desc;
 863         u32 mask;
 864         u16 ctrl;
 865
 866         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 867                 return;
 868
 869         BUG_ON(list_empty(&dev->msi_list));
 870         desc = list_first_entry(&dev->msi_list, struct msi_desc, list);
 871
 872         msi_set_enable(dev, 0);
 873         pci_intx_for_msi(dev, 1);
 874         dev->msi_enabled = 0;
 875
 876         /* Return the device with MSI unmasked as initial states */
 877         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &ctrl);
 878         mask = msi_capable_mask(ctrl);
 879         /* Keep cached state to be restored */
 880         __msi_mask_irq(desc, mask, ~mask);
 881
 882         /* Restore dev->irq to its default pin-assertion irq */
 883         dev->irq = desc->msi_attrib.default_irq;
 884 }
 885
 886 void pci_disable_msi(struct pci_dev *dev)
 887 {
 888         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 889                 return;
 890
 891         pci_msi_shutdown(dev);
 892         free_msi_irqs(dev);
 893         kset_unregister(dev->msi_kset);
 894         dev->msi_kset = NULL;
 895 }
 896 EXPORT_SYMBOL(pci_disable_msi);
 897
 898 /**
 899  * pci_msix_table_size - return the number of device's MSI-X table entries
 900  * @dev: pointer to the pci_dev data structure of MSI-X device function
 901  */
 902 int pci_msix_table_size(struct pci_dev *dev)
 903 {
 904         u16 control;
 905
 906         if (!dev->msix_cap)
 907                 return 0;
 908
 909         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 910         return msix_table_size(control);
 911 }
 912
 913 /**
 914  * pci_enable_msix - configure device's MSI-X capability structure
 915  * @dev: pointer to the pci_dev data structure of MSI-X device function
 916  * @entries: pointer to an array of MSI-X entries
 917  * @nvec: number of MSI-X irqs requested for allocation by device driver
 918  *
 919  * Setup the MSI-X capability structure of device function with the number
 920  * of requested irqs upon its software driver call to request for
 921  * MSI-X mode enabled on its hardware device function. A return of zero
 922  * indicates the successful configuration of MSI-X capability structure
 923  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
 924  * Or a return of > 0 indicates that driver request is exceeding the number
 925  * of irqs or MSI-X vectors available. Driver should use the returned value to
 926  * re-send its request.
 927  **/
 928 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
 929 {
 930         int status, nr_entries;
 931         int i, j;
 932
 933         if (!entries || !dev->msix_cap)
 934                 return -EINVAL;
 935
 936         status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSIX);
 937         if (status)
 938                 return status;
 939
 940         nr_entries = pci_msix_table_size(dev);
 941         if (nvec > nr_entries)
 942                 return nr_entries;
 943
 944         /* Check for any invalid entries */
 945         for (i = 0; i < nvec; i++) {
 946                 if (entries[i].entry >= nr_entries)
 947                         return -EINVAL;         /* invalid entry */
 948                 for (j = i + 1; j < nvec; j++) {
 949                         if (entries[i].entry == entries[j].entry)
 950                                 return -EINVAL; /* duplicate entry */
 951                 }
 952         }
 953         WARN_ON(!!dev->msix_enabled);
 954
 955         /* Check whether driver already requested for MSI irq */
 956         if (dev->msi_enabled) {
 957                 dev_info(&dev->dev, "can't enable MSI-X "
 958                        "(MSI IRQ already assigned)\n");
 959                 return -EINVAL;
 960         }
 961         status = msix_capability_init(dev, entries, nvec);
 962         return status;
 963 }
 964 EXPORT_SYMBOL(pci_enable_msix);
 965
 966 void pci_msix_shutdown(struct pci_dev *dev)
 967 {
 968         struct msi_desc *entry;
 969
 970         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 971                 return;
 972
 973         /* Return the device with MSI-X masked as initial states */
 974         list_for_each_entry(entry, &dev->msi_list, list) {
 975                 /* Keep cached states to be restored */
 976                 __msix_mask_irq(entry, 1);
 977         }
 978
 979         msix_set_enable(dev, 0);
 980         pci_intx_for_msi(dev, 1);
 981         dev->msix_enabled = 0;
 982 }
 983
 984 void pci_disable_msix(struct pci_dev *dev)
 985 {
 986         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 987                 return;
 988
 989         pci_msix_shutdown(dev);
 990         free_msi_irqs(dev);
 991         kset_unregister(dev->msi_kset);
 992         dev->msi_kset = NULL;
 993 }
 994 EXPORT_SYMBOL(pci_disable_msix);
 995
 996 /**
 997  * msi_remove_pci_irq_vectors - reclaim MSI(X) irqs to unused state
 998  * @dev: pointer to the pci_dev data structure of MSI(X) device function
 999  *
1000  * Being called during hotplug remove, from which the device function
1001  * is hot-removed. All previous assigned MSI/MSI-X irqs, if
1002  * allocated for this device function, are reclaimed to unused state,
1003  * which may be used later on.
1004  **/
1005 void msi_remove_pci_irq_vectors(struct pci_dev *dev)
1006 {
1007         if (!pci_msi_enable || !dev)
1008                 return;
1009
1010         if (dev->msi_enabled || dev->msix_enabled)
1011                 free_msi_irqs(dev);
1012 }
1013
1014 void pci_no_msi(void)
1015 {
1016         pci_msi_enable = 0;
1017 }
1018
1019 /**
1020  * pci_msi_enabled - is MSI enabled?
1021  *
1022  * Returns true if MSI has not been disabled by the command-line option
1023  * pci=nomsi.
1024  **/
1025 int pci_msi_enabled(void)
1026 {
1027         return pci_msi_enable;
1028 }
1029 EXPORT_SYMBOL(pci_msi_enabled);
1030
1031 void pci_msi_init_pci_dev(struct pci_dev *dev)
1032 {
1033         INIT_LIST_HEAD(&dev->msi_list);
1034
1035         /* Disable the msi hardware to avoid screaming interrupts
1036          * during boot.  This is the power on reset default so
1037          * usually this should be a noop.
1038          */
1039         dev->msi_cap = pci_find_capability(dev, PCI_CAP_ID_MSI);
1040         if (dev->msi_cap)
1041                 msi_set_enable(dev, 0);
1042
1043         dev->msix_cap = pci_find_capability(dev, PCI_CAP_ID_MSIX);
1044         if (dev->msix_cap)
1045                 msix_set_enable(dev, 0);
1046 }