regulator.txt 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. Voltage/Current regulator
  2. Binding:
  3. The regulator devices don't use the "compatible" property. The binding is done
  4. by the prefix of regulator node's name, or, if this fails, by the prefix of the
  5. regulator's "regulator-name" property. 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. For the node name e.g.: "prefix[:alpha:]num { ... }":
  12. - the driver prefix should be: "prefix" - case sensitive
  13. - the node name's "num" is set as "dev->driver_data" on bind
  14. Example the prefix "ldo" will pass for: "ldo1", "ldo@1", "ldoreg@1, ...
  15. Binding by means of the node's name is preferred. However if the node names
  16. would produce ambiguous prefixes (like "regulator@1" and "regualtor@11") and you
  17. can't or do not want to change them then binding against the "regulator-name"
  18. property is possible. The syntax for the prefix of the "regulator-name" property
  19. is the same as the one for the regulator's node name.
  20. Use case: a regulator named "regulator@1" to be bound to a driver named
  21. "LDO_DRV" and a regulator named "regualator@11" to be bound to an other driver
  22. named "BOOST_DRV". Using prefix "regualtor@1" for driver matching would load
  23. the same driver for both regulators, hence the prefix is ambiguous.
  24. Optional properties:
  25. - regulator-name: a string, required by the regulator uclass, used for driver
  26. binding if binding by node's name prefix fails
  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. - regulator-ramp-delay: ramp delay for regulator (in uV/us)
  34. - regulator-init-microvolt: a init allowed Voltage value
  35. - regulator-state-(standby|mem|disk)
  36. type: object
  37. description:
  38. sub-nodes for regulator state in Standby, Suspend-to-RAM, and
  39. Suspend-to-DISK modes. Equivalent with standby, mem, and disk Linux
  40. sleep states.
  41. properties:
  42. regulator-on-in-suspend:
  43. description: regulator should be on in suspend state.
  44. type: boolean
  45. regulator-off-in-suspend:
  46. description: regulator should be off in suspend state.
  47. type: boolean
  48. regulator-suspend-microvolt:
  49. description: the default voltage which regulator would be set in
  50. suspend. This property is now deprecated, instead setting voltage
  51. for suspend mode via the API which regulator driver provides is
  52. recommended.
  53. Note
  54. The "regulator-name" constraint is used for setting the device's uclass
  55. platform data '.name' field. And the regulator device name is set from
  56. it's node name. If "regulator-name" is not provided in dts, node name
  57. is chosen for setting the device's uclass platform data '.name' field.
  58. Other kernel-style properties, are currently not used.
  59. Note:
  60. For the regulator autoset from constraints, the framework expects that:
  61. - regulator-min-microvolt is equal to regulator-max-microvolt
  62. - regulator-min-microamp is equal to regulator-max-microamp
  63. - regulator-always-on or regulator-boot-on is set
  64. Example:
  65. ldo0 {
  66. /* Optional */
  67. regulator-name = "VDDQ_EMMC_1.8V";
  68. regulator-min-microvolt = <1800000>;
  69. regulator-max-microvolt = <1800000>;
  70. regulator-min-microamp = <100000>;
  71. regulator-max-microamp = <100000>;
  72. regulator-init-microvolt = <1800000>;
  73. regulator-always-on;
  74. regulator-boot-on;
  75. regulator-ramp-delay = <12000>;
  76. regulator-state-mem {
  77. regulator-on-in-suspend;
  78. regulator-suspend-microvolt = <1800000>;
  79. };
  80. };