Documentation: dt: keystone: ti-sci: Add optional host-id parameter
[rpmsg/hwspinlock.git] / Documentation / devicetree / bindings / arm / keystone / ti,sci.txt
1 Texas Instruments System Control Interface (TI-SCI) Message Protocol
2 --------------------------------------------------------------------
4 Texas Instrument's processors including those belonging to Keystone generation
5 of processors have separate hardware entity which is now responsible for the
6 management of the System on Chip (SoC) system. These include various system
7 level functions as well.
9 An example of such an SoC is K2G, which contains the system control hardware
10 block called Power Management Micro Controller (PMMC). This hardware block is
11 initialized early into boot process and provides services to Operating Systems
12 on multiple processors including ones running Linux.
14 See http://processors.wiki.ti.com/index.php/TISCI for protocol definition.
16 TI-SCI controller Device Node:
17 =============================
19 The TI-SCI node describes the Texas Instrument's System Controller entity node.
20 This parent node may optionally have additional children nodes which describe
21 specific functionality such as clocks, power domain, reset or additional
22 functionality as may be required for the SoC. This hierarchy also describes the
23 relationship between the TI-SCI parent node to the child node.
25 Required properties:
26 -------------------
27 - compatible: should be "ti,k2g-sci"
28 - mbox-names:
29         "rx" - Mailbox corresponding to receive path
30         "tx" - Mailbox corresponding to transmit path
32 - mboxes: Mailboxes corresponding to the mbox-names. Each value of the mboxes
33           property should contain a phandle to the mailbox controller device
34           node and an args specifier that will be the phandle to the intended
35           sub-mailbox child node to be used for communication.
37 See Documentation/devicetree/bindings/mailbox/mailbox.txt for more details
38 about the generic mailbox controller and client driver bindings. Also see
39 Documentation/devicetree/bindings/mailbox/ti,message-manager.txt for typical
40 controller that is used to communicate with this System controllers.
42 Optional Properties:
43 -------------------
44 - reg-names:
45         debug_messages - Map the Debug message region
46 - reg:  register space corresponding to the debug_messages
47 - ti,system-reboot-controller: If system reboot can be triggered by SoC reboot
48 - ti,host-id: Integer value corresponding to the host ID assigned by Firmware
49         for identification of host processing entities such as virtual
50         machines
52 Example (K2G):
53 -------------
54         pmmc: pmmc {
55                 compatible = "ti,k2g-sci";
56                 ti,host-id = <2>;
57                 mbox-names = "rx", "tx";
58                 mboxes= <&msgmgr &msgmgr_proxy_pmmc_rx>,
59                         <&msgmgr &msgmgr_proxy_pmmc_tx>;
60                 reg-names = "debug_messages";
61                 reg = <0x02921800 0x800>;
62         };
65 TI-SCI Client Device Node:
66 =========================
68 Client nodes are maintained as children of the relevant TI-SCI device node.
70 Example (K2G):
71 -------------
72         pmmc: pmmc {
73                 compatible = "ti,k2g-sci";
74                 ...
76                 my_clk_node: clk_node {
77                         ...
78                         ...
79                 };
81                 my_pd_node: pd_node {
82                         ...
83                         ...
84                 };
85         };