PCI/MSI: bugfix/utilize for msi_capability_init()
[linux-2.6.git] / 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/ioport.h>
15 #include <linux/pci.h>
16 #include <linux/proc_fs.h>
17 #include <linux/msi.h>
18 #include <linux/smp.h>
19
20 #include <asm/errno.h>
21 #include <asm/io.h>
22
23 #include "pci.h"
24 #include "msi.h"
25
26 static int pci_msi_enable = 1;
27
28 /* Arch hooks */
29
30 int __attribute__ ((weak))
31 arch_msi_check_device(struct pci_dev *dev, int nvec, int type)
32 {
33         return 0;
34 }
35
36 int __attribute__ ((weak))
37 arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *entry)
38 {
39         return 0;
40 }
41
42 int __attribute__ ((weak))
43 arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
44 {
45         struct msi_desc *entry;
46         int ret;
47
48         list_for_each_entry(entry, &dev->msi_list, list) {
49                 ret = arch_setup_msi_irq(dev, entry);
50                 if (ret)
51                         return ret;
52         }
53
54         return 0;
55 }
56
57 void __attribute__ ((weak)) arch_teardown_msi_irq(unsigned int irq)
58 {
59         return;
60 }
61
62 void __attribute__ ((weak))
63 arch_teardown_msi_irqs(struct pci_dev *dev)
64 {
65         struct msi_desc *entry;
66
67         list_for_each_entry(entry, &dev->msi_list, list) {
68                 if (entry->irq != 0)
69                         arch_teardown_msi_irq(entry->irq);
70         }
71 }
72
73 static void __msi_set_enable(struct pci_dev *dev, int pos, int enable)
74 {
75         u16 control;
76
77         if (pos) {
78                 pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &control);
79                 control &= ~PCI_MSI_FLAGS_ENABLE;
80                 if (enable)
81                         control |= PCI_MSI_FLAGS_ENABLE;
82                 pci_write_config_word(dev, pos + PCI_MSI_FLAGS, control);
83         }
84 }
85
86 static void msi_set_enable(struct pci_dev *dev, int enable)
87 {
88         __msi_set_enable(dev, pci_find_capability(dev, PCI_CAP_ID_MSI), enable);
89 }
90
91 static void msix_set_enable(struct pci_dev *dev, int enable)
92 {
93         int pos;
94         u16 control;
95
96         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
97         if (pos) {
98                 pci_read_config_word(dev, pos + PCI_MSIX_FLAGS, &control);
99                 control &= ~PCI_MSIX_FLAGS_ENABLE;
100                 if (enable)
101                         control |= PCI_MSIX_FLAGS_ENABLE;
102                 pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
103         }
104 }
105
106 static void msix_flush_writes(struct irq_desc *desc)
107 {
108         struct msi_desc *entry;
109
110         entry = get_irq_desc_msi(desc);
111         BUG_ON(!entry || !entry->dev);
112         switch (entry->msi_attrib.type) {
113         case PCI_CAP_ID_MSI:
114                 /* nothing to do */
115                 break;
116         case PCI_CAP_ID_MSIX:
117         {
118                 int offset = entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
119                         PCI_MSIX_ENTRY_VECTOR_CTRL_OFFSET;
120                 readl(entry->mask_base + offset);
121                 break;
122         }
123         default:
124                 BUG();
125                 break;
126         }
127 }
128
129 /*
130  * PCI 2.3 does not specify mask bits for each MSI interrupt.  Attempting to
131  * mask all MSI interrupts by clearing the MSI enable bit does not work
132  * reliably as devices without an INTx disable bit will then generate a
133  * level IRQ which will never be cleared.
134  *
135  * Returns 1 if it succeeded in masking the interrupt and 0 if the device
136  * doesn't support MSI masking.
137  */
138 static int msi_set_mask_bits(struct irq_desc *desc, u32 mask, u32 flag)
139 {
140         struct msi_desc *entry;
141
142         entry = get_irq_desc_msi(desc);
143         BUG_ON(!entry || !entry->dev);
144         switch (entry->msi_attrib.type) {
145         case PCI_CAP_ID_MSI:
146                 if (entry->msi_attrib.maskbit) {
147                         int pos;
148                         u32 mask_bits;
149
150                         pos = (long)entry->mask_base;
151                         pci_read_config_dword(entry->dev, pos, &mask_bits);
152                         mask_bits &= ~(mask);
153                         mask_bits |= flag & mask;
154                         pci_write_config_dword(entry->dev, pos, mask_bits);
155                 } else {
156                         return 0;
157                 }
158                 break;
159         case PCI_CAP_ID_MSIX:
160         {
161                 int offset = entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE +
162                         PCI_MSIX_ENTRY_VECTOR_CTRL_OFFSET;
163                 writel(flag, entry->mask_base + offset);
164                 readl(entry->mask_base + offset);
165                 break;
166         }
167         default:
168                 BUG();
169                 break;
170         }
171         entry->msi_attrib.masked = !!flag;
172         return 1;
173 }
174
175 void read_msi_msg_desc(struct irq_desc *desc, struct msi_msg *msg)
176 {
177         struct msi_desc *entry = get_irq_desc_msi(desc);
178         switch(entry->msi_attrib.type) {
179         case PCI_CAP_ID_MSI:
180         {
181                 struct pci_dev *dev = entry->dev;
182                 int pos = entry->msi_attrib.pos;
183                 u16 data;
184
185                 pci_read_config_dword(dev, msi_lower_address_reg(pos),
186                                         &msg->address_lo);
187                 if (entry->msi_attrib.is_64) {
188                         pci_read_config_dword(dev, msi_upper_address_reg(pos),
189                                                 &msg->address_hi);
190                         pci_read_config_word(dev, msi_data_reg(pos, 1), &data);
191                 } else {
192                         msg->address_hi = 0;
193                         pci_read_config_word(dev, msi_data_reg(pos, 0), &data);
194                 }
195                 msg->data = data;
196                 break;
197         }
198         case PCI_CAP_ID_MSIX:
199         {
200                 void __iomem *base;
201                 base = entry->mask_base +
202                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
203
204                 msg->address_lo = readl(base + PCI_MSIX_ENTRY_LOWER_ADDR_OFFSET);
205                 msg->address_hi = readl(base + PCI_MSIX_ENTRY_UPPER_ADDR_OFFSET);
206                 msg->data = readl(base + PCI_MSIX_ENTRY_DATA_OFFSET);
207                 break;
208         }
209         default:
210                 BUG();
211         }
212 }
213
214 void read_msi_msg(unsigned int irq, struct msi_msg *msg)
215 {
216         struct irq_desc *desc = irq_to_desc(irq);
217
218         read_msi_msg_desc(desc, msg);
219 }
220
221 void write_msi_msg_desc(struct irq_desc *desc, struct msi_msg *msg)
222 {
223         struct msi_desc *entry = get_irq_desc_msi(desc);
224         switch (entry->msi_attrib.type) {
225         case PCI_CAP_ID_MSI:
226         {
227                 struct pci_dev *dev = entry->dev;
228                 int pos = entry->msi_attrib.pos;
229
230                 pci_write_config_dword(dev, msi_lower_address_reg(pos),
231                                         msg->address_lo);
232                 if (entry->msi_attrib.is_64) {
233                         pci_write_config_dword(dev, msi_upper_address_reg(pos),
234                                                 msg->address_hi);
235                         pci_write_config_word(dev, msi_data_reg(pos, 1),
236                                                 msg->data);
237                 } else {
238                         pci_write_config_word(dev, msi_data_reg(pos, 0),
239                                                 msg->data);
240                 }
241                 break;
242         }
243         case PCI_CAP_ID_MSIX:
244         {
245                 void __iomem *base;
246                 base = entry->mask_base +
247                         entry->msi_attrib.entry_nr * PCI_MSIX_ENTRY_SIZE;
248
249                 writel(msg->address_lo,
250                         base + PCI_MSIX_ENTRY_LOWER_ADDR_OFFSET);
251                 writel(msg->address_hi,
252                         base + PCI_MSIX_ENTRY_UPPER_ADDR_OFFSET);
253                 writel(msg->data, base + PCI_MSIX_ENTRY_DATA_OFFSET);
254                 break;
255         }
256         default:
257                 BUG();
258         }
259         entry->msg = *msg;
260 }
261
262 void write_msi_msg(unsigned int irq, struct msi_msg *msg)
263 {
264         struct irq_desc *desc = irq_to_desc(irq);
265
266         write_msi_msg_desc(desc, msg);
267 }
268
269 void mask_msi_irq(unsigned int irq)
270 {
271         struct irq_desc *desc = irq_to_desc(irq);
272
273         msi_set_mask_bits(desc, 1, 1);
274         msix_flush_writes(desc);
275 }
276
277 void unmask_msi_irq(unsigned int irq)
278 {
279         struct irq_desc *desc = irq_to_desc(irq);
280
281         msi_set_mask_bits(desc, 1, 0);
282         msix_flush_writes(desc);
283 }
284
285 static int msi_free_irqs(struct pci_dev* dev);
286
287 static struct msi_desc* alloc_msi_entry(void)
288 {
289         struct msi_desc *entry;
290
291         entry = kzalloc(sizeof(struct msi_desc), GFP_KERNEL);
292         if (!entry)
293                 return NULL;
294
295         INIT_LIST_HEAD(&entry->list);
296         entry->irq = 0;
297         entry->dev = NULL;
298
299         return entry;
300 }
301
302 static void pci_intx_for_msi(struct pci_dev *dev, int enable)
303 {
304         if (!(dev->dev_flags & PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG))
305                 pci_intx(dev, enable);
306 }
307
308 static void __pci_restore_msi_state(struct pci_dev *dev)
309 {
310         int pos;
311         u16 control;
312         struct msi_desc *entry;
313
314         if (!dev->msi_enabled)
315                 return;
316
317         entry = get_irq_msi(dev->irq);
318         pos = entry->msi_attrib.pos;
319
320         pci_intx_for_msi(dev, 0);
321         msi_set_enable(dev, 0);
322         write_msi_msg(dev->irq, &entry->msg);
323         if (entry->msi_attrib.maskbit) {
324                 struct irq_desc *desc = irq_to_desc(dev->irq);
325                 msi_set_mask_bits(desc, entry->msi_attrib.maskbits_mask,
326                                   entry->msi_attrib.masked);
327         }
328
329         pci_read_config_word(dev, pos + PCI_MSI_FLAGS, &control);
330         control &= ~PCI_MSI_FLAGS_QSIZE;
331         control |= PCI_MSI_FLAGS_ENABLE;
332         pci_write_config_word(dev, pos + PCI_MSI_FLAGS, control);
333 }
334
335 static void __pci_restore_msix_state(struct pci_dev *dev)
336 {
337         int pos;
338         struct msi_desc *entry;
339         u16 control;
340
341         if (!dev->msix_enabled)
342                 return;
343
344         /* route the table */
345         pci_intx_for_msi(dev, 0);
346         msix_set_enable(dev, 0);
347
348         list_for_each_entry(entry, &dev->msi_list, list) {
349                 struct irq_desc *desc = irq_to_desc(entry->irq);
350                 write_msi_msg(entry->irq, &entry->msg);
351                 msi_set_mask_bits(desc, 1, entry->msi_attrib.masked);
352         }
353
354         BUG_ON(list_empty(&dev->msi_list));
355         entry = list_entry(dev->msi_list.next, struct msi_desc, list);
356         pos = entry->msi_attrib.pos;
357         pci_read_config_word(dev, pos + PCI_MSIX_FLAGS, &control);
358         control &= ~PCI_MSIX_FLAGS_MASKALL;
359         control |= PCI_MSIX_FLAGS_ENABLE;
360         pci_write_config_word(dev, pos + PCI_MSIX_FLAGS, control);
361 }
362
363 void pci_restore_msi_state(struct pci_dev *dev)
364 {
365         __pci_restore_msi_state(dev);
366         __pci_restore_msix_state(dev);
367 }
368 EXPORT_SYMBOL_GPL(pci_restore_msi_state);
369
370 /**
371  * msi_capability_init - configure device's MSI capability structure
372  * @dev: pointer to the pci_dev data structure of MSI device function
373  *
374  * Setup the MSI capability structure of device function with a single
375  * MSI irq, regardless of device function is capable of handling
376  * multiple messages. A return of zero indicates the successful setup
377  * of an entry zero with the new MSI irq or non-zero for otherwise.
378  **/
379 static int msi_capability_init(struct pci_dev *dev)
380 {
381         struct msi_desc *entry;
382         int pos, ret;
383         u16 control;
384
385         msi_set_enable(dev, 0); /* Ensure msi is disabled as I set it up */
386
387         pos = pci_find_capability(dev, PCI_CAP_ID_MSI);
388         pci_read_config_word(dev, msi_control_reg(pos), &control);
389         /* MSI Entry Initialization */
390         entry = alloc_msi_entry();
391         if (!entry)
392                 return -ENOMEM;
393
394         entry->msi_attrib.type = PCI_CAP_ID_MSI;
395         entry->msi_attrib.is_64 = is_64bit_address(control);
396         entry->msi_attrib.entry_nr = 0;
397         entry->msi_attrib.maskbit = is_mask_bit_support(control);
398         entry->msi_attrib.masked = 1;
399         entry->msi_attrib.default_irq = dev->irq;       /* Save IOAPIC IRQ */
400         entry->msi_attrib.pos = pos;
401         entry->dev = dev;
402         if (entry->msi_attrib.maskbit) {
403                 unsigned int base, maskbits, temp;
404
405                 base = msi_mask_bits_reg(pos, entry->msi_attrib.is_64);
406                 entry->mask_base = (void __iomem *)(long)base;
407
408                 /* All MSIs are unmasked by default, Mask them all */
409                 pci_read_config_dword(dev, base, &maskbits);
410                 temp = (1 << multi_msi_capable(control));
411                 temp = ((temp - 1) & ~temp);
412                 maskbits |= temp;
413                 pci_write_config_dword(dev, base, maskbits);
414                 entry->msi_attrib.maskbits_mask = temp;
415         }
416         list_add_tail(&entry->list, &dev->msi_list);
417
418         /* Configure MSI capability structure */
419         ret = arch_setup_msi_irqs(dev, 1, PCI_CAP_ID_MSI);
420         if (ret) {
421                 msi_free_irqs(dev);
422                 return ret;
423         }
424
425         /* Set MSI enabled bits  */
426         pci_intx_for_msi(dev, 0);
427         msi_set_enable(dev, 1);
428         dev->msi_enabled = 1;
429
430         dev->irq = entry->irq;
431         return 0;
432 }
433
434 /**
435  * msix_capability_init - configure device's MSI-X capability
436  * @dev: pointer to the pci_dev data structure of MSI-X device function
437  * @entries: pointer to an array of struct msix_entry entries
438  * @nvec: number of @entries
439  *
440  * Setup the MSI-X capability structure of device function with a
441  * single MSI-X irq. A return of zero indicates the successful setup of
442  * requested MSI-X entries with allocated irqs or non-zero for otherwise.
443  **/
444 static int msix_capability_init(struct pci_dev *dev,
445                                 struct msix_entry *entries, int nvec)
446 {
447         struct msi_desc *entry;
448         int pos, i, j, nr_entries, ret;
449         unsigned long phys_addr;
450         u32 table_offset;
451         u16 control;
452         u8 bir;
453         void __iomem *base;
454
455         msix_set_enable(dev, 0);/* Ensure msix is disabled as I set it up */
456
457         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
458         /* Request & Map MSI-X table region */
459         pci_read_config_word(dev, msi_control_reg(pos), &control);
460         nr_entries = multi_msix_capable(control);
461
462         pci_read_config_dword(dev, msix_table_offset_reg(pos), &table_offset);
463         bir = (u8)(table_offset & PCI_MSIX_FLAGS_BIRMASK);
464         table_offset &= ~PCI_MSIX_FLAGS_BIRMASK;
465         phys_addr = pci_resource_start (dev, bir) + table_offset;
466         base = ioremap_nocache(phys_addr, nr_entries * PCI_MSIX_ENTRY_SIZE);
467         if (base == NULL)
468                 return -ENOMEM;
469
470         /* MSI-X Table Initialization */
471         for (i = 0; i < nvec; i++) {
472                 entry = alloc_msi_entry();
473                 if (!entry)
474                         break;
475
476                 j = entries[i].entry;
477                 entry->msi_attrib.type = PCI_CAP_ID_MSIX;
478                 entry->msi_attrib.is_64 = 1;
479                 entry->msi_attrib.entry_nr = j;
480                 entry->msi_attrib.maskbit = 1;
481                 entry->msi_attrib.masked = 1;
482                 entry->msi_attrib.default_irq = dev->irq;
483                 entry->msi_attrib.pos = pos;
484                 entry->dev = dev;
485                 entry->mask_base = base;
486
487                 list_add_tail(&entry->list, &dev->msi_list);
488         }
489
490         ret = arch_setup_msi_irqs(dev, nvec, PCI_CAP_ID_MSIX);
491         if (ret) {
492                 int avail = 0;
493                 list_for_each_entry(entry, &dev->msi_list, list) {
494                         if (entry->irq != 0) {
495                                 avail++;
496                         }
497                 }
498
499                 msi_free_irqs(dev);
500
501                 /* If we had some success report the number of irqs
502                  * we succeeded in setting up.
503                  */
504                 if (avail == 0)
505                         avail = ret;
506                 return avail;
507         }
508
509         i = 0;
510         list_for_each_entry(entry, &dev->msi_list, list) {
511                 entries[i].vector = entry->irq;
512                 set_irq_msi(entry->irq, entry);
513                 i++;
514         }
515         /* Set MSI-X enabled bits */
516         pci_intx_for_msi(dev, 0);
517         msix_set_enable(dev, 1);
518         dev->msix_enabled = 1;
519
520         return 0;
521 }
522
523 /**
524  * pci_msi_check_device - check whether MSI may be enabled on a device
525  * @dev: pointer to the pci_dev data structure of MSI device function
526  * @nvec: how many MSIs have been requested ?
527  * @type: are we checking for MSI or MSI-X ?
528  *
529  * Look at global flags, the device itself, and its parent busses
530  * to determine if MSI/-X are supported for the device. If MSI/-X is
531  * supported return 0, else return an error code.
532  **/
533 static int pci_msi_check_device(struct pci_dev* dev, int nvec, int type)
534 {
535         struct pci_bus *bus;
536         int ret;
537
538         /* MSI must be globally enabled and supported by the device */
539         if (!pci_msi_enable || !dev || dev->no_msi)
540                 return -EINVAL;
541
542         /*
543          * You can't ask to have 0 or less MSIs configured.
544          *  a) it's stupid ..
545          *  b) the list manipulation code assumes nvec >= 1.
546          */
547         if (nvec < 1)
548                 return -ERANGE;
549
550         /* Any bridge which does NOT route MSI transactions from it's
551          * secondary bus to it's primary bus must set NO_MSI flag on
552          * the secondary pci_bus.
553          * We expect only arch-specific PCI host bus controller driver
554          * or quirks for specific PCI bridges to be setting NO_MSI.
555          */
556         for (bus = dev->bus; bus; bus = bus->parent)
557                 if (bus->bus_flags & PCI_BUS_FLAGS_NO_MSI)
558                         return -EINVAL;
559
560         ret = arch_msi_check_device(dev, nvec, type);
561         if (ret)
562                 return ret;
563
564         if (!pci_find_capability(dev, type))
565                 return -EINVAL;
566
567         return 0;
568 }
569
570 /**
571  * pci_enable_msi - configure device's MSI capability structure
572  * @dev: pointer to the pci_dev data structure of MSI device function
573  *
574  * Setup the MSI capability structure of device function with
575  * a single MSI irq upon its software driver call to request for
576  * MSI mode enabled on its hardware device function. A return of zero
577  * indicates the successful setup of an entry zero with the new MSI
578  * irq or non-zero for otherwise.
579  **/
580 int pci_enable_msi(struct pci_dev* dev)
581 {
582         int status;
583
584         status = pci_msi_check_device(dev, 1, PCI_CAP_ID_MSI);
585         if (status)
586                 return status;
587
588         WARN_ON(!!dev->msi_enabled);
589
590         /* Check whether driver already requested for MSI-X irqs */
591         if (dev->msix_enabled) {
592                 dev_info(&dev->dev, "can't enable MSI "
593                          "(MSI-X already enabled)\n");
594                 return -EINVAL;
595         }
596         status = msi_capability_init(dev);
597         return status;
598 }
599 EXPORT_SYMBOL(pci_enable_msi);
600
601 void pci_msi_shutdown(struct pci_dev* dev)
602 {
603         struct msi_desc *entry;
604
605         if (!pci_msi_enable || !dev || !dev->msi_enabled)
606                 return;
607
608         msi_set_enable(dev, 0);
609         pci_intx_for_msi(dev, 1);
610         dev->msi_enabled = 0;
611
612         BUG_ON(list_empty(&dev->msi_list));
613         entry = list_entry(dev->msi_list.next, struct msi_desc, list);
614         /* Return the the pci reset with msi irqs unmasked */
615         if (entry->msi_attrib.maskbit) {
616                 u32 mask = entry->msi_attrib.maskbits_mask;
617                 struct irq_desc *desc = irq_to_desc(dev->irq);
618                 msi_set_mask_bits(desc, mask, ~mask);
619         }
620         if (!entry->dev || entry->msi_attrib.type != PCI_CAP_ID_MSI)
621                 return;
622
623         /* Restore dev->irq to its default pin-assertion irq */
624         dev->irq = entry->msi_attrib.default_irq;
625 }
626 void pci_disable_msi(struct pci_dev* dev)
627 {
628         struct msi_desc *entry;
629
630         if (!pci_msi_enable || !dev || !dev->msi_enabled)
631                 return;
632
633         pci_msi_shutdown(dev);
634
635         entry = list_entry(dev->msi_list.next, struct msi_desc, list);
636         if (!entry->dev || entry->msi_attrib.type != PCI_CAP_ID_MSI)
637                 return;
638
639         msi_free_irqs(dev);
640 }
641 EXPORT_SYMBOL(pci_disable_msi);
642
643 static int msi_free_irqs(struct pci_dev* dev)
644 {
645         struct msi_desc *entry, *tmp;
646
647         list_for_each_entry(entry, &dev->msi_list, list) {
648                 if (entry->irq)
649                         BUG_ON(irq_has_action(entry->irq));
650         }
651
652         arch_teardown_msi_irqs(dev);
653
654         list_for_each_entry_safe(entry, tmp, &dev->msi_list, list) {
655                 if (entry->msi_attrib.type == PCI_CAP_ID_MSIX) {
656                         writel(1, entry->mask_base + entry->msi_attrib.entry_nr
657                                   * PCI_MSIX_ENTRY_SIZE
658                                   + PCI_MSIX_ENTRY_VECTOR_CTRL_OFFSET);
659
660                         if (list_is_last(&entry->list, &dev->msi_list))
661                                 iounmap(entry->mask_base);
662                 }
663                 list_del(&entry->list);
664                 kfree(entry);
665         }
666
667         return 0;
668 }
669
670 /**
671  * pci_enable_msix - configure device's MSI-X capability structure
672  * @dev: pointer to the pci_dev data structure of MSI-X device function
673  * @entries: pointer to an array of MSI-X entries
674  * @nvec: number of MSI-X irqs requested for allocation by device driver
675  *
676  * Setup the MSI-X capability structure of device function with the number
677  * of requested irqs upon its software driver call to request for
678  * MSI-X mode enabled on its hardware device function. A return of zero
679  * indicates the successful configuration of MSI-X capability structure
680  * with new allocated MSI-X irqs. A return of < 0 indicates a failure.
681  * Or a return of > 0 indicates that driver request is exceeding the number
682  * of irqs available. Driver should use the returned value to re-send
683  * its request.
684  **/
685 int pci_enable_msix(struct pci_dev* dev, struct msix_entry *entries, int nvec)
686 {
687         int status, pos, nr_entries;
688         int i, j;
689         u16 control;
690
691         if (!entries)
692                 return -EINVAL;
693
694         status = pci_msi_check_device(dev, nvec, PCI_CAP_ID_MSIX);
695         if (status)
696                 return status;
697
698         pos = pci_find_capability(dev, PCI_CAP_ID_MSIX);
699         pci_read_config_word(dev, msi_control_reg(pos), &control);
700         nr_entries = multi_msix_capable(control);
701         if (nvec > nr_entries)
702                 return -EINVAL;
703
704         /* Check for any invalid entries */
705         for (i = 0; i < nvec; i++) {
706                 if (entries[i].entry >= nr_entries)
707                         return -EINVAL;         /* invalid entry */
708                 for (j = i + 1; j < nvec; j++) {
709                         if (entries[i].entry == entries[j].entry)
710                                 return -EINVAL; /* duplicate entry */
711                 }
712         }
713         WARN_ON(!!dev->msix_enabled);
714
715         /* Check whether driver already requested for MSI irq */
716         if (dev->msi_enabled) {
717                 dev_info(&dev->dev, "can't enable MSI-X "
718                        "(MSI IRQ already assigned)\n");
719                 return -EINVAL;
720         }
721         status = msix_capability_init(dev, entries, nvec);
722         return status;
723 }
724 EXPORT_SYMBOL(pci_enable_msix);
725
726 static void msix_free_all_irqs(struct pci_dev *dev)
727 {
728         msi_free_irqs(dev);
729 }
730
731 void pci_msix_shutdown(struct pci_dev* dev)
732 {
733         if (!pci_msi_enable || !dev || !dev->msix_enabled)
734                 return;
735
736         msix_set_enable(dev, 0);
737         pci_intx_for_msi(dev, 1);
738         dev->msix_enabled = 0;
739 }
740 void pci_disable_msix(struct pci_dev* dev)
741 {
742         if (!pci_msi_enable || !dev || !dev->msix_enabled)
743                 return;
744
745         pci_msix_shutdown(dev);
746
747         msix_free_all_irqs(dev);
748 }
749 EXPORT_SYMBOL(pci_disable_msix);
750
751 /**
752  * msi_remove_pci_irq_vectors - reclaim MSI(X) irqs to unused state
753  * @dev: pointer to the pci_dev data structure of MSI(X) device function
754  *
755  * Being called during hotplug remove, from which the device function
756  * is hot-removed. All previous assigned MSI/MSI-X irqs, if
757  * allocated for this device function, are reclaimed to unused state,
758  * which may be used later on.
759  **/
760 void msi_remove_pci_irq_vectors(struct pci_dev* dev)
761 {
762         if (!pci_msi_enable || !dev)
763                 return;
764
765         if (dev->msi_enabled)
766                 msi_free_irqs(dev);
767
768         if (dev->msix_enabled)
769                 msix_free_all_irqs(dev);
770 }
771
772 void pci_no_msi(void)
773 {
774         pci_msi_enable = 0;
775 }
776
777 /**
778  * pci_msi_enabled - is MSI enabled?
779  *
780  * Returns true if MSI has not been disabled by the command-line option
781  * pci=nomsi.
782  **/
783 int pci_msi_enabled(void)
784 {
785         return pci_msi_enable;
786 }
787 EXPORT_SYMBOL(pci_msi_enabled);
788
789 void pci_msi_init_pci_dev(struct pci_dev *dev)
790 {
791         INIT_LIST_HEAD(&dev->msi_list);
792 }