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