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->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
 467         /* route the table */
 468         pci_intx_for_msi(dev, 0);
 469         msix_clear_and_set_ctrl(dev, 0,
 470                                 PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL);
 471
 472         arch_restore_msi_irqs(dev);
 473         list_for_each_entry(entry, &dev->msi_list, list) {
 474                 msix_mask_irq(entry, entry->masked);
 475         }
 476
 477         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 478 }
 479
 480 void pci_restore_msi_state(struct pci_dev *dev)
 481 {
 482         __pci_restore_msi_state(dev);
 483         __pci_restore_msix_state(dev);
 484 }
 485 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
 486
 487 static ssize_t msi_mode_show(struct device *dev, struct device_attribute *attr,
 488                              char *buf)
 489 {
 490         struct msi_desc *entry;
 491         unsigned long irq;
 492         int retval;
 493
 494         retval = kstrtoul(attr->attr.name, 10, &irq);
 495         if (retval)
 496                 return retval;
 497
 498         entry = irq_get_msi_desc(irq);
 499         if (entry)
 500                 return sprintf(buf, "%s\n",
 501                                 entry->msi_attrib.is_msix ? "msix" : "msi");
 502
 503         return -ENODEV;
 504 }
 505
 506 static int populate_msi_sysfs(struct pci_dev *pdev)
 507 {
 508         struct attribute **msi_attrs;
 509         struct attribute *msi_attr;
 510         struct device_attribute *msi_dev_attr;
 511         struct attribute_group *msi_irq_group;
 512         const struct attribute_group **msi_irq_groups;
 513         struct msi_desc *entry;
 514         int ret = -ENOMEM;
 515         int num_msi = 0;
 516         int count = 0;
 517
 518         /* Determine how many msi entries we have */
 519         list_for_each_entry(entry, &pdev->msi_list, list) {
 520                 ++num_msi;
 521         }
 522         if (!num_msi)
 523                 return 0;
 524
 525         /* Dynamically create the MSI attributes for the PCI device */
 526         msi_attrs = kzalloc(sizeof(void *) * (num_msi + 1), GFP_KERNEL);
 527         if (!msi_attrs)
 528                 return -ENOMEM;
 529         list_for_each_entry(entry, &pdev->msi_list, list) {
 530                 msi_dev_attr = kzalloc(sizeof(*msi_dev_attr), GFP_KERNEL);
 531                 if (!msi_dev_attr)
 532                         goto error_attrs;
 533                 msi_attrs[count] = &msi_dev_attr->attr;
 534
 535                 sysfs_attr_init(&msi_dev_attr->attr);
 536                 msi_dev_attr->attr.name = kasprintf(GFP_KERNEL, "%d",
 537                                                     entry->irq);
 538                 if (!msi_dev_attr->attr.name)
 539                         goto error_attrs;
 540                 msi_dev_attr->attr.mode = S_IRUGO;
 541                 msi_dev_attr->show = msi_mode_show;
 542                 ++count;
 543         }
 544
 545         msi_irq_group = kzalloc(sizeof(*msi_irq_group), GFP_KERNEL);
 546         if (!msi_irq_group)
 547                 goto error_attrs;
 548         msi_irq_group->name = "msi_irqs";
 549         msi_irq_group->attrs = msi_attrs;
 550
 551         msi_irq_groups = kzalloc(sizeof(void *) * 2, GFP_KERNEL);
 552         if (!msi_irq_groups)
 553                 goto error_irq_group;
 554         msi_irq_groups[0] = msi_irq_group;
 555
 556         ret = sysfs_create_groups(&pdev->dev.kobj, msi_irq_groups);
 557         if (ret)
 558                 goto error_irq_groups;
 559         pdev->msi_irq_groups = msi_irq_groups;
 560
 561         return 0;
 562
 563 error_irq_groups:
 564         kfree(msi_irq_groups);
 565 error_irq_group:
 566         kfree(msi_irq_group);
 567 error_attrs:
 568         count = 0;
 569         msi_attr = msi_attrs[count];
 570         while (msi_attr) {
 571                 msi_dev_attr = container_of(msi_attr, struct device_attribute, attr);
 572                 kfree(msi_attr->name);
 573                 kfree(msi_dev_attr);
 574                 ++count;
 575                 msi_attr = msi_attrs[count];
 576         }
 577         kfree(msi_attrs);
 578         return ret;
 579 }
 580
 581 static struct msi_desc *msi_setup_entry(struct pci_dev *dev)
 582 {
 583         u16 control;
 584         struct msi_desc *entry;
 585
 586         /* MSI Entry Initialization */
 587         entry = alloc_msi_entry(dev);
 588         if (!entry)
 589                 return NULL;
 590
 591         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
 592
 593         entry->msi_attrib.is_msix       = 0;
 594         entry->msi_attrib.is_64         = !!(control & PCI_MSI_FLAGS_64BIT);
 595         entry->msi_attrib.entry_nr      = 0;
 596         entry->msi_attrib.maskbit       = !!(control & PCI_MSI_FLAGS_MASKBIT);
 597         entry->msi_attrib.default_irq   = dev->irq;     /* Save IOAPIC IRQ */
 598         entry->msi_attrib.pos           = dev->msi_cap;
 599         entry->msi_attrib.multi_cap     = (control & PCI_MSI_FLAGS_QMASK) >> 1;
 600
 601         if (control & PCI_MSI_FLAGS_64BIT)
 602                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
 603         else
 604                 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
 605
 606         /* Save the initial mask status */
 607         if (entry->msi_attrib.maskbit)
 608                 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
 609
 610         return entry;
 611 }
 612
 613 /**
 614  * msi_capability_init - configure device's MSI capability structure
 615  * @dev: pointer to the pci_dev data structure of MSI device function
 616  * @nvec: number of interrupts to allocate
 617  *
 618  * Setup the MSI capability structure of the device with the requested
 619  * number of interrupts.  A return value of zero indicates the successful
 620  * setup of an entry with the new MSI irq.  A negative return value indicates
 621  * an error, and a positive return value indicates the number of interrupts
 622  * which could have been allocated.
 623  */
 624 static int msi_capability_init(struct pci_dev *dev, int nvec)
 625 {
 626         struct msi_desc *entry;
 627         int ret;
 628         unsigned mask;
 629
 630         msi_set_enable(dev, 0); /* Disable MSI during set up */
 631
 632         entry = msi_setup_entry(dev);
 633         if (!entry)
 634                 return -ENOMEM;
 635
 636         /* All MSIs are unmasked by default, Mask them all */
 637         mask = msi_mask(entry->msi_attrib.multi_cap);
 638         msi_mask_irq(entry, mask, mask);
 639
 640         list_add_tail(&entry->list, &dev->msi_list);
 641
 642         /* Configure MSI capability structure */
 643         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
 644         if (ret) {
 645                 msi_mask_irq(entry, mask, ~mask);
 646                 free_msi_irqs(dev);
 647                 return ret;
 648         }
 649
 650         ret = populate_msi_sysfs(dev);
 651         if (ret) {
 652                 msi_mask_irq(entry, mask, ~mask);
 653                 free_msi_irqs(dev);
 654                 return ret;
 655         }
 656
 657         /* Set MSI enabled bits  */
 658         pci_intx_for_msi(dev, 0);
 659         msi_set_enable(dev, 1);
 660         dev->msi_enabled = 1;
 661
 662         dev->irq = entry->irq;
 663         return 0;
 664 }
 665
 666 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
 667 {
 668         resource_size_t phys_addr;
 669         u32 table_offset;
 670         u8 bir;
 671
 672         pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
 673                               &table_offset);
 674         bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
 675         table_offset &= PCI_MSIX_TABLE_OFFSET;
 676         phys_addr = pci_resource_start(dev, bir) + table_offset;
 677
 678         return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
 679 }
 680
 681 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
 682                               struct msix_entry *entries, int nvec)
 683 {
 684         struct msi_desc *entry;
 685         int i;
 686
 687         for (i = 0; i < nvec; i++) {
 688                 entry = alloc_msi_entry(dev);
 689                 if (!entry) {
 690                         if (!i)
 691                                 iounmap(base);
 692                         else
 693                                 free_msi_irqs(dev);
 694                         /* No enough memory. Don't try again */
 695                         return -ENOMEM;
 696                 }
 697
 698                 entry->msi_attrib.is_msix       = 1;
 699                 entry->msi_attrib.is_64         = 1;
 700                 entry->msi_attrib.entry_nr      = entries[i].entry;
 701                 entry->msi_attrib.default_irq   = dev->irq;
 702                 entry->msi_attrib.pos           = dev->msix_cap;
 703                 entry->mask_base                = base;
 704
 705                 list_add_tail(&entry->list, &dev->msi_list);
 706         }
 707
 708         return 0;
 709 }
 710
 711 static void msix_program_entries(struct pci_dev *dev,
 712                                  struct msix_entry *entries)
 713 {
 714         struct msi_desc *entry;
 715         int i = 0;
 716
 717         list_for_each_entry(entry, &dev->msi_list, list) {
 718                 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
 719                                                 PCI_MSIX_ENTRY_VECTOR_CTRL;
 720
 721                 entries[i].vector = entry->irq;
 722                 irq_set_msi_desc(entry->irq, entry);
 723                 entry->masked = readl(entry->mask_base + offset);
 724                 msix_mask_irq(entry, 1);
 725                 i++;
 726         }
 727 }
 728
 729 /**
 730  * msix_capability_init - configure device's MSI-X capability
 731  * @dev: pointer to the pci_dev data structure of MSI-X device function
 732  * @entries: pointer to an array of struct msix_entry entries
 733  * @nvec: number of @entries
 734  *
 735  * Setup the MSI-X capability structure of device function with a
 736  * single MSI-X irq. A return of zero indicates the successful setup of
 737  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
 738  **/
 739 static int msix_capability_init(struct pci_dev *dev,
 740                                 struct msix_entry *entries, int nvec)
 741 {
 742         int ret;
 743         u16 control;
 744         void __iomem *base;
 745
 746         /* Ensure MSI-X is disabled while it is set up */
 747         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
 748
 749         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 750         /* Request & Map MSI-X table region */
 751         base = msix_map_region(dev, msix_table_size(control));
 752         if (!base)
 753                 return -ENOMEM;
 754
 755         ret = msix_setup_entries(dev, base, entries, nvec);
 756         if (ret)
 757                 return ret;
 758
 759         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
 760         if (ret)
 761                 goto out_avail;
 762
 763         /*
 764          * Some devices require MSI-X to be enabled before we can touch the
 765          * MSI-X registers.  We need to mask all the vectors to prevent
 766          * interrupts coming in before they're fully set up.
 767          */
 768         msix_clear_and_set_ctrl(dev, 0,
 769                                 PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE);
 770
 771         msix_program_entries(dev, entries);
 772
 773         ret = populate_msi_sysfs(dev);
 774         if (ret)
 775                 goto out_free;
 776
 777         /* Set MSI-X enabled bits and unmask the function */
 778         pci_intx_for_msi(dev, 0);
 779         dev->msix_enabled = 1;
 780
 781         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
 782
 783         return 0;
 784
 785 out_avail:
 786         if (ret < 0) {
 787                 /*
 788                  * If we had some success, report the number of irqs
 789                  * we succeeded in setting up.
 790                  */
 791                 struct msi_desc *entry;
 792                 int avail = 0;
 793
 794                 list_for_each_entry(entry, &dev->msi_list, list) {
 795                         if (entry->irq != 0)
 796                                 avail++;
 797                 }
 798                 if (avail != 0)
 799                         ret = avail;
 800         }
 801
 802 out_free:
 803         free_msi_irqs(dev);
 804
 805         return ret;
 806 }
 807
 808 /**
 809  * pci_msi_check_device - check whether MSI may be enabled on a device
 810  * @dev: pointer to the pci_dev data structure of MSI device function
 811  * @nvec: how many MSIs have been requested ?
 812  * @type: are we checking for MSI or MSI-X ?
 813  *
 814  * Look at global flags, the device itself, and its parent buses
 815  * to determine if MSI/-X are supported for the device. If MSI/-X is
 816  * supported return 0, else return an error code.
 817  **/
 818 static int pci_msi_check_device(struct pci_dev *dev, int nvec, int type)
 819 {
 820         struct pci_bus *bus;
 821         int ret;
 822
 823         /* MSI must be globally enabled and supported by the device */
 824         if (!pci_msi_enable || !dev || dev->no_msi)
 825                 return -EINVAL;
 826
 827         /*
 828          * You can't ask to have 0 or less MSIs configured.
 829          *  a) it's stupid ..
 830          *  b) the list manipulation code assumes nvec >= 1.
 831          */
 832         if (nvec < 1)
 833                 return -ERANGE;
 834
 835         /*
 836          * Any bridge which does NOT route MSI transactions from its
 837          * secondary bus to its primary bus must set NO_MSI flag on
 838          * the secondary pci_bus.
 839          * We expect only arch-specific PCI host bus controller driver
 840          * or quirks for specific PCI bridges to be setting NO_MSI.
 841          */
 842         for (bus = dev->bus; bus; bus = bus->parent)
 843                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
 844                         return -EINVAL;
 845
 846         ret = arch_msi_check_device(dev, nvec, type);
 847         if (ret)
 848                 return ret;
 849
 850         return 0;
 851 }
 852
 853 /**
 854  * pci_msi_vec_count - Return the number of MSI vectors a device can send
 855  * @dev: device to report about
 856  *
 857  * This function returns the number of MSI vectors a device requested via
 858  * Multiple Message Capable register. It returns a negative errno if the
 859  * device is not capable sending MSI interrupts. Otherwise, the call succeeds
 860  * and returns a power of two, up to a maximum of 2^5 (32), according to the
 861  * MSI specification.
 862  **/
 863 int pci_msi_vec_count(struct pci_dev *dev)
 864 {
 865         int ret;
 866         u16 msgctl;
 867
 868         if (!dev->msi_cap)
 869                 return -EINVAL;
 870
 871         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
 872         ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
 873
 874         return ret;
 875 }
 876 EXPORT_SYMBOL(pci_msi_vec_count);
 877
 878 void pci_msi_shutdown(struct pci_dev *dev)
 879 {
 880         struct msi_desc *desc;
 881         u32 mask;
 882
 883         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 884                 return;
 885
 886         BUG_ON(list_empty(&dev->msi_list));
 887         desc = list_first_entry(&dev->msi_list, struct msi_desc, list);
 888
 889         msi_set_enable(dev, 0);
 890         pci_intx_for_msi(dev, 1);
 891         dev->msi_enabled = 0;
 892
 893         /* Return the device with MSI unmasked as initial states */
 894         mask = msi_mask(desc->msi_attrib.multi_cap);
 895         /* Keep cached state to be restored */
 896         arch_msi_mask_irq(desc, mask, ~mask);
 897
 898         /* Restore dev->irq to its default pin-assertion irq */
 899         dev->irq = desc->msi_attrib.default_irq;
 900 }
 901
 902 void pci_disable_msi(struct pci_dev *dev)
 903 {
 904         if (!pci_msi_enable || !dev || !dev->msi_enabled)
 905                 return;
 906
 907         pci_msi_shutdown(dev);
 908         free_msi_irqs(dev);
 909 }
 910 EXPORT_SYMBOL(pci_disable_msi);
 911
 912 /**
 913  * pci_msix_vec_count - return the number of device's MSI-X table entries
 914  * @dev: pointer to the pci_dev data structure of MSI-X device function
 915  * This function returns the number of device's MSI-X table entries and
 916  * therefore the number of MSI-X vectors device is capable of sending.
 917  * It returns a negative errno if the device is not capable of sending MSI-X
 918  * interrupts.
 919  **/
 920 int pci_msix_vec_count(struct pci_dev *dev)
 921 {
 922         u16 control;
 923
 924         if (!dev->msix_cap)
 925                 return -EINVAL;
 926
 927         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
 928         return msix_table_size(control);
 929 }
 930 EXPORT_SYMBOL(pci_msix_vec_count);
 931
 932 /**
 933  * pci_enable_msix - configure device's MSI-X capability structure
 934  * @dev: pointer to the pci_dev data structure of MSI-X device function
 935  * @entries: pointer to an array of MSI-X entries
 936  * @nvec: number of MSI-X irqs requested for allocation by device driver
 937  *
 938  * Setup the MSI-X capability structure of device function with the number
 939  * of requested irqs upon its software driver call to request for
 940  * MSI-X mode enabled on its hardware device function. A return of zero
 941  * indicates the successful configuration of MSI-X capability structure
 942  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
 943  * Or a return of > 0 indicates that driver request is exceeding the number
 944  * of irqs or MSI-X vectors available. Driver should use the returned value to
 945  * re-send its request.
 946  **/
 947 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
 948 {
 949         int status, nr_entries;
 950         int i, j;
 951
 952         if (!entries || !dev->msix_cap || dev->current_state != PCI_D0)
 953                 return -EINVAL;
 954
 955         status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSIX);
 956         if (status)
 957                 return status;
 958
 959         nr_entries = pci_msix_vec_count(dev);
 960         if (nr_entries < 0)
 961                 return nr_entries;
 962         if (nvec > nr_entries)
 963                 return nr_entries;
 964
 965         /* Check for any invalid entries */
 966         for (i = 0; i < nvec; i++) {
 967                 if (entries[i].entry >= nr_entries)
 968                         return -EINVAL;         /* invalid entry */
 969                 for (j = i + 1; j < nvec; j++) {
 970                         if (entries[i].entry == entries[j].entry)
 971                                 return -EINVAL; /* duplicate entry */
 972                 }
 973         }
 974         WARN_ON(!!dev->msix_enabled);
 975
 976         /* Check whether driver already requested for MSI irq */
 977         if (dev->msi_enabled) {
 978                 dev_info(&dev->dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
 979                 return -EINVAL;
 980         }
 981         status = msix_capability_init(dev, entries, nvec);
 982         return status;
 983 }
 984 EXPORT_SYMBOL(pci_enable_msix);
 985
 986 void pci_msix_shutdown(struct pci_dev *dev)
 987 {
 988         struct msi_desc *entry;
 989
 990         if (!pci_msi_enable || !dev || !dev->msix_enabled)
 991                 return;
 992
 993         /* Return the device with MSI-X masked as initial states */
 994         list_for_each_entry(entry, &dev->msi_list, list) {
 995                 /* Keep cached states to be restored */
 996                 arch_msix_mask_irq(entry, 1);
 997         }
 998
 999         msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
1000         pci_intx_for_msi(dev, 1);
1001         dev->msix_enabled = 0;
1002 }
1003
1004 void pci_disable_msix(struct pci_dev *dev)
1005 {
1006         if (!pci_msi_enable || !dev || !dev->msix_enabled)
1007                 return;
1008
1009         pci_msix_shutdown(dev);
1010         free_msi_irqs(dev);
1011 }
1012 EXPORT_SYMBOL(pci_disable_msix);
1013
1014 void pci_no_msi(void)
1015 {
1016         pci_msi_enable = 0;
1017 }
1018
1019 /**
1020  * pci_msi_enabled - is MSI enabled?
1021  *
1022  * Returns true if MSI has not been disabled by the command-line option
1023  * pci=nomsi.
1024  **/
1025 int pci_msi_enabled(void)
1026 {
1027         return pci_msi_enable;
1028 }
1029 EXPORT_SYMBOL(pci_msi_enabled);
1030
1031 void pci_msi_init_pci_dev(struct pci_dev *dev)
1032 {
1033         INIT_LIST_HEAD(&dev->msi_list);
1034
1035         /* Disable the msi hardware to avoid screaming interrupts
1036          * during boot.  This is the power on reset default so
1037          * usually this should be a noop.
1038          */
1039         dev->msi_cap = pci_find_capability(dev, PCI_CAP_ID_MSI);
1040         if (dev->msi_cap)
1041                 msi_set_enable(dev, 0);
1042
1043         dev->msix_cap = pci_find_capability(dev, PCI_CAP_ID_MSIX);
1044         if (dev->msix_cap)
1045                 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
1046 }
1047
1048 /**
1049  * pci_enable_msi_range - configure device's MSI capability structure
1050  * @dev: device to configure
1051  * @minvec: minimal number of interrupts to configure
1052  * @maxvec: maximum number of interrupts to configure
1053  *
1054  * This function tries to allocate a maximum possible number of interrupts in a
1055  * range between @minvec and @maxvec. It returns a negative errno if an error
1056  * occurs. If it succeeds, it returns the actual number of interrupts allocated
1057  * and updates the @dev's irq member to the lowest new interrupt number;
1058  * the other interrupt numbers allocated to this device are consecutive.
1059  **/
1060 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec)
1061 {
1062         int nvec;
1063         int rc;
1064
1065         if (dev->current_state != PCI_D0)
1066                 return -EINVAL;
1067
1068         WARN_ON(!!dev->msi_enabled);
1069
1070         /* Check whether driver already requested MSI-X irqs */
1071         if (dev->msix_enabled) {
1072                 dev_info(&dev->dev,
1073                          "can't enable MSI (MSI-X already enabled)\n");
1074                 return -EINVAL;
1075         }
1076
1077         if (maxvec < minvec)
1078                 return -ERANGE;
1079
1080         nvec = pci_msi_vec_count(dev);
1081         if (nvec < 0)
1082                 return nvec;
1083         else if (nvec < minvec)
1084                 return -EINVAL;
1085         else if (nvec > maxvec)
1086                 nvec = maxvec;
1087
1088         do {
1089                 rc = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSI);
1090                 if (rc < 0) {
1091                         return rc;
1092                 } else if (rc > 0) {
1093                         if (rc < minvec)
1094                                 return -ENOSPC;
1095                         nvec = rc;
1096                 }
1097         } while (rc);
1098
1099         do {
1100                 rc = msi_capability_init(dev, nvec);
1101                 if (rc < 0) {
1102                         return rc;
1103                 } else if (rc > 0) {
1104                         if (rc < minvec)
1105                                 return -ENOSPC;
1106                         nvec = rc;
1107                 }
1108         } while (rc);
1109
1110         return nvec;
1111 }
1112 EXPORT_SYMBOL(pci_enable_msi_range);
1113
1114 /**
1115  * pci_enable_msix_range - configure device's MSI-X capability structure
1116  * @dev: pointer to the pci_dev data structure of MSI-X device function
1117  * @entries: pointer to an array of MSI-X entries
1118  * @minvec: minimum number of MSI-X irqs requested
1119  * @maxvec: maximum number of MSI-X irqs requested
1120  *
1121  * Setup the MSI-X capability structure of device function with a maximum
1122  * possible number of interrupts in the range between @minvec and @maxvec
1123  * upon its software driver call to request for MSI-X mode enabled on its
1124  * hardware device function. It returns a negative errno if an error occurs.
1125  * If it succeeds, it returns the actual number of interrupts allocated and
1126  * indicates the successful configuration of MSI-X capability structure
1127  * with new allocated MSI-X interrupts.
1128  **/
1129 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1130                                int minvec, int maxvec)
1131 {
1132         int nvec = maxvec;
1133         int rc;
1134
1135         if (maxvec < minvec)
1136                 return -ERANGE;
1137
1138         do {
1139                 rc = pci_enable_msix(dev, entries, nvec);
1140                 if (rc < 0) {
1141                         return rc;
1142                 } else if (rc > 0) {
1143                         if (rc < minvec)
1144                                 return -ENOSPC;
1145                         nvec = rc;
1146                 }
1147         } while (rc);
1148
1149         return nvec;
1150 }
1151 EXPORT_SYMBOL(pci_enable_msix_range);