/* * This header file contains MSI data structures and functions which are * only relevant for: * - Interrupt core code * - PCI/MSI core code * - MSI interrupt domain implementations * - IOMMU, low level VFIO, NTB and other justified exceptions * dealing with low level MSI details. * * Regular device drivers have no business with any of these functions and * especially storing MSI descriptor pointers in random code is considered * abuse. * * Device driver relevant functions are available in <linux/msi_api.h>
*/
/* Dummy shadow structures if an architecture does not define them */ #ifndef arch_msi_msg_addr_lo typedefstruct arch_msi_msg_addr_lo {
u32 address_lo;
} __attribute__ ((packed)) arch_msi_msg_addr_lo_t; #endif
/** * pci_msi_desc - PCI/MSI specific MSI descriptor data * * @msi_mask: [PCI MSI] MSI cached mask bits * @msix_ctrl: [PCI MSI-X] MSI-X cached per vector control bits * @is_msix: [PCI MSI/X] True if MSI-X * @multiple: [PCI MSI/X] log2 num of messages allocated * @multi_cap: [PCI MSI/X] log2 num of messages supported * @can_mask: [PCI MSI/X] Masking supported? * @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq * @mask_pos: [PCI MSI] Mask register position * @mask_base: [PCI MSI-X] Mask register base address
*/ struct pci_msi_desc { union {
u32 msi_mask;
u32 msix_ctrl;
}; struct {
u8 is_msix : 1;
u8 multiple : 3;
u8 multi_cap : 3;
u8 can_mask : 1;
u8 is_64 : 1;
u8 is_virtual : 1; unsigned default_irq;
} msi_attrib; union {
u8 mask_pos; void __iomem *mask_base;
};
};
/** * union msi_domain_cookie - Opaque MSI domain specific data * @value: u64 value store * @ptr: Pointer to domain specific data * @iobase: Domain specific IOmem pointer * * The content of this data is implementation defined and used by the MSI * domain to store domain specific information which is requried for * interrupt chip callbacks.
*/ union msi_domain_cookie {
u64 value; void *ptr; void __iomem *iobase;
};
/** * struct msi_desc_data - Generic MSI descriptor data * @dcookie: Cookie for MSI domain specific data which is required * for irq_chip callbacks * @icookie: Cookie for the MSI interrupt instance provided by * the usage site to the allocation function * * The content of this data is implementation defined, e.g. PCI/IMS * implementations define the meaning of the data. The MSI core ignores * this data completely.
*/ struct msi_desc_data { union msi_domain_cookie dcookie; union msi_instance_cookie icookie;
};
#define MSI_MAX_INDEX ((unsignedint)USHRT_MAX)
/** * struct msi_desc - Descriptor structure for MSI based interrupts * @irq: The base interrupt number * @nvec_used: The number of vectors used * @dev: Pointer to the device which uses this descriptor * @msg: The last set MSI message cached for reuse * @affinity: Optional pointer to a cpu affinity mask for this descriptor * @iommu_msi_iova: Optional shifted IOVA from the IOMMU to override the msi_addr. * Only used if iommu_msi_shift != 0 * @iommu_msi_shift: Indicates how many bits of the original address should be * preserved when using iommu_msi_iova. * @sysfs_attr: Pointer to sysfs device attribute * * @write_msi_msg: Callback that may be called when the MSI message * address or data changes * @write_msi_msg_data: Data parameter for the callback. * * @msi_index: Index of the msi descriptor * @pci: PCI specific msi descriptor data * @data: Generic MSI descriptor data
*/ struct msi_desc { /* Shared device/bus type independent data */ unsignedint irq; unsignedint nvec_used; struct device *dev; struct msi_msg msg; struct irq_affinity_desc *affinity; #ifdef CONFIG_IRQ_MSI_IOMMU
u64 iommu_msi_iova : 58;
u64 iommu_msi_shift : 6; #endif #ifdef CONFIG_SYSFS struct device_attribute *sysfs_attrs; #endif
/* * Filter values for the MSI descriptor iterators and accessor functions.
*/ enum msi_desc_filter { /* All descriptors */
MSI_DESC_ALL, /* Descriptors which have no interrupt associated */
MSI_DESC_NOTASSOCIATED, /* Descriptors which have an interrupt associated */
MSI_DESC_ASSOCIATED,
};
/** * struct msi_dev_domain - The internals of MSI domain info per device * @store: Xarray for storing MSI descriptor pointers * @irqdomain: Pointer to a per device interrupt domain
*/ struct msi_dev_domain { struct xarray store; struct irq_domain *domain;
};
/** * msi_first_desc - Get the first MSI descriptor of the default irqdomain * @dev: Device to operate on * @filter: Descriptor state filter * * Must be called with the MSI descriptor mutex held, i.e. msi_lock_descs() * must be invoked before the call. * * Return: Pointer to the first MSI descriptor matching the search * criteria, NULL if none found.
*/ staticinlinestruct msi_desc *msi_first_desc(struct device *dev, enum msi_desc_filter filter)
{ return msi_domain_first_desc(dev, MSI_DEFAULT_DOMAIN, filter);
}
/** * msi_domain_for_each_desc - Iterate the MSI descriptors in a specific domain * * @desc: struct msi_desc pointer used as iterator * @dev: struct device pointer - device to iterate * @domid: The id of the interrupt domain which should be walked. * @filter: Filter for descriptor selection * * Notes: * - The loop must be protected with a msi_lock_descs()/msi_unlock_descs() * pair. * - It is safe to remove a retrieved MSI descriptor in the loop.
*/ #define msi_domain_for_each_desc(desc, dev, domid, filter) \ for ((desc) = msi_domain_first_desc((dev), (domid), (filter)); (desc); \
(desc) = msi_next_desc((dev), (domid), (filter)))
/** * msi_for_each_desc - Iterate the MSI descriptors in the default irqdomain * * @desc: struct msi_desc pointer used as iterator * @dev: struct device pointer - device to iterate * @filter: Filter for descriptor selection * * Notes: * - The loop must be protected with a msi_lock_descs()/msi_unlock_descs() * pair. * - It is safe to remove a retrieved MSI descriptor in the loop.
*/ #define msi_for_each_desc(desc, dev, filter) \
msi_domain_for_each_desc((desc), (dev), MSI_DEFAULT_DOMAIN, (filter))
/** * msi_msg_set_addr() - Set MSI address in an MSI message * * @desc: MSI descriptor that may carry an IOVA base address for MSI via @iommu_msi_iova/shift * @msg: Target MSI message to set its address_hi and address_lo * @msi_addr: Physical address to set the MSI message * * Notes: * - Override @msi_addr using the IOVA base address in the @desc if @iommu_msi_shift is set * - Otherwise, simply set @msi_addr to @msg
*/ staticinlinevoid msi_msg_set_addr(struct msi_desc *desc, struct msi_msg *msg,
phys_addr_t msi_addr)
{ #ifdef CONFIG_IRQ_MSI_IOMMU if (desc->iommu_msi_shift) {
u64 msi_iova = desc->iommu_msi_iova << desc->iommu_msi_shift;
int msi_domain_insert_msi_desc(struct device *dev, unsignedint domid, struct msi_desc *init_desc); /** * msi_insert_msi_desc - Allocate and initialize a MSI descriptor in the * default irqdomain and insert it at @init_desc->msi_index * @dev: Pointer to the device for which the descriptor is allocated * @init_desc: Pointer to an MSI descriptor to initialize the new descriptor * * Return: 0 on success or an appropriate failure code.
*/ staticinlineint msi_insert_msi_desc(struct device *dev, struct msi_desc *init_desc)
{ return msi_domain_insert_msi_desc(dev, MSI_DEFAULT_DOMAIN, init_desc);
}
/** * msi_free_msi_descs_range - Free a range of MSI descriptors of a device * in the default irqdomain * * @dev: Device for which to free the descriptors * @first: Index to start freeing from (inclusive) * @last: Last index to be freed (inclusive)
*/ staticinlinevoid msi_free_msi_descs_range(struct device *dev, unsignedint first, unsignedint last)
{
msi_domain_free_msi_descs_range(dev, MSI_DEFAULT_DOMAIN, first, last);
}
/** * msi_free_msi_descs - Free all MSI descriptors of a device in the default irqdomain * @dev: Device to free the descriptors
*/ staticinlinevoid msi_free_msi_descs(struct device *dev)
{
msi_free_msi_descs_range(dev, 0, MSI_MAX_INDEX);
}
/* * The arch hooks to setup up msi irqs. Default functions are implemented * as weak symbols so that they /can/ be overriden by architecture specific * code if needed. These hooks can only be enabled by the architecture. * * If CONFIG_PCI_MSI_ARCH_FALLBACKS is not selected they are replaced by * stubs with warnings.
*/ #ifdef CONFIG_PCI_MSI_ARCH_FALLBACKS int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc); void arch_teardown_msi_irq(unsignedint irq); int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type); void arch_teardown_msi_irqs(struct pci_dev *dev); #endif/* CONFIG_PCI_MSI_ARCH_FALLBACKS */
/* * Xen uses non-default msi_domain_ops and hence needs a way to populate sysfs * entries of MSI IRQs.
*/ #ifdefined(CONFIG_PCI_XEN) || defined(CONFIG_PCI_MSI_ARCH_FALLBACKS) #ifdef CONFIG_SYSFS int msi_device_populate_sysfs(struct device *dev); void msi_device_destroy_sysfs(struct device *dev); #else/* CONFIG_SYSFS */ staticinlineint msi_device_populate_sysfs(struct device *dev) { return 0; } staticinlinevoid msi_device_destroy_sysfs(struct device *dev) { } #endif/* !CONFIG_SYSFS */ #endif/* CONFIG_PCI_XEN || CONFIG_PCI_MSI_ARCH_FALLBACKS */
/* * The restore hook is still available even for fully irq domain based * setups. Courtesy to XEN/X86.
*/ bool arch_restore_msi_irqs(struct pci_dev *dev);
/** * struct msi_domain_ops - MSI interrupt domain callbacks * @get_hwirq: Retrieve the resulting hw irq number * @msi_init: Domain specific init function for MSI interrupts * @msi_free: Domain specific function to free a MSI interrupts * @msi_prepare: Prepare the allocation of the interrupts in the domain * @msi_teardown: Reverse the effects of @msi_prepare * @prepare_desc: Optional function to prepare the allocated MSI descriptor * in the domain * @set_desc: Set the msi descriptor for an interrupt * @domain_alloc_irqs: Optional function to override the default allocation * function. * @domain_free_irqs: Optional function to override the default free * function. * @msi_post_free: Optional function which is invoked after freeing * all interrupts. * @msi_translate: Optional translate callback to support the odd wire to * MSI bridges, e.g. MBIGEN * * @get_hwirq, @msi_init and @msi_free are callbacks used by the underlying * irqdomain. * * @msi_check, @msi_prepare, @msi_teardown, @prepare_desc and * @set_desc are callbacks used by the msi_domain_alloc/free_irqs*() * variants. * * @domain_alloc_irqs, @domain_free_irqs can be used to override the * default allocation/free functions (__msi_domain_alloc/free_irqs). This * is initially for a wrapper around XENs seperate MSI universe which can't * be wrapped into the regular irq domains concepts by mere mortals. This * allows to universally use msi_domain_alloc/free_irqs without having to * special case XEN all over the place.
*/ struct msi_domain_ops {
irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
msi_alloc_info_t *arg); int (*msi_init)(struct irq_domain *domain, struct msi_domain_info *info, unsignedint virq, irq_hw_number_t hwirq,
msi_alloc_info_t *arg); void (*msi_free)(struct irq_domain *domain, struct msi_domain_info *info, unsignedint virq); int (*msi_prepare)(struct irq_domain *domain, struct device *dev, int nvec,
msi_alloc_info_t *arg); void (*msi_teardown)(struct irq_domain *domain,
msi_alloc_info_t *arg); void (*prepare_desc)(struct irq_domain *domain, msi_alloc_info_t *arg, struct msi_desc *desc); void (*set_desc)(msi_alloc_info_t *arg, struct msi_desc *desc); int (*domain_alloc_irqs)(struct irq_domain *domain, struct device *dev, int nvec); void (*domain_free_irqs)(struct irq_domain *domain, struct device *dev); void (*msi_post_free)(struct irq_domain *domain, struct device *dev); int (*msi_translate)(struct irq_domain *domain, struct irq_fwspec *fwspec,
irq_hw_number_t *hwirq, unsignedint *type);
};
/** * struct msi_domain_info - MSI interrupt domain data * @flags: Flags to decribe features and capabilities * @bus_token: The domain bus token * @hwsize: The hardware table size or the software index limit. * If 0 then the size is considered unlimited and * gets initialized to the maximum software index limit * by the domain creation code. * @ops: The callback data structure * @dev: Device which creates the domain * @chip: Optional: associated interrupt chip * @chip_data: Optional: associated interrupt chip data * @handler: Optional: associated interrupt flow handler * @handler_data: Optional: associated interrupt flow handler data * @handler_name: Optional: associated interrupt flow handler name * @alloc_data: Optional: associated interrupt allocation data * @data: Optional: domain specific data
*/ struct msi_domain_info {
u32 flags; enum irq_domain_bus_token bus_token; unsignedint hwsize; struct msi_domain_ops *ops; struct device *dev; struct irq_chip *chip; void *chip_data;
irq_flow_handler_t handler; void *handler_data; constchar *handler_name;
msi_alloc_info_t *alloc_data; void *data;
};
/** * struct msi_domain_template - Template for MSI device domains * @name: Storage for the resulting name. Filled in by the core. * @chip: Interrupt chip for this domain * @ops: MSI domain ops * @info: MSI domain info data * @alloc_info: MSI domain allocation data (architecture specific)
*/ struct msi_domain_template { char name[48]; struct irq_chip chip; struct msi_domain_ops ops; struct msi_domain_info info;
msi_alloc_info_t alloc_info;
};
/* * Flags for msi_domain_info * * Bit 0-15: Generic MSI functionality which is not subject to restriction * by parent domains * * Bit 16-31: Functionality which depends on the underlying parent domain and * can be masked out by msi_parent_ops::init_dev_msi_info() when * a device MSI domain is initialized.
*/ enum { /* * Init non implemented ops callbacks with default MSI domain * callbacks.
*/
MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0), /* * Init non implemented chip callbacks with default MSI chip * callbacks.
*/
MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1), /* Needs early activate, required for PCI */
MSI_FLAG_ACTIVATE_EARLY = (1 << 2), /* * Must reactivate when irq is started even when * MSI_FLAG_ACTIVATE_EARLY has been set.
*/
MSI_FLAG_MUST_REACTIVATE = (1 << 3), /* Populate sysfs on alloc() and destroy it on free() */
MSI_FLAG_DEV_SYSFS = (1 << 4), /* Allocate simple MSI descriptors */
MSI_FLAG_ALLOC_SIMPLE_MSI_DESCS = (1 << 5), /* Free MSI descriptors */
MSI_FLAG_FREE_MSI_DESCS = (1 << 6), /* Use dev->fwnode for MSI device domain creation */
MSI_FLAG_USE_DEV_FWNODE = (1 << 7), /* Set parent->dev into domain->pm_dev on device domain creation */
MSI_FLAG_PARENT_PM_DEV = (1 << 8), /* Support for parent mask/unmask */
MSI_FLAG_PCI_MSI_MASK_PARENT = (1 << 9), /* Support for parent startup/shutdown */
MSI_FLAG_PCI_MSI_STARTUP_PARENT = (1 << 10),
/* Mask for the generic functionality */
MSI_GENERIC_FLAGS_MASK = GENMASK(15, 0),
/* Mask for the domain specific functionality */
MSI_DOMAIN_FLAGS_MASK = GENMASK(31, 16),
/* Support multiple PCI MSI interrupts */
MSI_FLAG_MULTI_PCI_MSI = (1 << 16), /* Support PCI MSIX interrupts */
MSI_FLAG_PCI_MSIX = (1 << 17), /* Is level-triggered capable, using two messages */
MSI_FLAG_LEVEL_CAPABLE = (1 << 18), /* MSI-X entries must be contiguous */
MSI_FLAG_MSIX_CONTIGUOUS = (1 << 19), /* PCI/MSI-X vectors can be dynamically allocated/freed post MSI-X enable */
MSI_FLAG_PCI_MSIX_ALLOC_DYN = (1 << 20), /* PCI MSIs cannot be steered separately to CPU cores */
MSI_FLAG_NO_AFFINITY = (1 << 21), /* Inhibit usage of entry masking */
MSI_FLAG_NO_MASK = (1 << 22),
};
/** * struct msi_parent_ops - MSI parent domain callbacks and configuration info * * @supported_flags: Required: The supported MSI flags of the parent domain * @required_flags: Optional: The required MSI flags of the parent MSI domain * @chip_flags: Optional: Select MSI chip callbacks to update with defaults * in msi_lib_init_dev_msi_info(). * @bus_select_token: Optional: The bus token of the real parent domain for * irq_domain::select() * @bus_select_mask: Optional: A mask of supported BUS_DOMAINs for * irq_domain::select() * @prefix: Optional: Prefix for the domain and chip name * @init_dev_msi_info: Required: Callback for MSI parent domains to setup parent * domain specific domain flags, domain ops and interrupt chip * callbacks when a per device domain is created.
*/ struct msi_parent_ops {
u32 supported_flags;
u32 required_flags;
u32 chip_flags;
u32 bus_select_token;
u32 bus_select_mask; constchar *prefix; bool (*init_dev_msi_info)(struct device *dev, struct irq_domain *domain, struct irq_domain *msi_parent_domain, struct msi_domain_info *msi_child_info);
};
#else/* CONFIG_GENERIC_MSI_IRQ */ staticinlinebool msi_device_has_isolated_msi(struct device *dev)
{ /* * Arguably if the platform does not enable MSI support then it has * "isolated MSI", as an interrupt controller that cannot receive MSIs * is inherently isolated by our definition. The default definition for * arch_is_isolated_msi() is conservative and returns false anyhow.
*/ return arch_is_isolated_msi();
} #endif/* CONFIG_GENERIC_MSI_IRQ */
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.