summaryrefslogtreecommitdiffstats
path: root/dts/Bindings/leds/leds-pwm-multicolor.yaml
blob: bd6ec04a87277f2d520a1d49a88bc21c7ca23070 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/leds-pwm-multicolor.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Multi-color LEDs connected to PWM

maintainers:
  - Sven Schwermer <sven.schwermer@disruptive-technologies.com>

description: |
  This driver combines several monochrome PWM LEDs into one multi-color
  LED using the multicolor LED class.

properties:
  compatible:
    const: pwm-leds-multicolor

  multi-led:
    type: object
    $ref: leds-class-multicolor.yaml#
    unevaluatedProperties: false

    properties:
      max-brightness:
        description:
          Maximum brightness possible for the LED
        $ref: /schemas/types.yaml#/definitions/uint32

    patternProperties:
      "^led-[0-9a-z]+$":
        type: object
        $ref: common.yaml#

        additionalProperties: false

        properties:
          pwms:
            maxItems: 1

          pwm-names: true

          active-low:
            description: For PWMs where the LED is wired to supply rather than ground.
            type: boolean

          color: true

        required:
          - pwms
          - color

required:
  - compatible

additionalProperties: false

examples:
  - |
    #include <dt-bindings/leds/common.h>

    led-controller {
        compatible = "pwm-leds-multicolor";

        multi-led {
            color = <LED_COLOR_ID_RGB>;
            function = LED_FUNCTION_INDICATOR;
            max-brightness = <65535>;

            led-red {
                pwms = <&pwm1 0 1000000>;
                color = <LED_COLOR_ID_RED>;
            };

            led-green {
                pwms = <&pwm2 0 1000000>;
                color = <LED_COLOR_ID_GREEN>;
            };

            led-blue {
                pwms = <&pwm3 0 1000000>;
                color = <LED_COLOR_ID_BLUE>;
            };
        };
    };

...