Documentation/devicetree/bindings/leds/regulator-led.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/leds/regulator-led.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Regulator LEDs
   8
   9 maintainers:
  10   - Linus Walleij <linus.walleij@linaro.org>
  11
  12 description: |
  13   Regulator LEDs are powered by a single regulator such that they can
  14   be turned on or off by enabling or disabling the regulator. The available
  15   brightness settings will be inferred from the available voltages on the
  16   regulator, and any constraints on the voltage or current will need to be
  17   specified on the regulator.
  18
  19 allOf:
  20   - $ref: common.yaml#
  21
  22 properties:
  23   $nodename:
  24     pattern: '^led.*$'
  25
  26   compatible:
  27     const: regulator-led
  28
  29   vled-supply:
  30     description:
  31       The regulator controlling the current to the LED.
  32
  33   function: true
  34   color: true
  35   linux,default-trigger: true
  36   default-state: true
  37
  38 required:
  39   - compatible
  40   - vled-supply
  41
  42 additionalProperties: false
  43
  44 examples:
  45   - |
  46     #include <dt-bindings/leds/common.h>
  47
  48     led-heartbeat {
  49         compatible = "regulator-led";
  50         vled-supply = <&regulator>;
  51         function = LED_FUNCTION_STATUS;
  52         color = <LED_COLOR_ID_BLUE>;
  53         linux,default-trigger = "heartbeat";
  54     };
  55 ...