Documentation/devicetree/bindings/leds/leds-pwm-multicolor.yaml

   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-multicolor.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Multi-color LEDs connected to PWM
   8
   9 maintainers:
  10   - Sven Schwermer <sven.schwermer@disruptive-technologies.com>
  11
  12 description: |
  13   This driver combines several monochrome PWM LEDs into one multi-color
  14   LED using the multicolor LED class.
  15
  16 properties:
  17   compatible:
  18     const: pwm-leds-multicolor
  19
  20   multi-led:
  21     type: object
  22     $ref: leds-class-multicolor.yaml#
  23     unevaluatedProperties: false
  24
  25     properties:
  26       max-brightness:
  27         description:
  28           Maximum brightness possible for the LED
  29         $ref: /schemas/types.yaml#/definitions/uint32
  30
  31     patternProperties:
  32       "^led-[0-9a-z]+$":
  33         type: object
  34         $ref: common.yaml#
  35
  36         additionalProperties: false
  37
  38         properties:
  39           pwms:
  40             maxItems: 1
  41
  42           pwm-names: true
  43
  44           active-low:
  45             description: For PWMs where the LED is wired to supply rather than ground.
  46             type: boolean
  47
  48           color: true
  49
  50         required:
  51           - pwms
  52           - color
  53
  54 required:
  55   - compatible
  56
  57 additionalProperties: false
  58
  59 examples:
  60   - |
  61     #include <dt-bindings/leds/common.h>
  62
  63     led-controller {
  64         compatible = "pwm-leds-multicolor";
  65
  66         multi-led {
  67             color = <LED_COLOR_ID_RGB>;
  68             function = LED_FUNCTION_INDICATOR;
  69             max-brightness = <65535>;
  70
  71             led-red {
  72                 pwms = <&pwm1 0 1000000>;
  73                 color = <LED_COLOR_ID_RED>;
  74             };
  75
  76             led-green {
  77                 pwms = <&pwm2 0 1000000>;
  78                 color = <LED_COLOR_ID_GREEN>;
  79             };
  80
  81             led-blue {
  82                 pwms = <&pwm3 0 1000000>;
  83                 color = <LED_COLOR_ID_BLUE>;
  84             };
  85         };
  86     };
  87
  88 ...