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