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