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