rtc: s3c: add support for RTC of Exynos3250 SoC
[linux-2.6/btrfs-unstable.git] / drivers / pci / msi.c
blob9fab30af0e75abdcec135707363951d7e9e26f8c
1 /*
2 * File: msi.c
3 * Purpose: PCI Message Signaled Interrupt (MSI)
5 * Copyright (C) 2003-2004 Intel
6 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
7 */
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>
23 #include "pci.h"
25 static int pci_msi_enable = 1;
27 #define msix_table_size(flags) ((flags & PCI_MSIX_FLAGS_QSIZE) + 1)
30 /* Arch hooks */
32 int __weak arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc)
34 struct msi_chip *chip = dev->bus->msi;
35 int err;
37 if (!chip || !chip->setup_irq)
38 return -EINVAL;
40 err = chip->setup_irq(chip, dev, desc);
41 if (err < 0)
42 return err;
44 irq_set_chip_data(desc->irq, chip);
46 return 0;
49 void __weak arch_teardown_msi_irq(unsigned int irq)
51 struct msi_chip *chip = irq_get_chip_data(irq);
53 if (!chip || !chip->teardown_irq)
54 return;
56 chip->teardown_irq(chip, irq);
59 int __weak arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
61 struct msi_desc *entry;
62 int ret;
65 * If an architecture wants to support multiple MSI, it needs to
66 * override arch_setup_msi_irqs()
68 if (type == PCI_CAP_ID_MSI && nvec > 1)
69 return 1;
71 list_for_each_entry(entry, &dev->msi_list, list) {
72 ret = arch_setup_msi_irq(dev, entry);
73 if (ret < 0)
74 return ret;
75 if (ret > 0)
76 return -ENOSPC;
79 return 0;
83 * We have a default implementation available as a separate non-weak
84 * function, as it is used by the Xen x86 PCI code
86 void default_teardown_msi_irqs(struct pci_dev *dev)
88 struct msi_desc *entry;
90 list_for_each_entry(entry, &dev->msi_list, list) {
91 int i, nvec;
92 if (entry->irq == 0)
93 continue;
94 if (entry->nvec_used)
95 nvec = entry->nvec_used;
96 else
97 nvec = 1 << entry->msi_attrib.multiple;
98 for (i = 0; i < nvec; i++)
99 arch_teardown_msi_irq(entry->irq + i);
103 void __weak arch_teardown_msi_irqs(struct pci_dev *dev)
105 return default_teardown_msi_irqs(dev);
108 static void default_restore_msi_irq(struct pci_dev *dev, int irq)
110 struct msi_desc *entry;
112 entry = NULL;
113 if (dev->msix_enabled) {
114 list_for_each_entry(entry, &dev->msi_list, list) {
115 if (irq == entry->irq)
116 break;
118 } else if (dev->msi_enabled) {
119 entry = irq_get_msi_desc(irq);
122 if (entry)
123 __write_msi_msg(entry, &entry->msg);
126 void __weak arch_restore_msi_irqs(struct pci_dev *dev)
128 return default_restore_msi_irqs(dev);
131 static void msi_set_enable(struct pci_dev *dev, int enable)
133 u16 control;
135 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
136 control &= ~PCI_MSI_FLAGS_ENABLE;
137 if (enable)
138 control |= PCI_MSI_FLAGS_ENABLE;
139 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
142 static void msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
144 u16 ctrl;
146 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
147 ctrl &= ~clear;
148 ctrl |= set;
149 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
152 static inline __attribute_const__ u32 msi_mask(unsigned x)
154 /* Don't shift by >= width of type */
155 if (x >= 5)
156 return 0xffffffff;
157 return (1 << (1 << x)) - 1;
161 * PCI 2.3 does not specify mask bits for each MSI interrupt. Attempting to
162 * mask all MSI interrupts by clearing the MSI enable bit does not work
163 * reliably as devices without an INTx disable bit will then generate a
164 * level IRQ which will never be cleared.
166 u32 default_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
168 u32 mask_bits = desc->masked;
170 if (!desc->msi_attrib.maskbit)
171 return 0;
173 mask_bits &= ~mask;
174 mask_bits |= flag;
175 pci_write_config_dword(desc->dev, desc->mask_pos, mask_bits);
177 return mask_bits;
180 __weak u32 arch_msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
182 return default_msi_mask_irq(desc, mask, flag);
185 static void msi_mask_irq(struct msi_desc *desc, u32 mask, u32 flag)
187 desc->masked = arch_msi_mask_irq(desc, mask, flag);
191 * This internal function does not flush PCI writes to the device.
192 * All users must ensure that they read from the device before either
193 * assuming that the device state is up to date, or returning out of this
194 * file. This saves a few milliseconds when initialising devices with lots
195 * of MSI-X interrupts.
197 u32 default_msix_mask_irq(struct msi_desc *desc, u32 flag)
199 u32 mask_bits = desc->masked;
200 unsigned offset = desc->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
201 PCI_MSIX_ENTRY_VECTOR_CTRL;
202 mask_bits &= ~PCI_MSIX_ENTRY_CTRL_MASKBIT;
203 if (flag)
204 mask_bits |= PCI_MSIX_ENTRY_CTRL_MASKBIT;
205 writel(mask_bits, desc->mask_base + offset);
207 return mask_bits;
210 __weak u32 arch_msix_mask_irq(struct msi_desc *desc, u32 flag)
212 return default_msix_mask_irq(desc, flag);
215 static void msix_mask_irq(struct msi_desc *desc, u32 flag)
217 desc->masked = arch_msix_mask_irq(desc, flag);
220 static void msi_set_mask_bit(struct irq_data *data, u32 flag)
222 struct msi_desc *desc = irq_data_get_msi(data);
224 if (desc->msi_attrib.is_msix) {
225 msix_mask_irq(desc, flag);
226 readl(desc->mask_base); /* Flush write to device */
227 } else {
228 unsigned offset = data->irq - desc->irq;
229 msi_mask_irq(desc, 1 << offset, flag << offset);
233 void mask_msi_irq(struct irq_data *data)
235 msi_set_mask_bit(data, 1);
238 void unmask_msi_irq(struct irq_data *data)
240 msi_set_mask_bit(data, 0);
243 void default_restore_msi_irqs(struct pci_dev *dev)
245 struct msi_desc *entry;
247 list_for_each_entry(entry, &dev->msi_list, list) {
248 default_restore_msi_irq(dev, entry->irq);
252 void __read_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
254 BUG_ON(entry->dev->current_state != PCI_D0);
256 if (entry->msi_attrib.is_msix) {
257 void __iomem *base = entry->mask_base +
258 entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
260 msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR);
261 msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR);
262 msg->data = readl(base + PCI_MSIX_ENTRY_DATA);
263 } else {
264 struct pci_dev *dev = entry->dev;
265 int pos = dev->msi_cap;
266 u16 data;
268 pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
269 &msg->address_lo);
270 if (entry->msi_attrib.is_64) {
271 pci_read_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
272 &msg->address_hi);
273 pci_read_config_word(dev, pos + PCI_MSI_DATA_64, &data);
274 } else {
275 msg->address_hi = 0;
276 pci_read_config_word(dev, pos + PCI_MSI_DATA_32, &data);
278 msg->data = data;
282 void read_msi_msg(unsigned int irq, struct msi_msg *msg)
284 struct msi_desc *entry = irq_get_msi_desc(irq);
286 __read_msi_msg(entry, msg);
289 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
291 /* Assert that the cache is valid, assuming that
292 * valid messages are not all-zeroes. */
293 BUG_ON(!(entry->msg.address_hi | entry->msg.address_lo |
294 entry->msg.data));
296 *msg = entry->msg;
299 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
301 struct msi_desc *entry = irq_get_msi_desc(irq);
303 __get_cached_msi_msg(entry, msg);
305 EXPORT_SYMBOL_GPL(get_cached_msi_msg);
307 void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
309 if (entry->dev->current_state != PCI_D0) {
310 /* Don't touch the hardware now */
311 } else if (entry->msi_attrib.is_msix) {
312 void __iomem *base;
313 base = entry->mask_base +
314 entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
316 writel(msg->address_lo, base + PCI_MSIX_ENTRY_LOWER_ADDR);
317 writel(msg->address_hi, base + PCI_MSIX_ENTRY_UPPER_ADDR);
318 writel(msg->data, base + PCI_MSIX_ENTRY_DATA);
319 } else {
320 struct pci_dev *dev = entry->dev;
321 int pos = dev->msi_cap;
322 u16 msgctl;
324 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &msgctl);
325 msgctl &= ~PCI_MSI_FLAGS_QSIZE;
326 msgctl |= entry->msi_attrib.multiple << 4;
327 pci_write_config_word(dev, pos + PCI_MSI_FLAGS, msgctl);
329 pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_LO,
330 msg->address_lo);
331 if (entry->msi_attrib.is_64) {
332 pci_write_config_dword(dev, pos + PCI_MSI_ADDRESS_HI,
333 msg->address_hi);
334 pci_write_config_word(dev, pos + PCI_MSI_DATA_64,
335 msg->data);
336 } else {
337 pci_write_config_word(dev, pos + PCI_MSI_DATA_32,
338 msg->data);
341 entry->msg = *msg;
344 void write_msi_msg(unsigned int irq, struct msi_msg *msg)
346 struct msi_desc *entry = irq_get_msi_desc(irq);
348 __write_msi_msg(entry, msg);
350 EXPORT_SYMBOL_GPL(write_msi_msg);
352 static void free_msi_irqs(struct pci_dev *dev)
354 struct msi_desc *entry, *tmp;
355 struct attribute **msi_attrs;
356 struct device_attribute *dev_attr;
357 int count = 0;
359 list_for_each_entry(entry, &dev->msi_list, list) {
360 int i, nvec;
361 if (!entry->irq)
362 continue;
363 if (entry->nvec_used)
364 nvec = entry->nvec_used;
365 else
366 nvec = 1 << entry->msi_attrib.multiple;
367 for (i = 0; i < nvec; i++)
368 BUG_ON(irq_has_action(entry->irq + i));
371 arch_teardown_msi_irqs(dev);
373 list_for_each_entry_safe(entry, tmp, &dev->msi_list, list) {
374 if (entry->msi_attrib.is_msix) {
375 if (list_is_last(&entry->list, &dev->msi_list))
376 iounmap(entry->mask_base);
379 list_del(&entry->list);
380 kfree(entry);
383 if (dev->msi_irq_groups) {
384 sysfs_remove_groups(&dev->dev.kobj, dev->msi_irq_groups);
385 msi_attrs = dev->msi_irq_groups[0]->attrs;
386 while (msi_attrs[count]) {
387 dev_attr = container_of(msi_attrs[count],
388 struct device_attribute, attr);
389 kfree(dev_attr->attr.name);
390 kfree(dev_attr);
391 ++count;
393 kfree(msi_attrs);
394 kfree(dev->msi_irq_groups[0]);
395 kfree(dev->msi_irq_groups);
396 dev->msi_irq_groups = NULL;
400 static struct msi_desc *alloc_msi_entry(struct pci_dev *dev)
402 struct msi_desc *desc = kzalloc(sizeof(*desc), GFP_KERNEL);
403 if (!desc)
404 return NULL;
406 INIT_LIST_HEAD(&desc->list);
407 desc->dev = dev;
409 return desc;
412 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
414 if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
415 pci_intx(dev, enable);
418 static void __pci_restore_msi_state(struct pci_dev *dev)
420 u16 control;
421 struct msi_desc *entry;
423 if (!dev->msi_enabled)
424 return;
426 entry = irq_get_msi_desc(dev->irq);
428 pci_intx_for_msi(dev, 0);
429 msi_set_enable(dev, 0);
430 arch_restore_msi_irqs(dev);
432 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
433 msi_mask_irq(entry, msi_mask(entry->msi_attrib.multi_cap),
434 entry->masked);
435 control &= ~PCI_MSI_FLAGS_QSIZE;
436 control |= (entry->msi_attrib.multiple << 4) | PCI_MSI_FLAGS_ENABLE;
437 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
440 static void __pci_restore_msix_state(struct pci_dev *dev)
442 struct msi_desc *entry;
444 if (!dev->msix_enabled)
445 return;
446 BUG_ON(list_empty(&dev->msi_list));
448 /* route the table */
449 pci_intx_for_msi(dev, 0);
450 msix_clear_and_set_ctrl(dev, 0,
451 PCI_MSIX_FLAGS_ENABLE | PCI_MSIX_FLAGS_MASKALL);
453 arch_restore_msi_irqs(dev);
454 list_for_each_entry(entry, &dev->msi_list, list) {
455 msix_mask_irq(entry, entry->masked);
458 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
461 void pci_restore_msi_state(struct pci_dev *dev)
463 __pci_restore_msi_state(dev);
464 __pci_restore_msix_state(dev);
466 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
468 static ssize_t msi_mode_show(struct device *dev, struct device_attribute *attr,
469 char *buf)
471 struct msi_desc *entry;
472 unsigned long irq;
473 int retval;
475 retval = kstrtoul(attr->attr.name, 10, &irq);
476 if (retval)
477 return retval;
479 entry = irq_get_msi_desc(irq);
480 if (entry)
481 return sprintf(buf, "%s\n",
482 entry->msi_attrib.is_msix ? "msix" : "msi");
484 return -ENODEV;
487 static int populate_msi_sysfs(struct pci_dev *pdev)
489 struct attribute **msi_attrs;
490 struct attribute *msi_attr;
491 struct device_attribute *msi_dev_attr;
492 struct attribute_group *msi_irq_group;
493 const struct attribute_group **msi_irq_groups;
494 struct msi_desc *entry;
495 int ret = -ENOMEM;
496 int num_msi = 0;
497 int count = 0;
499 /* Determine how many msi entries we have */
500 list_for_each_entry(entry, &pdev->msi_list, list) {
501 ++num_msi;
503 if (!num_msi)
504 return 0;
506 /* Dynamically create the MSI attributes for the PCI device */
507 msi_attrs = kzalloc(sizeof(void *) * (num_msi + 1), GFP_KERNEL);
508 if (!msi_attrs)
509 return -ENOMEM;
510 list_for_each_entry(entry, &pdev->msi_list, list) {
511 msi_dev_attr = kzalloc(sizeof(*msi_dev_attr), GFP_KERNEL);
512 if (!msi_dev_attr)
513 goto error_attrs;
514 msi_attrs[count] = &msi_dev_attr->attr;
516 sysfs_attr_init(&msi_dev_attr->attr);
517 msi_dev_attr->attr.name = kasprintf(GFP_KERNEL, "%d",
518 entry->irq);
519 if (!msi_dev_attr->attr.name)
520 goto error_attrs;
521 msi_dev_attr->attr.mode = S_IRUGO;
522 msi_dev_attr->show = msi_mode_show;
523 ++count;
526 msi_irq_group = kzalloc(sizeof(*msi_irq_group), GFP_KERNEL);
527 if (!msi_irq_group)
528 goto error_attrs;
529 msi_irq_group->name = "msi_irqs";
530 msi_irq_group->attrs = msi_attrs;
532 msi_irq_groups = kzalloc(sizeof(void *) * 2, GFP_KERNEL);
533 if (!msi_irq_groups)
534 goto error_irq_group;
535 msi_irq_groups[0] = msi_irq_group;
537 ret = sysfs_create_groups(&pdev->dev.kobj, msi_irq_groups);
538 if (ret)
539 goto error_irq_groups;
540 pdev->msi_irq_groups = msi_irq_groups;
542 return 0;
544 error_irq_groups:
545 kfree(msi_irq_groups);
546 error_irq_group:
547 kfree(msi_irq_group);
548 error_attrs:
549 count = 0;
550 msi_attr = msi_attrs[count];
551 while (msi_attr) {
552 msi_dev_attr = container_of(msi_attr, struct device_attribute, attr);
553 kfree(msi_attr->name);
554 kfree(msi_dev_attr);
555 ++count;
556 msi_attr = msi_attrs[count];
558 kfree(msi_attrs);
559 return ret;
562 static struct msi_desc *msi_setup_entry(struct pci_dev *dev)
564 u16 control;
565 struct msi_desc *entry;
567 /* MSI Entry Initialization */
568 entry = alloc_msi_entry(dev);
569 if (!entry)
570 return NULL;
572 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
574 entry->msi_attrib.is_msix = 0;
575 entry->msi_attrib.is_64 = !!(control & PCI_MSI_FLAGS_64BIT);
576 entry->msi_attrib.entry_nr = 0;
577 entry->msi_attrib.maskbit = !!(control & PCI_MSI_FLAGS_MASKBIT);
578 entry->msi_attrib.default_irq = dev->irq; /* Save IOAPIC IRQ */
579 entry->msi_attrib.multi_cap = (control & PCI_MSI_FLAGS_QMASK) >> 1;
581 if (control & PCI_MSI_FLAGS_64BIT)
582 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_64;
583 else
584 entry->mask_pos = dev->msi_cap + PCI_MSI_MASK_32;
586 /* Save the initial mask status */
587 if (entry->msi_attrib.maskbit)
588 pci_read_config_dword(dev, entry->mask_pos, &entry->masked);
590 return entry;
594 * msi_capability_init - configure device's MSI capability structure
595 * @dev: pointer to the pci_dev data structure of MSI device function
596 * @nvec: number of interrupts to allocate
598 * Setup the MSI capability structure of the device with the requested
599 * number of interrupts. A return value of zero indicates the successful
600 * setup of an entry with the new MSI irq. A negative return value indicates
601 * an error, and a positive return value indicates the number of interrupts
602 * which could have been allocated.
604 static int msi_capability_init(struct pci_dev *dev, int nvec)
606 struct msi_desc *entry;
607 int ret;
608 unsigned mask;
610 msi_set_enable(dev, 0); /* Disable MSI during set up */
612 entry = msi_setup_entry(dev);
613 if (!entry)
614 return -ENOMEM;
616 /* All MSIs are unmasked by default, Mask them all */
617 mask = msi_mask(entry->msi_attrib.multi_cap);
618 msi_mask_irq(entry, mask, mask);
620 list_add_tail(&entry->list, &dev->msi_list);
622 /* Configure MSI capability structure */
623 ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSI);
624 if (ret) {
625 msi_mask_irq(entry, mask, ~mask);
626 free_msi_irqs(dev);
627 return ret;
630 ret = populate_msi_sysfs(dev);
631 if (ret) {
632 msi_mask_irq(entry, mask, ~mask);
633 free_msi_irqs(dev);
634 return ret;
637 /* Set MSI enabled bits */
638 pci_intx_for_msi(dev, 0);
639 msi_set_enable(dev, 1);
640 dev->msi_enabled = 1;
642 dev->irq = entry->irq;
643 return 0;
646 static void __iomem *msix_map_region(struct pci_dev *dev, unsigned nr_entries)
648 resource_size_t phys_addr;
649 u32 table_offset;
650 u8 bir;
652 pci_read_config_dword(dev, dev->msix_cap + PCI_MSIX_TABLE,
653 &table_offset);
654 bir = (u8)(table_offset & PCI_MSIX_TABLE_BIR);
655 table_offset &= PCI_MSIX_TABLE_OFFSET;
656 phys_addr = pci_resource_start(dev, bir) + table_offset;
658 return ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
661 static int msix_setup_entries(struct pci_dev *dev, void __iomem *base,
662 struct msix_entry *entries, int nvec)
664 struct msi_desc *entry;
665 int i;
667 for (i = 0; i < nvec; i++) {
668 entry = alloc_msi_entry(dev);
669 if (!entry) {
670 if (!i)
671 iounmap(base);
672 else
673 free_msi_irqs(dev);
674 /* No enough memory. Don't try again */
675 return -ENOMEM;
678 entry->msi_attrib.is_msix = 1;
679 entry->msi_attrib.is_64 = 1;
680 entry->msi_attrib.entry_nr = entries[i].entry;
681 entry->msi_attrib.default_irq = dev->irq;
682 entry->mask_base = base;
684 list_add_tail(&entry->list, &dev->msi_list);
687 return 0;
690 static void msix_program_entries(struct pci_dev *dev,
691 struct msix_entry *entries)
693 struct msi_desc *entry;
694 int i = 0;
696 list_for_each_entry(entry, &dev->msi_list, list) {
697 int offset = entries[i].entry * PCI_MSIX_ENTRY_SIZE +
698 PCI_MSIX_ENTRY_VECTOR_CTRL;
700 entries[i].vector = entry->irq;
701 irq_set_msi_desc(entry->irq, entry);
702 entry->masked = readl(entry->mask_base + offset);
703 msix_mask_irq(entry, 1);
704 i++;
709 * msix_capability_init - configure device's MSI-X capability
710 * @dev: pointer to the pci_dev data structure of MSI-X device function
711 * @entries: pointer to an array of struct msix_entry entries
712 * @nvec: number of @entries
714 * Setup the MSI-X capability structure of device function with a
715 * single MSI-X irq. A return of zero indicates the successful setup of
716 * requested MSI-X entries with allocated irqs or non-zero for otherwise.
718 static int msix_capability_init(struct pci_dev *dev,
719 struct msix_entry *entries, int nvec)
721 int ret;
722 u16 control;
723 void __iomem *base;
725 /* Ensure MSI-X is disabled while it is set up */
726 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
728 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
729 /* Request & Map MSI-X table region */
730 base = msix_map_region(dev, msix_table_size(control));
731 if (!base)
732 return -ENOMEM;
734 ret = msix_setup_entries(dev, base, entries, nvec);
735 if (ret)
736 return ret;
738 ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
739 if (ret)
740 goto out_avail;
743 * Some devices require MSI-X to be enabled before we can touch the
744 * MSI-X registers. We need to mask all the vectors to prevent
745 * interrupts coming in before they're fully set up.
747 msix_clear_and_set_ctrl(dev, 0,
748 PCI_MSIX_FLAGS_MASKALL | PCI_MSIX_FLAGS_ENABLE);
750 msix_program_entries(dev, entries);
752 ret = populate_msi_sysfs(dev);
753 if (ret)
754 goto out_free;
756 /* Set MSI-X enabled bits and unmask the function */
757 pci_intx_for_msi(dev, 0);
758 dev->msix_enabled = 1;
760 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_MASKALL, 0);
762 return 0;
764 out_avail:
765 if (ret < 0) {
767 * If we had some success, report the number of irqs
768 * we succeeded in setting up.
770 struct msi_desc *entry;
771 int avail = 0;
773 list_for_each_entry(entry, &dev->msi_list, list) {
774 if (entry->irq != 0)
775 avail++;
777 if (avail != 0)
778 ret = avail;
781 out_free:
782 free_msi_irqs(dev);
784 return ret;
788 * pci_msi_supported - check whether MSI may be enabled on a device
789 * @dev: pointer to the pci_dev data structure of MSI device function
790 * @nvec: how many MSIs have been requested ?
792 * Look at global flags, the device itself, and its parent buses
793 * to determine if MSI/-X are supported for the device. If MSI/-X is
794 * supported return 1, else return 0.
796 static int pci_msi_supported(struct pci_dev *dev, int nvec)
798 struct pci_bus *bus;
800 /* MSI must be globally enabled and supported by the device */
801 if (!pci_msi_enable)
802 return 0;
804 if (!dev || dev->no_msi || dev->current_state != PCI_D0)
805 return 0;
808 * You can't ask to have 0 or less MSIs configured.
809 * a) it's stupid ..
810 * b) the list manipulation code assumes nvec >= 1.
812 if (nvec < 1)
813 return 0;
816 * Any bridge which does NOT route MSI transactions from its
817 * secondary bus to its primary bus must set NO_MSI flag on
818 * the secondary pci_bus.
819 * We expect only arch-specific PCI host bus controller driver
820 * or quirks for specific PCI bridges to be setting NO_MSI.
822 for (bus = dev->bus; bus; bus = bus->parent)
823 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
824 return 0;
826 return 1;
830 * pci_msi_vec_count - Return the number of MSI vectors a device can send
831 * @dev: device to report about
833 * This function returns the number of MSI vectors a device requested via
834 * Multiple Message Capable register. It returns a negative errno if the
835 * device is not capable sending MSI interrupts. Otherwise, the call succeeds
836 * and returns a power of two, up to a maximum of 2^5 (32), according to the
837 * MSI specification.
839 int pci_msi_vec_count(struct pci_dev *dev)
841 int ret;
842 u16 msgctl;
844 if (!dev->msi_cap)
845 return -EINVAL;
847 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &msgctl);
848 ret = 1 << ((msgctl & PCI_MSI_FLAGS_QMASK) >> 1);
850 return ret;
852 EXPORT_SYMBOL(pci_msi_vec_count);
854 void pci_msi_shutdown(struct pci_dev *dev)
856 struct msi_desc *desc;
857 u32 mask;
859 if (!pci_msi_enable || !dev || !dev->msi_enabled)
860 return;
862 BUG_ON(list_empty(&dev->msi_list));
863 desc = list_first_entry(&dev->msi_list, struct msi_desc, list);
865 msi_set_enable(dev, 0);
866 pci_intx_for_msi(dev, 1);
867 dev->msi_enabled = 0;
869 /* Return the device with MSI unmasked as initial states */
870 mask = msi_mask(desc->msi_attrib.multi_cap);
871 /* Keep cached state to be restored */
872 arch_msi_mask_irq(desc, mask, ~mask);
874 /* Restore dev->irq to its default pin-assertion irq */
875 dev->irq = desc->msi_attrib.default_irq;
878 void pci_disable_msi(struct pci_dev *dev)
880 if (!pci_msi_enable || !dev || !dev->msi_enabled)
881 return;
883 pci_msi_shutdown(dev);
884 free_msi_irqs(dev);
886 EXPORT_SYMBOL(pci_disable_msi);
889 * pci_msix_vec_count - return the number of device's MSI-X table entries
890 * @dev: pointer to the pci_dev data structure of MSI-X device function
891 * This function returns the number of device's MSI-X table entries and
892 * therefore the number of MSI-X vectors device is capable of sending.
893 * It returns a negative errno if the device is not capable of sending MSI-X
894 * interrupts.
896 int pci_msix_vec_count(struct pci_dev *dev)
898 u16 control;
900 if (!dev->msix_cap)
901 return -EINVAL;
903 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &control);
904 return msix_table_size(control);
906 EXPORT_SYMBOL(pci_msix_vec_count);
909 * pci_enable_msix - configure device's MSI-X capability structure
910 * @dev: pointer to the pci_dev data structure of MSI-X device function
911 * @entries: pointer to an array of MSI-X entries
912 * @nvec: number of MSI-X irqs requested for allocation by device driver
914 * Setup the MSI-X capability structure of device function with the number
915 * of requested irqs upon its software driver call to request for
916 * MSI-X mode enabled on its hardware device function. A return of zero
917 * indicates the successful configuration of MSI-X capability structure
918 * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
919 * Or a return of > 0 indicates that driver request is exceeding the number
920 * of irqs or MSI-X vectors available. Driver should use the returned value to
921 * re-send its request.
923 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec)
925 int nr_entries;
926 int i, j;
928 if (!pci_msi_supported(dev, nvec))
929 return -EINVAL;
931 if (!entries)
932 return -EINVAL;
934 nr_entries = pci_msix_vec_count(dev);
935 if (nr_entries < 0)
936 return nr_entries;
937 if (nvec > nr_entries)
938 return nr_entries;
940 /* Check for any invalid entries */
941 for (i = 0; i < nvec; i++) {
942 if (entries[i].entry >= nr_entries)
943 return -EINVAL; /* invalid entry */
944 for (j = i + 1; j < nvec; j++) {
945 if (entries[i].entry == entries[j].entry)
946 return -EINVAL; /* duplicate entry */
949 WARN_ON(!!dev->msix_enabled);
951 /* Check whether driver already requested for MSI irq */
952 if (dev->msi_enabled) {
953 dev_info(&dev->dev, "can't enable MSI-X (MSI IRQ already assigned)\n");
954 return -EINVAL;
956 return msix_capability_init(dev, entries, nvec);
958 EXPORT_SYMBOL(pci_enable_msix);
960 void pci_msix_shutdown(struct pci_dev *dev)
962 struct msi_desc *entry;
964 if (!pci_msi_enable || !dev || !dev->msix_enabled)
965 return;
967 /* Return the device with MSI-X masked as initial states */
968 list_for_each_entry(entry, &dev->msi_list, list) {
969 /* Keep cached states to be restored */
970 arch_msix_mask_irq(entry, 1);
973 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
974 pci_intx_for_msi(dev, 1);
975 dev->msix_enabled = 0;
978 void pci_disable_msix(struct pci_dev *dev)
980 if (!pci_msi_enable || !dev || !dev->msix_enabled)
981 return;
983 pci_msix_shutdown(dev);
984 free_msi_irqs(dev);
986 EXPORT_SYMBOL(pci_disable_msix);
988 void pci_no_msi(void)
990 pci_msi_enable = 0;
994 * pci_msi_enabled - is MSI enabled?
996 * Returns true if MSI has not been disabled by the command-line option
997 * pci=nomsi.
999 int pci_msi_enabled(void)
1001 return pci_msi_enable;
1003 EXPORT_SYMBOL(pci_msi_enabled);
1005 void pci_msi_init_pci_dev(struct pci_dev *dev)
1007 INIT_LIST_HEAD(&dev->msi_list);
1009 /* Disable the msi hardware to avoid screaming interrupts
1010 * during boot. This is the power on reset default so
1011 * usually this should be a noop.
1013 dev->msi_cap = pci_find_capability(dev, PCI_CAP_ID_MSI);
1014 if (dev->msi_cap)
1015 msi_set_enable(dev, 0);
1017 dev->msix_cap = pci_find_capability(dev, PCI_CAP_ID_MSIX);
1018 if (dev->msix_cap)
1019 msix_clear_and_set_ctrl(dev, PCI_MSIX_FLAGS_ENABLE, 0);
1023 * pci_enable_msi_range - configure device's MSI capability structure
1024 * @dev: device to configure
1025 * @minvec: minimal number of interrupts to configure
1026 * @maxvec: maximum number of interrupts to configure
1028 * This function tries to allocate a maximum possible number of interrupts in a
1029 * range between @minvec and @maxvec. It returns a negative errno if an error
1030 * occurs. If it succeeds, it returns the actual number of interrupts allocated
1031 * and updates the @dev's irq member to the lowest new interrupt number;
1032 * the other interrupt numbers allocated to this device are consecutive.
1034 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec)
1036 int nvec;
1037 int rc;
1039 if (!pci_msi_supported(dev, minvec))
1040 return -EINVAL;
1042 WARN_ON(!!dev->msi_enabled);
1044 /* Check whether driver already requested MSI-X irqs */
1045 if (dev->msix_enabled) {
1046 dev_info(&dev->dev,
1047 "can't enable MSI (MSI-X already enabled)\n");
1048 return -EINVAL;
1051 if (maxvec < minvec)
1052 return -ERANGE;
1054 nvec = pci_msi_vec_count(dev);
1055 if (nvec < 0)
1056 return nvec;
1057 else if (nvec < minvec)
1058 return -EINVAL;
1059 else if (nvec > maxvec)
1060 nvec = maxvec;
1062 do {
1063 rc = msi_capability_init(dev, nvec);
1064 if (rc < 0) {
1065 return rc;
1066 } else if (rc > 0) {
1067 if (rc < minvec)
1068 return -ENOSPC;
1069 nvec = rc;
1071 } while (rc);
1073 return nvec;
1075 EXPORT_SYMBOL(pci_enable_msi_range);
1078 * pci_enable_msix_range - configure device's MSI-X capability structure
1079 * @dev: pointer to the pci_dev data structure of MSI-X device function
1080 * @entries: pointer to an array of MSI-X entries
1081 * @minvec: minimum number of MSI-X irqs requested
1082 * @maxvec: maximum number of MSI-X irqs requested
1084 * Setup the MSI-X capability structure of device function with a maximum
1085 * possible number of interrupts in the range between @minvec and @maxvec
1086 * upon its software driver call to request for MSI-X mode enabled on its
1087 * hardware device function. It returns a negative errno if an error occurs.
1088 * If it succeeds, it returns the actual number of interrupts allocated and
1089 * indicates the successful configuration of MSI-X capability structure
1090 * with new allocated MSI-X interrupts.
1092 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1093 int minvec, int maxvec)
1095 int nvec = maxvec;
1096 int rc;
1098 if (maxvec < minvec)
1099 return -ERANGE;
1101 do {
1102 rc = pci_enable_msix(dev, entries, nvec);
1103 if (rc < 0) {
1104 return rc;
1105 } else if (rc > 0) {
1106 if (rc < minvec)
1107 return -ENOSPC;
1108 nvec = rc;
1110 } while (rc);
1112 return nvec;
1114 EXPORT_SYMBOL(pci_enable_msix_range);