1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef LINUX_MSI_API_H
3 #define LINUX_MSI_API_H
6 * APIs which are relevant for device driver code for allocating and
7 * freeing MSI interrupts and querying the associations between
8 * hardware/software MSI indices and the Linux interrupt number.
14 * Per device interrupt domain related constants.
19 MSI_MAX_DEVICE_IRQDOMAINS,
23 * union msi_instance_cookie - MSI instance cookie
24 * @value: u64 value store
25 * @ptr: Pointer to usage site specific data
27 * This cookie is handed to the IMS allocation function and stored in the
28 * MSI descriptor for the interrupt chip callbacks.
30 * The content of this cookie is MSI domain implementation defined. For
31 * PCI/IMS implementations this could be a PASID or a pointer to queue
34 union msi_instance_cookie {
40 * msi_map - Mapping between MSI index and Linux interrupt number
41 * @index: The MSI index, e.g. slot in the MSI-X table or
42 * a software managed index if >= 0. If negative
43 * the allocation function failed and it contains
45 * @virq: The associated Linux interrupt number
53 * Constant to be used for dynamic allocations when the allocation is any
54 * free MSI index, which is either an entry in a hardware table or a
55 * software managed index.
57 #define MSI_ANY_INDEX UINT_MAX
59 unsigned int msi_domain_get_virq(struct device *dev, unsigned int domid, unsigned int index);
62 * msi_get_virq - Lookup the Linux interrupt number for a MSI index on the default interrupt domain
63 * @dev: Device for which the lookup happens
64 * @index: The MSI index to lookup
66 * Return: The Linux interrupt number on success (> 0), 0 if not found
68 static inline unsigned int msi_get_virq(struct device *dev, unsigned int index)
70 return msi_domain_get_virq(dev, MSI_DEFAULT_DOMAIN, index);