diff mbox

[v4,11/14] regulator: max77802: Document binding for regulator operating modes

Message ID 1415025649-8119-12-git-send-email-javier.martinez@collabora.co.uk
State Superseded, archived
Headers show

Commit Message

Javier Martinez Canillas Nov. 3, 2014, 2:40 p.m. UTC
Some regulators from the max77802 PMIC support to be configured in one
of two operating mode: Output ON (normal) and Output On Low Power Mode.
Not all regulators support these two modes and for some of them, the
mode can be changed while the system is running in normal operation
while others only support their mode to be changed on system suspend.

Extend the max77802 PMIC bindin by documenting the possible operating
modes values so the regulators modes can be correctly configured.

Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
---

Changes in v4: None

Changes in v3:
 - Use the standard suspend states bindings as suggested by Mark Brown.

 .../devicetree/bindings/regulator/max77802.txt     | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)

Comments

Krzysztof Kozlowski Nov. 4, 2014, 10:50 a.m. UTC | #1
On pon, 2014-11-03 at 15:40 +0100, Javier Martinez Canillas wrote:
> Some regulators from the max77802 PMIC support to be configured in one
> of two operating mode: Output ON (normal) and Output On Low Power Mode.
> Not all regulators support these two modes and for some of them, the
> mode can be changed while the system is running in normal operation
> while others only support their mode to be changed on system suspend.
> 
> Extend the max77802 PMIC bindin by documenting the possible operating
> modes values so the regulators modes can be correctly configured.
> 
> Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
> ---
> 
> Changes in v4: None
> 
> Changes in v3:
>  - Use the standard suspend states bindings as suggested by Mark Brown.
> 
>  .../devicetree/bindings/regulator/max77802.txt     | 33 ++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/regulator/max77802.txt b/Documentation/devicetree/bindings/regulator/max77802.txt
> index 5aeaffc..1a78ec2 100644
> --- a/Documentation/devicetree/bindings/regulator/max77802.txt
> +++ b/Documentation/devicetree/bindings/regulator/max77802.txt
> @@ -25,6 +25,27 @@ with their hardware counterparts as follow. The valid names are:
>  			example: LDO1, LDO2, LDO35.
>  	-BUCKn 	:	for BUCKs, where n can lie in range 1 to 10.
>  			example: BUCK1, BUCK5, BUCK10.
> +
> +The max77802 regulator supports two different operating modes: Normal and Low
> +Power Mode. Some regulators support the modes to be changed at startup or by
> +the consumers during normal operation while others only support to change the
> +mode during system suspend. The standard regulator suspend states binding can
> +be used to configure the regulator operating mode.
> +
> +The regulators that support the standard "regulator-initial-mode" property,
> +changing their mode during normal operation are: LDOs 1, 3, 20 and 21.
> +
> +The possible values for "regulator-initial-mode" and "regulator-mode" are:
> +	1: Normal regulator voltage output mode.
> +	3: Low Power which reduces the quiescent current down to only 1uA
> +
> +The list of valid modes are defined in the dt-bindings/regulator/regulator.h
> +header and can be included by device tree source files.

The more he looked inside, the more regulator.h wasn't there.

Best regards,
Krzysztof



--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Javier Martinez Canillas Nov. 4, 2014, 11:10 a.m. UTC | #2
Hello Krzysztof,

On 11/04/2014 11:50 AM, Krzysztof Kozlowski wrote:
>> +
>> +The possible values for "regulator-initial-mode" and "regulator-mode" are:
>> +	1: Normal regulator voltage output mode.
>> +	3: Low Power which reduces the quiescent current down to only 1uA
>> +
>> +The list of valid modes are defined in the dt-bindings/regulator/regulator.h
>> +header and can be included by device tree source files.
> 
> The more he looked inside, the more regulator.h wasn't there.
> 

Right, that's a typo from when the documentation was updated since previous
versions used the standard modes instead of hardware specific modes.

Should say that are defined in include/dt-bindings/regulator/maxim,max77802.h
instead, sorry about that.

Best regards,
Javier

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/regulator/max77802.txt b/Documentation/devicetree/bindings/regulator/max77802.txt
index 5aeaffc..1a78ec2 100644
--- a/Documentation/devicetree/bindings/regulator/max77802.txt
+++ b/Documentation/devicetree/bindings/regulator/max77802.txt
@@ -25,6 +25,27 @@  with their hardware counterparts as follow. The valid names are:
 			example: LDO1, LDO2, LDO35.
 	-BUCKn 	:	for BUCKs, where n can lie in range 1 to 10.
 			example: BUCK1, BUCK5, BUCK10.
+
+The max77802 regulator supports two different operating modes: Normal and Low
+Power Mode. Some regulators support the modes to be changed at startup or by
+the consumers during normal operation while others only support to change the
+mode during system suspend. The standard regulator suspend states binding can
+be used to configure the regulator operating mode.
+
+The regulators that support the standard "regulator-initial-mode" property,
+changing their mode during normal operation are: LDOs 1, 3, 20 and 21.
+
+The possible values for "regulator-initial-mode" and "regulator-mode" are:
+	1: Normal regulator voltage output mode.
+	3: Low Power which reduces the quiescent current down to only 1uA
+
+The list of valid modes are defined in the dt-bindings/regulator/regulator.h
+header and can be included by device tree source files.
+
+The standard "regulator-mode" property can only be used for regulators that
+support changing their mode to Low Power Mode during suspend. These regulators
+are: BUCKs 2-4 and LDOs 1-35.
+
 Example:
 
 	max77802@09 {
@@ -36,11 +57,23 @@  Example:
 		#size-cells = <0>;
 
 		regulators {
+			ldo1_reg: LDO1 {
+				regulator-name = "vdd_1v0";
+				regulator-min-microvolt = <1000000>;
+				regulator-max-microvolt = <1000000>;
+				regulator-always-on;
+				regulator-initial-mode = <MAX77802_OPMODE_LP>;
+			};
+
 			ldo11_reg: LDO11 {
 				regulator-name = "vdd_ldo11";
 				regulator-min-microvolt = <1900000>;
 				regulator-max-microvolt = <1900000>;
 				regulator-always-on;
+				regulator-state-mem {
+					regulator-on-in-suspend;
+					regulator-mode = <MAX77802_OPMODE_LP>;
+				};
 			};
 
 			buck1_reg: BUCK1 {