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