About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / devicetree / bindings / regulator




Custom Search

Based on kernel version 4.13.3. Page generated on 2017-09-23 13:55 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-settling-time-us: Settling time, in microseconds, for voltage
25	  change if regulator have the constant time for any level voltage change.
26	  This is useful when regulator have exponential voltage change.
27	- regulator-settling-time-up-us: Settling time, in microseconds, for voltage
28	  increase if the regulator needs a constant time to settle after voltage
29	  increases of any level. This is useful for regulators with exponential
30	  voltage changes.
31	- regulator-settling-time-down-us: Settling time, in microseconds, for voltage
32	  decrease if the regulator needs a constant time to settle after voltage
33	  decreases of any level. This is useful for regulators with exponential
34	  voltage changes.
35	- regulator-soft-start: Enable soft start so that voltage ramps slowly
36	- regulator-state-mem sub-root node for Suspend-to-RAM mode
37	  : suspend to memory, the device goes to sleep, but all data stored in memory,
38	  only some external interrupt can wake the device.
39	- regulator-state-disk sub-root node for Suspend-to-DISK mode
40	  : suspend to disk, this state operates similarly to Suspend-to-RAM,
41	  but includes a final step of writing memory contents to disk.
42	- regulator-state-[mem/disk] node has following common properties:
43		- regulator-on-in-suspend: regulator should be on in suspend state.
44		- regulator-off-in-suspend: regulator should be off in suspend state.
45		- regulator-suspend-microvolt: regulator should be set to this voltage
46		  in suspend.
47		- regulator-mode: operating mode in the given suspend state.
48		  The set of possible operating modes depends on the capabilities of
49		  every hardware so the valid modes are documented on each regulator
50		  device tree binding document.
51	- regulator-initial-mode: initial operating mode. The set of possible operating
52	  modes depends on the capabilities of every hardware so each device binding
53	  documentation explains which values the regulator supports.
54	- regulator-system-load: Load in uA present on regulator that is not captured by
55	  any consumer request.
56	- regulator-pull-down: Enable pull down resistor when the regulator is disabled.
57	- regulator-over-current-protection: Enable over current protection.
58	- regulator-active-discharge: tristate, enable/disable active discharge of
59	  regulators. The values are:
60		0: Disable active discharge.
61		1: Enable active discharge.
62		Absence of this property will leave configuration to default.
63	
64	Deprecated properties:
65	- regulator-compatible: If a regulator chip contains multiple
66	  regulators, and if the chip's binding contains a child node that
67	  describes each regulator, then this property indicates which regulator
68	  this child node is intended to configure. If this property is missing,
69	  the node's name will be used instead.
70	
71	Example:
72	
73		xyzreg: regulator@0 {
74			regulator-min-microvolt = <1000000>;
75			regulator-max-microvolt = <2500000>;
76			regulator-always-on;
77			vin-supply = <&vin>;
78	
79			regulator-state-mem {
80				regulator-on-in-suspend;
81			};
82		};
83	
84	Regulator Consumers:
85	Consumer nodes can reference one or more of its supplies/
86	regulators using the below bindings.
87	
88	- <name>-supply: phandle to the regulator node
89	
90	These are the same bindings that a regulator in the above
91	example used to reference its own supply, in which case
92	its just seen as a special case of a regulator being a
93	consumer itself.
94	
95	Example of a consumer device node (mmc) referencing two
96	regulators (twl_reg1 and twl_reg2),
97	
98		twl_reg1: regulator@0 {
99			...
100			...
101			...
102		};
103	
104		twl_reg2: regulator@1 {
105			...
106			...
107			...
108		};
109	
110		mmc: mmc@0x0 {
111			...
112			...
113			vmmc-supply = <&twl_reg1>;
114			vmmcaux-supply = <&twl_reg2>;
115		};
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.