diff mbox

[1/1] Documentation: Describe Device Tree bindings for GPIO Regulator driver

Message ID 1350374553-12678-1-git-send-email-lee.jones@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

Lee Jones Oct. 16, 2012, 8:02 a.m. UTC
Here we specify all non-standard bindings which can be used when
requesting the use of an GPIO controlled regulator from Device Tree.

Cc: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 .../bindings/regulator/gpio-regulator.txt          |   36 ++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/regulator/gpio-regulator.txt

Comments

Stephen Warren Oct. 16, 2012, 3:48 p.m. UTC | #1
On 10/16/2012 02:02 AM, Lee Jones wrote:
> Here we specify all non-standard bindings which can be used when
> requesting the use of an GPIO controlled regulator from Device Tree.

FWIW since I commented on this before and accidentally noticed the
repost, the binding looks fine to me now. So, this patch,

Reviewed-by: Stephen Warren <swarren@nvidia.com>
Mark Brown Oct. 17, 2012, 1:27 p.m. UTC | #2
On Tue, Oct 16, 2012 at 09:02:33AM +0100, Lee Jones wrote:
> Here we specify all non-standard bindings which can be used when
> requesting the use of an GPIO controlled regulator from Device Tree.

Applied both patches squashed together, thanks.  Please don't split
documentation from the code like this where the code is just a single
change - it's sensible where the code is a big series but for single
patch it's not helpful.

Given the subject line I'd be extremely likely to delete this patch
unread, Documentation: says "this isn't relevant".
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/regulator/gpio-regulator.txt b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt
new file mode 100644
index 0000000..3703be2
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt
@@ -0,0 +1,36 @@ 
+GPIO controlled regulators
+
+Required properties:
+- compatible		: Must be "regulator-gpio".
+
+Optional properties:
+- gpio-enable		: GPIO to use to enable/disable the regulator.
+- gpios			: GPIO group used to control voltage.
+- states		: Selection of available voltages and GPIO configs.
+- startup-delay-us	: Startup time in microseconds.
+- enable-active-high	: Polarity of GPIO is active high (default is low).
+
+Any property defined as part of the core regulator binding defined in
+regulator.txt can also be used.
+
+Example:
+
+	mmciv: gpio-regulator {
+		compatible = "regulator-gpio";
+
+		regulator-name = "mmci-gpio-supply";
+		regulator-min-microvolt = <1800000>;
+		regulator-max-microvolt = <2600000>;
+		regulator-boot-on;
+
+		gpio-enable = <&gpio0 23 0x4>;
+		gpios = <&gpio0 24 0x4
+			 &gpio0 25 0x4>;
+		states = <1800000 0x3
+			  2200000 0x2
+			  2600000 0x1
+			  2900000 0x0>;
+
+		startup-delay-us = <100000>;
+		enable-active-high;
+	};