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