GNU Linux-libre 4.19.281-gnu1
[releases.git] / Documentation / devicetree / bindings / mfd / twl4030-power.txt
1 Texas Instruments TWL family (twl4030) reset and power management module
2
3 The power management module inside the TWL family provides several facilities
4 to control the power resources, including power scripts. For now, the
5 binding only supports the complete shutdown of the system after poweroff.
6
7 Required properties:
8 - compatible : must be one of the following
9         "ti,twl4030-power"
10         "ti,twl4030-power-reset"
11         "ti,twl4030-power-idle"
12         "ti,twl4030-power-idle-osc-off"
13
14 The use of ti,twl4030-power-reset is recommended at least on
15 3530 that needs a special configuration for warm reset to work.
16
17 When using ti,twl4030-power-idle, the TI recommended configuration
18 for idle modes is loaded to the tlw4030 PMIC.
19
20 When using ti,twl4030-power-idle-osc-off, the TI recommended
21 configuration is used with the external oscillator being shut
22 down during off-idle. Note that this does not work on all boards
23 depending on how the external oscillator is wired.
24
25 Optional properties:
26
27 - ti,system-power-controller: This indicates that TWL4030 is the
28   power supply master of the system. With this flag, the chip will
29   initiate an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
30   system poweroffs.
31
32 - ti,use_poweroff: Deprecated name for ti,system-power-controller
33
34 Example:
35 &i2c1 {
36         clock-frequency = <2600000>;
37
38         twl: twl@48 {
39                 reg = <0x48>;
40                 interrupts = <7>; /* SYS_NIRQ cascaded to intc */
41                 interrupt-parent = <&intc>;
42
43                 twl_power: power {
44                         compatible = "ti,twl4030-power";
45                         ti,use_poweroff;
46                 };
47         };
48 };