sysfs-class-regulator 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  1. What: /sys/class/regulator/.../state
  2. Date: April 2008
  3. KernelVersion: 2.6.26
  4. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  5. Description:
  6. Some regulator directories will contain a field called
  7. state. This reports the regulator enable control, for
  8. regulators which can report that input value.
  9. This will be one of the following strings:
  10. 'enabled'
  11. 'disabled'
  12. 'unknown'
  13. 'enabled' means the regulator output is ON and is supplying
  14. power to the system (assuming no error prevents it).
  15. 'disabled' means the regulator output is OFF and is not
  16. supplying power to the system (unless some non-Linux
  17. control has enabled it).
  18. 'unknown' means software cannot determine the state, or
  19. the reported state is invalid.
  20. NOTE: this field can be used in conjunction with microvolts
  21. or microamps to determine configured regulator output levels.
  22. What: /sys/class/regulator/.../status
  23. Description:
  24. Some regulator directories will contain a field called
  25. "status". This reports the current regulator status, for
  26. regulators which can report that output value.
  27. This will be one of the following strings:
  28. - off
  29. - on
  30. - error
  31. - fast
  32. - normal
  33. - idle
  34. - standby
  35. "off" means the regulator is not supplying power to the
  36. system.
  37. "on" means the regulator is supplying power to the system,
  38. and the regulator can't report a detailed operation mode.
  39. "error" indicates an out-of-regulation status such as being
  40. disabled due to thermal shutdown, or voltage being unstable
  41. because of problems with the input power supply.
  42. "fast", "normal", "idle", and "standby" are all detailed
  43. regulator operation modes (described elsewhere). They
  44. imply "on", but provide more detail.
  45. Note that regulator status is a function of many inputs,
  46. not limited to control inputs from Linux. For example,
  47. the actual load presented may trigger "error" status; or
  48. a regulator may be enabled by another user, even though
  49. Linux did not enable it.
  50. What: /sys/class/regulator/.../type
  51. Date: April 2008
  52. KernelVersion: 2.6.26
  53. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  54. Description:
  55. Each regulator directory will contain a field called
  56. type. This holds the regulator type.
  57. This will be one of the following strings:
  58. - 'voltage'
  59. - 'current'
  60. - 'unknown'
  61. 'voltage' means the regulator output voltage can be controlled
  62. by software.
  63. 'current' means the regulator output current limit can be
  64. controlled by software.
  65. 'unknown' means software cannot control either voltage or
  66. current limit.
  67. What: /sys/class/regulator/.../microvolts
  68. Date: April 2008
  69. KernelVersion: 2.6.26
  70. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  71. Description:
  72. Some regulator directories will contain a field called
  73. microvolts. This holds the regulator output voltage setting
  74. measured in microvolts (i.e. E-6 Volts), for regulators
  75. which can report the control input for voltage.
  76. NOTE: This value should not be used to determine the regulator
  77. output voltage level as this value is the same regardless of
  78. whether the regulator is enabled or disabled.
  79. What: /sys/class/regulator/.../microamps
  80. Date: April 2008
  81. KernelVersion: 2.6.26
  82. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  83. Description:
  84. Some regulator directories will contain a field called
  85. microamps. This holds the regulator output current limit
  86. setting measured in microamps (i.e. E-6 Amps), for regulators
  87. which can report the control input for a current limit.
  88. NOTE: This value should not be used to determine the regulator
  89. output current level as this value is the same regardless of
  90. whether the regulator is enabled or disabled.
  91. What: /sys/class/regulator/.../opmode
  92. Date: April 2008
  93. KernelVersion: 2.6.26
  94. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  95. Description:
  96. Some regulator directories will contain a field called
  97. opmode. This holds the current regulator operating mode,
  98. for regulators which can report that control input value.
  99. The opmode value can be one of the following strings:
  100. - 'fast'
  101. - 'normal'
  102. - 'idle'
  103. - 'standby'
  104. - 'unknown'
  105. The modes are described in include/linux/regulator/consumer.h
  106. NOTE: This value should not be used to determine the regulator
  107. output operating mode as this value is the same regardless of
  108. whether the regulator is enabled or disabled. A "status"
  109. attribute may be available to determine the actual mode.
  110. What: /sys/class/regulator/.../min_microvolts
  111. Date: April 2008
  112. KernelVersion: 2.6.26
  113. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  114. Description:
  115. Some regulator directories will contain a field called
  116. min_microvolts. This holds the minimum safe working regulator
  117. output voltage setting for this domain measured in microvolts,
  118. for regulators which support voltage constraints.
  119. NOTE: this will return the string 'constraint not defined' if
  120. the power domain has no min microvolts constraint defined by
  121. platform code.
  122. What: /sys/class/regulator/.../max_microvolts
  123. Date: April 2008
  124. KernelVersion: 2.6.26
  125. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  126. Description:
  127. Some regulator directories will contain a field called
  128. max_microvolts. This holds the maximum safe working regulator
  129. output voltage setting for this domain measured in microvolts,
  130. for regulators which support voltage constraints.
  131. NOTE: this will return the string 'constraint not defined' if
  132. the power domain has no max microvolts constraint defined by
  133. platform code.
  134. What: /sys/class/regulator/.../min_microamps
  135. Date: April 2008
  136. KernelVersion: 2.6.26
  137. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  138. Description:
  139. Some regulator directories will contain a field called
  140. min_microamps. This holds the minimum safe working regulator
  141. output current limit setting for this domain measured in
  142. microamps, for regulators which support current constraints.
  143. NOTE: this will return the string 'constraint not defined' if
  144. the power domain has no min microamps constraint defined by
  145. platform code.
  146. What: /sys/class/regulator/.../max_microamps
  147. Date: April 2008
  148. KernelVersion: 2.6.26
  149. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  150. Description:
  151. Some regulator directories will contain a field called
  152. max_microamps. This holds the maximum safe working regulator
  153. output current limit setting for this domain measured in
  154. microamps, for regulators which support current constraints.
  155. NOTE: this will return the string 'constraint not defined' if
  156. the power domain has no max microamps constraint defined by
  157. platform code.
  158. What: /sys/class/regulator/.../name
  159. Date: October 2008
  160. KernelVersion: 2.6.28
  161. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  162. Description:
  163. Each regulator directory will contain a field called
  164. name. This holds a string identifying the regulator for
  165. display purposes.
  166. NOTE: this will be empty if no suitable name is provided
  167. by platform or regulator drivers.
  168. What: /sys/class/regulator/.../num_users
  169. Date: April 2008
  170. KernelVersion: 2.6.26
  171. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  172. Description:
  173. Each regulator directory will contain a field called
  174. num_users. This holds the number of consumer devices that
  175. have called regulator_enable() on this regulator.
  176. What: /sys/class/regulator/.../requested_microamps
  177. Date: April 2008
  178. KernelVersion: 2.6.26
  179. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  180. Description:
  181. Some regulator directories will contain a field called
  182. requested_microamps. This holds the total requested load
  183. current in microamps for this regulator from all its consumer
  184. devices.
  185. What: /sys/class/regulator/.../parent
  186. Date: April 2008
  187. KernelVersion: 2.6.26
  188. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  189. Description:
  190. Some regulator directories will contain a link called parent.
  191. This points to the parent or supply regulator if one exists.
  192. What: /sys/class/regulator/.../suspend_mem_microvolts
  193. Date: May 2008
  194. KernelVersion: 2.6.26
  195. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  196. Description:
  197. Some regulator directories will contain a field called
  198. suspend_mem_microvolts. This holds the regulator output
  199. voltage setting for this domain measured in microvolts when
  200. the system is suspended to memory, for voltage regulators
  201. implementing suspend voltage configuration constraints.
  202. What: /sys/class/regulator/.../suspend_disk_microvolts
  203. Date: May 2008
  204. KernelVersion: 2.6.26
  205. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  206. Description:
  207. Some regulator directories will contain a field called
  208. suspend_disk_microvolts. This holds the regulator output
  209. voltage setting for this domain measured in microvolts when
  210. the system is suspended to disk, for voltage regulators
  211. implementing suspend voltage configuration constraints.
  212. What: /sys/class/regulator/.../suspend_standby_microvolts
  213. Date: May 2008
  214. KernelVersion: 2.6.26
  215. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  216. Description:
  217. Some regulator directories will contain a field called
  218. suspend_standby_microvolts. This holds the regulator output
  219. voltage setting for this domain measured in microvolts when
  220. the system is suspended to standby, for voltage regulators
  221. implementing suspend voltage configuration constraints.
  222. What: /sys/class/regulator/.../suspend_mem_mode
  223. Date: May 2008
  224. KernelVersion: 2.6.26
  225. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  226. Description:
  227. Some regulator directories will contain a field called
  228. suspend_mem_mode. This holds the regulator operating mode
  229. setting for this domain when the system is suspended to
  230. memory, for regulators implementing suspend mode
  231. configuration constraints.
  232. What: /sys/class/regulator/.../suspend_disk_mode
  233. Date: May 2008
  234. KernelVersion: 2.6.26
  235. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  236. Description:
  237. Some regulator directories will contain a field called
  238. suspend_disk_mode. This holds the regulator operating mode
  239. setting for this domain when the system is suspended to disk,
  240. for regulators implementing suspend mode configuration
  241. constraints.
  242. What: /sys/class/regulator/.../suspend_standby_mode
  243. Date: May 2008
  244. KernelVersion: 2.6.26
  245. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  246. Description:
  247. Some regulator directories will contain a field called
  248. suspend_standby_mode. This holds the regulator operating mode
  249. setting for this domain when the system is suspended to
  250. standby, for regulators implementing suspend mode
  251. configuration constraints.
  252. What: /sys/class/regulator/.../suspend_mem_state
  253. Date: May 2008
  254. KernelVersion: 2.6.26
  255. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  256. Description:
  257. Some regulator directories will contain a field called
  258. suspend_mem_state. This holds the regulator operating state
  259. when suspended to memory, for regulators implementing suspend
  260. configuration constraints.
  261. This will be one of the same strings reported by
  262. the "state" attribute.
  263. What: /sys/class/regulator/.../suspend_disk_state
  264. Date: May 2008
  265. KernelVersion: 2.6.26
  266. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  267. Description:
  268. Some regulator directories will contain a field called
  269. suspend_disk_state. This holds the regulator operating state
  270. when suspended to disk, for regulators implementing
  271. suspend configuration constraints.
  272. This will be one of the same strings reported by
  273. the "state" attribute.
  274. What: /sys/class/regulator/.../suspend_standby_state
  275. Date: May 2008
  276. KernelVersion: 2.6.26
  277. Contact: Liam Girdwood <lrg@slimlogic.co.uk>
  278. Description:
  279. Some regulator directories will contain a field called
  280. suspend_standby_state. This holds the regulator operating
  281. state when suspended to standby, for regulators implementing
  282. suspend configuration constraints.
  283. This will be one of the same strings reported by
  284. the "state" attribute.
  285. What: /sys/class/regulator/.../bypass
  286. Date: September 2012
  287. KernelVersion: 3.7
  288. Contact: Mark Brown <broonie@opensource.wolfsonmicro.com>
  289. Description:
  290. Some regulator directories will contain a field called
  291. bypass. This indicates if the device is in bypass mode.
  292. This will be one of the following strings:
  293. - 'enabled'
  294. - 'disabled'
  295. - 'unknown'
  296. 'enabled' means the regulator is in bypass mode.
  297. 'disabled' means that the regulator is regulating.
  298. 'unknown' means software cannot determine the state, or
  299. the reported state is invalid.