xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/leds/backlight/common.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun$id: http://devicetree.org/schemas/leds/backlight/common.yaml#
5*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
6*4882a593Smuzhiyun
7*4882a593Smuzhiyuntitle: Common backlight properties
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  Backlight devices provide backlight for different types of graphical
16*4882a593Smuzhiyun  displays. They are typically but not necessarily implemented using a white
17*4882a593Smuzhiyun  LED powered by a boost converter.
18*4882a593Smuzhiyun
19*4882a593Smuzhiyunproperties:
20*4882a593Smuzhiyun  default-brightness:
21*4882a593Smuzhiyun    description:
22*4882a593Smuzhiyun      The default brightness that should be applied to the LED by the operating
23*4882a593Smuzhiyun      system on start-up. The brightness should not exceed the brightness the
24*4882a593Smuzhiyun      LED can provide.
25*4882a593Smuzhiyun    $ref: /schemas/types.yaml#definitions/uint32
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun  max-brightness:
28*4882a593Smuzhiyun    description:
29*4882a593Smuzhiyun      Normally the maximum brightness is determined by the hardware and this
30*4882a593Smuzhiyun      property is not required. This property is used to put a software limit
31*4882a593Smuzhiyun      on the brightness apart from what the driver says, as it could happen
32*4882a593Smuzhiyun      that a LED can be made so bright that it gets damaged or causes damage
33*4882a593Smuzhiyun      due to restrictions in a specific system, such as mounting conditions.
34*4882a593Smuzhiyun    $ref: /schemas/types.yaml#definitions/uint32
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunadditionalProperties: true
37