Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 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 |
Kishon Vijay Abraham I | 93134c7 | 2013-06-20 14:07:37 +0530 | [diff] [blame] | 12 | - regulator-allow-bypass: allow the regulator to go into bypass mode |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 13 | - <name>-supply: phandle to the parent supply/regulator node |
Axel Lin | ea38d13 | 2012-06-18 14:03:16 +0800 | [diff] [blame] | 14 | - regulator-ramp-delay: ramp delay for regulator(in uV/uS) |
Carlos Garcia | c98be0c | 2014-04-04 22:31:00 -0400 | [diff] [blame] | 15 | For hardware which supports disabling ramp rate, it should be explicitly |
Yadwinder Singh Brar | 1653ccf | 2013-06-29 18:21:15 +0530 | [diff] [blame] | 16 | intialised to zero (regulator-ramp-delay = <0>) for disabling ramp delay. |
Laxman Dewangan | 00c877c | 2013-09-18 18:18:02 +0530 | [diff] [blame] | 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. |
Stephen Warren | 13511de | 2012-09-24 13:25:00 -0600 | [diff] [blame] | 22 | |
| 23 | Deprecated properties: |
Laxman Dewangan | 8c5e461 | 2012-07-05 12:53:04 +0530 | [diff] [blame] | 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 |
Stephen Warren | 13511de | 2012-09-24 13:25:00 -0600 | [diff] [blame] | 27 | this child node is intended to configure. If this property is missing, |
| 28 | the node's name will be used instead. |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 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 |
Shawn Guo | 7728c14 | 2011-11-28 21:37:16 +0800 | [diff] [blame] | 51 | regulators (twl_reg1 and twl_reg2), |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 52 | |
Shawn Guo | 7728c14 | 2011-11-28 21:37:16 +0800 | [diff] [blame] | 53 | twl_reg1: regulator@0 { |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 54 | ... |
| 55 | ... |
| 56 | ... |
| 57 | }; |
| 58 | |
Shawn Guo | 7728c14 | 2011-11-28 21:37:16 +0800 | [diff] [blame] | 59 | twl_reg2: regulator@1 { |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 60 | ... |
| 61 | ... |
| 62 | ... |
| 63 | }; |
| 64 | |
| 65 | mmc: mmc@0x0 { |
| 66 | ... |
| 67 | ... |
Shawn Guo | 7728c14 | 2011-11-28 21:37:16 +0800 | [diff] [blame] | 68 | vmmc-supply = <&twl_reg1>; |
| 69 | vmmcaux-supply = <&twl_reg2>; |
Rajendra Nayak | 8f446e6 | 2011-11-18 16:47:17 +0530 | [diff] [blame] | 70 | }; |