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