diff mbox series

[v4,2/3] Documentation: DT: binding documentation for regulator-poweroff

Message ID 20201209210221.385188-3-michael@fossekall.de
State Accepted
Commit d6e33fc89e0f81571b7f8d6b365eb8748a97e041
Headers show
Series BPi M2 Zero poweroff support via new regulator-poweroff driver | expand

Commit Message

Michael Klein Dec. 9, 2020, 9:02 p.m. UTC 
Add devicetree binding documentation for regulator-poweroff driver.

Signed-off-by: Michael Klein <michael@fossekall.de>
---
 .../power/reset/regulator-poweroff.yaml       | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml

Comments

Rob Herring Dec. 11, 2020, 3:06 a.m. UTC | #1 
On Wed, 09 Dec 2020 22:02:20 +0100, Michael Klein wrote:
> Add devicetree binding documentation for regulator-poweroff driver.

> 

> Signed-off-by: Michael Klein <michael@fossekall.de>

> ---

>  .../power/reset/regulator-poweroff.yaml       | 37 +++++++++++++++++++

>  1 file changed, 37 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml

> 


Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml b/Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml
new file mode 100644
index 000000000000..c74ac247ab70
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml
@@ -0,0 +1,37 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/reset/regulator-poweroff.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Force-disable power regulator to turn the power off.
+
+maintainers:
+  - Michael Klein <michael@fossekall.de>
+
+description: |
+  When the power-off handler is called, a power regulator is disabled by
+  calling regulator_force_disable(). If the power is still on and the
+  CPU still running after a 3000ms delay, a warning is emitted.
+
+properties:
+  compatible:
+    const: "regulator-poweroff"
+
+  power-supply:
+    description:
+      regulator to disable on power-down
+
+required:
+  - compatible
+  - power-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    regulator-poweroff {
+        compatible = "regulator-poweroff";
+        power-supply = <&reg_vcc1v2>;
+    };
+...