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