1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 2015 ARM Ltd.
6 * Author: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>
8 #include <linux/acpi.h>
10 #include <linux/irqdomain.h>
13 enum acpi_irq_model_id acpi_irq_model
;
15 static struct fwnode_handle
*acpi_gsi_domain_id
;
18 * acpi_gsi_to_irq() - Retrieve the linux irq number for a given GSI
19 * @gsi: GSI IRQ number to map
20 * @irq: pointer where linux IRQ number is stored
22 * irq location updated with irq value [>0 on success, 0 on failure]
24 * Returns: 0 on success
27 int acpi_gsi_to_irq(u32 gsi
, unsigned int *irq
)
29 struct irq_domain
*d
= irq_find_matching_fwnode(acpi_gsi_domain_id
,
32 *irq
= irq_find_mapping(d
, gsi
);
34 * *irq == 0 means no mapping, that should
35 * be reported as a failure
37 return (*irq
> 0) ? 0 : -EINVAL
;
39 EXPORT_SYMBOL_GPL(acpi_gsi_to_irq
);
42 * acpi_register_gsi() - Map a GSI to a linux IRQ number
43 * @dev: device for which IRQ has to be mapped
44 * @gsi: GSI IRQ number
45 * @trigger: trigger type of the GSI number to be mapped
46 * @polarity: polarity of the GSI to be mapped
48 * Returns: a valid linux IRQ number on success
51 int acpi_register_gsi(struct device
*dev
, u32 gsi
, int trigger
,
54 struct irq_fwspec fwspec
;
56 if (WARN_ON(!acpi_gsi_domain_id
)) {
57 pr_warn("GSI: No registered irqchip, giving up\n");
61 fwspec
.fwnode
= acpi_gsi_domain_id
;
62 fwspec
.param
[0] = gsi
;
63 fwspec
.param
[1] = acpi_dev_get_irq_type(trigger
, polarity
);
64 fwspec
.param_count
= 2;
66 return irq_create_fwspec_mapping(&fwspec
);
68 EXPORT_SYMBOL_GPL(acpi_register_gsi
);
71 * acpi_unregister_gsi() - Free a GSI<->linux IRQ number mapping
72 * @gsi: GSI IRQ number
74 void acpi_unregister_gsi(u32 gsi
)
76 struct irq_domain
*d
= irq_find_matching_fwnode(acpi_gsi_domain_id
,
80 if (WARN_ON(acpi_irq_model
== ACPI_IRQ_MODEL_GIC
&& gsi
< 16))
83 irq
= irq_find_mapping(d
, gsi
);
84 irq_dispose_mapping(irq
);
86 EXPORT_SYMBOL_GPL(acpi_unregister_gsi
);
89 * acpi_get_irq_source_fwhandle() - Retrieve fwhandle from IRQ resource source.
90 * @source: acpi_resource_source to use for the lookup.
93 * Retrieve the fwhandle of the device referenced by the given IRQ resource
97 * The referenced device fwhandle or NULL on failure
99 static struct fwnode_handle
*
100 acpi_get_irq_source_fwhandle(const struct acpi_resource_source
*source
)
102 struct fwnode_handle
*result
;
103 struct acpi_device
*device
;
107 if (!source
->string_length
)
108 return acpi_gsi_domain_id
;
110 status
= acpi_get_handle(NULL
, source
->string_ptr
, &handle
);
111 if (WARN_ON(ACPI_FAILURE(status
)))
114 device
= acpi_bus_get_acpi_device(handle
);
115 if (WARN_ON(!device
))
118 result
= &device
->fwnode
;
119 acpi_bus_put_acpi_device(device
);
124 * Context for the resource walk used to lookup IRQ resources.
125 * Contains a return code, the lookup index, and references to the flags
126 * and fwspec where the result is returned.
128 struct acpi_irq_parse_one_ctx
{
131 unsigned long *res_flags
;
132 struct irq_fwspec
*fwspec
;
136 * acpi_irq_parse_one_match - Handle a matching IRQ resource.
137 * @fwnode: matching fwnode
138 * @hwirq: hardware IRQ number
139 * @triggering: triggering attributes of hwirq
140 * @polarity: polarity attributes of hwirq
141 * @polarity: polarity attributes of hwirq
142 * @shareable: shareable attributes of hwirq
143 * @ctx: acpi_irq_parse_one_ctx updated by this function
146 * Handle a matching IRQ resource by populating the given ctx with
147 * the information passed.
149 static inline void acpi_irq_parse_one_match(struct fwnode_handle
*fwnode
,
150 u32 hwirq
, u8 triggering
,
151 u8 polarity
, u8 shareable
,
152 struct acpi_irq_parse_one_ctx
*ctx
)
157 *ctx
->res_flags
= acpi_dev_irq_flags(triggering
, polarity
, shareable
);
158 ctx
->fwspec
->fwnode
= fwnode
;
159 ctx
->fwspec
->param
[0] = hwirq
;
160 ctx
->fwspec
->param
[1] = acpi_dev_get_irq_type(triggering
, polarity
);
161 ctx
->fwspec
->param_count
= 2;
165 * acpi_irq_parse_one_cb - Handle the given resource.
166 * @ares: resource to handle
167 * @context: context for the walk
170 * This is called by acpi_walk_resources passing each resource returned by
171 * the _CRS method. We only inspect IRQ resources. Since IRQ resources
172 * might contain multiple interrupts we check if the index is within this
173 * one's interrupt array, otherwise we subtract the current resource IRQ
174 * count from the lookup index to prepare for the next resource.
175 * Once a match is found we call acpi_irq_parse_one_match to populate
176 * the result and end the walk by returning AE_CTRL_TERMINATE.
179 * AE_OK if the walk should continue, AE_CTRL_TERMINATE if a matching
180 * IRQ resource was found.
182 static acpi_status
acpi_irq_parse_one_cb(struct acpi_resource
*ares
,
185 struct acpi_irq_parse_one_ctx
*ctx
= context
;
186 struct acpi_resource_irq
*irq
;
187 struct acpi_resource_extended_irq
*eirq
;
188 struct fwnode_handle
*fwnode
;
190 switch (ares
->type
) {
191 case ACPI_RESOURCE_TYPE_IRQ
:
192 irq
= &ares
->data
.irq
;
193 if (ctx
->index
>= irq
->interrupt_count
) {
194 ctx
->index
-= irq
->interrupt_count
;
197 fwnode
= acpi_gsi_domain_id
;
198 acpi_irq_parse_one_match(fwnode
, irq
->interrupts
[ctx
->index
],
199 irq
->triggering
, irq
->polarity
,
200 irq
->shareable
, ctx
);
201 return AE_CTRL_TERMINATE
;
202 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
203 eirq
= &ares
->data
.extended_irq
;
204 if (eirq
->producer_consumer
== ACPI_PRODUCER
)
206 if (ctx
->index
>= eirq
->interrupt_count
) {
207 ctx
->index
-= eirq
->interrupt_count
;
210 fwnode
= acpi_get_irq_source_fwhandle(&eirq
->resource_source
);
211 acpi_irq_parse_one_match(fwnode
, eirq
->interrupts
[ctx
->index
],
212 eirq
->triggering
, eirq
->polarity
,
213 eirq
->shareable
, ctx
);
214 return AE_CTRL_TERMINATE
;
221 * acpi_irq_parse_one - Resolve an interrupt for a device
222 * @handle: the device whose interrupt is to be resolved
223 * @index: index of the interrupt to resolve
224 * @fwspec: structure irq_fwspec filled by this function
225 * @flags: resource flags filled by this function
228 * Resolves an interrupt for a device by walking its CRS resources to find
229 * the appropriate ACPI IRQ resource and populating the given struct irq_fwspec
233 * The result stored in ctx.rc by the callback, or the default -EINVAL value
234 * if an error occurs.
236 static int acpi_irq_parse_one(acpi_handle handle
, unsigned int index
,
237 struct irq_fwspec
*fwspec
, unsigned long *flags
)
239 struct acpi_irq_parse_one_ctx ctx
= { -EINVAL
, index
, flags
, fwspec
};
241 acpi_walk_resources(handle
, METHOD_NAME__CRS
, acpi_irq_parse_one_cb
, &ctx
);
246 * acpi_irq_get - Lookup an ACPI IRQ resource and use it to initialize resource.
247 * @handle: ACPI device handle
248 * @index: ACPI IRQ resource index to lookup
249 * @res: Linux IRQ resource to initialize
252 * Look for the ACPI IRQ resource with the given index and use it to initialize
253 * the given Linux IRQ resource.
257 * -EINVAL if an error occurs
258 * -EPROBE_DEFER if the IRQ lookup/conversion failed
260 int acpi_irq_get(acpi_handle handle
, unsigned int index
, struct resource
*res
)
262 struct irq_fwspec fwspec
;
263 struct irq_domain
*domain
;
267 rc
= acpi_irq_parse_one(handle
, index
, &fwspec
, &flags
);
271 domain
= irq_find_matching_fwnode(fwspec
.fwnode
, DOMAIN_BUS_ANY
);
273 return -EPROBE_DEFER
;
275 rc
= irq_create_fwspec_mapping(&fwspec
);
285 EXPORT_SYMBOL_GPL(acpi_irq_get
);
288 * acpi_set_irq_model - Setup the GSI irqdomain information
289 * @model: the value assigned to acpi_irq_model
290 * @fwnode: the irq_domain identifier for mapping and looking up
293 void __init
acpi_set_irq_model(enum acpi_irq_model_id model
,
294 struct fwnode_handle
*fwnode
)
296 acpi_irq_model
= model
;
297 acpi_gsi_domain_id
= fwnode
;
301 * acpi_irq_create_hierarchy - Create a hierarchical IRQ domain with the default
302 * GSI domain as its parent.
303 * @flags: Irq domain flags associated with the domain
304 * @size: Size of the domain.
305 * @fwnode: Optional fwnode of the interrupt controller
306 * @ops: Pointer to the interrupt domain callbacks
307 * @host_data: Controller private data pointer
309 struct irq_domain
*acpi_irq_create_hierarchy(unsigned int flags
,
311 struct fwnode_handle
*fwnode
,
312 const struct irq_domain_ops
*ops
,
315 struct irq_domain
*d
= irq_find_matching_fwnode(acpi_gsi_domain_id
,
321 return irq_domain_create_hierarchy(d
, flags
, size
, fwnode
, ops
,
324 EXPORT_SYMBOL_GPL(acpi_irq_create_hierarchy
);