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

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

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/power/reset/syscon-poweroff.yaml
Extension
.yaml
Size
1911 bytes
Lines
73
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
%YAML 1.2
---
$id: http://devicetree.org/schemas/power/reset/syscon-poweroff.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Generic SYSCON mapped register poweroff driver

maintainers:
  - Sebastian Reichel <sre@kernel.org>

description: |+
  This is a generic poweroff driver using syscon to map the poweroff register.
  The poweroff is generally performed with a write to the poweroff register
  defined by the register map pointed by syscon reference plus the offset
  with the value and mask defined in the poweroff node.
  Default will be little endian mode, 32 bit access only.
  The SYSCON register map is normally retrieved from the parental dt-node. So
  the SYSCON poweroff node should be represented as a sub-node of a "syscon",
  "simple-mfd" node.

properties:
  compatible:
    const: syscon-poweroff

  reg:
    maxItems: 1

  mask:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Update only the register bits defined by the mask (32 bit).

  offset:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Offset in the register map for the poweroff register (in bytes).

  regmap:
    $ref: /schemas/types.yaml#/definitions/phandle
    deprecated: true
    description:
      Phandle to the register map node. This property is deprecated in favor of
      the syscon-poweroff node being a child of a system controller node.

  value:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: The poweroff value written to the poweroff register (32 bit access).

required:
  - compatible

anyOf:
  - required: [offset]
  - required: [reg]

additionalProperties: false

allOf:
  - if:
      not:
        required:
          - mask
    then:
      required:
        - value

examples:
  - |
    poweroff {
        compatible = "syscon-poweroff";
        offset = <0x0>;

Annotation

Implementation Notes