xref: /freebsd/sys/contrib/device-tree/Bindings/arm/keystone/ti,sci.yaml (revision 3a3af6b2a160bea72509a9d5ef84e25906b0478a) 
1# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/arm/keystone/ti,sci.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: TI-SCI controller device node bindings
8
9maintainers:
10  - Nishanth Menon <nm@ti.com>
11
12description: |
13  Texas Instrument's processors including those belonging to Keystone generation
14  of processors have separate hardware entity which is now responsible for the
15  management of the System on Chip (SoC) system. These include various system
16  level functions as well.
17
18  An example of such an SoC is K2G, which contains the system control hardware
19  block called Power Management Micro Controller (PMMC). This hardware block is
20  initialized early into boot process and provides services to Operating Systems
21  on multiple processors including ones running Linux.
22
23  See http://processors.wiki.ti.com/index.php/TISCI for protocol definition.
24
25  The TI-SCI node describes the Texas Instrument's System Controller entity node.
26  This parent node may optionally have additional children nodes which describe
27  specific functionality such as clocks, power domain, reset or additional
28  functionality as may be required for the SoC. This hierarchy also describes the
29  relationship between the TI-SCI parent node to the child node.
30
31properties:
32  $nodename:
33    pattern: "^system-controller@[0-9a-f]+$"
34
35  compatible:
36    oneOf:
37      - description: System controller on TI 66AK2G SoC and other K3 SoCs
38        items:
39          - const: ti,k2g-sci
40      - description: System controller on TI AM654 SoC
41        items:
42          - const: ti,am654-sci
43
44  reg-names:
45    description: |
46      Specifies the debug messages memory mapped region that is optionally
47      made available from TI-SCI controller.
48    const: debug_messages
49
50  reg:
51    minItems: 1
52
53  mbox-names:
54    description: |
55      Specifies the mailboxes used to communicate with TI-SCI Controller
56      made available from TI-SCI controller.
57    items:
58      - const: rx
59      - const: tx
60
61  mboxes:
62    minItems: 2
63
64  ti,system-reboot-controller:
65    description: Determines If system reboot can be triggered by SoC reboot
66    type: boolean
67
68  ti,host-id:
69    $ref: /schemas/types.yaml#/definitions/uint32
70    description: |
71      Value corresponding to the host ID assigned by Firmware
72      for identification of host processing entities such as virtual machines.
73
74  power-controller:
75    type: object
76    $ref: /schemas/soc/ti/sci-pm-domain.yaml#
77
78  clock-controller:
79    type: object
80    $ref: /schemas/clock/ti,sci-clk.yaml#
81
82  reset-controller:
83    type: object
84    $ref: /schemas/reset/ti,sci-reset.yaml#
85
86required:
87  - compatible
88  - mbox-names
89  - mboxes
90
91additionalProperties: false
92
93examples:
94  - |
95    pmmc: system-controller@2921800 {
96      compatible = "ti,k2g-sci";
97      ti,system-reboot-controller;
98      mbox-names = "rx", "tx";
99      mboxes= <&msgmgr 5 2>,
100              <&msgmgr 0 0>;
101      reg-names = "debug_messages";
102      reg = <0x02921800 0x800>;
103    };
104
105  - |
106    dmsc: system-controller@44083000 {
107      compatible = "ti,k2g-sci";
108      ti,host-id = <12>;
109      mbox-names = "rx", "tx";
110      mboxes= <&secure_proxy_main 11>,
111              <&secure_proxy_main 13>;
112      reg-names = "debug_messages";
113      reg = <0x44083000 0x1000>;
114
115      k3_pds: power-controller {
116        compatible = "ti,sci-pm-domain";
117        #power-domain-cells = <2>;
118      };
119
120      k3_clks: clock-controller {
121        compatible = "ti,k2g-sci-clk";
122        #clock-cells = <2>;
123      };
124
125      k3_reset: reset-controller {
126        compatible = "ti,sci-reset";
127        #reset-cells = <2>;
128      };
129    };
130