xref: /linux/kernel/irq/irqdomain.c (revision e0bf6c5ca2d3281f231c5f0c9bf145e9513644de)
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 
20 static LIST_HEAD(irq_domain_list);
21 static DEFINE_MUTEX(irq_domain_mutex);
22 
23 static DEFINE_MUTEX(revmap_trees_mutex);
24 static struct irq_domain *irq_default_domain;
25 
26 static int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
27 				  irq_hw_number_t hwirq, int node);
28 static void irq_domain_check_hierarchy(struct irq_domain *domain);
29 
30 /**
31  * __irq_domain_add() - Allocate a new irq_domain data structure
32  * @of_node: optional device-tree node of the interrupt controller
33  * @size: Size of linear map; 0 for radix mapping only
34  * @hwirq_max: Maximum number of interrupts supported by controller
35  * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
36  *              direct mapping
37  * @ops: domain callbacks
38  * @host_data: Controller private data pointer
39  *
40  * Allocates and initialize and irq_domain structure.
41  * Returns pointer to IRQ domain, or NULL on failure.
42  */
43 struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
44 				    irq_hw_number_t hwirq_max, int direct_max,
45 				    const struct irq_domain_ops *ops,
46 				    void *host_data)
47 {
48 	struct irq_domain *domain;
49 
50 	domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
51 			      GFP_KERNEL, of_node_to_nid(of_node));
52 	if (WARN_ON(!domain))
53 		return NULL;
54 
55 	/* Fill structure */
56 	INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
57 	domain->ops = ops;
58 	domain->host_data = host_data;
59 	domain->of_node = of_node_get(of_node);
60 	domain->hwirq_max = hwirq_max;
61 	domain->revmap_size = size;
62 	domain->revmap_direct_max_irq = direct_max;
63 	irq_domain_check_hierarchy(domain);
64 
65 	mutex_lock(&irq_domain_mutex);
66 	list_add(&domain->link, &irq_domain_list);
67 	mutex_unlock(&irq_domain_mutex);
68 
69 	pr_debug("Added domain %s\n", domain->name);
70 	return domain;
71 }
72 EXPORT_SYMBOL_GPL(__irq_domain_add);
73 
74 /**
75  * irq_domain_remove() - Remove an irq domain.
76  * @domain: domain to remove
77  *
78  * This routine is used to remove an irq domain. The caller must ensure
79  * that all mappings within the domain have been disposed of prior to
80  * use, depending on the revmap type.
81  */
82 void irq_domain_remove(struct irq_domain *domain)
83 {
84 	mutex_lock(&irq_domain_mutex);
85 
86 	/*
87 	 * radix_tree_delete() takes care of destroying the root
88 	 * node when all entries are removed. Shout if there are
89 	 * any mappings left.
90 	 */
91 	WARN_ON(domain->revmap_tree.height);
92 
93 	list_del(&domain->link);
94 
95 	/*
96 	 * If the going away domain is the default one, reset it.
97 	 */
98 	if (unlikely(irq_default_domain == domain))
99 		irq_set_default_host(NULL);
100 
101 	mutex_unlock(&irq_domain_mutex);
102 
103 	pr_debug("Removed domain %s\n", domain->name);
104 
105 	of_node_put(domain->of_node);
106 	kfree(domain);
107 }
108 EXPORT_SYMBOL_GPL(irq_domain_remove);
109 
110 /**
111  * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
112  * @of_node: pointer to interrupt controller's device tree node.
113  * @size: total number of irqs in mapping
114  * @first_irq: first number of irq block assigned to the domain,
115  *	pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
116  *	pre-map all of the irqs in the domain to virqs starting at first_irq.
117  * @ops: domain callbacks
118  * @host_data: Controller private data pointer
119  *
120  * Allocates an irq_domain, and optionally if first_irq is positive then also
121  * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
122  *
123  * This is intended to implement the expected behaviour for most
124  * interrupt controllers. If device tree is used, then first_irq will be 0 and
125  * irqs get mapped dynamically on the fly. However, if the controller requires
126  * static virq assignments (non-DT boot) then it will set that up correctly.
127  */
128 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
129 					 unsigned int size,
130 					 unsigned int first_irq,
131 					 const struct irq_domain_ops *ops,
132 					 void *host_data)
133 {
134 	struct irq_domain *domain;
135 
136 	domain = __irq_domain_add(of_node, size, size, 0, ops, host_data);
137 	if (!domain)
138 		return NULL;
139 
140 	if (first_irq > 0) {
141 		if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
142 			/* attempt to allocated irq_descs */
143 			int rc = irq_alloc_descs(first_irq, first_irq, size,
144 						 of_node_to_nid(of_node));
145 			if (rc < 0)
146 				pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
147 					first_irq);
148 		}
149 		irq_domain_associate_many(domain, first_irq, 0, size);
150 	}
151 
152 	return domain;
153 }
154 EXPORT_SYMBOL_GPL(irq_domain_add_simple);
155 
156 /**
157  * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
158  * @of_node: pointer to interrupt controller's device tree node.
159  * @size: total number of irqs in legacy mapping
160  * @first_irq: first number of irq block assigned to the domain
161  * @first_hwirq: first hwirq number to use for the translation. Should normally
162  *               be '0', but a positive integer can be used if the effective
163  *               hwirqs numbering does not begin at zero.
164  * @ops: map/unmap domain callbacks
165  * @host_data: Controller private data pointer
166  *
167  * Note: the map() callback will be called before this function returns
168  * for all legacy interrupts except 0 (which is always the invalid irq for
169  * a legacy controller).
170  */
171 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
172 					 unsigned int size,
173 					 unsigned int first_irq,
174 					 irq_hw_number_t first_hwirq,
175 					 const struct irq_domain_ops *ops,
176 					 void *host_data)
177 {
178 	struct irq_domain *domain;
179 
180 	domain = __irq_domain_add(of_node, first_hwirq + size,
181 				  first_hwirq + size, 0, ops, host_data);
182 	if (domain)
183 		irq_domain_associate_many(domain, first_irq, first_hwirq, size);
184 
185 	return domain;
186 }
187 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
188 
189 /**
190  * irq_find_host() - Locates a domain for a given device node
191  * @node: device-tree node of the interrupt controller
192  */
193 struct irq_domain *irq_find_host(struct device_node *node)
194 {
195 	struct irq_domain *h, *found = NULL;
196 	int rc;
197 
198 	/* We might want to match the legacy controller last since
199 	 * it might potentially be set to match all interrupts in
200 	 * the absence of a device node. This isn't a problem so far
201 	 * yet though...
202 	 */
203 	mutex_lock(&irq_domain_mutex);
204 	list_for_each_entry(h, &irq_domain_list, link) {
205 		if (h->ops->match)
206 			rc = h->ops->match(h, node);
207 		else
208 			rc = (h->of_node != NULL) && (h->of_node == node);
209 
210 		if (rc) {
211 			found = h;
212 			break;
213 		}
214 	}
215 	mutex_unlock(&irq_domain_mutex);
216 	return found;
217 }
218 EXPORT_SYMBOL_GPL(irq_find_host);
219 
220 /**
221  * irq_set_default_host() - Set a "default" irq domain
222  * @domain: default domain pointer
223  *
224  * For convenience, it's possible to set a "default" domain that will be used
225  * whenever NULL is passed to irq_create_mapping(). It makes life easier for
226  * platforms that want to manipulate a few hard coded interrupt numbers that
227  * aren't properly represented in the device-tree.
228  */
229 void irq_set_default_host(struct irq_domain *domain)
230 {
231 	pr_debug("Default domain set to @0x%p\n", domain);
232 
233 	irq_default_domain = domain;
234 }
235 EXPORT_SYMBOL_GPL(irq_set_default_host);
236 
237 void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
238 {
239 	struct irq_data *irq_data = irq_get_irq_data(irq);
240 	irq_hw_number_t hwirq;
241 
242 	if (WARN(!irq_data || irq_data->domain != domain,
243 		 "virq%i doesn't exist; cannot disassociate\n", irq))
244 		return;
245 
246 	hwirq = irq_data->hwirq;
247 	irq_set_status_flags(irq, IRQ_NOREQUEST);
248 
249 	/* remove chip and handler */
250 	irq_set_chip_and_handler(irq, NULL, NULL);
251 
252 	/* Make sure it's completed */
253 	synchronize_irq(irq);
254 
255 	/* Tell the PIC about it */
256 	if (domain->ops->unmap)
257 		domain->ops->unmap(domain, irq);
258 	smp_mb();
259 
260 	irq_data->domain = NULL;
261 	irq_data->hwirq = 0;
262 
263 	/* Clear reverse map for this hwirq */
264 	if (hwirq < domain->revmap_size) {
265 		domain->linear_revmap[hwirq] = 0;
266 	} else {
267 		mutex_lock(&revmap_trees_mutex);
268 		radix_tree_delete(&domain->revmap_tree, hwirq);
269 		mutex_unlock(&revmap_trees_mutex);
270 	}
271 }
272 
273 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
274 			 irq_hw_number_t hwirq)
275 {
276 	struct irq_data *irq_data = irq_get_irq_data(virq);
277 	int ret;
278 
279 	if (WARN(hwirq >= domain->hwirq_max,
280 		 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
281 		return -EINVAL;
282 	if (WARN(!irq_data, "error: virq%i is not allocated", virq))
283 		return -EINVAL;
284 	if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
285 		return -EINVAL;
286 
287 	mutex_lock(&irq_domain_mutex);
288 	irq_data->hwirq = hwirq;
289 	irq_data->domain = domain;
290 	if (domain->ops->map) {
291 		ret = domain->ops->map(domain, virq, hwirq);
292 		if (ret != 0) {
293 			/*
294 			 * If map() returns -EPERM, this interrupt is protected
295 			 * by the firmware or some other service and shall not
296 			 * be mapped. Don't bother telling the user about it.
297 			 */
298 			if (ret != -EPERM) {
299 				pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
300 				       domain->name, hwirq, virq, ret);
301 			}
302 			irq_data->domain = NULL;
303 			irq_data->hwirq = 0;
304 			mutex_unlock(&irq_domain_mutex);
305 			return ret;
306 		}
307 
308 		/* If not already assigned, give the domain the chip's name */
309 		if (!domain->name && irq_data->chip)
310 			domain->name = irq_data->chip->name;
311 	}
312 
313 	if (hwirq < domain->revmap_size) {
314 		domain->linear_revmap[hwirq] = virq;
315 	} else {
316 		mutex_lock(&revmap_trees_mutex);
317 		radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
318 		mutex_unlock(&revmap_trees_mutex);
319 	}
320 	mutex_unlock(&irq_domain_mutex);
321 
322 	irq_clear_status_flags(virq, IRQ_NOREQUEST);
323 
324 	return 0;
325 }
326 EXPORT_SYMBOL_GPL(irq_domain_associate);
327 
328 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
329 			       irq_hw_number_t hwirq_base, int count)
330 {
331 	int i;
332 
333 	pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
334 		of_node_full_name(domain->of_node), irq_base, (int)hwirq_base, count);
335 
336 	for (i = 0; i < count; i++) {
337 		irq_domain_associate(domain, irq_base + i, hwirq_base + i);
338 	}
339 }
340 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
341 
342 /**
343  * irq_create_direct_mapping() - Allocate an irq for direct mapping
344  * @domain: domain to allocate the irq for or NULL for default domain
345  *
346  * This routine is used for irq controllers which can choose the hardware
347  * interrupt numbers they generate. In such a case it's simplest to use
348  * the linux irq as the hardware interrupt number. It still uses the linear
349  * or radix tree to store the mapping, but the irq controller can optimize
350  * the revmap path by using the hwirq directly.
351  */
352 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
353 {
354 	unsigned int virq;
355 
356 	if (domain == NULL)
357 		domain = irq_default_domain;
358 
359 	virq = irq_alloc_desc_from(1, of_node_to_nid(domain->of_node));
360 	if (!virq) {
361 		pr_debug("create_direct virq allocation failed\n");
362 		return 0;
363 	}
364 	if (virq >= domain->revmap_direct_max_irq) {
365 		pr_err("ERROR: no free irqs available below %i maximum\n",
366 			domain->revmap_direct_max_irq);
367 		irq_free_desc(virq);
368 		return 0;
369 	}
370 	pr_debug("create_direct obtained virq %d\n", virq);
371 
372 	if (irq_domain_associate(domain, virq, virq)) {
373 		irq_free_desc(virq);
374 		return 0;
375 	}
376 
377 	return virq;
378 }
379 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
380 
381 /**
382  * irq_create_mapping() - Map a hardware interrupt into linux irq space
383  * @domain: domain owning this hardware interrupt or NULL for default domain
384  * @hwirq: hardware irq number in that domain space
385  *
386  * Only one mapping per hardware interrupt is permitted. Returns a linux
387  * irq number.
388  * If the sense/trigger is to be specified, set_irq_type() should be called
389  * on the number returned from that call.
390  */
391 unsigned int irq_create_mapping(struct irq_domain *domain,
392 				irq_hw_number_t hwirq)
393 {
394 	int virq;
395 
396 	pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
397 
398 	/* Look for default domain if nececssary */
399 	if (domain == NULL)
400 		domain = irq_default_domain;
401 	if (domain == NULL) {
402 		WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
403 		return 0;
404 	}
405 	pr_debug("-> using domain @%p\n", domain);
406 
407 	/* Check if mapping already exists */
408 	virq = irq_find_mapping(domain, hwirq);
409 	if (virq) {
410 		pr_debug("-> existing mapping on virq %d\n", virq);
411 		return virq;
412 	}
413 
414 	/* Allocate a virtual interrupt number */
415 	virq = irq_domain_alloc_descs(-1, 1, hwirq,
416 				      of_node_to_nid(domain->of_node));
417 	if (virq <= 0) {
418 		pr_debug("-> virq allocation failed\n");
419 		return 0;
420 	}
421 
422 	if (irq_domain_associate(domain, virq, hwirq)) {
423 		irq_free_desc(virq);
424 		return 0;
425 	}
426 
427 	pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
428 		hwirq, of_node_full_name(domain->of_node), virq);
429 
430 	return virq;
431 }
432 EXPORT_SYMBOL_GPL(irq_create_mapping);
433 
434 /**
435  * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
436  * @domain: domain owning the interrupt range
437  * @irq_base: beginning of linux IRQ range
438  * @hwirq_base: beginning of hardware IRQ range
439  * @count: Number of interrupts to map
440  *
441  * This routine is used for allocating and mapping a range of hardware
442  * irqs to linux irqs where the linux irq numbers are at pre-defined
443  * locations. For use by controllers that already have static mappings
444  * to insert in to the domain.
445  *
446  * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
447  * domain insertion.
448  *
449  * 0 is returned upon success, while any failure to establish a static
450  * mapping is treated as an error.
451  */
452 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
453 			       irq_hw_number_t hwirq_base, int count)
454 {
455 	int ret;
456 
457 	ret = irq_alloc_descs(irq_base, irq_base, count,
458 			      of_node_to_nid(domain->of_node));
459 	if (unlikely(ret < 0))
460 		return ret;
461 
462 	irq_domain_associate_many(domain, irq_base, hwirq_base, count);
463 	return 0;
464 }
465 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
466 
467 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
468 {
469 	struct irq_domain *domain;
470 	irq_hw_number_t hwirq;
471 	unsigned int type = IRQ_TYPE_NONE;
472 	int virq;
473 
474 	domain = irq_data->np ? irq_find_host(irq_data->np) : irq_default_domain;
475 	if (!domain) {
476 		pr_warn("no irq domain found for %s !\n",
477 			of_node_full_name(irq_data->np));
478 		return 0;
479 	}
480 
481 	/* If domain has no translation, then we assume interrupt line */
482 	if (domain->ops->xlate == NULL)
483 		hwirq = irq_data->args[0];
484 	else {
485 		if (domain->ops->xlate(domain, irq_data->np, irq_data->args,
486 					irq_data->args_count, &hwirq, &type))
487 			return 0;
488 	}
489 
490 	if (irq_domain_is_hierarchy(domain)) {
491 		/*
492 		 * If we've already configured this interrupt,
493 		 * don't do it again, or hell will break loose.
494 		 */
495 		virq = irq_find_mapping(domain, hwirq);
496 		if (virq)
497 			return virq;
498 
499 		virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, irq_data);
500 		if (virq <= 0)
501 			return 0;
502 	} else {
503 		/* Create mapping */
504 		virq = irq_create_mapping(domain, hwirq);
505 		if (!virq)
506 			return virq;
507 	}
508 
509 	/* Set type if specified and different than the current one */
510 	if (type != IRQ_TYPE_NONE &&
511 	    type != irq_get_trigger_type(virq))
512 		irq_set_irq_type(virq, type);
513 	return virq;
514 }
515 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
516 
517 /**
518  * irq_dispose_mapping() - Unmap an interrupt
519  * @virq: linux irq number of the interrupt to unmap
520  */
521 void irq_dispose_mapping(unsigned int virq)
522 {
523 	struct irq_data *irq_data = irq_get_irq_data(virq);
524 	struct irq_domain *domain;
525 
526 	if (!virq || !irq_data)
527 		return;
528 
529 	domain = irq_data->domain;
530 	if (WARN_ON(domain == NULL))
531 		return;
532 
533 	irq_domain_disassociate(domain, virq);
534 	irq_free_desc(virq);
535 }
536 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
537 
538 /**
539  * irq_find_mapping() - Find a linux irq from an hw irq number.
540  * @domain: domain owning this hardware interrupt
541  * @hwirq: hardware irq number in that domain space
542  */
543 unsigned int irq_find_mapping(struct irq_domain *domain,
544 			      irq_hw_number_t hwirq)
545 {
546 	struct irq_data *data;
547 
548 	/* Look for default domain if nececssary */
549 	if (domain == NULL)
550 		domain = irq_default_domain;
551 	if (domain == NULL)
552 		return 0;
553 
554 	if (hwirq < domain->revmap_direct_max_irq) {
555 		data = irq_domain_get_irq_data(domain, hwirq);
556 		if (data && data->hwirq == hwirq)
557 			return hwirq;
558 	}
559 
560 	/* Check if the hwirq is in the linear revmap. */
561 	if (hwirq < domain->revmap_size)
562 		return domain->linear_revmap[hwirq];
563 
564 	rcu_read_lock();
565 	data = radix_tree_lookup(&domain->revmap_tree, hwirq);
566 	rcu_read_unlock();
567 	return data ? data->irq : 0;
568 }
569 EXPORT_SYMBOL_GPL(irq_find_mapping);
570 
571 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
572 static int virq_debug_show(struct seq_file *m, void *private)
573 {
574 	unsigned long flags;
575 	struct irq_desc *desc;
576 	struct irq_domain *domain;
577 	struct radix_tree_iter iter;
578 	void *data, **slot;
579 	int i;
580 
581 	seq_printf(m, " %-16s  %-6s  %-10s  %-10s  %s\n",
582 		   "name", "mapped", "linear-max", "direct-max", "devtree-node");
583 	mutex_lock(&irq_domain_mutex);
584 	list_for_each_entry(domain, &irq_domain_list, link) {
585 		int count = 0;
586 		radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
587 			count++;
588 		seq_printf(m, "%c%-16s  %6u  %10u  %10u  %s\n",
589 			   domain == irq_default_domain ? '*' : ' ', domain->name,
590 			   domain->revmap_size + count, domain->revmap_size,
591 			   domain->revmap_direct_max_irq,
592 			   domain->of_node ? of_node_full_name(domain->of_node) : "");
593 	}
594 	mutex_unlock(&irq_domain_mutex);
595 
596 	seq_printf(m, "%-5s  %-7s  %-15s  %-*s  %6s  %-14s  %s\n", "irq", "hwirq",
597 		      "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
598 		      "active", "type", "domain");
599 
600 	for (i = 1; i < nr_irqs; i++) {
601 		desc = irq_to_desc(i);
602 		if (!desc)
603 			continue;
604 
605 		raw_spin_lock_irqsave(&desc->lock, flags);
606 		domain = desc->irq_data.domain;
607 
608 		if (domain) {
609 			struct irq_chip *chip;
610 			int hwirq = desc->irq_data.hwirq;
611 			bool direct;
612 
613 			seq_printf(m, "%5d  ", i);
614 			seq_printf(m, "0x%05x  ", hwirq);
615 
616 			chip = irq_desc_get_chip(desc);
617 			seq_printf(m, "%-15s  ", (chip && chip->name) ? chip->name : "none");
618 
619 			data = irq_desc_get_chip_data(desc);
620 			seq_printf(m, data ? "0x%p  " : "  %p  ", data);
621 
622 			seq_printf(m, "   %c    ", (desc->action && desc->action->handler) ? '*' : ' ');
623 			direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
624 			seq_printf(m, "%6s%-8s  ",
625 				   (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
626 				   direct ? "(DIRECT)" : "");
627 			seq_printf(m, "%s\n", desc->irq_data.domain->name);
628 		}
629 
630 		raw_spin_unlock_irqrestore(&desc->lock, flags);
631 	}
632 
633 	return 0;
634 }
635 
636 static int virq_debug_open(struct inode *inode, struct file *file)
637 {
638 	return single_open(file, virq_debug_show, inode->i_private);
639 }
640 
641 static const struct file_operations virq_debug_fops = {
642 	.open = virq_debug_open,
643 	.read = seq_read,
644 	.llseek = seq_lseek,
645 	.release = single_release,
646 };
647 
648 static int __init irq_debugfs_init(void)
649 {
650 	if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
651 				 NULL, &virq_debug_fops) == NULL)
652 		return -ENOMEM;
653 
654 	return 0;
655 }
656 __initcall(irq_debugfs_init);
657 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
658 
659 /**
660  * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
661  *
662  * Device Tree IRQ specifier translation function which works with one cell
663  * bindings where the cell value maps directly to the hwirq number.
664  */
665 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
666 			     const u32 *intspec, unsigned int intsize,
667 			     unsigned long *out_hwirq, unsigned int *out_type)
668 {
669 	if (WARN_ON(intsize < 1))
670 		return -EINVAL;
671 	*out_hwirq = intspec[0];
672 	*out_type = IRQ_TYPE_NONE;
673 	return 0;
674 }
675 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
676 
677 /**
678  * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
679  *
680  * Device Tree IRQ specifier translation function which works with two cell
681  * bindings where the cell values map directly to the hwirq number
682  * and linux irq flags.
683  */
684 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
685 			const u32 *intspec, unsigned int intsize,
686 			irq_hw_number_t *out_hwirq, unsigned int *out_type)
687 {
688 	if (WARN_ON(intsize < 2))
689 		return -EINVAL;
690 	*out_hwirq = intspec[0];
691 	*out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
692 	return 0;
693 }
694 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
695 
696 /**
697  * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
698  *
699  * Device Tree IRQ specifier translation function which works with either one
700  * or two cell bindings where the cell values map directly to the hwirq number
701  * and linux irq flags.
702  *
703  * Note: don't use this function unless your interrupt controller explicitly
704  * supports both one and two cell bindings.  For the majority of controllers
705  * the _onecell() or _twocell() variants above should be used.
706  */
707 int irq_domain_xlate_onetwocell(struct irq_domain *d,
708 				struct device_node *ctrlr,
709 				const u32 *intspec, unsigned int intsize,
710 				unsigned long *out_hwirq, unsigned int *out_type)
711 {
712 	if (WARN_ON(intsize < 1))
713 		return -EINVAL;
714 	*out_hwirq = intspec[0];
715 	*out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
716 	return 0;
717 }
718 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
719 
720 const struct irq_domain_ops irq_domain_simple_ops = {
721 	.xlate = irq_domain_xlate_onetwocell,
722 };
723 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
724 
725 static int irq_domain_alloc_descs(int virq, unsigned int cnt,
726 				  irq_hw_number_t hwirq, int node)
727 {
728 	unsigned int hint;
729 
730 	if (virq >= 0) {
731 		virq = irq_alloc_descs(virq, virq, cnt, node);
732 	} else {
733 		hint = hwirq % nr_irqs;
734 		if (hint == 0)
735 			hint++;
736 		virq = irq_alloc_descs_from(hint, cnt, node);
737 		if (virq <= 0 && hint > 1)
738 			virq = irq_alloc_descs_from(1, cnt, node);
739 	}
740 
741 	return virq;
742 }
743 
744 #ifdef	CONFIG_IRQ_DOMAIN_HIERARCHY
745 /**
746  * irq_domain_add_hierarchy - Add a irqdomain into the hierarchy
747  * @parent:	Parent irq domain to associate with the new domain
748  * @flags:	Irq domain flags associated to the domain
749  * @size:	Size of the domain. See below
750  * @node:	Optional device-tree node of the interrupt controller
751  * @ops:	Pointer to the interrupt domain callbacks
752  * @host_data:	Controller private data pointer
753  *
754  * If @size is 0 a tree domain is created, otherwise a linear domain.
755  *
756  * If successful the parent is associated to the new domain and the
757  * domain flags are set.
758  * Returns pointer to IRQ domain, or NULL on failure.
759  */
760 struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
761 					    unsigned int flags,
762 					    unsigned int size,
763 					    struct device_node *node,
764 					    const struct irq_domain_ops *ops,
765 					    void *host_data)
766 {
767 	struct irq_domain *domain;
768 
769 	if (size)
770 		domain = irq_domain_add_linear(node, size, ops, host_data);
771 	else
772 		domain = irq_domain_add_tree(node, ops, host_data);
773 	if (domain) {
774 		domain->parent = parent;
775 		domain->flags |= flags;
776 	}
777 
778 	return domain;
779 }
780 
781 static void irq_domain_insert_irq(int virq)
782 {
783 	struct irq_data *data;
784 
785 	for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
786 		struct irq_domain *domain = data->domain;
787 		irq_hw_number_t hwirq = data->hwirq;
788 
789 		if (hwirq < domain->revmap_size) {
790 			domain->linear_revmap[hwirq] = virq;
791 		} else {
792 			mutex_lock(&revmap_trees_mutex);
793 			radix_tree_insert(&domain->revmap_tree, hwirq, data);
794 			mutex_unlock(&revmap_trees_mutex);
795 		}
796 
797 		/* If not already assigned, give the domain the chip's name */
798 		if (!domain->name && data->chip)
799 			domain->name = data->chip->name;
800 	}
801 
802 	irq_clear_status_flags(virq, IRQ_NOREQUEST);
803 }
804 
805 static void irq_domain_remove_irq(int virq)
806 {
807 	struct irq_data *data;
808 
809 	irq_set_status_flags(virq, IRQ_NOREQUEST);
810 	irq_set_chip_and_handler(virq, NULL, NULL);
811 	synchronize_irq(virq);
812 	smp_mb();
813 
814 	for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
815 		struct irq_domain *domain = data->domain;
816 		irq_hw_number_t hwirq = data->hwirq;
817 
818 		if (hwirq < domain->revmap_size) {
819 			domain->linear_revmap[hwirq] = 0;
820 		} else {
821 			mutex_lock(&revmap_trees_mutex);
822 			radix_tree_delete(&domain->revmap_tree, hwirq);
823 			mutex_unlock(&revmap_trees_mutex);
824 		}
825 	}
826 }
827 
828 static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
829 						   struct irq_data *child)
830 {
831 	struct irq_data *irq_data;
832 
833 	irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL, child->node);
834 	if (irq_data) {
835 		child->parent_data = irq_data;
836 		irq_data->irq = child->irq;
837 		irq_data->node = child->node;
838 		irq_data->domain = domain;
839 	}
840 
841 	return irq_data;
842 }
843 
844 static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
845 {
846 	struct irq_data *irq_data, *tmp;
847 	int i;
848 
849 	for (i = 0; i < nr_irqs; i++) {
850 		irq_data = irq_get_irq_data(virq + i);
851 		tmp = irq_data->parent_data;
852 		irq_data->parent_data = NULL;
853 		irq_data->domain = NULL;
854 
855 		while (tmp) {
856 			irq_data = tmp;
857 			tmp = tmp->parent_data;
858 			kfree(irq_data);
859 		}
860 	}
861 }
862 
863 static int irq_domain_alloc_irq_data(struct irq_domain *domain,
864 				     unsigned int virq, unsigned int nr_irqs)
865 {
866 	struct irq_data *irq_data;
867 	struct irq_domain *parent;
868 	int i;
869 
870 	/* The outermost irq_data is embedded in struct irq_desc */
871 	for (i = 0; i < nr_irqs; i++) {
872 		irq_data = irq_get_irq_data(virq + i);
873 		irq_data->domain = domain;
874 
875 		for (parent = domain->parent; parent; parent = parent->parent) {
876 			irq_data = irq_domain_insert_irq_data(parent, irq_data);
877 			if (!irq_data) {
878 				irq_domain_free_irq_data(virq, i + 1);
879 				return -ENOMEM;
880 			}
881 		}
882 	}
883 
884 	return 0;
885 }
886 
887 /**
888  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
889  * @domain:	domain to match
890  * @virq:	IRQ number to get irq_data
891  */
892 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
893 					 unsigned int virq)
894 {
895 	struct irq_data *irq_data;
896 
897 	for (irq_data = irq_get_irq_data(virq); irq_data;
898 	     irq_data = irq_data->parent_data)
899 		if (irq_data->domain == domain)
900 			return irq_data;
901 
902 	return NULL;
903 }
904 
905 /**
906  * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
907  * @domain:	Interrupt domain to match
908  * @virq:	IRQ number
909  * @hwirq:	The hwirq number
910  * @chip:	The associated interrupt chip
911  * @chip_data:	The associated chip data
912  */
913 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
914 				  irq_hw_number_t hwirq, struct irq_chip *chip,
915 				  void *chip_data)
916 {
917 	struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
918 
919 	if (!irq_data)
920 		return -ENOENT;
921 
922 	irq_data->hwirq = hwirq;
923 	irq_data->chip = chip ? chip : &no_irq_chip;
924 	irq_data->chip_data = chip_data;
925 
926 	return 0;
927 }
928 
929 /**
930  * irq_domain_set_info - Set the complete data for a @virq in @domain
931  * @domain:		Interrupt domain to match
932  * @virq:		IRQ number
933  * @hwirq:		The hardware interrupt number
934  * @chip:		The associated interrupt chip
935  * @chip_data:		The associated interrupt chip data
936  * @handler:		The interrupt flow handler
937  * @handler_data:	The interrupt flow handler data
938  * @handler_name:	The interrupt handler name
939  */
940 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
941 			 irq_hw_number_t hwirq, struct irq_chip *chip,
942 			 void *chip_data, irq_flow_handler_t handler,
943 			 void *handler_data, const char *handler_name)
944 {
945 	irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
946 	__irq_set_handler(virq, handler, 0, handler_name);
947 	irq_set_handler_data(virq, handler_data);
948 }
949 
950 /**
951  * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
952  * @irq_data:	The pointer to irq_data
953  */
954 void irq_domain_reset_irq_data(struct irq_data *irq_data)
955 {
956 	irq_data->hwirq = 0;
957 	irq_data->chip = &no_irq_chip;
958 	irq_data->chip_data = NULL;
959 }
960 
961 /**
962  * irq_domain_free_irqs_common - Clear irq_data and free the parent
963  * @domain:	Interrupt domain to match
964  * @virq:	IRQ number to start with
965  * @nr_irqs:	The number of irqs to free
966  */
967 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
968 				 unsigned int nr_irqs)
969 {
970 	struct irq_data *irq_data;
971 	int i;
972 
973 	for (i = 0; i < nr_irqs; i++) {
974 		irq_data = irq_domain_get_irq_data(domain, virq + i);
975 		if (irq_data)
976 			irq_domain_reset_irq_data(irq_data);
977 	}
978 	irq_domain_free_irqs_parent(domain, virq, nr_irqs);
979 }
980 
981 /**
982  * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
983  * @domain:	Interrupt domain to match
984  * @virq:	IRQ number to start with
985  * @nr_irqs:	The number of irqs to free
986  */
987 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
988 			      unsigned int nr_irqs)
989 {
990 	int i;
991 
992 	for (i = 0; i < nr_irqs; i++) {
993 		irq_set_handler_data(virq + i, NULL);
994 		irq_set_handler(virq + i, NULL);
995 	}
996 	irq_domain_free_irqs_common(domain, virq, nr_irqs);
997 }
998 
999 static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1000 {
1001 	return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1002 }
1003 
1004 static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1005 					   unsigned int irq_base,
1006 					   unsigned int nr_irqs)
1007 {
1008 	domain->ops->free(domain, irq_base, nr_irqs);
1009 	if (irq_domain_is_auto_recursive(domain)) {
1010 		BUG_ON(!domain->parent);
1011 		irq_domain_free_irqs_recursive(domain->parent, irq_base,
1012 					       nr_irqs);
1013 	}
1014 }
1015 
1016 static int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1017 					   unsigned int irq_base,
1018 					   unsigned int nr_irqs, void *arg)
1019 {
1020 	int ret = 0;
1021 	struct irq_domain *parent = domain->parent;
1022 	bool recursive = irq_domain_is_auto_recursive(domain);
1023 
1024 	BUG_ON(recursive && !parent);
1025 	if (recursive)
1026 		ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1027 						      nr_irqs, arg);
1028 	if (ret >= 0)
1029 		ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1030 	if (ret < 0 && recursive)
1031 		irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1032 
1033 	return ret;
1034 }
1035 
1036 /**
1037  * __irq_domain_alloc_irqs - Allocate IRQs from domain
1038  * @domain:	domain to allocate from
1039  * @irq_base:	allocate specified IRQ nubmer if irq_base >= 0
1040  * @nr_irqs:	number of IRQs to allocate
1041  * @node:	NUMA node id for memory allocation
1042  * @arg:	domain specific argument
1043  * @realloc:	IRQ descriptors have already been allocated if true
1044  *
1045  * Allocate IRQ numbers and initialized all data structures to support
1046  * hierarchy IRQ domains.
1047  * Parameter @realloc is mainly to support legacy IRQs.
1048  * Returns error code or allocated IRQ number
1049  *
1050  * The whole process to setup an IRQ has been split into two steps.
1051  * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1052  * descriptor and required hardware resources. The second step,
1053  * irq_domain_activate_irq(), is to program hardwares with preallocated
1054  * resources. In this way, it's easier to rollback when failing to
1055  * allocate resources.
1056  */
1057 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1058 			    unsigned int nr_irqs, int node, void *arg,
1059 			    bool realloc)
1060 {
1061 	int i, ret, virq;
1062 
1063 	if (domain == NULL) {
1064 		domain = irq_default_domain;
1065 		if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1066 			return -EINVAL;
1067 	}
1068 
1069 	if (!domain->ops->alloc) {
1070 		pr_debug("domain->ops->alloc() is NULL\n");
1071 		return -ENOSYS;
1072 	}
1073 
1074 	if (realloc && irq_base >= 0) {
1075 		virq = irq_base;
1076 	} else {
1077 		virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node);
1078 		if (virq < 0) {
1079 			pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1080 				 irq_base, nr_irqs);
1081 			return virq;
1082 		}
1083 	}
1084 
1085 	if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1086 		pr_debug("cannot allocate memory for IRQ%d\n", virq);
1087 		ret = -ENOMEM;
1088 		goto out_free_desc;
1089 	}
1090 
1091 	mutex_lock(&irq_domain_mutex);
1092 	ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1093 	if (ret < 0) {
1094 		mutex_unlock(&irq_domain_mutex);
1095 		goto out_free_irq_data;
1096 	}
1097 	for (i = 0; i < nr_irqs; i++)
1098 		irq_domain_insert_irq(virq + i);
1099 	mutex_unlock(&irq_domain_mutex);
1100 
1101 	return virq;
1102 
1103 out_free_irq_data:
1104 	irq_domain_free_irq_data(virq, nr_irqs);
1105 out_free_desc:
1106 	irq_free_descs(virq, nr_irqs);
1107 	return ret;
1108 }
1109 
1110 /**
1111  * irq_domain_free_irqs - Free IRQ number and associated data structures
1112  * @virq:	base IRQ number
1113  * @nr_irqs:	number of IRQs to free
1114  */
1115 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1116 {
1117 	struct irq_data *data = irq_get_irq_data(virq);
1118 	int i;
1119 
1120 	if (WARN(!data || !data->domain || !data->domain->ops->free,
1121 		 "NULL pointer, cannot free irq\n"))
1122 		return;
1123 
1124 	mutex_lock(&irq_domain_mutex);
1125 	for (i = 0; i < nr_irqs; i++)
1126 		irq_domain_remove_irq(virq + i);
1127 	irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1128 	mutex_unlock(&irq_domain_mutex);
1129 
1130 	irq_domain_free_irq_data(virq, nr_irqs);
1131 	irq_free_descs(virq, nr_irqs);
1132 }
1133 
1134 /**
1135  * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1136  * @irq_base:	Base IRQ number
1137  * @nr_irqs:	Number of IRQs to allocate
1138  * @arg:	Allocation data (arch/domain specific)
1139  *
1140  * Check whether the domain has been setup recursive. If not allocate
1141  * through the parent domain.
1142  */
1143 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1144 				 unsigned int irq_base, unsigned int nr_irqs,
1145 				 void *arg)
1146 {
1147 	/* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1148 	if (irq_domain_is_auto_recursive(domain))
1149 		return 0;
1150 
1151 	domain = domain->parent;
1152 	if (domain)
1153 		return irq_domain_alloc_irqs_recursive(domain, irq_base,
1154 						       nr_irqs, arg);
1155 	return -ENOSYS;
1156 }
1157 
1158 /**
1159  * irq_domain_free_irqs_parent - Free interrupts from parent domain
1160  * @irq_base:	Base IRQ number
1161  * @nr_irqs:	Number of IRQs to free
1162  *
1163  * Check whether the domain has been setup recursive. If not free
1164  * through the parent domain.
1165  */
1166 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1167 				 unsigned int irq_base, unsigned int nr_irqs)
1168 {
1169 	/* irq_domain_free_irqs_recursive() will call parent's free */
1170 	if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1171 		irq_domain_free_irqs_recursive(domain->parent, irq_base,
1172 					       nr_irqs);
1173 }
1174 
1175 /**
1176  * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1177  *			     interrupt
1178  * @irq_data:	outermost irq_data associated with interrupt
1179  *
1180  * This is the second step to call domain_ops->activate to program interrupt
1181  * controllers, so the interrupt could actually get delivered.
1182  */
1183 void irq_domain_activate_irq(struct irq_data *irq_data)
1184 {
1185 	if (irq_data && irq_data->domain) {
1186 		struct irq_domain *domain = irq_data->domain;
1187 
1188 		if (irq_data->parent_data)
1189 			irq_domain_activate_irq(irq_data->parent_data);
1190 		if (domain->ops->activate)
1191 			domain->ops->activate(domain, irq_data);
1192 	}
1193 }
1194 
1195 /**
1196  * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1197  *			       deactivate interrupt
1198  * @irq_data: outermost irq_data associated with interrupt
1199  *
1200  * It calls domain_ops->deactivate to program interrupt controllers to disable
1201  * interrupt delivery.
1202  */
1203 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1204 {
1205 	if (irq_data && irq_data->domain) {
1206 		struct irq_domain *domain = irq_data->domain;
1207 
1208 		if (domain->ops->deactivate)
1209 			domain->ops->deactivate(domain, irq_data);
1210 		if (irq_data->parent_data)
1211 			irq_domain_deactivate_irq(irq_data->parent_data);
1212 	}
1213 }
1214 
1215 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1216 {
1217 	/* Hierarchy irq_domains must implement callback alloc() */
1218 	if (domain->ops->alloc)
1219 		domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1220 }
1221 #else	/* CONFIG_IRQ_DOMAIN_HIERARCHY */
1222 /**
1223  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1224  * @domain:	domain to match
1225  * @virq:	IRQ number to get irq_data
1226  */
1227 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1228 					 unsigned int virq)
1229 {
1230 	struct irq_data *irq_data = irq_get_irq_data(virq);
1231 
1232 	return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1233 }
1234 
1235 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1236 {
1237 }
1238 #endif	/* CONFIG_IRQ_DOMAIN_HIERARCHY */
1239