Merge tag 'docs-5.11-2' of git://git.lwn.net/linux
[linux-2.6-microblaze.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     const: sgmicro,sgm3140
22
23   enable-gpios:
24     maxItems: 1
25     description: A connection to the 'EN' pin.
26
27   flash-gpios:
28     maxItems: 1
29     description: A connection to the 'FLASH' pin.
30
31   vin-supply:
32     description: Regulator providing power to the 'VIN' pin.
33
34   led:
35     type: object
36     $ref: common.yaml#
37
38 required:
39   - compatible
40   - flash-gpios
41   - enable-gpios
42
43 additionalProperties: false
44
45 examples:
46   - |
47     #include <dt-bindings/gpio/gpio.h>
48     #include <dt-bindings/leds/common.h>
49
50     led-controller {
51         compatible = "sgmicro,sgm3140";
52         flash-gpios = <&pio 3 24 GPIO_ACTIVE_HIGH>; /* PD24 */
53         enable-gpios = <&pio 2 3 GPIO_ACTIVE_HIGH>; /* PC3 */
54         vin-supply = <&reg_dcdc1>;
55
56         sgm3140_flash: led {
57             function = LED_FUNCTION_FLASH;
58             color = <LED_COLOR_ID_WHITE>;
59             flash-max-timeout-us = <250000>;
60         };
61     };