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