]> git.ipfire.org Git - people/ms/linux.git/blame - include/linux/cpuidle.h
projects / people / ms / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
cpuidle / menu: move repeated correction factor check to init
[people/ms/linux.git] / include / linux / cpuidle.h
CommitLineData
4f86d3a8
LB		 1/*
2 * cpuidle.h - a generic framework for CPU idle power management
3 *
4 * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
7 *
8 * This code is licenced under the GPL.
9 */
10
11#ifndef _LINUX_CPUIDLE_H
12#define _LINUX_CPUIDLE_H
13
14#include <linux/percpu.h>
15#include <linux/list.h>
e1689795 16#include <linux/hrtimer.h>
4f86d3a8 17
86239ceb 18#define CPUIDLE_STATE_MAX 10
4f86d3a8 19#define CPUIDLE_NAME_LEN 16
4fcb2fcd 20#define CPUIDLE_DESC_LEN 32
4f86d3a8 21
de477254
PG		 22struct module;
23
4f86d3a8 24struct cpuidle_device;
46bcfad7 25struct cpuidle_driver;
4f86d3a8
LB		 26
27
28/****************************
29 * CPUIDLE DEVICE INTERFACE *
30 ****************************/
31
4202735e 32struct cpuidle_state_usage {
dc7fd275 33 unsigned long long disable;
4202735e
DD		 34 unsigned long long usage;
35 unsigned long long time; /* in US */
36};
37
4f86d3a8
LB		 38struct cpuidle_state {
39 char name[CPUIDLE_NAME_LEN];
4fcb2fcd 40 char desc[CPUIDLE_DESC_LEN];
4f86d3a8
LB		 41
42 unsigned int flags;
43 unsigned int exit_latency; /* in US */
02401c06 44 int power_usage; /* in mW */
4f86d3a8 45 unsigned int target_residency; /* in US */
cbc9ef02 46 bool disabled; /* disabled on all CPUs */
4f86d3a8 47
4f86d3a8 48 int (*enter) (struct cpuidle_device *dev,
46bcfad7 49 struct cpuidle_driver *drv,
e978aa7d 50 int index);
1a022e3f
BO		 51
52 int (*enter_dead) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 53};
54
55/* Idle State Flags */
56#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4126c019 57#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 58#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB		 59
60#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
61
728ce22b 62struct cpuidle_device_kobj;
1a706438
DL		 63struct cpuidle_state_kobj;
64struct cpuidle_driver_kobj;
728ce22b 65
4f86d3a8 66struct cpuidle_device {
dcb84f33 67 unsigned int registered:1;
b5556a67 68 unsigned int enabled:1;
4f86d3a8
LB		 69 unsigned int cpu;
70
71 int last_residency;
72 int state_count;
4202735e 73 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 74 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 75 struct cpuidle_driver_kobj *kobj_driver;
728ce22b 76 struct cpuidle_device_kobj *kobj_dev;
4f86d3a8 77 struct list_head device_list;
4126c019
CC		 78
79#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
80 int safe_state_index;
81 cpumask_t coupled_cpus;
82 struct cpuidle_coupled *coupled;
83#endif
4f86d3a8
LB		 84};
85
86DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
87
88/**
89 * cpuidle_get_last_residency - retrieves the last state's residency time
90 * @dev: the target CPU
91 *
92 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
93 */
94static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
95{
96 return dev->last_residency;
97}
98
99
100/****************************
101 * CPUIDLE DRIVER INTERFACE *
102 ****************************/
103
104struct cpuidle_driver {
db70b044 105 const char *name;
4f86d3a8 106 struct module *owner;
42f67f2a 107 int refcnt;
46bcfad7 108
a06df062
DL		 109 /* used by the cpuidle framework to setup the broadcast timer */
110 unsigned int bctimer:1;
8aef33a7 111 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD		 112 struct cpuidle_state states[CPUIDLE_STATE_MAX];
113 int state_count;
114 int safe_state_index;
82467a5a
DL		 115
116 /* the driver handles the cpus in cpumask */
6587fca2 117 struct cpumask *cpumask;
4f86d3a8
LB		 118};
119
120#ifdef CONFIG_CPU_IDLE
d91ee586 121extern void disable_cpuidle(void);
907e30f1 122
907e30f1
DL		 123extern int cpuidle_select(struct cpuidle_driver *drv,
124 struct cpuidle_device *dev);
125extern int cpuidle_enter(struct cpuidle_driver *drv,
126 struct cpuidle_device *dev, int index);
127extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
128
4f86d3a8 129extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 130extern struct cpuidle_driver *cpuidle_get_driver(void);
131extern struct cpuidle_driver *cpuidle_driver_ref(void);
132extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 133extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
134extern int cpuidle_register_device(struct cpuidle_device *dev);
135extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL		 136extern int cpuidle_register(struct cpuidle_driver *drv,
137 const struct cpumask *const coupled_cpus);
138extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB		 139extern void cpuidle_pause_and_lock(void);
140extern void cpuidle_resume_and_unlock(void);
8651f97b
PM		 141extern void cpuidle_pause(void);
142extern void cpuidle_resume(void);
4f86d3a8
LB		 143extern int cpuidle_enable_device(struct cpuidle_device *dev);
144extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO		 145extern int cpuidle_play_dead(void);
146
bf4d1b5d 147extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
4f86d3a8 148#else
d91ee586 149static inline void disable_cpuidle(void) { }
907e30f1
DL		 150static inline int cpuidle_select(struct cpuidle_driver *drv,
151 struct cpuidle_device *dev)
152{return -ENODEV; }
153static inline int cpuidle_enter(struct cpuidle_driver *drv,
154 struct cpuidle_device *dev, int index)
155{return -ENODEV; }
156static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8 157static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 158{return -ENODEV; }
752138df 159static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 160static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
161static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 162static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
163static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 164{return -ENODEV; }
4f86d3a8 165static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL		 166static inline int cpuidle_register(struct cpuidle_driver *drv,
167 const struct cpumask *const coupled_cpus)
168{return -ENODEV; }
169static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB		 170static inline void cpuidle_pause_and_lock(void) { }
171static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM		 172static inline void cpuidle_pause(void) { }
173static inline void cpuidle_resume(void) { }
4f86d3a8 174static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 175{return -ENODEV; }
4f86d3a8 176static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 177static inline int cpuidle_play_dead(void) {return -ENODEV; }
c8cc7d4d
DL		 178static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
179 struct cpuidle_device *dev) {return NULL; }
4f86d3a8
LB		 180#endif
181
20ff51a3
CC		 182#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
183void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB		 184#else
185static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
186{
187}
20ff51a3
CC		 188#endif
189
4f86d3a8
LB		 190/******************************
191 * CPUIDLE GOVERNOR INTERFACE *
192 ******************************/
193
194struct cpuidle_governor {
195 char name[CPUIDLE_NAME_LEN];
196 struct list_head governor_list;
197 unsigned int rating;
198
46bcfad7
DD		 199 int (*enable) (struct cpuidle_driver *drv,
200 struct cpuidle_device *dev);
201 void (*disable) (struct cpuidle_driver *drv,
202 struct cpuidle_device *dev);
4f86d3a8 203
46bcfad7
DD		 204 int (*select) (struct cpuidle_driver *drv,
205 struct cpuidle_device *dev);
e978aa7d 206 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 207
208 struct module *owner;
209};
210
211#ifdef CONFIG_CPU_IDLE
4f86d3a8 212extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 213#else
4f86d3a8
LB		 214static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
215{return 0;}
4f86d3a8
LB		 216#endif
217
9a0b8415 218#ifdef CONFIG_ARCH_HAS_CPU_RELAX
219#define CPUIDLE_DRIVER_STATE_START 1
220#else
221#define CPUIDLE_DRIVER_STATE_START 0
222#endif
223
4f86d3a8 224#endif /* _LINUX_CPUIDLE_H */
Michael's Linux tree.