Loading...
1#define pr_fmt(fmt) "irq: " fmt
2
3#include <linux/debugfs.h>
4#include <linux/hardirq.h>
5#include <linux/interrupt.h>
6#include <linux/irq.h>
7#include <linux/irqdesc.h>
8#include <linux/irqdomain.h>
9#include <linux/module.h>
10#include <linux/mutex.h>
11#include <linux/of.h>
12#include <linux/of_address.h>
13#include <linux/of_irq.h>
14#include <linux/topology.h>
15#include <linux/seq_file.h>
16#include <linux/slab.h>
17#include <linux/smp.h>
18#include <linux/fs.h>
19
20static LIST_HEAD(irq_domain_list);
21static DEFINE_MUTEX(irq_domain_mutex);
22
23static DEFINE_MUTEX(revmap_trees_mutex);
24static struct irq_domain *irq_default_domain;
25
26static void irq_domain_check_hierarchy(struct irq_domain *domain);
27
28struct irqchip_fwid {
29 struct fwnode_handle fwnode;
30 char *name;
31 void *data;
32};
33
34/**
35 * irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
36 * identifying an irq domain
37 * @data: optional user-provided data
38 *
39 * Allocate a struct device_node, and return a poiner to the embedded
40 * fwnode_handle (or NULL on failure).
41 */
42struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
43{
44 struct irqchip_fwid *fwid;
45 char *name;
46
47 fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
48 name = kasprintf(GFP_KERNEL, "irqchip@%p", data);
49
50 if (!fwid || !name) {
51 kfree(fwid);
52 kfree(name);
53 return NULL;
54 }
55
56 fwid->name = name;
57 fwid->data = data;
58 fwid->fwnode.type = FWNODE_IRQCHIP;
59 return &fwid->fwnode;
60}
61EXPORT_SYMBOL_GPL(irq_domain_alloc_fwnode);
62
63/**
64 * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
65 *
66 * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
67 */
68void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
69{
70 struct irqchip_fwid *fwid;
71
72 if (WARN_ON(!is_fwnode_irqchip(fwnode)))
73 return;
74
75 fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
76 kfree(fwid->name);
77 kfree(fwid);
78}
79EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
80
81/**
82 * __irq_domain_add() - Allocate a new irq_domain data structure
83 * @fwnode: firmware node for the interrupt controller
84 * @size: Size of linear map; 0 for radix mapping only
85 * @hwirq_max: Maximum number of interrupts supported by controller
86 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
87 * direct mapping
88 * @ops: domain callbacks
89 * @host_data: Controller private data pointer
90 *
91 * Allocates and initialize and irq_domain structure.
92 * Returns pointer to IRQ domain, or NULL on failure.
93 */
94struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
95 irq_hw_number_t hwirq_max, int direct_max,
96 const struct irq_domain_ops *ops,
97 void *host_data)
98{
99 struct device_node *of_node = to_of_node(fwnode);
100 struct irq_domain *domain;
101
102 domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
103 GFP_KERNEL, of_node_to_nid(of_node));
104 if (WARN_ON(!domain))
105 return NULL;
106
107 of_node_get(of_node);
108
109 /* Fill structure */
110 INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
111 domain->ops = ops;
112 domain->host_data = host_data;
113 domain->fwnode = fwnode;
114 domain->hwirq_max = hwirq_max;
115 domain->revmap_size = size;
116 domain->revmap_direct_max_irq = direct_max;
117 irq_domain_check_hierarchy(domain);
118
119 mutex_lock(&irq_domain_mutex);
120 list_add(&domain->link, &irq_domain_list);
121 mutex_unlock(&irq_domain_mutex);
122
123 pr_debug("Added domain %s\n", domain->name);
124 return domain;
125}
126EXPORT_SYMBOL_GPL(__irq_domain_add);
127
128/**
129 * irq_domain_remove() - Remove an irq domain.
130 * @domain: domain to remove
131 *
132 * This routine is used to remove an irq domain. The caller must ensure
133 * that all mappings within the domain have been disposed of prior to
134 * use, depending on the revmap type.
135 */
136void irq_domain_remove(struct irq_domain *domain)
137{
138 mutex_lock(&irq_domain_mutex);
139
140 WARN_ON(!radix_tree_empty(&domain->revmap_tree));
141
142 list_del(&domain->link);
143
144 /*
145 * If the going away domain is the default one, reset it.
146 */
147 if (unlikely(irq_default_domain == domain))
148 irq_set_default_host(NULL);
149
150 mutex_unlock(&irq_domain_mutex);
151
152 pr_debug("Removed domain %s\n", domain->name);
153
154 of_node_put(irq_domain_get_of_node(domain));
155 kfree(domain);
156}
157EXPORT_SYMBOL_GPL(irq_domain_remove);
158
159/**
160 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
161 * @of_node: pointer to interrupt controller's device tree node.
162 * @size: total number of irqs in mapping
163 * @first_irq: first number of irq block assigned to the domain,
164 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
165 * pre-map all of the irqs in the domain to virqs starting at first_irq.
166 * @ops: domain callbacks
167 * @host_data: Controller private data pointer
168 *
169 * Allocates an irq_domain, and optionally if first_irq is positive then also
170 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
171 *
172 * This is intended to implement the expected behaviour for most
173 * interrupt controllers. If device tree is used, then first_irq will be 0 and
174 * irqs get mapped dynamically on the fly. However, if the controller requires
175 * static virq assignments (non-DT boot) then it will set that up correctly.
176 */
177struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
178 unsigned int size,
179 unsigned int first_irq,
180 const struct irq_domain_ops *ops,
181 void *host_data)
182{
183 struct irq_domain *domain;
184
185 domain = __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
186 if (!domain)
187 return NULL;
188
189 if (first_irq > 0) {
190 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
191 /* attempt to allocated irq_descs */
192 int rc = irq_alloc_descs(first_irq, first_irq, size,
193 of_node_to_nid(of_node));
194 if (rc < 0)
195 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
196 first_irq);
197 }
198 irq_domain_associate_many(domain, first_irq, 0, size);
199 }
200
201 return domain;
202}
203EXPORT_SYMBOL_GPL(irq_domain_add_simple);
204
205/**
206 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
207 * @of_node: pointer to interrupt controller's device tree node.
208 * @size: total number of irqs in legacy mapping
209 * @first_irq: first number of irq block assigned to the domain
210 * @first_hwirq: first hwirq number to use for the translation. Should normally
211 * be '0', but a positive integer can be used if the effective
212 * hwirqs numbering does not begin at zero.
213 * @ops: map/unmap domain callbacks
214 * @host_data: Controller private data pointer
215 *
216 * Note: the map() callback will be called before this function returns
217 * for all legacy interrupts except 0 (which is always the invalid irq for
218 * a legacy controller).
219 */
220struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
221 unsigned int size,
222 unsigned int first_irq,
223 irq_hw_number_t first_hwirq,
224 const struct irq_domain_ops *ops,
225 void *host_data)
226{
227 struct irq_domain *domain;
228
229 domain = __irq_domain_add(of_node_to_fwnode(of_node), first_hwirq + size,
230 first_hwirq + size, 0, ops, host_data);
231 if (domain)
232 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
233
234 return domain;
235}
236EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
237
238/**
239 * irq_find_matching_fwspec() - Locates a domain for a given fwspec
240 * @fwspec: FW specifier for an interrupt
241 * @bus_token: domain-specific data
242 */
243struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
244 enum irq_domain_bus_token bus_token)
245{
246 struct irq_domain *h, *found = NULL;
247 struct fwnode_handle *fwnode = fwspec->fwnode;
248 int rc;
249
250 /* We might want to match the legacy controller last since
251 * it might potentially be set to match all interrupts in
252 * the absence of a device node. This isn't a problem so far
253 * yet though...
254 *
255 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
256 * values must generate an exact match for the domain to be
257 * selected.
258 */
259 mutex_lock(&irq_domain_mutex);
260 list_for_each_entry(h, &irq_domain_list, link) {
261 if (h->ops->select && fwspec->param_count)
262 rc = h->ops->select(h, fwspec, bus_token);
263 else if (h->ops->match)
264 rc = h->ops->match(h, to_of_node(fwnode), bus_token);
265 else
266 rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
267 ((bus_token == DOMAIN_BUS_ANY) ||
268 (h->bus_token == bus_token)));
269
270 if (rc) {
271 found = h;
272 break;
273 }
274 }
275 mutex_unlock(&irq_domain_mutex);
276 return found;
277}
278EXPORT_SYMBOL_GPL(irq_find_matching_fwspec);
279
280/**
281 * irq_set_default_host() - Set a "default" irq domain
282 * @domain: default domain pointer
283 *
284 * For convenience, it's possible to set a "default" domain that will be used
285 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
286 * platforms that want to manipulate a few hard coded interrupt numbers that
287 * aren't properly represented in the device-tree.
288 */
289void irq_set_default_host(struct irq_domain *domain)
290{
291 pr_debug("Default domain set to @0x%p\n", domain);
292
293 irq_default_domain = domain;
294}
295EXPORT_SYMBOL_GPL(irq_set_default_host);
296
297void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
298{
299 struct irq_data *irq_data = irq_get_irq_data(irq);
300 irq_hw_number_t hwirq;
301
302 if (WARN(!irq_data || irq_data->domain != domain,
303 "virq%i doesn't exist; cannot disassociate\n", irq))
304 return;
305
306 hwirq = irq_data->hwirq;
307 irq_set_status_flags(irq, IRQ_NOREQUEST);
308
309 /* remove chip and handler */
310 irq_set_chip_and_handler(irq, NULL, NULL);
311
312 /* Make sure it's completed */
313 synchronize_irq(irq);
314
315 /* Tell the PIC about it */
316 if (domain->ops->unmap)
317 domain->ops->unmap(domain, irq);
318 smp_mb();
319
320 irq_data->domain = NULL;
321 irq_data->hwirq = 0;
322
323 /* Clear reverse map for this hwirq */
324 if (hwirq < domain->revmap_size) {
325 domain->linear_revmap[hwirq] = 0;
326 } else {
327 mutex_lock(&revmap_trees_mutex);
328 radix_tree_delete(&domain->revmap_tree, hwirq);
329 mutex_unlock(&revmap_trees_mutex);
330 }
331}
332
333int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
334 irq_hw_number_t hwirq)
335{
336 struct irq_data *irq_data = irq_get_irq_data(virq);
337 int ret;
338
339 if (WARN(hwirq >= domain->hwirq_max,
340 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
341 return -EINVAL;
342 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
343 return -EINVAL;
344 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
345 return -EINVAL;
346
347 mutex_lock(&irq_domain_mutex);
348 irq_data->hwirq = hwirq;
349 irq_data->domain = domain;
350 if (domain->ops->map) {
351 ret = domain->ops->map(domain, virq, hwirq);
352 if (ret != 0) {
353 /*
354 * If map() returns -EPERM, this interrupt is protected
355 * by the firmware or some other service and shall not
356 * be mapped. Don't bother telling the user about it.
357 */
358 if (ret != -EPERM) {
359 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
360 domain->name, hwirq, virq, ret);
361 }
362 irq_data->domain = NULL;
363 irq_data->hwirq = 0;
364 mutex_unlock(&irq_domain_mutex);
365 return ret;
366 }
367
368 /* If not already assigned, give the domain the chip's name */
369 if (!domain->name && irq_data->chip)
370 domain->name = irq_data->chip->name;
371 }
372
373 if (hwirq < domain->revmap_size) {
374 domain->linear_revmap[hwirq] = virq;
375 } else {
376 mutex_lock(&revmap_trees_mutex);
377 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
378 mutex_unlock(&revmap_trees_mutex);
379 }
380 mutex_unlock(&irq_domain_mutex);
381
382 irq_clear_status_flags(virq, IRQ_NOREQUEST);
383
384 return 0;
385}
386EXPORT_SYMBOL_GPL(irq_domain_associate);
387
388void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
389 irq_hw_number_t hwirq_base, int count)
390{
391 struct device_node *of_node;
392 int i;
393
394 of_node = irq_domain_get_of_node(domain);
395 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
396 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
397
398 for (i = 0; i < count; i++) {
399 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
400 }
401}
402EXPORT_SYMBOL_GPL(irq_domain_associate_many);
403
404/**
405 * irq_create_direct_mapping() - Allocate an irq for direct mapping
406 * @domain: domain to allocate the irq for or NULL for default domain
407 *
408 * This routine is used for irq controllers which can choose the hardware
409 * interrupt numbers they generate. In such a case it's simplest to use
410 * the linux irq as the hardware interrupt number. It still uses the linear
411 * or radix tree to store the mapping, but the irq controller can optimize
412 * the revmap path by using the hwirq directly.
413 */
414unsigned int irq_create_direct_mapping(struct irq_domain *domain)
415{
416 struct device_node *of_node;
417 unsigned int virq;
418
419 if (domain == NULL)
420 domain = irq_default_domain;
421
422 of_node = irq_domain_get_of_node(domain);
423 virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
424 if (!virq) {
425 pr_debug("create_direct virq allocation failed\n");
426 return 0;
427 }
428 if (virq >= domain->revmap_direct_max_irq) {
429 pr_err("ERROR: no free irqs available below %i maximum\n",
430 domain->revmap_direct_max_irq);
431 irq_free_desc(virq);
432 return 0;
433 }
434 pr_debug("create_direct obtained virq %d\n", virq);
435
436 if (irq_domain_associate(domain, virq, virq)) {
437 irq_free_desc(virq);
438 return 0;
439 }
440
441 return virq;
442}
443EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
444
445/**
446 * irq_create_mapping() - Map a hardware interrupt into linux irq space
447 * @domain: domain owning this hardware interrupt or NULL for default domain
448 * @hwirq: hardware irq number in that domain space
449 *
450 * Only one mapping per hardware interrupt is permitted. Returns a linux
451 * irq number.
452 * If the sense/trigger is to be specified, set_irq_type() should be called
453 * on the number returned from that call.
454 */
455unsigned int irq_create_mapping(struct irq_domain *domain,
456 irq_hw_number_t hwirq)
457{
458 struct device_node *of_node;
459 int virq;
460
461 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
462
463 /* Look for default domain if nececssary */
464 if (domain == NULL)
465 domain = irq_default_domain;
466 if (domain == NULL) {
467 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
468 return 0;
469 }
470 pr_debug("-> using domain @%p\n", domain);
471
472 of_node = irq_domain_get_of_node(domain);
473
474 /* Check if mapping already exists */
475 virq = irq_find_mapping(domain, hwirq);
476 if (virq) {
477 pr_debug("-> existing mapping on virq %d\n", virq);
478 return virq;
479 }
480
481 /* Allocate a virtual interrupt number */
482 virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node), NULL);
483 if (virq <= 0) {
484 pr_debug("-> virq allocation failed\n");
485 return 0;
486 }
487
488 if (irq_domain_associate(domain, virq, hwirq)) {
489 irq_free_desc(virq);
490 return 0;
491 }
492
493 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
494 hwirq, of_node_full_name(of_node), virq);
495
496 return virq;
497}
498EXPORT_SYMBOL_GPL(irq_create_mapping);
499
500/**
501 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
502 * @domain: domain owning the interrupt range
503 * @irq_base: beginning of linux IRQ range
504 * @hwirq_base: beginning of hardware IRQ range
505 * @count: Number of interrupts to map
506 *
507 * This routine is used for allocating and mapping a range of hardware
508 * irqs to linux irqs where the linux irq numbers are at pre-defined
509 * locations. For use by controllers that already have static mappings
510 * to insert in to the domain.
511 *
512 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
513 * domain insertion.
514 *
515 * 0 is returned upon success, while any failure to establish a static
516 * mapping is treated as an error.
517 */
518int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
519 irq_hw_number_t hwirq_base, int count)
520{
521 struct device_node *of_node;
522 int ret;
523
524 of_node = irq_domain_get_of_node(domain);
525 ret = irq_alloc_descs(irq_base, irq_base, count,
526 of_node_to_nid(of_node));
527 if (unlikely(ret < 0))
528 return ret;
529
530 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
531 return 0;
532}
533EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
534
535static int irq_domain_translate(struct irq_domain *d,
536 struct irq_fwspec *fwspec,
537 irq_hw_number_t *hwirq, unsigned int *type)
538{
539#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
540 if (d->ops->translate)
541 return d->ops->translate(d, fwspec, hwirq, type);
542#endif
543 if (d->ops->xlate)
544 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
545 fwspec->param, fwspec->param_count,
546 hwirq, type);
547
548 /* If domain has no translation, then we assume interrupt line */
549 *hwirq = fwspec->param[0];
550 return 0;
551}
552
553static void of_phandle_args_to_fwspec(struct of_phandle_args *irq_data,
554 struct irq_fwspec *fwspec)
555{
556 int i;
557
558 fwspec->fwnode = irq_data->np ? &irq_data->np->fwnode : NULL;
559 fwspec->param_count = irq_data->args_count;
560
561 for (i = 0; i < irq_data->args_count; i++)
562 fwspec->param[i] = irq_data->args[i];
563}
564
565unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
566{
567 struct irq_domain *domain;
568 struct irq_data *irq_data;
569 irq_hw_number_t hwirq;
570 unsigned int type = IRQ_TYPE_NONE;
571 int virq;
572
573 if (fwspec->fwnode) {
574 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_WIRED);
575 if (!domain)
576 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_ANY);
577 } else {
578 domain = irq_default_domain;
579 }
580
581 if (!domain) {
582 pr_warn("no irq domain found for %s !\n",
583 of_node_full_name(to_of_node(fwspec->fwnode)));
584 return 0;
585 }
586
587 if (irq_domain_translate(domain, fwspec, &hwirq, &type))
588 return 0;
589
590 /*
591 * WARN if the irqchip returns a type with bits
592 * outside the sense mask set and clear these bits.
593 */
594 if (WARN_ON(type & ~IRQ_TYPE_SENSE_MASK))
595 type &= IRQ_TYPE_SENSE_MASK;
596
597 /*
598 * If we've already configured this interrupt,
599 * don't do it again, or hell will break loose.
600 */
601 virq = irq_find_mapping(domain, hwirq);
602 if (virq) {
603 /*
604 * If the trigger type is not specified or matches the
605 * current trigger type then we are done so return the
606 * interrupt number.
607 */
608 if (type == IRQ_TYPE_NONE || type == irq_get_trigger_type(virq))
609 return virq;
610
611 /*
612 * If the trigger type has not been set yet, then set
613 * it now and return the interrupt number.
614 */
615 if (irq_get_trigger_type(virq) == IRQ_TYPE_NONE) {
616 irq_data = irq_get_irq_data(virq);
617 if (!irq_data)
618 return 0;
619
620 irqd_set_trigger_type(irq_data, type);
621 return virq;
622 }
623
624 pr_warn("type mismatch, failed to map hwirq-%lu for %s!\n",
625 hwirq, of_node_full_name(to_of_node(fwspec->fwnode)));
626 return 0;
627 }
628
629 if (irq_domain_is_hierarchy(domain)) {
630 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
631 if (virq <= 0)
632 return 0;
633 } else {
634 /* Create mapping */
635 virq = irq_create_mapping(domain, hwirq);
636 if (!virq)
637 return virq;
638 }
639
640 irq_data = irq_get_irq_data(virq);
641 if (!irq_data) {
642 if (irq_domain_is_hierarchy(domain))
643 irq_domain_free_irqs(virq, 1);
644 else
645 irq_dispose_mapping(virq);
646 return 0;
647 }
648
649 /* Store trigger type */
650 irqd_set_trigger_type(irq_data, type);
651
652 return virq;
653}
654EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
655
656unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
657{
658 struct irq_fwspec fwspec;
659
660 of_phandle_args_to_fwspec(irq_data, &fwspec);
661 return irq_create_fwspec_mapping(&fwspec);
662}
663EXPORT_SYMBOL_GPL(irq_create_of_mapping);
664
665/**
666 * irq_dispose_mapping() - Unmap an interrupt
667 * @virq: linux irq number of the interrupt to unmap
668 */
669void irq_dispose_mapping(unsigned int virq)
670{
671 struct irq_data *irq_data = irq_get_irq_data(virq);
672 struct irq_domain *domain;
673
674 if (!virq || !irq_data)
675 return;
676
677 domain = irq_data->domain;
678 if (WARN_ON(domain == NULL))
679 return;
680
681 if (irq_domain_is_hierarchy(domain)) {
682 irq_domain_free_irqs(virq, 1);
683 } else {
684 irq_domain_disassociate(domain, virq);
685 irq_free_desc(virq);
686 }
687}
688EXPORT_SYMBOL_GPL(irq_dispose_mapping);
689
690/**
691 * irq_find_mapping() - Find a linux irq from an hw irq number.
692 * @domain: domain owning this hardware interrupt
693 * @hwirq: hardware irq number in that domain space
694 */
695unsigned int irq_find_mapping(struct irq_domain *domain,
696 irq_hw_number_t hwirq)
697{
698 struct irq_data *data;
699
700 /* Look for default domain if nececssary */
701 if (domain == NULL)
702 domain = irq_default_domain;
703 if (domain == NULL)
704 return 0;
705
706 if (hwirq < domain->revmap_direct_max_irq) {
707 data = irq_domain_get_irq_data(domain, hwirq);
708 if (data && data->hwirq == hwirq)
709 return hwirq;
710 }
711
712 /* Check if the hwirq is in the linear revmap. */
713 if (hwirq < domain->revmap_size)
714 return domain->linear_revmap[hwirq];
715
716 rcu_read_lock();
717 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
718 rcu_read_unlock();
719 return data ? data->irq : 0;
720}
721EXPORT_SYMBOL_GPL(irq_find_mapping);
722
723#ifdef CONFIG_IRQ_DOMAIN_DEBUG
724static int virq_debug_show(struct seq_file *m, void *private)
725{
726 unsigned long flags;
727 struct irq_desc *desc;
728 struct irq_domain *domain;
729 struct radix_tree_iter iter;
730 void *data, **slot;
731 int i;
732
733 seq_printf(m, " %-16s %-6s %-10s %-10s %s\n",
734 "name", "mapped", "linear-max", "direct-max", "devtree-node");
735 mutex_lock(&irq_domain_mutex);
736 list_for_each_entry(domain, &irq_domain_list, link) {
737 struct device_node *of_node;
738 int count = 0;
739 of_node = irq_domain_get_of_node(domain);
740 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
741 count++;
742 seq_printf(m, "%c%-16s %6u %10u %10u %s\n",
743 domain == irq_default_domain ? '*' : ' ', domain->name,
744 domain->revmap_size + count, domain->revmap_size,
745 domain->revmap_direct_max_irq,
746 of_node ? of_node_full_name(of_node) : "");
747 }
748 mutex_unlock(&irq_domain_mutex);
749
750 seq_printf(m, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
751 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
752 "active", "type", "domain");
753
754 for (i = 1; i < nr_irqs; i++) {
755 desc = irq_to_desc(i);
756 if (!desc)
757 continue;
758
759 raw_spin_lock_irqsave(&desc->lock, flags);
760 domain = desc->irq_data.domain;
761
762 if (domain) {
763 struct irq_chip *chip;
764 int hwirq = desc->irq_data.hwirq;
765 bool direct;
766
767 seq_printf(m, "%5d ", i);
768 seq_printf(m, "0x%05x ", hwirq);
769
770 chip = irq_desc_get_chip(desc);
771 seq_printf(m, "%-15s ", (chip && chip->name) ? chip->name : "none");
772
773 data = irq_desc_get_chip_data(desc);
774 seq_printf(m, data ? "0x%p " : " %p ", data);
775
776 seq_printf(m, " %c ", (desc->action && desc->action->handler) ? '*' : ' ');
777 direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
778 seq_printf(m, "%6s%-8s ",
779 (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
780 direct ? "(DIRECT)" : "");
781 seq_printf(m, "%s\n", desc->irq_data.domain->name);
782 }
783
784 raw_spin_unlock_irqrestore(&desc->lock, flags);
785 }
786
787 return 0;
788}
789
790static int virq_debug_open(struct inode *inode, struct file *file)
791{
792 return single_open(file, virq_debug_show, inode->i_private);
793}
794
795static const struct file_operations virq_debug_fops = {
796 .open = virq_debug_open,
797 .read = seq_read,
798 .llseek = seq_lseek,
799 .release = single_release,
800};
801
802static int __init irq_debugfs_init(void)
803{
804 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
805 NULL, &virq_debug_fops) == NULL)
806 return -ENOMEM;
807
808 return 0;
809}
810__initcall(irq_debugfs_init);
811#endif /* CONFIG_IRQ_DOMAIN_DEBUG */
812
813/**
814 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
815 *
816 * Device Tree IRQ specifier translation function which works with one cell
817 * bindings where the cell value maps directly to the hwirq number.
818 */
819int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
820 const u32 *intspec, unsigned int intsize,
821 unsigned long *out_hwirq, unsigned int *out_type)
822{
823 if (WARN_ON(intsize < 1))
824 return -EINVAL;
825 *out_hwirq = intspec[0];
826 *out_type = IRQ_TYPE_NONE;
827 return 0;
828}
829EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
830
831/**
832 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
833 *
834 * Device Tree IRQ specifier translation function which works with two cell
835 * bindings where the cell values map directly to the hwirq number
836 * and linux irq flags.
837 */
838int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
839 const u32 *intspec, unsigned int intsize,
840 irq_hw_number_t *out_hwirq, unsigned int *out_type)
841{
842 if (WARN_ON(intsize < 2))
843 return -EINVAL;
844 *out_hwirq = intspec[0];
845 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
846 return 0;
847}
848EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
849
850/**
851 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
852 *
853 * Device Tree IRQ specifier translation function which works with either one
854 * or two cell bindings where the cell values map directly to the hwirq number
855 * and linux irq flags.
856 *
857 * Note: don't use this function unless your interrupt controller explicitly
858 * supports both one and two cell bindings. For the majority of controllers
859 * the _onecell() or _twocell() variants above should be used.
860 */
861int irq_domain_xlate_onetwocell(struct irq_domain *d,
862 struct device_node *ctrlr,
863 const u32 *intspec, unsigned int intsize,
864 unsigned long *out_hwirq, unsigned int *out_type)
865{
866 if (WARN_ON(intsize < 1))
867 return -EINVAL;
868 *out_hwirq = intspec[0];
869 if (intsize > 1)
870 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
871 else
872 *out_type = IRQ_TYPE_NONE;
873 return 0;
874}
875EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
876
877const struct irq_domain_ops irq_domain_simple_ops = {
878 .xlate = irq_domain_xlate_onetwocell,
879};
880EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
881
882int irq_domain_alloc_descs(int virq, unsigned int cnt, irq_hw_number_t hwirq,
883 int node, const struct cpumask *affinity)
884{
885 unsigned int hint;
886
887 if (virq >= 0) {
888 virq = __irq_alloc_descs(virq, virq, cnt, node, THIS_MODULE,
889 affinity);
890 } else {
891 hint = hwirq % nr_irqs;
892 if (hint == 0)
893 hint++;
894 virq = __irq_alloc_descs(-1, hint, cnt, node, THIS_MODULE,
895 affinity);
896 if (virq <= 0 && hint > 1) {
897 virq = __irq_alloc_descs(-1, 1, cnt, node, THIS_MODULE,
898 affinity);
899 }
900 }
901
902 return virq;
903}
904
905#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
906/**
907 * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
908 * @parent: Parent irq domain to associate with the new domain
909 * @flags: Irq domain flags associated to the domain
910 * @size: Size of the domain. See below
911 * @fwnode: Optional fwnode of the interrupt controller
912 * @ops: Pointer to the interrupt domain callbacks
913 * @host_data: Controller private data pointer
914 *
915 * If @size is 0 a tree domain is created, otherwise a linear domain.
916 *
917 * If successful the parent is associated to the new domain and the
918 * domain flags are set.
919 * Returns pointer to IRQ domain, or NULL on failure.
920 */
921struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
922 unsigned int flags,
923 unsigned int size,
924 struct fwnode_handle *fwnode,
925 const struct irq_domain_ops *ops,
926 void *host_data)
927{
928 struct irq_domain *domain;
929
930 if (size)
931 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
932 else
933 domain = irq_domain_create_tree(fwnode, ops, host_data);
934 if (domain) {
935 domain->parent = parent;
936 domain->flags |= flags;
937 }
938
939 return domain;
940}
941EXPORT_SYMBOL_GPL(irq_domain_create_hierarchy);
942
943static void irq_domain_insert_irq(int virq)
944{
945 struct irq_data *data;
946
947 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
948 struct irq_domain *domain = data->domain;
949 irq_hw_number_t hwirq = data->hwirq;
950
951 if (hwirq < domain->revmap_size) {
952 domain->linear_revmap[hwirq] = virq;
953 } else {
954 mutex_lock(&revmap_trees_mutex);
955 radix_tree_insert(&domain->revmap_tree, hwirq, data);
956 mutex_unlock(&revmap_trees_mutex);
957 }
958
959 /* If not already assigned, give the domain the chip's name */
960 if (!domain->name && data->chip)
961 domain->name = data->chip->name;
962 }
963
964 irq_clear_status_flags(virq, IRQ_NOREQUEST);
965}
966
967static void irq_domain_remove_irq(int virq)
968{
969 struct irq_data *data;
970
971 irq_set_status_flags(virq, IRQ_NOREQUEST);
972 irq_set_chip_and_handler(virq, NULL, NULL);
973 synchronize_irq(virq);
974 smp_mb();
975
976 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
977 struct irq_domain *domain = data->domain;
978 irq_hw_number_t hwirq = data->hwirq;
979
980 if (hwirq < domain->revmap_size) {
981 domain->linear_revmap[hwirq] = 0;
982 } else {
983 mutex_lock(&revmap_trees_mutex);
984 radix_tree_delete(&domain->revmap_tree, hwirq);
985 mutex_unlock(&revmap_trees_mutex);
986 }
987 }
988}
989
990static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
991 struct irq_data *child)
992{
993 struct irq_data *irq_data;
994
995 irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
996 irq_data_get_node(child));
997 if (irq_data) {
998 child->parent_data = irq_data;
999 irq_data->irq = child->irq;
1000 irq_data->common = child->common;
1001 irq_data->domain = domain;
1002 }
1003
1004 return irq_data;
1005}
1006
1007static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
1008{
1009 struct irq_data *irq_data, *tmp;
1010 int i;
1011
1012 for (i = 0; i < nr_irqs; i++) {
1013 irq_data = irq_get_irq_data(virq + i);
1014 tmp = irq_data->parent_data;
1015 irq_data->parent_data = NULL;
1016 irq_data->domain = NULL;
1017
1018 while (tmp) {
1019 irq_data = tmp;
1020 tmp = tmp->parent_data;
1021 kfree(irq_data);
1022 }
1023 }
1024}
1025
1026static int irq_domain_alloc_irq_data(struct irq_domain *domain,
1027 unsigned int virq, unsigned int nr_irqs)
1028{
1029 struct irq_data *irq_data;
1030 struct irq_domain *parent;
1031 int i;
1032
1033 /* The outermost irq_data is embedded in struct irq_desc */
1034 for (i = 0; i < nr_irqs; i++) {
1035 irq_data = irq_get_irq_data(virq + i);
1036 irq_data->domain = domain;
1037
1038 for (parent = domain->parent; parent; parent = parent->parent) {
1039 irq_data = irq_domain_insert_irq_data(parent, irq_data);
1040 if (!irq_data) {
1041 irq_domain_free_irq_data(virq, i + 1);
1042 return -ENOMEM;
1043 }
1044 }
1045 }
1046
1047 return 0;
1048}
1049
1050/**
1051 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1052 * @domain: domain to match
1053 * @virq: IRQ number to get irq_data
1054 */
1055struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1056 unsigned int virq)
1057{
1058 struct irq_data *irq_data;
1059
1060 for (irq_data = irq_get_irq_data(virq); irq_data;
1061 irq_data = irq_data->parent_data)
1062 if (irq_data->domain == domain)
1063 return irq_data;
1064
1065 return NULL;
1066}
1067EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1068
1069/**
1070 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1071 * @domain: Interrupt domain to match
1072 * @virq: IRQ number
1073 * @hwirq: The hwirq number
1074 * @chip: The associated interrupt chip
1075 * @chip_data: The associated chip data
1076 */
1077int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1078 irq_hw_number_t hwirq, struct irq_chip *chip,
1079 void *chip_data)
1080{
1081 struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1082
1083 if (!irq_data)
1084 return -ENOENT;
1085
1086 irq_data->hwirq = hwirq;
1087 irq_data->chip = chip ? chip : &no_irq_chip;
1088 irq_data->chip_data = chip_data;
1089
1090 return 0;
1091}
1092EXPORT_SYMBOL_GPL(irq_domain_set_hwirq_and_chip);
1093
1094/**
1095 * irq_domain_set_info - Set the complete data for a @virq in @domain
1096 * @domain: Interrupt domain to match
1097 * @virq: IRQ number
1098 * @hwirq: The hardware interrupt number
1099 * @chip: The associated interrupt chip
1100 * @chip_data: The associated interrupt chip data
1101 * @handler: The interrupt flow handler
1102 * @handler_data: The interrupt flow handler data
1103 * @handler_name: The interrupt handler name
1104 */
1105void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1106 irq_hw_number_t hwirq, struct irq_chip *chip,
1107 void *chip_data, irq_flow_handler_t handler,
1108 void *handler_data, const char *handler_name)
1109{
1110 irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1111 __irq_set_handler(virq, handler, 0, handler_name);
1112 irq_set_handler_data(virq, handler_data);
1113}
1114EXPORT_SYMBOL(irq_domain_set_info);
1115
1116/**
1117 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1118 * @irq_data: The pointer to irq_data
1119 */
1120void irq_domain_reset_irq_data(struct irq_data *irq_data)
1121{
1122 irq_data->hwirq = 0;
1123 irq_data->chip = &no_irq_chip;
1124 irq_data->chip_data = NULL;
1125}
1126EXPORT_SYMBOL_GPL(irq_domain_reset_irq_data);
1127
1128/**
1129 * irq_domain_free_irqs_common - Clear irq_data and free the parent
1130 * @domain: Interrupt domain to match
1131 * @virq: IRQ number to start with
1132 * @nr_irqs: The number of irqs to free
1133 */
1134void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1135 unsigned int nr_irqs)
1136{
1137 struct irq_data *irq_data;
1138 int i;
1139
1140 for (i = 0; i < nr_irqs; i++) {
1141 irq_data = irq_domain_get_irq_data(domain, virq + i);
1142 if (irq_data)
1143 irq_domain_reset_irq_data(irq_data);
1144 }
1145 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1146}
1147EXPORT_SYMBOL_GPL(irq_domain_free_irqs_common);
1148
1149/**
1150 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1151 * @domain: Interrupt domain to match
1152 * @virq: IRQ number to start with
1153 * @nr_irqs: The number of irqs to free
1154 */
1155void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1156 unsigned int nr_irqs)
1157{
1158 int i;
1159
1160 for (i = 0; i < nr_irqs; i++) {
1161 irq_set_handler_data(virq + i, NULL);
1162 irq_set_handler(virq + i, NULL);
1163 }
1164 irq_domain_free_irqs_common(domain, virq, nr_irqs);
1165}
1166
1167static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1168{
1169 return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1170}
1171
1172static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1173 unsigned int irq_base,
1174 unsigned int nr_irqs)
1175{
1176 domain->ops->free(domain, irq_base, nr_irqs);
1177 if (irq_domain_is_auto_recursive(domain)) {
1178 BUG_ON(!domain->parent);
1179 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1180 nr_irqs);
1181 }
1182}
1183
1184int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1185 unsigned int irq_base,
1186 unsigned int nr_irqs, void *arg)
1187{
1188 int ret = 0;
1189 struct irq_domain *parent = domain->parent;
1190 bool recursive = irq_domain_is_auto_recursive(domain);
1191
1192 BUG_ON(recursive && !parent);
1193 if (recursive)
1194 ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1195 nr_irqs, arg);
1196 if (ret < 0)
1197 return ret;
1198
1199 ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1200 if (ret < 0 && recursive)
1201 irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1202
1203 return ret;
1204}
1205
1206/**
1207 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1208 * @domain: domain to allocate from
1209 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1210 * @nr_irqs: number of IRQs to allocate
1211 * @node: NUMA node id for memory allocation
1212 * @arg: domain specific argument
1213 * @realloc: IRQ descriptors have already been allocated if true
1214 * @affinity: Optional irq affinity mask for multiqueue devices
1215 *
1216 * Allocate IRQ numbers and initialized all data structures to support
1217 * hierarchy IRQ domains.
1218 * Parameter @realloc is mainly to support legacy IRQs.
1219 * Returns error code or allocated IRQ number
1220 *
1221 * The whole process to setup an IRQ has been split into two steps.
1222 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1223 * descriptor and required hardware resources. The second step,
1224 * irq_domain_activate_irq(), is to program hardwares with preallocated
1225 * resources. In this way, it's easier to rollback when failing to
1226 * allocate resources.
1227 */
1228int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1229 unsigned int nr_irqs, int node, void *arg,
1230 bool realloc, const struct cpumask *affinity)
1231{
1232 int i, ret, virq;
1233
1234 if (domain == NULL) {
1235 domain = irq_default_domain;
1236 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1237 return -EINVAL;
1238 }
1239
1240 if (!domain->ops->alloc) {
1241 pr_debug("domain->ops->alloc() is NULL\n");
1242 return -ENOSYS;
1243 }
1244
1245 if (realloc && irq_base >= 0) {
1246 virq = irq_base;
1247 } else {
1248 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node,
1249 affinity);
1250 if (virq < 0) {
1251 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1252 irq_base, nr_irqs);
1253 return virq;
1254 }
1255 }
1256
1257 if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1258 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1259 ret = -ENOMEM;
1260 goto out_free_desc;
1261 }
1262
1263 mutex_lock(&irq_domain_mutex);
1264 ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1265 if (ret < 0) {
1266 mutex_unlock(&irq_domain_mutex);
1267 goto out_free_irq_data;
1268 }
1269 for (i = 0; i < nr_irqs; i++)
1270 irq_domain_insert_irq(virq + i);
1271 mutex_unlock(&irq_domain_mutex);
1272
1273 return virq;
1274
1275out_free_irq_data:
1276 irq_domain_free_irq_data(virq, nr_irqs);
1277out_free_desc:
1278 irq_free_descs(virq, nr_irqs);
1279 return ret;
1280}
1281
1282/**
1283 * irq_domain_free_irqs - Free IRQ number and associated data structures
1284 * @virq: base IRQ number
1285 * @nr_irqs: number of IRQs to free
1286 */
1287void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1288{
1289 struct irq_data *data = irq_get_irq_data(virq);
1290 int i;
1291
1292 if (WARN(!data || !data->domain || !data->domain->ops->free,
1293 "NULL pointer, cannot free irq\n"))
1294 return;
1295
1296 mutex_lock(&irq_domain_mutex);
1297 for (i = 0; i < nr_irqs; i++)
1298 irq_domain_remove_irq(virq + i);
1299 irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1300 mutex_unlock(&irq_domain_mutex);
1301
1302 irq_domain_free_irq_data(virq, nr_irqs);
1303 irq_free_descs(virq, nr_irqs);
1304}
1305
1306/**
1307 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1308 * @irq_base: Base IRQ number
1309 * @nr_irqs: Number of IRQs to allocate
1310 * @arg: Allocation data (arch/domain specific)
1311 *
1312 * Check whether the domain has been setup recursive. If not allocate
1313 * through the parent domain.
1314 */
1315int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1316 unsigned int irq_base, unsigned int nr_irqs,
1317 void *arg)
1318{
1319 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1320 if (irq_domain_is_auto_recursive(domain))
1321 return 0;
1322
1323 domain = domain->parent;
1324 if (domain)
1325 return irq_domain_alloc_irqs_recursive(domain, irq_base,
1326 nr_irqs, arg);
1327 return -ENOSYS;
1328}
1329EXPORT_SYMBOL_GPL(irq_domain_alloc_irqs_parent);
1330
1331/**
1332 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1333 * @irq_base: Base IRQ number
1334 * @nr_irqs: Number of IRQs to free
1335 *
1336 * Check whether the domain has been setup recursive. If not free
1337 * through the parent domain.
1338 */
1339void irq_domain_free_irqs_parent(struct irq_domain *domain,
1340 unsigned int irq_base, unsigned int nr_irqs)
1341{
1342 /* irq_domain_free_irqs_recursive() will call parent's free */
1343 if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1344 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1345 nr_irqs);
1346}
1347EXPORT_SYMBOL_GPL(irq_domain_free_irqs_parent);
1348
1349static void __irq_domain_activate_irq(struct irq_data *irq_data)
1350{
1351 if (irq_data && irq_data->domain) {
1352 struct irq_domain *domain = irq_data->domain;
1353
1354 if (irq_data->parent_data)
1355 __irq_domain_activate_irq(irq_data->parent_data);
1356 if (domain->ops->activate)
1357 domain->ops->activate(domain, irq_data);
1358 }
1359}
1360
1361static void __irq_domain_deactivate_irq(struct irq_data *irq_data)
1362{
1363 if (irq_data && irq_data->domain) {
1364 struct irq_domain *domain = irq_data->domain;
1365
1366 if (domain->ops->deactivate)
1367 domain->ops->deactivate(domain, irq_data);
1368 if (irq_data->parent_data)
1369 __irq_domain_deactivate_irq(irq_data->parent_data);
1370 }
1371}
1372
1373/**
1374 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1375 * interrupt
1376 * @irq_data: outermost irq_data associated with interrupt
1377 *
1378 * This is the second step to call domain_ops->activate to program interrupt
1379 * controllers, so the interrupt could actually get delivered.
1380 */
1381void irq_domain_activate_irq(struct irq_data *irq_data)
1382{
1383 if (!irqd_is_activated(irq_data)) {
1384 __irq_domain_activate_irq(irq_data);
1385 irqd_set_activated(irq_data);
1386 }
1387}
1388
1389/**
1390 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1391 * deactivate interrupt
1392 * @irq_data: outermost irq_data associated with interrupt
1393 *
1394 * It calls domain_ops->deactivate to program interrupt controllers to disable
1395 * interrupt delivery.
1396 */
1397void irq_domain_deactivate_irq(struct irq_data *irq_data)
1398{
1399 if (irqd_is_activated(irq_data)) {
1400 __irq_domain_deactivate_irq(irq_data);
1401 irqd_clr_activated(irq_data);
1402 }
1403}
1404
1405static void irq_domain_check_hierarchy(struct irq_domain *domain)
1406{
1407 /* Hierarchy irq_domains must implement callback alloc() */
1408 if (domain->ops->alloc)
1409 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1410}
1411#else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1412/**
1413 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1414 * @domain: domain to match
1415 * @virq: IRQ number to get irq_data
1416 */
1417struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1418 unsigned int virq)
1419{
1420 struct irq_data *irq_data = irq_get_irq_data(virq);
1421
1422 return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1423}
1424EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1425
1426/**
1427 * irq_domain_set_info - Set the complete data for a @virq in @domain
1428 * @domain: Interrupt domain to match
1429 * @virq: IRQ number
1430 * @hwirq: The hardware interrupt number
1431 * @chip: The associated interrupt chip
1432 * @chip_data: The associated interrupt chip data
1433 * @handler: The interrupt flow handler
1434 * @handler_data: The interrupt flow handler data
1435 * @handler_name: The interrupt handler name
1436 */
1437void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1438 irq_hw_number_t hwirq, struct irq_chip *chip,
1439 void *chip_data, irq_flow_handler_t handler,
1440 void *handler_data, const char *handler_name)
1441{
1442 irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1443 irq_set_chip_data(virq, chip_data);
1444 irq_set_handler_data(virq, handler_data);
1445}
1446
1447static void irq_domain_check_hierarchy(struct irq_domain *domain)
1448{
1449}
1450#endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1// SPDX-License-Identifier: GPL-2.0
2
3#define pr_fmt(fmt) "irq: " fmt
4
5#include <linux/acpi.h>
6#include <linux/debugfs.h>
7#include <linux/hardirq.h>
8#include <linux/interrupt.h>
9#include <linux/irq.h>
10#include <linux/irqdesc.h>
11#include <linux/irqdomain.h>
12#include <linux/module.h>
13#include <linux/mutex.h>
14#include <linux/of.h>
15#include <linux/of_address.h>
16#include <linux/of_irq.h>
17#include <linux/topology.h>
18#include <linux/seq_file.h>
19#include <linux/slab.h>
20#include <linux/smp.h>
21#include <linux/fs.h>
22
23static LIST_HEAD(irq_domain_list);
24static DEFINE_MUTEX(irq_domain_mutex);
25
26static struct irq_domain *irq_default_domain;
27
28static void irq_domain_check_hierarchy(struct irq_domain *domain);
29
30struct irqchip_fwid {
31 struct fwnode_handle fwnode;
32 unsigned int type;
33 char *name;
34 phys_addr_t *pa;
35};
36
37#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
38static void debugfs_add_domain_dir(struct irq_domain *d);
39static void debugfs_remove_domain_dir(struct irq_domain *d);
40#else
41static inline void debugfs_add_domain_dir(struct irq_domain *d) { }
42static inline void debugfs_remove_domain_dir(struct irq_domain *d) { }
43#endif
44
45const struct fwnode_operations irqchip_fwnode_ops;
46EXPORT_SYMBOL_GPL(irqchip_fwnode_ops);
47
48/**
49 * irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
50 * identifying an irq domain
51 * @type: Type of irqchip_fwnode. See linux/irqdomain.h
52 * @name: Optional user provided domain name
53 * @id: Optional user provided id if name != NULL
54 * @pa: Optional user-provided physical address
55 *
56 * Allocate a struct irqchip_fwid, and return a poiner to the embedded
57 * fwnode_handle (or NULL on failure).
58 *
59 * Note: The types IRQCHIP_FWNODE_NAMED and IRQCHIP_FWNODE_NAMED_ID are
60 * solely to transport name information to irqdomain creation code. The
61 * node is not stored. For other types the pointer is kept in the irq
62 * domain struct.
63 */
64struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
65 const char *name,
66 phys_addr_t *pa)
67{
68 struct irqchip_fwid *fwid;
69 char *n;
70
71 fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
72
73 switch (type) {
74 case IRQCHIP_FWNODE_NAMED:
75 n = kasprintf(GFP_KERNEL, "%s", name);
76 break;
77 case IRQCHIP_FWNODE_NAMED_ID:
78 n = kasprintf(GFP_KERNEL, "%s-%d", name, id);
79 break;
80 default:
81 n = kasprintf(GFP_KERNEL, "irqchip@%pa", pa);
82 break;
83 }
84
85 if (!fwid || !n) {
86 kfree(fwid);
87 kfree(n);
88 return NULL;
89 }
90
91 fwid->type = type;
92 fwid->name = n;
93 fwid->pa = pa;
94 fwid->fwnode.ops = &irqchip_fwnode_ops;
95 return &fwid->fwnode;
96}
97EXPORT_SYMBOL_GPL(__irq_domain_alloc_fwnode);
98
99/**
100 * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
101 *
102 * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
103 */
104void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
105{
106 struct irqchip_fwid *fwid;
107
108 if (WARN_ON(!is_fwnode_irqchip(fwnode)))
109 return;
110
111 fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
112 kfree(fwid->name);
113 kfree(fwid);
114}
115EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
116
117/**
118 * __irq_domain_add() - Allocate a new irq_domain data structure
119 * @fwnode: firmware node for the interrupt controller
120 * @size: Size of linear map; 0 for radix mapping only
121 * @hwirq_max: Maximum number of interrupts supported by controller
122 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
123 * direct mapping
124 * @ops: domain callbacks
125 * @host_data: Controller private data pointer
126 *
127 * Allocates and initializes an irq_domain structure.
128 * Returns pointer to IRQ domain, or NULL on failure.
129 */
130struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
131 irq_hw_number_t hwirq_max, int direct_max,
132 const struct irq_domain_ops *ops,
133 void *host_data)
134{
135 struct device_node *of_node = to_of_node(fwnode);
136 struct irqchip_fwid *fwid;
137 struct irq_domain *domain;
138
139 static atomic_t unknown_domains;
140
141 domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
142 GFP_KERNEL, of_node_to_nid(of_node));
143 if (!domain)
144 return NULL;
145
146 if (fwnode && is_fwnode_irqchip(fwnode)) {
147 fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
148
149 switch (fwid->type) {
150 case IRQCHIP_FWNODE_NAMED:
151 case IRQCHIP_FWNODE_NAMED_ID:
152 domain->fwnode = fwnode;
153 domain->name = kstrdup(fwid->name, GFP_KERNEL);
154 if (!domain->name) {
155 kfree(domain);
156 return NULL;
157 }
158 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
159 break;
160 default:
161 domain->fwnode = fwnode;
162 domain->name = fwid->name;
163 break;
164 }
165#ifdef CONFIG_ACPI
166 } else if (is_acpi_device_node(fwnode)) {
167 struct acpi_buffer buf = {
168 .length = ACPI_ALLOCATE_BUFFER,
169 };
170 acpi_handle handle;
171
172 handle = acpi_device_handle(to_acpi_device_node(fwnode));
173 if (acpi_get_name(handle, ACPI_FULL_PATHNAME, &buf) == AE_OK) {
174 domain->name = buf.pointer;
175 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
176 }
177
178 domain->fwnode = fwnode;
179#endif
180 } else if (of_node) {
181 char *name;
182
183 /*
184 * DT paths contain '/', which debugfs is legitimately
185 * unhappy about. Replace them with ':', which does
186 * the trick and is not as offensive as '\'...
187 */
188 name = kasprintf(GFP_KERNEL, "%pOF", of_node);
189 if (!name) {
190 kfree(domain);
191 return NULL;
192 }
193
194 strreplace(name, '/', ':');
195
196 domain->name = name;
197 domain->fwnode = fwnode;
198 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
199 }
200
201 if (!domain->name) {
202 if (fwnode)
203 pr_err("Invalid fwnode type for irqdomain\n");
204 domain->name = kasprintf(GFP_KERNEL, "unknown-%d",
205 atomic_inc_return(&unknown_domains));
206 if (!domain->name) {
207 kfree(domain);
208 return NULL;
209 }
210 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
211 }
212
213 of_node_get(of_node);
214
215 /* Fill structure */
216 INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
217 mutex_init(&domain->revmap_tree_mutex);
218 domain->ops = ops;
219 domain->host_data = host_data;
220 domain->hwirq_max = hwirq_max;
221 domain->revmap_size = size;
222 domain->revmap_direct_max_irq = direct_max;
223 irq_domain_check_hierarchy(domain);
224
225 mutex_lock(&irq_domain_mutex);
226 debugfs_add_domain_dir(domain);
227 list_add(&domain->link, &irq_domain_list);
228 mutex_unlock(&irq_domain_mutex);
229
230 pr_debug("Added domain %s\n", domain->name);
231 return domain;
232}
233EXPORT_SYMBOL_GPL(__irq_domain_add);
234
235/**
236 * irq_domain_remove() - Remove an irq domain.
237 * @domain: domain to remove
238 *
239 * This routine is used to remove an irq domain. The caller must ensure
240 * that all mappings within the domain have been disposed of prior to
241 * use, depending on the revmap type.
242 */
243void irq_domain_remove(struct irq_domain *domain)
244{
245 mutex_lock(&irq_domain_mutex);
246 debugfs_remove_domain_dir(domain);
247
248 WARN_ON(!radix_tree_empty(&domain->revmap_tree));
249
250 list_del(&domain->link);
251
252 /*
253 * If the going away domain is the default one, reset it.
254 */
255 if (unlikely(irq_default_domain == domain))
256 irq_set_default_host(NULL);
257
258 mutex_unlock(&irq_domain_mutex);
259
260 pr_debug("Removed domain %s\n", domain->name);
261
262 of_node_put(irq_domain_get_of_node(domain));
263 if (domain->flags & IRQ_DOMAIN_NAME_ALLOCATED)
264 kfree(domain->name);
265 kfree(domain);
266}
267EXPORT_SYMBOL_GPL(irq_domain_remove);
268
269void irq_domain_update_bus_token(struct irq_domain *domain,
270 enum irq_domain_bus_token bus_token)
271{
272 char *name;
273
274 if (domain->bus_token == bus_token)
275 return;
276
277 mutex_lock(&irq_domain_mutex);
278
279 domain->bus_token = bus_token;
280
281 name = kasprintf(GFP_KERNEL, "%s-%d", domain->name, bus_token);
282 if (!name) {
283 mutex_unlock(&irq_domain_mutex);
284 return;
285 }
286
287 debugfs_remove_domain_dir(domain);
288
289 if (domain->flags & IRQ_DOMAIN_NAME_ALLOCATED)
290 kfree(domain->name);
291 else
292 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
293
294 domain->name = name;
295 debugfs_add_domain_dir(domain);
296
297 mutex_unlock(&irq_domain_mutex);
298}
299
300/**
301 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
302 * @of_node: pointer to interrupt controller's device tree node.
303 * @size: total number of irqs in mapping
304 * @first_irq: first number of irq block assigned to the domain,
305 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
306 * pre-map all of the irqs in the domain to virqs starting at first_irq.
307 * @ops: domain callbacks
308 * @host_data: Controller private data pointer
309 *
310 * Allocates an irq_domain, and optionally if first_irq is positive then also
311 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
312 *
313 * This is intended to implement the expected behaviour for most
314 * interrupt controllers. If device tree is used, then first_irq will be 0 and
315 * irqs get mapped dynamically on the fly. However, if the controller requires
316 * static virq assignments (non-DT boot) then it will set that up correctly.
317 */
318struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
319 unsigned int size,
320 unsigned int first_irq,
321 const struct irq_domain_ops *ops,
322 void *host_data)
323{
324 struct irq_domain *domain;
325
326 domain = __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
327 if (!domain)
328 return NULL;
329
330 if (first_irq > 0) {
331 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
332 /* attempt to allocated irq_descs */
333 int rc = irq_alloc_descs(first_irq, first_irq, size,
334 of_node_to_nid(of_node));
335 if (rc < 0)
336 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
337 first_irq);
338 }
339 irq_domain_associate_many(domain, first_irq, 0, size);
340 }
341
342 return domain;
343}
344EXPORT_SYMBOL_GPL(irq_domain_add_simple);
345
346/**
347 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
348 * @of_node: pointer to interrupt controller's device tree node.
349 * @size: total number of irqs in legacy mapping
350 * @first_irq: first number of irq block assigned to the domain
351 * @first_hwirq: first hwirq number to use for the translation. Should normally
352 * be '0', but a positive integer can be used if the effective
353 * hwirqs numbering does not begin at zero.
354 * @ops: map/unmap domain callbacks
355 * @host_data: Controller private data pointer
356 *
357 * Note: the map() callback will be called before this function returns
358 * for all legacy interrupts except 0 (which is always the invalid irq for
359 * a legacy controller).
360 */
361struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
362 unsigned int size,
363 unsigned int first_irq,
364 irq_hw_number_t first_hwirq,
365 const struct irq_domain_ops *ops,
366 void *host_data)
367{
368 struct irq_domain *domain;
369
370 domain = __irq_domain_add(of_node_to_fwnode(of_node), first_hwirq + size,
371 first_hwirq + size, 0, ops, host_data);
372 if (domain)
373 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
374
375 return domain;
376}
377EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
378
379/**
380 * irq_find_matching_fwspec() - Locates a domain for a given fwspec
381 * @fwspec: FW specifier for an interrupt
382 * @bus_token: domain-specific data
383 */
384struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
385 enum irq_domain_bus_token bus_token)
386{
387 struct irq_domain *h, *found = NULL;
388 struct fwnode_handle *fwnode = fwspec->fwnode;
389 int rc;
390
391 /* We might want to match the legacy controller last since
392 * it might potentially be set to match all interrupts in
393 * the absence of a device node. This isn't a problem so far
394 * yet though...
395 *
396 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
397 * values must generate an exact match for the domain to be
398 * selected.
399 */
400 mutex_lock(&irq_domain_mutex);
401 list_for_each_entry(h, &irq_domain_list, link) {
402 if (h->ops->select && fwspec->param_count)
403 rc = h->ops->select(h, fwspec, bus_token);
404 else if (h->ops->match)
405 rc = h->ops->match(h, to_of_node(fwnode), bus_token);
406 else
407 rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
408 ((bus_token == DOMAIN_BUS_ANY) ||
409 (h->bus_token == bus_token)));
410
411 if (rc) {
412 found = h;
413 break;
414 }
415 }
416 mutex_unlock(&irq_domain_mutex);
417 return found;
418}
419EXPORT_SYMBOL_GPL(irq_find_matching_fwspec);
420
421/**
422 * irq_domain_check_msi_remap - Check whether all MSI irq domains implement
423 * IRQ remapping
424 *
425 * Return: false if any MSI irq domain does not support IRQ remapping,
426 * true otherwise (including if there is no MSI irq domain)
427 */
428bool irq_domain_check_msi_remap(void)
429{
430 struct irq_domain *h;
431 bool ret = true;
432
433 mutex_lock(&irq_domain_mutex);
434 list_for_each_entry(h, &irq_domain_list, link) {
435 if (irq_domain_is_msi(h) &&
436 !irq_domain_hierarchical_is_msi_remap(h)) {
437 ret = false;
438 break;
439 }
440 }
441 mutex_unlock(&irq_domain_mutex);
442 return ret;
443}
444EXPORT_SYMBOL_GPL(irq_domain_check_msi_remap);
445
446/**
447 * irq_set_default_host() - Set a "default" irq domain
448 * @domain: default domain pointer
449 *
450 * For convenience, it's possible to set a "default" domain that will be used
451 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
452 * platforms that want to manipulate a few hard coded interrupt numbers that
453 * aren't properly represented in the device-tree.
454 */
455void irq_set_default_host(struct irq_domain *domain)
456{
457 pr_debug("Default domain set to @0x%p\n", domain);
458
459 irq_default_domain = domain;
460}
461EXPORT_SYMBOL_GPL(irq_set_default_host);
462
463/**
464 * irq_get_default_host() - Retrieve the "default" irq domain
465 *
466 * Returns: the default domain, if any.
467 *
468 * Modern code should never use this. This should only be used on
469 * systems that cannot implement a firmware->fwnode mapping (which
470 * both DT and ACPI provide).
471 */
472struct irq_domain *irq_get_default_host(void)
473{
474 return irq_default_domain;
475}
476
477static void irq_domain_clear_mapping(struct irq_domain *domain,
478 irq_hw_number_t hwirq)
479{
480 if (hwirq < domain->revmap_size) {
481 domain->linear_revmap[hwirq] = 0;
482 } else {
483 mutex_lock(&domain->revmap_tree_mutex);
484 radix_tree_delete(&domain->revmap_tree, hwirq);
485 mutex_unlock(&domain->revmap_tree_mutex);
486 }
487}
488
489static void irq_domain_set_mapping(struct irq_domain *domain,
490 irq_hw_number_t hwirq,
491 struct irq_data *irq_data)
492{
493 if (hwirq < domain->revmap_size) {
494 domain->linear_revmap[hwirq] = irq_data->irq;
495 } else {
496 mutex_lock(&domain->revmap_tree_mutex);
497 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
498 mutex_unlock(&domain->revmap_tree_mutex);
499 }
500}
501
502void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
503{
504 struct irq_data *irq_data = irq_get_irq_data(irq);
505 irq_hw_number_t hwirq;
506
507 if (WARN(!irq_data || irq_data->domain != domain,
508 "virq%i doesn't exist; cannot disassociate\n", irq))
509 return;
510
511 hwirq = irq_data->hwirq;
512 irq_set_status_flags(irq, IRQ_NOREQUEST);
513
514 /* remove chip and handler */
515 irq_set_chip_and_handler(irq, NULL, NULL);
516
517 /* Make sure it's completed */
518 synchronize_irq(irq);
519
520 /* Tell the PIC about it */
521 if (domain->ops->unmap)
522 domain->ops->unmap(domain, irq);
523 smp_mb();
524
525 irq_data->domain = NULL;
526 irq_data->hwirq = 0;
527 domain->mapcount--;
528
529 /* Clear reverse map for this hwirq */
530 irq_domain_clear_mapping(domain, hwirq);
531}
532
533int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
534 irq_hw_number_t hwirq)
535{
536 struct irq_data *irq_data = irq_get_irq_data(virq);
537 int ret;
538
539 if (WARN(hwirq >= domain->hwirq_max,
540 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
541 return -EINVAL;
542 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
543 return -EINVAL;
544 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
545 return -EINVAL;
546
547 mutex_lock(&irq_domain_mutex);
548 irq_data->hwirq = hwirq;
549 irq_data->domain = domain;
550 if (domain->ops->map) {
551 ret = domain->ops->map(domain, virq, hwirq);
552 if (ret != 0) {
553 /*
554 * If map() returns -EPERM, this interrupt is protected
555 * by the firmware or some other service and shall not
556 * be mapped. Don't bother telling the user about it.
557 */
558 if (ret != -EPERM) {
559 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
560 domain->name, hwirq, virq, ret);
561 }
562 irq_data->domain = NULL;
563 irq_data->hwirq = 0;
564 mutex_unlock(&irq_domain_mutex);
565 return ret;
566 }
567
568 /* If not already assigned, give the domain the chip's name */
569 if (!domain->name && irq_data->chip)
570 domain->name = irq_data->chip->name;
571 }
572
573 domain->mapcount++;
574 irq_domain_set_mapping(domain, hwirq, irq_data);
575 mutex_unlock(&irq_domain_mutex);
576
577 irq_clear_status_flags(virq, IRQ_NOREQUEST);
578
579 return 0;
580}
581EXPORT_SYMBOL_GPL(irq_domain_associate);
582
583void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
584 irq_hw_number_t hwirq_base, int count)
585{
586 struct device_node *of_node;
587 int i;
588
589 of_node = irq_domain_get_of_node(domain);
590 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
591 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
592
593 for (i = 0; i < count; i++) {
594 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
595 }
596}
597EXPORT_SYMBOL_GPL(irq_domain_associate_many);
598
599/**
600 * irq_create_direct_mapping() - Allocate an irq for direct mapping
601 * @domain: domain to allocate the irq for or NULL for default domain
602 *
603 * This routine is used for irq controllers which can choose the hardware
604 * interrupt numbers they generate. In such a case it's simplest to use
605 * the linux irq as the hardware interrupt number. It still uses the linear
606 * or radix tree to store the mapping, but the irq controller can optimize
607 * the revmap path by using the hwirq directly.
608 */
609unsigned int irq_create_direct_mapping(struct irq_domain *domain)
610{
611 struct device_node *of_node;
612 unsigned int virq;
613
614 if (domain == NULL)
615 domain = irq_default_domain;
616
617 of_node = irq_domain_get_of_node(domain);
618 virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
619 if (!virq) {
620 pr_debug("create_direct virq allocation failed\n");
621 return 0;
622 }
623 if (virq >= domain->revmap_direct_max_irq) {
624 pr_err("ERROR: no free irqs available below %i maximum\n",
625 domain->revmap_direct_max_irq);
626 irq_free_desc(virq);
627 return 0;
628 }
629 pr_debug("create_direct obtained virq %d\n", virq);
630
631 if (irq_domain_associate(domain, virq, virq)) {
632 irq_free_desc(virq);
633 return 0;
634 }
635
636 return virq;
637}
638EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
639
640/**
641 * irq_create_mapping() - Map a hardware interrupt into linux irq space
642 * @domain: domain owning this hardware interrupt or NULL for default domain
643 * @hwirq: hardware irq number in that domain space
644 *
645 * Only one mapping per hardware interrupt is permitted. Returns a linux
646 * irq number.
647 * If the sense/trigger is to be specified, set_irq_type() should be called
648 * on the number returned from that call.
649 */
650unsigned int irq_create_mapping(struct irq_domain *domain,
651 irq_hw_number_t hwirq)
652{
653 struct device_node *of_node;
654 int virq;
655
656 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
657
658 /* Look for default domain if nececssary */
659 if (domain == NULL)
660 domain = irq_default_domain;
661 if (domain == NULL) {
662 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
663 return 0;
664 }
665 pr_debug("-> using domain @%p\n", domain);
666
667 of_node = irq_domain_get_of_node(domain);
668
669 /* Check if mapping already exists */
670 virq = irq_find_mapping(domain, hwirq);
671 if (virq) {
672 pr_debug("-> existing mapping on virq %d\n", virq);
673 return virq;
674 }
675
676 /* Allocate a virtual interrupt number */
677 virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node), NULL);
678 if (virq <= 0) {
679 pr_debug("-> virq allocation failed\n");
680 return 0;
681 }
682
683 if (irq_domain_associate(domain, virq, hwirq)) {
684 irq_free_desc(virq);
685 return 0;
686 }
687
688 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
689 hwirq, of_node_full_name(of_node), virq);
690
691 return virq;
692}
693EXPORT_SYMBOL_GPL(irq_create_mapping);
694
695/**
696 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
697 * @domain: domain owning the interrupt range
698 * @irq_base: beginning of linux IRQ range
699 * @hwirq_base: beginning of hardware IRQ range
700 * @count: Number of interrupts to map
701 *
702 * This routine is used for allocating and mapping a range of hardware
703 * irqs to linux irqs where the linux irq numbers are at pre-defined
704 * locations. For use by controllers that already have static mappings
705 * to insert in to the domain.
706 *
707 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
708 * domain insertion.
709 *
710 * 0 is returned upon success, while any failure to establish a static
711 * mapping is treated as an error.
712 */
713int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
714 irq_hw_number_t hwirq_base, int count)
715{
716 struct device_node *of_node;
717 int ret;
718
719 of_node = irq_domain_get_of_node(domain);
720 ret = irq_alloc_descs(irq_base, irq_base, count,
721 of_node_to_nid(of_node));
722 if (unlikely(ret < 0))
723 return ret;
724
725 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
726 return 0;
727}
728EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
729
730static int irq_domain_translate(struct irq_domain *d,
731 struct irq_fwspec *fwspec,
732 irq_hw_number_t *hwirq, unsigned int *type)
733{
734#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
735 if (d->ops->translate)
736 return d->ops->translate(d, fwspec, hwirq, type);
737#endif
738 if (d->ops->xlate)
739 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
740 fwspec->param, fwspec->param_count,
741 hwirq, type);
742
743 /* If domain has no translation, then we assume interrupt line */
744 *hwirq = fwspec->param[0];
745 return 0;
746}
747
748static void of_phandle_args_to_fwspec(struct device_node *np, const u32 *args,
749 unsigned int count,
750 struct irq_fwspec *fwspec)
751{
752 int i;
753
754 fwspec->fwnode = np ? &np->fwnode : NULL;
755 fwspec->param_count = count;
756
757 for (i = 0; i < count; i++)
758 fwspec->param[i] = args[i];
759}
760
761unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
762{
763 struct irq_domain *domain;
764 struct irq_data *irq_data;
765 irq_hw_number_t hwirq;
766 unsigned int type = IRQ_TYPE_NONE;
767 int virq;
768
769 if (fwspec->fwnode) {
770 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_WIRED);
771 if (!domain)
772 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_ANY);
773 } else {
774 domain = irq_default_domain;
775 }
776
777 if (!domain) {
778 pr_warn("no irq domain found for %s !\n",
779 of_node_full_name(to_of_node(fwspec->fwnode)));
780 return 0;
781 }
782
783 if (irq_domain_translate(domain, fwspec, &hwirq, &type))
784 return 0;
785
786 /*
787 * WARN if the irqchip returns a type with bits
788 * outside the sense mask set and clear these bits.
789 */
790 if (WARN_ON(type & ~IRQ_TYPE_SENSE_MASK))
791 type &= IRQ_TYPE_SENSE_MASK;
792
793 /*
794 * If we've already configured this interrupt,
795 * don't do it again, or hell will break loose.
796 */
797 virq = irq_find_mapping(domain, hwirq);
798 if (virq) {
799 /*
800 * If the trigger type is not specified or matches the
801 * current trigger type then we are done so return the
802 * interrupt number.
803 */
804 if (type == IRQ_TYPE_NONE || type == irq_get_trigger_type(virq))
805 return virq;
806
807 /*
808 * If the trigger type has not been set yet, then set
809 * it now and return the interrupt number.
810 */
811 if (irq_get_trigger_type(virq) == IRQ_TYPE_NONE) {
812 irq_data = irq_get_irq_data(virq);
813 if (!irq_data)
814 return 0;
815
816 irqd_set_trigger_type(irq_data, type);
817 return virq;
818 }
819
820 pr_warn("type mismatch, failed to map hwirq-%lu for %s!\n",
821 hwirq, of_node_full_name(to_of_node(fwspec->fwnode)));
822 return 0;
823 }
824
825 if (irq_domain_is_hierarchy(domain)) {
826 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
827 if (virq <= 0)
828 return 0;
829 } else {
830 /* Create mapping */
831 virq = irq_create_mapping(domain, hwirq);
832 if (!virq)
833 return virq;
834 }
835
836 irq_data = irq_get_irq_data(virq);
837 if (!irq_data) {
838 if (irq_domain_is_hierarchy(domain))
839 irq_domain_free_irqs(virq, 1);
840 else
841 irq_dispose_mapping(virq);
842 return 0;
843 }
844
845 /* Store trigger type */
846 irqd_set_trigger_type(irq_data, type);
847
848 return virq;
849}
850EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
851
852unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
853{
854 struct irq_fwspec fwspec;
855
856 of_phandle_args_to_fwspec(irq_data->np, irq_data->args,
857 irq_data->args_count, &fwspec);
858
859 return irq_create_fwspec_mapping(&fwspec);
860}
861EXPORT_SYMBOL_GPL(irq_create_of_mapping);
862
863/**
864 * irq_dispose_mapping() - Unmap an interrupt
865 * @virq: linux irq number of the interrupt to unmap
866 */
867void irq_dispose_mapping(unsigned int virq)
868{
869 struct irq_data *irq_data = irq_get_irq_data(virq);
870 struct irq_domain *domain;
871
872 if (!virq || !irq_data)
873 return;
874
875 domain = irq_data->domain;
876 if (WARN_ON(domain == NULL))
877 return;
878
879 if (irq_domain_is_hierarchy(domain)) {
880 irq_domain_free_irqs(virq, 1);
881 } else {
882 irq_domain_disassociate(domain, virq);
883 irq_free_desc(virq);
884 }
885}
886EXPORT_SYMBOL_GPL(irq_dispose_mapping);
887
888/**
889 * irq_find_mapping() - Find a linux irq from a hw irq number.
890 * @domain: domain owning this hardware interrupt
891 * @hwirq: hardware irq number in that domain space
892 */
893unsigned int irq_find_mapping(struct irq_domain *domain,
894 irq_hw_number_t hwirq)
895{
896 struct irq_data *data;
897
898 /* Look for default domain if nececssary */
899 if (domain == NULL)
900 domain = irq_default_domain;
901 if (domain == NULL)
902 return 0;
903
904 if (hwirq < domain->revmap_direct_max_irq) {
905 data = irq_domain_get_irq_data(domain, hwirq);
906 if (data && data->hwirq == hwirq)
907 return hwirq;
908 }
909
910 /* Check if the hwirq is in the linear revmap. */
911 if (hwirq < domain->revmap_size)
912 return domain->linear_revmap[hwirq];
913
914 rcu_read_lock();
915 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
916 rcu_read_unlock();
917 return data ? data->irq : 0;
918}
919EXPORT_SYMBOL_GPL(irq_find_mapping);
920
921/**
922 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
923 *
924 * Device Tree IRQ specifier translation function which works with one cell
925 * bindings where the cell value maps directly to the hwirq number.
926 */
927int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
928 const u32 *intspec, unsigned int intsize,
929 unsigned long *out_hwirq, unsigned int *out_type)
930{
931 if (WARN_ON(intsize < 1))
932 return -EINVAL;
933 *out_hwirq = intspec[0];
934 *out_type = IRQ_TYPE_NONE;
935 return 0;
936}
937EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
938
939/**
940 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
941 *
942 * Device Tree IRQ specifier translation function which works with two cell
943 * bindings where the cell values map directly to the hwirq number
944 * and linux irq flags.
945 */
946int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
947 const u32 *intspec, unsigned int intsize,
948 irq_hw_number_t *out_hwirq, unsigned int *out_type)
949{
950 struct irq_fwspec fwspec;
951
952 of_phandle_args_to_fwspec(ctrlr, intspec, intsize, &fwspec);
953 return irq_domain_translate_twocell(d, &fwspec, out_hwirq, out_type);
954}
955EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
956
957/**
958 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
959 *
960 * Device Tree IRQ specifier translation function which works with either one
961 * or two cell bindings where the cell values map directly to the hwirq number
962 * and linux irq flags.
963 *
964 * Note: don't use this function unless your interrupt controller explicitly
965 * supports both one and two cell bindings. For the majority of controllers
966 * the _onecell() or _twocell() variants above should be used.
967 */
968int irq_domain_xlate_onetwocell(struct irq_domain *d,
969 struct device_node *ctrlr,
970 const u32 *intspec, unsigned int intsize,
971 unsigned long *out_hwirq, unsigned int *out_type)
972{
973 if (WARN_ON(intsize < 1))
974 return -EINVAL;
975 *out_hwirq = intspec[0];
976 if (intsize > 1)
977 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
978 else
979 *out_type = IRQ_TYPE_NONE;
980 return 0;
981}
982EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
983
984const struct irq_domain_ops irq_domain_simple_ops = {
985 .xlate = irq_domain_xlate_onetwocell,
986};
987EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
988
989/**
990 * irq_domain_translate_twocell() - Generic translate for direct two cell
991 * bindings
992 *
993 * Device Tree IRQ specifier translation function which works with two cell
994 * bindings where the cell values map directly to the hwirq number
995 * and linux irq flags.
996 */
997int irq_domain_translate_twocell(struct irq_domain *d,
998 struct irq_fwspec *fwspec,
999 unsigned long *out_hwirq,
1000 unsigned int *out_type)
1001{
1002 if (WARN_ON(fwspec->param_count < 2))
1003 return -EINVAL;
1004 *out_hwirq = fwspec->param[0];
1005 *out_type = fwspec->param[1] & IRQ_TYPE_SENSE_MASK;
1006 return 0;
1007}
1008EXPORT_SYMBOL_GPL(irq_domain_translate_twocell);
1009
1010int irq_domain_alloc_descs(int virq, unsigned int cnt, irq_hw_number_t hwirq,
1011 int node, const struct irq_affinity_desc *affinity)
1012{
1013 unsigned int hint;
1014
1015 if (virq >= 0) {
1016 virq = __irq_alloc_descs(virq, virq, cnt, node, THIS_MODULE,
1017 affinity);
1018 } else {
1019 hint = hwirq % nr_irqs;
1020 if (hint == 0)
1021 hint++;
1022 virq = __irq_alloc_descs(-1, hint, cnt, node, THIS_MODULE,
1023 affinity);
1024 if (virq <= 0 && hint > 1) {
1025 virq = __irq_alloc_descs(-1, 1, cnt, node, THIS_MODULE,
1026 affinity);
1027 }
1028 }
1029
1030 return virq;
1031}
1032
1033#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1034/**
1035 * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
1036 * @parent: Parent irq domain to associate with the new domain
1037 * @flags: Irq domain flags associated to the domain
1038 * @size: Size of the domain. See below
1039 * @fwnode: Optional fwnode of the interrupt controller
1040 * @ops: Pointer to the interrupt domain callbacks
1041 * @host_data: Controller private data pointer
1042 *
1043 * If @size is 0 a tree domain is created, otherwise a linear domain.
1044 *
1045 * If successful the parent is associated to the new domain and the
1046 * domain flags are set.
1047 * Returns pointer to IRQ domain, or NULL on failure.
1048 */
1049struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
1050 unsigned int flags,
1051 unsigned int size,
1052 struct fwnode_handle *fwnode,
1053 const struct irq_domain_ops *ops,
1054 void *host_data)
1055{
1056 struct irq_domain *domain;
1057
1058 if (size)
1059 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
1060 else
1061 domain = irq_domain_create_tree(fwnode, ops, host_data);
1062 if (domain) {
1063 domain->parent = parent;
1064 domain->flags |= flags;
1065 }
1066
1067 return domain;
1068}
1069EXPORT_SYMBOL_GPL(irq_domain_create_hierarchy);
1070
1071static void irq_domain_insert_irq(int virq)
1072{
1073 struct irq_data *data;
1074
1075 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
1076 struct irq_domain *domain = data->domain;
1077
1078 domain->mapcount++;
1079 irq_domain_set_mapping(domain, data->hwirq, data);
1080
1081 /* If not already assigned, give the domain the chip's name */
1082 if (!domain->name && data->chip)
1083 domain->name = data->chip->name;
1084 }
1085
1086 irq_clear_status_flags(virq, IRQ_NOREQUEST);
1087}
1088
1089static void irq_domain_remove_irq(int virq)
1090{
1091 struct irq_data *data;
1092
1093 irq_set_status_flags(virq, IRQ_NOREQUEST);
1094 irq_set_chip_and_handler(virq, NULL, NULL);
1095 synchronize_irq(virq);
1096 smp_mb();
1097
1098 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
1099 struct irq_domain *domain = data->domain;
1100 irq_hw_number_t hwirq = data->hwirq;
1101
1102 domain->mapcount--;
1103 irq_domain_clear_mapping(domain, hwirq);
1104 }
1105}
1106
1107static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
1108 struct irq_data *child)
1109{
1110 struct irq_data *irq_data;
1111
1112 irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
1113 irq_data_get_node(child));
1114 if (irq_data) {
1115 child->parent_data = irq_data;
1116 irq_data->irq = child->irq;
1117 irq_data->common = child->common;
1118 irq_data->domain = domain;
1119 }
1120
1121 return irq_data;
1122}
1123
1124static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
1125{
1126 struct irq_data *irq_data, *tmp;
1127 int i;
1128
1129 for (i = 0; i < nr_irqs; i++) {
1130 irq_data = irq_get_irq_data(virq + i);
1131 tmp = irq_data->parent_data;
1132 irq_data->parent_data = NULL;
1133 irq_data->domain = NULL;
1134
1135 while (tmp) {
1136 irq_data = tmp;
1137 tmp = tmp->parent_data;
1138 kfree(irq_data);
1139 }
1140 }
1141}
1142
1143static int irq_domain_alloc_irq_data(struct irq_domain *domain,
1144 unsigned int virq, unsigned int nr_irqs)
1145{
1146 struct irq_data *irq_data;
1147 struct irq_domain *parent;
1148 int i;
1149
1150 /* The outermost irq_data is embedded in struct irq_desc */
1151 for (i = 0; i < nr_irqs; i++) {
1152 irq_data = irq_get_irq_data(virq + i);
1153 irq_data->domain = domain;
1154
1155 for (parent = domain->parent; parent; parent = parent->parent) {
1156 irq_data = irq_domain_insert_irq_data(parent, irq_data);
1157 if (!irq_data) {
1158 irq_domain_free_irq_data(virq, i + 1);
1159 return -ENOMEM;
1160 }
1161 }
1162 }
1163
1164 return 0;
1165}
1166
1167/**
1168 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1169 * @domain: domain to match
1170 * @virq: IRQ number to get irq_data
1171 */
1172struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1173 unsigned int virq)
1174{
1175 struct irq_data *irq_data;
1176
1177 for (irq_data = irq_get_irq_data(virq); irq_data;
1178 irq_data = irq_data->parent_data)
1179 if (irq_data->domain == domain)
1180 return irq_data;
1181
1182 return NULL;
1183}
1184EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1185
1186/**
1187 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1188 * @domain: Interrupt domain to match
1189 * @virq: IRQ number
1190 * @hwirq: The hwirq number
1191 * @chip: The associated interrupt chip
1192 * @chip_data: The associated chip data
1193 */
1194int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1195 irq_hw_number_t hwirq, struct irq_chip *chip,
1196 void *chip_data)
1197{
1198 struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1199
1200 if (!irq_data)
1201 return -ENOENT;
1202
1203 irq_data->hwirq = hwirq;
1204 irq_data->chip = chip ? chip : &no_irq_chip;
1205 irq_data->chip_data = chip_data;
1206
1207 return 0;
1208}
1209EXPORT_SYMBOL_GPL(irq_domain_set_hwirq_and_chip);
1210
1211/**
1212 * irq_domain_set_info - Set the complete data for a @virq in @domain
1213 * @domain: Interrupt domain to match
1214 * @virq: IRQ number
1215 * @hwirq: The hardware interrupt number
1216 * @chip: The associated interrupt chip
1217 * @chip_data: The associated interrupt chip data
1218 * @handler: The interrupt flow handler
1219 * @handler_data: The interrupt flow handler data
1220 * @handler_name: The interrupt handler name
1221 */
1222void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1223 irq_hw_number_t hwirq, struct irq_chip *chip,
1224 void *chip_data, irq_flow_handler_t handler,
1225 void *handler_data, const char *handler_name)
1226{
1227 irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1228 __irq_set_handler(virq, handler, 0, handler_name);
1229 irq_set_handler_data(virq, handler_data);
1230}
1231EXPORT_SYMBOL(irq_domain_set_info);
1232
1233/**
1234 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1235 * @irq_data: The pointer to irq_data
1236 */
1237void irq_domain_reset_irq_data(struct irq_data *irq_data)
1238{
1239 irq_data->hwirq = 0;
1240 irq_data->chip = &no_irq_chip;
1241 irq_data->chip_data = NULL;
1242}
1243EXPORT_SYMBOL_GPL(irq_domain_reset_irq_data);
1244
1245/**
1246 * irq_domain_free_irqs_common - Clear irq_data and free the parent
1247 * @domain: Interrupt domain to match
1248 * @virq: IRQ number to start with
1249 * @nr_irqs: The number of irqs to free
1250 */
1251void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1252 unsigned int nr_irqs)
1253{
1254 struct irq_data *irq_data;
1255 int i;
1256
1257 for (i = 0; i < nr_irqs; i++) {
1258 irq_data = irq_domain_get_irq_data(domain, virq + i);
1259 if (irq_data)
1260 irq_domain_reset_irq_data(irq_data);
1261 }
1262 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1263}
1264EXPORT_SYMBOL_GPL(irq_domain_free_irqs_common);
1265
1266/**
1267 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1268 * @domain: Interrupt domain to match
1269 * @virq: IRQ number to start with
1270 * @nr_irqs: The number of irqs to free
1271 */
1272void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1273 unsigned int nr_irqs)
1274{
1275 int i;
1276
1277 for (i = 0; i < nr_irqs; i++) {
1278 irq_set_handler_data(virq + i, NULL);
1279 irq_set_handler(virq + i, NULL);
1280 }
1281 irq_domain_free_irqs_common(domain, virq, nr_irqs);
1282}
1283
1284static void irq_domain_free_irqs_hierarchy(struct irq_domain *domain,
1285 unsigned int irq_base,
1286 unsigned int nr_irqs)
1287{
1288 if (domain->ops->free)
1289 domain->ops->free(domain, irq_base, nr_irqs);
1290}
1291
1292int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
1293 unsigned int irq_base,
1294 unsigned int nr_irqs, void *arg)
1295{
1296 return domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1297}
1298
1299/**
1300 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1301 * @domain: domain to allocate from
1302 * @irq_base: allocate specified IRQ number if irq_base >= 0
1303 * @nr_irqs: number of IRQs to allocate
1304 * @node: NUMA node id for memory allocation
1305 * @arg: domain specific argument
1306 * @realloc: IRQ descriptors have already been allocated if true
1307 * @affinity: Optional irq affinity mask for multiqueue devices
1308 *
1309 * Allocate IRQ numbers and initialized all data structures to support
1310 * hierarchy IRQ domains.
1311 * Parameter @realloc is mainly to support legacy IRQs.
1312 * Returns error code or allocated IRQ number
1313 *
1314 * The whole process to setup an IRQ has been split into two steps.
1315 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1316 * descriptor and required hardware resources. The second step,
1317 * irq_domain_activate_irq(), is to program hardwares with preallocated
1318 * resources. In this way, it's easier to rollback when failing to
1319 * allocate resources.
1320 */
1321int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1322 unsigned int nr_irqs, int node, void *arg,
1323 bool realloc, const struct irq_affinity_desc *affinity)
1324{
1325 int i, ret, virq;
1326
1327 if (domain == NULL) {
1328 domain = irq_default_domain;
1329 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1330 return -EINVAL;
1331 }
1332
1333 if (!domain->ops->alloc) {
1334 pr_debug("domain->ops->alloc() is NULL\n");
1335 return -ENOSYS;
1336 }
1337
1338 if (realloc && irq_base >= 0) {
1339 virq = irq_base;
1340 } else {
1341 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node,
1342 affinity);
1343 if (virq < 0) {
1344 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1345 irq_base, nr_irqs);
1346 return virq;
1347 }
1348 }
1349
1350 if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1351 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1352 ret = -ENOMEM;
1353 goto out_free_desc;
1354 }
1355
1356 mutex_lock(&irq_domain_mutex);
1357 ret = irq_domain_alloc_irqs_hierarchy(domain, virq, nr_irqs, arg);
1358 if (ret < 0) {
1359 mutex_unlock(&irq_domain_mutex);
1360 goto out_free_irq_data;
1361 }
1362 for (i = 0; i < nr_irqs; i++)
1363 irq_domain_insert_irq(virq + i);
1364 mutex_unlock(&irq_domain_mutex);
1365
1366 return virq;
1367
1368out_free_irq_data:
1369 irq_domain_free_irq_data(virq, nr_irqs);
1370out_free_desc:
1371 irq_free_descs(virq, nr_irqs);
1372 return ret;
1373}
1374
1375/* The irq_data was moved, fix the revmap to refer to the new location */
1376static void irq_domain_fix_revmap(struct irq_data *d)
1377{
1378 void __rcu **slot;
1379
1380 if (d->hwirq < d->domain->revmap_size)
1381 return; /* Not using radix tree. */
1382
1383 /* Fix up the revmap. */
1384 mutex_lock(&d->domain->revmap_tree_mutex);
1385 slot = radix_tree_lookup_slot(&d->domain->revmap_tree, d->hwirq);
1386 if (slot)
1387 radix_tree_replace_slot(&d->domain->revmap_tree, slot, d);
1388 mutex_unlock(&d->domain->revmap_tree_mutex);
1389}
1390
1391/**
1392 * irq_domain_push_irq() - Push a domain in to the top of a hierarchy.
1393 * @domain: Domain to push.
1394 * @virq: Irq to push the domain in to.
1395 * @arg: Passed to the irq_domain_ops alloc() function.
1396 *
1397 * For an already existing irqdomain hierarchy, as might be obtained
1398 * via a call to pci_enable_msix(), add an additional domain to the
1399 * head of the processing chain. Must be called before request_irq()
1400 * has been called.
1401 */
1402int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg)
1403{
1404 struct irq_data *child_irq_data;
1405 struct irq_data *root_irq_data = irq_get_irq_data(virq);
1406 struct irq_desc *desc;
1407 int rv = 0;
1408
1409 /*
1410 * Check that no action has been set, which indicates the virq
1411 * is in a state where this function doesn't have to deal with
1412 * races between interrupt handling and maintaining the
1413 * hierarchy. This will catch gross misuse. Attempting to
1414 * make the check race free would require holding locks across
1415 * calls to struct irq_domain_ops->alloc(), which could lead
1416 * to deadlock, so we just do a simple check before starting.
1417 */
1418 desc = irq_to_desc(virq);
1419 if (!desc)
1420 return -EINVAL;
1421 if (WARN_ON(desc->action))
1422 return -EBUSY;
1423
1424 if (domain == NULL)
1425 return -EINVAL;
1426
1427 if (WARN_ON(!irq_domain_is_hierarchy(domain)))
1428 return -EINVAL;
1429
1430 if (!root_irq_data)
1431 return -EINVAL;
1432
1433 if (domain->parent != root_irq_data->domain)
1434 return -EINVAL;
1435
1436 child_irq_data = kzalloc_node(sizeof(*child_irq_data), GFP_KERNEL,
1437 irq_data_get_node(root_irq_data));
1438 if (!child_irq_data)
1439 return -ENOMEM;
1440
1441 mutex_lock(&irq_domain_mutex);
1442
1443 /* Copy the original irq_data. */
1444 *child_irq_data = *root_irq_data;
1445
1446 /*
1447 * Overwrite the root_irq_data, which is embedded in struct
1448 * irq_desc, with values for this domain.
1449 */
1450 root_irq_data->parent_data = child_irq_data;
1451 root_irq_data->domain = domain;
1452 root_irq_data->mask = 0;
1453 root_irq_data->hwirq = 0;
1454 root_irq_data->chip = NULL;
1455 root_irq_data->chip_data = NULL;
1456
1457 /* May (probably does) set hwirq, chip, etc. */
1458 rv = irq_domain_alloc_irqs_hierarchy(domain, virq, 1, arg);
1459 if (rv) {
1460 /* Restore the original irq_data. */
1461 *root_irq_data = *child_irq_data;
1462 goto error;
1463 }
1464
1465 irq_domain_fix_revmap(child_irq_data);
1466 irq_domain_set_mapping(domain, root_irq_data->hwirq, root_irq_data);
1467
1468error:
1469 mutex_unlock(&irq_domain_mutex);
1470
1471 return rv;
1472}
1473EXPORT_SYMBOL_GPL(irq_domain_push_irq);
1474
1475/**
1476 * irq_domain_pop_irq() - Remove a domain from the top of a hierarchy.
1477 * @domain: Domain to remove.
1478 * @virq: Irq to remove the domain from.
1479 *
1480 * Undo the effects of a call to irq_domain_push_irq(). Must be
1481 * called either before request_irq() or after free_irq().
1482 */
1483int irq_domain_pop_irq(struct irq_domain *domain, int virq)
1484{
1485 struct irq_data *root_irq_data = irq_get_irq_data(virq);
1486 struct irq_data *child_irq_data;
1487 struct irq_data *tmp_irq_data;
1488 struct irq_desc *desc;
1489
1490 /*
1491 * Check that no action is set, which indicates the virq is in
1492 * a state where this function doesn't have to deal with races
1493 * between interrupt handling and maintaining the hierarchy.
1494 * This will catch gross misuse. Attempting to make the check
1495 * race free would require holding locks across calls to
1496 * struct irq_domain_ops->free(), which could lead to
1497 * deadlock, so we just do a simple check before starting.
1498 */
1499 desc = irq_to_desc(virq);
1500 if (!desc)
1501 return -EINVAL;
1502 if (WARN_ON(desc->action))
1503 return -EBUSY;
1504
1505 if (domain == NULL)
1506 return -EINVAL;
1507
1508 if (!root_irq_data)
1509 return -EINVAL;
1510
1511 tmp_irq_data = irq_domain_get_irq_data(domain, virq);
1512
1513 /* We can only "pop" if this domain is at the top of the list */
1514 if (WARN_ON(root_irq_data != tmp_irq_data))
1515 return -EINVAL;
1516
1517 if (WARN_ON(root_irq_data->domain != domain))
1518 return -EINVAL;
1519
1520 child_irq_data = root_irq_data->parent_data;
1521 if (WARN_ON(!child_irq_data))
1522 return -EINVAL;
1523
1524 mutex_lock(&irq_domain_mutex);
1525
1526 root_irq_data->parent_data = NULL;
1527
1528 irq_domain_clear_mapping(domain, root_irq_data->hwirq);
1529 irq_domain_free_irqs_hierarchy(domain, virq, 1);
1530
1531 /* Restore the original irq_data. */
1532 *root_irq_data = *child_irq_data;
1533
1534 irq_domain_fix_revmap(root_irq_data);
1535
1536 mutex_unlock(&irq_domain_mutex);
1537
1538 kfree(child_irq_data);
1539
1540 return 0;
1541}
1542EXPORT_SYMBOL_GPL(irq_domain_pop_irq);
1543
1544/**
1545 * irq_domain_free_irqs - Free IRQ number and associated data structures
1546 * @virq: base IRQ number
1547 * @nr_irqs: number of IRQs to free
1548 */
1549void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1550{
1551 struct irq_data *data = irq_get_irq_data(virq);
1552 int i;
1553
1554 if (WARN(!data || !data->domain || !data->domain->ops->free,
1555 "NULL pointer, cannot free irq\n"))
1556 return;
1557
1558 mutex_lock(&irq_domain_mutex);
1559 for (i = 0; i < nr_irqs; i++)
1560 irq_domain_remove_irq(virq + i);
1561 irq_domain_free_irqs_hierarchy(data->domain, virq, nr_irqs);
1562 mutex_unlock(&irq_domain_mutex);
1563
1564 irq_domain_free_irq_data(virq, nr_irqs);
1565 irq_free_descs(virq, nr_irqs);
1566}
1567
1568/**
1569 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1570 * @irq_base: Base IRQ number
1571 * @nr_irqs: Number of IRQs to allocate
1572 * @arg: Allocation data (arch/domain specific)
1573 *
1574 * Check whether the domain has been setup recursive. If not allocate
1575 * through the parent domain.
1576 */
1577int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1578 unsigned int irq_base, unsigned int nr_irqs,
1579 void *arg)
1580{
1581 if (!domain->parent)
1582 return -ENOSYS;
1583
1584 return irq_domain_alloc_irqs_hierarchy(domain->parent, irq_base,
1585 nr_irqs, arg);
1586}
1587EXPORT_SYMBOL_GPL(irq_domain_alloc_irqs_parent);
1588
1589/**
1590 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1591 * @irq_base: Base IRQ number
1592 * @nr_irqs: Number of IRQs to free
1593 *
1594 * Check whether the domain has been setup recursive. If not free
1595 * through the parent domain.
1596 */
1597void irq_domain_free_irqs_parent(struct irq_domain *domain,
1598 unsigned int irq_base, unsigned int nr_irqs)
1599{
1600 if (!domain->parent)
1601 return;
1602
1603 irq_domain_free_irqs_hierarchy(domain->parent, irq_base, nr_irqs);
1604}
1605EXPORT_SYMBOL_GPL(irq_domain_free_irqs_parent);
1606
1607static void __irq_domain_deactivate_irq(struct irq_data *irq_data)
1608{
1609 if (irq_data && irq_data->domain) {
1610 struct irq_domain *domain = irq_data->domain;
1611
1612 if (domain->ops->deactivate)
1613 domain->ops->deactivate(domain, irq_data);
1614 if (irq_data->parent_data)
1615 __irq_domain_deactivate_irq(irq_data->parent_data);
1616 }
1617}
1618
1619static int __irq_domain_activate_irq(struct irq_data *irqd, bool reserve)
1620{
1621 int ret = 0;
1622
1623 if (irqd && irqd->domain) {
1624 struct irq_domain *domain = irqd->domain;
1625
1626 if (irqd->parent_data)
1627 ret = __irq_domain_activate_irq(irqd->parent_data,
1628 reserve);
1629 if (!ret && domain->ops->activate) {
1630 ret = domain->ops->activate(domain, irqd, reserve);
1631 /* Rollback in case of error */
1632 if (ret && irqd->parent_data)
1633 __irq_domain_deactivate_irq(irqd->parent_data);
1634 }
1635 }
1636 return ret;
1637}
1638
1639/**
1640 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1641 * interrupt
1642 * @irq_data: Outermost irq_data associated with interrupt
1643 * @reserve: If set only reserve an interrupt vector instead of assigning one
1644 *
1645 * This is the second step to call domain_ops->activate to program interrupt
1646 * controllers, so the interrupt could actually get delivered.
1647 */
1648int irq_domain_activate_irq(struct irq_data *irq_data, bool reserve)
1649{
1650 int ret = 0;
1651
1652 if (!irqd_is_activated(irq_data))
1653 ret = __irq_domain_activate_irq(irq_data, reserve);
1654 if (!ret)
1655 irqd_set_activated(irq_data);
1656 return ret;
1657}
1658
1659/**
1660 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1661 * deactivate interrupt
1662 * @irq_data: outermost irq_data associated with interrupt
1663 *
1664 * It calls domain_ops->deactivate to program interrupt controllers to disable
1665 * interrupt delivery.
1666 */
1667void irq_domain_deactivate_irq(struct irq_data *irq_data)
1668{
1669 if (irqd_is_activated(irq_data)) {
1670 __irq_domain_deactivate_irq(irq_data);
1671 irqd_clr_activated(irq_data);
1672 }
1673}
1674
1675static void irq_domain_check_hierarchy(struct irq_domain *domain)
1676{
1677 /* Hierarchy irq_domains must implement callback alloc() */
1678 if (domain->ops->alloc)
1679 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1680}
1681
1682/**
1683 * irq_domain_hierarchical_is_msi_remap - Check if the domain or any
1684 * parent has MSI remapping support
1685 * @domain: domain pointer
1686 */
1687bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
1688{
1689 for (; domain; domain = domain->parent) {
1690 if (irq_domain_is_msi_remap(domain))
1691 return true;
1692 }
1693 return false;
1694}
1695#else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1696/**
1697 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1698 * @domain: domain to match
1699 * @virq: IRQ number to get irq_data
1700 */
1701struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1702 unsigned int virq)
1703{
1704 struct irq_data *irq_data = irq_get_irq_data(virq);
1705
1706 return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1707}
1708EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1709
1710/**
1711 * irq_domain_set_info - Set the complete data for a @virq in @domain
1712 * @domain: Interrupt domain to match
1713 * @virq: IRQ number
1714 * @hwirq: The hardware interrupt number
1715 * @chip: The associated interrupt chip
1716 * @chip_data: The associated interrupt chip data
1717 * @handler: The interrupt flow handler
1718 * @handler_data: The interrupt flow handler data
1719 * @handler_name: The interrupt handler name
1720 */
1721void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1722 irq_hw_number_t hwirq, struct irq_chip *chip,
1723 void *chip_data, irq_flow_handler_t handler,
1724 void *handler_data, const char *handler_name)
1725{
1726 irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1727 irq_set_chip_data(virq, chip_data);
1728 irq_set_handler_data(virq, handler_data);
1729}
1730
1731static void irq_domain_check_hierarchy(struct irq_domain *domain)
1732{
1733}
1734#endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1735
1736#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
1737static struct dentry *domain_dir;
1738
1739static void
1740irq_domain_debug_show_one(struct seq_file *m, struct irq_domain *d, int ind)
1741{
1742 seq_printf(m, "%*sname: %s\n", ind, "", d->name);
1743 seq_printf(m, "%*ssize: %u\n", ind + 1, "",
1744 d->revmap_size + d->revmap_direct_max_irq);
1745 seq_printf(m, "%*smapped: %u\n", ind + 1, "", d->mapcount);
1746 seq_printf(m, "%*sflags: 0x%08x\n", ind +1 , "", d->flags);
1747 if (d->ops && d->ops->debug_show)
1748 d->ops->debug_show(m, d, NULL, ind + 1);
1749#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1750 if (!d->parent)
1751 return;
1752 seq_printf(m, "%*sparent: %s\n", ind + 1, "", d->parent->name);
1753 irq_domain_debug_show_one(m, d->parent, ind + 4);
1754#endif
1755}
1756
1757static int irq_domain_debug_show(struct seq_file *m, void *p)
1758{
1759 struct irq_domain *d = m->private;
1760
1761 /* Default domain? Might be NULL */
1762 if (!d) {
1763 if (!irq_default_domain)
1764 return 0;
1765 d = irq_default_domain;
1766 }
1767 irq_domain_debug_show_one(m, d, 0);
1768 return 0;
1769}
1770DEFINE_SHOW_ATTRIBUTE(irq_domain_debug);
1771
1772static void debugfs_add_domain_dir(struct irq_domain *d)
1773{
1774 if (!d->name || !domain_dir || d->debugfs_file)
1775 return;
1776 d->debugfs_file = debugfs_create_file(d->name, 0444, domain_dir, d,
1777 &irq_domain_debug_fops);
1778}
1779
1780static void debugfs_remove_domain_dir(struct irq_domain *d)
1781{
1782 debugfs_remove(d->debugfs_file);
1783 d->debugfs_file = NULL;
1784}
1785
1786void __init irq_domain_debugfs_init(struct dentry *root)
1787{
1788 struct irq_domain *d;
1789
1790 domain_dir = debugfs_create_dir("domains", root);
1791
1792 debugfs_create_file("default", 0444, domain_dir, NULL,
1793 &irq_domain_debug_fops);
1794 mutex_lock(&irq_domain_mutex);
1795 list_for_each_entry(d, &irq_domain_list, link)
1796 debugfs_add_domain_dir(d);
1797 mutex_unlock(&irq_domain_mutex);
1798}
1799#endif