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