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