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