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