Documentation/devicetree/bindings/leds/sprd,sc2731-bltc.yaml

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

title: Spreadtrum SC2731 PMIC breathing light controller

maintainers:
  - Orson Zhai <orsonzhai@gmail.com>
  - Baolin Wang <baolin.wang7@gmail.com>
  - Chunyan Zhang <zhang.lyra@gmail.com>

description: |
  The SC2731 breathing light controller supports up to 3 outputs:
  red LED, green LED and blue LED. Each LED can work at normal PWM mode
  or breath light mode.

properties:
  compatible:
    const: sprd,sc2731-bltc

  reg:
    maxItems: 1

  '#address-cells':
    const: 1

  '#size-cells':
    const: 0

patternProperties:
  "^led@[0-2]$":
    type: object
    $ref: common.yaml#
    unevaluatedProperties: false

    properties:
      reg:
        minimum: 0
        maximum: 2

    required:
      - reg

required:
  - compatible
  - reg
  - '#address-cells'
  - '#size-cells'

additionalProperties: false

examples:
  - |
    #include <dt-bindings/leds/common.h>

    pmic {
      #address-cells = <1>;
      #size-cells = <0>;

      led-controller@200 {
        compatible = "sprd,sc2731-bltc";
        reg = <0x200>;
        #address-cells = <1>;
        #size-cells = <0>;

        led@0 {
          reg = <0x0>;
          color = <LED_COLOR_ID_RED>;
        };

        led@1 {
          reg = <0x1>;
          color = <LED_COLOR_ID_GREEN>;
        };

        led@2 {
          reg = <0x2>;
          color = <LED_COLOR_ID_BLUE>;
        };
      };
    };
...