pm_runtime.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. /*
  2. * pm_runtime.h - Device run-time power management helper functions.
  3. *
  4. * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
  5. *
  6. * This file is released under the GPLv2.
  7. */
  8. #ifndef _LINUX_PM_RUNTIME_H
  9. #define _LINUX_PM_RUNTIME_H
  10. #include <linux/device.h>
  11. #include <linux/notifier.h>
  12. #include <linux/pm.h>
  13. #include <linux/jiffies.h>
  14. /* Runtime PM flag argument bits */
  15. #define RPM_ASYNC 0x01 /* Request is asynchronous */
  16. #define RPM_NOWAIT 0x02 /* Don't wait for concurrent
  17. state change */
  18. #define RPM_GET_PUT 0x04 /* Increment/decrement the
  19. usage_count */
  20. #define RPM_AUTO 0x08 /* Use autosuspend_delay */
  21. #ifdef CONFIG_PM
  22. extern struct workqueue_struct *pm_wq;
  23. static inline bool queue_pm_work(struct work_struct *work)
  24. {
  25. return queue_work(pm_wq, work);
  26. }
  27. extern int pm_generic_runtime_suspend(struct device *dev);
  28. extern int pm_generic_runtime_resume(struct device *dev);
  29. extern int pm_runtime_force_suspend(struct device *dev);
  30. extern int pm_runtime_force_resume(struct device *dev);
  31. extern int __pm_runtime_idle(struct device *dev, int rpmflags);
  32. extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
  33. extern int __pm_runtime_resume(struct device *dev, int rpmflags);
  34. extern int pm_runtime_get_if_in_use(struct device *dev);
  35. extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
  36. extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
  37. extern int pm_runtime_barrier(struct device *dev);
  38. extern void pm_runtime_enable(struct device *dev);
  39. extern void __pm_runtime_disable(struct device *dev, bool check_resume);
  40. extern void pm_runtime_allow(struct device *dev);
  41. extern void pm_runtime_forbid(struct device *dev);
  42. extern void pm_runtime_no_callbacks(struct device *dev);
  43. extern void pm_runtime_irq_safe(struct device *dev);
  44. extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
  45. extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
  46. extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
  47. extern void pm_runtime_update_max_time_suspended(struct device *dev,
  48. s64 delta_ns);
  49. extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
  50. extern void pm_runtime_clean_up_links(struct device *dev);
  51. extern void pm_runtime_get_suppliers(struct device *dev);
  52. extern void pm_runtime_put_suppliers(struct device *dev);
  53. extern void pm_runtime_new_link(struct device *dev);
  54. extern void pm_runtime_drop_link(struct device *dev);
  55. static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
  56. {
  57. dev->power.ignore_children = enable;
  58. }
  59. static inline bool pm_children_suspended(struct device *dev)
  60. {
  61. return dev->power.ignore_children
  62. || !atomic_read(&dev->power.child_count);
  63. }
  64. static inline void pm_runtime_get_noresume(struct device *dev)
  65. {
  66. atomic_inc(&dev->power.usage_count);
  67. }
  68. static inline void pm_runtime_put_noidle(struct device *dev)
  69. {
  70. atomic_add_unless(&dev->power.usage_count, -1, 0);
  71. }
  72. static inline bool device_run_wake(struct device *dev)
  73. {
  74. return dev->power.run_wake;
  75. }
  76. static inline void device_set_run_wake(struct device *dev, bool enable)
  77. {
  78. dev->power.run_wake = enable;
  79. }
  80. static inline bool pm_runtime_suspended(struct device *dev)
  81. {
  82. return dev->power.runtime_status == RPM_SUSPENDED
  83. && !dev->power.disable_depth;
  84. }
  85. static inline bool pm_runtime_active(struct device *dev)
  86. {
  87. return dev->power.runtime_status == RPM_ACTIVE
  88. || dev->power.disable_depth;
  89. }
  90. static inline bool pm_runtime_status_suspended(struct device *dev)
  91. {
  92. return dev->power.runtime_status == RPM_SUSPENDED;
  93. }
  94. static inline bool pm_runtime_enabled(struct device *dev)
  95. {
  96. return !dev->power.disable_depth;
  97. }
  98. static inline bool pm_runtime_callbacks_present(struct device *dev)
  99. {
  100. return !dev->power.no_callbacks;
  101. }
  102. static inline void pm_runtime_mark_last_busy(struct device *dev)
  103. {
  104. ACCESS_ONCE(dev->power.last_busy) = jiffies;
  105. }
  106. static inline bool pm_runtime_is_irq_safe(struct device *dev)
  107. {
  108. return dev->power.irq_safe;
  109. }
  110. #else /* !CONFIG_PM */
  111. static inline bool queue_pm_work(struct work_struct *work) { return false; }
  112. static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
  113. static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
  114. static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
  115. static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
  116. static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
  117. {
  118. return -ENOSYS;
  119. }
  120. static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
  121. {
  122. return -ENOSYS;
  123. }
  124. static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
  125. {
  126. return 1;
  127. }
  128. static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
  129. {
  130. return -ENOSYS;
  131. }
  132. static inline int pm_runtime_get_if_in_use(struct device *dev)
  133. {
  134. return -EINVAL;
  135. }
  136. static inline int __pm_runtime_set_status(struct device *dev,
  137. unsigned int status) { return 0; }
  138. static inline int pm_runtime_barrier(struct device *dev) { return 0; }
  139. static inline void pm_runtime_enable(struct device *dev) {}
  140. static inline void __pm_runtime_disable(struct device *dev, bool c) {}
  141. static inline void pm_runtime_allow(struct device *dev) {}
  142. static inline void pm_runtime_forbid(struct device *dev) {}
  143. static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
  144. static inline bool pm_children_suspended(struct device *dev) { return false; }
  145. static inline void pm_runtime_get_noresume(struct device *dev) {}
  146. static inline void pm_runtime_put_noidle(struct device *dev) {}
  147. static inline bool device_run_wake(struct device *dev) { return false; }
  148. static inline void device_set_run_wake(struct device *dev, bool enable) {}
  149. static inline bool pm_runtime_suspended(struct device *dev) { return false; }
  150. static inline bool pm_runtime_active(struct device *dev) { return true; }
  151. static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
  152. static inline bool pm_runtime_enabled(struct device *dev) { return false; }
  153. static inline void pm_runtime_no_callbacks(struct device *dev) {}
  154. static inline void pm_runtime_irq_safe(struct device *dev) {}
  155. static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
  156. static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
  157. static inline void pm_runtime_mark_last_busy(struct device *dev) {}
  158. static inline void __pm_runtime_use_autosuspend(struct device *dev,
  159. bool use) {}
  160. static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
  161. int delay) {}
  162. static inline unsigned long pm_runtime_autosuspend_expiration(
  163. struct device *dev) { return 0; }
  164. static inline void pm_runtime_set_memalloc_noio(struct device *dev,
  165. bool enable){}
  166. static inline void pm_runtime_clean_up_links(struct device *dev) {}
  167. static inline void pm_runtime_get_suppliers(struct device *dev) {}
  168. static inline void pm_runtime_put_suppliers(struct device *dev) {}
  169. static inline void pm_runtime_new_link(struct device *dev) {}
  170. static inline void pm_runtime_drop_link(struct device *dev) {}
  171. #endif /* !CONFIG_PM */
  172. static inline int pm_runtime_idle(struct device *dev)
  173. {
  174. return __pm_runtime_idle(dev, 0);
  175. }
  176. static inline int pm_runtime_suspend(struct device *dev)
  177. {
  178. return __pm_runtime_suspend(dev, 0);
  179. }
  180. static inline int pm_runtime_autosuspend(struct device *dev)
  181. {
  182. return __pm_runtime_suspend(dev, RPM_AUTO);
  183. }
  184. static inline int pm_runtime_resume(struct device *dev)
  185. {
  186. return __pm_runtime_resume(dev, 0);
  187. }
  188. static inline int pm_request_idle(struct device *dev)
  189. {
  190. return __pm_runtime_idle(dev, RPM_ASYNC);
  191. }
  192. static inline int pm_request_resume(struct device *dev)
  193. {
  194. return __pm_runtime_resume(dev, RPM_ASYNC);
  195. }
  196. static inline int pm_request_autosuspend(struct device *dev)
  197. {
  198. return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
  199. }
  200. static inline int pm_runtime_get(struct device *dev)
  201. {
  202. return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
  203. }
  204. static inline int pm_runtime_get_sync(struct device *dev)
  205. {
  206. return __pm_runtime_resume(dev, RPM_GET_PUT);
  207. }
  208. static inline int pm_runtime_put(struct device *dev)
  209. {
  210. return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
  211. }
  212. static inline int pm_runtime_put_autosuspend(struct device *dev)
  213. {
  214. return __pm_runtime_suspend(dev,
  215. RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
  216. }
  217. static inline int pm_runtime_put_sync(struct device *dev)
  218. {
  219. return __pm_runtime_idle(dev, RPM_GET_PUT);
  220. }
  221. static inline int pm_runtime_put_sync_suspend(struct device *dev)
  222. {
  223. return __pm_runtime_suspend(dev, RPM_GET_PUT);
  224. }
  225. static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
  226. {
  227. return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
  228. }
  229. static inline int pm_runtime_set_active(struct device *dev)
  230. {
  231. return __pm_runtime_set_status(dev, RPM_ACTIVE);
  232. }
  233. static inline void pm_runtime_set_suspended(struct device *dev)
  234. {
  235. __pm_runtime_set_status(dev, RPM_SUSPENDED);
  236. }
  237. static inline void pm_runtime_disable(struct device *dev)
  238. {
  239. __pm_runtime_disable(dev, true);
  240. }
  241. static inline void pm_runtime_use_autosuspend(struct device *dev)
  242. {
  243. __pm_runtime_use_autosuspend(dev, true);
  244. }
  245. static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
  246. {
  247. __pm_runtime_use_autosuspend(dev, false);
  248. }
  249. #endif