blob: b89f67da919e1596852aa87098261a78b699dfca [file] [log] [blame]
Len Brown4f86d3a2007-10-03 18:58:00 -04001/*
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>
16#include <linux/module.h>
17#include <linux/kobject.h>
18#include <linux/completion.h>
19
20#define CPUIDLE_STATE_MAX 8
21#define CPUIDLE_NAME_LEN 16
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080022#define CPUIDLE_DESC_LEN 32
Len Brown4f86d3a2007-10-03 18:58:00 -040023
24struct cpuidle_device;
25
26
27/****************************
28 * CPUIDLE DEVICE INTERFACE *
29 ****************************/
30
31struct cpuidle_state {
32 char name[CPUIDLE_NAME_LEN];
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080033 char desc[CPUIDLE_DESC_LEN];
Len Brown4f86d3a2007-10-03 18:58:00 -040034 void *driver_data;
35
36 unsigned int flags;
37 unsigned int exit_latency; /* in US */
38 unsigned int power_usage; /* in mW */
39 unsigned int target_residency; /* in US */
40
Yi Yang8b78cf62008-02-25 08:46:12 +080041 unsigned long long usage;
42 unsigned long long time; /* in US */
Len Brown4f86d3a2007-10-03 18:58:00 -040043
44 int (*enter) (struct cpuidle_device *dev,
45 struct cpuidle_state *state);
46};
47
48/* Idle State Flags */
49#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
Ai Li71abbbf2010-08-09 17:20:13 -070050#define CPUIDLE_FLAG_IGNORE (0x100) /* ignore during this idle period */
Len Brown4f86d3a2007-10-03 18:58:00 -040051
52#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
53
54/**
55 * cpuidle_get_statedata - retrieves private driver state data
56 * @state: the state
57 */
58static inline void * cpuidle_get_statedata(struct cpuidle_state *state)
59{
60 return state->driver_data;
61}
62
63/**
64 * cpuidle_set_statedata - stores private driver state data
65 * @state: the state
66 * @data: the private data
67 */
68static inline void
69cpuidle_set_statedata(struct cpuidle_state *state, void *data)
70{
71 state->driver_data = data;
72}
73
74struct cpuidle_state_kobj {
75 struct cpuidle_state *state;
76 struct completion kobj_unregister;
77 struct kobject kobj;
78};
79
80struct cpuidle_device {
Venkatesh Pallipadidcb84f32008-05-19 19:09:27 -040081 unsigned int registered:1;
Harvey Harrisonb5556a62008-02-06 22:39:44 +010082 unsigned int enabled:1;
Ai Li71abbbf2010-08-09 17:20:13 -070083 unsigned int power_specified:1;
Len Brown4f86d3a2007-10-03 18:58:00 -040084 unsigned int cpu;
85
86 int last_residency;
87 int state_count;
88 struct cpuidle_state states[CPUIDLE_STATE_MAX];
89 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
90 struct cpuidle_state *last_state;
91
92 struct list_head device_list;
93 struct kobject kobj;
94 struct completion kobj_unregister;
95 void *governor_data;
Venkatesh Pallipadiddc081a2007-11-19 21:43:22 -050096 struct cpuidle_state *safe_state;
Ai Li71abbbf2010-08-09 17:20:13 -070097
98 int (*prepare) (struct cpuidle_device *dev);
Len Brown4f86d3a2007-10-03 18:58:00 -040099};
100
101DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
102
103/**
104 * cpuidle_get_last_residency - retrieves the last state's residency time
105 * @dev: the target CPU
106 *
107 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
108 */
109static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
110{
111 return dev->last_residency;
112}
113
114
115/****************************
116 * CPUIDLE DRIVER INTERFACE *
117 ****************************/
118
119struct cpuidle_driver {
120 char name[CPUIDLE_NAME_LEN];
121 struct module *owner;
122};
123
124#ifdef CONFIG_CPU_IDLE
Len Brownd91ee582011-04-01 18:28:35 -0400125extern void disable_cpuidle(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400126
127extern int cpuidle_register_driver(struct cpuidle_driver *drv);
Len Brown752138d2010-05-22 16:57:26 -0400128struct cpuidle_driver *cpuidle_get_driver(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400129extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
130extern int cpuidle_register_device(struct cpuidle_device *dev);
131extern void cpuidle_unregister_device(struct cpuidle_device *dev);
132
133extern void cpuidle_pause_and_lock(void);
134extern void cpuidle_resume_and_unlock(void);
135extern int cpuidle_enable_device(struct cpuidle_device *dev);
136extern void cpuidle_disable_device(struct cpuidle_device *dev);
137
138#else
Len Brownd91ee582011-04-01 18:28:35 -0400139static inline void disable_cpuidle(void) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400140
141static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
Len Brown6b2c6762010-05-11 16:50:52 -0400142{return -ENODEV; }
Len Brown752138d2010-05-22 16:57:26 -0400143static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400144static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
145static inline int cpuidle_register_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400146{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400147static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
148
149static inline void cpuidle_pause_and_lock(void) { }
150static inline void cpuidle_resume_and_unlock(void) { }
151static inline int cpuidle_enable_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400152{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400153static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
154
155#endif
156
157/******************************
158 * CPUIDLE GOVERNOR INTERFACE *
159 ******************************/
160
161struct cpuidle_governor {
162 char name[CPUIDLE_NAME_LEN];
163 struct list_head governor_list;
164 unsigned int rating;
165
166 int (*enable) (struct cpuidle_device *dev);
167 void (*disable) (struct cpuidle_device *dev);
168
169 int (*select) (struct cpuidle_device *dev);
170 void (*reflect) (struct cpuidle_device *dev);
171
172 struct module *owner;
173};
174
175#ifdef CONFIG_CPU_IDLE
176
177extern int cpuidle_register_governor(struct cpuidle_governor *gov);
178extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
179
180#else
181
182static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
183{return 0;}
184static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
185
186#endif
187
venkatesh.pallipadi@intel.com9a0b8412008-01-31 17:35:06 -0800188#ifdef CONFIG_ARCH_HAS_CPU_RELAX
189#define CPUIDLE_DRIVER_STATE_START 1
190#else
191#define CPUIDLE_DRIVER_STATE_START 0
192#endif
193
Len Brown4f86d3a2007-10-03 18:58:00 -0400194#endif /* _LINUX_CPUIDLE_H */