projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ACPI: intel_idle : break dependency between modules
[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>
4f86d3a8
LB		 16#include <linux/kobject.h>
17#include <linux/completion.h>
e1689795 18#include <linux/hrtimer.h>
4f86d3a8
LB		 19
20#define CPUIDLE_STATE_MAX 8
21#define CPUIDLE_NAME_LEN 16
4fcb2fcd 22#define CPUIDLE_DESC_LEN 32
4f86d3a8 23
de477254
PG		 24struct module;
25
4f86d3a8 26struct cpuidle_device;
46bcfad7 27struct cpuidle_driver;
4f86d3a8
LB		 28
29
30/****************************
31 * CPUIDLE DEVICE INTERFACE *
32 ****************************/
33
4202735e
DD		 34struct cpuidle_state_usage {
35 void *driver_data;
36
dc7fd275 37 unsigned long long disable;
4202735e
DD		 38 unsigned long long usage;
39 unsigned long long time; /* in US */
40};
41
4f86d3a8
LB		 42struct cpuidle_state {
43 char name[CPUIDLE_NAME_LEN];
4fcb2fcd 44 char desc[CPUIDLE_DESC_LEN];
4f86d3a8
LB		 45
46 unsigned int flags;
47 unsigned int exit_latency; /* in US */
02401c06 48 int power_usage; /* in mW */
4f86d3a8
LB		 49 unsigned int target_residency; /* in US */
50
4f86d3a8 51 int (*enter) (struct cpuidle_device *dev,
46bcfad7 52 struct cpuidle_driver *drv,
e978aa7d 53 int index);
1a022e3f
BO		 54
55 int (*enter_dead) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 56};
57
58/* Idle State Flags */
59#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4f86d3a8
LB		 60
61#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
62
63/**
64 * cpuidle_get_statedata - retrieves private driver state data
4202735e 65 * @st_usage: the state usage statistics
4f86d3a8 66 */
4202735e 67static inline void *cpuidle_get_statedata(struct cpuidle_state_usage *st_usage)
4f86d3a8 68{
4202735e 69 return st_usage->driver_data;
4f86d3a8
LB		 70}
71
72/**
73 * cpuidle_set_statedata - stores private driver state data
4202735e 74 * @st_usage: the state usage statistics
4f86d3a8
LB		 75 * @data: the private data
76 */
77static inline void
4202735e 78cpuidle_set_statedata(struct cpuidle_state_usage *st_usage, void *data)
4f86d3a8 79{
4202735e 80 st_usage->driver_data = data;
4f86d3a8
LB		 81}
82
83struct cpuidle_state_kobj {
84 struct cpuidle_state *state;
4202735e 85 struct cpuidle_state_usage *state_usage;
4f86d3a8
LB		 86 struct completion kobj_unregister;
87 struct kobject kobj;
88};
89
90struct cpuidle_device {
dcb84f33 91 unsigned int registered:1;
b5556a67 92 unsigned int enabled:1;
4f86d3a8
LB		 93 unsigned int cpu;
94
95 int last_residency;
96 int state_count;
4202735e 97 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 98 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
4f86d3a8
LB		 99
100 struct list_head device_list;
101 struct kobject kobj;
102 struct completion kobj_unregister;
4f86d3a8
LB		 103};
104
105DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
106
107/**
108 * cpuidle_get_last_residency - retrieves the last state's residency time
109 * @dev: the target CPU
110 *
111 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
112 */
113static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
114{
115 return dev->last_residency;
116}
117
118
119/****************************
120 * CPUIDLE DRIVER INTERFACE *
121 ****************************/
122
123struct cpuidle_driver {
db70b044 124 const char *name;
4f86d3a8 125 struct module *owner;
46bcfad7
DD		 126
127 unsigned int power_specified:1;
e1689795
RL		 128 /* set to 1 to use the core cpuidle time keeping (for all states). */
129 unsigned int en_core_tk_irqen:1;
46bcfad7
DD		 130 struct cpuidle_state states[CPUIDLE_STATE_MAX];
131 int state_count;
132 int safe_state_index;
4f86d3a8
LB		 133};
134
135#ifdef CONFIG_CPU_IDLE
d91ee586 136extern void disable_cpuidle(void);
a0bfa137 137extern int cpuidle_idle_call(void);
4f86d3a8 138extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 139extern struct cpuidle_driver *cpuidle_get_driver(void);
140extern struct cpuidle_driver *cpuidle_driver_ref(void);
141extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 142extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
143extern int cpuidle_register_device(struct cpuidle_device *dev);
144extern void cpuidle_unregister_device(struct cpuidle_device *dev);
145
146extern void cpuidle_pause_and_lock(void);
147extern void cpuidle_resume_and_unlock(void);
148extern int cpuidle_enable_device(struct cpuidle_device *dev);
149extern void cpuidle_disable_device(struct cpuidle_device *dev);
e1689795
RL		 150extern int cpuidle_wrap_enter(struct cpuidle_device *dev,
151 struct cpuidle_driver *drv, int index,
152 int (*enter)(struct cpuidle_device *dev,
153 struct cpuidle_driver *drv, int index));
1a022e3f
BO		 154extern int cpuidle_play_dead(void);
155
4f86d3a8 156#else
d91ee586 157static inline void disable_cpuidle(void) { }
a0bfa137 158static inline int cpuidle_idle_call(void) { return -ENODEV; }
4f86d3a8 159static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 160{return -ENODEV; }
752138df 161static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 162static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
163static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 164static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
165static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 166{return -ENODEV; }
4f86d3a8
LB		 167static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
168
169static inline void cpuidle_pause_and_lock(void) { }
170static inline void cpuidle_resume_and_unlock(void) { }
171static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 172{return -ENODEV; }
4f86d3a8 173static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
e1689795
RL		 174static inline int cpuidle_wrap_enter(struct cpuidle_device *dev,
175 struct cpuidle_driver *drv, int index,
176 int (*enter)(struct cpuidle_device *dev,
177 struct cpuidle_driver *drv, int index))
178{ return -ENODEV; }
1a022e3f 179static inline int cpuidle_play_dead(void) {return -ENODEV; }
4f86d3a8
LB		 180
181#endif
182
183/******************************
184 * CPUIDLE GOVERNOR INTERFACE *
185 ******************************/
186
187struct cpuidle_governor {
188 char name[CPUIDLE_NAME_LEN];
189 struct list_head governor_list;
190 unsigned int rating;
191
46bcfad7
DD		 192 int (*enable) (struct cpuidle_driver *drv,
193 struct cpuidle_device *dev);
194 void (*disable) (struct cpuidle_driver *drv,
195 struct cpuidle_device *dev);
4f86d3a8 196
46bcfad7
DD		 197 int (*select) (struct cpuidle_driver *drv,
198 struct cpuidle_device *dev);
e978aa7d 199 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 200
201 struct module *owner;
202};
203
204#ifdef CONFIG_CPU_IDLE
205
206extern int cpuidle_register_governor(struct cpuidle_governor *gov);
207extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
208
209#else
210
211static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
212{return 0;}
213static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
214
215#endif
216
9a0b8415 217#ifdef CONFIG_ARCH_HAS_CPU_RELAX
218#define CPUIDLE_DRIVER_STATE_START 1
219#else
220#define CPUIDLE_DRIVER_STATE_START 0
221#endif
222
4f86d3a8 223#endif /* _LINUX_CPUIDLE_H */
Linux kernel - Deliverables
This page took 0.610522 seconds and 5 git commands to generate.