drivers/pci/msi.c

   1 /*
   2  * File:        msi.c
   3  * Purpose:     PCI Message Signaled Interrupt (MSI)
   4  *
   5  * Copyright (C) 2003-2004 Intel
   6  * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
   7  */
   8
   9 #include <linux/err.h>
  10 #include <linux/mm.h>
  11 #include <linux/irq.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/export.h>
  14 #include <linux/ioport.h>
  15 #include <linux/pci.h>
  16 #include <linux/proc_fs.h>
  17 #include <linux/msi.h>
  18 #include <linux/smp.h>
  19 #include <linux/errno.h>
  20 #include <linux/io.h>
  21 #include <linux/slab.h>
  22
  23 #include "pci.h"
  24
  25 static int pci_msi_enable = 1;
  26 int pci_msi_ignore_mask;
  27
  28 #define msix_table_size(flags)  ((flags & PCI_MSIX_FLAGS_QSIZE) + 1)
  29
  30
  31 /* Arch hooks */
  32
  33 struct msi_controller * __weak pcibios_msi_controller(struct pci_dev *dev)
  34 {
  35         return NULL;
  36 }
  37
  38 static struct msi_controller *pci_msi_controller(struct pci_dev *dev)
  39 {
  40         struct msi_controller *msi_ctrl = dev->bus->msi;
  41
  42         if (msi_ctrl)
  43                 return msi_ctrl;
  44
  45         return pcibios_msi_controller(dev);
  46 }
  47
  48 int __weak arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc)
  49 {
  50         struct msi_controller *chip = pci_msi_controller(dev);
  51         int err;
  52
  53         if (!chip || !chip->setup_irq)
  54                 return -EINVAL;
  55
  56         err = chip->setup_irq(chip, dev, desc);
  57         if (err < 0)
  58                 return err;
  59
  60         irq_set_chip_data(desc->irq, chip);
  61
  62         return 0;
  63 }
  64
  65 void __weak arch_teardown_msi_irq(unsigned int irq)
  66 {
  67         struct msi_controller *chip = irq_get_chip_data(irq);
  68
  69         if (!chip || !chip->teardown_irq)
  70                 return;
  71
  72         chip->teardown_irq(chip, irq);
  73 }
  74
  75 int __weak arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
  76 {
  77         struct msi_desc *entry;
  78         int ret;
  79
  80         /*
  81          * If an architecture wants to support multiple MSI, it needs to
  82          * override arch_setup_msi_irqs()
  83          */
  84         if (type == PCI_CAP_ID_MSI && nvec > 1)
  85                 return 1;
  86
  87         list_for_each_entry(entry, &dev->msi_list, list) {
  88                 ret = arch_setup_msi_irq(dev, entry);
  89                 if (ret < 0)
  90                         return ret;
  91                 if (ret > 0)
  92                         return -ENOSPC;
  93         }
  94
  95         return 0;
  96 }
  97
  98 /*
  99  * We have a default implementation available as a separate non-weak
 100  * function, as it is used by the Xen x86 PCI code
 101  */
 102 void default_teardown_msi_irqs(struct pci_dev *dev)
 103 {
 104         int i;
 105         struct msi_desc *entry;
 106
 107         list_for_each_entry(entry, &dev->msi_list, list)
 108                 if (entry->irq)
 109                         for (i = 0; i < entry->nvec_used; i++)
 110                                 arch_teardown_msi_irq(entry->irq + i);
 111 }
 112
 113 void __weak arch_teardown_msi_irqs(struct pci_dev *dev)
 114 {
 115         return default_teardown_msi_irqs(dev);
 116 }
 117
 118 static void default_restore_msi_irq(struct pci_dev *dev, int irq)
 119 {
 120         struct msi_desc *entry;
 121
 122         entry = NULL;
 123         if (dev->msix_enabled) {
 124                 list_for_each_entry(entry, &dev->msi_list, list) {
 125                         if (irq == entry->irq)
 126                                 break;
 127                 }
 128         } else if (dev->msi_enabled)  {
 129                 entry = irq_get_msi_desc(irq);
 130         }
 131
 132         if (entry)
 133                 __pci_write_msi_msg(entry, &entry->msg);
 134 }
 135
 136 void __weak arch_restore_msi_irqs(struct pci_dev *dev)
 137 {
 138         return default_restore_msi_irqs(dev);
 139 }
 140
 141 static void msi_set_enable(struct pci_dev *dev, int enable)
 142 {
 143         u16 control;
 144
 145         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 146         control &= ~PCI_MSI_FLAGS_ENABLE;
 147         if (enable)
 148                 control |= PCI_MSI_FLAGS_ENABLE;
 149         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 150 }
 151
 152 static void msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
 153 {
 154         u16 ctrl;
 155
 156         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
 157         ctrl &= ~clear;
 158         ctrl |= set;
 159         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
 160 }
 161
 162 static inline __attribute_const__ u32 msi_mask(unsigned x)
 163 {
 164         /* Don't shift by >= width of type */
 165         if (x >= 5)
 166                 return 0xffffffff;
 167         return (1 << (1 << x)) - 1;
 168 }
 169
 170 /*
 171  * PCI 2.3 does not specify mask bits for each MSI interrupt.  Attempting to
 172  * mask all MSI interrupts by clearing the MSI enable bit does not work
 173  * reliably as devices without an INTx disable bit will then generate a
 174  * level IRQ which will never be cleared.
 175  */
 176 u32 __msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 177 {
 178         u32 mask_bits = desc->masked;
 179
 180         if (pci_msi_ignore_mask || !desc->msi_attrib.maskbit)
 181                 return 0;
 182
 183         mask_bits &= ~mask;
 184         mask_bits |= flag;
 185         pci_write_config_dword(desc->dev, desc->mask_pos, mask_bits);
 186
 187         return mask_bits;
 188 }
 189
 190 static void msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
 191 {
 192         desc->masked = __msi_mask_irq(desc, mask, flag);
 193 }
 194
 195 /*
 196  * This internal function does not flush PCI writes to the device.
 197  * All users must ensure that they read from the device before either
 198  * assuming that the device state is up to date, or returning out of this
 199  * file.  This saves a few milliseconds when initialising devices with lots
 200  * of MSI-X interrupts.
 201  */
 202 u32 __msix_mask_irq(struct msi_desc *desc, u32 flag)
 203 {
 204         u32 mask_bits = desc->masked;
 205         unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
 206                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 207
 208         if (pci_msi_ignore_mask)
 209                 return 0;
 210
 211         mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
 212         if (flag)
 213                 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
 214         writel(mask_bits, desc->mask_base + offset);
 215
 216         return mask_bits;
 217 }
 218
 219 static void msix_mask_irq(struct msi_desc *desc, u32 flag)
 220 {
 221         desc->masked = __msix_mask_irq(desc, flag);
 222 }
 223
 224 static void msi_set_mask_bit(struct irq_data *data, u32 flag)
 225 {
 226         struct msi_desc *desc = irq_data_get_msi(data);
 227
 228         if (desc->msi_attrib.is_msix) {
 229                 msix_mask_irq(desc, flag);
 230                 readl(desc->mask_base);         /* Flush write to device */
 231         } else {
 232                 unsigned offset = data->irq - desc->irq;
 233                 msi_mask_irq(desc, 1 << offset, flag << offset);
 234         }
 235 }
 236
 237 void mask_msi_irq(struct irq_data *data)
 238 {
 239         msi_set_mask_bit(data, 1);
 240 }
 241
 242 void unmask_msi_irq(struct irq_data *data)
 243 {
 244         msi_set_mask_bit(data, 0);
 245 }
 246
 247 void default_restore_msi_irqs(struct pci_dev *dev)
 248 {
 249         struct msi_desc *entry;
 250
 251         list_for_each_entry(entry, &dev->msi_list, list)
 252                 default_restore_msi_irq(dev, entry->irq);
 253 }
 254
 255 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 256 {
 257         BUG_ON(entry->dev->current_state != PCI_D0);
 258
 259         if (entry->msi_attrib.is_msix) {
 260                 void __iomem *base = entry->mask_base +
 261                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 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                 struct pci_dev *dev = entry->dev;
 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 __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 286 {
 287         /* Assert that the cache is valid, assuming that
 288          * valid messages are not all-zeroes. */
 289         BUG_ON(!(entry->msg.address_hi | entry->msg.address_lo |
 290                  entry->msg.data));
 291
 292         *msg = entry->msg;
 293 }
 294
 295 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
 296 {
 297         struct msi_desc *entry = irq_get_msi_desc(irq);
 298
 299         __get_cached_msi_msg(entry, msg);
 300 }
 301 EXPORT_SYMBOL_GPL(get_cached_msi_msg);
 302
 303 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
 304 {
 305         if (entry->dev->current_state != PCI_D0) {
 306                 /* Don't touch the hardware now */
 307         } else if (entry->msi_attrib.is_msix) {
 308                 void __iomem *base;
 309                 base = entry->mask_base +
 310                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
 311
 312                 writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
 313                 writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
 314                 writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
 315         } else {
 316                 struct pci_dev *dev = entry->dev;
 317                 int pos = dev->msi_cap;
 318                 u16 msgctl;
 319
 320                 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
 321                 msgctl &= ~PCI_MSI_FLAGS_QSIZE;
 322                 msgctl |= entry->msi_attrib.multiple << 4;
 323                 pci_write_config_word(dev, pos + PCI_MSI_FLAGS, msgctl);
 324
 325                 pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
 326                                        msg->address_lo);
 327                 if (entry->msi_attrib.is_64) {
 328                         pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
 329                                                msg->address_hi);
 330                         pci_write_config_word(dev, pos + PCI_MSI_DATA_64,
 331                                               msg->data);
 332                 } else {
 333                         pci_write_config_word(dev, pos + PCI_MSI_DATA_32,
 334                                               msg->data);
 335                 }
 336         }
 337         entry->msg = *msg;
 338 }
 339
 340 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
 341 {
 342         struct msi_desc *entry = irq_get_msi_desc(irq);
 343
 344         __pci_write_msi_msg(entry, msg);
 345 }
 346 EXPORT_SYMBOL_GPL(pci_write_msi_msg);
 347
 348 static void free_msi_irqs(struct pci_dev *dev)
 349 {
 350         struct msi_desc *entry, *tmp;
 351         struct attribute **msi_attrs;
 352         struct device_attribute *dev_attr;
 353         int i, count = 0;
 354
 355         list_for_each_entry(entry, &dev->msi_list, list)
 356                 if (entry->irq)
 357                         for (i = 0; i < entry->nvec_used; i++)
 358                                 BUG_ON(irq_has_action(entry->irq + i));
 359
 360         arch_teardown_msi_irqs(dev);
 361
 362         list_for_each_entry_safe(entry, tmp, &dev->msi_list, list) {
 363                 if (entry->msi_attrib.is_msix) {
 364                         if (list_is_last(&entry->list, &dev->msi_list))
 365                                 iounmap(entry->mask_base);
 366                 }
 367
 368                 list_del(&entry->list);
 369                 kfree(entry);
 370         }
 371
 372         if (dev->msi_irq_groups) {
 373                 sysfs_remove_groups(&dev->dev.kobj, dev->msi_irq_groups);
 374                 msi_attrs = dev->msi_irq_groups[0]->attrs;
 375                 while (msi_attrs[count]) {
 376                         dev_attr = container_of(msi_attrs[count],
 377                                                 struct device_attribute, attr);
 378                         kfree(dev_attr->attr.name);
 379                         kfree(dev_attr);
 380                         ++count;
 381                 }
 382                 kfree(msi_attrs);
 383                 kfree(dev->msi_irq_groups[0]);
 384                 kfree(dev->msi_irq_groups);
 385                 dev->msi_irq_groups = NULL;
 386         }
 387 }
 388
 389 static struct msi_desc *alloc_msi_entry(struct pci_dev *dev)
 390 {
 391         struct msi_desc *desc = kzalloc(sizeof(*desc), GFP_KERNEL);
 392         if (!desc)
 393                 return NULL;
 394
 395         INIT_LIST_HEAD(&desc->list);
 396         desc->dev = dev;
 397
 398         return desc;
 399 }
 400
 401 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
 402 {
 403         if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
 404                 pci_intx(dev, enable);
 405 }
 406
 407 static void __pci_restore_msi_state(struct pci_dev *dev)
 408 {
 409         u16 control;
 410         struct msi_desc *entry;
 411
 412         if (!dev->msi_enabled)
 413                 return;
 414
 415         entry = irq_get_msi_desc(dev->irq);
 416
 417         pci_intx_for_msi(dev, 0);
 418         msi_set_enable(dev, 0);
 419         arch_restore_msi_irqs(dev);
 420
 421         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 422         msi_mask_irq(entry, msi_mask(entry->msi_attrib.multi_cap),
 423                      entry->masked);
 424         control &= ~PCI_MSI_FLAGS_QSIZE;
 425         control |= (entry->msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
 426         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
 427 }
 428
 429 static void __pci_restore_msix_state(struct pci_dev *dev)
 430 {
 431         struct msi_desc *entry;
 432
 433         if (!dev->msix_enabled)
 434                 return;
 435         BUG_ON(list_empty(&dev->msi_list));
 436
 437         /* route the table */
 438         pci_intx_for_msi(dev, 0);
 439         msix_clear_and_set_ctrl(dev, 0,
 440                                 PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL);
 441
 442         arch_restore_msi_irqs(dev);
 443         list_for_each_entry(entry, &dev->msi_list, list)
 444                 msix_mask_irq(entry, entry->masked);
 445
 446         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 447 }
 448
 449 void pci_restore_msi_state(struct pci_dev *dev)
 450 {
 451         __pci_restore_msi_state(dev);
 452         __pci_restore_msix_state(dev);
 453 }
 454 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
 455
 456 static ssize_t msi_mode_show(struct device *dev, struct device_attribute *attr,
 457                              char *buf)
 458 {
 459         struct msi_desc *entry;
 460         unsigned long irq;
 461         int retval;
 462
 463         retval = kstrtoul(attr->attr.name, 10, &irq);
 464         if (retval)
 465                 return retval;
 466
 467         entry = irq_get_msi_desc(irq);
 468         if (entry)
 469                 return sprintf(buf, "%s\n",
 470                                 entry->msi_attrib.is_msix ? "msix" : "msi");
 471
 472         return -ENODEV;
 473 }
 474
 475 static int populate_msi_sysfs(struct pci_dev *pdev)
 476 {
 477         struct attribute **msi_attrs;
 478         struct attribute *msi_attr;
 479         struct device_attribute *msi_dev_attr;
 480         struct attribute_group *msi_irq_group;
 481         const struct attribute_group **msi_irq_groups;
 482         struct msi_desc *entry;
 483         int ret = -ENOMEM;
 484         int num_msi = 0;
 485         int count = 0;
 486
 487         /* Determine how many msi entries we have */
 488         list_for_each_entry(entry, &pdev->msi_list, list)
 489                 ++num_msi;
 490         if (!num_msi)
 491                 return 0;
 492
 493         /* Dynamically create the MSI attributes for the PCI device */
 494         msi_attrs = kzalloc(sizeof(void *) * (num_msi + 1), GFP_KERNEL);
 495         if (!msi_attrs)
 496                 return -ENOMEM;
 497         list_for_each_entry(entry, &pdev->msi_list, list) {
 498                 msi_dev_attr = kzalloc(sizeof(*msi_dev_attr), GFP_KERNEL);
 499                 if (!msi_dev_attr)
 500                         goto error_attrs;
 501                 msi_attrs[count] = &msi_dev_attr->attr;
 502
 503                 sysfs_attr_init(&msi_dev_attr->attr);
 504                 msi_dev_attr->attr.name = kasprintf(GFP_KERNEL, "%d",
 505                                                     entry->irq);
 506                 if (!msi_dev_attr->attr.name)
 507                         goto error_attrs;
 508                 msi_dev_attr->attr.mode = S_IRUGO;
 509                 msi_dev_attr->show = msi_mode_show;
 510                 ++count;
 511         }
 512
 513         msi_irq_group = kzalloc(sizeof(*msi_irq_group), GFP_KERNEL);
 514         if (!msi_irq_group)
 515                 goto error_attrs;
 516         msi_irq_group->name = "msi_irqs";
 517         msi_irq_group->attrs = msi_attrs;
 518
 519         msi_irq_groups = kzalloc(sizeof(void *) * 2, GFP_KERNEL);
 520         if (!msi_irq_groups)
 521                 goto error_irq_group;
 522         msi_irq_groups[0] = msi_irq_group;
 523
 524         ret = sysfs_create_groups(&pdev->dev.kobj, msi_irq_groups);
 525         if (ret)
 526                 goto error_irq_groups;
 527         pdev->msi_irq_groups = msi_irq_groups;
 528
 529         return 0;
 530
 531 error_irq_groups:
 532         kfree(msi_irq_groups);
 533 error_irq_group:
 534         kfree(msi_irq_group);
 535 error_attrs:
 536         count = 0;
 537         msi_attr = msi_attrs[count];
 538         while (msi_attr) {
 539                 msi_dev_attr = container_of(msi_attr, struct device_attribute, attr);
 540                 kfree(msi_attr->name);
 541                 kfree(msi_dev_attr);
 542                 ++count;
 543                 msi_attr = msi_attrs[count];
 544         }
 545         kfree(msi_attrs);
 546         return ret;
 547 }
 548
 549 static struct msi_desc *msi_setup_entry(struct pci_dev *dev, int nvec)
 550 {
 551         u16 control;
 552         struct msi_desc *entry;
 553
 554         /* MSI Entry Initialization */
 555         entry = alloc_msi_entry(dev);
 556         if (!entry)
 557                 return NULL;
 558
 559         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 560
 561         entry->msi_attrib.is_msix       = 0;
 562         entry->msi_attrib.is_64         = !!(control & PCI_MSI_FLAGS_64BIT);
 563         entry->msi_attrib.entry_nr      = 0;
 564         entry->msi_attrib.maskbit       = !!(control & PCI_MSI_FLAGS_MASKBIT);
 565         entry->msi_attrib.default_irq   = dev->irq;     /* Save IOAPIC IRQ */
 566         entry->msi_attrib.multi_cap     = (control & PCI_MSI_FLAGS_QMASK) >> 1;
 567         entry->msi_attrib.multiple      = ilog2(__roundup_pow_of_two(nvec));
 568         entry->nvec_used                = nvec;
 569
 570         if (control & PCI_MSI_FLAGS_64BIT)
 571                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
 572         else
 573                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
 574
 575         /* Save the initial mask status */
 576         if (entry->msi_attrib.maskbit)
 577                 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
 578
 579         return entry;
 580 }
 581
 582 /**
 583  * msi_capability_init - configure device's MSI capability structure
 584  * @dev: pointer to the pci_dev data structure of MSI device function
 585  * @nvec: number of interrupts to allocate
 586  *
 587  * Setup the MSI capability structure of the device with the requested
 588  * number of interrupts.  A return value of zero indicates the successful
 589  * setup of an entry with the new MSI irq.  A negative return value indicates
 590  * an error, and a positive return value indicates the number of interrupts
 591  * which could have been allocated.
 592  */
 593 static int msi_capability_init(struct pci_dev *dev, int nvec)
 594 {
 595         struct msi_desc *entry;
 596         int ret;
 597         unsigned mask;
 598
 599         msi_set_enable(dev, 0); /* Disable MSI during set up */
 600
 601         entry = msi_setup_entry(dev, nvec);
 602         if (!entry)
 603                 return -ENOMEM;
 604
 605         /* All MSIs are unmasked by default, Mask them all */
 606         mask = msi_mask(entry->msi_attrib.multi_cap);
 607         msi_mask_irq(entry, mask, mask);
 608
 609         list_add_tail(&entry->list, &dev->msi_list);
 610
 611         /* Configure MSI capability structure */
 612         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 613         if (ret) {
 614                 msi_mask_irq(entry, mask, ~mask);
 615                 free_msi_irqs(dev);
 616                 return ret;
 617         }
 618
 619         ret = populate_msi_sysfs(dev);
 620         if (ret) {
 621                 msi_mask_irq(entry, mask, ~mask);
 622                 free_msi_irqs(dev);
 623                 return ret;
 624         }
 625
 626         /* Set MSI enabled bits  */
 627         pci_intx_for_msi(dev, 0);
 628         msi_set_enable(dev, 1);
 629         dev->msi_enabled = 1;
 630
 631         dev->irq = entry->irq;
 632         return 0;
 633 }
 634
 635 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
 636 {
 637         resource_size_t phys_addr;
 638         u32 table_offset;
 639         u8 bir;
 640
 641         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 642                               &table_offset);
 643         bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
 644         table_offset &= PCI_MSIX_TABLE_OFFSET;
 645         phys_addr = pci_resource_start(dev, bir) + table_offset;
 646
 647         return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 648 }
 649
 650 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 651                               struct msix_entry *entries, int nvec)
 652 {
 653         struct msi_desc *entry;
 654         int i;
 655
 656         for (i = 0; i < nvec; i++) {
 657                 entry = alloc_msi_entry(dev);
 658                 if (!entry) {
 659                         if (!i)
 660                                 iounmap(base);
 661                         else
 662                                 free_msi_irqs(dev);
 663                         /* No enough memory. Don't try again */
 664                         return -ENOMEM;
 665                 }
 666
 667                 entry->msi_attrib.is_msix       = 1;
 668                 entry->msi_attrib.is_64         = 1;
 669                 entry->msi_attrib.entry_nr      = entries[i].entry;
 670                 entry->msi_attrib.default_irq   = dev->irq;
 671                 entry->mask_base                = base;
 672                 entry->nvec_used                = 1;
 673
 674                 list_add_tail(&entry->list, &dev->msi_list);
 675         }
 676
 677         return 0;
 678 }
 679
 680 static void msix_program_entries(struct pci_dev *dev,
 681                                  struct msix_entry *entries)
 682 {
 683         struct msi_desc *entry;
 684         int i = 0;
 685
 686         list_for_each_entry(entry, &dev->msi_list, list) {
 687                 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
 688                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 689
 690                 entries[i].vector = entry->irq;
 691                 entry->masked = readl(entry->mask_base + offset);
 692                 msix_mask_irq(entry, 1);
 693                 i++;
 694         }
 695 }
 696
 697 /**
 698  * msix_capability_init - configure device's MSI-X capability
 699  * @dev: pointer to the pci_dev data structure of MSI-X device function
 700  * @entries: pointer to an array of struct msix_entry entries
 701  * @nvec: number of @entries
 702  *
 703  * Setup the MSI-X capability structure of device function with a
 704  * single MSI-X irq. A return of zero indicates the successful setup of
 705  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
 706  **/
 707 static int msix_capability_init(struct pci_dev *dev,
 708                                 struct msix_entry *entries, int nvec)
 709 {
 710         int ret;
 711         u16 control;
 712         void __iomem *base;
 713
 714         /* Ensure MSI-X is disabled while it is set up */
 715         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 716
 717         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 718         /* Request & Map MSI-X table region */
 719         base = msix_map_region(dev, msix_table_size(control));
 720         if (!base)
 721                 return -ENOMEM;
 722
 723         ret = msix_setup_entries(dev, base, entries, nvec);
 724         if (ret)
 725                 return ret;
 726
 727         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 728         if (ret)
 729                 goto out_avail;
 730
 731         /*
 732          * Some devices require MSI-X to be enabled before we can touch the
 733          * MSI-X registers.  We need to mask all the vectors to prevent
 734          * interrupts coming in before they're fully set up.
 735          */
 736         msix_clear_and_set_ctrl(dev, 0,
 737                                 PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE);
 738
 739         msix_program_entries(dev, entries);
 740
 741         ret = populate_msi_sysfs(dev);
 742         if (ret)
 743                 goto out_free;
 744
 745         /* Set MSI-X enabled bits and unmask the function */
 746         pci_intx_for_msi(dev, 0);
 747         dev->msix_enabled = 1;
 748
 749         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 750
 751         return 0;
 752
 753 out_avail:
 754         if (ret < 0) {
 755                 /*
 756                  * If we had some success, report the number of irqs
 757                  * we succeeded in setting up.
 758                  */
 759                 struct msi_desc *entry;
 760                 int avail = 0;
 761
 762                 list_for_each_entry(entry, &dev->msi_list, list) {
 763                         if (entry->irq != 0)
 764                                 avail++;
 765                 }
 766                 if (avail != 0)
 767                         ret = avail;
 768         }
 769
 770 out_free:
 771         free_msi_irqs(dev);
 772
 773         return ret;
 774 }
 775
 776 /**
 777  * pci_msi_supported - check whether MSI may be enabled on a device
 778  * @dev: pointer to the pci_dev data structure of MSI device function
 779  * @nvec: how many MSIs have been requested ?
 780  *
 781  * Look at global flags, the device itself, and its parent buses
 782  * to determine if MSI/-X are supported for the device. If MSI/-X is
 783  * supported return 1, else return 0.
 784  **/
 785 static int pci_msi_supported(struct pci_dev *dev, int nvec)
 786 {
 787         struct pci_bus *bus;
 788
 789         /* MSI must be globally enabled and supported by the device */
 790         if (!pci_msi_enable)
 791                 return 0;
 792
 793         if (!dev || dev->no_msi || dev->current_state != PCI_D0)
 794                 return 0;
 795
 796         /*
 797          * You can't ask to have 0 or less MSIs configured.
 798          *  a) it's stupid ..
 799          *  b) the list manipulation code assumes nvec >= 1.
 800          */
 801         if (nvec < 1)
 802                 return 0;
 803
 804         /*
 805          * Any bridge which does NOT route MSI transactions from its
 806          * secondary bus to its primary bus must set NO_MSI flag on
 807          * the secondary pci_bus.
 808          * We expect only arch-specific PCI host bus controller driver
 809          * or quirks for specific PCI bridges to be setting NO_MSI.
 810          */
 811         for (bus = dev->bus; bus; bus = bus->parent)
 812                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 813                         return 0;
 814
 815         return 1;
 816 }
 817
 818 /**
 819  * pci_msi_vec_count - Return the number of MSI vectors a device can send
 820  * @dev: device to report about
 821  *
 822  * This function returns the number of MSI vectors a device requested via
 823  * Multiple Message Capable register. It returns a negative errno if the
 824  * device is not capable sending MSI interrupts. Otherwise, the call succeeds
 825  * and returns a power of two, up to a maximum of 2^5 (32), according to the
 826  * MSI specification.
 827  **/
 828 int pci_msi_vec_count(struct pci_dev *dev)
 829 {
 830         int ret;
 831         u16 msgctl;
 832
 833         if (!dev->msi_cap)
 834                 return -EINVAL;
 835
 836         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 837         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 838
 839         return ret;
 840 }
 841 EXPORT_SYMBOL(pci_msi_vec_count);
 842
 843 void pci_msi_shutdown(struct pci_dev *dev)
 844 {
 845         struct msi_desc *desc;
 846         u32 mask;
 847
 848         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 849                 return;
 850
 851         BUG_ON(list_empty(&dev->msi_list));
 852         desc = list_first_entry(&dev->msi_list, struct msi_desc, list);
 853
 854         msi_set_enable(dev, 0);
 855         pci_intx_for_msi(dev, 1);
 856         dev->msi_enabled = 0;
 857
 858         /* Return the device with MSI unmasked as initial states */
 859         mask = msi_mask(desc->msi_attrib.multi_cap);
 860         /* Keep cached state to be restored */
 861         __msi_mask_irq(desc, mask, ~mask);
 862
 863         /* Restore dev->irq to its default pin-assertion irq */
 864         dev->irq = desc->msi_attrib.default_irq;
 865 }
 866
 867 void pci_disable_msi(struct pci_dev *dev)
 868 {
 869         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 870                 return;
 871
 872         pci_msi_shutdown(dev);
 873         free_msi_irqs(dev);
 874 }
 875 EXPORT_SYMBOL(pci_disable_msi);
 876
 877 /**
 878  * pci_msix_vec_count - return the number of device's MSI-X table entries
 879  * @dev: pointer to the pci_dev data structure of MSI-X device function
 880  * This function returns the number of device's MSI-X table entries and
 881  * therefore the number of MSI-X vectors device is capable of sending.
 882  * It returns a negative errno if the device is not capable of sending MSI-X
 883  * interrupts.
 884  **/
 885 int pci_msix_vec_count(struct pci_dev *dev)
 886 {
 887         u16 control;
 888
 889         if (!dev->msix_cap)
 890                 return -EINVAL;
 891
 892         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 893         return msix_table_size(control);
 894 }
 895 EXPORT_SYMBOL(pci_msix_vec_count);
 896
 897 /**
 898  * pci_enable_msix - configure device's MSI-X capability structure
 899  * @dev: pointer to the pci_dev data structure of MSI-X device function
 900  * @entries: pointer to an array of MSI-X entries
 901  * @nvec: number of MSI-X irqs requested for allocation by device driver
 902  *
 903  * Setup the MSI-X capability structure of device function with the number
 904  * of requested irqs upon its software driver call to request for
 905  * MSI-X mode enabled on its hardware device function. A return of zero
 906  * indicates the successful configuration of MSI-X capability structure
 907  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
 908  * Or a return of > 0 indicates that driver request is exceeding the number
 909  * of irqs or MSI-X vectors available. Driver should use the returned value to
 910  * re-send its request.
 911  **/
 912 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
 913 {
 914         int nr_entries;
 915         int i, j;
 916
 917         if (!pci_msi_supported(dev, nvec))
 918                 return -EINVAL;
 919
 920         if (!entries)
 921                 return -EINVAL;
 922
 923         nr_entries = pci_msix_vec_count(dev);
 924         if (nr_entries < 0)
 925                 return nr_entries;
 926         if (nvec > nr_entries)
 927                 return nr_entries;
 928
 929         /* Check for any invalid entries */
 930         for (i = 0; i < nvec; i++) {
 931                 if (entries[i].entry >= nr_entries)
 932                         return -EINVAL;         /* invalid entry */
 933                 for (j = i + 1; j < nvec; j++) {
 934                         if (entries[i].entry == entries[j].entry)
 935                                 return -EINVAL; /* duplicate entry */
 936                 }
 937         }
 938         WARN_ON(!!dev->msix_enabled);
 939
 940         /* Check whether driver already requested for MSI irq */
 941         if (dev->msi_enabled) {
 942                 dev_info(&dev->dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
 943                 return -EINVAL;
 944         }
 945         return msix_capability_init(dev, entries, nvec);
 946 }
 947 EXPORT_SYMBOL(pci_enable_msix);
 948
 949 void pci_msix_shutdown(struct pci_dev *dev)
 950 {
 951         struct msi_desc *entry;
 952
 953         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 954                 return;
 955
 956         /* Return the device with MSI-X masked as initial states */
 957         list_for_each_entry(entry, &dev->msi_list, list) {
 958                 /* Keep cached states to be restored */
 959                 __msix_mask_irq(entry, 1);
 960         }
 961
 962         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 963         pci_intx_for_msi(dev, 1);
 964         dev->msix_enabled = 0;
 965 }
 966
 967 void pci_disable_msix(struct pci_dev *dev)
 968 {
 969         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 970                 return;
 971
 972         pci_msix_shutdown(dev);
 973         free_msi_irqs(dev);
 974 }
 975 EXPORT_SYMBOL(pci_disable_msix);
 976
 977 void pci_no_msi(void)
 978 {
 979         pci_msi_enable = 0;
 980 }
 981
 982 /**
 983  * pci_msi_enabled - is MSI enabled?
 984  *
 985  * Returns true if MSI has not been disabled by the command-line option
 986  * pci=nomsi.
 987  **/
 988 int pci_msi_enabled(void)
 989 {
 990         return pci_msi_enable;
 991 }
 992 EXPORT_SYMBOL(pci_msi_enabled);
 993
 994 void pci_msi_init_pci_dev(struct pci_dev *dev)
 995 {
 996         INIT_LIST_HEAD(&dev->msi_list);
 997
 998         /* Disable the msi hardware to avoid screaming interrupts
 999          * during boot.  This is the power on reset default so
1000          * usually this should be a noop.
1001          */
1002         dev->msi_cap = pci_find_capability(dev, PCI_CAP_ID_MSI);
1003         if (dev->msi_cap)
1004                 msi_set_enable(dev, 0);
1005
1006         dev->msix_cap = pci_find_capability(dev, PCI_CAP_ID_MSIX);
1007         if (dev->msix_cap)
1008                 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
1009 }
1010
1011 /**
1012  * pci_enable_msi_range - configure device's MSI capability structure
1013  * @dev: device to configure
1014  * @minvec: minimal number of interrupts to configure
1015  * @maxvec: maximum number of interrupts to configure
1016  *
1017  * This function tries to allocate a maximum possible number of interrupts in a
1018  * range between @minvec and @maxvec. It returns a negative errno if an error
1019  * occurs. If it succeeds, it returns the actual number of interrupts allocated
1020  * and updates the @dev's irq member to the lowest new interrupt number;
1021  * the other interrupt numbers allocated to this device are consecutive.
1022  **/
1023 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec)
1024 {
1025         int nvec;
1026         int rc;
1027
1028         if (!pci_msi_supported(dev, minvec))
1029                 return -EINVAL;
1030
1031         WARN_ON(!!dev->msi_enabled);
1032
1033         /* Check whether driver already requested MSI-X irqs */
1034         if (dev->msix_enabled) {
1035                 dev_info(&dev->dev,
1036                          "can't enable MSI (MSI-X already enabled)\n");
1037                 return -EINVAL;
1038         }
1039
1040         if (maxvec < minvec)
1041                 return -ERANGE;
1042
1043         nvec = pci_msi_vec_count(dev);
1044         if (nvec < 0)
1045                 return nvec;
1046         else if (nvec < minvec)
1047                 return -EINVAL;
1048         else if (nvec > maxvec)
1049                 nvec = maxvec;
1050
1051         do {
1052                 rc = msi_capability_init(dev, nvec);
1053                 if (rc < 0) {
1054                         return rc;
1055                 } else if (rc > 0) {
1056                         if (rc < minvec)
1057                                 return -ENOSPC;
1058                         nvec = rc;
1059                 }
1060         } while (rc);
1061
1062         return nvec;
1063 }
1064 EXPORT_SYMBOL(pci_enable_msi_range);
1065
1066 /**
1067  * pci_enable_msix_range - configure device's MSI-X capability structure
1068  * @dev: pointer to the pci_dev data structure of MSI-X device function
1069  * @entries: pointer to an array of MSI-X entries
1070  * @minvec: minimum number of MSI-X irqs requested
1071  * @maxvec: maximum number of MSI-X irqs requested
1072  *
1073  * Setup the MSI-X capability structure of device function with a maximum
1074  * possible number of interrupts in the range between @minvec and @maxvec
1075  * upon its software driver call to request for MSI-X mode enabled on its
1076  * hardware device function. It returns a negative errno if an error occurs.
1077  * If it succeeds, it returns the actual number of interrupts allocated and
1078  * indicates the successful configuration of MSI-X capability structure
1079  * with new allocated MSI-X interrupts.
1080  **/
1081 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1082                                int minvec, int maxvec)
1083 {
1084         int nvec = maxvec;
1085         int rc;
1086
1087         if (maxvec < minvec)
1088                 return -ERANGE;
1089
1090         do {
1091                 rc = pci_enable_msix(dev, entries, nvec);
1092                 if (rc < 0) {
1093                         return rc;
1094                 } else if (rc > 0) {
1095                         if (rc < minvec)
1096                                 return -ENOSPC;
1097                         nvec = rc;
1098                 }
1099         } while (rc);
1100
1101         return nvec;
1102 }
1103 EXPORT_SYMBOL(pci_enable_msix_range);