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