]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
3b7d1921 EB |
2 | #ifndef LINUX_MSI_H |
3 | #define LINUX_MSI_H | |
4 | ||
b50cac55 | 5 | #include <linux/kobject.h> |
4aa9bc95 ME |
6 | #include <linux/list.h> |
7 | ||
3b7d1921 EB |
8 | struct msi_msg { |
9 | u32 address_lo; /* low 32 bits of msi message address */ | |
10 | u32 address_hi; /* high 32 bits of msi message address */ | |
11 | u32 data; /* 16 bits of msi message data */ | |
12 | }; | |
13 | ||
38737d82 | 14 | extern int pci_msi_ignore_mask; |
c54c1879 | 15 | /* Helper functions */ |
1c9db525 | 16 | struct irq_data; |
39431acb | 17 | struct msi_desc; |
25a98bd4 | 18 | struct pci_dev; |
c09fcc4b | 19 | struct platform_msi_priv_data; |
2366d06e | 20 | void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg); |
2f44e29c | 21 | #ifdef CONFIG_GENERIC_MSI_IRQ |
2366d06e | 22 | void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg); |
2f44e29c AB |
23 | #else |
24 | static inline void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg) | |
25 | { | |
26 | } | |
27 | #endif | |
891d4a48 | 28 | |
c09fcc4b MZ |
29 | typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc, |
30 | struct msi_msg *msg); | |
31 | ||
32 | /** | |
33 | * platform_msi_desc - Platform device specific msi descriptor data | |
34 | * @msi_priv_data: Pointer to platform private data | |
35 | * @msi_index: The index of the MSI descriptor for multi MSI | |
36 | */ | |
37 | struct platform_msi_desc { | |
38 | struct platform_msi_priv_data *msi_priv_data; | |
39 | u16 msi_index; | |
40 | }; | |
41 | ||
550308e4 GR |
42 | /** |
43 | * fsl_mc_msi_desc - FSL-MC device specific msi descriptor data | |
44 | * @msi_index: The index of the MSI descriptor | |
45 | */ | |
46 | struct fsl_mc_msi_desc { | |
47 | u16 msi_index; | |
48 | }; | |
49 | ||
fc88419c JL |
50 | /** |
51 | * struct msi_desc - Descriptor structure for MSI based interrupts | |
52 | * @list: List head for management | |
53 | * @irq: The base interrupt number | |
54 | * @nvec_used: The number of vectors used | |
55 | * @dev: Pointer to the device which uses this descriptor | |
56 | * @msg: The last set MSI message cached for reuse | |
0972fa57 | 57 | * @affinity: Optional pointer to a cpu affinity mask for this descriptor |
fc88419c JL |
58 | * |
59 | * @masked: [PCI MSI/X] Mask bits | |
60 | * @is_msix: [PCI MSI/X] True if MSI-X | |
61 | * @multiple: [PCI MSI/X] log2 num of messages allocated | |
62 | * @multi_cap: [PCI MSI/X] log2 num of messages supported | |
63 | * @maskbit: [PCI MSI/X] Mask-Pending bit supported? | |
64 | * @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit | |
65 | * @entry_nr: [PCI MSI/X] Entry which is described by this descriptor | |
66 | * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq | |
67 | * @mask_pos: [PCI MSI] Mask register position | |
68 | * @mask_base: [PCI MSI-X] Mask register base address | |
c09fcc4b | 69 | * @platform: [platform] Platform device specific msi descriptor data |
87840fb5 | 70 | * @fsl_mc: [fsl-mc] FSL MC device specific msi descriptor data |
fc88419c | 71 | */ |
3b7d1921 | 72 | struct msi_desc { |
fc88419c JL |
73 | /* Shared device/bus type independent data */ |
74 | struct list_head list; | |
75 | unsigned int irq; | |
76 | unsigned int nvec_used; | |
77 | struct device *dev; | |
78 | struct msi_msg msg; | |
bec04037 | 79 | struct irq_affinity_desc *affinity; |
3b7d1921 | 80 | |
264d9caa | 81 | union { |
fc88419c JL |
82 | /* PCI MSI/X specific data */ |
83 | struct { | |
84 | u32 masked; | |
85 | struct { | |
86 | __u8 is_msix : 1; | |
87 | __u8 multiple : 3; | |
88 | __u8 multi_cap : 3; | |
89 | __u8 maskbit : 1; | |
90 | __u8 is_64 : 1; | |
91 | __u16 entry_nr; | |
92 | unsigned default_irq; | |
93 | } msi_attrib; | |
94 | union { | |
95 | u8 mask_pos; | |
96 | void __iomem *mask_base; | |
97 | }; | |
98 | }; | |
3b7d1921 | 99 | |
fc88419c JL |
100 | /* |
101 | * Non PCI variants add their data structure here. New | |
102 | * entries need to use a named structure. We want | |
103 | * proper name spaces for this. The PCI part is | |
104 | * anonymous for now as it would require an immediate | |
105 | * tree wide cleanup. | |
106 | */ | |
c09fcc4b | 107 | struct platform_msi_desc platform; |
550308e4 | 108 | struct fsl_mc_msi_desc fsl_mc; |
fc88419c | 109 | }; |
3b7d1921 EB |
110 | }; |
111 | ||
d31eb342 | 112 | /* Helpers to hide struct msi_desc implementation details */ |
25a98bd4 | 113 | #define msi_desc_to_dev(desc) ((desc)->dev) |
4a7cc831 | 114 | #define dev_to_msi_list(dev) (&(dev)->msi_list) |
d31eb342 JL |
115 | #define first_msi_entry(dev) \ |
116 | list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list) | |
117 | #define for_each_msi_entry(desc, dev) \ | |
118 | list_for_each_entry((desc), dev_to_msi_list((dev)), list) | |
81b1e6e6 MR |
119 | #define for_each_msi_entry_safe(desc, tmp, dev) \ |
120 | list_for_each_entry_safe((desc), (tmp), dev_to_msi_list((dev)), list) | |
d31eb342 JL |
121 | |
122 | #ifdef CONFIG_PCI_MSI | |
123 | #define first_pci_msi_entry(pdev) first_msi_entry(&(pdev)->dev) | |
124 | #define for_each_pci_msi_entry(desc, pdev) \ | |
125 | for_each_msi_entry((desc), &(pdev)->dev) | |
126 | ||
25a98bd4 | 127 | struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc); |
c179c9b9 | 128 | void *msi_desc_to_pci_sysdata(struct msi_desc *desc); |
2f44e29c | 129 | void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg); |
c179c9b9 JL |
130 | #else /* CONFIG_PCI_MSI */ |
131 | static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc) | |
132 | { | |
133 | return NULL; | |
134 | } | |
2f44e29c AB |
135 | static inline void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg) |
136 | { | |
137 | } | |
d31eb342 JL |
138 | #endif /* CONFIG_PCI_MSI */ |
139 | ||
28f4b041 | 140 | struct msi_desc *alloc_msi_entry(struct device *dev, int nvec, |
bec04037 | 141 | const struct irq_affinity_desc *affinity); |
aa48b6f7 | 142 | void free_msi_entry(struct msi_desc *entry); |
891d4a48 | 143 | void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg); |
83a18912 | 144 | void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg); |
83a18912 | 145 | |
23ed8d57 TG |
146 | u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag); |
147 | u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag); | |
148 | void pci_msi_mask_irq(struct irq_data *data); | |
149 | void pci_msi_unmask_irq(struct irq_data *data); | |
150 | ||
83a18912 JL |
151 | /* Conversion helpers. Should be removed after merging */ |
152 | static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg) | |
153 | { | |
154 | __pci_write_msi_msg(entry, msg); | |
155 | } | |
156 | static inline void write_msi_msg(int irq, struct msi_msg *msg) | |
157 | { | |
158 | pci_write_msi_msg(irq, msg); | |
159 | } | |
23ed8d57 TG |
160 | static inline void mask_msi_irq(struct irq_data *data) |
161 | { | |
162 | pci_msi_mask_irq(data); | |
163 | } | |
164 | static inline void unmask_msi_irq(struct irq_data *data) | |
165 | { | |
166 | pci_msi_unmask_irq(data); | |
167 | } | |
891d4a48 | 168 | |
3b7d1921 | 169 | /* |
4287d824 TP |
170 | * The arch hooks to setup up msi irqs. Those functions are |
171 | * implemented as weak symbols so that they /can/ be overriden by | |
172 | * architecture specific code if needed. | |
3b7d1921 | 173 | */ |
f7feaca7 | 174 | int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc); |
3b7d1921 | 175 | void arch_teardown_msi_irq(unsigned int irq); |
2366d06e BH |
176 | int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type); |
177 | void arch_teardown_msi_irqs(struct pci_dev *dev); | |
ac8344c4 | 178 | void arch_restore_msi_irqs(struct pci_dev *dev); |
4287d824 TP |
179 | |
180 | void default_teardown_msi_irqs(struct pci_dev *dev); | |
ac8344c4 | 181 | void default_restore_msi_irqs(struct pci_dev *dev); |
3b7d1921 | 182 | |
c2791b80 | 183 | struct msi_controller { |
0cbdcfcf TR |
184 | struct module *owner; |
185 | struct device *dev; | |
0d5a6db3 TP |
186 | struct device_node *of_node; |
187 | struct list_head list; | |
0cbdcfcf | 188 | |
c2791b80 | 189 | int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev, |
0cbdcfcf | 190 | struct msi_desc *desc); |
339e5b44 LS |
191 | int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev, |
192 | int nvec, int type); | |
c2791b80 | 193 | void (*teardown_irq)(struct msi_controller *chip, unsigned int irq); |
0cbdcfcf TR |
194 | }; |
195 | ||
f3cf8bb0 | 196 | #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN |
d9109698 | 197 | |
aeeb5965 | 198 | #include <linux/irqhandler.h> |
d9109698 JL |
199 | #include <asm/msi.h> |
200 | ||
f3cf8bb0 | 201 | struct irq_domain; |
552c494a | 202 | struct irq_domain_ops; |
f3cf8bb0 JL |
203 | struct irq_chip; |
204 | struct device_node; | |
be5436c8 | 205 | struct fwnode_handle; |
f3cf8bb0 JL |
206 | struct msi_domain_info; |
207 | ||
208 | /** | |
209 | * struct msi_domain_ops - MSI interrupt domain callbacks | |
210 | * @get_hwirq: Retrieve the resulting hw irq number | |
211 | * @msi_init: Domain specific init function for MSI interrupts | |
212 | * @msi_free: Domain specific function to free a MSI interrupts | |
d9109698 JL |
213 | * @msi_check: Callback for verification of the domain/info/dev data |
214 | * @msi_prepare: Prepare the allocation of the interrupts in the domain | |
1d1e8cdc | 215 | * @msi_finish: Optional callback to finalize the allocation |
d9109698 JL |
216 | * @set_desc: Set the msi descriptor for an interrupt |
217 | * @handle_error: Optional error handler if the allocation fails | |
218 | * | |
219 | * @get_hwirq, @msi_init and @msi_free are callbacks used by | |
220 | * msi_create_irq_domain() and related interfaces | |
221 | * | |
222 | * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error | |
1d1e8cdc | 223 | * are callbacks used by msi_domain_alloc_irqs() and related |
d9109698 | 224 | * interfaces which are based on msi_desc. |
f3cf8bb0 JL |
225 | */ |
226 | struct msi_domain_ops { | |
aeeb5965 JL |
227 | irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info, |
228 | msi_alloc_info_t *arg); | |
f3cf8bb0 JL |
229 | int (*msi_init)(struct irq_domain *domain, |
230 | struct msi_domain_info *info, | |
231 | unsigned int virq, irq_hw_number_t hwirq, | |
aeeb5965 | 232 | msi_alloc_info_t *arg); |
f3cf8bb0 JL |
233 | void (*msi_free)(struct irq_domain *domain, |
234 | struct msi_domain_info *info, | |
235 | unsigned int virq); | |
d9109698 JL |
236 | int (*msi_check)(struct irq_domain *domain, |
237 | struct msi_domain_info *info, | |
238 | struct device *dev); | |
239 | int (*msi_prepare)(struct irq_domain *domain, | |
240 | struct device *dev, int nvec, | |
241 | msi_alloc_info_t *arg); | |
242 | void (*msi_finish)(msi_alloc_info_t *arg, int retval); | |
243 | void (*set_desc)(msi_alloc_info_t *arg, | |
244 | struct msi_desc *desc); | |
245 | int (*handle_error)(struct irq_domain *domain, | |
246 | struct msi_desc *desc, int error); | |
f3cf8bb0 JL |
247 | }; |
248 | ||
249 | /** | |
250 | * struct msi_domain_info - MSI interrupt domain data | |
aeeb5965 JL |
251 | * @flags: Flags to decribe features and capabilities |
252 | * @ops: The callback data structure | |
253 | * @chip: Optional: associated interrupt chip | |
254 | * @chip_data: Optional: associated interrupt chip data | |
255 | * @handler: Optional: associated interrupt flow handler | |
256 | * @handler_data: Optional: associated interrupt flow handler data | |
257 | * @handler_name: Optional: associated interrupt flow handler name | |
258 | * @data: Optional: domain specific data | |
f3cf8bb0 JL |
259 | */ |
260 | struct msi_domain_info { | |
aeeb5965 | 261 | u32 flags; |
f3cf8bb0 JL |
262 | struct msi_domain_ops *ops; |
263 | struct irq_chip *chip; | |
aeeb5965 JL |
264 | void *chip_data; |
265 | irq_flow_handler_t handler; | |
266 | void *handler_data; | |
267 | const char *handler_name; | |
f3cf8bb0 JL |
268 | void *data; |
269 | }; | |
270 | ||
aeeb5965 JL |
271 | /* Flags for msi_domain_info */ |
272 | enum { | |
273 | /* | |
274 | * Init non implemented ops callbacks with default MSI domain | |
275 | * callbacks. | |
276 | */ | |
277 | MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0), | |
278 | /* | |
279 | * Init non implemented chip callbacks with default MSI chip | |
280 | * callbacks. | |
281 | */ | |
282 | MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1), | |
aeeb5965 | 283 | /* Support multiple PCI MSI interrupts */ |
b6140914 | 284 | MSI_FLAG_MULTI_PCI_MSI = (1 << 2), |
aeeb5965 | 285 | /* Support PCI MSIX interrupts */ |
b6140914 | 286 | MSI_FLAG_PCI_MSIX = (1 << 3), |
f3b0946d MZ |
287 | /* Needs early activate, required for PCI */ |
288 | MSI_FLAG_ACTIVATE_EARLY = (1 << 4), | |
22d0b12f TG |
289 | /* |
290 | * Must reactivate when irq is started even when | |
291 | * MSI_FLAG_ACTIVATE_EARLY has been set. | |
292 | */ | |
293 | MSI_FLAG_MUST_REACTIVATE = (1 << 5), | |
0be8153c MZ |
294 | /* Is level-triggered capable, using two messages */ |
295 | MSI_FLAG_LEVEL_CAPABLE = (1 << 6), | |
aeeb5965 JL |
296 | }; |
297 | ||
f3cf8bb0 JL |
298 | int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask, |
299 | bool force); | |
300 | ||
be5436c8 | 301 | struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode, |
f3cf8bb0 JL |
302 | struct msi_domain_info *info, |
303 | struct irq_domain *parent); | |
d9109698 JL |
304 | int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev, |
305 | int nvec); | |
306 | void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev); | |
f3cf8bb0 JL |
307 | struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain); |
308 | ||
be5436c8 | 309 | struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode, |
c09fcc4b MZ |
310 | struct msi_domain_info *info, |
311 | struct irq_domain *parent); | |
312 | int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec, | |
313 | irq_write_msi_msg_t write_msi_msg); | |
314 | void platform_msi_domain_free_irqs(struct device *dev); | |
b2eba39b MZ |
315 | |
316 | /* When an MSI domain is used as an intermediate domain */ | |
317 | int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev, | |
318 | int nvec, msi_alloc_info_t *args); | |
2145ac93 MZ |
319 | int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev, |
320 | int virq, int nvec, msi_alloc_info_t *args); | |
552c494a | 321 | struct irq_domain * |
1f83515b MZ |
322 | __platform_msi_create_device_domain(struct device *dev, |
323 | unsigned int nvec, | |
324 | bool is_tree, | |
325 | irq_write_msi_msg_t write_msi_msg, | |
326 | const struct irq_domain_ops *ops, | |
327 | void *host_data); | |
328 | ||
329 | #define platform_msi_create_device_domain(dev, nvec, write, ops, data) \ | |
330 | __platform_msi_create_device_domain(dev, nvec, false, write, ops, data) | |
331 | #define platform_msi_create_device_tree_domain(dev, nvec, write, ops, data) \ | |
332 | __platform_msi_create_device_domain(dev, nvec, true, write, ops, data) | |
333 | ||
552c494a MZ |
334 | int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq, |
335 | unsigned int nr_irqs); | |
336 | void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq, | |
337 | unsigned int nvec); | |
338 | void *platform_msi_get_host_data(struct irq_domain *domain); | |
f3cf8bb0 JL |
339 | #endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */ |
340 | ||
3878eaef JL |
341 | #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN |
342 | void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg); | |
be5436c8 | 343 | struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode, |
3878eaef JL |
344 | struct msi_domain_info *info, |
345 | struct irq_domain *parent); | |
3878eaef JL |
346 | irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev, |
347 | struct msi_desc *desc); | |
348 | int pci_msi_domain_check_cap(struct irq_domain *domain, | |
349 | struct msi_domain_info *info, struct device *dev); | |
b6eec9b7 | 350 | u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev); |
54fa97ee MZ |
351 | struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev); |
352 | #else | |
353 | static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev) | |
354 | { | |
355 | return NULL; | |
356 | } | |
3878eaef JL |
357 | #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */ |
358 | ||
3b7d1921 | 359 | #endif /* LINUX_MSI_H */ |