cpufreq.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. /*
  2. * linux/include/linux/cpufreq.h
  3. *
  4. * Copyright (C) 2001 Russell King
  5. * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
  6. *
  7. *
  8. * $Id: cpufreq.h,v 1.1.1.1 2007/06/12 07:27:16 eyryu Exp $
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License version 2 as
  12. * published by the Free Software Foundation.
  13. */
  14. #ifndef _LINUX_CPUFREQ_H
  15. #define _LINUX_CPUFREQ_H
  16. #include <linux/mutex.h>
  17. #include <linux/notifier.h>
  18. #include <linux/threads.h>
  19. #include <linux/device.h>
  20. #include <linux/kobject.h>
  21. #include <linux/sysfs.h>
  22. #include <linux/completion.h>
  23. #include <linux/workqueue.h>
  24. #include <linux/cpumask.h>
  25. #include <asm/div64.h>
  26. #define CPUFREQ_NAME_LEN 16
  27. /*********************************************************************
  28. * CPUFREQ NOTIFIER INTERFACE *
  29. *********************************************************************/
  30. int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
  31. int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
  32. #define CPUFREQ_TRANSITION_NOTIFIER (0)
  33. #define CPUFREQ_POLICY_NOTIFIER (1)
  34. /* if (cpufreq_driver->target) exists, the ->governor decides what frequency
  35. * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
  36. * two generic policies are available:
  37. */
  38. #define CPUFREQ_POLICY_POWERSAVE (1)
  39. #define CPUFREQ_POLICY_PERFORMANCE (2)
  40. /* Frequency values here are CPU kHz so that hardware which doesn't run
  41. * with some frequencies can complain without having to guess what per
  42. * cent / per mille means.
  43. * Maximum transition latency is in nanoseconds - if it's unknown,
  44. * CPUFREQ_ETERNAL shall be used.
  45. */
  46. struct cpufreq_governor;
  47. #define CPUFREQ_ETERNAL (-1)
  48. struct cpufreq_cpuinfo {
  49. unsigned int max_freq;
  50. unsigned int min_freq;
  51. unsigned int transition_latency; /* in 10^(-9) s = nanoseconds */
  52. };
  53. struct cpufreq_real_policy {
  54. unsigned int min; /* in kHz */
  55. unsigned int max; /* in kHz */
  56. unsigned int policy; /* see above */
  57. struct cpufreq_governor *governor; /* see below */
  58. };
  59. struct cpufreq_policy {
  60. cpumask_t cpus; /* affected CPUs */
  61. unsigned int shared_type; /* ANY or ALL affected CPUs
  62. should set cpufreq */
  63. unsigned int cpu; /* cpu nr of registered CPU */
  64. struct cpufreq_cpuinfo cpuinfo;/* see above */
  65. unsigned int min; /* in kHz */
  66. unsigned int max; /* in kHz */
  67. unsigned int cur; /* in kHz, only needed if cpufreq
  68. * governors are used */
  69. unsigned int policy; /* see above */
  70. struct cpufreq_governor *governor; /* see below */
  71. struct work_struct update; /* if update_policy() needs to be
  72. * called, but you're in IRQ context */
  73. struct cpufreq_real_policy user_policy;
  74. struct kobject kobj;
  75. struct completion kobj_unregister;
  76. };
  77. #define CPUFREQ_ADJUST (0)
  78. #define CPUFREQ_INCOMPATIBLE (1)
  79. #define CPUFREQ_NOTIFY (2)
  80. #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
  81. #define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
  82. #define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
  83. #define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
  84. /******************** cpufreq transition notifiers *******************/
  85. #define CPUFREQ_PRECHANGE (0)
  86. #define CPUFREQ_POSTCHANGE (1)
  87. #define CPUFREQ_RESUMECHANGE (8)
  88. #define CPUFREQ_SUSPENDCHANGE (9)
  89. struct cpufreq_freqs {
  90. unsigned int cpu; /* cpu nr */
  91. unsigned int old;
  92. unsigned int new;
  93. u8 flags; /* flags of cpufreq_driver, see below. */
  94. };
  95. /**
  96. * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch safe)
  97. * @old: old value
  98. * @div: divisor
  99. * @mult: multiplier
  100. *
  101. *
  102. * new = old * mult / div
  103. */
  104. static inline unsigned long cpufreq_scale(unsigned long old, u_int div, u_int mult)
  105. {
  106. #if BITS_PER_LONG == 32
  107. u64 result = ((u64) old) * ((u64) mult);
  108. do_div(result, div);
  109. return (unsigned long) result;
  110. #elif BITS_PER_LONG == 64
  111. unsigned long result = old * ((u64) mult);
  112. result /= div;
  113. return result;
  114. #endif
  115. };
  116. /*********************************************************************
  117. * CPUFREQ GOVERNORS *
  118. *********************************************************************/
  119. #define CPUFREQ_GOV_START 1
  120. #define CPUFREQ_GOV_STOP 2
  121. #define CPUFREQ_GOV_LIMITS 3
  122. struct cpufreq_governor {
  123. char name[CPUFREQ_NAME_LEN];
  124. int (*governor) (struct cpufreq_policy *policy,
  125. unsigned int event);
  126. struct list_head governor_list;
  127. struct module *owner;
  128. };
  129. /* pass a target to the cpufreq driver
  130. */
  131. extern int cpufreq_driver_target(struct cpufreq_policy *policy,
  132. unsigned int target_freq,
  133. unsigned int relation);
  134. extern int __cpufreq_driver_target(struct cpufreq_policy *policy,
  135. unsigned int target_freq,
  136. unsigned int relation);
  137. extern int __cpufreq_driver_getavg(struct cpufreq_policy *policy);
  138. int cpufreq_register_governor(struct cpufreq_governor *governor);
  139. void cpufreq_unregister_governor(struct cpufreq_governor *governor);
  140. int lock_policy_rwsem_read(int cpu);
  141. int lock_policy_rwsem_write(int cpu);
  142. void unlock_policy_rwsem_read(int cpu);
  143. void unlock_policy_rwsem_write(int cpu);
  144. /*********************************************************************
  145. * CPUFREQ DRIVER INTERFACE *
  146. *********************************************************************/
  147. #define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
  148. #define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
  149. struct freq_attr;
  150. struct cpufreq_driver {
  151. struct module *owner;
  152. char name[CPUFREQ_NAME_LEN];
  153. u8 flags;
  154. /* needed by all drivers */
  155. int (*init) (struct cpufreq_policy *policy);
  156. int (*verify) (struct cpufreq_policy *policy);
  157. /* define one out of two */
  158. int (*setpolicy) (struct cpufreq_policy *policy);
  159. int (*target) (struct cpufreq_policy *policy,
  160. unsigned int target_freq,
  161. unsigned int relation);
  162. /* should be defined, if possible */
  163. unsigned int (*get) (unsigned int cpu);
  164. /* optional */
  165. unsigned int (*getavg) (unsigned int cpu);
  166. int (*exit) (struct cpufreq_policy *policy);
  167. int (*suspend) (struct cpufreq_policy *policy, pm_message_t pmsg);
  168. int (*resume) (struct cpufreq_policy *policy);
  169. struct freq_attr **attr;
  170. };
  171. /* flags */
  172. #define CPUFREQ_STICKY 0x01 /* the driver isn't removed even if
  173. * all ->init() calls failed */
  174. #define CPUFREQ_CONST_LOOPS 0x02 /* loops_per_jiffy or other kernel
  175. * "constants" aren't affected by
  176. * frequency transitions */
  177. #define CPUFREQ_PM_NO_WARN 0x04 /* don't warn on suspend/resume speed
  178. * mismatches */
  179. int cpufreq_register_driver(struct cpufreq_driver *driver_data);
  180. int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
  181. void cpufreq_notify_transition(struct cpufreq_freqs *freqs, unsigned int state);
  182. static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy, unsigned int min, unsigned int max)
  183. {
  184. if (policy->min < min)
  185. policy->min = min;
  186. if (policy->max < min)
  187. policy->max = min;
  188. if (policy->min > max)
  189. policy->min = max;
  190. if (policy->max > max)
  191. policy->max = max;
  192. if (policy->min > policy->max)
  193. policy->min = policy->max;
  194. return;
  195. }
  196. struct freq_attr {
  197. struct attribute attr;
  198. ssize_t (*show)(struct cpufreq_policy *, char *);
  199. ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
  200. };
  201. /*********************************************************************
  202. * CPUFREQ 2.6. INTERFACE *
  203. *********************************************************************/
  204. int cpufreq_set_policy(struct cpufreq_policy *policy);
  205. int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
  206. int cpufreq_update_policy(unsigned int cpu);
  207. /* query the current CPU frequency (in kHz). If zero, cpufreq couldn't detect it */
  208. unsigned int cpufreq_get(unsigned int cpu);
  209. /* query the last known CPU freq (in kHz). If zero, cpufreq couldn't detect it */
  210. #ifdef CONFIG_CPU_FREQ
  211. unsigned int cpufreq_quick_get(unsigned int cpu);
  212. #else
  213. static inline unsigned int cpufreq_quick_get(unsigned int cpu)
  214. {
  215. return 0;
  216. }
  217. #endif
  218. /*********************************************************************
  219. * CPUFREQ DEFAULT GOVERNOR *
  220. *********************************************************************/
  221. #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
  222. extern struct cpufreq_governor cpufreq_gov_performance;
  223. #define CPUFREQ_DEFAULT_GOVERNOR &cpufreq_gov_performance
  224. #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
  225. extern struct cpufreq_governor cpufreq_gov_userspace;
  226. #define CPUFREQ_DEFAULT_GOVERNOR &cpufreq_gov_userspace
  227. #endif
  228. /*********************************************************************
  229. * FREQUENCY TABLE HELPERS *
  230. *********************************************************************/
  231. #define CPUFREQ_ENTRY_INVALID ~0
  232. #define CPUFREQ_TABLE_END ~1
  233. struct cpufreq_frequency_table {
  234. unsigned int index; /* any */
  235. unsigned int frequency; /* kHz - doesn't need to be in ascending
  236. * order */
  237. };
  238. int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
  239. struct cpufreq_frequency_table *table);
  240. int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
  241. struct cpufreq_frequency_table *table);
  242. int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
  243. struct cpufreq_frequency_table *table,
  244. unsigned int target_freq,
  245. unsigned int relation,
  246. unsigned int *index);
  247. /* the following 3 funtions are for cpufreq core use only */
  248. struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
  249. struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
  250. void cpufreq_cpu_put (struct cpufreq_policy *data);
  251. /* the following are really really optional */
  252. extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
  253. void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
  254. unsigned int cpu);
  255. void cpufreq_frequency_table_put_attr(unsigned int cpu);
  256. /*********************************************************************
  257. * UNIFIED DEBUG HELPERS *
  258. *********************************************************************/
  259. #define CPUFREQ_DEBUG_CORE 1
  260. #define CPUFREQ_DEBUG_DRIVER 2
  261. #define CPUFREQ_DEBUG_GOVERNOR 4
  262. #ifdef CONFIG_CPU_FREQ_DEBUG
  263. extern void cpufreq_debug_printk(unsigned int type, const char *prefix,
  264. const char *fmt, ...);
  265. #else
  266. #define cpufreq_debug_printk(msg...) do { } while(0)
  267. #endif /* CONFIG_CPU_FREQ_DEBUG */
  268. #endif /* _LINUX_CPUFREQ_H */