Merge remote-tracking branch 'pci/next'
[karo-tx-linux.git] / include / linux / msi.h
1 #ifndef LINUX_MSI_H
2 #define LINUX_MSI_H
3
4 #include <linux/kobject.h>
5 #include <linux/list.h>
6
7 struct msi_msg {
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 */
11 };
12
13 extern int pci_msi_ignore_mask;
14 /* Helper functions */
15 struct irq_data;
16 struct msi_desc;
17 struct pci_dev;
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);
21
22 typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
23                                     struct msi_msg *msg);
24
25 /**
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
29  */
30 struct platform_msi_desc {
31         struct platform_msi_priv_data   *msi_priv_data;
32         u16                             msi_index;
33 };
34
35 /**
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
42  *
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
54  */
55 struct msi_desc {
56         /* Shared device/bus type independent data */
57         struct list_head                list;
58         unsigned int                    irq;
59         unsigned int                    nvec_used;
60         struct device                   *dev;
61         struct msi_msg                  msg;
62
63         union {
64                 /* PCI MSI/X specific data */
65                 struct {
66                         u32 masked;
67                         struct {
68                                 __u8    is_msix         : 1;
69                                 __u8    multiple        : 3;
70                                 __u8    multi_cap       : 3;
71                                 __u8    maskbit         : 1;
72                                 __u8    is_64           : 1;
73                                 __u16   entry_nr;
74                                 unsigned default_irq;
75                         } msi_attrib;
76                         union {
77                                 u8      mask_pos;
78                                 void __iomem *mask_base;
79                         };
80                 };
81
82                 /*
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
87                  * tree wide cleanup.
88                  */
89                 struct platform_msi_desc platform;
90         };
91 };
92
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)
100
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)
105
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)
110 {
111         return NULL;
112 }
113 #endif /* CONFIG_PCI_MSI */
114
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);
120
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);
125
126 /* Conversion helpers. Should be removed after merging */
127 static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
128 {
129         __pci_write_msi_msg(entry, msg);
130 }
131 static inline void write_msi_msg(int irq, struct msi_msg *msg)
132 {
133         pci_write_msi_msg(irq, msg);
134 }
135 static inline void mask_msi_irq(struct irq_data *data)
136 {
137         pci_msi_mask_irq(data);
138 }
139 static inline void unmask_msi_irq(struct irq_data *data)
140 {
141         pci_msi_unmask_irq(data);
142 }
143
144 /*
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.
148  */
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);
154
155 void default_teardown_msi_irqs(struct pci_dev *dev);
156 void default_restore_msi_irqs(struct pci_dev *dev);
157
158 struct msi_controller {
159         struct module *owner;
160         struct device *dev;
161         struct device_node *of_node;
162         struct list_head list;
163
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,
167                           int nvec, int type);
168         void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
169 };
170
171 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
172
173 #include <linux/irqhandler.h>
174 #include <asm/msi.h>
175
176 struct irq_domain;
177 struct irq_chip;
178 struct device_node;
179 struct fwnode_handle;
180 struct msi_domain_info;
181
182 /**
183  * struct msi_domain_ops - MSI interrupt domain callbacks
184  * @get_hwirq:          Retrieve the resulting hw irq number
185  * @msi_init:           Domain specific init function for MSI interrupts
186  * @msi_free:           Domain specific function to free a MSI interrupts
187  * @msi_check:          Callback for verification of the domain/info/dev data
188  * @msi_prepare:        Prepare the allocation of the interrupts in the domain
189  * @msi_finish:         Optional callbacl to finalize the allocation
190  * @set_desc:           Set the msi descriptor for an interrupt
191  * @handle_error:       Optional error handler if the allocation fails
192  *
193  * @get_hwirq, @msi_init and @msi_free are callbacks used by
194  * msi_create_irq_domain() and related interfaces
195  *
196  * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
197  * are callbacks used by msi_irq_domain_alloc_irqs() and related
198  * interfaces which are based on msi_desc.
199  */
200 struct msi_domain_ops {
201         irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
202                                      msi_alloc_info_t *arg);
203         int             (*msi_init)(struct irq_domain *domain,
204                                     struct msi_domain_info *info,
205                                     unsigned int virq, irq_hw_number_t hwirq,
206                                     msi_alloc_info_t *arg);
207         void            (*msi_free)(struct irq_domain *domain,
208                                     struct msi_domain_info *info,
209                                     unsigned int virq);
210         int             (*msi_check)(struct irq_domain *domain,
211                                      struct msi_domain_info *info,
212                                      struct device *dev);
213         int             (*msi_prepare)(struct irq_domain *domain,
214                                        struct device *dev, int nvec,
215                                        msi_alloc_info_t *arg);
216         void            (*msi_finish)(msi_alloc_info_t *arg, int retval);
217         void            (*set_desc)(msi_alloc_info_t *arg,
218                                     struct msi_desc *desc);
219         int             (*handle_error)(struct irq_domain *domain,
220                                         struct msi_desc *desc, int error);
221 };
222
223 /**
224  * struct msi_domain_info - MSI interrupt domain data
225  * @flags:              Flags to decribe features and capabilities
226  * @ops:                The callback data structure
227  * @chip:               Optional: associated interrupt chip
228  * @chip_data:          Optional: associated interrupt chip data
229  * @handler:            Optional: associated interrupt flow handler
230  * @handler_data:       Optional: associated interrupt flow handler data
231  * @handler_name:       Optional: associated interrupt flow handler name
232  * @data:               Optional: domain specific data
233  */
234 struct msi_domain_info {
235         u32                     flags;
236         struct msi_domain_ops   *ops;
237         struct irq_chip         *chip;
238         void                    *chip_data;
239         irq_flow_handler_t      handler;
240         void                    *handler_data;
241         const char              *handler_name;
242         void                    *data;
243 };
244
245 /* Flags for msi_domain_info */
246 enum {
247         /*
248          * Init non implemented ops callbacks with default MSI domain
249          * callbacks.
250          */
251         MSI_FLAG_USE_DEF_DOM_OPS        = (1 << 0),
252         /*
253          * Init non implemented chip callbacks with default MSI chip
254          * callbacks.
255          */
256         MSI_FLAG_USE_DEF_CHIP_OPS       = (1 << 1),
257         /* Build identity map between hwirq and irq */
258         MSI_FLAG_IDENTITY_MAP           = (1 << 2),
259         /* Support multiple PCI MSI interrupts */
260         MSI_FLAG_MULTI_PCI_MSI          = (1 << 3),
261         /* Support PCI MSIX interrupts */
262         MSI_FLAG_PCI_MSIX               = (1 << 4),
263 };
264
265 int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
266                             bool force);
267
268 struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
269                                          struct msi_domain_info *info,
270                                          struct irq_domain *parent);
271 int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
272                           int nvec);
273 void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
274 struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
275
276 struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
277                                                   struct msi_domain_info *info,
278                                                   struct irq_domain *parent);
279 int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
280                                    irq_write_msi_msg_t write_msi_msg);
281 void platform_msi_domain_free_irqs(struct device *dev);
282 #endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
283
284 #ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
285 void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
286 struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
287                                              struct msi_domain_info *info,
288                                              struct irq_domain *parent);
289 int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
290                               int nvec, int type);
291 void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev);
292 struct irq_domain *pci_msi_create_default_irq_domain(struct fwnode_handle *fwnode,
293                  struct msi_domain_info *info, struct irq_domain *parent);
294
295 irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
296                                           struct msi_desc *desc);
297 int pci_msi_domain_check_cap(struct irq_domain *domain,
298                              struct msi_domain_info *info, struct device *dev);
299 u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
300 struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
301 #else
302 static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
303 {
304         return NULL;
305 }
306 #endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
307
308 #endif /* LINUX_MSI_H */