About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / devicetree / bindings / regulator / regulator.txt




Custom Search

Based on kernel version 4.8. Page generated on 2016-10-06 23:14 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-input-current-limit-microamp: maximum input current regulator allows
11	- regulator-always-on: boolean, regulator should never be disabled
12	- regulator-boot-on: bootloader/firmware enabled regulator
13	- regulator-allow-bypass: allow the regulator to go into bypass mode
14	- regulator-allow-set-load: allow the regulator performance level to be configured
15	- <name>-supply: phandle to the parent supply/regulator node
16	- regulator-ramp-delay: ramp delay for regulator(in uV/uS)
17	  For hardware which supports disabling ramp rate, it should be explicitly
18	  initialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay.
19	- regulator-enable-ramp-delay: The time taken, in microseconds, for the supply
20	  rail to reach the target voltage, plus/minus whatever tolerance the board
21	  design requires. This property describes the total system ramp time
22	  required due to the combination of internal ramping of the regulator itself,
23	  and board design issues such as trace capacitance and load on the supply.
24	- regulator-soft-start: Enable soft start so that voltage ramps slowly
25	- regulator-state-mem sub-root node for Suspend-to-RAM mode
26	  : suspend to memory, the device goes to sleep, but all data stored in memory,
27	  only some external interrupt can wake the device.
28	- regulator-state-disk sub-root node for Suspend-to-DISK mode
29	  : suspend to disk, this state operates similarly to Suspend-to-RAM,
30	  but includes a final step of writing memory contents to disk.
31	- regulator-state-[mem/disk] node has following common properties:
32		- regulator-on-in-suspend: regulator should be on in suspend state.
33		- regulator-off-in-suspend: regulator should be off in suspend state.
34		- regulator-suspend-microvolt: regulator should be set to this voltage
35		  in suspend.
36		- regulator-mode: operating mode in the given suspend state.
37		  The set of possible operating modes depends on the capabilities of
38		  every hardware so the valid modes are documented on each regulator
39		  device tree binding document.
40	- regulator-initial-mode: initial operating mode. The set of possible operating
41	  modes depends on the capabilities of every hardware so each device binding
42	  documentation explains which values the regulator supports.
43	- regulator-system-load: Load in uA present on regulator that is not captured by
44	  any consumer request.
45	- regulator-pull-down: Enable pull down resistor when the regulator is disabled.
46	- regulator-over-current-protection: Enable over current protection.
47	- regulator-active-discharge: tristate, enable/disable active discharge of
48	  regulators. The values are:
49		0: Disable active discharge.
50		1: Enable active discharge.
51		Absence of this property will leave configuration to default.
52	
53	Deprecated properties:
54	- regulator-compatible: If a regulator chip contains multiple
55	  regulators, and if the chip's binding contains a child node that
56	  describes each regulator, then this property indicates which regulator
57	  this child node is intended to configure. If this property is missing,
58	  the node's name will be used instead.
59	
60	Example:
61	
62		xyzreg: regulator@0 {
63			regulator-min-microvolt = <1000000>;
64			regulator-max-microvolt = <2500000>;
65			regulator-always-on;
66			vin-supply = <&vin>;
67	
68			regulator-state-mem {
69				regulator-on-in-suspend;
70			};
71		};
72	
73	Regulator Consumers:
74	Consumer nodes can reference one or more of its supplies/
75	regulators using the below bindings.
76	
77	- <name>-supply: phandle to the regulator node
78	
79	These are the same bindings that a regulator in the above
80	example used to reference its own supply, in which case
81	its just seen as a special case of a regulator being a
82	consumer itself.
83	
84	Example of a consumer device node (mmc) referencing two
85	regulators (twl_reg1 and twl_reg2),
86	
87		twl_reg1: regulator@0 {
88			...
89			...
90			...
91		};
92	
93		twl_reg2: regulator@1 {
94			...
95			...
96			...
97		};
98	
99		mmc: mmc@0x0 {
100			...
101			...
102			vmmc-supply = <&twl_reg1>;
103			vmmcaux-supply = <&twl_reg2>;
104		};
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.