Greg Kroah-Hartman | b244131 | 2017-11-01 15:07:57 +0100 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 2 | /* |
| 3 | * irq_domain - IRQ translation domains |
| 4 | * |
| 5 | * Translation infrastructure between hw and linux irq numbers. This is |
| 6 | * helpful for interrupt controllers to implement mapping between hardware |
| 7 | * irq numbers and the Linux irq number space. |
| 8 | * |
Marc Zyngier | e7a46c8 | 2015-10-13 12:51:45 +0100 | [diff] [blame] | 9 | * irq_domains also have hooks for translating device tree or other |
| 10 | * firmware interrupt representations into a hardware irq number that |
| 11 | * can be mapped back to a Linux irq number without any extra platform |
| 12 | * support code. |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 13 | * |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 14 | * Interrupt controller "domain" data structure. This could be defined as a |
| 15 | * irq domain controller. That is, it handles the mapping between hardware |
| 16 | * and virtual interrupt numbers for a given interrupt domain. The domain |
| 17 | * structure is generally created by the PIC code for a given PIC instance |
| 18 | * (though a domain can cover more than one PIC if they have a flat number |
| 19 | * model). It's the domain callbacks that are responsible for setting the |
| 20 | * irq_chip on a given irq_desc after it's been mapped. |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 21 | * |
Marc Zyngier | e7a46c8 | 2015-10-13 12:51:45 +0100 | [diff] [blame] | 22 | * The host code and data structures use a fwnode_handle pointer to |
| 23 | * identify the domain. In some cases, and in order to preserve source |
| 24 | * code compatibility, this fwnode pointer is "upgraded" to a DT |
| 25 | * device_node. For those firmware infrastructures that do not provide |
| 26 | * a unique identifier for an interrupt controller, the irq_domain |
| 27 | * code offers a fwnode allocator. |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 28 | */ |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 29 | |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 30 | #ifndef _LINUX_IRQDOMAIN_H |
| 31 | #define _LINUX_IRQDOMAIN_H |
| 32 | |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 33 | #include <linux/types.h> |
Jiang Liu | 1b53770 | 2014-11-09 23:10:24 +0800 | [diff] [blame] | 34 | #include <linux/irqhandler.h> |
Marc Zyngier | f110711 | 2015-10-13 12:51:30 +0100 | [diff] [blame] | 35 | #include <linux/of.h> |
Masahiro Yamada | f1d7835 | 2017-10-05 10:44:54 +0900 | [diff] [blame] | 36 | #include <linux/mutex.h> |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 37 | #include <linux/radix-tree.h> |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 38 | |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 39 | struct device_node; |
| 40 | struct irq_domain; |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 41 | struct of_device_id; |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 42 | struct irq_chip; |
| 43 | struct irq_data; |
Thomas Gleixner | 06ee6d5 | 2016-07-04 17:39:24 +0900 | [diff] [blame] | 44 | struct cpumask; |
Thomas Gleixner | c3e7239 | 2017-09-13 23:29:06 +0200 | [diff] [blame] | 45 | struct seq_file; |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 46 | |
Grant Likely | 1bc04f2 | 2012-02-14 14:06:55 -0700 | [diff] [blame] | 47 | /* Number of irqs reserved for a legacy isa controller */ |
| 48 | #define NUM_ISA_INTERRUPTS 16 |
| 49 | |
Marc Zyngier | 11e4438e | 2015-10-13 12:51:32 +0100 | [diff] [blame] | 50 | #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16 |
| 51 | |
| 52 | /** |
| 53 | * struct irq_fwspec - generic IRQ specifier structure |
| 54 | * |
| 55 | * @fwnode: Pointer to a firmware-specific descriptor |
| 56 | * @param_count: Number of device-specific parameters |
| 57 | * @param: Device-specific parameters |
| 58 | * |
| 59 | * This structure, directly modeled after of_phandle_args, is used to |
| 60 | * pass a device-specific description of an interrupt. |
| 61 | */ |
| 62 | struct irq_fwspec { |
| 63 | struct fwnode_handle *fwnode; |
| 64 | int param_count; |
| 65 | u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS]; |
| 66 | }; |
| 67 | |
Marc Zyngier | ad3aedf | 2015-07-28 14:46:08 +0100 | [diff] [blame] | 68 | /* |
| 69 | * Should several domains have the same device node, but serve |
| 70 | * different purposes (for example one domain is for PCI/MSI, and the |
| 71 | * other for wired IRQs), they can be distinguished using a |
| 72 | * bus-specific token. Most domains are expected to only carry |
| 73 | * DOMAIN_BUS_ANY. |
| 74 | */ |
| 75 | enum irq_domain_bus_token { |
| 76 | DOMAIN_BUS_ANY = 0, |
Marc Zyngier | 530cbe1 | 2016-01-26 13:52:25 +0000 | [diff] [blame] | 77 | DOMAIN_BUS_WIRED, |
Marc Zyngier | 0380839 | 2015-07-28 14:46:09 +0100 | [diff] [blame] | 78 | DOMAIN_BUS_PCI_MSI, |
Marc Zyngier | c706c23 | 2015-07-28 14:46:15 +0100 | [diff] [blame] | 79 | DOMAIN_BUS_PLATFORM_MSI, |
Marc Zyngier | a571607 | 2015-07-28 14:46:17 +0100 | [diff] [blame] | 80 | DOMAIN_BUS_NEXUS, |
Qais Yousef | 29d5c8d | 2015-12-08 13:20:13 +0000 | [diff] [blame] | 81 | DOMAIN_BUS_IPI, |
J. German Rivera | 9b1b282 | 2016-01-06 16:03:19 -0600 | [diff] [blame] | 82 | DOMAIN_BUS_FSL_MC_MSI, |
Marc Zyngier | ad3aedf | 2015-07-28 14:46:08 +0100 | [diff] [blame] | 83 | }; |
| 84 | |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 85 | /** |
| 86 | * struct irq_domain_ops - Methods for irq_domain objects |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 87 | * @match: Match an interrupt controller device node to a host, returns |
| 88 | * 1 on a match |
| 89 | * @map: Create or update a mapping between a virtual irq number and a hw |
| 90 | * irq number. This is called only once for a given mapping. |
| 91 | * @unmap: Dispose of such a mapping |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 92 | * @xlate: Given a device tree node and interrupt specifier, decode |
| 93 | * the hardware irq number and linux irq type value. |
| 94 | * |
| 95 | * Functions below are provided by the driver and called whenever a new mapping |
| 96 | * is created or an old mapping is disposed. The driver can then proceed to |
| 97 | * whatever internal data structures management is required. It also needs |
| 98 | * to setup the irq_desc when returning from map(). |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 99 | */ |
| 100 | struct irq_domain_ops { |
Marc Zyngier | ad3aedf | 2015-07-28 14:46:08 +0100 | [diff] [blame] | 101 | int (*match)(struct irq_domain *d, struct device_node *node, |
| 102 | enum irq_domain_bus_token bus_token); |
Marc Zyngier | 651e8b5 | 2016-04-11 09:57:51 +0100 | [diff] [blame] | 103 | int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec, |
| 104 | enum irq_domain_bus_token bus_token); |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 105 | int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw); |
| 106 | void (*unmap)(struct irq_domain *d, unsigned int virq); |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 107 | int (*xlate)(struct irq_domain *d, struct device_node *node, |
| 108 | const u32 *intspec, unsigned int intsize, |
| 109 | unsigned long *out_hwirq, unsigned int *out_type); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 110 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
| 111 | /* extended V2 interfaces to support hierarchy irq_domains */ |
| 112 | int (*alloc)(struct irq_domain *d, unsigned int virq, |
| 113 | unsigned int nr_irqs, void *arg); |
| 114 | void (*free)(struct irq_domain *d, unsigned int virq, |
| 115 | unsigned int nr_irqs); |
Thomas Gleixner | 702cb0a0 | 2017-12-29 16:59:06 +0100 | [diff] [blame] | 116 | int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool reserve); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 117 | void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data); |
Marc Zyngier | 11e4438e | 2015-10-13 12:51:32 +0100 | [diff] [blame] | 118 | int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec, |
| 119 | unsigned long *out_hwirq, unsigned int *out_type); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 120 | #endif |
Thomas Gleixner | c3e7239 | 2017-09-13 23:29:06 +0200 | [diff] [blame] | 121 | #ifdef CONFIG_GENERIC_IRQ_DEBUGFS |
| 122 | void (*debug_show)(struct seq_file *m, struct irq_domain *d, |
| 123 | struct irq_data *irqd, int ind); |
| 124 | #endif |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 125 | }; |
| 126 | |
Thomas Gleixner | 088f40b | 2013-05-06 14:30:27 +0000 | [diff] [blame] | 127 | extern struct irq_domain_ops irq_generic_chip_ops; |
| 128 | |
| 129 | struct irq_domain_chip_generic; |
| 130 | |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 131 | /** |
| 132 | * struct irq_domain - Hardware interrupt number translation object |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 133 | * @link: Element in global irq_domain list. |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 134 | * @name: Name of interrupt domain |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 135 | * @ops: pointer to irq_domain methods |
| 136 | * @host_data: private data pointer for use by owner. Not touched by irq_domain |
| 137 | * core code. |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 138 | * @flags: host per irq_domain flags |
Thomas Gleixner | 9dc6be3 | 2017-06-20 01:37:16 +0200 | [diff] [blame] | 139 | * @mapcount: The number of mapped interrupts |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 140 | * |
| 141 | * Optional elements |
Dou Liyang | 4b82130 | 2017-10-30 10:15:00 +0800 | [diff] [blame] | 142 | * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy |
| 143 | * to swap it for the of_node via the irq_domain_get_of_node accessor |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 144 | * @gc: Pointer to a list of generic chips. There is a helper function for |
| 145 | * setting up one or more generic chips for interrupt controllers |
| 146 | * drivers using the generic chip library which uses this pointer. |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 147 | * @parent: Pointer to parent irq_domain to support hierarchy irq_domains |
Thomas Gleixner | 087cdfb | 2017-06-20 01:37:17 +0200 | [diff] [blame] | 148 | * @debugfs_file: dentry for the domain debugfs file |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 149 | * |
| 150 | * Revmap data, used internally by irq_domain |
| 151 | * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that |
| 152 | * support direct mapping |
| 153 | * @revmap_size: Size of the linear map table @linear_revmap[] |
| 154 | * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map |
| 155 | * @linear_revmap: Linear table of hwirq->virq reverse mappings |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 156 | */ |
| 157 | struct irq_domain { |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 158 | struct list_head link; |
Grant Likely | 0bb4afb | 2013-06-06 14:23:30 +0100 | [diff] [blame] | 159 | const char *name; |
Grant Likely | a18dc81 | 2012-01-26 12:12:14 -0700 | [diff] [blame] | 160 | const struct irq_domain_ops *ops; |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 161 | void *host_data; |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 162 | unsigned int flags; |
Thomas Gleixner | 9dc6be3 | 2017-06-20 01:37:16 +0200 | [diff] [blame] | 163 | unsigned int mapcount; |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 164 | |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 165 | /* Optional data */ |
Marc Zyngier | f110711 | 2015-10-13 12:51:30 +0100 | [diff] [blame] | 166 | struct fwnode_handle *fwnode; |
Marc Zyngier | ad3aedf | 2015-07-28 14:46:08 +0100 | [diff] [blame] | 167 | enum irq_domain_bus_token bus_token; |
Thomas Gleixner | 088f40b | 2013-05-06 14:30:27 +0000 | [diff] [blame] | 168 | struct irq_domain_chip_generic *gc; |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 169 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
| 170 | struct irq_domain *parent; |
| 171 | #endif |
Thomas Gleixner | 087cdfb | 2017-06-20 01:37:17 +0200 | [diff] [blame] | 172 | #ifdef CONFIG_GENERIC_IRQ_DEBUGFS |
| 173 | struct dentry *debugfs_file; |
| 174 | #endif |
Grant Likely | cef5075 | 2012-07-11 17:24:31 +0100 | [diff] [blame] | 175 | |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 176 | /* reverse map data. The linear map gets appended to the irq_domain */ |
Grant Likely | ddaf144 | 2013-06-10 01:06:02 +0100 | [diff] [blame] | 177 | irq_hw_number_t hwirq_max; |
Grant Likely | 1aa0dd9 | 2013-06-08 12:03:59 +0100 | [diff] [blame] | 178 | unsigned int revmap_direct_max_irq; |
| 179 | unsigned int revmap_size; |
| 180 | struct radix_tree_root revmap_tree; |
Masahiro Yamada | f1d7835 | 2017-10-05 10:44:54 +0900 | [diff] [blame] | 181 | struct mutex revmap_tree_mutex; |
Grant Likely | cef5075 | 2012-07-11 17:24:31 +0100 | [diff] [blame] | 182 | unsigned int linear_revmap[]; |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 183 | }; |
| 184 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 185 | /* Irq domain flags */ |
| 186 | enum { |
| 187 | /* Irq domain is hierarchical */ |
| 188 | IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), |
| 189 | |
Marc Zyngier | 6a6544e | 2017-06-20 22:17:44 +0100 | [diff] [blame] | 190 | /* Irq domain name was allocated in __irq_domain_add() */ |
| 191 | IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6), |
Jiang Liu | 36d7273 | 2014-11-15 22:24:01 +0800 | [diff] [blame] | 192 | |
Qais Yousef | 0abefba | 2015-12-08 13:20:12 +0000 | [diff] [blame] | 193 | /* Irq domain is an IPI domain with virq per cpu */ |
| 194 | IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2), |
| 195 | |
| 196 | /* Irq domain is an IPI domain with single virq */ |
| 197 | IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3), |
| 198 | |
Eric Auger | 631a963 | 2017-01-19 20:57:57 +0000 | [diff] [blame] | 199 | /* Irq domain implements MSIs */ |
| 200 | IRQ_DOMAIN_FLAG_MSI = (1 << 4), |
| 201 | |
| 202 | /* Irq domain implements MSI remapping */ |
| 203 | IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5), |
| 204 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 205 | /* |
| 206 | * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved |
| 207 | * for implementation specific purposes and ignored by the |
| 208 | * core code. |
| 209 | */ |
| 210 | IRQ_DOMAIN_FLAG_NONCORE = (1 << 16), |
| 211 | }; |
| 212 | |
Marc Zyngier | 10abc7d | 2015-10-09 15:50:11 +0100 | [diff] [blame] | 213 | static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d) |
| 214 | { |
Marc Zyngier | f110711 | 2015-10-13 12:51:30 +0100 | [diff] [blame] | 215 | return to_of_node(d->fwnode); |
Marc Zyngier | 10abc7d | 2015-10-09 15:50:11 +0100 | [diff] [blame] | 216 | } |
| 217 | |
Grant Likely | 7bb69ba | 2012-02-14 14:06:48 -0700 | [diff] [blame] | 218 | #ifdef CONFIG_IRQ_DOMAIN |
Thomas Gleixner | d59f661 | 2017-06-20 01:37:05 +0200 | [diff] [blame] | 219 | struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id, |
| 220 | const char *name, void *data); |
| 221 | |
| 222 | enum { |
| 223 | IRQCHIP_FWNODE_REAL, |
| 224 | IRQCHIP_FWNODE_NAMED, |
| 225 | IRQCHIP_FWNODE_NAMED_ID, |
| 226 | }; |
| 227 | |
| 228 | static inline |
| 229 | struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name) |
| 230 | { |
| 231 | return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL); |
| 232 | } |
| 233 | |
| 234 | static inline |
| 235 | struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id) |
| 236 | { |
| 237 | return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name, |
| 238 | NULL); |
| 239 | } |
| 240 | |
| 241 | static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data) |
| 242 | { |
| 243 | return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data); |
| 244 | } |
| 245 | |
Marc Zyngier | b145dcc | 2015-10-13 12:51:36 +0100 | [diff] [blame] | 246 | void irq_domain_free_fwnode(struct fwnode_handle *fwnode); |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 247 | struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size, |
Grant Likely | ddaf144 | 2013-06-10 01:06:02 +0100 | [diff] [blame] | 248 | irq_hw_number_t hwirq_max, int direct_max, |
Grant Likely | fa40f37 | 2013-06-08 12:57:40 +0100 | [diff] [blame] | 249 | const struct irq_domain_ops *ops, |
| 250 | void *host_data); |
Mark Brown | 781d0f4 | 2012-07-05 12:19:19 +0100 | [diff] [blame] | 251 | struct irq_domain *irq_domain_add_simple(struct device_node *of_node, |
| 252 | unsigned int size, |
| 253 | unsigned int first_irq, |
| 254 | const struct irq_domain_ops *ops, |
| 255 | void *host_data); |
Grant Likely | a8db8cf | 2012-02-14 14:06:54 -0700 | [diff] [blame] | 256 | struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, |
Grant Likely | 1bc04f2 | 2012-02-14 14:06:55 -0700 | [diff] [blame] | 257 | unsigned int size, |
| 258 | unsigned int first_irq, |
| 259 | irq_hw_number_t first_hwirq, |
Grant Likely | a18dc81 | 2012-01-26 12:12:14 -0700 | [diff] [blame] | 260 | const struct irq_domain_ops *ops, |
Grant Likely | a8db8cf | 2012-02-14 14:06:54 -0700 | [diff] [blame] | 261 | void *host_data); |
Marc Zyngier | 651e8b5 | 2016-04-11 09:57:51 +0100 | [diff] [blame] | 262 | extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec, |
Marc Zyngier | 130b8c6 | 2015-10-13 12:51:31 +0100 | [diff] [blame] | 263 | enum irq_domain_bus_token bus_token); |
Eric Auger | c7b41f0 | 2017-01-19 20:57:59 +0000 | [diff] [blame] | 264 | extern bool irq_domain_check_msi_remap(void); |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 265 | extern void irq_set_default_host(struct irq_domain *host); |
Qais Yousef | ac0a0cd | 2015-12-08 13:20:18 +0000 | [diff] [blame] | 266 | extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs, |
Thomas Gleixner | 06ee6d5 | 2016-07-04 17:39:24 +0900 | [diff] [blame] | 267 | irq_hw_number_t hwirq, int node, |
| 268 | const struct cpumask *affinity); |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 269 | |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 270 | static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node) |
| 271 | { |
| 272 | return node ? &node->fwnode : NULL; |
| 273 | } |
| 274 | |
Sakari Ailus | db3e50f | 2017-07-21 14:39:31 +0300 | [diff] [blame] | 275 | extern const struct fwnode_operations irqchip_fwnode_ops; |
| 276 | |
Suravee Suthikulpanit | 75aba7b | 2015-12-10 08:55:28 -0800 | [diff] [blame] | 277 | static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode) |
| 278 | { |
Sakari Ailus | db3e50f | 2017-07-21 14:39:31 +0300 | [diff] [blame] | 279 | return fwnode && fwnode->ops == &irqchip_fwnode_ops; |
Suravee Suthikulpanit | 75aba7b | 2015-12-10 08:55:28 -0800 | [diff] [blame] | 280 | } |
| 281 | |
Marc Zyngier | 61d0a00 | 2017-06-22 11:34:57 +0100 | [diff] [blame] | 282 | extern void irq_domain_update_bus_token(struct irq_domain *domain, |
| 283 | enum irq_domain_bus_token bus_token); |
| 284 | |
Marc Zyngier | 651e8b5 | 2016-04-11 09:57:51 +0100 | [diff] [blame] | 285 | static inline |
| 286 | struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode, |
| 287 | enum irq_domain_bus_token bus_token) |
| 288 | { |
| 289 | struct irq_fwspec fwspec = { |
| 290 | .fwnode = fwnode, |
| 291 | }; |
| 292 | |
| 293 | return irq_find_matching_fwspec(&fwspec, bus_token); |
| 294 | } |
| 295 | |
Marc Zyngier | 130b8c6 | 2015-10-13 12:51:31 +0100 | [diff] [blame] | 296 | static inline struct irq_domain *irq_find_matching_host(struct device_node *node, |
| 297 | enum irq_domain_bus_token bus_token) |
| 298 | { |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 299 | return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token); |
Marc Zyngier | 130b8c6 | 2015-10-13 12:51:31 +0100 | [diff] [blame] | 300 | } |
| 301 | |
Marc Zyngier | ad3aedf | 2015-07-28 14:46:08 +0100 | [diff] [blame] | 302 | static inline struct irq_domain *irq_find_host(struct device_node *node) |
| 303 | { |
| 304 | return irq_find_matching_host(node, DOMAIN_BUS_ANY); |
| 305 | } |
| 306 | |
Grant Likely | fa40f37 | 2013-06-08 12:57:40 +0100 | [diff] [blame] | 307 | /** |
| 308 | * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain. |
| 309 | * @of_node: pointer to interrupt controller's device tree node. |
| 310 | * @size: Number of interrupts in the domain. |
| 311 | * @ops: map/unmap domain callbacks |
| 312 | * @host_data: Controller private data pointer |
| 313 | */ |
| 314 | static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node, |
| 315 | unsigned int size, |
| 316 | const struct irq_domain_ops *ops, |
| 317 | void *host_data) |
| 318 | { |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 319 | return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data); |
Grant Likely | fa40f37 | 2013-06-08 12:57:40 +0100 | [diff] [blame] | 320 | } |
| 321 | static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node, |
| 322 | unsigned int max_irq, |
| 323 | const struct irq_domain_ops *ops, |
| 324 | void *host_data) |
| 325 | { |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 326 | return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data); |
Grant Likely | fa40f37 | 2013-06-08 12:57:40 +0100 | [diff] [blame] | 327 | } |
Grant Likely | 1bc04f2 | 2012-02-14 14:06:55 -0700 | [diff] [blame] | 328 | static inline struct irq_domain *irq_domain_add_legacy_isa( |
| 329 | struct device_node *of_node, |
Grant Likely | a18dc81 | 2012-01-26 12:12:14 -0700 | [diff] [blame] | 330 | const struct irq_domain_ops *ops, |
Grant Likely | 1bc04f2 | 2012-02-14 14:06:55 -0700 | [diff] [blame] | 331 | void *host_data) |
| 332 | { |
| 333 | return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, |
| 334 | host_data); |
| 335 | } |
Grant Likely | cef5075 | 2012-07-11 17:24:31 +0100 | [diff] [blame] | 336 | static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node, |
| 337 | const struct irq_domain_ops *ops, |
| 338 | void *host_data) |
| 339 | { |
Marc Zyngier | 1bf4ddc | 2015-10-13 12:51:35 +0100 | [diff] [blame] | 340 | return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data); |
| 341 | } |
| 342 | |
| 343 | static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode, |
| 344 | unsigned int size, |
| 345 | const struct irq_domain_ops *ops, |
| 346 | void *host_data) |
| 347 | { |
| 348 | return __irq_domain_add(fwnode, size, size, 0, ops, host_data); |
| 349 | } |
| 350 | |
| 351 | static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode, |
| 352 | const struct irq_domain_ops *ops, |
| 353 | void *host_data) |
| 354 | { |
| 355 | return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data); |
Grant Likely | cef5075 | 2012-07-11 17:24:31 +0100 | [diff] [blame] | 356 | } |
Paul Mundt | 58ee99a | 2012-05-19 15:11:41 +0900 | [diff] [blame] | 357 | |
| 358 | extern void irq_domain_remove(struct irq_domain *host); |
| 359 | |
Grant Likely | ddaf144 | 2013-06-10 01:06:02 +0100 | [diff] [blame] | 360 | extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq, |
| 361 | irq_hw_number_t hwirq); |
| 362 | extern void irq_domain_associate_many(struct irq_domain *domain, |
| 363 | unsigned int irq_base, |
| 364 | irq_hw_number_t hwirq_base, int count); |
Jiang Liu | 43a7759 | 2014-06-09 16:20:05 +0800 | [diff] [blame] | 365 | extern void irq_domain_disassociate(struct irq_domain *domain, |
| 366 | unsigned int irq); |
Grant Likely | 98aa468 | 2012-06-17 16:17:04 -0600 | [diff] [blame] | 367 | |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 368 | extern unsigned int irq_create_mapping(struct irq_domain *host, |
| 369 | irq_hw_number_t hwirq); |
Marc Zyngier | c0131f0 | 2015-10-13 12:51:34 +0100 | [diff] [blame] | 370 | extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec); |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 371 | extern void irq_dispose_mapping(unsigned int virq); |
Grant Likely | d3dcb43 | 2013-06-10 12:19:17 +0100 | [diff] [blame] | 372 | |
| 373 | /** |
| 374 | * irq_linear_revmap() - Find a linux irq from a hw irq number. |
| 375 | * @domain: domain owning this hardware interrupt |
| 376 | * @hwirq: hardware irq number in that domain space |
| 377 | * |
| 378 | * This is a fast path alternative to irq_find_mapping() that can be |
| 379 | * called directly by irq controller code to save a handful of |
| 380 | * instructions. It is always safe to call, but won't find irqs mapped |
| 381 | * using the radix tree. |
| 382 | */ |
| 383 | static inline unsigned int irq_linear_revmap(struct irq_domain *domain, |
| 384 | irq_hw_number_t hwirq) |
| 385 | { |
| 386 | return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0; |
| 387 | } |
Grant Likely | cc79ca6 | 2012-02-16 01:37:49 -0700 | [diff] [blame] | 388 | extern unsigned int irq_find_mapping(struct irq_domain *host, |
| 389 | irq_hw_number_t hwirq); |
| 390 | extern unsigned int irq_create_direct_mapping(struct irq_domain *host); |
Grant Likely | 98aa468 | 2012-06-17 16:17:04 -0600 | [diff] [blame] | 391 | extern int irq_create_strict_mappings(struct irq_domain *domain, |
| 392 | unsigned int irq_base, |
| 393 | irq_hw_number_t hwirq_base, int count); |
| 394 | |
| 395 | static inline int irq_create_identity_mapping(struct irq_domain *host, |
| 396 | irq_hw_number_t hwirq) |
| 397 | { |
| 398 | return irq_create_strict_mappings(host, hwirq, hwirq, 1); |
| 399 | } |
| 400 | |
Grant Likely | a18dc81 | 2012-01-26 12:12:14 -0700 | [diff] [blame] | 401 | extern const struct irq_domain_ops irq_domain_simple_ops; |
Grant Likely | 16b2e6e | 2012-01-26 11:26:52 -0700 | [diff] [blame] | 402 | |
| 403 | /* stock xlate functions */ |
| 404 | int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr, |
| 405 | const u32 *intspec, unsigned int intsize, |
| 406 | irq_hw_number_t *out_hwirq, unsigned int *out_type); |
| 407 | int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr, |
| 408 | const u32 *intspec, unsigned int intsize, |
| 409 | irq_hw_number_t *out_hwirq, unsigned int *out_type); |
| 410 | int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr, |
| 411 | const u32 *intspec, unsigned int intsize, |
| 412 | irq_hw_number_t *out_hwirq, unsigned int *out_type); |
| 413 | |
Qais Yousef | d17bf24 | 2015-12-08 13:20:19 +0000 | [diff] [blame] | 414 | /* IPI functions */ |
Matt Redfearn | 7cec18a | 2016-04-25 08:14:24 +0100 | [diff] [blame] | 415 | int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest); |
| 416 | int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest); |
Qais Yousef | d17bf24 | 2015-12-08 13:20:19 +0000 | [diff] [blame] | 417 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 418 | /* V2 interfaces to support hierarchy IRQ domains. */ |
| 419 | extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, |
| 420 | unsigned int virq); |
Stefan Agner | 5f22f5c | 2015-05-16 11:44:13 +0200 | [diff] [blame] | 421 | extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, |
| 422 | irq_hw_number_t hwirq, struct irq_chip *chip, |
| 423 | void *chip_data, irq_flow_handler_t handler, |
| 424 | void *handler_data, const char *handler_name); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 425 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
Marc Zyngier | 2a5e9a0 | 2015-10-13 12:51:43 +0100 | [diff] [blame] | 426 | extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent, |
Jiang Liu | afb7da8 | 2014-11-15 22:24:02 +0800 | [diff] [blame] | 427 | unsigned int flags, unsigned int size, |
Marc Zyngier | 2a5e9a0 | 2015-10-13 12:51:43 +0100 | [diff] [blame] | 428 | struct fwnode_handle *fwnode, |
Jiang Liu | afb7da8 | 2014-11-15 22:24:02 +0800 | [diff] [blame] | 429 | const struct irq_domain_ops *ops, void *host_data); |
Marc Zyngier | 2a5e9a0 | 2015-10-13 12:51:43 +0100 | [diff] [blame] | 430 | |
| 431 | static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent, |
| 432 | unsigned int flags, |
| 433 | unsigned int size, |
| 434 | struct device_node *node, |
| 435 | const struct irq_domain_ops *ops, |
| 436 | void *host_data) |
| 437 | { |
| 438 | return irq_domain_create_hierarchy(parent, flags, size, |
| 439 | of_node_to_fwnode(node), |
| 440 | ops, host_data); |
| 441 | } |
| 442 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 443 | extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, |
| 444 | unsigned int nr_irqs, int node, void *arg, |
Thomas Gleixner | 06ee6d5 | 2016-07-04 17:39:24 +0900 | [diff] [blame] | 445 | bool realloc, const struct cpumask *affinity); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 446 | extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); |
Thomas Gleixner | 42e1cc2 | 2017-09-13 23:29:12 +0200 | [diff] [blame] | 447 | extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 448 | extern void irq_domain_deactivate_irq(struct irq_data *irq_data); |
| 449 | |
| 450 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, |
| 451 | unsigned int nr_irqs, int node, void *arg) |
| 452 | { |
Thomas Gleixner | 06ee6d5 | 2016-07-04 17:39:24 +0900 | [diff] [blame] | 453 | return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false, |
| 454 | NULL); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 455 | } |
| 456 | |
Marc Zyngier | 6a6544e | 2017-06-20 22:17:44 +0100 | [diff] [blame] | 457 | extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain, |
Marc Zyngier | c466595 | 2015-11-23 08:26:04 +0000 | [diff] [blame] | 458 | unsigned int irq_base, |
| 459 | unsigned int nr_irqs, void *arg); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 460 | extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, |
| 461 | unsigned int virq, |
| 462 | irq_hw_number_t hwirq, |
| 463 | struct irq_chip *chip, |
| 464 | void *chip_data); |
| 465 | extern void irq_domain_reset_irq_data(struct irq_data *irq_data); |
| 466 | extern void irq_domain_free_irqs_common(struct irq_domain *domain, |
| 467 | unsigned int virq, |
| 468 | unsigned int nr_irqs); |
| 469 | extern void irq_domain_free_irqs_top(struct irq_domain *domain, |
| 470 | unsigned int virq, unsigned int nr_irqs); |
| 471 | |
David Daney | 495c38d3 | 2017-08-17 17:53:34 -0700 | [diff] [blame] | 472 | extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg); |
| 473 | extern int irq_domain_pop_irq(struct irq_domain *domain, int virq); |
| 474 | |
Jiang Liu | 36d7273 | 2014-11-15 22:24:01 +0800 | [diff] [blame] | 475 | extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain, |
| 476 | unsigned int irq_base, |
| 477 | unsigned int nr_irqs, void *arg); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 478 | |
Jiang Liu | 36d7273 | 2014-11-15 22:24:01 +0800 | [diff] [blame] | 479 | extern void irq_domain_free_irqs_parent(struct irq_domain *domain, |
| 480 | unsigned int irq_base, |
| 481 | unsigned int nr_irqs); |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 482 | |
| 483 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) |
| 484 | { |
| 485 | return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY; |
| 486 | } |
Qais Yousef | 0abefba | 2015-12-08 13:20:12 +0000 | [diff] [blame] | 487 | |
| 488 | static inline bool irq_domain_is_ipi(struct irq_domain *domain) |
| 489 | { |
| 490 | return domain->flags & |
| 491 | (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE); |
| 492 | } |
| 493 | |
| 494 | static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain) |
| 495 | { |
| 496 | return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU; |
| 497 | } |
| 498 | |
| 499 | static inline bool irq_domain_is_ipi_single(struct irq_domain *domain) |
| 500 | { |
| 501 | return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE; |
| 502 | } |
Eric Auger | 631a963 | 2017-01-19 20:57:57 +0000 | [diff] [blame] | 503 | |
| 504 | static inline bool irq_domain_is_msi(struct irq_domain *domain) |
| 505 | { |
| 506 | return domain->flags & IRQ_DOMAIN_FLAG_MSI; |
| 507 | } |
| 508 | |
| 509 | static inline bool irq_domain_is_msi_remap(struct irq_domain *domain) |
| 510 | { |
| 511 | return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP; |
| 512 | } |
| 513 | |
| 514 | extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain); |
| 515 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 516 | #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */ |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 517 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, |
| 518 | unsigned int nr_irqs, int node, void *arg) |
| 519 | { |
| 520 | return -1; |
| 521 | } |
| 522 | |
Jon Hunter | 1e2a7d7 | 2016-06-07 16:12:28 +0100 | [diff] [blame] | 523 | static inline void irq_domain_free_irqs(unsigned int virq, |
| 524 | unsigned int nr_irqs) { } |
| 525 | |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 526 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) |
| 527 | { |
| 528 | return false; |
| 529 | } |
Qais Yousef | 0abefba | 2015-12-08 13:20:12 +0000 | [diff] [blame] | 530 | |
| 531 | static inline bool irq_domain_is_ipi(struct irq_domain *domain) |
| 532 | { |
| 533 | return false; |
| 534 | } |
| 535 | |
| 536 | static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain) |
| 537 | { |
| 538 | return false; |
| 539 | } |
| 540 | |
| 541 | static inline bool irq_domain_is_ipi_single(struct irq_domain *domain) |
| 542 | { |
| 543 | return false; |
| 544 | } |
Eric Auger | 631a963 | 2017-01-19 20:57:57 +0000 | [diff] [blame] | 545 | |
| 546 | static inline bool irq_domain_is_msi(struct irq_domain *domain) |
| 547 | { |
| 548 | return false; |
| 549 | } |
| 550 | |
| 551 | static inline bool irq_domain_is_msi_remap(struct irq_domain *domain) |
| 552 | { |
| 553 | return false; |
| 554 | } |
| 555 | |
| 556 | static inline bool |
| 557 | irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain) |
| 558 | { |
| 559 | return false; |
| 560 | } |
Jiang Liu | f8264e3 | 2014-11-06 22:20:14 +0800 | [diff] [blame] | 561 | #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */ |
| 562 | |
Grant Likely | d593f25 | 2012-02-24 08:24:17 -0700 | [diff] [blame] | 563 | #else /* CONFIG_IRQ_DOMAIN */ |
| 564 | static inline void irq_dispose_mapping(unsigned int virq) { } |
Suravee Suthikulpanit | 471036b | 2015-12-10 08:55:27 -0800 | [diff] [blame] | 565 | static inline struct irq_domain *irq_find_matching_fwnode( |
| 566 | struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token) |
| 567 | { |
| 568 | return NULL; |
| 569 | } |
Mian Yousaf Kaukab | b3e2284 | 2017-03-02 16:11:47 +0100 | [diff] [blame] | 570 | static inline bool irq_domain_check_msi_remap(void) |
| 571 | { |
| 572 | return false; |
| 573 | } |
Grant Likely | d593f25 | 2012-02-24 08:24:17 -0700 | [diff] [blame] | 574 | #endif /* !CONFIG_IRQ_DOMAIN */ |
Grant Likely | 7e71330 | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 575 | |
Grant Likely | 08a543a | 2011-07-26 03:19:06 -0600 | [diff] [blame] | 576 | #endif /* _LINUX_IRQDOMAIN_H */ |