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