blob: 8b425c66305ad3f1a518fe643a5b2ffe93b3278d [file] [log] [blame]
Eric W. Biederman3b7d1922006-10-04 02:16:59 -07001#ifndef LINUX_MSI_H
2#define LINUX_MSI_H
3
Neil Hormanb50cac52011-10-06 14:08:18 -04004#include <linux/kobject.h>
Michael Ellerman4aa9bc92007-04-05 17:19:10 +10005#include <linux/list.h>
6
Eric W. Biederman3b7d1922006-10-04 02:16:59 -07007struct 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
Yijing Wang38737d82014-10-27 10:44:36 +080013extern int pci_msi_ignore_mask;
Satoru Takeuchic54c1872007-01-18 13:50:05 +090014/* Helper functions */
Thomas Gleixner1c9db522010-09-28 16:46:51 +020015struct irq_data;
Thomas Gleixner39431ac2010-09-28 19:09:51 +020016struct msi_desc;
Jiang Liu25a98bd2015-07-09 16:00:45 +080017struct pci_dev;
Marc Zyngierc09fcc4b2015-07-28 14:46:16 +010018struct platform_msi_priv_data;
Bjorn Helgaas2366d062013-04-18 10:55:46 -060019void __get_cached_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Bjorn Helgaas2366d062013-04-18 10:55:46 -060020void get_cached_msi_msg(unsigned int irq, struct msi_msg *msg);
Jiang Liu891d4a42014-11-09 23:10:33 +080021
Marc Zyngierc09fcc4b2015-07-28 14:46:16 +010022typedef 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 */
30struct platform_msi_desc {
31 struct platform_msi_priv_data *msi_priv_data;
32 u16 msi_index;
33};
34
Jiang Liufc884192015-07-09 16:00:46 +080035/**
J. German Rivera550308e2016-01-06 16:03:20 -060036 * fsl_mc_msi_desc - FSL-MC device specific msi descriptor data
37 * @msi_index: The index of the MSI descriptor
38 */
39struct fsl_mc_msi_desc {
40 u16 msi_index;
41};
42
43/**
Jiang Liufc884192015-07-09 16:00:46 +080044 * struct msi_desc - Descriptor structure for MSI based interrupts
45 * @list: List head for management
46 * @irq: The base interrupt number
47 * @nvec_used: The number of vectors used
48 * @dev: Pointer to the device which uses this descriptor
49 * @msg: The last set MSI message cached for reuse
50 *
51 * @masked: [PCI MSI/X] Mask bits
52 * @is_msix: [PCI MSI/X] True if MSI-X
53 * @multiple: [PCI MSI/X] log2 num of messages allocated
54 * @multi_cap: [PCI MSI/X] log2 num of messages supported
55 * @maskbit: [PCI MSI/X] Mask-Pending bit supported?
56 * @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit
57 * @entry_nr: [PCI MSI/X] Entry which is described by this descriptor
58 * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
59 * @mask_pos: [PCI MSI] Mask register position
60 * @mask_base: [PCI MSI-X] Mask register base address
Marc Zyngierc09fcc4b2015-07-28 14:46:16 +010061 * @platform: [platform] Platform device specific msi descriptor data
Jiang Liufc884192015-07-09 16:00:46 +080062 */
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070063struct msi_desc {
Jiang Liufc884192015-07-09 16:00:46 +080064 /* Shared device/bus type independent data */
65 struct list_head list;
66 unsigned int irq;
67 unsigned int nvec_used;
68 struct device *dev;
69 struct msi_msg msg;
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070070
Matthew Wilcox264d9ca2009-03-17 08:54:08 -040071 union {
Jiang Liufc884192015-07-09 16:00:46 +080072 /* PCI MSI/X specific data */
73 struct {
74 u32 masked;
75 struct {
76 __u8 is_msix : 1;
77 __u8 multiple : 3;
78 __u8 multi_cap : 3;
79 __u8 maskbit : 1;
80 __u8 is_64 : 1;
81 __u16 entry_nr;
82 unsigned default_irq;
83 } msi_attrib;
84 union {
85 u8 mask_pos;
86 void __iomem *mask_base;
87 };
88 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -070089
Jiang Liufc884192015-07-09 16:00:46 +080090 /*
91 * Non PCI variants add their data structure here. New
92 * entries need to use a named structure. We want
93 * proper name spaces for this. The PCI part is
94 * anonymous for now as it would require an immediate
95 * tree wide cleanup.
96 */
Marc Zyngierc09fcc4b2015-07-28 14:46:16 +010097 struct platform_msi_desc platform;
J. German Rivera550308e2016-01-06 16:03:20 -060098 struct fsl_mc_msi_desc fsl_mc;
Jiang Liufc884192015-07-09 16:00:46 +080099 };
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700100};
101
Jiang Liud31eb342014-11-15 22:24:03 +0800102/* Helpers to hide struct msi_desc implementation details */
Jiang Liu25a98bd2015-07-09 16:00:45 +0800103#define msi_desc_to_dev(desc) ((desc)->dev)
Jiang Liu4a7cc832015-07-09 16:00:44 +0800104#define dev_to_msi_list(dev) (&(dev)->msi_list)
Jiang Liud31eb342014-11-15 22:24:03 +0800105#define first_msi_entry(dev) \
106 list_first_entry(dev_to_msi_list((dev)), struct msi_desc, list)
107#define for_each_msi_entry(desc, dev) \
108 list_for_each_entry((desc), dev_to_msi_list((dev)), list)
109
110#ifdef CONFIG_PCI_MSI
111#define first_pci_msi_entry(pdev) first_msi_entry(&(pdev)->dev)
112#define for_each_pci_msi_entry(desc, pdev) \
113 for_each_msi_entry((desc), &(pdev)->dev)
114
Jiang Liu25a98bd2015-07-09 16:00:45 +0800115struct pci_dev *msi_desc_to_pci_dev(struct msi_desc *desc);
Jiang Liuc179c9b2015-07-09 16:00:36 +0800116void *msi_desc_to_pci_sysdata(struct msi_desc *desc);
117#else /* CONFIG_PCI_MSI */
118static inline void *msi_desc_to_pci_sysdata(struct msi_desc *desc)
119{
120 return NULL;
121}
Jiang Liud31eb342014-11-15 22:24:03 +0800122#endif /* CONFIG_PCI_MSI */
123
Jiang Liuaa48b6f2015-07-09 16:00:47 +0800124struct msi_desc *alloc_msi_entry(struct device *dev);
125void free_msi_entry(struct msi_desc *entry);
Jiang Liu891d4a42014-11-09 23:10:33 +0800126void __pci_read_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
Jiang Liu83a18912014-11-09 23:10:34 +0800127void __pci_write_msi_msg(struct msi_desc *entry, struct msi_msg *msg);
128void pci_write_msi_msg(unsigned int irq, struct msi_msg *msg);
129
Thomas Gleixner23ed8d52014-11-23 11:55:58 +0100130u32 __pci_msix_desc_mask_irq(struct msi_desc *desc, u32 flag);
131u32 __pci_msi_desc_mask_irq(struct msi_desc *desc, u32 mask, u32 flag);
132void pci_msi_mask_irq(struct irq_data *data);
133void pci_msi_unmask_irq(struct irq_data *data);
134
Jiang Liu83a18912014-11-09 23:10:34 +0800135/* Conversion helpers. Should be removed after merging */
136static inline void __write_msi_msg(struct msi_desc *entry, struct msi_msg *msg)
137{
138 __pci_write_msi_msg(entry, msg);
139}
140static inline void write_msi_msg(int irq, struct msi_msg *msg)
141{
142 pci_write_msi_msg(irq, msg);
143}
Thomas Gleixner23ed8d52014-11-23 11:55:58 +0100144static inline void mask_msi_irq(struct irq_data *data)
145{
146 pci_msi_mask_irq(data);
147}
148static inline void unmask_msi_irq(struct irq_data *data)
149{
150 pci_msi_unmask_irq(data);
151}
Jiang Liu891d4a42014-11-09 23:10:33 +0800152
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700153/*
Thomas Petazzoni4287d822013-08-09 22:27:06 +0200154 * The arch hooks to setup up msi irqs. Those functions are
155 * implemented as weak symbols so that they /can/ be overriden by
156 * architecture specific code if needed.
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700157 */
Eric W. Biedermanf7feaca2007-01-28 12:56:37 -0700158int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700159void arch_teardown_msi_irq(unsigned int irq);
Bjorn Helgaas2366d062013-04-18 10:55:46 -0600160int arch_setup_msi_irqs(struct pci_dev *dev, int nvec, int type);
161void arch_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +0800162void arch_restore_msi_irqs(struct pci_dev *dev);
Thomas Petazzoni4287d822013-08-09 22:27:06 +0200163
164void default_teardown_msi_irqs(struct pci_dev *dev);
DuanZhenzhongac8344c2013-12-04 13:09:16 +0800165void default_restore_msi_irqs(struct pci_dev *dev);
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700166
Yijing Wangc2791b82014-11-11 17:45:45 -0700167struct msi_controller {
Thierry Reding0cbdcfc2013-08-09 22:27:08 +0200168 struct module *owner;
169 struct device *dev;
Thomas Petazzoni0d5a6db2013-08-09 22:27:09 +0200170 struct device_node *of_node;
171 struct list_head list;
Thierry Reding0cbdcfc2013-08-09 22:27:08 +0200172
Yijing Wangc2791b82014-11-11 17:45:45 -0700173 int (*setup_irq)(struct msi_controller *chip, struct pci_dev *dev,
Thierry Reding0cbdcfc2013-08-09 22:27:08 +0200174 struct msi_desc *desc);
Lucas Stach339e5b42015-09-18 13:58:34 -0500175 int (*setup_irqs)(struct msi_controller *chip, struct pci_dev *dev,
176 int nvec, int type);
Yijing Wangc2791b82014-11-11 17:45:45 -0700177 void (*teardown_irq)(struct msi_controller *chip, unsigned int irq);
Thierry Reding0cbdcfc2013-08-09 22:27:08 +0200178};
179
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100180#ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
Jiang Liud9109692014-11-15 22:24:04 +0800181
Jiang Liuaeeb5962014-11-15 22:24:05 +0800182#include <linux/irqhandler.h>
Jiang Liud9109692014-11-15 22:24:04 +0800183#include <asm/msi.h>
184
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100185struct irq_domain;
Marc Zyngier552c4942015-11-23 08:26:07 +0000186struct irq_domain_ops;
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100187struct irq_chip;
188struct device_node;
Marc Zyngierbe5436c2015-10-13 12:51:44 +0100189struct fwnode_handle;
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100190struct msi_domain_info;
191
192/**
193 * struct msi_domain_ops - MSI interrupt domain callbacks
194 * @get_hwirq: Retrieve the resulting hw irq number
195 * @msi_init: Domain specific init function for MSI interrupts
196 * @msi_free: Domain specific function to free a MSI interrupts
Jiang Liud9109692014-11-15 22:24:04 +0800197 * @msi_check: Callback for verification of the domain/info/dev data
198 * @msi_prepare: Prepare the allocation of the interrupts in the domain
Thomas Petazzoni1d1e8cd2015-12-21 14:13:08 +0100199 * @msi_finish: Optional callback to finalize the allocation
Jiang Liud9109692014-11-15 22:24:04 +0800200 * @set_desc: Set the msi descriptor for an interrupt
201 * @handle_error: Optional error handler if the allocation fails
202 *
203 * @get_hwirq, @msi_init and @msi_free are callbacks used by
204 * msi_create_irq_domain() and related interfaces
205 *
206 * @msi_check, @msi_prepare, @msi_finish, @set_desc and @handle_error
Thomas Petazzoni1d1e8cd2015-12-21 14:13:08 +0100207 * are callbacks used by msi_domain_alloc_irqs() and related
Jiang Liud9109692014-11-15 22:24:04 +0800208 * interfaces which are based on msi_desc.
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100209 */
210struct msi_domain_ops {
Jiang Liuaeeb5962014-11-15 22:24:05 +0800211 irq_hw_number_t (*get_hwirq)(struct msi_domain_info *info,
212 msi_alloc_info_t *arg);
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100213 int (*msi_init)(struct irq_domain *domain,
214 struct msi_domain_info *info,
215 unsigned int virq, irq_hw_number_t hwirq,
Jiang Liuaeeb5962014-11-15 22:24:05 +0800216 msi_alloc_info_t *arg);
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100217 void (*msi_free)(struct irq_domain *domain,
218 struct msi_domain_info *info,
219 unsigned int virq);
Jiang Liud9109692014-11-15 22:24:04 +0800220 int (*msi_check)(struct irq_domain *domain,
221 struct msi_domain_info *info,
222 struct device *dev);
223 int (*msi_prepare)(struct irq_domain *domain,
224 struct device *dev, int nvec,
225 msi_alloc_info_t *arg);
226 void (*msi_finish)(msi_alloc_info_t *arg, int retval);
227 void (*set_desc)(msi_alloc_info_t *arg,
228 struct msi_desc *desc);
229 int (*handle_error)(struct irq_domain *domain,
230 struct msi_desc *desc, int error);
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100231};
232
233/**
234 * struct msi_domain_info - MSI interrupt domain data
Jiang Liuaeeb5962014-11-15 22:24:05 +0800235 * @flags: Flags to decribe features and capabilities
236 * @ops: The callback data structure
237 * @chip: Optional: associated interrupt chip
238 * @chip_data: Optional: associated interrupt chip data
239 * @handler: Optional: associated interrupt flow handler
240 * @handler_data: Optional: associated interrupt flow handler data
241 * @handler_name: Optional: associated interrupt flow handler name
242 * @data: Optional: domain specific data
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100243 */
244struct msi_domain_info {
Jiang Liuaeeb5962014-11-15 22:24:05 +0800245 u32 flags;
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100246 struct msi_domain_ops *ops;
247 struct irq_chip *chip;
Jiang Liuaeeb5962014-11-15 22:24:05 +0800248 void *chip_data;
249 irq_flow_handler_t handler;
250 void *handler_data;
251 const char *handler_name;
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100252 void *data;
253};
254
Jiang Liuaeeb5962014-11-15 22:24:05 +0800255/* Flags for msi_domain_info */
256enum {
257 /*
258 * Init non implemented ops callbacks with default MSI domain
259 * callbacks.
260 */
261 MSI_FLAG_USE_DEF_DOM_OPS = (1 << 0),
262 /*
263 * Init non implemented chip callbacks with default MSI chip
264 * callbacks.
265 */
266 MSI_FLAG_USE_DEF_CHIP_OPS = (1 << 1),
267 /* Build identity map between hwirq and irq */
268 MSI_FLAG_IDENTITY_MAP = (1 << 2),
269 /* Support multiple PCI MSI interrupts */
270 MSI_FLAG_MULTI_PCI_MSI = (1 << 3),
271 /* Support PCI MSIX interrupts */
272 MSI_FLAG_PCI_MSIX = (1 << 4),
273};
274
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100275int msi_domain_set_affinity(struct irq_data *data, const struct cpumask *mask,
276 bool force);
277
Marc Zyngierbe5436c2015-10-13 12:51:44 +0100278struct irq_domain *msi_create_irq_domain(struct fwnode_handle *fwnode,
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100279 struct msi_domain_info *info,
280 struct irq_domain *parent);
Jiang Liud9109692014-11-15 22:24:04 +0800281int msi_domain_alloc_irqs(struct irq_domain *domain, struct device *dev,
282 int nvec);
283void msi_domain_free_irqs(struct irq_domain *domain, struct device *dev);
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100284struct msi_domain_info *msi_get_domain_info(struct irq_domain *domain);
285
Marc Zyngierbe5436c2015-10-13 12:51:44 +0100286struct irq_domain *platform_msi_create_irq_domain(struct fwnode_handle *fwnode,
Marc Zyngierc09fcc4b2015-07-28 14:46:16 +0100287 struct msi_domain_info *info,
288 struct irq_domain *parent);
289int platform_msi_domain_alloc_irqs(struct device *dev, unsigned int nvec,
290 irq_write_msi_msg_t write_msi_msg);
291void platform_msi_domain_free_irqs(struct device *dev);
Marc Zyngierb2eba392015-11-23 08:26:05 +0000292
293/* When an MSI domain is used as an intermediate domain */
294int msi_domain_prepare_irqs(struct irq_domain *domain, struct device *dev,
295 int nvec, msi_alloc_info_t *args);
Marc Zyngier2145ac92015-11-23 08:26:06 +0000296int msi_domain_populate_irqs(struct irq_domain *domain, struct device *dev,
297 int virq, int nvec, msi_alloc_info_t *args);
Marc Zyngier552c4942015-11-23 08:26:07 +0000298struct irq_domain *
299platform_msi_create_device_domain(struct device *dev,
300 unsigned int nvec,
301 irq_write_msi_msg_t write_msi_msg,
302 const struct irq_domain_ops *ops,
303 void *host_data);
304int platform_msi_domain_alloc(struct irq_domain *domain, unsigned int virq,
305 unsigned int nr_irqs);
306void platform_msi_domain_free(struct irq_domain *domain, unsigned int virq,
307 unsigned int nvec);
308void *platform_msi_get_host_data(struct irq_domain *domain);
Jiang Liuf3cf8bb2014-11-12 11:39:03 +0100309#endif /* CONFIG_GENERIC_MSI_IRQ_DOMAIN */
310
Jiang Liu3878eae2014-11-11 21:02:18 +0800311#ifdef CONFIG_PCI_MSI_IRQ_DOMAIN
312void pci_msi_domain_write_msg(struct irq_data *irq_data, struct msi_msg *msg);
Marc Zyngierbe5436c2015-10-13 12:51:44 +0100313struct irq_domain *pci_msi_create_irq_domain(struct fwnode_handle *fwnode,
Jiang Liu3878eae2014-11-11 21:02:18 +0800314 struct msi_domain_info *info,
315 struct irq_domain *parent);
316int pci_msi_domain_alloc_irqs(struct irq_domain *domain, struct pci_dev *dev,
317 int nvec, int type);
318void pci_msi_domain_free_irqs(struct irq_domain *domain, struct pci_dev *dev);
Marc Zyngierbe5436c2015-10-13 12:51:44 +0100319struct irq_domain *pci_msi_create_default_irq_domain(struct fwnode_handle *fwnode,
Jiang Liu8e047ad2014-11-15 22:24:07 +0800320 struct msi_domain_info *info, struct irq_domain *parent);
321
Jiang Liu3878eae2014-11-11 21:02:18 +0800322irq_hw_number_t pci_msi_domain_calc_hwirq(struct pci_dev *dev,
323 struct msi_desc *desc);
324int pci_msi_domain_check_cap(struct irq_domain *domain,
325 struct msi_domain_info *info, struct device *dev);
David Daneyb6eec9b2015-10-08 15:10:49 -0700326u32 pci_msi_domain_get_msi_rid(struct irq_domain *domain, struct pci_dev *pdev);
Marc Zyngier54fa97e2015-10-02 14:43:06 +0100327struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev);
328#else
329static inline struct irq_domain *pci_msi_get_device_domain(struct pci_dev *pdev)
330{
331 return NULL;
332}
Jiang Liu3878eae2014-11-11 21:02:18 +0800333#endif /* CONFIG_PCI_MSI_IRQ_DOMAIN */
334
Eric W. Biederman3b7d1922006-10-04 02:16:59 -0700335#endif /* LINUX_MSI_H */