summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/leds/leds-pwm.yaml
diff options
context:
space:
mode:
authorAlexander Dahl <post@lespocky.de>2020-10-05 22:34:41 +0200
committerPavel Machek <pavel@ucw.cz>2020-11-25 13:18:24 +0100
commit0fe5ac3d9667176e236d536ff9c1ec30eb2e6080 (patch)
treeb4636fcb8b7f0369c114fedfffa78da23383bd67 /Documentation/devicetree/bindings/leds/leds-pwm.yaml
parentleds: lp50xx: Fix an error handling path in 'lp50xx_probe_dt()' (diff)
downloadlinux-0fe5ac3d9667176e236d536ff9c1ec30eb2e6080.tar.xz
linux-0fe5ac3d9667176e236d536ff9c1ec30eb2e6080.zip
dt-bindings: leds: Convert pwm to yaml
The example was adapted in the following ways: - make use of the now supported 'function' and 'color' properties - remove pwm nodes, those are documented elsewhere - align node names to new dt schema rules and dt recommendations License was not explicitly set before. The license set now is recommended by DT project. Suggested-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> Signed-off-by: Alexander Dahl <post@lespocky.de> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org> Reviewed-by: Rob Herring <robh@kernel.org> Cc: Peter Ujfalusi <peter.ujfalusi@ti.com> [For the license change only:] Acked-by: Russell King <rmk+kernel@armlinux.org.uk> Signed-off-by: Pavel Machek <pavel@ucw.cz>
Diffstat (limited to 'Documentation/devicetree/bindings/leds/leds-pwm.yaml')
-rw-r--r--Documentation/devicetree/bindings/leds/leds-pwm.yaml70
1 files changed, 70 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/leds/leds-pwm.yaml b/Documentation/devicetree/bindings/leds/leds-pwm.yaml
new file mode 100644
index 000000000000..fe4d5fd25913
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-pwm.yaml
@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-pwm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LEDs connected to PWM
+
+maintainers:
+ - Pavel Machek <pavel@ucw.cz>
+
+description:
+ Each LED is represented as a sub-node of the pwm-leds device. Each
+ node's name represents the name of the corresponding LED.
+
+properties:
+ compatible:
+ const: pwm-leds
+
+patternProperties:
+ "^led(-[0-9a-f]+)?$":
+ type: object
+
+ $ref: common.yaml#
+
+ properties:
+ pwms:
+ maxItems: 1
+
+ pwm-names: true
+
+ max-brightness:
+ description:
+ Maximum brightness possible for the LED
+ $ref: /schemas/types.yaml#/definitions/uint32
+
+ active-low:
+ description:
+ For PWMs where the LED is wired to supply rather than ground.
+ type: boolean
+
+ required:
+ - pwms
+ - max-brightness
+
+additionalProperties: false
+
+examples:
+ - |
+
+ #include <dt-bindings/leds/common.h>
+
+ led-controller {
+ compatible = "pwm-leds";
+
+ led-1 {
+ label = "omap4::keypad";
+ pwms = <&twl_pwm 0 7812500>;
+ max-brightness = <127>;
+ };
+
+ led-2 {
+ color = <LED_COLOR_ID_GREEN>;
+ function = LED_FUNCTION_CHARGING;
+ pwms = <&twl_pwmled 0 7812500>;
+ max-brightness = <255>;
+ };
+ };
+
+...