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