projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[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);
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);
a0bfa137 122extern int cpuidle_idle_call(void);
4f86d3a8 123extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 124extern struct cpuidle_driver *cpuidle_get_driver(void);
125extern struct cpuidle_driver *cpuidle_driver_ref(void);
126extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 127extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
128extern int cpuidle_register_device(struct cpuidle_device *dev);
129extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL		 130extern int cpuidle_register(struct cpuidle_driver *drv,
131 const struct cpumask *const coupled_cpus);
132extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB		 133extern void cpuidle_pause_and_lock(void);
134extern void cpuidle_resume_and_unlock(void);
8651f97b
PM		 135extern void cpuidle_pause(void);
136extern void cpuidle_resume(void);
4f86d3a8
LB		 137extern int cpuidle_enable_device(struct cpuidle_device *dev);
138extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO		 139extern int cpuidle_play_dead(void);
140
bf4d1b5d 141extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
4f86d3a8 142#else
d91ee586 143static inline void disable_cpuidle(void) { }
a0bfa137 144static inline int cpuidle_idle_call(void) { return -ENODEV; }
4f86d3a8 145static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 146{return -ENODEV; }
752138df 147static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 148static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
149static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 150static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
151static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 152{return -ENODEV; }
4f86d3a8 153static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL		 154static inline int cpuidle_register(struct cpuidle_driver *drv,
155 const struct cpumask *const coupled_cpus)
156{return -ENODEV; }
157static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB		 158static inline void cpuidle_pause_and_lock(void) { }
159static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM		 160static inline void cpuidle_pause(void) { }
161static inline void cpuidle_resume(void) { }
4f86d3a8 162static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 163{return -ENODEV; }
4f86d3a8 164static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 165static inline int cpuidle_play_dead(void) {return -ENODEV; }
4f86d3a8
LB		 166#endif
167
20ff51a3
CC		 168#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
169void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB		 170#else
171static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
172{
173}
20ff51a3
CC		 174#endif
175
4f86d3a8
LB		 176/******************************
177 * CPUIDLE GOVERNOR INTERFACE *
178 ******************************/
179
180struct cpuidle_governor {
181 char name[CPUIDLE_NAME_LEN];
182 struct list_head governor_list;
183 unsigned int rating;
184
46bcfad7
DD		 185 int (*enable) (struct cpuidle_driver *drv,
186 struct cpuidle_device *dev);
187 void (*disable) (struct cpuidle_driver *drv,
188 struct cpuidle_device *dev);
4f86d3a8 189
46bcfad7
DD		 190 int (*select) (struct cpuidle_driver *drv,
191 struct cpuidle_device *dev);
e978aa7d 192 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 193
194 struct module *owner;
195};
196
197#ifdef CONFIG_CPU_IDLE
4f86d3a8 198extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 199#else
4f86d3a8
LB		 200static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
201{return 0;}
4f86d3a8
LB		 202#endif
203
9a0b8415 204#ifdef CONFIG_ARCH_HAS_CPU_RELAX
205#define CPUIDLE_DRIVER_STATE_START 1
206#else
207#define CPUIDLE_DRIVER_STATE_START 0
208#endif
209
4f86d3a8 210#endif /* _LINUX_CPUIDLE_H */
Linux kernel - Deliverables
This page took 0.480881 seconds and 5 git commands to generate.