xref: /linux/Documentation/devicetree/bindings/leds/leds-pwm.yaml (revision d30c1683aaecb93d2ab95685dc4300a33d3cea7a) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/leds/leds-pwm.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: LEDs connected to PWM
8
9maintainers:
10  - Pavel Machek <pavel@ucw.cz>
11
12description:
13  Each LED is represented as a sub-node of the pwm-leds device.  Each
14  node's name represents the name of the corresponding LED.
15
16properties:
17  compatible:
18    const: pwm-leds
19
20patternProperties:
21  "^led(-[0-9a-f]+)?$":
22    type: object
23    $ref: common.yaml#
24    unevaluatedProperties: false
25
26    properties:
27      pwms:
28        maxItems: 1
29
30      pwm-names: true
31
32      max-brightness:
33        description:
34          Maximum brightness possible for the LED
35        $ref: /schemas/types.yaml#/definitions/uint32
36
37      default-brightness:
38        description:
39          Brightness to be set if LED's default state is on. Used only during
40          initialization. If the option is not set then max brightness is used.
41        $ref: /schemas/types.yaml#/definitions/uint32
42
43      enable-gpios:
44        description:
45          GPIO for LED hardware enable control. Set active when brightness is
46          non-zero and inactive when brightness is zero.
47          The GPIO default state follows the "default-state" property.
48        maxItems: 1
49
50    required:
51      - pwms
52      - max-brightness
53
54additionalProperties: false
55
56examples:
57  - |
58
59    #include <dt-bindings/leds/common.h>
60
61    led-controller {
62        compatible = "pwm-leds";
63
64        led-1 {
65            label = "omap4::keypad";
66            pwms = <&twl_pwm 0 7812500>;
67            max-brightness = <127>;
68        };
69
70        led-2 {
71            color = <LED_COLOR_ID_GREEN>;
72            function = LED_FUNCTION_CHARGING;
73            pwms = <&twl_pwmled 0 7812500>;
74            max-brightness = <255>;
75        };
76    };
77
78...
79