xref: /openbmc/linux/Documentation/devicetree/bindings/mfd/maxim,max77693.yaml (revision da7ee30ae6662f016f28a9ef090b2132b3c0fb48) 
1# SPDX-License-Identifier: GPL-2.0-only
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mfd/maxim,max77693.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Maxim MAX77693 MicroUSB and Companion Power Management IC
8
9maintainers:
10  - Chanwoo Choi <cw00.choi@samsung.com>
11  - Krzysztof Kozlowski <krzk@kernel.org>
12
13description: |
14  This is a part of device tree bindings for Maxim MAX77693 MicroUSB
15  Integrated Circuit (MUIC).
16
17  The Maxim MAX77693 is a MicroUSB and Companion Power Management IC which
18  includes voltage current regulators, charger, LED/flash, haptic motor driver
19  and MicroUSB management IC.
20
21properties:
22  compatible:
23    const: maxim,max77693
24
25  interrupts:
26    maxItems: 1
27
28  reg:
29    maxItems: 1
30
31  charger:
32    $ref: /schemas/power/supply/maxim,max77693.yaml
33
34  connector:
35    $ref: /schemas/connector/usb-connector.yaml#
36    unevaluatedProperties: false
37
38  led:
39    $ref: /schemas/leds/maxim,max77693.yaml
40
41  max77693-muic:
42    type: object
43    additionalProperties: false
44
45    properties:
46      compatible:
47        const: maxim,max77693-muic
48
49    required:
50      - compatible
51
52  motor-driver:
53    type: object
54    additionalProperties: false
55
56    properties:
57      compatible:
58        const: maxim,max77693-haptic
59
60      haptic-supply:
61        description: Power supply to the haptic motor
62
63      pwms:
64        maxItems: 1
65
66    required:
67      - compatible
68      - haptic-supply
69      - pwms
70
71  regulators:
72    $ref: ../regulator/maxim,max77693.yaml
73    description:
74      List of child nodes that specify the regulators.
75
76required:
77  - compatible
78  - interrupts
79  - reg
80
81additionalProperties: false
82
83examples:
84  - |
85    #include <dt-bindings/interrupt-controller/irq.h>
86    #include <dt-bindings/leds/common.h>
87
88    i2c {
89        #address-cells = <1>;
90        #size-cells = <0>;
91
92        pmic@66 {
93            compatible = "maxim,max77693";
94            reg = <0x66>;
95            interrupt-parent = <&gpx1>;
96            interrupts = <5 IRQ_TYPE_LEVEL_LOW>;
97
98            regulators {
99                ESAFEOUT1 {
100                    regulator-name = "ESAFEOUT1";
101                };
102
103                ESAFEOUT2 {
104                    regulator-name = "ESAFEOUT2";
105                };
106
107                CHARGER {
108                    regulator-name = "CHARGER";
109                    regulator-min-microamp = <60000>;
110                    regulator-max-microamp = <2580000>;
111                };
112            };
113
114            motor-driver {
115                compatible = "maxim,max77693-haptic";
116                haptic-supply = <&ldo26_reg>;
117                pwms = <&pwm 0 38022 0>;
118            };
119
120            charger {
121                compatible = "maxim,max77693-charger";
122
123                maxim,constant-microvolt = <4350000>;
124                maxim,min-system-microvolt = <3600000>;
125                maxim,thermal-regulation-celsius = <100>;
126                maxim,battery-overcurrent-microamp = <3500000>;
127                maxim,charge-input-threshold-microvolt = <4300000>;
128            };
129
130            led {
131                compatible = "maxim,max77693-led";
132                maxim,boost-mode = <LEDS_BOOST_FIXED>;
133                maxim,boost-mvout = <5000>;
134                maxim,mvsys-min = <2400>;
135
136                flash-led {
137                    label = "max77693-flash";
138                    function = LED_FUNCTION_FLASH;
139                    color = <LED_COLOR_ID_WHITE>;
140                    led-sources = <0>, <1>;
141                    led-max-microamp = <500000>;
142                    flash-max-microamp = <1250000>;
143                    flash-max-timeout-us = <1000000>;
144                };
145            };
146        };
147    };
148