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