xref: /openbmc/u-boot/doc/device-tree-bindings/power/ti,sci-pm-domain.txt (revision 9c2cb97e22a7a12bf87d0af7e90156afe7a78d21)
1 Texas Instruments TI SCI Generic Power Domain
2 =============================================
3 
4 Some TI SoCs contain a system controller (like the SYSFW, etc...) that is
5 responsible for controlling the state of the IPs that are present.
6 Communication between the host processor running an OS and the system
7 controller happens through a protocol known as TI SCI [1].
8 
9 [1] http://processors.wiki.ti.com/index.php/TISCI
10 
11 PM Domain Node
12 ==============
13 The PM domain node represents the global PM domain managed by the SYSFW. Because
14 this relies on the TI SCI protocol to communicate with the SYSFW it must be a
15 child of the sysfw node.
16 
17 Required Properties:
18 --------------------
19 - compatible: Must be "ti,sci-pm-domain"
20 - #power-domain-cells: Must be 1 so that an id can be provided in each
21 		       device node.
22 
23 Example (AM65x):
24 ----------------
25 	sysfw: sysfw {
26 		compatible = "ti,am654-system-controller";
27 		...
28 		k3_pds: power-controller {
29 			compatible = "ti,sci-pm-domain";
30 			#power-domain-cells = <1>;
31 		};
32 	};
33 
34 PM Domain Consumers
35 ===================
36 Hardware blocks belonging to a PM domain should contain a "power-domains"
37 property that is a phandle pointing to the corresponding PM domain node
38 along with an index representing the device id to be passed to the PMMC
39 for device control.
40 
41 Required Properties:
42 --------------------
43 - power-domains: phandle pointing to the corresponding PM domain node
44 		 and an ID representing the device.
45 
46 Example (AM65x):
47 ----------------
48 	uart2: serial@02800000 {
49 		compatible = "ti,omap4-uart";
50 		...
51 		power-domains = <&k3_pds 0x3f>;
52 	};
53