]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - kernel/irq/irqdomain.c
irqdomain: eliminate slow-path revmap lookups
[mirror_ubuntu-zesty-kernel.git] / kernel / irq / irqdomain.c
CommitLineData
54a90588
PM
1#define pr_fmt(fmt) "irq: " fmt
2
cc79ca69
GL
3#include <linux/debugfs.h>
4#include <linux/hardirq.h>
5#include <linux/interrupt.h>
08a543ad 6#include <linux/irq.h>
cc79ca69 7#include <linux/irqdesc.h>
08a543ad
GL
8#include <linux/irqdomain.h>
9#include <linux/module.h>
10#include <linux/mutex.h>
11#include <linux/of.h>
7e713301 12#include <linux/of_address.h>
5ca4db61 13#include <linux/topology.h>
cc79ca69 14#include <linux/seq_file.h>
7e713301 15#include <linux/slab.h>
cc79ca69
GL
16#include <linux/smp.h>
17#include <linux/fs.h>
08a543ad 18
1bc04f2c
GL
19#define IRQ_DOMAIN_MAP_LEGACY 0 /* driver allocated fixed range of irqs.
20 * ie. legacy 8259, gets irqs 1..15 */
a8db8cf0
GL
21#define IRQ_DOMAIN_MAP_NOMAP 1 /* no fast reverse mapping */
22#define IRQ_DOMAIN_MAP_LINEAR 2 /* linear map of interrupts */
23#define IRQ_DOMAIN_MAP_TREE 3 /* radix tree */
24
08a543ad
GL
25static LIST_HEAD(irq_domain_list);
26static DEFINE_MUTEX(irq_domain_mutex);
27
cc79ca69 28static DEFINE_MUTEX(revmap_trees_mutex);
68700650 29static struct irq_domain *irq_default_domain;
cc79ca69 30
cc79ca69 31/**
a8db8cf0 32 * irq_domain_alloc() - Allocate a new irq_domain data structure
cc79ca69
GL
33 * @of_node: optional device-tree node of the interrupt controller
34 * @revmap_type: type of reverse mapping to use
68700650 35 * @ops: map/unmap domain callbacks
a8db8cf0 36 * @host_data: Controller private data pointer
cc79ca69 37 *
a8db8cf0
GL
38 * Allocates and initialize and irq_domain structure. Caller is expected to
39 * register allocated irq_domain with irq_domain_register(). Returns pointer
40 * to IRQ domain, or NULL on failure.
cc79ca69 41 */
a8db8cf0
GL
42static struct irq_domain *irq_domain_alloc(struct device_node *of_node,
43 unsigned int revmap_type,
a18dc81b 44 const struct irq_domain_ops *ops,
a8db8cf0 45 void *host_data)
cc79ca69 46{
a8db8cf0 47 struct irq_domain *domain;
cc79ca69 48
5ca4db61
PM
49 domain = kzalloc_node(sizeof(*domain), GFP_KERNEL,
50 of_node_to_nid(of_node));
a8db8cf0 51 if (WARN_ON(!domain))
cc79ca69
GL
52 return NULL;
53
54 /* Fill structure */
68700650 55 domain->revmap_type = revmap_type;
68700650 56 domain->ops = ops;
a8db8cf0 57 domain->host_data = host_data;
68700650 58 domain->of_node = of_node_get(of_node);
cc79ca69 59
a8db8cf0
GL
60 return domain;
61}
62
58ee99ad
PM
63static void irq_domain_free(struct irq_domain *domain)
64{
65 of_node_put(domain->of_node);
66 kfree(domain);
67}
68
a8db8cf0
GL
69static void irq_domain_add(struct irq_domain *domain)
70{
71 mutex_lock(&irq_domain_mutex);
72 list_add(&domain->link, &irq_domain_list);
73 mutex_unlock(&irq_domain_mutex);
54a90588 74 pr_debug("Allocated domain of type %d @0x%p\n",
a8db8cf0
GL
75 domain->revmap_type, domain);
76}
77
58ee99ad
PM
78/**
79 * irq_domain_remove() - Remove an irq domain.
80 * @domain: domain to remove
81 *
82 * This routine is used to remove an irq domain. The caller must ensure
83 * that all mappings within the domain have been disposed of prior to
84 * use, depending on the revmap type.
85 */
86void irq_domain_remove(struct irq_domain *domain)
87{
88 mutex_lock(&irq_domain_mutex);
89
90 switch (domain->revmap_type) {
91 case IRQ_DOMAIN_MAP_LEGACY:
92 /*
93 * Legacy domains don't manage their own irq_desc
94 * allocations, we expect the caller to handle irq_desc
95 * freeing on their own.
96 */
97 break;
98 case IRQ_DOMAIN_MAP_TREE:
99 /*
100 * radix_tree_delete() takes care of destroying the root
101 * node when all entries are removed. Shout if there are
102 * any mappings left.
103 */
104 WARN_ON(domain->revmap_data.tree.height);
105 break;
106 case IRQ_DOMAIN_MAP_LINEAR:
107 kfree(domain->revmap_data.linear.revmap);
108 domain->revmap_data.linear.size = 0;
109 break;
110 case IRQ_DOMAIN_MAP_NOMAP:
111 break;
112 }
113
114 list_del(&domain->link);
115
116 /*
117 * If the going away domain is the default one, reset it.
118 */
119 if (unlikely(irq_default_domain == domain))
120 irq_set_default_host(NULL);
121
122 mutex_unlock(&irq_domain_mutex);
123
54a90588 124 pr_debug("Removed domain of type %d @0x%p\n",
58ee99ad
PM
125 domain->revmap_type, domain);
126
127 irq_domain_free(domain);
128}
ecd84eb2 129EXPORT_SYMBOL_GPL(irq_domain_remove);
58ee99ad 130
1bc04f2c
GL
131static unsigned int irq_domain_legacy_revmap(struct irq_domain *domain,
132 irq_hw_number_t hwirq)
133{
134 irq_hw_number_t first_hwirq = domain->revmap_data.legacy.first_hwirq;
135 int size = domain->revmap_data.legacy.size;
136
137 if (WARN_ON(hwirq < first_hwirq || hwirq >= first_hwirq + size))
138 return 0;
139 return hwirq - first_hwirq + domain->revmap_data.legacy.first_irq;
140}
141
781d0f46
MB
142/**
143 * irq_domain_add_simple() - Allocate and register a simple irq_domain.
144 * @of_node: pointer to interrupt controller's device tree node.
145 * @size: total number of irqs in mapping
146 * @first_irq: first number of irq block assigned to the domain
147 * @ops: map/unmap domain callbacks
148 * @host_data: Controller private data pointer
149 *
150 * Allocates a legacy irq_domain if irq_base is positive or a linear
151 * domain otherwise.
152 *
153 * This is intended to implement the expected behaviour for most
154 * interrupt controllers which is that a linear mapping should
155 * normally be used unless the system requires a legacy mapping in
156 * order to support supplying interrupt numbers during non-DT
157 * registration of devices.
158 */
159struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
160 unsigned int size,
161 unsigned int first_irq,
162 const struct irq_domain_ops *ops,
163 void *host_data)
164{
165 if (first_irq > 0)
166 return irq_domain_add_legacy(of_node, size, first_irq, 0,
167 ops, host_data);
168 else
169 return irq_domain_add_linear(of_node, size, ops, host_data);
170}
171
a8db8cf0
GL
172/**
173 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
174 * @of_node: pointer to interrupt controller's device tree node.
1bc04f2c
GL
175 * @size: total number of irqs in legacy mapping
176 * @first_irq: first number of irq block assigned to the domain
177 * @first_hwirq: first hwirq number to use for the translation. Should normally
178 * be '0', but a positive integer can be used if the effective
179 * hwirqs numbering does not begin at zero.
a8db8cf0
GL
180 * @ops: map/unmap domain callbacks
181 * @host_data: Controller private data pointer
182 *
183 * Note: the map() callback will be called before this function returns
184 * for all legacy interrupts except 0 (which is always the invalid irq for
185 * a legacy controller).
186 */
187struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
1bc04f2c
GL
188 unsigned int size,
189 unsigned int first_irq,
190 irq_hw_number_t first_hwirq,
a18dc81b 191 const struct irq_domain_ops *ops,
a8db8cf0
GL
192 void *host_data)
193{
1bc04f2c 194 struct irq_domain *domain;
a8db8cf0
GL
195 unsigned int i;
196
197 domain = irq_domain_alloc(of_node, IRQ_DOMAIN_MAP_LEGACY, ops, host_data);
198 if (!domain)
199 return NULL;
200
1bc04f2c
GL
201 domain->revmap_data.legacy.first_irq = first_irq;
202 domain->revmap_data.legacy.first_hwirq = first_hwirq;
203 domain->revmap_data.legacy.size = size;
204
cc79ca69 205 mutex_lock(&irq_domain_mutex);
1bc04f2c
GL
206 /* Verify that all the irqs are available */
207 for (i = 0; i < size; i++) {
208 int irq = first_irq + i;
209 struct irq_data *irq_data = irq_get_irq_data(irq);
210
211 if (WARN_ON(!irq_data || irq_data->domain)) {
a8db8cf0 212 mutex_unlock(&irq_domain_mutex);
58ee99ad 213 irq_domain_free(domain);
a8db8cf0 214 return NULL;
cc79ca69
GL
215 }
216 }
cc79ca69 217
1bc04f2c
GL
218 /* Claim all of the irqs before registering a legacy domain */
219 for (i = 0; i < size; i++) {
220 struct irq_data *irq_data = irq_get_irq_data(first_irq + i);
221 irq_data->hwirq = first_hwirq + i;
a8db8cf0 222 irq_data->domain = domain;
1bc04f2c
GL
223 }
224 mutex_unlock(&irq_domain_mutex);
225
226 for (i = 0; i < size; i++) {
227 int irq = first_irq + i;
228 int hwirq = first_hwirq + i;
229
230 /* IRQ0 gets ignored */
231 if (!irq)
232 continue;
a8db8cf0
GL
233
234 /* Legacy flags are left to default at this point,
235 * one can then use irq_create_mapping() to
236 * explicitly change them
237 */
aed98048
GL
238 if (ops->map)
239 ops->map(domain, irq, hwirq);
a8db8cf0
GL
240
241 /* Clear norequest flags */
1bc04f2c 242 irq_clear_status_flags(irq, IRQ_NOREQUEST);
cc79ca69 243 }
1bc04f2c
GL
244
245 irq_domain_add(domain);
a8db8cf0
GL
246 return domain;
247}
ecd84eb2 248EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
a8db8cf0
GL
249
250/**
22076c77 251 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
a8db8cf0 252 * @of_node: pointer to interrupt controller's device tree node.
a87487e6 253 * @size: Number of interrupts in the domain.
a8db8cf0
GL
254 * @ops: map/unmap domain callbacks
255 * @host_data: Controller private data pointer
256 */
257struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
258 unsigned int size,
a18dc81b 259 const struct irq_domain_ops *ops,
a8db8cf0
GL
260 void *host_data)
261{
262 struct irq_domain *domain;
263 unsigned int *revmap;
cc79ca69 264
5ca4db61
PM
265 revmap = kzalloc_node(sizeof(*revmap) * size, GFP_KERNEL,
266 of_node_to_nid(of_node));
a8db8cf0
GL
267 if (WARN_ON(!revmap))
268 return NULL;
cc79ca69 269
a8db8cf0
GL
270 domain = irq_domain_alloc(of_node, IRQ_DOMAIN_MAP_LINEAR, ops, host_data);
271 if (!domain) {
272 kfree(revmap);
273 return NULL;
274 }
275 domain->revmap_data.linear.size = size;
276 domain->revmap_data.linear.revmap = revmap;
277 irq_domain_add(domain);
278 return domain;
279}
ecd84eb2 280EXPORT_SYMBOL_GPL(irq_domain_add_linear);
a8db8cf0
GL
281
282struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
6fa6c8e2 283 unsigned int max_irq,
a18dc81b 284 const struct irq_domain_ops *ops,
a8db8cf0
GL
285 void *host_data)
286{
287 struct irq_domain *domain = irq_domain_alloc(of_node,
288 IRQ_DOMAIN_MAP_NOMAP, ops, host_data);
6fa6c8e2
GL
289 if (domain) {
290 domain->revmap_data.nomap.max_irq = max_irq ? max_irq : ~0;
a8db8cf0 291 irq_domain_add(domain);
6fa6c8e2 292 }
a8db8cf0
GL
293 return domain;
294}
ecd84eb2 295EXPORT_SYMBOL_GPL(irq_domain_add_nomap);
a8db8cf0
GL
296
297/**
298 * irq_domain_add_tree()
299 * @of_node: pointer to interrupt controller's device tree node.
300 * @ops: map/unmap domain callbacks
301 *
302 * Note: The radix tree will be allocated later during boot automatically
303 * (the reverse mapping will use the slow path until that happens).
304 */
305struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
a18dc81b 306 const struct irq_domain_ops *ops,
a8db8cf0
GL
307 void *host_data)
308{
309 struct irq_domain *domain = irq_domain_alloc(of_node,
310 IRQ_DOMAIN_MAP_TREE, ops, host_data);
311 if (domain) {
312 INIT_RADIX_TREE(&domain->revmap_data.tree, GFP_KERNEL);
313 irq_domain_add(domain);
314 }
68700650 315 return domain;
cc79ca69 316}
ecd84eb2 317EXPORT_SYMBOL_GPL(irq_domain_add_tree);
cc79ca69
GL
318
319/**
320 * irq_find_host() - Locates a domain for a given device node
321 * @node: device-tree node of the interrupt controller
322 */
323struct irq_domain *irq_find_host(struct device_node *node)
324{
325 struct irq_domain *h, *found = NULL;
a18dc81b 326 int rc;
cc79ca69
GL
327
328 /* We might want to match the legacy controller last since
329 * it might potentially be set to match all interrupts in
330 * the absence of a device node. This isn't a problem so far
331 * yet though...
332 */
333 mutex_lock(&irq_domain_mutex);
a18dc81b
GL
334 list_for_each_entry(h, &irq_domain_list, link) {
335 if (h->ops->match)
336 rc = h->ops->match(h, node);
337 else
338 rc = (h->of_node != NULL) && (h->of_node == node);
339
340 if (rc) {
cc79ca69
GL
341 found = h;
342 break;
343 }
a18dc81b 344 }
cc79ca69
GL
345 mutex_unlock(&irq_domain_mutex);
346 return found;
347}
348EXPORT_SYMBOL_GPL(irq_find_host);
349
350/**
351 * irq_set_default_host() - Set a "default" irq domain
68700650 352 * @domain: default domain pointer
cc79ca69
GL
353 *
354 * For convenience, it's possible to set a "default" domain that will be used
355 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
356 * platforms that want to manipulate a few hard coded interrupt numbers that
357 * aren't properly represented in the device-tree.
358 */
68700650 359void irq_set_default_host(struct irq_domain *domain)
cc79ca69 360{
54a90588 361 pr_debug("Default domain set to @0x%p\n", domain);
cc79ca69 362
68700650 363 irq_default_domain = domain;
cc79ca69 364}
ecd84eb2 365EXPORT_SYMBOL_GPL(irq_set_default_host);
cc79ca69 366
913af207
GL
367static void irq_domain_disassociate_many(struct irq_domain *domain,
368 unsigned int irq_base, int count)
369{
370 /*
371 * disassociate in reverse order;
372 * not strictly necessary, but nice for unwinding
373 */
374 while (count--) {
375 int irq = irq_base + count;
376 struct irq_data *irq_data = irq_get_irq_data(irq);
377 irq_hw_number_t hwirq = irq_data->hwirq;
378
379 if (WARN_ON(!irq_data || irq_data->domain != domain))
380 continue;
381
382 irq_set_status_flags(irq, IRQ_NOREQUEST);
383
384 /* remove chip and handler */
385 irq_set_chip_and_handler(irq, NULL, NULL);
386
387 /* Make sure it's completed */
388 synchronize_irq(irq);
389
390 /* Tell the PIC about it */
391 if (domain->ops->unmap)
392 domain->ops->unmap(domain, irq);
393 smp_mb();
394
395 irq_data->domain = NULL;
396 irq_data->hwirq = 0;
397
398 /* Clear reverse map */
399 switch(domain->revmap_type) {
400 case IRQ_DOMAIN_MAP_LINEAR:
401 if (hwirq < domain->revmap_data.linear.size)
402 domain->revmap_data.linear.revmap[hwirq] = 0;
403 break;
404 case IRQ_DOMAIN_MAP_TREE:
405 mutex_lock(&revmap_trees_mutex);
406 radix_tree_delete(&domain->revmap_data.tree, hwirq);
407 mutex_unlock(&revmap_trees_mutex);
408 break;
409 }
410 }
411}
412
98aa468e
GL
413int irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
414 irq_hw_number_t hwirq_base, int count)
cc79ca69 415{
98aa468e
GL
416 unsigned int virq = irq_base;
417 irq_hw_number_t hwirq = hwirq_base;
418 int i;
cc79ca69 419
98aa468e
GL
420 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
421 of_node_full_name(domain->of_node), irq_base, (int)hwirq_base, count);
cc79ca69 422
98aa468e
GL
423 for (i = 0; i < count; i++) {
424 struct irq_data *irq_data = irq_get_irq_data(virq + i);
425
426 if (WARN(!irq_data, "error: irq_desc not allocated; "
427 "irq=%i hwirq=0x%x\n", virq + i, (int)hwirq + i))
428 return -EINVAL;
429 if (WARN(irq_data->domain, "error: irq_desc already associated; "
430 "irq=%i hwirq=0x%x\n", virq + i, (int)hwirq + i))
431 return -EINVAL;
432 };
433
434 for (i = 0; i < count; i++, virq++, hwirq++) {
435 struct irq_data *irq_data = irq_get_irq_data(virq);
436
437 irq_data->hwirq = hwirq;
438 irq_data->domain = domain;
439 if (domain->ops->map && domain->ops->map(domain, virq, hwirq)) {
440 pr_err("irq-%i==>hwirq-0x%lx mapping failed\n", virq, hwirq);
441 irq_data->domain = NULL;
442 irq_data->hwirq = 0;
443 goto err_unmap;
444 }
445
446 switch (domain->revmap_type) {
447 case IRQ_DOMAIN_MAP_LINEAR:
448 if (hwirq < domain->revmap_data.linear.size)
449 domain->revmap_data.linear.revmap[hwirq] = virq;
450 break;
451 case IRQ_DOMAIN_MAP_TREE:
452 mutex_lock(&revmap_trees_mutex);
d6b0d1f7 453 radix_tree_insert(&domain->revmap_data.tree, hwirq, irq_data);
98aa468e
GL
454 mutex_unlock(&revmap_trees_mutex);
455 break;
456 }
2a71a1a9 457
98aa468e
GL
458 irq_clear_status_flags(virq, IRQ_NOREQUEST);
459 }
cc79ca69
GL
460
461 return 0;
98aa468e
GL
462
463 err_unmap:
464 irq_domain_disassociate_many(domain, irq_base, i);
465 return -EINVAL;
cc79ca69 466}
98aa468e 467EXPORT_SYMBOL_GPL(irq_domain_associate_many);
cc79ca69
GL
468
469/**
470 * irq_create_direct_mapping() - Allocate an irq for direct mapping
68700650 471 * @domain: domain to allocate the irq for or NULL for default domain
cc79ca69
GL
472 *
473 * This routine is used for irq controllers which can choose the hardware
474 * interrupt numbers they generate. In such a case it's simplest to use
475 * the linux irq as the hardware interrupt number.
476 */
68700650 477unsigned int irq_create_direct_mapping(struct irq_domain *domain)
cc79ca69
GL
478{
479 unsigned int virq;
480
68700650
GL
481 if (domain == NULL)
482 domain = irq_default_domain;
cc79ca69 483
9844a552
GL
484 if (WARN_ON(!domain || domain->revmap_type != IRQ_DOMAIN_MAP_NOMAP))
485 return 0;
cc79ca69 486
5ca4db61 487 virq = irq_alloc_desc_from(1, of_node_to_nid(domain->of_node));
03848373 488 if (!virq) {
54a90588 489 pr_debug("create_direct virq allocation failed\n");
03848373 490 return 0;
cc79ca69 491 }
6fa6c8e2 492 if (virq >= domain->revmap_data.nomap.max_irq) {
cc79ca69 493 pr_err("ERROR: no free irqs available below %i maximum\n",
6fa6c8e2 494 domain->revmap_data.nomap.max_irq);
cc79ca69
GL
495 irq_free_desc(virq);
496 return 0;
497 }
54a90588 498 pr_debug("create_direct obtained virq %d\n", virq);
cc79ca69 499
98aa468e 500 if (irq_domain_associate(domain, virq, virq)) {
cc79ca69 501 irq_free_desc(virq);
03848373 502 return 0;
cc79ca69
GL
503 }
504
505 return virq;
506}
ecd84eb2 507EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
cc79ca69
GL
508
509/**
510 * irq_create_mapping() - Map a hardware interrupt into linux irq space
68700650
GL
511 * @domain: domain owning this hardware interrupt or NULL for default domain
512 * @hwirq: hardware irq number in that domain space
cc79ca69
GL
513 *
514 * Only one mapping per hardware interrupt is permitted. Returns a linux
515 * irq number.
516 * If the sense/trigger is to be specified, set_irq_type() should be called
517 * on the number returned from that call.
518 */
68700650 519unsigned int irq_create_mapping(struct irq_domain *domain,
cc79ca69
GL
520 irq_hw_number_t hwirq)
521{
5b7526e3
DD
522 unsigned int hint;
523 int virq;
cc79ca69 524
54a90588 525 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
cc79ca69 526
68700650
GL
527 /* Look for default domain if nececssary */
528 if (domain == NULL)
529 domain = irq_default_domain;
530 if (domain == NULL) {
54a90588
PM
531 pr_warning("irq_create_mapping called for"
532 " NULL domain, hwirq=%lx\n", hwirq);
cc79ca69 533 WARN_ON(1);
03848373 534 return 0;
cc79ca69 535 }
54a90588 536 pr_debug("-> using domain @%p\n", domain);
cc79ca69
GL
537
538 /* Check if mapping already exists */
68700650 539 virq = irq_find_mapping(domain, hwirq);
03848373 540 if (virq) {
54a90588 541 pr_debug("-> existing mapping on virq %d\n", virq);
cc79ca69
GL
542 return virq;
543 }
544
545 /* Get a virtual interrupt number */
1bc04f2c
GL
546 if (domain->revmap_type == IRQ_DOMAIN_MAP_LEGACY)
547 return irq_domain_legacy_revmap(domain, hwirq);
548
549 /* Allocate a virtual interrupt number */
6fa6c8e2 550 hint = hwirq % nr_irqs;
1bc04f2c
GL
551 if (hint == 0)
552 hint++;
5ca4db61 553 virq = irq_alloc_desc_from(hint, of_node_to_nid(domain->of_node));
5b7526e3 554 if (virq <= 0)
5ca4db61 555 virq = irq_alloc_desc_from(1, of_node_to_nid(domain->of_node));
5b7526e3 556 if (virq <= 0) {
54a90588 557 pr_debug("-> virq allocation failed\n");
1bc04f2c 558 return 0;
cc79ca69
GL
559 }
560
98aa468e 561 if (irq_domain_associate(domain, virq, hwirq)) {
73255704 562 irq_free_desc(virq);
03848373 563 return 0;
cc79ca69
GL
564 }
565
54a90588 566 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
efd68e72 567 hwirq, of_node_full_name(domain->of_node), virq);
cc79ca69
GL
568
569 return virq;
570}
571EXPORT_SYMBOL_GPL(irq_create_mapping);
572
98aa468e
GL
573/**
574 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
575 * @domain: domain owning the interrupt range
576 * @irq_base: beginning of linux IRQ range
577 * @hwirq_base: beginning of hardware IRQ range
578 * @count: Number of interrupts to map
579 *
580 * This routine is used for allocating and mapping a range of hardware
581 * irqs to linux irqs where the linux irq numbers are at pre-defined
582 * locations. For use by controllers that already have static mappings
583 * to insert in to the domain.
584 *
585 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
586 * domain insertion.
587 *
588 * 0 is returned upon success, while any failure to establish a static
589 * mapping is treated as an error.
590 */
591int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
592 irq_hw_number_t hwirq_base, int count)
593{
594 int ret;
595
596 ret = irq_alloc_descs(irq_base, irq_base, count,
597 of_node_to_nid(domain->of_node));
598 if (unlikely(ret < 0))
599 return ret;
600
601 ret = irq_domain_associate_many(domain, irq_base, hwirq_base, count);
602 if (unlikely(ret < 0)) {
603 irq_free_descs(irq_base, count);
604 return ret;
605 }
606
607 return 0;
608}
609EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
610
cc79ca69
GL
611unsigned int irq_create_of_mapping(struct device_node *controller,
612 const u32 *intspec, unsigned int intsize)
613{
68700650 614 struct irq_domain *domain;
cc79ca69
GL
615 irq_hw_number_t hwirq;
616 unsigned int type = IRQ_TYPE_NONE;
617 unsigned int virq;
618
68700650
GL
619 domain = controller ? irq_find_host(controller) : irq_default_domain;
620 if (!domain) {
abd2363f
GL
621#ifdef CONFIG_MIPS
622 /*
623 * Workaround to avoid breaking interrupt controller drivers
624 * that don't yet register an irq_domain. This is temporary
625 * code. ~~~gcl, Feb 24, 2012
626 *
627 * Scheduled for removal in Linux v3.6. That should be enough
628 * time.
629 */
630 if (intsize > 0)
631 return intspec[0];
632#endif
54a90588 633 pr_warning("no irq domain found for %s !\n",
efd68e72 634 of_node_full_name(controller));
03848373 635 return 0;
cc79ca69
GL
636 }
637
68700650
GL
638 /* If domain has no translation, then we assume interrupt line */
639 if (domain->ops->xlate == NULL)
cc79ca69
GL
640 hwirq = intspec[0];
641 else {
68700650 642 if (domain->ops->xlate(domain, controller, intspec, intsize,
cc79ca69 643 &hwirq, &type))
03848373 644 return 0;
cc79ca69
GL
645 }
646
647 /* Create mapping */
68700650 648 virq = irq_create_mapping(domain, hwirq);
03848373 649 if (!virq)
cc79ca69
GL
650 return virq;
651
652 /* Set type if specified and different than the current one */
653 if (type != IRQ_TYPE_NONE &&
654 type != (irqd_get_trigger_type(irq_get_irq_data(virq))))
655 irq_set_irq_type(virq, type);
656 return virq;
657}
658EXPORT_SYMBOL_GPL(irq_create_of_mapping);
659
660/**
661 * irq_dispose_mapping() - Unmap an interrupt
662 * @virq: linux irq number of the interrupt to unmap
663 */
664void irq_dispose_mapping(unsigned int virq)
665{
666 struct irq_data *irq_data = irq_get_irq_data(virq);
68700650 667 struct irq_domain *domain;
cc79ca69 668
03848373 669 if (!virq || !irq_data)
cc79ca69
GL
670 return;
671
68700650
GL
672 domain = irq_data->domain;
673 if (WARN_ON(domain == NULL))
cc79ca69
GL
674 return;
675
676 /* Never unmap legacy interrupts */
68700650 677 if (domain->revmap_type == IRQ_DOMAIN_MAP_LEGACY)
cc79ca69
GL
678 return;
679
913af207 680 irq_domain_disassociate_many(domain, virq, 1);
cc79ca69
GL
681 irq_free_desc(virq);
682}
683EXPORT_SYMBOL_GPL(irq_dispose_mapping);
684
685/**
686 * irq_find_mapping() - Find a linux irq from an hw irq number.
68700650
GL
687 * @domain: domain owning this hardware interrupt
688 * @hwirq: hardware irq number in that domain space
cc79ca69 689 */
68700650 690unsigned int irq_find_mapping(struct irq_domain *domain,
cc79ca69
GL
691 irq_hw_number_t hwirq)
692{
4c0946c4 693 struct irq_data *data;
cc79ca69 694
68700650
GL
695 /* Look for default domain if nececssary */
696 if (domain == NULL)
697 domain = irq_default_domain;
698 if (domain == NULL)
03848373 699 return 0;
cc79ca69 700
4c0946c4
GL
701 switch (domain->revmap_type) {
702 case IRQ_DOMAIN_MAP_LEGACY:
1bc04f2c 703 return irq_domain_legacy_revmap(domain, hwirq);
4c0946c4
GL
704 case IRQ_DOMAIN_MAP_LINEAR:
705 return irq_linear_revmap(domain, hwirq);
706 case IRQ_DOMAIN_MAP_TREE:
707 rcu_read_lock();
708 data = radix_tree_lookup(&domain->revmap_data.tree, hwirq);
709 rcu_read_unlock();
710 if (data)
711 return data->irq;
712 break;
713 case IRQ_DOMAIN_MAP_NOMAP:
714 data = irq_get_irq_data(hwirq);
68700650 715 if (data && (data->domain == domain) && (data->hwirq == hwirq))
4c0946c4
GL
716 return hwirq;
717 break;
718 }
719
03848373 720 return 0;
cc79ca69
GL
721}
722EXPORT_SYMBOL_GPL(irq_find_mapping);
723
cc79ca69
GL
724/**
725 * irq_linear_revmap() - Find a linux irq from a hw irq number.
68700650
GL
726 * @domain: domain owning this hardware interrupt
727 * @hwirq: hardware irq number in that domain space
cc79ca69 728 *
4c0946c4
GL
729 * This is a fast path that can be called directly by irq controller code to
730 * save a handful of instructions.
cc79ca69 731 */
68700650 732unsigned int irq_linear_revmap(struct irq_domain *domain,
cc79ca69
GL
733 irq_hw_number_t hwirq)
734{
4c0946c4 735 BUG_ON(domain->revmap_type != IRQ_DOMAIN_MAP_LINEAR);
cc79ca69 736
4c0946c4
GL
737 /* Check revmap bounds; complain if exceeded */
738 if (WARN_ON(hwirq >= domain->revmap_data.linear.size))
739 return 0;
cc79ca69 740
4c0946c4 741 return domain->revmap_data.linear.revmap[hwirq];
cc79ca69 742}
ecd84eb2 743EXPORT_SYMBOL_GPL(irq_linear_revmap);
cc79ca69 744
092b2fb0 745#ifdef CONFIG_IRQ_DOMAIN_DEBUG
cc79ca69
GL
746static int virq_debug_show(struct seq_file *m, void *private)
747{
748 unsigned long flags;
749 struct irq_desc *desc;
750 const char *p;
751 static const char none[] = "none";
752 void *data;
753 int i;
754
15e06bf6 755 seq_printf(m, "%-5s %-7s %-15s %-*s %s\n", "irq", "hwirq",
5269a9ab
GL
756 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
757 "domain name");
cc79ca69
GL
758
759 for (i = 1; i < nr_irqs; i++) {
760 desc = irq_to_desc(i);
761 if (!desc)
762 continue;
763
764 raw_spin_lock_irqsave(&desc->lock, flags);
765
766 if (desc->action && desc->action->handler) {
767 struct irq_chip *chip;
768
769 seq_printf(m, "%5d ", i);
770 seq_printf(m, "0x%05lx ", desc->irq_data.hwirq);
771
772 chip = irq_desc_get_chip(desc);
773 if (chip && chip->name)
774 p = chip->name;
775 else
776 p = none;
777 seq_printf(m, "%-15s ", p);
778
779 data = irq_desc_get_chip_data(desc);
15e06bf6 780 seq_printf(m, data ? "0x%p " : " %p ", data);
cc79ca69 781
efd68e72
GL
782 if (desc->irq_data.domain)
783 p = of_node_full_name(desc->irq_data.domain->of_node);
cc79ca69
GL
784 else
785 p = none;
786 seq_printf(m, "%s\n", p);
787 }
788
789 raw_spin_unlock_irqrestore(&desc->lock, flags);
790 }
791
792 return 0;
793}
794
795static int virq_debug_open(struct inode *inode, struct file *file)
796{
797 return single_open(file, virq_debug_show, inode->i_private);
798}
799
800static const struct file_operations virq_debug_fops = {
801 .open = virq_debug_open,
802 .read = seq_read,
803 .llseek = seq_lseek,
804 .release = single_release,
805};
806
807static int __init irq_debugfs_init(void)
808{
092b2fb0 809 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
cc79ca69
GL
810 NULL, &virq_debug_fops) == NULL)
811 return -ENOMEM;
812
813 return 0;
814}
815__initcall(irq_debugfs_init);
092b2fb0 816#endif /* CONFIG_IRQ_DOMAIN_DEBUG */
cc79ca69 817
16b2e6e2
GL
818/**
819 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
820 *
821 * Device Tree IRQ specifier translation function which works with one cell
822 * bindings where the cell value maps directly to the hwirq number.
823 */
824int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
825 const u32 *intspec, unsigned int intsize,
826 unsigned long *out_hwirq, unsigned int *out_type)
7e713301 827{
16b2e6e2 828 if (WARN_ON(intsize < 1))
7e713301 829 return -EINVAL;
7e713301
GL
830 *out_hwirq = intspec[0];
831 *out_type = IRQ_TYPE_NONE;
7e713301
GL
832 return 0;
833}
16b2e6e2
GL
834EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
835
836/**
837 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
838 *
839 * Device Tree IRQ specifier translation function which works with two cell
840 * bindings where the cell values map directly to the hwirq number
841 * and linux irq flags.
842 */
843int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
844 const u32 *intspec, unsigned int intsize,
845 irq_hw_number_t *out_hwirq, unsigned int *out_type)
846{
847 if (WARN_ON(intsize < 2))
848 return -EINVAL;
849 *out_hwirq = intspec[0];
850 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
851 return 0;
852}
853EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
854
855/**
856 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
857 *
858 * Device Tree IRQ specifier translation function which works with either one
859 * or two cell bindings where the cell values map directly to the hwirq number
860 * and linux irq flags.
861 *
862 * Note: don't use this function unless your interrupt controller explicitly
863 * supports both one and two cell bindings. For the majority of controllers
864 * the _onecell() or _twocell() variants above should be used.
865 */
866int irq_domain_xlate_onetwocell(struct irq_domain *d,
867 struct device_node *ctrlr,
868 const u32 *intspec, unsigned int intsize,
869 unsigned long *out_hwirq, unsigned int *out_type)
870{
871 if (WARN_ON(intsize < 1))
872 return -EINVAL;
873 *out_hwirq = intspec[0];
874 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
875 return 0;
876}
877EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
7e713301 878
a18dc81b 879const struct irq_domain_ops irq_domain_simple_ops = {
16b2e6e2 880 .xlate = irq_domain_xlate_onetwocell,
75294957
GL
881};
882EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
883
884#ifdef CONFIG_OF_IRQ
7e713301
GL
885void irq_domain_generate_simple(const struct of_device_id *match,
886 u64 phys_base, unsigned int irq_start)
887{
888 struct device_node *node;
e1964c50 889 pr_debug("looking for phys_base=%llx, irq_start=%i\n",
7e713301
GL
890 (unsigned long long) phys_base, (int) irq_start);
891 node = of_find_matching_node_by_address(NULL, match, phys_base);
892 if (node)
6b783f7c
GL
893 irq_domain_add_legacy(node, 32, irq_start, 0,
894 &irq_domain_simple_ops, NULL);
7e713301
GL
895}
896EXPORT_SYMBOL_GPL(irq_domain_generate_simple);
75294957 897#endif