Documentation/devicetree/bindings/leds/kinetic,ktd2692.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/kinetic,ktd2692.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: KTD2692 Flash LED Driver from Kinetic Technologies
   8
   9 maintainers:
  10   - Markuss Broks <markuss.broks@gmail.com>
  11
  12 description: |
  13   KTD2692 is the ideal power solution for high-power flash LEDs.
  14   It uses ExpressWire single-wire programming for maximum flexibility.
  15
  16   The ExpressWire interface through CTRL pin can control LED on/off and
  17   enable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
  18   Flash timeout, LVP(low voltage protection).
  19
  20   Also, When the AUX pin is pulled high while CTRL pin is high,
  21   LED current will be ramped up to the flash-mode current level.
  22
  23 properties:
  24   compatible:
  25     const: kinetic,ktd2692
  26
  27   ctrl-gpios:
  28     maxItems: 1
  29     description: Specifier of the GPIO connected to CTRL pin.
  30
  31   aux-gpios:
  32     maxItems: 1
  33     description: Specifier of the GPIO connected to CTRL pin.
  34
  35   vin-supply:
  36     description: LED supply (2.7V to 5.5V).
  37
  38   led:
  39     type: object
  40     $ref: common.yaml#
  41     description: Properties for the LED.
  42     properties:
  43       function: true
  44       color: true
  45       flash-max-timeout-us:
  46         description: Flash LED maximum timeout.
  47
  48       led-max-microamp:
  49         maximum: 300000
  50         description: Minimum Threshold for Timer protection
  51           is defined internally (Maximum 300mA).
  52
  53       flash-max-microamp:
  54         maximum: 300000
  55         description: Flash LED maximum current
  56           Formula - I(uA) = 15000000 / Rset.
  57
  58     additionalProperties: false
  59
  60 required:
  61   - compatible
  62   - ctrl-gpios
  63   - led
  64
  65 additionalProperties: false
  66
  67 examples:
  68   - |
  69     #include <dt-bindings/gpio/gpio.h>
  70     #include <dt-bindings/leds/common.h>
  71
  72     ktd2692 {
  73       compatible = "kinetic,ktd2692";
  74       ctrl-gpios = <&gpc0 1 0>;
  75       aux-gpios = <&gpc0 2 0>;
  76       vin-supply = <&vbat>;
  77
  78       led {
  79         function = LED_FUNCTION_FLASH;
  80         color = <LED_COLOR_ID_WHITE>;
  81         flash-max-timeout-us = <250000>;
  82         flash-max-microamp = <150000>;
  83         led-max-microamp = <25000>;
  84       };
  85     };
  86
  87 ...