xref: /linux/Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml (revision 7f71507851fc7764b36a3221839607d3a45c2025) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/interrupt-controller/ti,sci-inta.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Texas Instruments K3 Interrupt Aggregator
8
9maintainers:
10  - Lokesh Vutla <lokeshvutla@ti.com>
11
12allOf:
13  - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#
14
15description: |
16  The Interrupt Aggregator (INTA) provides a centralized machine
17  which handles the termination of system events to that they can
18  be coherently processed by the host(s) in the system. A maximum
19  of 64 events can be mapped to a single interrupt.
20
21                                Interrupt Aggregator
22                       +-----------------------------------------+
23                       |      Intmap            VINT             |
24                       | +--------------+  +------------+        |
25              m ------>| | vint  | bit  |  | 0 |.....|63| vint0  |
26                 .     | +--------------+  +------------+        |      +------+
27                 .     |         .               .               |      | HOST |
28  Globalevents  ------>|         .               .               |----->| IRQ  |
29                 .     |         .               .               |      | CTRL |
30                 .     |         .               .               |      +------+
31              n ------>| +--------------+  +------------+        |
32                       | | vint  | bit  |  | 0 |.....|63| vintx  |
33                       | +--------------+  +------------+        |
34                       |                                         |
35                       |      Unmap                              |
36                       | +--------------+                        |
37  Unmapped events ---->| |   umapidx    |-------------------------> Globalevents
38                       | +--------------+                        |
39                       |                                         |
40                       +-----------------------------------------+
41
42  Configuration of these Intmap registers that maps global events to vint is
43  done by a system controller (like the Device Memory and Security Controller
44  on AM654 SoC). Driver should request the system controller to get the range
45  of global events and vints assigned to the requesting host. Management
46  of these requested resources should be handled by driver and requests
47  system controller to map specific global event to vint, bit pair.
48
49  Communication between the host processor running an OS and the system
50  controller happens through a protocol called TI System Control Interface
51  (TISCI protocol).
52
53properties:
54  compatible:
55    const: ti,sci-inta
56
57  reg:
58    maxItems: 1
59
60  interrupt-controller: true
61
62  '#interrupt-cells':
63    const: 0
64
65  msi-controller: true
66
67  ti,interrupt-ranges:
68    $ref: /schemas/types.yaml#/definitions/uint32-matrix
69    description: |
70      Interrupt ranges that converts the INTA output hw irq numbers
71      to parents's input interrupt numbers.
72    items:
73      items:
74        - description: |
75            "output_irq" specifies the base for inta output irq
76        - description: |
77            "parent's input irq" specifies the base for parent irq
78        - description: |
79            "limit" specifies the limit for translation
80
81  ti,unmapped-event-sources:
82    $ref: /schemas/types.yaml#/definitions/phandle-array
83    items:
84      maxItems: 1
85    description:
86      Array of phandles to DMA controllers where the unmapped events originate.
87
88  power-domains:
89    maxItems: 1
90
91required:
92  - compatible
93  - reg
94  - interrupt-controller
95  - msi-controller
96  - ti,sci
97  - ti,sci-dev-id
98  - ti,interrupt-ranges
99
100unevaluatedProperties: false
101
102examples:
103  - |
104    bus {
105        #address-cells = <2>;
106        #size-cells = <2>;
107
108        main_udmass_inta: msi-controller@33d00000 {
109            compatible = "ti,sci-inta";
110            reg = <0x0 0x33d00000 0x0 0x100000>;
111            interrupt-controller;
112            #interrupt-cells = <0>;
113            msi-controller;
114            interrupt-parent = <&main_navss_intr>;
115            ti,sci = <&dmsc>;
116            ti,sci-dev-id = <179>;
117            ti,interrupt-ranges = <0 0 256>;
118        };
119    };
120