Documentation/devicetree/bindings/regulator/samsung,s5m8767.yaml

# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/regulator/samsung,s5m8767.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Samsung S5M8767 Power Management IC regulators

maintainers:
  - Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>

description: |
  This is a part of device tree bindings for S2M and S5M family of Power
  Management IC (PMIC).

  The S5M8767 provides buck and LDO regulators.

  See also Documentation/devicetree/bindings/mfd/samsung,s5m8767.yaml for
  additional information and example.

patternProperties:
  # 28 LDOs
  "^LDO([1-9]|1[0-9]|2[0-8])$":
    type: object
    $ref: regulator.yaml#
    unevaluatedProperties: false
    description:
      Properties for single LDO regulator.

    properties:
      op_mode:
        $ref: /schemas/types.yaml#/definitions/uint32
        enum: [0, 1, 2, 3]
        default: 1
        description: |
          Describes the different operating modes of the LDO's with power mode
          change in SOC. The different possible values are:
            0 - always off mode
            1 - on in normal mode
            2 - low power mode
            3 - suspend mode

    required:
      - regulator-name

  # 8 bucks
  "^BUCK[1-8]$":
    type: object
    $ref: regulator.yaml#
    unevaluatedProperties: false
    description:
      Properties for single BUCK regulator.

    properties:
      op_mode:
        $ref: /schemas/types.yaml#/definitions/uint32
        enum: [0, 1, 2, 3]
        default: 1
        description: |
          Describes the different operating modes of the regulator with power
          mode change in SOC. The different possible values are:
            0 - always off mode
            1 - on in normal mode
            2 - low power mode
            3 - suspend mode

    required:
      - regulator-name

properties:
  # 9 buck
  BUCK9:
    type: object
    $ref: regulator.yaml#
    unevaluatedProperties: false
    description:
      Properties for single BUCK regulator.

    properties:
      op_mode:
        $ref: /schemas/types.yaml#/definitions/uint32
        enum: [0, 1, 2, 3]
        default: 1
        description: |
          Describes the different operating modes of the regulator with power
          mode change in SOC. The different possible values are:
            0 - always off mode
            1 - on in normal mode
            2 - low power mode
            3 - suspend mode

      s5m8767,pmic-ext-control-gpios:
        maxItems: 1
        description: |
          GPIO specifier for one GPIO controlling this regulator on/off.

    required:
      - regulator-name

additionalProperties: false