Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml

   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
   7 title: Texas Instruments K3 Interrupt Aggregator
   8
   9 maintainers:
  10   - Lokesh Vutla <lokeshvutla@ti.com>
  11
  12 allOf:
  13   - $ref: /schemas/arm/keystone/ti,k3-sci-common.yaml#
  14
  15 description: |
  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
  53 properties:
  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 required:
  89   - compatible
  90   - reg
  91   - interrupt-controller
  92   - msi-controller
  93   - ti,sci
  94   - ti,sci-dev-id
  95   - ti,interrupt-ranges
  96
  97 unevaluatedProperties: false
  98
  99 examples:
 100   - |
 101     bus {
 102         #address-cells = <2>;
 103         #size-cells = <2>;
 104
 105         main_udmass_inta: msi-controller@33d00000 {
 106             compatible = "ti,sci-inta";
 107             reg = <0x0 0x33d00000 0x0 0x100000>;
 108             interrupt-controller;
 109             msi-controller;
 110             interrupt-parent = <&main_navss_intr>;
 111             ti,sci = <&dmsc>;
 112             ti,sci-dev-id = <179>;
 113             ti,interrupt-ranges = <0 0 256>;
 114         };
 115     };