GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / leds / leds-group-multicolor.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/leds-group-multicolor.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Multi-color LED built with monochromatic LEDs
8
9 maintainers:
10   - Jean-Jacques Hiblot <jjhiblot@traphandler.com>
11
12 description: |
13   This driver combines several monochromatic LEDs into one multi-color
14   LED using the multicolor LED class.
15
16 properties:
17   compatible:
18     const: leds-group-multicolor
19
20   leds:
21     description:
22       An aray of monochromatic leds
23     $ref: /schemas/types.yaml#/definitions/phandle-array
24
25 required:
26   - leds
27
28 allOf:
29   - $ref: leds-class-multicolor.yaml#
30
31 unevaluatedProperties: false
32
33 examples:
34   - |
35     #include <dt-bindings/gpio/gpio.h>
36     #include <dt-bindings/leds/common.h>
37
38     monochromatic-leds {
39         compatible = "gpio-leds";
40
41         led0: led-0 {
42             gpios = <&mcu_pio 0 GPIO_ACTIVE_LOW>;
43             color = <LED_COLOR_ID_RED>;
44         };
45
46         led1: led-1 {
47             gpios = <&mcu_pio 1 GPIO_ACTIVE_HIGH>;
48             color = <LED_COLOR_ID_GREEN>;
49         };
50
51         led2: led-2 {
52             gpios = <&mcu_pio 2 GPIO_ACTIVE_HIGH>;
53             color = <LED_COLOR_ID_BLUE>;
54         };
55     };
56
57     multi-led {
58         compatible = "leds-group-multicolor";
59         color = <LED_COLOR_ID_RGB>;
60         function = LED_FUNCTION_INDICATOR;
61         leds = <&led0>, <&led1>, <&led2>;
62     };
63
64 ...