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