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