blob: 2cf4b9de8bad8880f3c78504401aa4a76c9d34c8 [file] [log] [blame]
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +02001Voltage/Current regulator
2
3Binding:
4The regulator devices don't use the "compatible" property. The binding is done
5by the prefix of regulator node's name. Usually the pmic I/O driver will provide
6the array of 'struct pmic_child_info' with the prefixes and compatible drivers.
7The bind is done by calling function: pmic_bind_childs().
8Example drivers:
9pmic: drivers/power/pmic/max77686.c
10regulator: drivers/power/regulator/max77686.c
11
12For the node name e.g.: "prefix[:alpha:]num { ... }":
13- the driver prefix should be: "prefix" or "PREFIX" - case insensitive
14- the node name's "num" is set as "dev->driver_data" on bind
15
16Example the prefix "ldo" will pass for: "ldo1", "ldo@1", "LDO1", "LDOREG@1"...
17
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +020018Optional properties:
Peng Fan40ade2c2015-08-07 16:43:43 +080019- regulator-name: a string, required by the regulator uclass
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +020020- regulator-min-microvolt: a minimum allowed Voltage value
21- regulator-max-microvolt: a maximum allowed Voltage value
22- regulator-min-microamp: a minimum allowed Current value
23- regulator-max-microamp: a maximum allowed Current value
24- regulator-always-on: regulator should never be disabled
25- regulator-boot-on: enabled by bootloader/firmware
26
Peng Fan40ade2c2015-08-07 16:43:43 +080027Note
28The "regulator-name" constraint is used for setting the device's uclass
29platform data '.name' field. And the regulator device name is set from
30it's node name. If "regulator-name" is not provided in dts, node name
31is chosen for setting the device's uclass platform data '.name' field.
32
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +020033Other kernel-style properties, are currently not used.
34
35Note:
36For the regulator autoset from constraints, the framework expects that:
37- regulator-min-microvolt is equal to regulator-max-microvolt
38- regulator-min-microamp is equal to regulator-max-microamp
39- regulator-always-on or regulator-boot-on is set
40
41Example:
42ldo0 {
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +020043 /* Optional */
Peng Fan40ade2c2015-08-07 16:43:43 +080044 regulator-name = "VDDQ_EMMC_1.8V";
Przemyslaw Marczakaf41e8d2015-04-20 20:07:42 +020045 regulator-min-microvolt = <1800000>;
46 regulator-max-microvolt = <1800000>;
47 regulator-min-microamp = <100000>;
48 regulator-max-microamp = <100000>;
49 regulator-always-on;
50 regulator-boot-on;
51};