Documentation/devicetree/bindings/mfd/maxim,max77693.yaml

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