xref: /openbmc/linux/Documentation/devicetree/bindings/leds/backlight/common.yaml (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
1ae1f74daSLinus Walleij# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2ae1f74daSLinus Walleij%YAML 1.2
3ae1f74daSLinus Walleij---
4ae1f74daSLinus Walleij$id: http://devicetree.org/schemas/leds/backlight/common.yaml#
5ae1f74daSLinus Walleij$schema: http://devicetree.org/meta-schemas/core.yaml#
6ae1f74daSLinus Walleij
7ae1f74daSLinus Walleijtitle: Common backlight properties
8ae1f74daSLinus Walleij
9ae1f74daSLinus Walleijmaintainers:
10*2654f59bSLee Jones  - Lee Jones <lee@kernel.org>
11ae1f74daSLinus Walleij  - Daniel Thompson <daniel.thompson@linaro.org>
12ae1f74daSLinus Walleij  - Jingoo Han <jingoohan1@gmail.com>
13ae1f74daSLinus Walleij
14ae1f74daSLinus Walleijdescription:
15ae1f74daSLinus Walleij  Backlight devices provide backlight for different types of graphical
16ae1f74daSLinus Walleij  displays. They are typically but not necessarily implemented using a white
17ae1f74daSLinus Walleij  LED powered by a boost converter.
18ae1f74daSLinus Walleij
19ae1f74daSLinus Walleijproperties:
20ae1f74daSLinus Walleij  default-brightness:
21ae1f74daSLinus Walleij    description:
22ae1f74daSLinus Walleij      The default brightness that should be applied to the LED by the operating
23ae1f74daSLinus Walleij      system on start-up. The brightness should not exceed the brightness the
24ae1f74daSLinus Walleij      LED can provide.
25d69c6dddSRob Herring    $ref: /schemas/types.yaml#/definitions/uint32
26ae1f74daSLinus Walleij
27ae1f74daSLinus Walleij  max-brightness:
28ae1f74daSLinus Walleij    description:
29ae1f74daSLinus Walleij      Normally the maximum brightness is determined by the hardware and this
30ae1f74daSLinus Walleij      property is not required. This property is used to put a software limit
31ae1f74daSLinus Walleij      on the brightness apart from what the driver says, as it could happen
32ae1f74daSLinus Walleij      that a LED can be made so bright that it gets damaged or causes damage
33ae1f74daSLinus Walleij      due to restrictions in a specific system, such as mounting conditions.
34d69c6dddSRob Herring    $ref: /schemas/types.yaml#/definitions/uint32
35f84e2c5cSRob Herring
36f84e2c5cSRob HerringadditionalProperties: true
37