Merge tag 'docs-5.11-2' of git://git.lwn.net/linux
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / power / reset / regulator-poweroff.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/power/reset/regulator-poweroff.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Force-disable power regulator to turn the power off.
8
9 maintainers:
10   - Michael Klein <michael@fossekall.de>
11
12 description: |
13   When the power-off handler is called, a power regulator is disabled by
14   calling regulator_force_disable(). If the power is still on and the
15   CPU still running after a 3000ms delay, a warning is emitted.
16
17 properties:
18   compatible:
19     const: "regulator-poweroff"
20
21   cpu-supply:
22     description:
23       regulator to disable on power-down
24
25 required:
26   - compatible
27   - cpu-supply
28
29 additionalProperties: false
30
31 examples:
32   - |
33     regulator-poweroff {
34         compatible = "regulator-poweroff";
35         cpu-supply = <&reg_vcc1v2>;
36     };
37 ...