drivers/pci/msi/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 #include <linux/err.h>
  10 #include <linux/export.h>
  11 #include <linux/irq.h>
  12
  13 #include "../pci.h"
  14 #include "msi.h"
  15
  16 static int pci_msi_enable = 1;
  17 int pci_msi_ignore_mask;
  18
  19 static noinline void pci_msi_update_mask(struct msi_desc *desc, u32 clear, u32 set)
  20 {
  21         raw_spinlock_t *lock = &to_pci_dev(desc->dev)->msi_lock;
  22         unsigned long flags;
  23
  24         if (!desc->pci.msi_attrib.can_mask)
  25                 return;
  26
  27         raw_spin_lock_irqsave(lock, flags);
  28         desc->pci.msi_mask &= ~clear;
  29         desc->pci.msi_mask |= set;
  30         pci_write_config_dword(msi_desc_to_pci_dev(desc), desc->pci.mask_pos,
  31                                desc->pci.msi_mask);
  32         raw_spin_unlock_irqrestore(lock, flags);
  33 }
  34
  35 static inline void pci_msi_mask(struct msi_desc *desc, u32 mask)
  36 {
  37         pci_msi_update_mask(desc, 0, mask);
  38 }
  39
  40 static inline void pci_msi_unmask(struct msi_desc *desc, u32 mask)
  41 {
  42         pci_msi_update_mask(desc, mask, 0);
  43 }
  44
  45 static inline void __iomem *pci_msix_desc_addr(struct msi_desc *desc)
  46 {
  47         return desc->pci.mask_base + desc->pci.msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
  48 }
  49
  50 /*
  51  * This internal function does not flush PCI writes to the device.  All
  52  * users must ensure that they read from the device before either assuming
  53  * that the device state is up to date, or returning out of this file.
  54  * It does not affect the msi_desc::msix_ctrl cache either. Use with care!
  55  */
  56 static void pci_msix_write_vector_ctrl(struct msi_desc *desc, u32 ctrl)
  57 {
  58         void __iomem *desc_addr = pci_msix_desc_addr(desc);
  59
  60         if (desc->pci.msi_attrib.can_mask)
  61                 writel(ctrl, desc_addr + PCI_MSIX_ENTRY_VECTOR_CTRL);
  62 }
  63
  64 static inline void pci_msix_mask(struct msi_desc *desc)
  65 {
  66         desc->pci.msix_ctrl |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
  67         pci_msix_write_vector_ctrl(desc, desc->pci.msix_ctrl);
  68         /* Flush write to device */
  69         readl(desc->pci.mask_base);
  70 }
  71
  72 static inline void pci_msix_unmask(struct msi_desc *desc)
  73 {
  74         desc->pci.msix_ctrl &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
  75         pci_msix_write_vector_ctrl(desc, desc->pci.msix_ctrl);
  76 }
  77
  78 static void __pci_msi_mask_desc(struct msi_desc *desc, u32 mask)
  79 {
  80         if (desc->pci.msi_attrib.is_msix)
  81                 pci_msix_mask(desc);
  82         else
  83                 pci_msi_mask(desc, mask);
  84 }
  85
  86 static void __pci_msi_unmask_desc(struct msi_desc *desc, u32 mask)
  87 {
  88         if (desc->pci.msi_attrib.is_msix)
  89                 pci_msix_unmask(desc);
  90         else
  91                 pci_msi_unmask(desc, mask);
  92 }
  93
  94 /**
  95  * pci_msi_mask_irq - Generic IRQ chip callback to mask PCI/MSI interrupts
  96  * @data:       pointer to irqdata associated to that interrupt
  97  */
  98 void pci_msi_mask_irq(struct irq_data *data)
  99 {
 100         struct msi_desc *desc = irq_data_get_msi_desc(data);
 101
 102         __pci_msi_mask_desc(desc, BIT(data->irq - desc->irq));
 103 }
 104 EXPORT_SYMBOL_GPL(pci_msi_mask_irq);
 105
 106 /**
 107  * pci_msi_unmask_irq - Generic IRQ chip callback to unmask PCI/MSI interrupts
 108  * @data:       pointer to irqdata associated to that interrupt
 109  */
 110 void pci_msi_unmask_irq(struct irq_data *data)
 111 {
 112         struct msi_desc *desc = irq_data_get_msi_desc(data);
 113
 114         __pci_msi_unmask_desc(desc, BIT(data->irq - desc->irq));
 115 }
 116 EXPORT_SYMBOL_GPL(pci_msi_unmask_irq);
 117
 118 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 119 {
 120         struct pci_dev *dev = msi_desc_to_pci_dev(entry);
 121
 122         BUG_ON(dev->current_state != PCI_D0);
 123
 124         if (entry->pci.msi_attrib.is_msix) {
 125                 void __iomem *base = pci_msix_desc_addr(entry);
 126
 127                 if (WARN_ON_ONCE(entry->pci.msi_attrib.is_virtual))
 128                         return;
 129
 130                 msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR);
 131                 msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR);
 132                 msg->data = readl(base + PCI_MSIX_ENTRY_DATA);
 133         } else {
 134                 int pos = dev->msi_cap;
 135                 u16 data;
 136
 137                 pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 138                                       &msg->address_lo);
 139                 if (entry->pci.msi_attrib.is_64) {
 140                         pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 141                                               &msg->address_hi);
 142                         pci_read_config_word(dev, pos + PCI_MSI_DATA_64, &data);
 143                 } else {
 144                         msg->address_hi = 0;
 145                         pci_read_config_word(dev, pos + PCI_MSI_DATA_32, &data);
 146                 }
 147                 msg->data = data;
 148         }
 149 }
 150
 151 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 152 {
 153         struct pci_dev *dev = msi_desc_to_pci_dev(entry);
 154
 155         if (dev->current_state != PCI_D0 || pci_dev_is_disconnected(dev)) {
 156                 /* Don't touch the hardware now */
 157         } else if (entry->pci.msi_attrib.is_msix) {
 158                 void __iomem *base = pci_msix_desc_addr(entry);
 159                 u32 ctrl = entry->pci.msix_ctrl;
 160                 bool unmasked = !(ctrl & PCI_MSIX_ENTRY_CTRL_MASKBIT);
 161
 162                 if (entry->pci.msi_attrib.is_virtual)
 163                         goto skip;
 164
 165                 /*
 166                  * The specification mandates that the entry is masked
 167                  * when the message is modified:
 168                  *
 169                  * "If software changes the Address or Data value of an
 170                  * entry while the entry is unmasked, the result is
 171                  * undefined."
 172                  */
 173                 if (unmasked)
 174                         pci_msix_write_vector_ctrl(entry, ctrl | PCI_MSIX_ENTRY_CTRL_MASKBIT);
 175
 176                 writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
 177                 writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
 178                 writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
 179
 180                 if (unmasked)
 181                         pci_msix_write_vector_ctrl(entry, ctrl);
 182
 183                 /* Ensure that the writes are visible in the device */
 184                 readl(base + PCI_MSIX_ENTRY_DATA);
 185         } else {
 186                 int pos = dev->msi_cap;
 187                 u16 msgctl;
 188
 189                 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
 190                 msgctl &= ~PCI_MSI_FLAGS_QSIZE;
 191                 msgctl |= entry->pci.msi_attrib.multiple << 4;
 192                 pci_write_config_word(dev, pos + PCI_MSI_FLAGS, msgctl);
 193
 194                 pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 195                                        msg->address_lo);
 196                 if (entry->pci.msi_attrib.is_64) {
 197                         pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 198                                                msg->address_hi);
 199                         pci_write_config_word(dev, pos + PCI_MSI_DATA_64,
 200                                               msg->data);
 201                 } else {
 202                         pci_write_config_word(dev, pos + PCI_MSI_DATA_32,
 203                                               msg->data);
 204                 }
 205                 /* Ensure that the writes are visible in the device */
 206                 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
 207         }
 208
 209 skip:
 210         entry->msg = *msg;
 211
 212         if (entry->write_msi_msg)
 213                 entry->write_msi_msg(entry, entry->write_msi_msg_data);
 214
 215 }
 216
 217 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
 218 {
 219         struct msi_desc *entry = irq_get_msi_desc(irq);
 220
 221         __pci_write_msi_msg(entry, msg);
 222 }
 223 EXPORT_SYMBOL_GPL(pci_write_msi_msg);
 224
 225 static void free_msi_irqs(struct pci_dev *dev)
 226 {
 227         struct list_head *msi_list = dev_to_msi_list(&dev->dev);
 228         struct msi_desc *entry, *tmp;
 229         int i;
 230
 231         for_each_pci_msi_entry(entry, dev)
 232                 if (entry->irq)
 233                         for (i = 0; i < entry->nvec_used; i++)
 234                                 BUG_ON(irq_has_action(entry->irq + i));
 235
 236         if (dev->msi_irq_groups) {
 237                 msi_destroy_sysfs(&dev->dev, dev->msi_irq_groups);
 238                 dev->msi_irq_groups = NULL;
 239         }
 240
 241         pci_msi_teardown_msi_irqs(dev);
 242
 243         list_for_each_entry_safe(entry, tmp, msi_list, list) {
 244                 list_del(&entry->list);
 245                 free_msi_entry(entry);
 246         }
 247
 248         if (dev->msix_base) {
 249                 iounmap(dev->msix_base);
 250                 dev->msix_base = NULL;
 251         }
 252 }
 253
 254 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
 255 {
 256         if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
 257                 pci_intx(dev, enable);
 258 }
 259
 260 static void pci_msi_set_enable(struct pci_dev *dev, int enable)
 261 {
 262         u16 control;
 263
 264         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 265         control &= ~PCI_MSI_FLAGS_ENABLE;
 266         if (enable)
 267                 control |= PCI_MSI_FLAGS_ENABLE;
 268         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 269 }
 270
 271 /*
 272  * Architecture override returns true when the PCI MSI message should be
 273  * written by the generic restore function.
 274  */
 275 bool __weak arch_restore_msi_irqs(struct pci_dev *dev)
 276 {
 277         return true;
 278 }
 279
 280 static void __pci_restore_msi_state(struct pci_dev *dev)
 281 {
 282         struct msi_desc *entry;
 283         u16 control;
 284
 285         if (!dev->msi_enabled)
 286                 return;
 287
 288         entry = irq_get_msi_desc(dev->irq);
 289
 290         pci_intx_for_msi(dev, 0);
 291         pci_msi_set_enable(dev, 0);
 292         if (arch_restore_msi_irqs(dev))
 293                 __pci_write_msi_msg(entry, &entry->msg);
 294
 295         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 296         pci_msi_update_mask(entry, 0, 0);
 297         control &= ~PCI_MSI_FLAGS_QSIZE;
 298         control |= (entry->pci.msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
 299         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 300 }
 301
 302 static void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
 303 {
 304         u16 ctrl;
 305
 306         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
 307         ctrl &= ~clear;
 308         ctrl |= set;
 309         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
 310 }
 311
 312 static void __pci_restore_msix_state(struct pci_dev *dev)
 313 {
 314         struct msi_desc *entry;
 315         bool write_msg;
 316
 317         if (!dev->msix_enabled)
 318                 return;
 319         BUG_ON(list_empty(dev_to_msi_list(&dev->dev)));
 320
 321         /* route the table */
 322         pci_intx_for_msi(dev, 0);
 323         pci_msix_clear_and_set_ctrl(dev, 0,
 324                                 PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL);
 325
 326         write_msg = arch_restore_msi_irqs(dev);
 327
 328         for_each_pci_msi_entry(entry, dev) {
 329                 if (write_msg)
 330                         __pci_write_msi_msg(entry, &entry->msg);
 331                 pci_msix_write_vector_ctrl(entry, entry->pci.msix_ctrl);
 332         }
 333
 334         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 335 }
 336
 337 void pci_restore_msi_state(struct pci_dev *dev)
 338 {
 339         __pci_restore_msi_state(dev);
 340         __pci_restore_msix_state(dev);
 341 }
 342 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
 343
 344 static struct msi_desc *
 345 msi_setup_entry(struct pci_dev *dev, int nvec, struct irq_affinity *affd)
 346 {
 347         struct irq_affinity_desc *masks = NULL;
 348         struct msi_desc *entry;
 349         u16 control;
 350
 351         if (affd)
 352                 masks = irq_create_affinity_masks(nvec, affd);
 353
 354         /* MSI Entry Initialization */
 355         entry = alloc_msi_entry(&dev->dev, nvec, masks);
 356         if (!entry)
 357                 goto out;
 358
 359         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 360         /* Lies, damned lies, and MSIs */
 361         if (dev->dev_flags & PCI_DEV_FLAGS_HAS_MSI_MASKING)
 362                 control |= PCI_MSI_FLAGS_MASKBIT;
 363
 364         entry->pci.msi_attrib.is_msix   = 0;
 365         entry->pci.msi_attrib.is_64             = !!(control & PCI_MSI_FLAGS_64BIT);
 366         entry->pci.msi_attrib.is_virtual    = 0;
 367         entry->pci.msi_attrib.entry_nr  = 0;
 368         entry->pci.msi_attrib.can_mask  = !pci_msi_ignore_mask &&
 369                                           !!(control & PCI_MSI_FLAGS_MASKBIT);
 370         entry->pci.msi_attrib.default_irq       = dev->irq;     /* Save IOAPIC IRQ */
 371         entry->pci.msi_attrib.multi_cap = (control & PCI_MSI_FLAGS_QMASK) >> 1;
 372         entry->pci.msi_attrib.multiple  = ilog2(__roundup_pow_of_two(nvec));
 373
 374         if (control & PCI_MSI_FLAGS_64BIT)
 375                 entry->pci.mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
 376         else
 377                 entry->pci.mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
 378
 379         /* Save the initial mask status */
 380         if (entry->pci.msi_attrib.can_mask)
 381                 pci_read_config_dword(dev, entry->pci.mask_pos, &entry->pci.msi_mask);
 382
 383 out:
 384         kfree(masks);
 385         return entry;
 386 }
 387
 388 static int msi_verify_entries(struct pci_dev *dev)
 389 {
 390         struct msi_desc *entry;
 391
 392         if (!dev->no_64bit_msi)
 393                 return 0;
 394
 395         for_each_pci_msi_entry(entry, dev) {
 396                 if (entry->msg.address_hi) {
 397                         pci_err(dev, "arch assigned 64-bit MSI address %#x%08x but device only supports 32 bits\n",
 398                                 entry->msg.address_hi, entry->msg.address_lo);
 399                         return -EIO;
 400                 }
 401         }
 402         return 0;
 403 }
 404
 405 /**
 406  * msi_capability_init - configure device's MSI capability structure
 407  * @dev: pointer to the pci_dev data structure of MSI device function
 408  * @nvec: number of interrupts to allocate
 409  * @affd: description of automatic IRQ affinity assignments (may be %NULL)
 410  *
 411  * Setup the MSI capability structure of the device with the requested
 412  * number of interrupts.  A return value of zero indicates the successful
 413  * setup of an entry with the new MSI IRQ.  A negative return value indicates
 414  * an error, and a positive return value indicates the number of interrupts
 415  * which could have been allocated.
 416  */
 417 static int msi_capability_init(struct pci_dev *dev, int nvec,
 418                                struct irq_affinity *affd)
 419 {
 420         const struct attribute_group **groups;
 421         struct msi_desc *entry;
 422         int ret;
 423
 424         /*
 425          * Disable MSI during setup in the hardware, but mark it enabled
 426          * so that setup code can evaluate it.
 427          */
 428         pci_msi_set_enable(dev, 0);
 429         dev->msi_enabled = 1;
 430
 431         entry = msi_setup_entry(dev, nvec, affd);
 432         if (!entry) {
 433                 ret = -ENOMEM;
 434                 goto fail;
 435         }
 436
 437         /* All MSIs are unmasked by default; mask them all */
 438         pci_msi_mask(entry, msi_multi_mask(entry));
 439
 440         list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 441
 442         /* Configure MSI capability structure */
 443         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 444         if (ret)
 445                 goto err;
 446
 447         ret = msi_verify_entries(dev);
 448         if (ret)
 449                 goto err;
 450
 451         groups = msi_populate_sysfs(&dev->dev);
 452         if (IS_ERR(groups)) {
 453                 ret = PTR_ERR(groups);
 454                 goto err;
 455         }
 456
 457         dev->msi_irq_groups = groups;
 458
 459         /* Set MSI enabled bits */
 460         pci_intx_for_msi(dev, 0);
 461         pci_msi_set_enable(dev, 1);
 462
 463         pcibios_free_irq(dev);
 464         dev->irq = entry->irq;
 465         return 0;
 466
 467 err:
 468         pci_msi_unmask(entry, msi_multi_mask(entry));
 469         free_msi_irqs(dev);
 470 fail:
 471         dev->msi_enabled = 0;
 472         return ret;
 473 }
 474
 475 static void __iomem *msix_map_region(struct pci_dev *dev,
 476                                      unsigned int nr_entries)
 477 {
 478         resource_size_t phys_addr;
 479         u32 table_offset;
 480         unsigned long flags;
 481         u8 bir;
 482
 483         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 484                               &table_offset);
 485         bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
 486         flags = pci_resource_flags(dev, bir);
 487         if (!flags || (flags & IORESOURCE_UNSET))
 488                 return NULL;
 489
 490         table_offset &= PCI_MSIX_TABLE_OFFSET;
 491         phys_addr = pci_resource_start(dev, bir) + table_offset;
 492
 493         return ioremap(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 494 }
 495
 496 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 497                               struct msix_entry *entries, int nvec,
 498                               struct irq_affinity *affd)
 499 {
 500         struct irq_affinity_desc *curmsk, *masks = NULL;
 501         struct msi_desc *entry;
 502         void __iomem *addr;
 503         int ret, i;
 504         int vec_count = pci_msix_vec_count(dev);
 505
 506         if (affd)
 507                 masks = irq_create_affinity_masks(nvec, affd);
 508
 509         for (i = 0, curmsk = masks; i < nvec; i++) {
 510                 entry = alloc_msi_entry(&dev->dev, 1, curmsk);
 511                 if (!entry) {
 512                         /* No enough memory. Don't try again */
 513                         ret = -ENOMEM;
 514                         goto out;
 515                 }
 516
 517                 entry->pci.msi_attrib.is_msix   = 1;
 518                 entry->pci.msi_attrib.is_64     = 1;
 519
 520                 if (entries)
 521                         entry->pci.msi_attrib.entry_nr = entries[i].entry;
 522                 else
 523                         entry->pci.msi_attrib.entry_nr = i;
 524
 525                 entry->pci.msi_attrib.is_virtual =
 526                         entry->pci.msi_attrib.entry_nr >= vec_count;
 527
 528                 entry->pci.msi_attrib.can_mask  = !pci_msi_ignore_mask &&
 529                                                   !entry->pci.msi_attrib.is_virtual;
 530
 531                 entry->pci.msi_attrib.default_irq       = dev->irq;
 532                 entry->pci.mask_base                    = base;
 533
 534                 if (entry->pci.msi_attrib.can_mask) {
 535                         addr = pci_msix_desc_addr(entry);
 536                         entry->pci.msix_ctrl = readl(addr + PCI_MSIX_ENTRY_VECTOR_CTRL);
 537                 }
 538
 539                 list_add_tail(&entry->list, dev_to_msi_list(&dev->dev));
 540                 if (masks)
 541                         curmsk++;
 542         }
 543         ret = 0;
 544 out:
 545         kfree(masks);
 546         return ret;
 547 }
 548
 549 static void msix_update_entries(struct pci_dev *dev, struct msix_entry *entries)
 550 {
 551         struct msi_desc *entry;
 552
 553         if (entries) {
 554                 for_each_pci_msi_entry(entry, dev) {
 555                         entries->vector = entry->irq;
 556                         entries++;
 557                 }
 558         }
 559 }
 560
 561 static void msix_mask_all(void __iomem *base, int tsize)
 562 {
 563         u32 ctrl = PCI_MSIX_ENTRY_CTRL_MASKBIT;
 564         int i;
 565
 566         if (pci_msi_ignore_mask)
 567                 return;
 568
 569         for (i = 0; i < tsize; i++, base += PCI_MSIX_ENTRY_SIZE)
 570                 writel(ctrl, base + PCI_MSIX_ENTRY_VECTOR_CTRL);
 571 }
 572
 573 /**
 574  * msix_capability_init - configure device's MSI-X capability
 575  * @dev: pointer to the pci_dev data structure of MSI-X device function
 576  * @entries: pointer to an array of struct msix_entry entries
 577  * @nvec: number of @entries
 578  * @affd: Optional pointer to enable automatic affinity assignment
 579  *
 580  * Setup the MSI-X capability structure of device function with a
 581  * single MSI-X IRQ. A return of zero indicates the successful setup of
 582  * requested MSI-X entries with allocated IRQs or non-zero for otherwise.
 583  **/
 584 static int msix_capability_init(struct pci_dev *dev, struct msix_entry *entries,
 585                                 int nvec, struct irq_affinity *affd)
 586 {
 587         const struct attribute_group **groups;
 588         void __iomem *base;
 589         int ret, tsize;
 590         u16 control;
 591
 592         /*
 593          * Some devices require MSI-X to be enabled before the MSI-X
 594          * registers can be accessed.  Mask all the vectors to prevent
 595          * interrupts coming in before they're fully set up.
 596          */
 597         pci_msix_clear_and_set_ctrl(dev, 0, PCI_MSIX_FLAGS_MASKALL |
 598                                     PCI_MSIX_FLAGS_ENABLE);
 599
 600         /* Mark it enabled so setup functions can query it */
 601         dev->msix_enabled = 1;
 602
 603         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 604         /* Request & Map MSI-X table region */
 605         tsize = msix_table_size(control);
 606         base = msix_map_region(dev, tsize);
 607         if (!base) {
 608                 ret = -ENOMEM;
 609                 goto out_disable;
 610         }
 611
 612         dev->msix_base = base;
 613
 614         ret = msix_setup_entries(dev, base, entries, nvec, affd);
 615         if (ret)
 616                 goto out_free;
 617
 618         ret = pci_msi_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 619         if (ret)
 620                 goto out_free;
 621
 622         /* Check if all MSI entries honor device restrictions */
 623         ret = msi_verify_entries(dev);
 624         if (ret)
 625                 goto out_free;
 626
 627         msix_update_entries(dev, entries);
 628
 629         groups = msi_populate_sysfs(&dev->dev);
 630         if (IS_ERR(groups)) {
 631                 ret = PTR_ERR(groups);
 632                 goto out_free;
 633         }
 634
 635         dev->msi_irq_groups = groups;
 636
 637         /* Disable INTX */
 638         pci_intx_for_msi(dev, 0);
 639
 640         /*
 641          * Ensure that all table entries are masked to prevent
 642          * stale entries from firing in a crash kernel.
 643          *
 644          * Done late to deal with a broken Marvell NVME device
 645          * which takes the MSI-X mask bits into account even
 646          * when MSI-X is disabled, which prevents MSI delivery.
 647          */
 648         msix_mask_all(base, tsize);
 649         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 650
 651         pcibios_free_irq(dev);
 652         return 0;
 653
 654 out_free:
 655         free_msi_irqs(dev);
 656
 657 out_disable:
 658         dev->msix_enabled = 0;
 659         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE, 0);
 660
 661         return ret;
 662 }
 663
 664 /**
 665  * pci_msi_supported - check whether MSI may be enabled on a device
 666  * @dev: pointer to the pci_dev data structure of MSI device function
 667  * @nvec: how many MSIs have been requested?
 668  *
 669  * Look at global flags, the device itself, and its parent buses
 670  * to determine if MSI/-X are supported for the device. If MSI/-X is
 671  * supported return 1, else return 0.
 672  **/
 673 static int pci_msi_supported(struct pci_dev *dev, int nvec)
 674 {
 675         struct pci_bus *bus;
 676
 677         /* MSI must be globally enabled and supported by the device */
 678         if (!pci_msi_enable)
 679                 return 0;
 680
 681         if (!dev || dev->no_msi)
 682                 return 0;
 683
 684         /*
 685          * You can't ask to have 0 or less MSIs configured.
 686          *  a) it's stupid ..
 687          *  b) the list manipulation code assumes nvec >= 1.
 688          */
 689         if (nvec < 1)
 690                 return 0;
 691
 692         /*
 693          * Any bridge which does NOT route MSI transactions from its
 694          * secondary bus to its primary bus must set NO_MSI flag on
 695          * the secondary pci_bus.
 696          *
 697          * The NO_MSI flag can either be set directly by:
 698          * - arch-specific PCI host bus controller drivers (deprecated)
 699          * - quirks for specific PCI bridges
 700          *
 701          * or indirectly by platform-specific PCI host bridge drivers by
 702          * advertising the 'msi_domain' property, which results in
 703          * the NO_MSI flag when no MSI domain is found for this bridge
 704          * at probe time.
 705          */
 706         for (bus = dev->bus; bus; bus = bus->parent)
 707                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 708                         return 0;
 709
 710         return 1;
 711 }
 712
 713 /**
 714  * pci_msi_vec_count - Return the number of MSI vectors a device can send
 715  * @dev: device to report about
 716  *
 717  * This function returns the number of MSI vectors a device requested via
 718  * Multiple Message Capable register. It returns a negative errno if the
 719  * device is not capable sending MSI interrupts. Otherwise, the call succeeds
 720  * and returns a power of two, up to a maximum of 2^5 (32), according to the
 721  * MSI specification.
 722  **/
 723 int pci_msi_vec_count(struct pci_dev *dev)
 724 {
 725         int ret;
 726         u16 msgctl;
 727
 728         if (!dev->msi_cap)
 729                 return -EINVAL;
 730
 731         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 732         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 733
 734         return ret;
 735 }
 736 EXPORT_SYMBOL(pci_msi_vec_count);
 737
 738 static void pci_msi_shutdown(struct pci_dev *dev)
 739 {
 740         struct msi_desc *desc;
 741
 742         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 743                 return;
 744
 745         BUG_ON(list_empty(dev_to_msi_list(&dev->dev)));
 746         desc = first_pci_msi_entry(dev);
 747
 748         pci_msi_set_enable(dev, 0);
 749         pci_intx_for_msi(dev, 1);
 750         dev->msi_enabled = 0;
 751
 752         /* Return the device with MSI unmasked as initial states */
 753         pci_msi_unmask(desc, msi_multi_mask(desc));
 754
 755         /* Restore dev->irq to its default pin-assertion IRQ */
 756         dev->irq = desc->pci.msi_attrib.default_irq;
 757         pcibios_alloc_irq(dev);
 758 }
 759
 760 void pci_disable_msi(struct pci_dev *dev)
 761 {
 762         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 763                 return;
 764
 765         pci_msi_shutdown(dev);
 766         free_msi_irqs(dev);
 767 }
 768 EXPORT_SYMBOL(pci_disable_msi);
 769
 770 /**
 771  * pci_msix_vec_count - return the number of device's MSI-X table entries
 772  * @dev: pointer to the pci_dev data structure of MSI-X device function
 773  * This function returns the number of device's MSI-X table entries and
 774  * therefore the number of MSI-X vectors device is capable of sending.
 775  * It returns a negative errno if the device is not capable of sending MSI-X
 776  * interrupts.
 777  **/
 778 int pci_msix_vec_count(struct pci_dev *dev)
 779 {
 780         u16 control;
 781
 782         if (!dev->msix_cap)
 783                 return -EINVAL;
 784
 785         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 786         return msix_table_size(control);
 787 }
 788 EXPORT_SYMBOL(pci_msix_vec_count);
 789
 790 static int __pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries,
 791                              int nvec, struct irq_affinity *affd, int flags)
 792 {
 793         int nr_entries;
 794         int i, j;
 795
 796         if (!pci_msi_supported(dev, nvec) || dev->current_state != PCI_D0)
 797                 return -EINVAL;
 798
 799         nr_entries = pci_msix_vec_count(dev);
 800         if (nr_entries < 0)
 801                 return nr_entries;
 802         if (nvec > nr_entries && !(flags & PCI_IRQ_VIRTUAL))
 803                 return nr_entries;
 804
 805         if (entries) {
 806                 /* Check for any invalid entries */
 807                 for (i = 0; i < nvec; i++) {
 808                         if (entries[i].entry >= nr_entries)
 809                                 return -EINVAL;         /* invalid entry */
 810                         for (j = i + 1; j < nvec; j++) {
 811                                 if (entries[i].entry == entries[j].entry)
 812                                         return -EINVAL; /* duplicate entry */
 813                         }
 814                 }
 815         }
 816
 817         /* Check whether driver already requested for MSI IRQ */
 818         if (dev->msi_enabled) {
 819                 pci_info(dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
 820                 return -EINVAL;
 821         }
 822         return msix_capability_init(dev, entries, nvec, affd);
 823 }
 824
 825 static void pci_msix_shutdown(struct pci_dev *dev)
 826 {
 827         struct msi_desc *entry;
 828
 829         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 830                 return;
 831
 832         if (pci_dev_is_disconnected(dev)) {
 833                 dev->msix_enabled = 0;
 834                 return;
 835         }
 836
 837         /* Return the device with MSI-X masked as initial states */
 838         for_each_pci_msi_entry(entry, dev)
 839                 pci_msix_mask(entry);
 840
 841         pci_msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 842         pci_intx_for_msi(dev, 1);
 843         dev->msix_enabled = 0;
 844         pcibios_alloc_irq(dev);
 845 }
 846
 847 void pci_disable_msix(struct pci_dev *dev)
 848 {
 849         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 850                 return;
 851
 852         pci_msix_shutdown(dev);
 853         free_msi_irqs(dev);
 854 }
 855 EXPORT_SYMBOL(pci_disable_msix);
 856
 857 static int __pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec,
 858                                   struct irq_affinity *affd)
 859 {
 860         int nvec;
 861         int rc;
 862
 863         if (!pci_msi_supported(dev, minvec) || dev->current_state != PCI_D0)
 864                 return -EINVAL;
 865
 866         /* Check whether driver already requested MSI-X IRQs */
 867         if (dev->msix_enabled) {
 868                 pci_info(dev, "can't enable MSI (MSI-X already enabled)\n");
 869                 return -EINVAL;
 870         }
 871
 872         if (maxvec < minvec)
 873                 return -ERANGE;
 874
 875         if (WARN_ON_ONCE(dev->msi_enabled))
 876                 return -EINVAL;
 877
 878         nvec = pci_msi_vec_count(dev);
 879         if (nvec < 0)
 880                 return nvec;
 881         if (nvec < minvec)
 882                 return -ENOSPC;
 883
 884         if (nvec > maxvec)
 885                 nvec = maxvec;
 886
 887         for (;;) {
 888                 if (affd) {
 889                         nvec = irq_calc_affinity_vectors(minvec, nvec, affd);
 890                         if (nvec < minvec)
 891                                 return -ENOSPC;
 892                 }
 893
 894                 rc = msi_capability_init(dev, nvec, affd);
 895                 if (rc == 0)
 896                         return nvec;
 897
 898                 if (rc < 0)
 899                         return rc;
 900                 if (rc < minvec)
 901                         return -ENOSPC;
 902
 903                 nvec = rc;
 904         }
 905 }
 906
 907 /* deprecated, don't use */
 908 int pci_enable_msi(struct pci_dev *dev)
 909 {
 910         int rc = __pci_enable_msi_range(dev, 1, 1, NULL);
 911         if (rc < 0)
 912                 return rc;
 913         return 0;
 914 }
 915 EXPORT_SYMBOL(pci_enable_msi);
 916
 917 static int __pci_enable_msix_range(struct pci_dev *dev,
 918                                    struct msix_entry *entries, int minvec,
 919                                    int maxvec, struct irq_affinity *affd,
 920                                    int flags)
 921 {
 922         int rc, nvec = maxvec;
 923
 924         if (maxvec < minvec)
 925                 return -ERANGE;
 926
 927         if (WARN_ON_ONCE(dev->msix_enabled))
 928                 return -EINVAL;
 929
 930         for (;;) {
 931                 if (affd) {
 932                         nvec = irq_calc_affinity_vectors(minvec, nvec, affd);
 933                         if (nvec < minvec)
 934                                 return -ENOSPC;
 935                 }
 936
 937                 rc = __pci_enable_msix(dev, entries, nvec, affd, flags);
 938                 if (rc == 0)
 939                         return nvec;
 940
 941                 if (rc < 0)
 942                         return rc;
 943                 if (rc < minvec)
 944                         return -ENOSPC;
 945
 946                 nvec = rc;
 947         }
 948 }
 949
 950 /**
 951  * pci_enable_msix_range - configure device's MSI-X capability structure
 952  * @dev: pointer to the pci_dev data structure of MSI-X device function
 953  * @entries: pointer to an array of MSI-X entries
 954  * @minvec: minimum number of MSI-X IRQs requested
 955  * @maxvec: maximum number of MSI-X IRQs requested
 956  *
 957  * Setup the MSI-X capability structure of device function with a maximum
 958  * possible number of interrupts in the range between @minvec and @maxvec
 959  * upon its software driver call to request for MSI-X mode enabled on its
 960  * hardware device function. It returns a negative errno if an error occurs.
 961  * If it succeeds, it returns the actual number of interrupts allocated and
 962  * indicates the successful configuration of MSI-X capability structure
 963  * with new allocated MSI-X interrupts.
 964  **/
 965 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
 966                 int minvec, int maxvec)
 967 {
 968         return __pci_enable_msix_range(dev, entries, minvec, maxvec, NULL, 0);
 969 }
 970 EXPORT_SYMBOL(pci_enable_msix_range);
 971
 972 /**
 973  * pci_alloc_irq_vectors_affinity - allocate multiple IRQs for a device
 974  * @dev:                PCI device to operate on
 975  * @min_vecs:           minimum number of vectors required (must be >= 1)
 976  * @max_vecs:           maximum (desired) number of vectors
 977  * @flags:              flags or quirks for the allocation
 978  * @affd:               optional description of the affinity requirements
 979  *
 980  * Allocate up to @max_vecs interrupt vectors for @dev, using MSI-X or MSI
 981  * vectors if available, and fall back to a single legacy vector
 982  * if neither is available.  Return the number of vectors allocated,
 983  * (which might be smaller than @max_vecs) if successful, or a negative
 984  * error code on error. If less than @min_vecs interrupt vectors are
 985  * available for @dev the function will fail with -ENOSPC.
 986  *
 987  * To get the Linux IRQ number used for a vector that can be passed to
 988  * request_irq() use the pci_irq_vector() helper.
 989  */
 990 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
 991                                    unsigned int max_vecs, unsigned int flags,
 992                                    struct irq_affinity *affd)
 993 {
 994         struct irq_affinity msi_default_affd = {0};
 995         int nvecs = -ENOSPC;
 996
 997         if (flags & PCI_IRQ_AFFINITY) {
 998                 if (!affd)
 999                         affd = &msi_default_affd;
1000         } else {
1001                 if (WARN_ON(affd))
1002                         affd = NULL;
1003         }
1004
1005         if (flags & PCI_IRQ_MSIX) {
1006                 nvecs = __pci_enable_msix_range(dev, NULL, min_vecs, max_vecs,
1007                                                 affd, flags);
1008                 if (nvecs > 0)
1009                         return nvecs;
1010         }
1011
1012         if (flags & PCI_IRQ_MSI) {
1013                 nvecs = __pci_enable_msi_range(dev, min_vecs, max_vecs, affd);
1014                 if (nvecs > 0)
1015                         return nvecs;
1016         }
1017
1018         /* use legacy IRQ if allowed */
1019         if (flags & PCI_IRQ_LEGACY) {
1020                 if (min_vecs == 1 && dev->irq) {
1021                         /*
1022                          * Invoke the affinity spreading logic to ensure that
1023                          * the device driver can adjust queue configuration
1024                          * for the single interrupt case.
1025                          */
1026                         if (affd)
1027                                 irq_create_affinity_masks(1, affd);
1028                         pci_intx(dev, 1);
1029                         return 1;
1030                 }
1031         }
1032
1033         return nvecs;
1034 }
1035 EXPORT_SYMBOL(pci_alloc_irq_vectors_affinity);
1036
1037 /**
1038  * pci_free_irq_vectors - free previously allocated IRQs for a device
1039  * @dev:                PCI device to operate on
1040  *
1041  * Undoes the allocations and enabling in pci_alloc_irq_vectors().
1042  */
1043 void pci_free_irq_vectors(struct pci_dev *dev)
1044 {
1045         pci_disable_msix(dev);
1046         pci_disable_msi(dev);
1047 }
1048 EXPORT_SYMBOL(pci_free_irq_vectors);
1049
1050 /**
1051  * pci_irq_vector - return Linux IRQ number of a device vector
1052  * @dev:        PCI device to operate on
1053  * @nr:         Interrupt vector index (0-based)
1054  *
1055  * @nr has the following meanings depending on the interrupt mode:
1056  *   MSI-X:     The index in the MSI-X vector table
1057  *   MSI:       The index of the enabled MSI vectors
1058  *   INTx:      Must be 0
1059  *
1060  * Return: The Linux interrupt number or -EINVAl if @nr is out of range.
1061  */
1062 int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1063 {
1064         if (dev->msix_enabled) {
1065                 struct msi_desc *entry;
1066
1067                 for_each_pci_msi_entry(entry, dev) {
1068                         if (entry->pci.msi_attrib.entry_nr == nr)
1069                                 return entry->irq;
1070                 }
1071                 WARN_ON_ONCE(1);
1072                 return -EINVAL;
1073         }
1074
1075         if (dev->msi_enabled) {
1076                 struct msi_desc *entry = first_pci_msi_entry(dev);
1077
1078                 if (WARN_ON_ONCE(nr >= entry->nvec_used))
1079                         return -EINVAL;
1080         } else {
1081                 if (WARN_ON_ONCE(nr > 0))
1082                         return -EINVAL;
1083         }
1084
1085         return dev->irq + nr;
1086 }
1087 EXPORT_SYMBOL(pci_irq_vector);
1088
1089 /**
1090  * pci_irq_get_affinity - return the affinity of a particular MSI vector
1091  * @dev:        PCI device to operate on
1092  * @nr:         device-relative interrupt vector index (0-based).
1093  *
1094  * @nr has the following meanings depending on the interrupt mode:
1095  *   MSI-X:     The index in the MSI-X vector table
1096  *   MSI:       The index of the enabled MSI vectors
1097  *   INTx:      Must be 0
1098  *
1099  * Return: A cpumask pointer or NULL if @nr is out of range
1100  */
1101 const struct cpumask *pci_irq_get_affinity(struct pci_dev *dev, int nr)
1102 {
1103         if (dev->msix_enabled) {
1104                 struct msi_desc *entry;
1105
1106                 for_each_pci_msi_entry(entry, dev) {
1107                         if (entry->pci.msi_attrib.entry_nr == nr)
1108                                 return &entry->affinity->mask;
1109                 }
1110                 WARN_ON_ONCE(1);
1111                 return NULL;
1112         } else if (dev->msi_enabled) {
1113                 struct msi_desc *entry = first_pci_msi_entry(dev);
1114
1115                 if (WARN_ON_ONCE(!entry || !entry->affinity ||
1116                                  nr >= entry->nvec_used))
1117                         return NULL;
1118
1119                 return &entry->affinity[nr].mask;
1120         } else {
1121                 return cpu_possible_mask;
1122         }
1123 }
1124 EXPORT_SYMBOL(pci_irq_get_affinity);
1125
1126 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc)
1127 {
1128         return to_pci_dev(desc->dev);
1129 }
1130 EXPORT_SYMBOL(msi_desc_to_pci_dev);
1131
1132 void pci_no_msi(void)
1133 {
1134         pci_msi_enable = 0;
1135 }
1136
1137 /**
1138  * pci_msi_enabled - is MSI enabled?
1139  *
1140  * Returns true if MSI has not been disabled by the command-line option
1141  * pci=nomsi.
1142  **/
1143 int pci_msi_enabled(void)
1144 {
1145         return pci_msi_enable;
1146 }
1147 EXPORT_SYMBOL(pci_msi_enabled);