Documentation/devicetree/bindings/leds/leds-pwm.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.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: LEDs connected to PWM
   8
   9 maintainers:
  10   - Pavel Machek <pavel@ucw.cz>
  11
  12 description:
  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
  16 properties:
  17   compatible:
  18     const: pwm-leds
  19
  20 patternProperties:
  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     required:
  44       - pwms
  45       - max-brightness
  46
  47 additionalProperties: false
  48
  49 examples:
  50   - |
  51
  52     #include <dt-bindings/leds/common.h>
  53
  54     led-controller {
  55         compatible = "pwm-leds";
  56
  57         led-1 {
  58             label = "omap4::keypad";
  59             pwms = <&twl_pwm 0 7812500>;
  60             max-brightness = <127>;
  61         };
  62
  63         led-2 {
  64             color = <LED_COLOR_ID_GREEN>;
  65             function = LED_FUNCTION_CHARGING;
  66             pwms = <&twl_pwmled 0 7812500>;
  67             max-brightness = <255>;
  68         };
  69     };
  70
  71 ...