GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / leds / backlight / gpio-backlight.yaml
1 # SPDX-License-Identifier: GPL-2.0-only
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/leds/backlight/gpio-backlight.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: gpio-backlight
8
9 maintainers:
10   - Lee Jones <lee@kernel.org>
11   - Daniel Thompson <daniel.thompson@linaro.org>
12   - Jingoo Han <jingoohan1@gmail.com>
13
14 properties:
15   compatible:
16     const: gpio-backlight
17
18   gpios:
19     description: The gpio that is used for enabling/disabling the backlight.
20     maxItems: 1
21
22   default-on:
23     description: enable the backlight at boot.
24     type: boolean
25
26 required:
27   - compatible
28   - gpios
29
30 additionalProperties: false
31
32 examples:
33   - |
34     #include <dt-bindings/gpio/gpio.h>
35     backlight {
36         compatible = "gpio-backlight";
37         gpios = <&gpio3 4 GPIO_ACTIVE_HIGH>;
38         default-on;
39     };
40
41 ...