doc/device-tree-bindings/regulator/regulator.txt

   1 Voltage/Current regulator
   2
   3 Binding:
   4 The regulator devices don't use the "compatible" property. The binding is done
   5 by the prefix of regulator node's name. Usually the pmic I/O driver will provide
   6 the array of 'struct pmic_child_info' with the prefixes and compatible drivers.
   7 The bind is done by calling function: pmic_bind_childs().
   8 Example drivers:
   9 pmic: drivers/power/pmic/max77686.c
  10 regulator: drivers/power/regulator/max77686.c
  11
  12 For 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
  16 Example the prefix "ldo" will pass for: "ldo1", "ldo@1", "LDO1", "LDOREG@1"...
  17
  18 Required properties:
  19 - regulator-name: a string, required by the regulator uclass
  20
  21 Note
  22 The "regulator-name" constraint is used for setting the device's uclass
  23 platform data '.name' field. And the regulator device name is set from
  24 it's node name.
  25
  26 Optional properties:
  27 - regulator-min-microvolt: a minimum allowed Voltage value
  28 - regulator-max-microvolt: a maximum allowed Voltage value
  29 - regulator-min-microamp: a minimum allowed Current value
  30 - regulator-max-microamp: a maximum allowed Current value
  31 - regulator-always-on: regulator should never be disabled
  32 - regulator-boot-on: enabled by bootloader/firmware
  33
  34 Other kernel-style properties, are currently not used.
  35
  36 Note:
  37 For the regulator autoset from constraints, the framework expects that:
  38 - regulator-min-microvolt is equal to regulator-max-microvolt
  39 - regulator-min-microamp is equal to regulator-max-microamp
  40 - regulator-always-on or regulator-boot-on is set
  41
  42 Example:
  43 ldo0 {
  44         /* Mandatory */
  45         regulator-name = "VDDQ_EMMC_1.8V";
  46
  47         /* Optional */
  48         regulator-min-microvolt = <1800000>;
  49         regulator-max-microvolt = <1800000>;
  50         regulator-min-microamp = <100000>;
  51         regulator-max-microamp = <100000>;
  52         regulator-always-on;
  53         regulator-boot-on;
  54 };