drivers/pci/msi.c

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