Documentation/devicetree/bindings/mfd/max77693.txt

   1 Maxim MAX77693 multi-function device
   2
   3 MAX77693 is a Multifunction device with the following submodules:
   4 - PMIC,
   5 - CHARGER,
   6 - LED,
   7 - MUIC,
   8 - HAPTIC
   9
  10 It is interfaced to host controller using i2c.
  11 This document describes the bindings for the mfd device.
  12
  13 Required properties:
  14 - compatible : Must be "maxim,max77693".
  15 - reg : Specifies the i2c slave address of PMIC block.
  16 - interrupts : This i2c device has an IRQ line connected to the main SoC.
  17 - interrupt-parent :  The parent interrupt controller.
  18
  19 Optional properties:
  20 - regulators : The regulators of max77693 have to be instantiated under subnod
  21   named "regulators" using the following format.
  22
  23         regulators {
  24                 regualtor-compatible = ESAFEOUT1/ESAFEOUT2/CHARGER
  25                 standard regulator constratints[*].
  26         };
  27
  28         [*] refer Documentation/devicetree/bindings/regulator/regulator.txt
  29
  30 - haptic : The MAX77693 haptic device utilises a PWM controlled motor to provide
  31   users with tactile feedback. PWM period and duty-cycle are varied in
  32   order to provide the approprite level of feedback.
  33
  34  Required properties:
  35         - compatible : Must be "maxim,max77693-hpatic"
  36         - haptic-supply : power supply for the haptic motor
  37         [*] refer Documentation/devicetree/bindings/regulator/regulator.txt
  38         - pwms : phandle to the physical PWM(Pulse Width Modulation) device.
  39          PWM properties should be named "pwms". And number of cell is different
  40          for each pwm device.
  41          To get more informations, please refer to documentaion.
  42         [*] refer Documentation/devicetree/bindings/pwm/pwm.txt
  43
  44 Example:
  45         max77693@66 {
  46                 compatible = "maxim,max77693";
  47                 reg = <0x66>;
  48                 interrupt-parent = <&gpx1>;
  49                 interrupts = <5 2>;
  50
  51                 regulators {
  52                         esafeout@1 {
  53                                 regulator-compatible = "ESAFEOUT1";
  54                                 regulator-name = "ESAFEOUT1";
  55                                 regulator-boot-on;
  56                         };
  57                         esafeout@2 {
  58                                 regulator-compatible = "ESAFEOUT2";
  59                                 regulator-name = "ESAFEOUT2";
  60                                 };
  61                         charger@0 {
  62                                 regulator-compatible = "CHARGER";
  63                                 regulator-name = "CHARGER";
  64                                 regulator-min-microamp = <60000>;
  65                                 regulator-max-microamp = <2580000>;
  66                                         regulator-boot-on;
  67                         };
  68                 };
  69
  70                 haptic {
  71                         compatible = "maxim,max77693-haptic";
  72                         haptic-supply = <&haptic_supply>;
  73                         pwms = <&pwm 0 40000 0>;
  74                         pwm-names = "haptic";
  75                 };
  76         };