Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/power/reset/regulator-poweroff.yaml
Extension
.yaml
Size
870 bytes
Lines
38
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# 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

  cpu-supply:
    description:
      regulator to disable on power-down

required:
  - compatible
  - cpu-supply

additionalProperties: false

examples:
  - |
    regulator-poweroff {
        compatible = "regulator-poweroff";
        cpu-supply = <&reg_vcc1v2>;
    };
...

Annotation

Implementation Notes