Commit 5d1d147f authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Lee Jones
Browse files

dt-bindings: regulator/mfd: Reorganize S2MPA01 bindings 



The mfd/s2mpa01.txt duplicates some of the information about bindings
with old mfd/s2mps11.txt. Now common part exists entirely in
mfd/samsung,sec-core.txt so:
 - add company prefix to file name (regulator/samsung,s2mpa01.txt),
 - remove duplicated information,
 - reorganize the contents to match style of
   regulator/samsung,s2mps11.txt.

Signed-off-by: default avatarKrzysztof Kozlowski <k.kozlowski@samsung.com>
Acked-by: default avatarMark Brown <broonie@kernel.org>
Acked-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
parent 27383ca9

Documentation/devicetree/bindings/mfd/samsung,sec-core.txt

+3 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ Binding for Samsung S2M and S5M family multi-function device 
This is a part of device tree bindings for S2M and S5M family multi-function

devices.



The Samsung S2MPS11/13/14/15, S2MPU02 and S5M8767 is a family

The Samsung S2MPA01, S2MPS11/13/14/15, S2MPU02 and S5M8767 is a family

of multi-function devices which include voltage and current regulators, RTC,

charger controller, clock outputs and other sub-blocks. It is interfaced

to the host controller using an I2C interface. Each sub-block is usually
@@ -13,6 +13,7 @@ addressed by the host system using different I2C slave addresses. 


This document describes bindings for main device node. Optional sub-blocks

must be a sub-nodes to it. Bindings for them can be found in:

 - bindings/regulator/samsung,s2mpa01.txt

 - bindings/regulator/samsung,s2mps11.txt

 - bindings/regulator/samsung,s5m8767.txt

 - bindings/clock/samsung,s2mps11.txt
@@ -20,6 +21,7 @@ must be a sub-nodes to it. Bindings for them can be found in: 


Required properties:

 - compatible: Should be one of the following

	- "samsung,s2mpa01-pmic",

	- "samsung,s2mps11-pmic",

	- "samsung,s2mps13-pmic",

	- "samsung,s2mps14-pmic",

Documentation/devicetree/bindings/mfd/s2mpa01.txt→Documentation/devicetree/bindings/regulator/samsung,s2mpa01.txt

+79 −0
Original line number Diff line number Diff line 
Binding for Samsung S2MPA01 regulator block

===========================================



* Samsung S2MPA01 Voltage and Current Regulator

This is a part of device tree bindings for S2M family multi-function devices.

More information can be found in bindings/mfd/sec-core.txt file.



The Samsung S2MPA01 is a multi-function device which includes high

efficiency buck converters including Dual-Phase buck converter, various LDOs,

and an RTC. It is interfaced to the host controller using an I2C interface.

Each sub-block is addressed by the host system using different I2C slave

addresses.

The S2MPA01 device provide buck and LDO regulators.



Required properties:

- compatible: Should be "samsung,s2mpa01-pmic".

- reg: Specifies the I2C slave address of the PMIC block. It should be 0x66.

To register these with regulator framework instantiate under main device node

a sub-node named "regulators" with more sub-nodes for each regulator using the

common regulator binding documented in:

 - Documentation/devicetree/bindings/regulator/regulator.txt



Optional properties:

- interrupt-parent: Specifies the phandle of the interrupt controller to which

  the interrupts from s2mpa01 are delivered to.

- interrupts: An interrupt specifier for the sole interrupt generated by the

  device.



Optional nodes:

- regulators: The regulators of s2mpa01 that have to be instantiated should be

  included in a sub-node named 'regulators'. Regulator nodes and constraints

  included in this sub-node use the standard regulator bindings which are

  documented elsewhere.

Names of regulators supported by S2MPA01 device:

	- LDOn

		  - valid values for n are 1 to 26

		  - Example: LDO1, LD02, LDO26

	- BUCKn

		  - valid values for n are 1 to 10.

		  - Example: BUCK1, BUCK2, BUCK9

Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number

as per the datasheet of device.



Properties for BUCK regulator nodes:



Optional properties of buck regulator nodes under "regulators" sub-node:

 - regulator-ramp-delay: ramp delay in uV/us. May be 6250, 12500

   (default), 25000, or 50000. May be 0 for disabling the ramp delay on

   BUCK{1,2,3,4}.
@@ -31,24 +31,13 @@ Properties for BUCK regulator nodes: 
   In the absence of the regulator-ramp-delay property, the default ramp

   delay will be used.



  NOTE: Some BUCKs share the ramp rate setting i.e. same ramp value will be set

  for a particular group of BUCKs. So provide same regulator-ramp-delay=<value>.



  The following BUCKs share ramp settings:

  * 1 and 6

  * 2 and 4

  * 8, 9, and 10



The following are the names of the regulators that the s2mpa01 PMIC block

supports. Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number

as per the datasheet of s2mpa01.



	- LDOn

		  - valid values for n are 1 to 26

		  - Example: LDO1, LD02, LDO26

	- BUCKn

		  - valid values for n are 1 to 10.

		  - Example: BUCK1, BUCK2, BUCK9

   Note: Some bucks share the ramp rate setting i.e. same ramp value

   will be set for a particular group of bucks so provide the same

   regulator-ramp-delay value for them.

   Groups sharing ramp rate:

    - buck{1,6},

    - buck{2,4},

    - buck{8,9,10}.



Example:

CRA Git | Maintained and supported by SUSTech CRA and CCSE