xref: /linux/Documentation/devicetree/bindings/mfd/maxim,max77693.yaml (revision ae22a94997b8a03dcb3c922857c203246711f9d4) 
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  led:
35    $ref: /schemas/leds/maxim,max77693.yaml
36
37  max77693-muic:
38    type: object
39    additionalProperties: false
40    deprecated: true
41
42    properties:
43      compatible:
44        const: maxim,max77693-muic
45
46    required:
47      - compatible
48
49  muic:
50    type: object
51    additionalProperties: false
52
53    properties:
54      compatible:
55        const: maxim,max77693-muic
56
57      connector:
58        $ref: /schemas/connector/usb-connector.yaml#
59        unevaluatedProperties: false
60
61    required:
62      - compatible
63
64  motor-driver:
65    type: object
66    additionalProperties: false
67
68    properties:
69      compatible:
70        const: maxim,max77693-haptic
71
72      haptic-supply:
73        description: Power supply to the haptic motor
74
75      pwms:
76        maxItems: 1
77
78    required:
79      - compatible
80      - haptic-supply
81      - pwms
82
83  regulators:
84    $ref: ../regulator/maxim,max77693.yaml
85    description:
86      List of child nodes that specify the regulators.
87
88required:
89  - compatible
90  - interrupts
91  - reg
92
93additionalProperties: false
94
95examples:
96  - |
97    #include <dt-bindings/interrupt-controller/irq.h>
98    #include <dt-bindings/leds/common.h>
99
100    i2c {
101        #address-cells = <1>;
102        #size-cells = <0>;
103
104        pmic@66 {
105            compatible = "maxim,max77693";
106            reg = <0x66>;
107            interrupt-parent = <&gpx1>;
108            interrupts = <5 IRQ_TYPE_LEVEL_LOW>;
109
110            regulators {
111                ESAFEOUT1 {
112                    regulator-name = "ESAFEOUT1";
113                };
114
115                ESAFEOUT2 {
116                    regulator-name = "ESAFEOUT2";
117                };
118
119                CHARGER {
120                    regulator-name = "CHARGER";
121                    regulator-min-microamp = <60000>;
122                    regulator-max-microamp = <2580000>;
123                };
124            };
125
126            muic {
127                compatible = "maxim,max77693-muic";
128
129                connector {
130                    compatible = "samsung,usb-connector-11pin",
131                                 "usb-b-connector";
132                    label = "micro-USB";
133                    type = "micro";
134
135                    ports {
136                        #address-cells = <1>;
137                        #size-cells = <0>;
138
139                        port@0 {
140                            reg = <0>;
141
142                            muic_to_usb: endpoint {
143                                remote-endpoint = <&usb_to_muic>;
144                            };
145                        };
146
147                        port@3 {
148                            reg = <3>;
149
150                            muic_to_mhl: endpoint {
151                                remote-endpoint = <&mhl_to_muic>;
152                            };
153                        };
154                    };
155                };
156            };
157
158            motor-driver {
159                compatible = "maxim,max77693-haptic";
160                haptic-supply = <&ldo26_reg>;
161                pwms = <&pwm 0 38022 0>;
162            };
163
164            charger {
165                compatible = "maxim,max77693-charger";
166
167                maxim,constant-microvolt = <4350000>;
168                maxim,min-system-microvolt = <3600000>;
169                maxim,thermal-regulation-celsius = <100>;
170                maxim,battery-overcurrent-microamp = <3500000>;
171                maxim,charge-input-threshold-microvolt = <4300000>;
172            };
173
174            led {
175                compatible = "maxim,max77693-led";
176                maxim,boost-mode = <LEDS_BOOST_FIXED>;
177                maxim,boost-mvout = <5000>;
178                maxim,mvsys-min = <2400>;
179
180                flash-led {
181                    label = "max77693-flash";
182                    function = LED_FUNCTION_FLASH;
183                    color = <LED_COLOR_ID_WHITE>;
184                    led-sources = <0>, <1>;
185                    led-max-microamp = <500000>;
186                    flash-max-microamp = <1250000>;
187                    flash-max-timeout-us = <1000000>;
188                };
189            };
190        };
191    };
192