include/linux/msi.h

6  * This header file contains MSI data structures and functions which are
9  *	- PCI/MSI core code
10  *	- MSI interrupt domain implementations
12  *	  dealing with low level MSI details.
15  * especially storing MSI descriptor pointers in random code is considered
26 #include <asm/msi.h>
52  * msi_msg - Representation of a MSI message
53  * @address_lo:		Low 32 bits of msi message address
55  * @address_hi:		High 32 bits of msi message address
58  * @data:		MSI message data (usually 16 bits)
94  * pci_msi_desc - PCI/MSI specific MSI descriptor data
96  * @msi_mask:	[PCI MSI]   MSI cached mask bits
97  * @msix_ctrl:	[PCI MSI-X] MSI-X cached per vector control bits
98  * @is_msix:	[PCI MSI/X] True if MSI-X
99  * @multiple:	[PCI MSI/X] log2 num of messages allocated
100  * @multi_cap:	[PCI MSI/X] log2 num of messages supported
101  * @can_mask:	[PCI MSI/X] Masking supported?
102  * @is_64:	[PCI MSI/X] Address size: 0=32bit 1=64bit
103  * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
104  * @mask_pos:	[PCI MSI]   Mask register position
105  * @mask_base:	[PCI MSI-X] Mask register base address
128  * union msi_domain_cookie - Opaque MSI domain specific data
133  * The content of this data is implementation defined and used by the MSI
144  * struct msi_desc_data - Generic MSI descriptor data
145  * @dcookie:	Cookie for MSI domain specific data which is required
147  * @icookie:	Cookie for the MSI interrupt instance provided by
151  * implementations define the meaning of the data. The MSI core ignores
162  * struct msi_desc - Descriptor structure for MSI based interrupts
166  * @msg:	The last set MSI message cached for reuse
174  * @write_msi_msg:	Callback that may be called when the MSI message
178  * @msi_index:	Index of the msi descriptor
179  * @pci:	PCI specific msi descriptor data
180  * @data:	Generic MSI descriptor data
208  * Filter values for the MSI descriptor iterators and accessor functions.
221  * struct msi_dev_domain - The internals of MSI domain info per device
222  * @store:		Xarray for storing MSI descriptor pointers
239  * msi_first_desc - Get the first MSI descriptor of the default irqdomain
243  * Must be called with the MSI descriptor mutex held, i.e. msi_lock_descs()
246  * Return: Pointer to the first MSI descriptor matching the search
259  * msi_domain_for_each_desc - Iterate the MSI descriptors in a specific domain
269  *  - It is safe to remove a retrieved MSI descriptor in the loop.
276  * msi_for_each_desc - Iterate the MSI descriptors in the default irqdomain
285  *  - It is safe to remove a retrieved MSI descriptor in the loop.
302  * msi_msg_set_addr() - Set MSI address in an MSI message
304  * @desc:	MSI descriptor that may carry an IOVA base address for MSI via @iommu_msi_iova/shift
305  * @msg:	Target MSI message to set its address_hi and address_lo
306  * @msi_addr:	Physical address to set the MSI message
332  * msi_insert_msi_desc - Allocate and initialize a MSI descriptor in the
335  * @init_desc:	Pointer to an MSI descriptor to initialize the new descriptor
348  * msi_free_msi_descs_range - Free a range of MSI descriptors of a device
362  * msi_free_msi_descs - Free all MSI descriptors of a device in the default irqdomain
371  * The arch hooks to setup up msi irqs. Default functions are implemented
387  * entries of MSI IRQs.
418  * struct msi_domain_ops - MSI interrupt domain callbacks
420  * @msi_init:		Domain specific init function for MSI interrupts
421  * @msi_free:		Domain specific function to free a MSI interrupts
423  * @prepare_desc:	Optional function to prepare the allocated MSI descriptor
425  * @set_desc:		Set the msi descriptor for an interrupt
433  *			MSI bridges, e.g. MBIGEN
443  * is initially for a wrapper around XENs seperate MSI universe which can't
476  * struct msi_domain_info - MSI interrupt domain data
505  * struct msi_domain_template - Template for MSI device domains
508  * @ops:	MSI domain ops
509  * @info:	MSI domain info data
521  * Bit 0-15:	Generic MSI functionality which is not subject to restriction
526  *		a device MSI domain is initialized.
530 	 * Init non implemented ops callbacks with default MSI domain
535 	 * Init non implemented chip callbacks with default MSI chip
548 	/* Allocate simple MSI descriptors */
550 	/* Free MSI descriptors */
552 	/* Use dev->fwnode for MSI device domain creation */
565 	/* Support multiple PCI MSI interrupts */
571 	/* MSI-X entries must be contiguous */
573 	/* PCI/MSI-X vectors can be dynamically allocated/freed post MSI-X enable */
590  * struct msi_parent_ops - MSI parent domain callbacks and configuration info
592  * @supported_flags:	Required: The supported MSI flags of the parent domain
593  * @required_flags:	Optional: The required MSI flags of the parent MSI domain
594  * @chip_flags:		Optional: Select MSI chip callbacks to update with defaults
601  * @init_dev_msi_info:	Required: Callback for MSI parent domains to setup parent
656 /* Per device platform MSI */
672 	 * Arguably if the platform does not enable MSI support then it has  in msi_device_has_isolated_msi()
673 	 * "isolated MSI", as an interrupt controller that cannot receive MSIs  in msi_device_has_isolated_msi()