About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / devicetree / bindings / regulator / regulator.txt




Custom Search

Based on kernel version 3.13. Page generated on 2014-01-20 22:01 EST.

1	Voltage/Current Regulators
2	
3	Optional properties:
4	- regulator-name: A string used as a descriptive name for regulator outputs
5	- regulator-min-microvolt: smallest voltage consumers may set
6	- regulator-max-microvolt: largest voltage consumers may set
7	- regulator-microvolt-offset: Offset applied to voltages to compensate for voltage drops
8	- regulator-min-microamp: smallest current consumers may set
9	- regulator-max-microamp: largest current consumers may set
10	- regulator-always-on: boolean, regulator should never be disabled
11	- regulator-boot-on: bootloader/firmware enabled regulator
12	- regulator-allow-bypass: allow the regulator to go into bypass mode
13	- <name>-supply: phandle to the parent supply/regulator node
14	- regulator-ramp-delay: ramp delay for regulator(in uV/uS)
15	  For hardwares which support disabling ramp rate, it should be explicitly
16	  intialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay.
17	- regulator-enable-ramp-delay: The time taken, in microseconds, for the supply
18	  rail to reach the target voltage, plus/minus whatever tolerance the board
19	  design requires. This property describes the total system ramp time
20	  required due to the combination of internal ramping of the regulator itself,
21	  and board design issues such as trace capacitance and load on the supply.
22	
23	Deprecated properties:
24	- regulator-compatible: If a regulator chip contains multiple
25	  regulators, and if the chip's binding contains a child node that
26	  describes each regulator, then this property indicates which regulator
27	  this child node is intended to configure. If this property is missing,
28	  the node's name will be used instead.
29	
30	Example:
31	
32		xyzreg: regulator@0 {
33			regulator-min-microvolt = <1000000>;
34			regulator-max-microvolt = <2500000>;
35			regulator-always-on;
36			vin-supply = <&vin>;
37		};
38	
39	Regulator Consumers:
40	Consumer nodes can reference one or more of its supplies/
41	regulators using the below bindings.
42	
43	- <name>-supply: phandle to the regulator node
44	
45	These are the same bindings that a regulator in the above
46	example used to reference its own supply, in which case
47	its just seen as a special case of a regulator being a
48	consumer itself.
49	
50	Example of a consumer device node (mmc) referencing two
51	regulators (twl_reg1 and twl_reg2),
52	
53		twl_reg1: regulator@0 {
54			...
55			...
56			...
57		};
58	
59		twl_reg2: regulator@1 {
60			...
61			...
62			...
63		};
64	
65		mmc: mmc@0x0 {
66			...
67			...
68			vmmc-supply = <&twl_reg1>;
69			vmmcaux-supply = <&twl_reg2>;
70		};
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.