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