drivers/pci/msi.c

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