Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / soc / ti / sci-pm-domain.txt
1 Texas Instruments TI-SCI Generic Power Domain
2 ---------------------------------------------
3
4 Some TI SoCs contain a system controller (like the PMMC, 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] Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
10
11 PM Domain Node
12 ==============
13 The PM domain node represents the global PM domain managed by the PMMC, which
14 in this case is the implementation as documented by the generic PM domain
15 bindings in Documentation/devicetree/bindings/power/power_domain.txt.  Because
16 this relies on the TI SCI protocol to communicate with the PMMC it must be a
17 child of the pmmc node.
18
19 Required Properties:
20 --------------------
21 - compatible: should be "ti,sci-pm-domain"
22 - #power-domain-cells: Must be 1 so that an id can be provided in each
23                        device node.
24
25 Example (K2G):
26 -------------
27         pmmc: pmmc {
28                 compatible = "ti,k2g-sci";
29                 ...
30
31                 k2g_pds: power-controller {
32                         compatible = "ti,sci-pm-domain";
33                         #power-domain-cells = <1>;
34                 };
35         };
36
37 PM Domain Consumers
38 ===================
39 Hardware blocks belonging to a PM domain should contain a "power-domains"
40 property that is a phandle pointing to the corresponding PM domain node
41 along with an index representing the device id to be passed to the PMMC
42 for device control.
43
44 Required Properties:
45 --------------------
46 - power-domains: phandle pointing to the corresponding PM domain node
47                  and an ID representing the device.
48
49 See http://processors.wiki.ti.com/index.php/TISCI#66AK2G02_Data for the list
50 of valid identifiers for k2g.
51
52 Example (K2G):
53 --------------------
54         uart0: serial@02530c00 {
55                 compatible = "ns16550a";
56                 ...
57                 power-domains = <&k2g_pds 0x002c>;
58         };