1 // SPDX-License-Identifier: GPL-2.0
3 * Texas Instruments' K3 Interrupt Aggregator irqchip driver
5 * Copyright (C) 2018-2019 Texas Instruments Incorporated - https://www.ti.com/
6 * Lokesh Vutla <lokeshvutla@ti.com>
11 #include <linux/irq.h>
12 #include <linux/irqchip.h>
13 #include <linux/irqdomain.h>
14 #include <linux/interrupt.h>
15 #include <linux/msi.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/of_address.h>
19 #include <linux/of_irq.h>
20 #include <linux/of_platform.h>
21 #include <linux/irqchip/chained_irq.h>
22 #include <linux/soc/ti/ti_sci_inta_msi.h>
23 #include <linux/soc/ti/ti_sci_protocol.h>
24 #include <asm-generic/msi.h>
26 #define TI_SCI_DEV_ID_MASK 0xffff
27 #define TI_SCI_DEV_ID_SHIFT 16
28 #define TI_SCI_IRQ_ID_MASK 0xffff
29 #define TI_SCI_IRQ_ID_SHIFT 0
30 #define HWIRQ_TO_DEVID(hwirq) (((hwirq) >> (TI_SCI_DEV_ID_SHIFT)) & \
32 #define HWIRQ_TO_IRQID(hwirq) ((hwirq) & (TI_SCI_IRQ_ID_MASK))
33 #define TO_HWIRQ(dev, index) ((((dev) & TI_SCI_DEV_ID_MASK) << \
34 TI_SCI_DEV_ID_SHIFT) | \
35 ((index) & TI_SCI_IRQ_ID_MASK))
37 #define MAX_EVENTS_PER_VINT 64
38 #define VINT_ENABLE_SET_OFFSET 0x0
39 #define VINT_ENABLE_CLR_OFFSET 0x8
40 #define VINT_STATUS_OFFSET 0x18
41 #define VINT_STATUS_MASKED_OFFSET 0x20
44 * struct ti_sci_inta_event_desc - Description of an event coming to
45 * Interrupt Aggregator. This serves
46 * as a mapping table for global event,
48 * @global_event: Global event number corresponding to this event
49 * @hwirq: Hwirq of the incoming interrupt
50 * @vint_bit: Corresponding vint bit to which this event is attached.
52 struct ti_sci_inta_event_desc {
59 * struct ti_sci_inta_vint_desc - Description of a virtual interrupt coming out
60 * of Interrupt Aggregator.
61 * @domain: Pointer to IRQ domain to which this vint belongs.
62 * @list: List entry for the vint list
63 * @event_map: Bitmap to manage the allocation of events to vint.
64 * @events: Array of event descriptors assigned to this vint.
65 * @parent_virq: Linux IRQ number that gets attached to parent
66 * @vint_id: TISCI vint ID
68 struct ti_sci_inta_vint_desc {
69 struct irq_domain *domain;
70 struct list_head list;
71 DECLARE_BITMAP(event_map, MAX_EVENTS_PER_VINT);
72 struct ti_sci_inta_event_desc events[MAX_EVENTS_PER_VINT];
73 unsigned int parent_virq;
78 * struct ti_sci_inta_irq_domain - Structure representing a TISCI based
79 * Interrupt Aggregator IRQ domain.
80 * @sci: Pointer to TISCI handle
81 * @vint: TISCI resource pointer representing IA inerrupts.
82 * @global_event: TISCI resource pointer representing global events.
83 * @vint_list: List of the vints active in the system
84 * @vint_mutex: Mutex to protect vint_list
85 * @base: Base address of the memory mapped IO registers
86 * @pdev: Pointer to platform device.
87 * @ti_sci_id: TI-SCI device identifier
89 struct ti_sci_inta_irq_domain {
90 const struct ti_sci_handle *sci;
91 struct ti_sci_resource *vint;
92 struct ti_sci_resource *global_event;
93 struct list_head vint_list;
94 /* Mutex to protect vint list */
95 struct mutex vint_mutex;
97 struct platform_device *pdev;
101 #define to_vint_desc(e, i) container_of(e, struct ti_sci_inta_vint_desc, \
105 * ti_sci_inta_irq_handler() - Chained IRQ handler for the vint irqs
106 * @desc: Pointer to irq_desc corresponding to the irq
108 static void ti_sci_inta_irq_handler(struct irq_desc *desc)
110 struct ti_sci_inta_vint_desc *vint_desc;
111 struct ti_sci_inta_irq_domain *inta;
112 struct irq_domain *domain;
113 unsigned int virq, bit;
116 vint_desc = irq_desc_get_handler_data(desc);
117 domain = vint_desc->domain;
118 inta = domain->host_data;
120 chained_irq_enter(irq_desc_get_chip(desc), desc);
122 val = readq_relaxed(inta->base + vint_desc->vint_id * 0x1000 +
123 VINT_STATUS_MASKED_OFFSET);
125 for_each_set_bit(bit, &val, MAX_EVENTS_PER_VINT) {
126 virq = irq_find_mapping(domain, vint_desc->events[bit].hwirq);
128 generic_handle_irq(virq);
131 chained_irq_exit(irq_desc_get_chip(desc), desc);
135 * ti_sci_inta_xlate_irq() - Translate hwirq to parent's hwirq.
136 * @inta: IRQ domain corresponding to Interrupt Aggregator
137 * @irq: Hardware irq corresponding to the above irq domain
139 * Return parent irq number if translation is available else -ENOENT.
141 static int ti_sci_inta_xlate_irq(struct ti_sci_inta_irq_domain *inta,
144 struct device_node *np = dev_of_node(&inta->pdev->dev);
145 u32 base, parent_base, size;
149 range = of_get_property(np, "ti,interrupt-ranges", &len);
153 for (len /= sizeof(*range); len >= 3; len -= 3) {
154 base = be32_to_cpu(*range++);
155 parent_base = be32_to_cpu(*range++);
156 size = be32_to_cpu(*range++);
158 if (base <= vint_id && vint_id < base + size)
159 return vint_id - base + parent_base;
166 * ti_sci_inta_alloc_parent_irq() - Allocate parent irq to Interrupt aggregator
167 * @domain: IRQ domain corresponding to Interrupt Aggregator
169 * Return 0 if all went well else corresponding error value.
171 static struct ti_sci_inta_vint_desc *ti_sci_inta_alloc_parent_irq(struct irq_domain *domain)
173 struct ti_sci_inta_irq_domain *inta = domain->host_data;
174 struct ti_sci_inta_vint_desc *vint_desc;
175 struct irq_fwspec parent_fwspec;
176 struct device_node *parent_node;
177 unsigned int parent_virq;
181 vint_id = ti_sci_get_free_resource(inta->vint);
182 if (vint_id == TI_SCI_RESOURCE_NULL)
183 return ERR_PTR(-EINVAL);
185 p_hwirq = ti_sci_inta_xlate_irq(inta, vint_id);
191 vint_desc = kzalloc(sizeof(*vint_desc), GFP_KERNEL);
197 vint_desc->domain = domain;
198 vint_desc->vint_id = vint_id;
199 INIT_LIST_HEAD(&vint_desc->list);
201 parent_node = of_irq_find_parent(dev_of_node(&inta->pdev->dev));
202 parent_fwspec.fwnode = of_node_to_fwnode(parent_node);
204 if (of_device_is_compatible(parent_node, "arm,gic-v3")) {
206 parent_fwspec.param_count = 3;
207 parent_fwspec.param[0] = 0;
208 parent_fwspec.param[1] = p_hwirq - 32;
209 parent_fwspec.param[2] = IRQ_TYPE_LEVEL_HIGH;
211 /* Parent is Interrupt Router */
212 parent_fwspec.param_count = 1;
213 parent_fwspec.param[0] = p_hwirq;
216 parent_virq = irq_create_fwspec_mapping(&parent_fwspec);
217 if (parent_virq == 0) {
218 dev_err(&inta->pdev->dev, "Parent IRQ allocation failed\n");
223 vint_desc->parent_virq = parent_virq;
225 list_add_tail(&vint_desc->list, &inta->vint_list);
226 irq_set_chained_handler_and_data(vint_desc->parent_virq,
227 ti_sci_inta_irq_handler, vint_desc);
233 ti_sci_release_resource(inta->vint, vint_id);
238 * ti_sci_inta_alloc_event() - Attach an event to a IA vint.
239 * @vint_desc: Pointer to vint_desc to which the event gets attached
240 * @free_bit: Bit inside vint to which event gets attached
241 * @hwirq: hwirq of the input event
243 * Return event_desc pointer if all went ok else appropriate error value.
245 static struct ti_sci_inta_event_desc *ti_sci_inta_alloc_event(struct ti_sci_inta_vint_desc *vint_desc,
249 struct ti_sci_inta_irq_domain *inta = vint_desc->domain->host_data;
250 struct ti_sci_inta_event_desc *event_desc;
251 u16 dev_id, dev_index;
254 dev_id = HWIRQ_TO_DEVID(hwirq);
255 dev_index = HWIRQ_TO_IRQID(hwirq);
257 event_desc = &vint_desc->events[free_bit];
258 event_desc->hwirq = hwirq;
259 event_desc->vint_bit = free_bit;
260 event_desc->global_event = ti_sci_get_free_resource(inta->global_event);
261 if (event_desc->global_event == TI_SCI_RESOURCE_NULL)
262 return ERR_PTR(-EINVAL);
264 err = inta->sci->ops.rm_irq_ops.set_event_map(inta->sci,
268 event_desc->global_event,
271 goto free_global_event;
275 ti_sci_release_resource(inta->global_event, event_desc->global_event);
280 * ti_sci_inta_alloc_irq() - Allocate an irq within INTA domain
281 * @domain: irq_domain pointer corresponding to INTA
282 * @hwirq: hwirq of the input event
284 * Note: Allocation happens in the following manner:
285 * - Find a free bit available in any of the vints available in the list.
286 * - If not found, allocate a vint from the vint pool
287 * - Attach the free bit to input hwirq.
288 * Return event_desc if all went ok else appropriate error value.
290 static struct ti_sci_inta_event_desc *ti_sci_inta_alloc_irq(struct irq_domain *domain,
293 struct ti_sci_inta_irq_domain *inta = domain->host_data;
294 struct ti_sci_inta_vint_desc *vint_desc = NULL;
295 struct ti_sci_inta_event_desc *event_desc;
298 mutex_lock(&inta->vint_mutex);
299 list_for_each_entry(vint_desc, &inta->vint_list, list) {
300 free_bit = find_first_zero_bit(vint_desc->event_map,
301 MAX_EVENTS_PER_VINT);
302 if (free_bit != MAX_EVENTS_PER_VINT) {
303 set_bit(free_bit, vint_desc->event_map);
308 /* No free bits available. Allocate a new vint */
309 vint_desc = ti_sci_inta_alloc_parent_irq(domain);
310 if (IS_ERR(vint_desc)) {
311 event_desc = ERR_CAST(vint_desc);
315 free_bit = find_first_zero_bit(vint_desc->event_map,
316 MAX_EVENTS_PER_VINT);
317 set_bit(free_bit, vint_desc->event_map);
320 event_desc = ti_sci_inta_alloc_event(vint_desc, free_bit, hwirq);
321 if (IS_ERR(event_desc))
322 clear_bit(free_bit, vint_desc->event_map);
325 mutex_unlock(&inta->vint_mutex);
330 * ti_sci_inta_free_parent_irq() - Free a parent irq to INTA
331 * @inta: Pointer to inta domain.
332 * @vint_desc: Pointer to vint_desc that needs to be freed.
334 static void ti_sci_inta_free_parent_irq(struct ti_sci_inta_irq_domain *inta,
335 struct ti_sci_inta_vint_desc *vint_desc)
337 if (find_first_bit(vint_desc->event_map, MAX_EVENTS_PER_VINT) == MAX_EVENTS_PER_VINT) {
338 list_del(&vint_desc->list);
339 ti_sci_release_resource(inta->vint, vint_desc->vint_id);
340 irq_dispose_mapping(vint_desc->parent_virq);
346 * ti_sci_inta_free_irq() - Free an IRQ within INTA domain
347 * @event_desc: Pointer to event_desc that needs to be freed.
348 * @hwirq: Hwirq number within INTA domain that needs to be freed
350 static void ti_sci_inta_free_irq(struct ti_sci_inta_event_desc *event_desc,
353 struct ti_sci_inta_vint_desc *vint_desc;
354 struct ti_sci_inta_irq_domain *inta;
356 vint_desc = to_vint_desc(event_desc, event_desc->vint_bit);
357 inta = vint_desc->domain->host_data;
359 mutex_lock(&inta->vint_mutex);
360 inta->sci->ops.rm_irq_ops.free_event_map(inta->sci,
361 HWIRQ_TO_DEVID(hwirq),
362 HWIRQ_TO_IRQID(hwirq),
365 event_desc->global_event,
366 event_desc->vint_bit);
368 clear_bit(event_desc->vint_bit, vint_desc->event_map);
369 ti_sci_release_resource(inta->global_event, event_desc->global_event);
370 event_desc->global_event = TI_SCI_RESOURCE_NULL;
371 event_desc->hwirq = 0;
373 ti_sci_inta_free_parent_irq(inta, vint_desc);
374 mutex_unlock(&inta->vint_mutex);
378 * ti_sci_inta_request_resources() - Allocate resources for input irq
379 * @data: Pointer to corresponding irq_data
381 * Note: This is the core api where the actual allocation happens for input
382 * hwirq. This allocation involves creating a parent irq for vint.
383 * If this is done in irq_domain_ops.alloc() then a deadlock is reached
384 * for allocation. So this allocation is being done in request_resources()
386 * Return: 0 if all went well else corresponding error.
388 static int ti_sci_inta_request_resources(struct irq_data *data)
390 struct ti_sci_inta_event_desc *event_desc;
392 event_desc = ti_sci_inta_alloc_irq(data->domain, data->hwirq);
393 if (IS_ERR(event_desc))
394 return PTR_ERR(event_desc);
396 data->chip_data = event_desc;
402 * ti_sci_inta_release_resources - Release resources for input irq
403 * @data: Pointer to corresponding irq_data
405 * Note: Corresponding to request_resources(), all the unmapping and deletion
406 * of parent vint irqs happens in this api.
408 static void ti_sci_inta_release_resources(struct irq_data *data)
410 struct ti_sci_inta_event_desc *event_desc;
412 event_desc = irq_data_get_irq_chip_data(data);
413 ti_sci_inta_free_irq(event_desc, data->hwirq);
417 * ti_sci_inta_manage_event() - Control the event based on the offset
418 * @data: Pointer to corresponding irq_data
419 * @offset: register offset using which event is controlled.
421 static void ti_sci_inta_manage_event(struct irq_data *data, u32 offset)
423 struct ti_sci_inta_event_desc *event_desc;
424 struct ti_sci_inta_vint_desc *vint_desc;
425 struct ti_sci_inta_irq_domain *inta;
427 event_desc = irq_data_get_irq_chip_data(data);
428 vint_desc = to_vint_desc(event_desc, event_desc->vint_bit);
429 inta = data->domain->host_data;
431 writeq_relaxed(BIT(event_desc->vint_bit),
432 inta->base + vint_desc->vint_id * 0x1000 + offset);
436 * ti_sci_inta_mask_irq() - Mask an event
437 * @data: Pointer to corresponding irq_data
439 static void ti_sci_inta_mask_irq(struct irq_data *data)
441 ti_sci_inta_manage_event(data, VINT_ENABLE_CLR_OFFSET);
445 * ti_sci_inta_unmask_irq() - Unmask an event
446 * @data: Pointer to corresponding irq_data
448 static void ti_sci_inta_unmask_irq(struct irq_data *data)
450 ti_sci_inta_manage_event(data, VINT_ENABLE_SET_OFFSET);
454 * ti_sci_inta_ack_irq() - Ack an event
455 * @data: Pointer to corresponding irq_data
457 static void ti_sci_inta_ack_irq(struct irq_data *data)
460 * Do not clear the event if hardware is capable of sending
463 if (irqd_get_trigger_type(data) != IRQF_TRIGGER_HIGH)
464 ti_sci_inta_manage_event(data, VINT_STATUS_OFFSET);
467 static int ti_sci_inta_set_affinity(struct irq_data *d,
468 const struct cpumask *mask_val, bool force)
474 * ti_sci_inta_set_type() - Update the trigger type of the irq.
475 * @data: Pointer to corresponding irq_data
476 * @type: Trigger type as specified by user
478 * Note: This updates the handle_irq callback for level msi.
480 * Return 0 if all went well else appropriate error.
482 static int ti_sci_inta_set_type(struct irq_data *data, unsigned int type)
485 * .alloc default sets handle_edge_irq. But if the user specifies
486 * that IRQ is level MSI, then update the handle to handle_level_irq
488 switch (type & IRQ_TYPE_SENSE_MASK) {
489 case IRQF_TRIGGER_HIGH:
490 irq_set_handler_locked(data, handle_level_irq);
492 case IRQF_TRIGGER_RISING:
499 static struct irq_chip ti_sci_inta_irq_chip = {
501 .irq_ack = ti_sci_inta_ack_irq,
502 .irq_mask = ti_sci_inta_mask_irq,
503 .irq_set_type = ti_sci_inta_set_type,
504 .irq_unmask = ti_sci_inta_unmask_irq,
505 .irq_set_affinity = ti_sci_inta_set_affinity,
506 .irq_request_resources = ti_sci_inta_request_resources,
507 .irq_release_resources = ti_sci_inta_release_resources,
511 * ti_sci_inta_irq_domain_free() - Free an IRQ from the IRQ domain
512 * @domain: Domain to which the irqs belong
513 * @virq: base linux virtual IRQ to be freed.
514 * @nr_irqs: Number of continuous irqs to be freed
516 static void ti_sci_inta_irq_domain_free(struct irq_domain *domain,
517 unsigned int virq, unsigned int nr_irqs)
519 struct irq_data *data = irq_domain_get_irq_data(domain, virq);
521 irq_domain_reset_irq_data(data);
525 * ti_sci_inta_irq_domain_alloc() - Allocate Interrupt aggregator IRQs
526 * @domain: Point to the interrupt aggregator IRQ domain
527 * @virq: Corresponding Linux virtual IRQ number
528 * @nr_irqs: Continuous irqs to be allocated
529 * @data: Pointer to firmware specifier
531 * No actual allocation happens here.
533 * Return 0 if all went well else appropriate error value.
535 static int ti_sci_inta_irq_domain_alloc(struct irq_domain *domain,
536 unsigned int virq, unsigned int nr_irqs,
539 msi_alloc_info_t *arg = data;
541 irq_domain_set_info(domain, virq, arg->hwirq, &ti_sci_inta_irq_chip,
542 NULL, handle_edge_irq, NULL, NULL);
547 static const struct irq_domain_ops ti_sci_inta_irq_domain_ops = {
548 .free = ti_sci_inta_irq_domain_free,
549 .alloc = ti_sci_inta_irq_domain_alloc,
552 static struct irq_chip ti_sci_inta_msi_irq_chip = {
554 .flags = IRQCHIP_SUPPORTS_LEVEL_MSI,
557 static void ti_sci_inta_msi_set_desc(msi_alloc_info_t *arg,
558 struct msi_desc *desc)
560 struct platform_device *pdev = to_platform_device(desc->dev);
563 arg->hwirq = TO_HWIRQ(pdev->id, desc->inta.dev_index);
566 static struct msi_domain_ops ti_sci_inta_msi_ops = {
567 .set_desc = ti_sci_inta_msi_set_desc,
570 static struct msi_domain_info ti_sci_inta_msi_domain_info = {
571 .flags = (MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
572 MSI_FLAG_LEVEL_CAPABLE),
573 .ops = &ti_sci_inta_msi_ops,
574 .chip = &ti_sci_inta_msi_irq_chip,
577 static int ti_sci_inta_irq_domain_probe(struct platform_device *pdev)
579 struct irq_domain *parent_domain, *domain, *msi_domain;
580 struct device_node *parent_node, *node;
581 struct ti_sci_inta_irq_domain *inta;
582 struct device *dev = &pdev->dev;
583 struct resource *res;
586 node = dev_of_node(dev);
587 parent_node = of_irq_find_parent(node);
589 dev_err(dev, "Failed to get IRQ parent node\n");
593 parent_domain = irq_find_host(parent_node);
595 return -EPROBE_DEFER;
597 inta = devm_kzalloc(dev, sizeof(*inta), GFP_KERNEL);
602 inta->sci = devm_ti_sci_get_by_phandle(dev, "ti,sci");
603 if (IS_ERR(inta->sci))
604 return dev_err_probe(dev, PTR_ERR(inta->sci),
605 "ti,sci read fail\n");
607 ret = of_property_read_u32(dev->of_node, "ti,sci-dev-id", &inta->ti_sci_id);
609 dev_err(dev, "missing 'ti,sci-dev-id' property\n");
613 inta->vint = devm_ti_sci_get_resource(inta->sci, dev, inta->ti_sci_id,
614 TI_SCI_RESASG_SUBTYPE_IA_VINT);
615 if (IS_ERR(inta->vint)) {
616 dev_err(dev, "VINT resource allocation failed\n");
617 return PTR_ERR(inta->vint);
620 inta->global_event = devm_ti_sci_get_resource(inta->sci, dev, inta->ti_sci_id,
621 TI_SCI_RESASG_SUBTYPE_GLOBAL_EVENT_SEVT);
622 if (IS_ERR(inta->global_event)) {
623 dev_err(dev, "Global event resource allocation failed\n");
624 return PTR_ERR(inta->global_event);
627 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
628 inta->base = devm_ioremap_resource(dev, res);
629 if (IS_ERR(inta->base))
630 return PTR_ERR(inta->base);
632 domain = irq_domain_add_linear(dev_of_node(dev),
633 ti_sci_get_num_resources(inta->vint),
634 &ti_sci_inta_irq_domain_ops, inta);
636 dev_err(dev, "Failed to allocate IRQ domain\n");
640 msi_domain = ti_sci_inta_msi_create_irq_domain(of_node_to_fwnode(node),
641 &ti_sci_inta_msi_domain_info,
644 irq_domain_remove(domain);
645 dev_err(dev, "Failed to allocate msi domain\n");
649 INIT_LIST_HEAD(&inta->vint_list);
650 mutex_init(&inta->vint_mutex);
652 dev_info(dev, "Interrupt Aggregator domain %d created\n", pdev->id);
657 static const struct of_device_id ti_sci_inta_irq_domain_of_match[] = {
658 { .compatible = "ti,sci-inta", },
661 MODULE_DEVICE_TABLE(of, ti_sci_inta_irq_domain_of_match);
663 static struct platform_driver ti_sci_inta_irq_domain_driver = {
664 .probe = ti_sci_inta_irq_domain_probe,
666 .name = "ti-sci-inta",
667 .of_match_table = ti_sci_inta_irq_domain_of_match,
670 module_platform_driver(ti_sci_inta_irq_domain_driver);
672 MODULE_AUTHOR("Lokesh Vutla <lokeshvutla@ti.com>");
673 MODULE_DESCRIPTION("K3 Interrupt Aggregator driver over TI SCI protocol");
674 MODULE_LICENSE("GPL v2");