]> git.karo-electronics.de Git - karo-tx-linux.git/blob - Documentation/devicetree/bindings/power/power_domain.txt
base: power: Add generic OF-based power domain look-up
[karo-tx-linux.git] / Documentation / devicetree / bindings / power / power_domain.txt
1 * Generic power domains
2
3 System on chip designs are often divided into multiple power domains that
4 can be used for power gating of selected IP blocks for power saving by
5 reduced leakage current.
6
7 This device tree binding can be used to bind power domain consumer devices
8 with their power domains provided by power domain providers. A power domain
9 provider can be represented by any node in the device tree and can provide
10 one or more power domains. A consumer node can refer to the provider by
11 a phandle and a set of phandle arguments (so called power domain specifier)
12 of length specified by #power-domain-cells property in the power domain
13 provider node.
14
15 ==Power domain providers==
16
17 Required properties:
18  - #power-domain-cells : Number of cells in a power domain specifier;
19    Typically 0 for nodes representing a single power domain and 1 for nodes
20    providing multiple power domains (e.g. power controllers), but can be
21    any value as specified by device tree binding documentation of particular
22    provider.
23
24 Example:
25
26         power: power-controller@12340000 {
27                 compatible = "foo,power-controller";
28                 reg = <0x12340000 0x1000>;
29                 #power-domain-cells = <1>;
30         };
31
32 The node above defines a power controller that is a power domain provider
33 and expects one cell as its phandle argument.
34
35 ==Power domain consumers==
36
37 Required properties:
38  - power-domains : A phandle and power domain specifier as defined by bindings
39                    of power controller specified by phandle.
40
41 Example:
42
43         leaky-device@12350000 {
44                 compatible = "foo,i-leak-current";
45                 reg = <0x12350000 0x1000>;
46                 power-domains = <&power 0>;
47         };
48
49 The node above defines a typical power domain consumer device, which is located
50 inside power domain with index 0 of power controller represented by node with
51 label "power".