Documentation/devicetree/bindings/mfd/s2mps11.txt

   1
   2 * Samsung S2MPS11, S2MPS14 and S2MPU02 Voltage and Current Regulator
   3
   4 The Samsung S2MPS11 is a multi-function device which includes voltage and
   5 current regulators, RTC, charger controller and other sub-blocks. It is
   6 interfaced to the host controller using an I2C interface. Each sub-block is
   7 addressed by the host system using different I2C slave addresses.
   8
   9 Required properties:
  10 - compatible: Should be "samsung,s2mps11-pmic" or "samsung,s2mps14-pmic"
  11               or "samsung,s2mpu02-pmic".
  12 - reg: Specifies the I2C slave address of the pmic block. It should be 0x66.
  13
  14 Optional properties:
  15 - interrupt-parent: Specifies the phandle of the interrupt controller to which
  16   the interrupts from s2mps11 are delivered to.
  17 - interrupts: Interrupt specifiers for interrupt sources.
  18
  19 Optional nodes:
  20 - clocks: s2mps11 and s5m8767 provide three(AP/CP/BT) buffered 32.768 KHz
  21   outputs, so to register these as clocks with common clock framework
  22   instantiate a sub-node named "clocks". It uses the common clock binding
  23   documented in :
  24   [Documentation/devicetree/bindings/clock/clock-bindings.txt]
  25   The s2mps14 provides two (AP/BT) buffered 32.768 KHz outputs.
  26   - #clock-cells: should be 1.
  27
  28   - The following is the list of clocks generated by the controller. Each clock
  29     is assigned an identifier and client nodes use this identifier to specify
  30     the clock which they consume.
  31     Clock               ID           Devices
  32     ----------------------------------------------------------
  33     32KhzAP             0            S2MPS11, S2MPS14, S5M8767
  34     32KhzCP             1            S2MPS11, S5M8767
  35     32KhzBT             2            S2MPS11, S2MPS14, S5M8767
  36
  37   - compatible: Should be one of: "samsung,s2mps11-clk", "samsung,s2mps14-clk",
  38                 "samsung,s5m8767-clk"
  39
  40 - regulators: The regulators of s2mps11 that have to be instantiated should be
  41 included in a sub-node named 'regulators'. Regulator nodes included in this
  42 sub-node should be of the format as listed below.
  43
  44         regulator_name {
  45                 [standard regulator constraints....];
  46         };
  47
  48  regulator-ramp-delay for BUCKs = [6250/12500/25000(default)/50000] uV/us
  49
  50  BUCK[2/3/4/6] supports disabling ramp delay on hardware, so explictly
  51  regulator-ramp-delay = <0> can be used for them to disable ramp delay.
  52  In the absence of the regulator-ramp-delay property, the default ramp
  53  delay will be used.
  54
  55 NOTE: Some BUCKs share the ramp rate setting i.e. same ramp value will be set
  56 for a particular group of BUCKs. So provide same regulator-ramp-delay<value>.
  57 Grouping of BUCKs sharing ramp rate setting is as follow : BUCK[1, 6],
  58 BUCK[3, 4], and BUCK[7, 8, 10]
  59
  60 On S2MPS14 the LDO10, LDO11 and LDO12 can be configured to external control
  61 over GPIO. To turn this feature on this property must be added to the regulator
  62 sub-node:
  63         - samsung,ext-control-gpios: GPIO specifier for one GPIO
  64                 controlling this regulator (enable/disable);
  65 Example:
  66         LDO12 {
  67                 regulator-name = "V_EMMC_2.8V";
  68                 regulator-min-microvolt = <2800000>;
  69                 regulator-max-microvolt = <2800000>;
  70                 samsung,ext-control-gpios = <&gpk0 2 0>;
  71         };
  72
  73
  74 The regulator constraints inside the regulator nodes use the standard regulator
  75 bindings which are documented elsewhere.
  76
  77 The following are the names of the regulators that the s2mps11 pmic block
  78 supports. Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
  79 as per the datasheet of s2mps11.
  80
  81         - LDOn
  82                   - valid values for n are:
  83                         - S2MPS11: 1 to 38
  84                         - S2MPS14: 1 to 25
  85                         - S2MPU02: 1 to 28
  86                   - Example: LDO1, LDO2, LDO28
  87         - BUCKn
  88                   - valid values for n are:
  89                         - S2MPS11: 1 to 10
  90                         - S2MPS14: 1 to 5
  91                         - S2MPU02: 1 to 7
  92                   - Example: BUCK1, BUCK2, BUCK9
  93
  94 Example:
  95
  96         s2mps11_pmic@66 {
  97                 compatible = "samsung,s2mps11-pmic";
  98                 reg = <0x66>;
  99
 100                 s2m_osc: clocks {
 101                         compatible = "samsung,s2mps11-clk";
 102                         #clock-cells = <1>;
 103                         clock-output-names = "xx", "yy", "zz";
 104                 };
 105
 106                 regulators {
 107                         ldo1_reg: LDO1 {
 108                                 regulator-name = "VDD_ABB_3.3V";
 109                                 regulator-min-microvolt = <3300000>;
 110                                 regulator-max-microvolt = <3300000>;
 111                         };
 112
 113                         ldo2_reg: LDO2 {
 114                                 regulator-name = "VDD_ALIVE_1.1V";
 115                                 regulator-min-microvolt = <1100000>;
 116                                 regulator-max-microvolt = <1100000>;
 117                                 regulator-always-on;
 118                         };
 119
 120                         buck1_reg: BUCK1 {
 121                                 regulator-name = "vdd_mif";
 122                                 regulator-min-microvolt = <950000>;
 123                                 regulator-max-microvolt = <1350000>;
 124                                 regulator-always-on;
 125                                 regulator-boot-on;
 126                         };
 127
 128                         buck2_reg: BUCK2 {
 129                                 regulator-name = "vdd_arm";
 130                                 regulator-min-microvolt = <950000>;
 131                                 regulator-max-microvolt = <1350000>;
 132                                 regulator-always-on;
 133                                 regulator-boot-on;
 134                                 regulator-ramp-delay = <50000>;
 135                         };
 136                 };
 137         };