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         int i;
 482
 483         /* Determine how many msi entries we have */
 484         for_each_pci_msi_entry(entry, pdev)
 485                 num_msi += entry->nvec_used;
 486         if (!num_msi)
 487                 return 0;
 488
 489         /* Dynamically create the MSI attributes for the PCI device */
 490         msi_attrs = kzalloc(sizeof(void *) * (num_msi + 1), GFP_KERNEL);
 491         if (!msi_attrs)
 492                 return -ENOMEM;
 493         for_each_pci_msi_entry(entry, pdev) {
 494                 for (i = 0; i < entry->nvec_used; i++) {
 495                         msi_dev_attr = kzalloc(sizeof(*msi_dev_attr), GFP_KERNEL);
 496                         if (!msi_dev_attr)
 497                                 goto error_attrs;
 498                         msi_attrs[count] = &msi_dev_attr->attr;
 499
 500                         sysfs_attr_init(&msi_dev_attr->attr);
 501                         msi_dev_attr->attr.name = kasprintf(GFP_KERNEL, "%d",
 502                                                             entry->irq + i);
 503                         if (!msi_dev_attr->attr.name)
 504                                 goto error_attrs;
 505                         msi_dev_attr->attr.mode = S_IRUGO;
 506                         msi_dev_attr->show = msi_mode_show;
 507                         ++count;
 508                 }
 509         }
 510
 511         msi_irq_group = kzalloc(sizeof(*msi_irq_group), GFP_KERNEL);
 512         if (!msi_irq_group)
 513                 goto error_attrs;
 514         msi_irq_group->name = "msi_irqs";
 515         msi_irq_group->attrs = msi_attrs;
 516
 517         msi_irq_groups = kzalloc(sizeof(void *) * 2, GFP_KERNEL);
 518         if (!msi_irq_groups)
 519                 goto error_irq_group;
 520         msi_irq_groups[0] = msi_irq_group;
 521
 522         ret = sysfs_create_groups(&pdev->dev.kobj, msi_irq_groups);
 523         if (ret)
 524                 goto error_irq_groups;
 525         pdev->msi_irq_groups = msi_irq_groups;
 526
 527         return 0;
 528
 529 error_irq_groups:
 530         kfree(msi_irq_groups);
 531 error_irq_group:
 532         kfree(msi_irq_group);
 533 error_attrs:
 534         count = 0;
 535         msi_attr = msi_attrs[count];
 536         while (msi_attr) {
 537                 msi_dev_attr = container_of(msi_attr, struct device_attribute, attr);
 538                 kfree(msi_attr->name);
 539                 kfree(msi_dev_attr);
 540                 ++count;
 541                 msi_attr = msi_attrs[count];
 542         }
 543         kfree(msi_attrs);
 544         return ret;
 545 }
 546
 547 static struct msi_desc *msi_setup_entry(struct pci_dev *dev, int nvec)
 548 {
 549         u16 control;
 550         struct msi_desc *entry;
 551
 552         /* MSI Entry Initialization */
 553         entry = alloc_msi_entry(&dev->dev);
 554         if (!entry)
 555                 return NULL;
 556
 557         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 558
 559         entry->msi_attrib.is_msix       = 0;
 560         entry->msi_attrib.is_64         = !!(control & PCI_MSI_FLAGS_64BIT);
 561         entry->msi_attrib.entry_nr      = 0;
 562         entry->msi_attrib.maskbit       = !!(control & PCI_MSI_FLAGS_MASKBIT);
 563         entry->msi_attrib.default_irq   = dev->irq;     /* Save IOAPIC IRQ */
 564         entry->msi_attrib.multi_cap     = (control & PCI_MSI_FLAGS_QMASK) >> 1;
 565         entry->msi_attrib.multiple      = ilog2(__roundup_pow_of_two(nvec));
 566         entry->nvec_used                = nvec;
 567
 568         if (control & PCI_MSI_FLAGS_64BIT)
 569                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
 570         else
 571                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
 572
 573         /* Save the initial mask status */
 574         if (entry->msi_attrib.maskbit)
 575                 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
 576
 577         return entry;
 578 }
 579
 580 static int msi_verify_entries(struct pci_dev *dev)
 581 {
 582         struct msi_desc *entry;
 583
 584         for_each_pci_msi_entry(entry, dev) {
 585                 if (!dev->no_64bit_msi || !entry->msg.address_hi)
 586                         continue;
 587                 dev_err(&dev->dev, "Device has broken 64-bit MSI but arch"
 588                         " tried to assign one above 4G\n");
 589                 return -EIO;
 590         }
 591         return 0;
 592 }
 593
 594 /**
 595  * msi_capability_init - configure device's MSI capability structure
 596  * @dev: pointer to the pci_dev data structure of MSI device function
 597  * @nvec: number of interrupts to allocate
 598  *
 599  * Setup the MSI capability structure of the device with the requested
 600  * number of interrupts.  A return value of zero indicates the successful
 601  * setup of an entry with the new MSI irq.  A negative return value indicates
 602  * an error, and a positive return value indicates the number of interrupts
 603  * which could have been allocated.
 604  */
 605 static int msi_capability_init(struct pci_dev *dev, int nvec)
 606 {
 607         struct msi_desc *entry;
 608         int ret;
 609         unsigned mask;
 610
 611         pci_msi_set_enable(dev, 0);     /* Disable MSI during set up */
 612
 613         entry = msi_setup_entry(dev, nvec);
 614         if (!entry)
 615                 return -ENOMEM;
 616
 617         /* All MSIs are unmasked by default, Mask them all */
 618         mask = msi_mask(entry->msi_attrib.multi_cap);
 619         msi_mask_irq(entry, mask, mask);
 620
 621         list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 622
 623         /* Configure MSI capability structure */
 624         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 625         if (ret) {
 626                 msi_mask_irq(entry, mask, ~mask);
 627                 free_msi_irqs(dev);
 628                 return ret;
 629         }
 630
 631         ret = msi_verify_entries(dev);
 632         if (ret) {
 633                 msi_mask_irq(entry, mask, ~mask);
 634                 free_msi_irqs(dev);
 635                 return ret;
 636         }
 637
 638         ret = populate_msi_sysfs(dev);
 639         if (ret) {
 640                 msi_mask_irq(entry, mask, ~mask);
 641                 free_msi_irqs(dev);
 642                 return ret;
 643         }
 644
 645         /* Set MSI enabled bits  */
 646         pci_intx_for_msi(dev, 0);
 647         pci_msi_set_enable(dev, 1);
 648         dev->msi_enabled = 1;
 649
 650         pcibios_free_irq(dev);
 651         dev->irq = entry->irq;
 652         return 0;
 653 }
 654
 655 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
 656 {
 657         resource_size_t phys_addr;
 658         u32 table_offset;
 659         unsigned long flags;
 660         u8 bir;
 661
 662         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 663                               &table_offset);
 664         bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
 665         flags = pci_resource_flags(dev, bir);
 666         if (!flags || (flags & IORESOURCE_UNSET))
 667                 return NULL;
 668
 669         table_offset &= PCI_MSIX_TABLE_OFFSET;
 670         phys_addr = pci_resource_start(dev, bir) + table_offset;
 671
 672         return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 673 }
 674
 675 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 676                               struct msix_entry *entries, int nvec)
 677 {
 678         struct msi_desc *entry;
 679         int i;
 680
 681         for (i = 0; i < nvec; i++) {
 682                 entry = alloc_msi_entry(&dev->dev);
 683                 if (!entry) {
 684                         if (!i)
 685                                 iounmap(base);
 686                         else
 687                                 free_msi_irqs(dev);
 688                         /* No enough memory. Don't try again */
 689                         return -ENOMEM;
 690                 }
 691
 692                 entry->msi_attrib.is_msix       = 1;
 693                 entry->msi_attrib.is_64         = 1;
 694                 entry->msi_attrib.entry_nr      = entries[i].entry;
 695                 entry->msi_attrib.default_irq   = dev->irq;
 696                 entry->mask_base                = base;
 697                 entry->nvec_used                = 1;
 698
 699                 list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 700         }
 701
 702         return 0;
 703 }
 704
 705 static void msix_program_entries(struct pci_dev *dev,
 706                                  struct msix_entry *entries)
 707 {
 708         struct msi_desc *entry;
 709         int i = 0;
 710
 711         for_each_pci_msi_entry(entry, dev) {
 712                 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
 713                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 714
 715                 entries[i].vector = entry->irq;
 716                 entry->masked = readl(entry->mask_base + offset);
 717                 msix_mask_irq(entry, 1);
 718                 i++;
 719         }
 720 }
 721
 722 /**
 723  * msix_capability_init - configure device's MSI-X capability
 724  * @dev: pointer to the pci_dev data structure of MSI-X device function
 725  * @entries: pointer to an array of struct msix_entry entries
 726  * @nvec: number of @entries
 727  *
 728  * Setup the MSI-X capability structure of device function with a
 729  * single MSI-X irq. A return of zero indicates the successful setup of
 730  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
 731  **/
 732 static int msix_capability_init(struct pci_dev *dev,
 733                                 struct msix_entry *entries, int nvec)
 734 {
 735         int ret;
 736         u16 control;
 737         void __iomem *base;
 738
 739         /* Ensure MSI-X is disabled while it is set up */
 740         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 741
 742         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 743         /* Request & Map MSI-X table region */
 744         base = msix_map_region(dev, msix_table_size(control));
 745         if (!base)
 746                 return -ENOMEM;
 747
 748         ret = msix_setup_entries(dev, base, entries, nvec);
 749         if (ret)
 750                 return ret;
 751
 752         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 753         if (ret)
 754                 goto out_avail;
 755
 756         /* Check if all MSI entries honor device restrictions */
 757         ret = msi_verify_entries(dev);
 758         if (ret)
 759                 goto out_free;
 760
 761         /*
 762          * Some devices require MSI-X to be enabled before we can touch the
 763          * MSI-X registers.  We need to mask all the vectors to prevent
 764          * interrupts coming in before they're fully set up.
 765          */
 766         pci_msix_clear_and_set_ctrl(dev, 0,
 767                                 PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE);
 768
 769         msix_program_entries(dev, entries);
 770
 771         ret = populate_msi_sysfs(dev);
 772         if (ret)
 773                 goto out_free;
 774
 775         /* Set MSI-X enabled bits and unmask the function */
 776         pci_intx_for_msi(dev, 0);
 777         dev->msix_enabled = 1;
 778         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 779
 780         pcibios_free_irq(dev);
 781         return 0;
 782
 783 out_avail:
 784         if (ret < 0) {
 785                 /*
 786                  * If we had some success, report the number of irqs
 787                  * we succeeded in setting up.
 788                  */
 789                 struct msi_desc *entry;
 790                 int avail = 0;
 791
 792                 for_each_pci_msi_entry(entry, dev) {
 793                         if (entry->irq != 0)
 794                                 avail++;
 795                 }
 796                 if (avail != 0)
 797                         ret = avail;
 798         }
 799
 800 out_free:
 801         free_msi_irqs(dev);
 802
 803         return ret;
 804 }
 805
 806 /**
 807  * pci_msi_supported - check whether MSI may be enabled on a device
 808  * @dev: pointer to the pci_dev data structure of MSI device function
 809  * @nvec: how many MSIs have been requested ?
 810  *
 811  * Look at global flags, the device itself, and its parent buses
 812  * to determine if MSI/-X are supported for the device. If MSI/-X is
 813  * supported return 1, else return 0.
 814  **/
 815 static int pci_msi_supported(struct pci_dev *dev, int nvec)
 816 {
 817         struct pci_bus *bus;
 818
 819         /* MSI must be globally enabled and supported by the device */
 820         if (!pci_msi_enable)
 821                 return 0;
 822
 823         if (!dev || dev->no_msi || dev->current_state != PCI_D0)
 824                 return 0;
 825
 826         /*
 827          * You can't ask to have 0 or less MSIs configured.
 828          *  a) it's stupid ..
 829          *  b) the list manipulation code assumes nvec >= 1.
 830          */
 831         if (nvec < 1)
 832                 return 0;
 833
 834         /*
 835          * Any bridge which does NOT route MSI transactions from its
 836          * secondary bus to its primary bus must set NO_MSI flag on
 837          * the secondary pci_bus.
 838          * We expect only arch-specific PCI host bus controller driver
 839          * or quirks for specific PCI bridges to be setting NO_MSI.
 840          */
 841         for (bus = dev->bus; bus; bus = bus->parent)
 842                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 843                         return 0;
 844
 845         return 1;
 846 }
 847
 848 /**
 849  * pci_msi_vec_count - Return the number of MSI vectors a device can send
 850  * @dev: device to report about
 851  *
 852  * This function returns the number of MSI vectors a device requested via
 853  * Multiple Message Capable register. It returns a negative errno if the
 854  * device is not capable sending MSI interrupts. Otherwise, the call succeeds
 855  * and returns a power of two, up to a maximum of 2^5 (32), according to the
 856  * MSI specification.
 857  **/
 858 int pci_msi_vec_count(struct pci_dev *dev)
 859 {
 860         int ret;
 861         u16 msgctl;
 862
 863         if (!dev->msi_cap)
 864                 return -EINVAL;
 865
 866         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 867         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 868
 869         return ret;
 870 }
 871 EXPORT_SYMBOL(pci_msi_vec_count);
 872
 873 void pci_msi_shutdown(struct pci_dev *dev)
 874 {
 875         struct msi_desc *desc;
 876         u32 mask;
 877
 878         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 879                 return;
 880
 881         BUG_ON(list_empty(dev_to_msi_list(&dev->dev)));
 882         desc = first_pci_msi_entry(dev);
 883
 884         pci_msi_set_enable(dev, 0);
 885         pci_intx_for_msi(dev, 1);
 886         dev->msi_enabled = 0;
 887
 888         /* Return the device with MSI unmasked as initial states */
 889         mask = msi_mask(desc->msi_attrib.multi_cap);
 890         /* Keep cached state to be restored */
 891         __pci_msi_desc_mask_irq(desc, mask, ~mask);
 892
 893         /* Restore dev->irq to its default pin-assertion irq */
 894         dev->irq = desc->msi_attrib.default_irq;
 895         pcibios_alloc_irq(dev);
 896 }
 897
 898 void pci_disable_msi(struct pci_dev *dev)
 899 {
 900         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 901                 return;
 902
 903         pci_msi_shutdown(dev);
 904         free_msi_irqs(dev);
 905 }
 906 EXPORT_SYMBOL(pci_disable_msi);
 907
 908 /**
 909  * pci_msix_vec_count - return the number of device's MSI-X table entries
 910  * @dev: pointer to the pci_dev data structure of MSI-X device function
 911  * This function returns the number of device's MSI-X table entries and
 912  * therefore the number of MSI-X vectors device is capable of sending.
 913  * It returns a negative errno if the device is not capable of sending MSI-X
 914  * interrupts.
 915  **/
 916 int pci_msix_vec_count(struct pci_dev *dev)
 917 {
 918         u16 control;
 919
 920         if (!dev->msix_cap)
 921                 return -EINVAL;
 922
 923         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 924         return msix_table_size(control);
 925 }
 926 EXPORT_SYMBOL(pci_msix_vec_count);
 927
 928 /**
 929  * pci_enable_msix - configure device's MSI-X capability structure
 930  * @dev: pointer to the pci_dev data structure of MSI-X device function
 931  * @entries: pointer to an array of MSI-X entries
 932  * @nvec: number of MSI-X irqs requested for allocation by device driver
 933  *
 934  * Setup the MSI-X capability structure of device function with the number
 935  * of requested irqs upon its software driver call to request for
 936  * MSI-X mode enabled on its hardware device function. A return of zero
 937  * indicates the successful configuration of MSI-X capability structure
 938  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
 939  * Or a return of > 0 indicates that driver request is exceeding the number
 940  * of irqs or MSI-X vectors available. Driver should use the returned value to
 941  * re-send its request.
 942  **/
 943 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
 944 {
 945         int nr_entries;
 946         int i, j;
 947
 948         if (!pci_msi_supported(dev, nvec))
 949                 return -EINVAL;
 950
 951         if (!entries)
 952                 return -EINVAL;
 953
 954         nr_entries = pci_msix_vec_count(dev);
 955         if (nr_entries < 0)
 956                 return nr_entries;
 957         if (nvec > nr_entries)
 958                 return nr_entries;
 959
 960         /* Check for any invalid entries */
 961         for (i = 0; i < nvec; i++) {
 962                 if (entries[i].entry >= nr_entries)
 963                         return -EINVAL;         /* invalid entry */
 964                 for (j = i + 1; j < nvec; j++) {
 965                         if (entries[i].entry == entries[j].entry)
 966                                 return -EINVAL; /* duplicate entry */
 967                 }
 968         }
 969         WARN_ON(!!dev->msix_enabled);
 970
 971         /* Check whether driver already requested for MSI irq */
 972         if (dev->msi_enabled) {
 973                 dev_info(&dev->dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
 974                 return -EINVAL;
 975         }
 976         return msix_capability_init(dev, entries, nvec);
 977 }
 978 EXPORT_SYMBOL(pci_enable_msix);
 979
 980 void pci_msix_shutdown(struct pci_dev *dev)
 981 {
 982         struct msi_desc *entry;
 983
 984         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 985                 return;
 986
 987         /* Return the device with MSI-X masked as initial states */
 988         for_each_pci_msi_entry(entry, dev) {
 989                 /* Keep cached states to be restored */
 990                 __pci_msix_desc_mask_irq(entry, 1);
 991         }
 992
 993         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 994         pci_intx_for_msi(dev, 1);
 995         dev->msix_enabled = 0;
 996         pcibios_alloc_irq(dev);
 997 }
 998
 999 void pci_disable_msix(struct pci_dev *dev)
1000 {
1001         if (!pci_msi_enable || !dev || !dev->msix_enabled)
1002                 return;
1003
1004         pci_msix_shutdown(dev);
1005         free_msi_irqs(dev);
1006 }
1007 EXPORT_SYMBOL(pci_disable_msix);
1008
1009 void pci_no_msi(void)
1010 {
1011         pci_msi_enable = 0;
1012 }
1013
1014 /**
1015  * pci_msi_enabled - is MSI enabled?
1016  *
1017  * Returns true if MSI has not been disabled by the command-line option
1018  * pci=nomsi.
1019  **/
1020 int pci_msi_enabled(void)
1021 {
1022         return pci_msi_enable;
1023 }
1024 EXPORT_SYMBOL(pci_msi_enabled);
1025
1026 void pci_msi_init_pci_dev(struct pci_dev *dev)
1027 {
1028 }
1029
1030 /**
1031  * pci_enable_msi_range - configure device's MSI capability structure
1032  * @dev: device to configure
1033  * @minvec: minimal number of interrupts to configure
1034  * @maxvec: maximum number of interrupts to configure
1035  *
1036  * This function tries to allocate a maximum possible number of interrupts in a
1037  * range between @minvec and @maxvec. It returns a negative errno if an error
1038  * occurs. If it succeeds, it returns the actual number of interrupts allocated
1039  * and updates the @dev's irq member to the lowest new interrupt number;
1040  * the other interrupt numbers allocated to this device are consecutive.
1041  **/
1042 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec)
1043 {
1044         int nvec;
1045         int rc;
1046
1047         if (!pci_msi_supported(dev, minvec))
1048                 return -EINVAL;
1049
1050         WARN_ON(!!dev->msi_enabled);
1051
1052         /* Check whether driver already requested MSI-X irqs */
1053         if (dev->msix_enabled) {
1054                 dev_info(&dev->dev,
1055                          "can't enable MSI (MSI-X already enabled)\n");
1056                 return -EINVAL;
1057         }
1058
1059         if (maxvec < minvec)
1060                 return -ERANGE;
1061
1062         nvec = pci_msi_vec_count(dev);
1063         if (nvec < 0)
1064                 return nvec;
1065         else if (nvec < minvec)
1066                 return -EINVAL;
1067         else if (nvec > maxvec)
1068                 nvec = maxvec;
1069
1070         do {
1071                 rc = msi_capability_init(dev, nvec);
1072                 if (rc < 0) {
1073                         return rc;
1074                 } else if (rc > 0) {
1075                         if (rc < minvec)
1076                                 return -ENOSPC;
1077                         nvec = rc;
1078                 }
1079         } while (rc);
1080
1081         return nvec;
1082 }
1083 EXPORT_SYMBOL(pci_enable_msi_range);
1084
1085 /**
1086  * pci_enable_msix_range - configure device's MSI-X capability structure
1087  * @dev: pointer to the pci_dev data structure of MSI-X device function
1088  * @entries: pointer to an array of MSI-X entries
1089  * @minvec: minimum number of MSI-X irqs requested
1090  * @maxvec: maximum number of MSI-X irqs requested
1091  *
1092  * Setup the MSI-X capability structure of device function with a maximum
1093  * possible number of interrupts in the range between @minvec and @maxvec
1094  * upon its software driver call to request for MSI-X mode enabled on its
1095  * hardware device function. It returns a negative errno if an error occurs.
1096  * If it succeeds, it returns the actual number of interrupts allocated and
1097  * indicates the successful configuration of MSI-X capability structure
1098  * with new allocated MSI-X interrupts.
1099  **/
1100 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1101                                int minvec, int maxvec)
1102 {
1103         int nvec = maxvec;
1104         int rc;
1105
1106         if (maxvec < minvec)
1107                 return -ERANGE;
1108
1109         do {
1110                 rc = pci_enable_msix(dev, entries, nvec);
1111                 if (rc < 0) {
1112                         return rc;
1113                 } else if (rc > 0) {
1114                         if (rc < minvec)
1115                                 return -ENOSPC;
1116                         nvec = rc;
1117                 }
1118         } while (rc);
1119
1120         return nvec;
1121 }
1122 EXPORT_SYMBOL(pci_enable_msix_range);
1123
1124 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc)
1125 {
1126         return to_pci_dev(desc->dev);
1127 }
1128
1129 void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
1130 {
1131         struct pci_dev *dev = msi_desc_to_pci_dev(desc);
1132
1133         return dev->bus->sysdata;
1134 }
1135 EXPORT_SYMBOL_GPL(msi_desc_to_pci_sysdata);
1136
1137 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
1138 /**
1139  * pci_msi_domain_write_msg - Helper to write MSI message to PCI config space
1140  * @irq_data:   Pointer to interrupt data of the MSI interrupt
1141  * @msg:        Pointer to the message
1142  */
1143 void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg)
1144 {
1145         struct msi_desc *desc = irq_data_get_msi_desc(irq_data);
1146
1147         /*
1148          * For MSI-X desc->irq is always equal to irq_data->irq. For
1149          * MSI only the first interrupt of MULTI MSI passes the test.
1150          */
1151         if (desc->irq == irq_data->irq)
1152                 __pci_write_msi_msg(desc, msg);
1153 }
1154
1155 /**
1156  * pci_msi_domain_calc_hwirq - Generate a unique ID for an MSI source
1157  * @dev:        Pointer to the PCI device
1158  * @desc:       Pointer to the msi descriptor
1159  *
1160  * The ID number is only used within the irqdomain.
1161  */
1162 irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
1163                                           struct msi_desc *desc)
1164 {
1165         return (irq_hw_number_t)desc->msi_attrib.entry_nr |
1166                 PCI_DEVID(dev->bus->number, dev->devfn) << 11 |
1167                 (pci_domain_nr(dev->bus) & 0xFFFFFFFF) << 27;
1168 }
1169
1170 static inline bool pci_msi_desc_is_multi_msi(struct msi_desc *desc)
1171 {
1172         return !desc->msi_attrib.is_msix && desc->nvec_used > 1;
1173 }
1174
1175 /**
1176  * pci_msi_domain_check_cap - Verify that @domain supports the capabilities for @dev
1177  * @domain:     The interrupt domain to check
1178  * @info:       The domain info for verification
1179  * @dev:        The device to check
1180  *
1181  * Returns:
1182  *  0 if the functionality is supported
1183  *  1 if Multi MSI is requested, but the domain does not support it
1184  *  -ENOTSUPP otherwise
1185  */
1186 int pci_msi_domain_check_cap(struct irq_domain *domain,
1187                              struct msi_domain_info *info, struct device *dev)
1188 {
1189         struct msi_desc *desc = first_pci_msi_entry(to_pci_dev(dev));
1190
1191         /* Special handling to support pci_enable_msi_range() */
1192         if (pci_msi_desc_is_multi_msi(desc) &&
1193             !(info->flags & MSI_FLAG_MULTI_PCI_MSI))
1194                 return 1;
1195         else if (desc->msi_attrib.is_msix && !(info->flags & MSI_FLAG_PCI_MSIX))
1196                 return -ENOTSUPP;
1197
1198         return 0;
1199 }
1200
1201 static int pci_msi_domain_handle_error(struct irq_domain *domain,
1202                                        struct msi_desc *desc, int error)
1203 {
1204         /* Special handling to support pci_enable_msi_range() */
1205         if (pci_msi_desc_is_multi_msi(desc) && error == -ENOSPC)
1206                 return 1;
1207
1208         return error;
1209 }
1210
1211 #ifdef GENERIC_MSI_DOMAIN_OPS
1212 static void pci_msi_domain_set_desc(msi_alloc_info_t *arg,
1213                                     struct msi_desc *desc)
1214 {
1215         arg->desc = desc;
1216         arg->hwirq = pci_msi_domain_calc_hwirq(msi_desc_to_pci_dev(desc),
1217                                                desc);
1218 }
1219 #else
1220 #define pci_msi_domain_set_desc         NULL
1221 #endif
1222
1223 static struct msi_domain_ops pci_msi_domain_ops_default = {
1224         .set_desc       = pci_msi_domain_set_desc,
1225         .msi_check      = pci_msi_domain_check_cap,
1226         .handle_error   = pci_msi_domain_handle_error,
1227 };
1228
1229 static void pci_msi_domain_update_dom_ops(struct msi_domain_info *info)
1230 {
1231         struct msi_domain_ops *ops = info->ops;
1232
1233         if (ops == NULL) {
1234                 info->ops = &pci_msi_domain_ops_default;
1235         } else {
1236                 if (ops->set_desc == NULL)
1237                         ops->set_desc = pci_msi_domain_set_desc;
1238                 if (ops->msi_check == NULL)
1239                         ops->msi_check = pci_msi_domain_check_cap;
1240                 if (ops->handle_error == NULL)
1241                         ops->handle_error = pci_msi_domain_handle_error;
1242         }
1243 }
1244
1245 static void pci_msi_domain_update_chip_ops(struct msi_domain_info *info)
1246 {
1247         struct irq_chip *chip = info->chip;
1248
1249         BUG_ON(!chip);
1250         if (!chip->irq_write_msi_msg)
1251                 chip->irq_write_msi_msg = pci_msi_domain_write_msg;
1252 }
1253
1254 /**
1255  * pci_msi_create_irq_domain - Creat a MSI interrupt domain
1256  * @node:       Optional device-tree node of the interrupt controller
1257  * @info:       MSI domain info
1258  * @parent:     Parent irq domain
1259  *
1260  * Updates the domain and chip ops and creates a MSI interrupt domain.
1261  *
1262  * Returns:
1263  * A domain pointer or NULL in case of failure.
1264  */
1265 struct irq_domain *pci_msi_create_irq_domain(struct device_node *node,
1266                                              struct msi_domain_info *info,
1267                                              struct irq_domain *parent)
1268 {
1269         struct irq_domain *domain;
1270
1271         if (info->flags & MSI_FLAG_USE_DEF_DOM_OPS)
1272                 pci_msi_domain_update_dom_ops(info);
1273         if (info->flags & MSI_FLAG_USE_DEF_CHIP_OPS)
1274                 pci_msi_domain_update_chip_ops(info);
1275
1276         domain = msi_create_irq_domain(node, info, parent);
1277         if (!domain)
1278                 return NULL;
1279
1280         domain->bus_token = DOMAIN_BUS_PCI_MSI;
1281         return domain;
1282 }
1283
1284 /**
1285  * pci_msi_domain_alloc_irqs - Allocate interrupts for @dev in @domain
1286  * @domain:     The interrupt domain to allocate from
1287  * @dev:        The device for which to allocate
1288  * @nvec:       The number of interrupts to allocate
1289  * @type:       Unused to allow simpler migration from the arch_XXX interfaces
1290  *
1291  * Returns:
1292  * A virtual interrupt number or an error code in case of failure
1293  */
1294 int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
1295                               int nvec, int type)
1296 {
1297         return msi_domain_alloc_irqs(domain, &dev->dev, nvec);
1298 }
1299
1300 /**
1301  * pci_msi_domain_free_irqs - Free interrupts for @dev in @domain
1302  * @domain:     The interrupt domain
1303  * @dev:        The device for which to free interrupts
1304  */
1305 void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev)
1306 {
1307         msi_domain_free_irqs(domain, &dev->dev);
1308 }
1309
1310 /**
1311  * pci_msi_create_default_irq_domain - Create a default MSI interrupt domain
1312  * @node:       Optional device-tree node of the interrupt controller
1313  * @info:       MSI domain info
1314  * @parent:     Parent irq domain
1315  *
1316  * Returns: A domain pointer or NULL in case of failure. If successful
1317  * the default PCI/MSI irqdomain pointer is updated.
1318  */
1319 struct irq_domain *pci_msi_create_default_irq_domain(struct device_node *node,
1320                 struct msi_domain_info *info, struct irq_domain *parent)
1321 {
1322         struct irq_domain *domain;
1323
1324         mutex_lock(&pci_msi_domain_lock);
1325         if (pci_msi_default_domain) {
1326                 pr_err("PCI: default irq domain for PCI MSI has already been created.\n");
1327                 domain = NULL;
1328         } else {
1329                 domain = pci_msi_create_irq_domain(node, info, parent);
1330                 pci_msi_default_domain = domain;
1331         }
1332         mutex_unlock(&pci_msi_domain_lock);
1333
1334         return domain;
1335 }
1336 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */