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