GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / leds / leds-class-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-class-multicolor.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Common properties for the multicolor LED class.
8
9 maintainers:
10   - Andrew Davis <afd@ti.com>
11
12 description: |
13   Bindings for multi color LEDs show how to describe current outputs of
14   either integrated multi-color LED elements (like RGB, RGBW, RGBWA-UV
15   etc.) or standalone LEDs, to achieve logically grouped multi-color LED
16   modules. This is achieved by adding multi-led nodes layer to the
17   monochrome LED bindings.
18   The nodes and properties defined in this document are unique to the multicolor
19   LED class.  Common LED nodes and properties are inherited from the common.yaml
20   within this documentation directory.
21
22 properties:
23   $nodename:
24     pattern: "^multi-led(@[0-9a-f])?$"
25
26   color:
27     description: |
28       For multicolor LED support this property should be defined as either
29       LED_COLOR_ID_RGB or LED_COLOR_ID_MULTI which can be found in
30       include/linux/leds/common.h.
31     enum: [ 8, 9 ]
32
33 required:
34   - color
35
36 allOf:
37   - $ref: common.yaml#
38
39 additionalProperties: true
40
41 ...