2 * cpuidle.h - a generic framework for CPU idle power management
4 * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
8 * This code is licenced under the GPL.
11 #ifndef _LINUX_CPUIDLE_H
12 #define _LINUX_CPUIDLE_H
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>
20 #define CPUIDLE_STATE_MAX 8
21 #define CPUIDLE_NAME_LEN 16
22 #define CPUIDLE_DESC_LEN 32
24 struct cpuidle_device
;
27 /****************************
28 * CPUIDLE DEVICE INTERFACE *
29 ****************************/
31 struct cpuidle_state
{
32 char name
[CPUIDLE_NAME_LEN
];
33 char desc
[CPUIDLE_DESC_LEN
];
37 unsigned int exit_latency
; /* in US */
38 unsigned int power_usage
; /* in mW */
39 unsigned int target_residency
; /* in US */
41 unsigned long long usage
;
42 unsigned long long time
; /* in US */
44 int (*enter
) (struct cpuidle_device
*dev
,
45 struct cpuidle_state
*state
);
48 /* Idle State Flags */
49 #define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
50 #define CPUIDLE_FLAG_CHECK_BM (0x02) /* BM activity will exit state */
51 #define CPUIDLE_FLAG_POLL (0x10) /* no latency, no savings */
52 #define CPUIDLE_FLAG_SHALLOW (0x20) /* low latency, minimal savings */
53 #define CPUIDLE_FLAG_BALANCED (0x40) /* medium latency, moderate savings */
54 #define CPUIDLE_FLAG_DEEP (0x80) /* high latency, large savings */
56 #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
59 * cpuidle_get_statedata - retrieves private driver state data
62 static inline void * cpuidle_get_statedata(struct cpuidle_state
*state
)
64 return state
->driver_data
;
68 * cpuidle_set_statedata - stores private driver state data
70 * @data: the private data
73 cpuidle_set_statedata(struct cpuidle_state
*state
, void *data
)
75 state
->driver_data
= data
;
78 struct cpuidle_state_kobj
{
79 struct cpuidle_state
*state
;
80 struct completion kobj_unregister
;
84 struct cpuidle_device
{
85 unsigned int registered
:1;
86 unsigned int enabled
:1;
91 struct cpuidle_state states
[CPUIDLE_STATE_MAX
];
92 struct cpuidle_state_kobj
*kobjs
[CPUIDLE_STATE_MAX
];
93 struct cpuidle_state
*last_state
;
95 struct list_head device_list
;
97 struct completion kobj_unregister
;
99 struct cpuidle_state
*safe_state
;
102 DECLARE_PER_CPU(struct cpuidle_device
*, cpuidle_devices
);
105 * cpuidle_get_last_residency - retrieves the last state's residency time
106 * @dev: the target CPU
108 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
110 static inline int cpuidle_get_last_residency(struct cpuidle_device
*dev
)
112 return dev
->last_residency
;
116 /****************************
117 * CPUIDLE DRIVER INTERFACE *
118 ****************************/
120 struct cpuidle_driver
{
121 char name
[CPUIDLE_NAME_LEN
];
122 struct module
*owner
;
125 #ifdef CONFIG_CPU_IDLE
127 extern int cpuidle_register_driver(struct cpuidle_driver
*drv
);
128 struct cpuidle_driver
*cpuidle_get_driver(void);
129 extern void cpuidle_unregister_driver(struct cpuidle_driver
*drv
);
130 extern int cpuidle_register_device(struct cpuidle_device
*dev
);
131 extern void cpuidle_unregister_device(struct cpuidle_device
*dev
);
133 extern void cpuidle_pause_and_lock(void);
134 extern void cpuidle_resume_and_unlock(void);
135 extern int cpuidle_enable_device(struct cpuidle_device
*dev
);
136 extern void cpuidle_disable_device(struct cpuidle_device
*dev
);
140 static inline int cpuidle_register_driver(struct cpuidle_driver
*drv
)
142 static inline struct cpuidle_driver
*cpuidle_get_driver(void) {return NULL
; }
143 static inline void cpuidle_unregister_driver(struct cpuidle_driver
*drv
) { }
144 static inline int cpuidle_register_device(struct cpuidle_device
*dev
)
146 static inline void cpuidle_unregister_device(struct cpuidle_device
*dev
) { }
148 static inline void cpuidle_pause_and_lock(void) { }
149 static inline void cpuidle_resume_and_unlock(void) { }
150 static inline int cpuidle_enable_device(struct cpuidle_device
*dev
)
152 static inline void cpuidle_disable_device(struct cpuidle_device
*dev
) { }
156 /******************************
157 * CPUIDLE GOVERNOR INTERFACE *
158 ******************************/
160 struct cpuidle_governor
{
161 char name
[CPUIDLE_NAME_LEN
];
162 struct list_head governor_list
;
165 int (*enable
) (struct cpuidle_device
*dev
);
166 void (*disable
) (struct cpuidle_device
*dev
);
168 int (*select
) (struct cpuidle_device
*dev
);
169 void (*reflect
) (struct cpuidle_device
*dev
);
171 struct module
*owner
;
174 #ifdef CONFIG_CPU_IDLE
176 extern int cpuidle_register_governor(struct cpuidle_governor
*gov
);
177 extern void cpuidle_unregister_governor(struct cpuidle_governor
*gov
);
181 static inline int cpuidle_register_governor(struct cpuidle_governor
*gov
)
183 static inline void cpuidle_unregister_governor(struct cpuidle_governor
*gov
) { }
187 #ifdef CONFIG_ARCH_HAS_CPU_RELAX
188 #define CPUIDLE_DRIVER_STATE_START 1
190 #define CPUIDLE_DRIVER_STATE_START 0
193 #endif /* _LINUX_CPUIDLE_H */