summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/leds/common.yaml
diff options
context:
space:
mode:
authorAstrid Rost <astrid.rost@axis.com>2023-07-03 15:03:12 +0200
committerLee Jones <lee@kernel.org>2023-07-28 09:26:21 +0100
commit713899c0627c440851a543b36b0ffe36fade2622 (patch)
tree93f34c33d031bb3c360e1152f064ed8e44d01b8b /Documentation/devicetree/bindings/leds/common.yaml
parent7a72f33b6771d37aafe1d396f8d49e5886e6262e (diff)
dt-bindings: leds: Read max-brightness from device tree
Normally, the maximum brightness is determined by the hardware, and this property is not required. This property is used to set a software limit. It could happen that an LED is made so bright that it gets damaged or causes damage due to restrictions in a specific system, such as mounting conditions. Note that this flag is mainly used for PWM-LEDs, where it is not possible to map brightness to current. Drivers for other controllers should use led-max-microamp. Signed-off-by: Astrid Rost <astrid.rost@axis.com> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Reviewed-by: Rob Herring <robh@kernel.org> Acked-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> Link: https://lore.kernel.org/r/20230703130313.548519-2-astrid.rost@axis.com Signed-off-by: Lee Jones <lee@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings/leds/common.yaml')
-rw-r--r--Documentation/devicetree/bindings/leds/common.yaml12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
index 58b492d00246..1c425eb5bec9 100644
--- a/Documentation/devicetree/bindings/leds/common.yaml
+++ b/Documentation/devicetree/bindings/leds/common.yaml
@@ -158,6 +158,18 @@ properties:
For flash LED controllers with configurable current this property is
mandatory for the LEDs in the non-flash modes (e.g. torch or indicator).
+ max-brightness:
+ description:
+ Normally, the maximum brightness is determined by the hardware, and this
+ property is not required. This property is used to set a software limit.
+ It could happen that an LED is made so bright that it gets damaged or
+ causes damage due to restrictions in a specific system, such as mounting
+ conditions.
+ Note that this flag is mainly used for PWM-LEDs, where it is not possible
+ to map brightness to current. Drivers for other controllers should use
+ led-max-microamp.
+ $ref: /schemas/types.yaml#definitions/uint32
+
panic-indicator:
description:
This property specifies that the LED should be used, if at all possible,