xref: /freebsd/sys/contrib/device-tree/Bindings/soc/ti/sci-pm-domain.txt (revision ec0ea6efa1ad229d75c394c1a9b9cac33af2b1d3)
1Texas Instruments TI-SCI Generic Power Domain
2---------------------------------------------
3
4Some TI SoCs contain a system controller (like the PMMC, etc...) that is
5responsible for controlling the state of the IPs that are present.
6Communication between the host processor running an OS and the system
7controller happens through a protocol known as TI-SCI [1].
8
9[1] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
10
11PM Domain Node
12==============
13The PM domain node represents the global PM domain managed by the PMMC, which
14in this case is the implementation as documented by the generic PM domain
15bindings in Documentation/devicetree/bindings/power/power-domain.yaml.  Because
16this relies on the TI SCI protocol to communicate with the PMMC it must be a
17child of the pmmc node.
18
19Required Properties:
20--------------------
21- compatible: should be "ti,sci-pm-domain"
22- #power-domain-cells: Can be one of the following:
23			1: Containing the device id of each node
24			2: First entry should be device id
25			   Second entry should be one of the floowing:
26			   TI_SCI_PD_EXCLUSIVE: To allow device to be
27						exclusively controlled by
28						the requesting hosts.
29			   TI_SCI_PD_SHARED: To allow device to be shared
30					     by multiple hosts.
31
32Example (K2G):
33-------------
34	pmmc: pmmc {
35		compatible = "ti,k2g-sci";
36		...
37
38		k2g_pds: power-controller {
39			compatible = "ti,sci-pm-domain";
40			#power-domain-cells = <1>;
41		};
42	};
43
44PM Domain Consumers
45===================
46Hardware blocks belonging to a PM domain should contain a "power-domains"
47property that is a phandle pointing to the corresponding PM domain node
48along with an index representing the device id to be passed to the PMMC
49for device control.
50
51Required Properties:
52--------------------
53- power-domains: phandle pointing to the corresponding PM domain node
54		 and an ID representing the device.
55
56See http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data for the list
57of valid identifiers for k2g.
58
59Example (K2G):
60--------------------
61	uart0: serial@2530c00 {
62		compatible = "ns16550a";
63		...
64		power-domains = <&k2g_pds 0x002c>;
65	};
66