xref: /linux/Documentation/devicetree/bindings/leds/backlight/led-backlight.yaml (revision 44e1655a444fe7a1bd81994d34c6bbb5245b9e60)
1*44e1655aSRob Herring# SPDX-License-Identifier: GPL-2.0-only
2*44e1655aSRob Herring%YAML 1.2
3*44e1655aSRob Herring---
4*44e1655aSRob Herring$id: http://devicetree.org/schemas/leds/backlight/led-backlight.yaml#
5*44e1655aSRob Herring$schema: http://devicetree.org/meta-schemas/core.yaml#
6*44e1655aSRob Herring
7*44e1655aSRob Herringtitle: led-backlight bindings
8*44e1655aSRob Herring
9*44e1655aSRob Herringmaintainers:
10*44e1655aSRob Herring  - Lee Jones <lee.jones@linaro.org>
11*44e1655aSRob Herring  - Daniel Thompson <daniel.thompson@linaro.org>
12*44e1655aSRob Herring  - Jingoo Han <jingoohan1@gmail.com>
13*44e1655aSRob Herring
14*44e1655aSRob Herringdescription:
15*44e1655aSRob Herring  This binding is used to describe a basic backlight device made of LEDs. It
16*44e1655aSRob Herring  can also be used to describe a backlight device controlled by the output of
17*44e1655aSRob Herring  a LED driver.
18*44e1655aSRob Herring
19*44e1655aSRob Herringproperties:
20*44e1655aSRob Herring  compatible:
21*44e1655aSRob Herring    const: led-backlight
22*44e1655aSRob Herring
23*44e1655aSRob Herring  leds:
24*44e1655aSRob Herring    description: A list of LED nodes
25*44e1655aSRob Herring    $ref: /schemas/types.yaml#/definitions/phandle-array
26*44e1655aSRob Herring
27*44e1655aSRob Herring  brightness-levels:
28*44e1655aSRob Herring    description:
29*44e1655aSRob Herring      Array of distinct brightness levels. The levels must be in the range
30*44e1655aSRob Herring      accepted by the underlying LED devices. This is used to translate a
31*44e1655aSRob Herring      backlight brightness level into a LED brightness level. If it is not
32*44e1655aSRob Herring      provided, the identity mapping is used.
33*44e1655aSRob Herring    $ref: /schemas/types.yaml#/definitions/uint32-array
34*44e1655aSRob Herring
35*44e1655aSRob Herring  default-brightness-level:
36*44e1655aSRob Herring    description:
37*44e1655aSRob Herring      The default brightness level (index into the array defined by the
38*44e1655aSRob Herring      "brightness-levels" property).
39*44e1655aSRob Herring    $ref: /schemas/types.yaml#/definitions/uint32
40*44e1655aSRob Herring
41*44e1655aSRob Herringrequired:
42*44e1655aSRob Herring  - compatible
43*44e1655aSRob Herring  - leds
44*44e1655aSRob Herring
45*44e1655aSRob HerringadditionalProperties: false
46*44e1655aSRob Herring
47*44e1655aSRob Herringexamples:
48*44e1655aSRob Herring  - |
49*44e1655aSRob Herring    backlight {
50*44e1655aSRob Herring        compatible = "led-backlight";
51*44e1655aSRob Herring
52*44e1655aSRob Herring        leds = <&led1>, <&led2>;
53*44e1655aSRob Herring        brightness-levels = <0 4 8 16 32 64 128 255>;
54*44e1655aSRob Herring        default-brightness-level = <6>;
55*44e1655aSRob Herring    };
56*44e1655aSRob Herring
57*44e1655aSRob Herring...
58