4 #include <linux/kobject.h>
5 #include <linux/list.h>
8 u32 address_lo; /* low 32 bits of msi message address */
9 u32 address_hi; /* high 32 bits of msi message address */
10 u32 data; /* 16 bits of msi message data */
13 extern int pci_msi_ignore_mask;
14 /* Helper functions */
18 struct platform_msi_priv_data;
19 void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
20 void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
22 typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
26 * platform_msi_desc - Platform device specific msi descriptor data
27 * @msi_priv_data: Pointer to platform private data
28 * @msi_index: The index of the MSI descriptor for multi MSI
30 struct platform_msi_desc {
31 struct platform_msi_priv_data *msi_priv_data;
36 * struct msi_desc - Descriptor structure for MSI based interrupts
37 * @list: List head for management
38 * @irq: The base interrupt number
39 * @nvec_used: The number of vectors used
40 * @dev: Pointer to the device which uses this descriptor
41 * @msg: The last set MSI message cached for reuse
43 * @masked: [PCI MSI/X] Mask bits
44 * @is_msix: [PCI MSI/X] True if MSI-X
45 * @multiple: [PCI MSI/X] log2 num of messages allocated
46 * @multi_cap: [PCI MSI/X] log2 num of messages supported
47 * @maskbit: [PCI MSI/X] Mask-Pending bit supported?
48 * @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit
49 * @entry_nr: [PCI MSI/X] Entry which is described by this descriptor
50 * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
51 * @mask_pos: [PCI MSI] Mask register position
52 * @mask_base: [PCI MSI-X] Mask register base address
53 * @platform: [platform] Platform device specific msi descriptor data
56 /* Shared device/bus type independent data */
57 struct list_head list;
59 unsigned int nvec_used;
64 /* PCI MSI/X specific data */
78 void __iomem *mask_base;
83 * Non PCI variants add their data structure here. New
84 * entries need to use a named structure. We want
85 * proper name spaces for this. The PCI part is
86 * anonymous for now as it would require an immediate
89 struct platform_msi_desc platform;
93 /* Helpers to hide struct msi_desc implementation details */
94 #define msi_desc_to_dev(desc) ((desc)->dev)
95 #define dev_to_msi_list(dev) (&(dev)->msi_list)
96 #define first_msi_entry(dev) \
97 list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list)
98 #define for_each_msi_entry(desc, dev) \
99 list_for_each_entry((desc), dev_to_msi_list((dev)), list)
101 #ifdef CONFIG_PCI_MSI
102 #define first_pci_msi_entry(pdev) first_msi_entry(&(pdev)->dev)
103 #define for_each_pci_msi_entry(desc, pdev) \
104 for_each_msi_entry((desc), &(pdev)->dev)
106 struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
107 void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
108 #else /* CONFIG_PCI_MSI */
109 static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
113 #endif /* CONFIG_PCI_MSI */
115 struct msi_desc *alloc_msi_entry(struct device *dev);
116 void free_msi_entry(struct msi_desc *entry);
117 void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
118 void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
119 void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
121 u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
122 u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
123 void pci_msi_mask_irq(struct irq_data *data);
124 void pci_msi_unmask_irq(struct irq_data *data);
126 /* Conversion helpers. Should be removed after merging */
127 static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
129 __pci_write_msi_msg(entry, msg);
131 static inline void write_msi_msg(int irq, struct msi_msg *msg)
133 pci_write_msi_msg(irq, msg);
135 static inline void mask_msi_irq(struct irq_data *data)
137 pci_msi_mask_irq(data);
139 static inline void unmask_msi_irq(struct irq_data *data)
141 pci_msi_unmask_irq(data);
145 * The arch hooks to setup up msi irqs. Those functions are
146 * implemented as weak symbols so that they /can/ be overriden by
147 * architecture specific code if needed.
149 int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
150 void arch_teardown_msi_irq(unsigned int irq);
151 int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
152 void arch_teardown_msi_irqs(struct pci_dev *dev);
153 void arch_restore_msi_irqs(struct pci_dev *dev);
155 void default_teardown_msi_irqs(struct pci_dev *dev);
156 void default_restore_msi_irqs(struct pci_dev *dev);
158 struct msi_controller {
159 struct module *owner;
161 struct device_node *of_node;
162 struct list_head list;
164 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
165 struct msi_desc *desc);
166 int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev,
168 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
171 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
173 #include <linux/irqhandler.h>
177 struct irq_domain_ops;
180 struct fwnode_handle;
181 struct msi_domain_info;
184 * struct msi_domain_ops - MSI interrupt domain callbacks
185 * @get_hwirq: Retrieve the resulting hw irq number
186 * @msi_init: Domain specific init function for MSI interrupts
187 * @msi_free: Domain specific function to free a MSI interrupts
188 * @msi_check: Callback for verification of the domain/info/dev data
189 * @msi_prepare: Prepare the allocation of the interrupts in the domain
190 * @msi_finish: Optional callbacl to finalize the allocation
191 * @set_desc: Set the msi descriptor for an interrupt
192 * @handle_error: Optional error handler if the allocation fails
194 * @get_hwirq, @msi_init and @msi_free are callbacks used by
195 * msi_create_irq_domain() and related interfaces
197 * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
198 * are callbacks used by msi_irq_domain_alloc_irqs() and related
199 * interfaces which are based on msi_desc.
201 struct msi_domain_ops {
202 irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
203 msi_alloc_info_t *arg);
204 int (*msi_init)(struct irq_domain *domain,
205 struct msi_domain_info *info,
206 unsigned int virq, irq_hw_number_t hwirq,
207 msi_alloc_info_t *arg);
208 void (*msi_free)(struct irq_domain *domain,
209 struct msi_domain_info *info,
211 int (*msi_check)(struct irq_domain *domain,
212 struct msi_domain_info *info,
214 int (*msi_prepare)(struct irq_domain *domain,
215 struct device *dev, int nvec,
216 msi_alloc_info_t *arg);
217 void (*msi_finish)(msi_alloc_info_t *arg, int retval);
218 void (*set_desc)(msi_alloc_info_t *arg,
219 struct msi_desc *desc);
220 int (*handle_error)(struct irq_domain *domain,
221 struct msi_desc *desc, int error);
225 * struct msi_domain_info - MSI interrupt domain data
226 * @flags: Flags to decribe features and capabilities
227 * @ops: The callback data structure
228 * @chip: Optional: associated interrupt chip
229 * @chip_data: Optional: associated interrupt chip data
230 * @handler: Optional: associated interrupt flow handler
231 * @handler_data: Optional: associated interrupt flow handler data
232 * @handler_name: Optional: associated interrupt flow handler name
233 * @data: Optional: domain specific data
235 struct msi_domain_info {
237 struct msi_domain_ops *ops;
238 struct irq_chip *chip;
240 irq_flow_handler_t handler;
242 const char *handler_name;
246 /* Flags for msi_domain_info */
249 * Init non implemented ops callbacks with default MSI domain
252 MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0),
254 * Init non implemented chip callbacks with default MSI chip
257 MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1),
258 /* Build identity map between hwirq and irq */
259 MSI_FLAG_IDENTITY_MAP = (1 << 2),
260 /* Support multiple PCI MSI interrupts */
261 MSI_FLAG_MULTI_PCI_MSI = (1 << 3),
262 /* Support PCI MSIX interrupts */
263 MSI_FLAG_PCI_MSIX = (1 << 4),
266 int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
269 struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
270 struct msi_domain_info *info,
271 struct irq_domain *parent);
272 int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
274 void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
275 struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
277 struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
278 struct msi_domain_info *info,
279 struct irq_domain *parent);
280 int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
281 irq_write_msi_msg_t write_msi_msg);
282 void platform_msi_domain_free_irqs(struct device *dev);
284 /* When an MSI domain is used as an intermediate domain */
285 int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
286 int nvec, msi_alloc_info_t *args);
287 int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
288 int virq, int nvec, msi_alloc_info_t *args);
290 platform_msi_create_device_domain(struct device *dev,
292 irq_write_msi_msg_t write_msi_msg,
293 const struct irq_domain_ops *ops,
295 int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
296 unsigned int nr_irqs);
297 void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
299 void *platform_msi_get_host_data(struct irq_domain *domain);
300 #endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
302 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
303 void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
304 struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
305 struct msi_domain_info *info,
306 struct irq_domain *parent);
307 int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
309 void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev);
310 struct irq_domain *pci_msi_create_default_irq_domain(struct fwnode_handle *fwnode,
311 struct msi_domain_info *info, struct irq_domain *parent);
313 irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
314 struct msi_desc *desc);
315 int pci_msi_domain_check_cap(struct irq_domain *domain,
316 struct msi_domain_info *info, struct device *dev);
317 u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
318 struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
320 static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
324 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
326 #endif /* LINUX_MSI_H */