GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / leds / leds-sgm3140.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-sgm3140.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: SGMICRO SGM3140 500mA Buck/Boost Charge Pump LED Driver
8
9 maintainers:
10   - Luca Weiss <luca@z3ntu.xyz>
11
12 description: |
13   The SGM3140 is a current-regulated charge pump which can regulate two current
14   levels for Flash and Torch modes.
15
16   The data sheet can be found at:
17     http://www.sg-micro.com/uploads/soft/20190626/1561535688.pdf
18
19 properties:
20   compatible:
21     enum:
22       - ocs,ocp8110
23       - richtek,rt5033-led
24       - sgmicro,sgm3140
25
26   enable-gpios:
27     maxItems: 1
28     description: A connection to the 'EN' pin.
29
30   flash-gpios:
31     maxItems: 1
32     description: A connection to the 'FLASH' pin.
33
34   vin-supply:
35     description: Regulator providing power to the 'VIN' pin.
36
37   led:
38     type: object
39     $ref: common.yaml#
40     unevaluatedProperties: false
41
42 required:
43   - compatible
44   - flash-gpios
45   - enable-gpios
46
47 additionalProperties: false
48
49 examples:
50   - |
51     #include <dt-bindings/gpio/gpio.h>
52     #include <dt-bindings/leds/common.h>
53
54     led-controller {
55         compatible = "sgmicro,sgm3140";
56         flash-gpios = <&pio 3 24 GPIO_ACTIVE_HIGH>; /* PD24 */
57         enable-gpios = <&pio 2 3 GPIO_ACTIVE_HIGH>; /* PC3 */
58         vin-supply = <&reg_dcdc1>;
59
60         sgm3140_flash: led {
61             function = LED_FUNCTION_FLASH;
62             color = <LED_COLOR_ID_WHITE>;
63             flash-max-timeout-us = <250000>;
64         };
65     };