[deliverable/linux.git] / Documentation / devicetree / bindings / regulator / gpio-regulator.txt

GPIO controlled regulators

Required properties:
- compatible		: Must be "regulator-gpio".
- states		: Selection of available voltages and GPIO configs.
                          if there are no states, then use a fixed regulator

Optional properties:
- enable-gpio		: GPIO to use to enable/disable the regulator.
- gpios			: GPIO group used to control voltage.
- gpios-states		: gpios pin's initial states array. 0: LOW, 1: HIGH.
			  defualt is LOW if nothing is specified.
- startup-delay-us	: Startup time in microseconds.
- enable-active-high	: Polarity of GPIO is active high (default is low).
- regulator-type	: Specifies what is being regulated, must be either
			  "voltage" or "current", defaults to current.

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;

		enable-gpio = <&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;
	};
Commit	Line	Data
006694d0 LJ	1	GPIO controlled regulators
	2
	3	Required properties:
	4	- compatible : Must be "regulator-gpio".
216f2b9c LJ	5	- states : Selection of available voltages and GPIO configs.
216f2b9c LJ	6	if there are no states, then use a fixed regulator
006694d0 LJ	7
006694d0 LJ	8	Optional properties:
dea05fe6	9	- enable-gpio : GPIO to use to enable/disable the regulator.
006694d0	10	- gpios : GPIO group used to control voltage.
90733981 KM	11	- gpios-states : gpios pin's initial states array. 0: LOW, 1: HIGH.
90733981 KM	12	defualt is LOW if nothing is specified.
006694d0 LJ	13	- startup-delay-us : Startup time in microseconds.
006694d0 LJ	14	- enable-active-high : Polarity of GPIO is active high (default is low).
7f196ec9 MB	15	- regulator-type : Specifies what is being regulated, must be either
7f196ec9 MB	16	"voltage" or "current", defaults to current.
006694d0 LJ	17
	18	Any property defined as part of the core regulator binding defined in
	19	regulator.txt can also be used.
	20
	21	Example:
	22
	23	mmciv: gpio-regulator {
	24	compatible = "regulator-gpio";
	25
	26	regulator-name = "mmci-gpio-supply";
	27	regulator-min-microvolt = <1800000>;
	28	regulator-max-microvolt = <2600000>;
	29	regulator-boot-on;
	30
dea05fe6	31	enable-gpio = <&gpio0 23 0x4>;
006694d0 LJ	32	gpios = <&gpio0 24 0x4
	33	&gpio0 25 0x4>;
	34	states = <1800000 0x3
	35	2200000 0x2
	36	2600000 0x1
	37	2900000 0x0>;
	38
	39	startup-delay-us = <100000>;
	40	enable-active-high;
	41	};