projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[deliverable/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);
124cf911
RW		 53
54 /*
55 * CPUs execute ->enter_freeze with the local tick or entire timekeeping
56 * suspended, so it must not re-enable interrupts at any point (even
57 * temporarily) or attempt to change states of clock event devices.
58 */
59 void (*enter_freeze) (struct cpuidle_device *dev,
60 struct cpuidle_driver *drv,
61 int index);
4f86d3a8
LB		 62};
63
64/* Idle State Flags */
4126c019 65#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 66#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB		 67
68#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
69
728ce22b 70struct cpuidle_device_kobj;
1a706438
DL		 71struct cpuidle_state_kobj;
72struct cpuidle_driver_kobj;
728ce22b 73
4f86d3a8 74struct cpuidle_device {
dcb84f33 75 unsigned int registered:1;
b5556a67 76 unsigned int enabled:1;
4f86d3a8
LB		 77 unsigned int cpu;
78
79 int last_residency;
4202735e 80 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 81 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 82 struct cpuidle_driver_kobj *kobj_driver;
728ce22b 83 struct cpuidle_device_kobj *kobj_dev;
4f86d3a8 84 struct list_head device_list;
4126c019
CC		 85
86#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
4126c019
CC		 87 cpumask_t coupled_cpus;
88 struct cpuidle_coupled *coupled;
89#endif
4f86d3a8
LB		 90};
91
92DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
f08dbf8a 93DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
4f86d3a8
LB		 94
95/**
96 * cpuidle_get_last_residency - retrieves the last state's residency time
97 * @dev: the target CPU
4f86d3a8
LB		 98 */
99static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
100{
101 return dev->last_residency;
102}
103
104
105/****************************
106 * CPUIDLE DRIVER INTERFACE *
107 ****************************/
108
109struct cpuidle_driver {
db70b044 110 const char *name;
4f86d3a8 111 struct module *owner;
42f67f2a 112 int refcnt;
46bcfad7 113
a06df062
DL		 114 /* used by the cpuidle framework to setup the broadcast timer */
115 unsigned int bctimer:1;
8aef33a7 116 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD		 117 struct cpuidle_state states[CPUIDLE_STATE_MAX];
118 int state_count;
119 int safe_state_index;
82467a5a
DL		 120
121 /* the driver handles the cpus in cpumask */
6587fca2 122 struct cpumask *cpumask;
4f86d3a8
LB		 123};
124
125#ifdef CONFIG_CPU_IDLE
d91ee586 126extern void disable_cpuidle(void);
ef2b22ac
RW		 127extern bool cpuidle_not_available(struct cpuidle_driver *drv,
128 struct cpuidle_device *dev);
907e30f1 129
907e30f1
DL		 130extern int cpuidle_select(struct cpuidle_driver *drv,
131 struct cpuidle_device *dev);
132extern int cpuidle_enter(struct cpuidle_driver *drv,
133 struct cpuidle_device *dev, int index);
134extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
135
4f86d3a8 136extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 137extern struct cpuidle_driver *cpuidle_get_driver(void);
138extern struct cpuidle_driver *cpuidle_driver_ref(void);
139extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 140extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
141extern int cpuidle_register_device(struct cpuidle_device *dev);
142extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL		 143extern int cpuidle_register(struct cpuidle_driver *drv,
144 const struct cpumask *const coupled_cpus);
145extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB		 146extern void cpuidle_pause_and_lock(void);
147extern void cpuidle_resume_and_unlock(void);
8651f97b
PM		 148extern void cpuidle_pause(void);
149extern void cpuidle_resume(void);
4f86d3a8
LB		 150extern int cpuidle_enable_device(struct cpuidle_device *dev);
151extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO		 152extern int cpuidle_play_dead(void);
153
bf4d1b5d 154extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
4f86d3a8 155#else
d91ee586 156static inline void disable_cpuidle(void) { }
ef2b22ac
RW		 157static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
158 struct cpuidle_device *dev)
159{return true; }
907e30f1
DL		 160static inline int cpuidle_select(struct cpuidle_driver *drv,
161 struct cpuidle_device *dev)
162{return -ENODEV; }
163static inline int cpuidle_enter(struct cpuidle_driver *drv,
164 struct cpuidle_device *dev, int index)
165{return -ENODEV; }
166static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8 167static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 168{return -ENODEV; }
752138df 169static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 170static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
171static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 172static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
173static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 174{return -ENODEV; }
4f86d3a8 175static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL		 176static inline int cpuidle_register(struct cpuidle_driver *drv,
177 const struct cpumask *const coupled_cpus)
178{return -ENODEV; }
179static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB		 180static inline void cpuidle_pause_and_lock(void) { }
181static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM		 182static inline void cpuidle_pause(void) { }
183static inline void cpuidle_resume(void) { }
4f86d3a8 184static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 185{return -ENODEV; }
4f86d3a8 186static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 187static inline int cpuidle_play_dead(void) {return -ENODEV; }
87e9b9f1
RW		 188static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
189 struct cpuidle_device *dev) {return NULL; }
190#endif
191
192#if defined(CONFIG_CPU_IDLE) && defined(CONFIG_SUSPEND)
193extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
194 struct cpuidle_device *dev);
195extern int cpuidle_enter_freeze(struct cpuidle_driver *drv,
196 struct cpuidle_device *dev);
197#else
ef2b22ac
RW		 198static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
199 struct cpuidle_device *dev)
200{return -ENODEV; }
201static inline int cpuidle_enter_freeze(struct cpuidle_driver *drv,
202 struct cpuidle_device *dev)
203{return -ENODEV; }
4f86d3a8
LB		 204#endif
205
faad3849
RW		 206/* kernel/sched/idle.c */
207extern void sched_idle_set_state(struct cpuidle_state *idle_state);
827a5aef 208extern void default_idle_call(void);
faad3849 209
20ff51a3
CC		 210#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
211void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB		 212#else
213static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
214{
215}
20ff51a3
CC		 216#endif
217
4f86d3a8
LB		 218/******************************
219 * CPUIDLE GOVERNOR INTERFACE *
220 ******************************/
221
222struct cpuidle_governor {
223 char name[CPUIDLE_NAME_LEN];
224 struct list_head governor_list;
225 unsigned int rating;
226
46bcfad7
DD		 227 int (*enable) (struct cpuidle_driver *drv,
228 struct cpuidle_device *dev);
229 void (*disable) (struct cpuidle_driver *drv,
230 struct cpuidle_device *dev);
4f86d3a8 231
46bcfad7
DD		 232 int (*select) (struct cpuidle_driver *drv,
233 struct cpuidle_device *dev);
e978aa7d 234 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 235
236 struct module *owner;
237};
238
239#ifdef CONFIG_CPU_IDLE
4f86d3a8 240extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 241#else
4f86d3a8
LB		 242static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
243{return 0;}
4f86d3a8
LB		 244#endif
245
9a0b8415 246#ifdef CONFIG_ARCH_HAS_CPU_RELAX
247#define CPUIDLE_DRIVER_STATE_START 1
248#else
249#define CPUIDLE_DRIVER_STATE_START 0
250#endif
251
4f86d3a8 252#endif /* _LINUX_CPUIDLE_H */
Linux kernel - Deliverables
This page took 0.710062 seconds and 5 git commands to generate.