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/export.h>
  14 #include <linux/ioport.h>
  15 #include <linux/pci.h>
  16 #include <linux/proc_fs.h>
  17 #include <linux/msi.h>
  18 #include <linux/smp.h>
  19 #include <linux/errno.h>
  20 #include <linux/io.h>
  21 #include <linux/slab.h>
  22 #include <linux/irqdomain.h>
  23
  24 #include "pci.h"
  25
  26 static int pci_msi_enable = 1;
  27 int pci_msi_ignore_mask;
  28
  29 #define msix_table_size(flags)  ((flags & PCI_MSIX_FLAGS_QSIZE) + 1)
  30
  31 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
  32 static struct irq_domain *pci_msi_default_domain;
  33 static DEFINE_MUTEX(pci_msi_domain_lock);
  34
  35 struct irq_domain * __weak arch_get_pci_msi_domain(struct pci_dev *dev)
  36 {
  37         return pci_msi_default_domain;
  38 }
  39
  40 static struct irq_domain *pci_msi_get_domain(struct pci_dev *dev)
  41 {
  42         struct irq_domain *domain;
  43
  44         domain = dev_get_msi_domain(&dev->dev);
  45         if (domain)
  46                 return domain;
  47
  48         return arch_get_pci_msi_domain(dev);
  49 }
  50
  51 static int pci_msi_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
  52 {
  53         struct irq_domain *domain;
  54
  55         domain = pci_msi_get_domain(dev);
  56         if (domain)
  57                 return pci_msi_domain_alloc_irqs(domain, dev, nvec, type);
  58
  59         return arch_setup_msi_irqs(dev, nvec, type);
  60 }
  61
  62 static void pci_msi_teardown_msi_irqs(struct pci_dev *dev)
  63 {
  64         struct irq_domain *domain;
  65
  66         domain = pci_msi_get_domain(dev);
  67         if (domain)
  68                 pci_msi_domain_free_irqs(domain, dev);
  69         else
  70                 arch_teardown_msi_irqs(dev);
  71 }
  72 #else
  73 #define pci_msi_setup_msi_irqs          arch_setup_msi_irqs
  74 #define pci_msi_teardown_msi_irqs       arch_teardown_msi_irqs
  75 #endif
  76
  77 /* Arch hooks */
  78
  79 int __weak arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc)
  80 {
  81         struct msi_controller *chip = dev->bus->msi;
  82         int err;
  83
  84         if (!chip || !chip->setup_irq)
  85                 return -EINVAL;
  86
  87         err = chip->setup_irq(chip, dev, desc);
  88         if (err < 0)
  89                 return err;
  90
  91         irq_set_chip_data(desc->irq, chip);
  92
  93         return 0;
  94 }
  95
  96 void __weak arch_teardown_msi_irq(unsigned int irq)
  97 {
  98         struct msi_controller *chip = irq_get_chip_data(irq);
  99
 100         if (!chip || !chip->teardown_irq)
 101                 return;
 102
 103         chip->teardown_irq(chip, irq);
 104 }
 105
 106 int __weak arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
 107 {
 108         struct msi_controller *chip = dev->bus->msi;
 109         struct msi_desc *entry;
 110         int ret;
 111
 112         if (chip && chip->setup_irqs)
 113                 return chip->setup_irqs(chip, dev, nvec, type);
 114         /*
 115          * If an architecture wants to support multiple MSI, it needs to
 116          * override arch_setup_msi_irqs()
 117          */
 118         if (type == PCI_CAP_ID_MSI && nvec > 1)
 119                 return 1;
 120
 121         for_each_pci_msi_entry(entry, dev) {
 122                 ret = arch_setup_msi_irq(dev, entry);
 123                 if (ret < 0)
 124                         return ret;
 125                 if (ret > 0)
 126                         return -ENOSPC;
 127         }
 128
 129         return 0;
 130 }
 131
 132 /*
 133  * We have a default implementation available as a separate non-weak
 134  * function, as it is used by the Xen x86 PCI code
 135  */
 136 void default_teardown_msi_irqs(struct pci_dev *dev)
 137 {
 138         int i;
 139         struct msi_desc *entry;
 140
 141         for_each_pci_msi_entry(entry, dev)
 142                 if (entry->irq)
 143                         for (i = 0; i < entry->nvec_used; i++)
 144                                 arch_teardown_msi_irq(entry->irq + i);
 145 }
 146
 147 void __weak arch_teardown_msi_irqs(struct pci_dev *dev)
 148 {
 149         return default_teardown_msi_irqs(dev);
 150 }
 151
 152 static void default_restore_msi_irq(struct pci_dev *dev, int irq)
 153 {
 154         struct msi_desc *entry;
 155
 156         entry = NULL;
 157         if (dev->msix_enabled) {
 158                 for_each_pci_msi_entry(entry, dev) {
 159                         if (irq == entry->irq)
 160                                 break;
 161                 }
 162         } else if (dev->msi_enabled)  {
 163                 entry = irq_get_msi_desc(irq);
 164         }
 165
 166         if (entry)
 167                 __pci_write_msi_msg(entry, &entry->msg);
 168 }
 169
 170 void __weak arch_restore_msi_irqs(struct pci_dev *dev)
 171 {
 172         return default_restore_msi_irqs(dev);
 173 }
 174
 175 static inline __attribute_const__ u32 msi_mask(unsigned x)
 176 {
 177         /* Don't shift by >= width of type */
 178         if (x >= 5)
 179                 return 0xffffffff;
 180         return (1 << (1 << x)) - 1;
 181 }
 182
 183 /*
 184  * PCI 2.3 does not specify mask bits for each MSI interrupt.  Attempting to
 185  * mask all MSI interrupts by clearing the MSI enable bit does not work
 186  * reliably as devices without an INTx disable bit will then generate a
 187  * level IRQ which will never be cleared.
 188  */
 189 u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 190 {
 191         u32 mask_bits = desc->masked;
 192
 193         if (pci_msi_ignore_mask || !desc->msi_attrib.maskbit)
 194                 return 0;
 195
 196         mask_bits &= ~mask;
 197         mask_bits |= flag;
 198         pci_write_config_dword(msi_desc_to_pci_dev(desc), desc->mask_pos,
 199                                mask_bits);
 200
 201         return mask_bits;
 202 }
 203
 204 static void msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 205 {
 206         desc->masked = __pci_msi_desc_mask_irq(desc, mask, flag);
 207 }
 208
 209 /*
 210  * This internal function does not flush PCI writes to the device.
 211  * All users must ensure that they read from the device before either
 212  * assuming that the device state is up to date, or returning out of this
 213  * file.  This saves a few milliseconds when initialising devices with lots
 214  * of MSI-X interrupts.
 215  */
 216 u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag)
 217 {
 218         u32 mask_bits = desc->masked;
 219         unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
 220                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 221
 222         if (pci_msi_ignore_mask)
 223                 return 0;
 224
 225         mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
 226         if (flag)
 227                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
 228         writel(mask_bits, desc->mask_base + offset);
 229
 230         return mask_bits;
 231 }
 232
 233 static void msix_mask_irq(struct msi_desc *desc, u32 flag)
 234 {
 235         desc->masked = __pci_msix_desc_mask_irq(desc, flag);
 236 }
 237
 238 static void msi_set_mask_bit(struct irq_data *data, u32 flag)
 239 {
 240         struct msi_desc *desc = irq_data_get_msi_desc(data);
 241
 242         if (desc->msi_attrib.is_msix) {
 243                 msix_mask_irq(desc, flag);
 244                 readl(desc->mask_base);         /* Flush write to device */
 245         } else {
 246                 unsigned offset = data->irq - desc->irq;
 247                 msi_mask_irq(desc, 1 << offset, flag << offset);
 248         }
 249 }
 250
 251 /**
 252  * pci_msi_mask_irq - Generic irq chip callback to mask PCI/MSI interrupts
 253  * @data:       pointer to irqdata associated to that interrupt
 254  */
 255 void pci_msi_mask_irq(struct irq_data *data)
 256 {
 257         msi_set_mask_bit(data, 1);
 258 }
 259
 260 /**
 261  * pci_msi_unmask_irq - Generic irq chip callback to unmask PCI/MSI interrupts
 262  * @data:       pointer to irqdata associated to that interrupt
 263  */
 264 void pci_msi_unmask_irq(struct irq_data *data)
 265 {
 266         msi_set_mask_bit(data, 0);
 267 }
 268
 269 void default_restore_msi_irqs(struct pci_dev *dev)
 270 {
 271         struct msi_desc *entry;
 272
 273         for_each_pci_msi_entry(entry, dev)
 274                 default_restore_msi_irq(dev, entry->irq);
 275 }
 276
 277 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 278 {
 279         struct pci_dev *dev = msi_desc_to_pci_dev(entry);
 280
 281         BUG_ON(dev->current_state != PCI_D0);
 282
 283         if (entry->msi_attrib.is_msix) {
 284                 void __iomem *base = entry->mask_base +
 285                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 286
 287                 msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR);
 288                 msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR);
 289                 msg->data = readl(base + PCI_MSIX_ENTRY_DATA);
 290         } else {
 291                 int pos = dev->msi_cap;
 292                 u16 data;
 293
 294                 pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 295                                       &msg->address_lo);
 296                 if (entry->msi_attrib.is_64) {
 297                         pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 298                                               &msg->address_hi);
 299                         pci_read_config_word(dev, pos + PCI_MSI_DATA_64, &data);
 300                 } else {
 301                         msg->address_hi = 0;
 302                         pci_read_config_word(dev, pos + PCI_MSI_DATA_32, &data);
 303                 }
 304                 msg->data = data;
 305         }
 306 }
 307
 308 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 309 {
 310         struct pci_dev *dev = msi_desc_to_pci_dev(entry);
 311
 312         if (dev->current_state != PCI_D0) {
 313                 /* Don't touch the hardware now */
 314         } else if (entry->msi_attrib.is_msix) {
 315                 void __iomem *base;
 316                 base = entry->mask_base +
 317                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 318
 319                 writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
 320                 writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
 321                 writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
 322         } else {
 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 pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
 347 {
 348         struct msi_desc *entry = irq_get_msi_desc(irq);
 349
 350         __pci_write_msi_msg(entry, msg);
 351 }
 352 EXPORT_SYMBOL_GPL(pci_write_msi_msg);
 353
 354 static void free_msi_irqs(struct pci_dev *dev)
 355 {
 356         struct list_head *msi_list = dev_to_msi_list(&dev->dev);
 357         struct msi_desc *entry, *tmp;
 358         struct attribute **msi_attrs;
 359         struct device_attribute *dev_attr;
 360         int i, count = 0;
 361
 362         for_each_pci_msi_entry(entry, dev)
 363                 if (entry->irq)
 364                         for (i = 0; i < entry->nvec_used; i++)
 365                                 BUG_ON(irq_has_action(entry->irq + i));
 366
 367         pci_msi_teardown_msi_irqs(dev);
 368
 369         list_for_each_entry_safe(entry, tmp, msi_list, list) {
 370                 if (entry->msi_attrib.is_msix) {
 371                         if (list_is_last(&entry->list, msi_list))
 372                                 iounmap(entry->mask_base);
 373                 }
 374
 375                 list_del(&entry->list);
 376                 kfree(entry);
 377         }
 378
 379         if (dev->msi_irq_groups) {
 380                 sysfs_remove_groups(&dev->dev.kobj, dev->msi_irq_groups);
 381                 msi_attrs = dev->msi_irq_groups[0]->attrs;
 382                 while (msi_attrs[count]) {
 383                         dev_attr = container_of(msi_attrs[count],
 384                                                 struct device_attribute, attr);
 385                         kfree(dev_attr->attr.name);
 386                         kfree(dev_attr);
 387                         ++count;
 388                 }
 389                 kfree(msi_attrs);
 390                 kfree(dev->msi_irq_groups[0]);
 391                 kfree(dev->msi_irq_groups);
 392                 dev->msi_irq_groups = NULL;
 393         }
 394 }
 395
 396 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
 397 {
 398         if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
 399                 pci_intx(dev, enable);
 400 }
 401
 402 static void __pci_restore_msi_state(struct pci_dev *dev)
 403 {
 404         u16 control;
 405         struct msi_desc *entry;
 406
 407         if (!dev->msi_enabled)
 408                 return;
 409
 410         entry = irq_get_msi_desc(dev->irq);
 411
 412         pci_intx_for_msi(dev, 0);
 413         pci_msi_set_enable(dev, 0);
 414         arch_restore_msi_irqs(dev);
 415
 416         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 417         msi_mask_irq(entry, msi_mask(entry->msi_attrib.multi_cap),
 418                      entry->masked);
 419         control &= ~PCI_MSI_FLAGS_QSIZE;
 420         control |= (entry->msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
 421         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 422 }
 423
 424 static void __pci_restore_msix_state(struct pci_dev *dev)
 425 {
 426         struct msi_desc *entry;
 427
 428         if (!dev->msix_enabled)
 429                 return;
 430         BUG_ON(list_empty(dev_to_msi_list(&dev->dev)));
 431
 432         /* route the table */
 433         pci_intx_for_msi(dev, 0);
 434         pci_msix_clear_and_set_ctrl(dev, 0,
 435                                 PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL);
 436
 437         arch_restore_msi_irqs(dev);
 438         for_each_pci_msi_entry(entry, dev)
 439                 msix_mask_irq(entry, entry->masked);
 440
 441         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 442 }
 443
 444 void pci_restore_msi_state(struct pci_dev *dev)
 445 {
 446         __pci_restore_msi_state(dev);
 447         __pci_restore_msix_state(dev);
 448 }
 449 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
 450
 451 static ssize_t msi_mode_show(struct device *dev, struct device_attribute *attr,
 452                              char *buf)
 453 {
 454         struct msi_desc *entry;
 455         unsigned long irq;
 456         int retval;
 457
 458         retval = kstrtoul(attr->attr.name, 10, &irq);
 459         if (retval)
 460                 return retval;
 461
 462         entry = irq_get_msi_desc(irq);
 463         if (entry)
 464                 return sprintf(buf, "%s\n",
 465                                 entry->msi_attrib.is_msix ? "msix" : "msi");
 466
 467         return -ENODEV;
 468 }
 469
 470 static int populate_msi_sysfs(struct pci_dev *pdev)
 471 {
 472         struct attribute **msi_attrs;
 473         struct attribute *msi_attr;
 474         struct device_attribute *msi_dev_attr;
 475         struct attribute_group *msi_irq_group;
 476         const struct attribute_group **msi_irq_groups;
 477         struct msi_desc *entry;
 478         int ret = -ENOMEM;
 479         int num_msi = 0;
 480         int count = 0;
 481
 482         /* Determine how many msi entries we have */
 483         for_each_pci_msi_entry(entry, pdev)
 484                 ++num_msi;
 485         if (!num_msi)
 486                 return 0;
 487
 488         /* Dynamically create the MSI attributes for the PCI device */
 489         msi_attrs = kzalloc(sizeof(void *) * (num_msi + 1), GFP_KERNEL);
 490         if (!msi_attrs)
 491                 return -ENOMEM;
 492         for_each_pci_msi_entry(entry, pdev) {
 493                 msi_dev_attr = kzalloc(sizeof(*msi_dev_attr), GFP_KERNEL);
 494                 if (!msi_dev_attr)
 495                         goto error_attrs;
 496                 msi_attrs[count] = &msi_dev_attr->attr;
 497
 498                 sysfs_attr_init(&msi_dev_attr->attr);
 499                 msi_dev_attr->attr.name = kasprintf(GFP_KERNEL, "%d",
 500                                                     entry->irq);
 501                 if (!msi_dev_attr->attr.name)
 502                         goto error_attrs;
 503                 msi_dev_attr->attr.mode = S_IRUGO;
 504                 msi_dev_attr->show = msi_mode_show;
 505                 ++count;
 506         }
 507
 508         msi_irq_group = kzalloc(sizeof(*msi_irq_group), GFP_KERNEL);
 509         if (!msi_irq_group)
 510                 goto error_attrs;
 511         msi_irq_group->name = "msi_irqs";
 512         msi_irq_group->attrs = msi_attrs;
 513
 514         msi_irq_groups = kzalloc(sizeof(void *) * 2, GFP_KERNEL);
 515         if (!msi_irq_groups)
 516                 goto error_irq_group;
 517         msi_irq_groups[0] = msi_irq_group;
 518
 519         ret = sysfs_create_groups(&pdev->dev.kobj, msi_irq_groups);
 520         if (ret)
 521                 goto error_irq_groups;
 522         pdev->msi_irq_groups = msi_irq_groups;
 523
 524         return 0;
 525
 526 error_irq_groups:
 527         kfree(msi_irq_groups);
 528 error_irq_group:
 529         kfree(msi_irq_group);
 530 error_attrs:
 531         count = 0;
 532         msi_attr = msi_attrs[count];
 533         while (msi_attr) {
 534                 msi_dev_attr = container_of(msi_attr, struct device_attribute, attr);
 535                 kfree(msi_attr->name);
 536                 kfree(msi_dev_attr);
 537                 ++count;
 538                 msi_attr = msi_attrs[count];
 539         }
 540         kfree(msi_attrs);
 541         return ret;
 542 }
 543
 544 static struct msi_desc *msi_setup_entry(struct pci_dev *dev, int nvec)
 545 {
 546         u16 control;
 547         struct msi_desc *entry;
 548
 549         /* MSI Entry Initialization */
 550         entry = alloc_msi_entry(&dev->dev);
 551         if (!entry)
 552                 return NULL;
 553
 554         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 555
 556         entry->msi_attrib.is_msix       = 0;
 557         entry->msi_attrib.is_64         = !!(control & PCI_MSI_FLAGS_64BIT);
 558         entry->msi_attrib.entry_nr      = 0;
 559         entry->msi_attrib.maskbit       = !!(control & PCI_MSI_FLAGS_MASKBIT);
 560         entry->msi_attrib.default_irq   = dev->irq;     /* Save IOAPIC IRQ */
 561         entry->msi_attrib.multi_cap     = (control & PCI_MSI_FLAGS_QMASK) >> 1;
 562         entry->msi_attrib.multiple      = ilog2(__roundup_pow_of_two(nvec));
 563         entry->nvec_used                = nvec;
 564
 565         if (control & PCI_MSI_FLAGS_64BIT)
 566                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
 567         else
 568                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
 569
 570         /* Save the initial mask status */
 571         if (entry->msi_attrib.maskbit)
 572                 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
 573
 574         return entry;
 575 }
 576
 577 static int msi_verify_entries(struct pci_dev *dev)
 578 {
 579         struct msi_desc *entry;
 580
 581         for_each_pci_msi_entry(entry, dev) {
 582                 if (!dev->no_64bit_msi || !entry->msg.address_hi)
 583                         continue;
 584                 dev_err(&dev->dev, "Device has broken 64-bit MSI but arch"
 585                         " tried to assign one above 4G\n");
 586                 return -EIO;
 587         }
 588         return 0;
 589 }
 590
 591 /**
 592  * msi_capability_init - configure device's MSI capability structure
 593  * @dev: pointer to the pci_dev data structure of MSI device function
 594  * @nvec: number of interrupts to allocate
 595  *
 596  * Setup the MSI capability structure of the device with the requested
 597  * number of interrupts.  A return value of zero indicates the successful
 598  * setup of an entry with the new MSI irq.  A negative return value indicates
 599  * an error, and a positive return value indicates the number of interrupts
 600  * which could have been allocated.
 601  */
 602 static int msi_capability_init(struct pci_dev *dev, int nvec)
 603 {
 604         struct msi_desc *entry;
 605         int ret;
 606         unsigned mask;
 607
 608         pci_msi_set_enable(dev, 0);     /* Disable MSI during set up */
 609
 610         entry = msi_setup_entry(dev, nvec);
 611         if (!entry)
 612                 return -ENOMEM;
 613
 614         /* All MSIs are unmasked by default, Mask them all */
 615         mask = msi_mask(entry->msi_attrib.multi_cap);
 616         msi_mask_irq(entry, mask, mask);
 617
 618         list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 619
 620         /* Configure MSI capability structure */
 621         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 622         if (ret) {
 623                 msi_mask_irq(entry, mask, ~mask);
 624                 free_msi_irqs(dev);
 625                 return ret;
 626         }
 627
 628         ret = msi_verify_entries(dev);
 629         if (ret) {
 630                 msi_mask_irq(entry, mask, ~mask);
 631                 free_msi_irqs(dev);
 632                 return ret;
 633         }
 634
 635         ret = populate_msi_sysfs(dev);
 636         if (ret) {
 637                 msi_mask_irq(entry, mask, ~mask);
 638                 free_msi_irqs(dev);
 639                 return ret;
 640         }
 641
 642         /* Set MSI enabled bits  */
 643         pci_intx_for_msi(dev, 0);
 644         pci_msi_set_enable(dev, 1);
 645         dev->msi_enabled = 1;
 646
 647         pcibios_free_irq(dev);
 648         dev->irq = entry->irq;
 649         return 0;
 650 }
 651
 652 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
 653 {
 654         resource_size_t phys_addr;
 655         u32 table_offset;
 656         unsigned long flags;
 657         u8 bir;
 658
 659         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 660                               &table_offset);
 661         bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
 662         flags = pci_resource_flags(dev, bir);
 663         if (!flags || (flags & IORESOURCE_UNSET))
 664                 return NULL;
 665
 666         table_offset &= PCI_MSIX_TABLE_OFFSET;
 667         phys_addr = pci_resource_start(dev, bir) + table_offset;
 668
 669         return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 670 }
 671
 672 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 673                               struct msix_entry *entries, int nvec)
 674 {
 675         struct msi_desc *entry;
 676         int i;
 677
 678         for (i = 0; i < nvec; i++) {
 679                 entry = alloc_msi_entry(&dev->dev);
 680                 if (!entry) {
 681                         if (!i)
 682                                 iounmap(base);
 683                         else
 684                                 free_msi_irqs(dev);
 685                         /* No enough memory. Don't try again */
 686                         return -ENOMEM;
 687                 }
 688
 689                 entry->msi_attrib.is_msix       = 1;
 690                 entry->msi_attrib.is_64         = 1;
 691                 entry->msi_attrib.entry_nr      = entries[i].entry;
 692                 entry->msi_attrib.default_irq   = dev->irq;
 693                 entry->mask_base                = base;
 694                 entry->nvec_used                = 1;
 695
 696                 list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 697         }
 698
 699         return 0;
 700 }
 701
 702 static void msix_program_entries(struct pci_dev *dev,
 703                                  struct msix_entry *entries)
 704 {
 705         struct msi_desc *entry;
 706         int i = 0;
 707
 708         for_each_pci_msi_entry(entry, dev) {
 709                 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
 710                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 711
 712                 entries[i].vector = entry->irq;
 713                 entry->masked = readl(entry->mask_base + offset);
 714                 msix_mask_irq(entry, 1);
 715                 i++;
 716         }
 717 }
 718
 719 /**
 720  * msix_capability_init - configure device's MSI-X capability
 721  * @dev: pointer to the pci_dev data structure of MSI-X device function
 722  * @entries: pointer to an array of struct msix_entry entries
 723  * @nvec: number of @entries
 724  *
 725  * Setup the MSI-X capability structure of device function with a
 726  * single MSI-X irq. A return of zero indicates the successful setup of
 727  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
 728  **/
 729 static int msix_capability_init(struct pci_dev *dev,
 730                                 struct msix_entry *entries, int nvec)
 731 {
 732         int ret;
 733         u16 control;
 734         void __iomem *base;
 735
 736         /* Ensure MSI-X is disabled while it is set up */
 737         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 738
 739         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 740         /* Request & Map MSI-X table region */
 741         base = msix_map_region(dev, msix_table_size(control));
 742         if (!base)
 743                 return -ENOMEM;
 744
 745         ret = msix_setup_entries(dev, base, entries, nvec);
 746         if (ret)
 747                 return ret;
 748
 749         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 750         if (ret)
 751                 goto out_avail;
 752
 753         /* Check if all MSI entries honor device restrictions */
 754         ret = msi_verify_entries(dev);
 755         if (ret)
 756                 goto out_free;
 757
 758         /*
 759          * Some devices require MSI-X to be enabled before we can touch the
 760          * MSI-X registers.  We need to mask all the vectors to prevent
 761          * interrupts coming in before they're fully set up.
 762          */
 763         pci_msix_clear_and_set_ctrl(dev, 0,
 764                                 PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE);
 765
 766         msix_program_entries(dev, entries);
 767
 768         ret = populate_msi_sysfs(dev);
 769         if (ret)
 770                 goto out_free;
 771
 772         /* Set MSI-X enabled bits and unmask the function */
 773         pci_intx_for_msi(dev, 0);
 774         dev->msix_enabled = 1;
 775         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 776
 777         pcibios_free_irq(dev);
 778         return 0;
 779
 780 out_avail:
 781         if (ret < 0) {
 782                 /*
 783                  * If we had some success, report the number of irqs
 784                  * we succeeded in setting up.
 785                  */
 786                 struct msi_desc *entry;
 787                 int avail = 0;
 788
 789                 for_each_pci_msi_entry(entry, dev) {
 790                         if (entry->irq != 0)
 791                                 avail++;
 792                 }
 793                 if (avail != 0)
 794                         ret = avail;
 795         }
 796
 797 out_free:
 798         free_msi_irqs(dev);
 799
 800         return ret;
 801 }
 802
 803 /**
 804  * pci_msi_supported - check whether MSI may be enabled on a device
 805  * @dev: pointer to the pci_dev data structure of MSI device function
 806  * @nvec: how many MSIs have been requested ?
 807  *
 808  * Look at global flags, the device itself, and its parent buses
 809  * to determine if MSI/-X are supported for the device. If MSI/-X is
 810  * supported return 1, else return 0.
 811  **/
 812 static int pci_msi_supported(struct pci_dev *dev, int nvec)
 813 {
 814         struct pci_bus *bus;
 815
 816         /* MSI must be globally enabled and supported by the device */
 817         if (!pci_msi_enable)
 818                 return 0;
 819
 820         if (!dev || dev->no_msi || dev->current_state != PCI_D0)
 821                 return 0;
 822
 823         /*
 824          * You can't ask to have 0 or less MSIs configured.
 825          *  a) it's stupid ..
 826          *  b) the list manipulation code assumes nvec >= 1.
 827          */
 828         if (nvec < 1)
 829                 return 0;
 830
 831         /*
 832          * Any bridge which does NOT route MSI transactions from its
 833          * secondary bus to its primary bus must set NO_MSI flag on
 834          * the secondary pci_bus.
 835          * We expect only arch-specific PCI host bus controller driver
 836          * or quirks for specific PCI bridges to be setting NO_MSI.
 837          */
 838         for (bus = dev->bus; bus; bus = bus->parent)
 839                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 840                         return 0;
 841
 842         return 1;
 843 }
 844
 845 /**
 846  * pci_msi_vec_count - Return the number of MSI vectors a device can send
 847  * @dev: device to report about
 848  *
 849  * This function returns the number of MSI vectors a device requested via
 850  * Multiple Message Capable register. It returns a negative errno if the
 851  * device is not capable sending MSI interrupts. Otherwise, the call succeeds
 852  * and returns a power of two, up to a maximum of 2^5 (32), according to the
 853  * MSI specification.
 854  **/
 855 int pci_msi_vec_count(struct pci_dev *dev)
 856 {
 857         int ret;
 858         u16 msgctl;
 859
 860         if (!dev->msi_cap)
 861                 return -EINVAL;
 862
 863         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 864         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 865
 866         return ret;
 867 }
 868 EXPORT_SYMBOL(pci_msi_vec_count);
 869
 870 void pci_msi_shutdown(struct pci_dev *dev)
 871 {
 872         struct msi_desc *desc;
 873         u32 mask;
 874
 875         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 876                 return;
 877
 878         BUG_ON(list_empty(dev_to_msi_list(&dev->dev)));
 879         desc = first_pci_msi_entry(dev);
 880
 881         pci_msi_set_enable(dev, 0);
 882         pci_intx_for_msi(dev, 1);
 883         dev->msi_enabled = 0;
 884
 885         /* Return the device with MSI unmasked as initial states */
 886         mask = msi_mask(desc->msi_attrib.multi_cap);
 887         /* Keep cached state to be restored */
 888         __pci_msi_desc_mask_irq(desc, mask, ~mask);
 889
 890         /* Restore dev->irq to its default pin-assertion irq */
 891         dev->irq = desc->msi_attrib.default_irq;
 892         pcibios_alloc_irq(dev);
 893 }
 894
 895 void pci_disable_msi(struct pci_dev *dev)
 896 {
 897         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 898                 return;
 899
 900         pci_msi_shutdown(dev);
 901         free_msi_irqs(dev);
 902 }
 903 EXPORT_SYMBOL(pci_disable_msi);
 904
 905 /**
 906  * pci_msix_vec_count - return the number of device's MSI-X table entries
 907  * @dev: pointer to the pci_dev data structure of MSI-X device function
 908  * This function returns the number of device's MSI-X table entries and
 909  * therefore the number of MSI-X vectors device is capable of sending.
 910  * It returns a negative errno if the device is not capable of sending MSI-X
 911  * interrupts.
 912  **/
 913 int pci_msix_vec_count(struct pci_dev *dev)
 914 {
 915         u16 control;
 916
 917         if (!dev->msix_cap)
 918                 return -EINVAL;
 919
 920         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 921         return msix_table_size(control);
 922 }
 923 EXPORT_SYMBOL(pci_msix_vec_count);
 924
 925 /**
 926  * pci_enable_msix - configure device's MSI-X capability structure
 927  * @dev: pointer to the pci_dev data structure of MSI-X device function
 928  * @entries: pointer to an array of MSI-X entries
 929  * @nvec: number of MSI-X irqs requested for allocation by device driver
 930  *
 931  * Setup the MSI-X capability structure of device function with the number
 932  * of requested irqs upon its software driver call to request for
 933  * MSI-X mode enabled on its hardware device function. A return of zero
 934  * indicates the successful configuration of MSI-X capability structure
 935  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
 936  * Or a return of > 0 indicates that driver request is exceeding the number
 937  * of irqs or MSI-X vectors available. Driver should use the returned value to
 938  * re-send its request.
 939  **/
 940 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
 941 {
 942         int nr_entries;
 943         int i, j;
 944
 945         if (!pci_msi_supported(dev, nvec))
 946                 return -EINVAL;
 947
 948         if (!entries)
 949                 return -EINVAL;
 950
 951         nr_entries = pci_msix_vec_count(dev);
 952         if (nr_entries < 0)
 953                 return nr_entries;
 954         if (nvec > nr_entries)
 955                 return nr_entries;
 956
 957         /* Check for any invalid entries */
 958         for (i = 0; i < nvec; i++) {
 959                 if (entries[i].entry >= nr_entries)
 960                         return -EINVAL;         /* invalid entry */
 961                 for (j = i + 1; j < nvec; j++) {
 962                         if (entries[i].entry == entries[j].entry)
 963                                 return -EINVAL; /* duplicate entry */
 964                 }
 965         }
 966         WARN_ON(!!dev->msix_enabled);
 967
 968         /* Check whether driver already requested for MSI irq */
 969         if (dev->msi_enabled) {
 970                 dev_info(&dev->dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
 971                 return -EINVAL;
 972         }
 973         return msix_capability_init(dev, entries, nvec);
 974 }
 975 EXPORT_SYMBOL(pci_enable_msix);
 976
 977 void pci_msix_shutdown(struct pci_dev *dev)
 978 {
 979         struct msi_desc *entry;
 980
 981         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 982                 return;
 983
 984         /* Return the device with MSI-X masked as initial states */
 985         for_each_pci_msi_entry(entry, dev) {
 986                 /* Keep cached states to be restored */
 987                 __pci_msix_desc_mask_irq(entry, 1);
 988         }
 989
 990         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 991         pci_intx_for_msi(dev, 1);
 992         dev->msix_enabled = 0;
 993         pcibios_alloc_irq(dev);
 994 }
 995
 996 void pci_disable_msix(struct pci_dev *dev)
 997 {
 998         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 999                 return;
1000
1001         pci_msix_shutdown(dev);
1002         free_msi_irqs(dev);
1003 }
1004 EXPORT_SYMBOL(pci_disable_msix);
1005
1006 void pci_no_msi(void)
1007 {
1008         pci_msi_enable = 0;
1009 }
1010
1011 /**
1012  * pci_msi_enabled - is MSI enabled?
1013  *
1014  * Returns true if MSI has not been disabled by the command-line option
1015  * pci=nomsi.
1016  **/
1017 int pci_msi_enabled(void)
1018 {
1019         return pci_msi_enable;
1020 }
1021 EXPORT_SYMBOL(pci_msi_enabled);
1022
1023 void pci_msi_init_pci_dev(struct pci_dev *dev)
1024 {
1025 }
1026
1027 /**
1028  * pci_enable_msi_range - configure device's MSI capability structure
1029  * @dev: device to configure
1030  * @minvec: minimal number of interrupts to configure
1031  * @maxvec: maximum number of interrupts to configure
1032  *
1033  * This function tries to allocate a maximum possible number of interrupts in a
1034  * range between @minvec and @maxvec. It returns a negative errno if an error
1035  * occurs. If it succeeds, it returns the actual number of interrupts allocated
1036  * and updates the @dev's irq member to the lowest new interrupt number;
1037  * the other interrupt numbers allocated to this device are consecutive.
1038  **/
1039 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec)
1040 {
1041         int nvec;
1042         int rc;
1043
1044         if (!pci_msi_supported(dev, minvec))
1045                 return -EINVAL;
1046
1047         WARN_ON(!!dev->msi_enabled);
1048
1049         /* Check whether driver already requested MSI-X irqs */
1050         if (dev->msix_enabled) {
1051                 dev_info(&dev->dev,
1052                          "can't enable MSI (MSI-X already enabled)\n");
1053                 return -EINVAL;
1054         }
1055
1056         if (maxvec < minvec)
1057                 return -ERANGE;
1058
1059         nvec = pci_msi_vec_count(dev);
1060         if (nvec < 0)
1061                 return nvec;
1062         else if (nvec < minvec)
1063                 return -EINVAL;
1064         else if (nvec > maxvec)
1065                 nvec = maxvec;
1066
1067         do {
1068                 rc = msi_capability_init(dev, nvec);
1069                 if (rc < 0) {
1070                         return rc;
1071                 } else if (rc > 0) {
1072                         if (rc < minvec)
1073                                 return -ENOSPC;
1074                         nvec = rc;
1075                 }
1076         } while (rc);
1077
1078         return nvec;
1079 }
1080 EXPORT_SYMBOL(pci_enable_msi_range);
1081
1082 /**
1083  * pci_enable_msix_range - configure device's MSI-X capability structure
1084  * @dev: pointer to the pci_dev data structure of MSI-X device function
1085  * @entries: pointer to an array of MSI-X entries
1086  * @minvec: minimum number of MSI-X irqs requested
1087  * @maxvec: maximum number of MSI-X irqs requested
1088  *
1089  * Setup the MSI-X capability structure of device function with a maximum
1090  * possible number of interrupts in the range between @minvec and @maxvec
1091  * upon its software driver call to request for MSI-X mode enabled on its
1092  * hardware device function. It returns a negative errno if an error occurs.
1093  * If it succeeds, it returns the actual number of interrupts allocated and
1094  * indicates the successful configuration of MSI-X capability structure
1095  * with new allocated MSI-X interrupts.
1096  **/
1097 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1098                                int minvec, int maxvec)
1099 {
1100         int nvec = maxvec;
1101         int rc;
1102
1103         if (maxvec < minvec)
1104                 return -ERANGE;
1105
1106         do {
1107                 rc = pci_enable_msix(dev, entries, nvec);
1108                 if (rc < 0) {
1109                         return rc;
1110                 } else if (rc > 0) {
1111                         if (rc < minvec)
1112                                 return -ENOSPC;
1113                         nvec = rc;
1114                 }
1115         } while (rc);
1116
1117         return nvec;
1118 }
1119 EXPORT_SYMBOL(pci_enable_msix_range);
1120
1121 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc)
1122 {
1123         return to_pci_dev(desc->dev);
1124 }
1125
1126 void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
1127 {
1128         struct pci_dev *dev = msi_desc_to_pci_dev(desc);
1129
1130         return dev->bus->sysdata;
1131 }
1132 EXPORT_SYMBOL_GPL(msi_desc_to_pci_sysdata);
1133
1134 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
1135 /**
1136  * pci_msi_domain_write_msg - Helper to write MSI message to PCI config space
1137  * @irq_data:   Pointer to interrupt data of the MSI interrupt
1138  * @msg:        Pointer to the message
1139  */
1140 void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg)
1141 {
1142         struct msi_desc *desc = irq_data_get_msi_desc(irq_data);
1143
1144         /*
1145          * For MSI-X desc->irq is always equal to irq_data->irq. For
1146          * MSI only the first interrupt of MULTI MSI passes the test.
1147          */
1148         if (desc->irq == irq_data->irq)
1149                 __pci_write_msi_msg(desc, msg);
1150 }
1151
1152 /**
1153  * pci_msi_domain_calc_hwirq - Generate a unique ID for an MSI source
1154  * @dev:        Pointer to the PCI device
1155  * @desc:       Pointer to the msi descriptor
1156  *
1157  * The ID number is only used within the irqdomain.
1158  */
1159 irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
1160                                           struct msi_desc *desc)
1161 {
1162         return (irq_hw_number_t)desc->msi_attrib.entry_nr |
1163                 PCI_DEVID(dev->bus->number, dev->devfn) << 11 |
1164                 (pci_domain_nr(dev->bus) & 0xFFFFFFFF) << 27;
1165 }
1166
1167 static inline bool pci_msi_desc_is_multi_msi(struct msi_desc *desc)
1168 {
1169         return !desc->msi_attrib.is_msix && desc->nvec_used > 1;
1170 }
1171
1172 /**
1173  * pci_msi_domain_check_cap - Verify that @domain supports the capabilities for @dev
1174  * @domain:     The interrupt domain to check
1175  * @info:       The domain info for verification
1176  * @dev:        The device to check
1177  *
1178  * Returns:
1179  *  0 if the functionality is supported
1180  *  1 if Multi MSI is requested, but the domain does not support it
1181  *  -ENOTSUPP otherwise
1182  */
1183 int pci_msi_domain_check_cap(struct irq_domain *domain,
1184                              struct msi_domain_info *info, struct device *dev)
1185 {
1186         struct msi_desc *desc = first_pci_msi_entry(to_pci_dev(dev));
1187
1188         /* Special handling to support pci_enable_msi_range() */
1189         if (pci_msi_desc_is_multi_msi(desc) &&
1190             !(info->flags & MSI_FLAG_MULTI_PCI_MSI))
1191                 return 1;
1192         else if (desc->msi_attrib.is_msix && !(info->flags & MSI_FLAG_PCI_MSIX))
1193                 return -ENOTSUPP;
1194
1195         return 0;
1196 }
1197
1198 static int pci_msi_domain_handle_error(struct irq_domain *domain,
1199                                        struct msi_desc *desc, int error)
1200 {
1201         /* Special handling to support pci_enable_msi_range() */
1202         if (pci_msi_desc_is_multi_msi(desc) && error == -ENOSPC)
1203                 return 1;
1204
1205         return error;
1206 }
1207
1208 #ifdef GENERIC_MSI_DOMAIN_OPS
1209 static void pci_msi_domain_set_desc(msi_alloc_info_t *arg,
1210                                     struct msi_desc *desc)
1211 {
1212         arg->desc = desc;
1213         arg->hwirq = pci_msi_domain_calc_hwirq(msi_desc_to_pci_dev(desc),
1214                                                desc);
1215 }
1216 #else
1217 #define pci_msi_domain_set_desc         NULL
1218 #endif
1219
1220 static struct msi_domain_ops pci_msi_domain_ops_default = {
1221         .set_desc       = pci_msi_domain_set_desc,
1222         .msi_check      = pci_msi_domain_check_cap,
1223         .handle_error   = pci_msi_domain_handle_error,
1224 };
1225
1226 static void pci_msi_domain_update_dom_ops(struct msi_domain_info *info)
1227 {
1228         struct msi_domain_ops *ops = info->ops;
1229
1230         if (ops == NULL) {
1231                 info->ops = &pci_msi_domain_ops_default;
1232         } else {
1233                 if (ops->set_desc == NULL)
1234                         ops->set_desc = pci_msi_domain_set_desc;
1235                 if (ops->msi_check == NULL)
1236                         ops->msi_check = pci_msi_domain_check_cap;
1237                 if (ops->handle_error == NULL)
1238                         ops->handle_error = pci_msi_domain_handle_error;
1239         }
1240 }
1241
1242 static void pci_msi_domain_update_chip_ops(struct msi_domain_info *info)
1243 {
1244         struct irq_chip *chip = info->chip;
1245
1246         BUG_ON(!chip);
1247         if (!chip->irq_write_msi_msg)
1248                 chip->irq_write_msi_msg = pci_msi_domain_write_msg;
1249 }
1250
1251 /**
1252  * pci_msi_create_irq_domain - Creat a MSI interrupt domain
1253  * @node:       Optional device-tree node of the interrupt controller
1254  * @info:       MSI domain info
1255  * @parent:     Parent irq domain
1256  *
1257  * Updates the domain and chip ops and creates a MSI interrupt domain.
1258  *
1259  * Returns:
1260  * A domain pointer or NULL in case of failure.
1261  */
1262 struct irq_domain *pci_msi_create_irq_domain(struct device_node *node,
1263                                              struct msi_domain_info *info,
1264                                              struct irq_domain *parent)
1265 {
1266         struct irq_domain *domain;
1267
1268         if (info->flags & MSI_FLAG_USE_DEF_DOM_OPS)
1269                 pci_msi_domain_update_dom_ops(info);
1270         if (info->flags & MSI_FLAG_USE_DEF_CHIP_OPS)
1271                 pci_msi_domain_update_chip_ops(info);
1272
1273         domain = msi_create_irq_domain(node, info, parent);
1274         if (!domain)
1275                 return NULL;
1276
1277         domain->bus_token = DOMAIN_BUS_PCI_MSI;
1278         return domain;
1279 }
1280
1281 /**
1282  * pci_msi_domain_alloc_irqs - Allocate interrupts for @dev in @domain
1283  * @domain:     The interrupt domain to allocate from
1284  * @dev:        The device for which to allocate
1285  * @nvec:       The number of interrupts to allocate
1286  * @type:       Unused to allow simpler migration from the arch_XXX interfaces
1287  *
1288  * Returns:
1289  * A virtual interrupt number or an error code in case of failure
1290  */
1291 int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
1292                               int nvec, int type)
1293 {
1294         return msi_domain_alloc_irqs(domain, &dev->dev, nvec);
1295 }
1296
1297 /**
1298  * pci_msi_domain_free_irqs - Free interrupts for @dev in @domain
1299  * @domain:     The interrupt domain
1300  * @dev:        The device for which to free interrupts
1301  */
1302 void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev)
1303 {
1304         msi_domain_free_irqs(domain, &dev->dev);
1305 }
1306
1307 /**
1308  * pci_msi_create_default_irq_domain - Create a default MSI interrupt domain
1309  * @node:       Optional device-tree node of the interrupt controller
1310  * @info:       MSI domain info
1311  * @parent:     Parent irq domain
1312  *
1313  * Returns: A domain pointer or NULL in case of failure. If successful
1314  * the default PCI/MSI irqdomain pointer is updated.
1315  */
1316 struct irq_domain *pci_msi_create_default_irq_domain(struct device_node *node,
1317                 struct msi_domain_info *info, struct irq_domain *parent)
1318 {
1319         struct irq_domain *domain;
1320
1321         mutex_lock(&pci_msi_domain_lock);
1322         if (pci_msi_default_domain) {
1323                 pr_err("PCI: default irq domain for PCI MSI has already been created.\n");
1324                 domain = NULL;
1325         } else {
1326                 domain = pci_msi_create_irq_domain(node, info, parent);
1327                 pci_msi_default_domain = domain;
1328         }
1329         mutex_unlock(&pci_msi_domain_lock);
1330
1331         return domain;
1332 }
1333 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */