1
2#ifndef LINUX_MSI_H
3#define LINUX_MSI_H
4
5#include <linux/kobject.h>
6#include <linux/list.h>
7
8struct msi_msg {
9 u32 address_lo;
10 u32 address_hi;
11 u32 data;
12};
13
14extern int pci_msi_ignore_mask;
15
16struct irq_data;
17struct msi_desc;
18struct pci_dev;
19struct platform_msi_priv_data;
20void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
21#ifdef CONFIG_GENERIC_MSI_IRQ
22void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
23#else
24static inline void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg)
25{
26}
27#endif
28
29typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
30 struct msi_msg *msg);
31
32
33
34
35
36
37struct platform_msi_desc {
38 struct platform_msi_priv_data *msi_priv_data;
39 u16 msi_index;
40};
41
42
43
44
45
46struct fsl_mc_msi_desc {
47 u16 msi_index;
48};
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72struct msi_desc {
73
74 struct list_head list;
75 unsigned int irq;
76 unsigned int nvec_used;
77 struct device *dev;
78 struct msi_msg msg;
79 struct cpumask *affinity;
80
81 union {
82
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 };
99
100
101
102
103
104
105
106
107 struct platform_msi_desc platform;
108 struct fsl_mc_msi_desc fsl_mc;
109 };
110};
111
112
113#define msi_desc_to_dev(desc) ((desc)->dev)
114#define dev_to_msi_list(dev) (&(dev)->msi_list)
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)
119
120#ifdef CONFIG_PCI_MSI
121#define first_pci_msi_entry(pdev) first_msi_entry(&(pdev)->dev)
122#define for_each_pci_msi_entry(desc, pdev) \
123 for_each_msi_entry((desc), &(pdev)->dev)
124
125struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
126void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
127void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
128#else
129static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
130{
131 return NULL;
132}
133static inline void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg)
134{
135}
136#endif
137
138struct msi_desc *alloc_msi_entry(struct device *dev, int nvec,
139 const struct cpumask *affinity);
140void free_msi_entry(struct msi_desc *entry);
141void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
142void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
143
144u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
145u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
146void pci_msi_mask_irq(struct irq_data *data);
147void pci_msi_unmask_irq(struct irq_data *data);
148
149
150static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
151{
152 __pci_write_msi_msg(entry, msg);
153}
154static inline void write_msi_msg(int irq, struct msi_msg *msg)
155{
156 pci_write_msi_msg(irq, msg);
157}
158static inline void mask_msi_irq(struct irq_data *data)
159{
160 pci_msi_mask_irq(data);
161}
162static inline void unmask_msi_irq(struct irq_data *data)
163{
164 pci_msi_unmask_irq(data);
165}
166
167
168
169
170
171
172int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
173void arch_teardown_msi_irq(unsigned int irq);
174int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
175void arch_teardown_msi_irqs(struct pci_dev *dev);
176void arch_restore_msi_irqs(struct pci_dev *dev);
177
178void default_teardown_msi_irqs(struct pci_dev *dev);
179void default_restore_msi_irqs(struct pci_dev *dev);
180
181struct msi_controller {
182 struct module *owner;
183 struct device *dev;
184 struct device_node *of_node;
185 struct list_head list;
186
187 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
188 struct msi_desc *desc);
189 int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev,
190 int nvec, int type);
191 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
192};
193
194#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
195
196#include <linux/irqhandler.h>
197#include <asm/msi.h>
198
199struct irq_domain;
200struct irq_domain_ops;
201struct irq_chip;
202struct device_node;
203struct fwnode_handle;
204struct msi_domain_info;
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224struct msi_domain_ops {
225 irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
226 msi_alloc_info_t *arg);
227 int (*msi_init)(struct irq_domain *domain,
228 struct msi_domain_info *info,
229 unsigned int virq, irq_hw_number_t hwirq,
230 msi_alloc_info_t *arg);
231 void (*msi_free)(struct irq_domain *domain,
232 struct msi_domain_info *info,
233 unsigned int virq);
234 int (*msi_check)(struct irq_domain *domain,
235 struct msi_domain_info *info,
236 struct device *dev);
237 int (*msi_prepare)(struct irq_domain *domain,
238 struct device *dev, int nvec,
239 msi_alloc_info_t *arg);
240 void (*msi_finish)(msi_alloc_info_t *arg, int retval);
241 void (*set_desc)(msi_alloc_info_t *arg,
242 struct msi_desc *desc);
243 int (*handle_error)(struct irq_domain *domain,
244 struct msi_desc *desc, int error);
245};
246
247
248
249
250
251
252
253
254
255
256
257
258struct msi_domain_info {
259 u32 flags;
260 struct msi_domain_ops *ops;
261 struct irq_chip *chip;
262 void *chip_data;
263 irq_flow_handler_t handler;
264 void *handler_data;
265 const char *handler_name;
266 void *data;
267};
268
269
270enum {
271
272
273
274
275 MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0),
276
277
278
279
280 MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1),
281
282 MSI_FLAG_MULTI_PCI_MSI = (1 << 2),
283
284 MSI_FLAG_PCI_MSIX = (1 << 3),
285
286 MSI_FLAG_ACTIVATE_EARLY = (1 << 4),
287
288
289
290
291 MSI_FLAG_MUST_REACTIVATE = (1 << 5),
292};
293
294int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
295 bool force);
296
297struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
298 struct msi_domain_info *info,
299 struct irq_domain *parent);
300int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
301 int nvec);
302void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
303struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
304
305struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
306 struct msi_domain_info *info,
307 struct irq_domain *parent);
308int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
309 irq_write_msi_msg_t write_msi_msg);
310void platform_msi_domain_free_irqs(struct device *dev);
311
312
313int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
314 int nvec, msi_alloc_info_t *args);
315int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
316 int virq, int nvec, msi_alloc_info_t *args);
317struct irq_domain *
318platform_msi_create_device_domain(struct device *dev,
319 unsigned int nvec,
320 irq_write_msi_msg_t write_msi_msg,
321 const struct irq_domain_ops *ops,
322 void *host_data);
323int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
324 unsigned int nr_irqs);
325void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
326 unsigned int nvec);
327void *platform_msi_get_host_data(struct irq_domain *domain);
328#endif
329
330#ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
331void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
332struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
333 struct msi_domain_info *info,
334 struct irq_domain *parent);
335irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
336 struct msi_desc *desc);
337int pci_msi_domain_check_cap(struct irq_domain *domain,
338 struct msi_domain_info *info, struct device *dev);
339u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
340struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
341#else
342static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
343{
344 return NULL;
345}
346#endif
347
348#endif
349