blob: bb31373c3478bdb0ed97dcf8856d1b81ccdc76e3 [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>
Robert Leee1689792012-03-20 15:22:42 -050016#include <linux/hrtimer.h>
Len Brown4f86d3a2007-10-03 18:58:00 -040017
Len Brown86239ce2013-02-27 13:18:50 -050018#define CPUIDLE_STATE_MAX 10
Len Brown4f86d3a2007-10-03 18:58:00 -040019#define CPUIDLE_NAME_LEN 16
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080020#define CPUIDLE_DESC_LEN 32
Len Brown4f86d3a2007-10-03 18:58:00 -040021
Paul Gortmakerde477252011-05-26 13:46:22 -040022struct module;
23
Len Brown4f86d3a2007-10-03 18:58:00 -040024struct cpuidle_device;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +053025struct cpuidle_driver;
Len Brown4f86d3a2007-10-03 18:58:00 -040026
27
28/****************************
29 * CPUIDLE DEVICE INTERFACE *
30 ****************************/
31
Deepthi Dharwar42027352011-10-28 16:20:33 +053032struct cpuidle_state_usage {
ShuoX Liudc7fd272012-07-03 19:05:31 +020033 unsigned long long disable;
Deepthi Dharwar42027352011-10-28 16:20:33 +053034 unsigned long long usage;
35 unsigned long long time; /* in US */
36};
37
Len Brown4f86d3a2007-10-03 18:58:00 -040038struct cpuidle_state {
39 char name[CPUIDLE_NAME_LEN];
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080040 char desc[CPUIDLE_DESC_LEN];
Len Brown4f86d3a2007-10-03 18:58:00 -040041
42 unsigned int flags;
43 unsigned int exit_latency; /* in US */
Boris Ostrovsky02401c02012-03-13 19:55:10 +010044 int power_usage; /* in mW */
Len Brown4f86d3a2007-10-03 18:58:00 -040045 unsigned int target_residency; /* in US */
Rafael J. Wysockicbc9ef02012-07-03 19:07:42 +020046 bool disabled; /* disabled on all CPUs */
Len Brown4f86d3a2007-10-03 18:58:00 -040047
Len Brown4f86d3a2007-10-03 18:58:00 -040048 int (*enter) (struct cpuidle_device *dev,
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +053049 struct cpuidle_driver *drv,
Deepthi Dharware978aa72011-10-28 16:20:09 +053050 int index);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +010051
52 int (*enter_dead) (struct cpuidle_device *dev, int index);
Rafael J. Wysocki124cf9112015-02-13 23:50:43 +010053
54 /*
55 * CPUs execute ->enter_freeze with the local tick or entire timekeeping
56 * suspended, so it must not re-enable interrupts at any point (even
57 * temporarily) or attempt to change states of clock event devices.
58 */
59 void (*enter_freeze) (struct cpuidle_device *dev,
60 struct cpuidle_driver *drv,
61 int index);
Len Brown4f86d3a2007-10-03 18:58:00 -040062};
63
64/* Idle State Flags */
Colin Cross4126c012012-05-07 17:57:41 -070065#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
Daniel Lezcanob60e6a02013-03-21 12:21:31 +000066#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
Len Brown4f86d3a2007-10-03 18:58:00 -040067
68#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
69
Daniel Lezcano728ce222013-06-12 15:08:51 +020070struct cpuidle_device_kobj;
Daniel Lezcano1a706432013-06-12 15:08:52 +020071struct cpuidle_state_kobj;
72struct cpuidle_driver_kobj;
Daniel Lezcano728ce222013-06-12 15:08:51 +020073
Len Brown4f86d3a2007-10-03 18:58:00 -040074struct cpuidle_device {
Venkatesh Pallipadidcb84f32008-05-19 19:09:27 -040075 unsigned int registered:1;
Harvey Harrisonb5556a62008-02-06 22:39:44 +010076 unsigned int enabled:1;
Len Brown4f86d3a2007-10-03 18:58:00 -040077 unsigned int cpu;
78
79 int last_residency;
Deepthi Dharwar42027352011-10-28 16:20:33 +053080 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
Len Brown4f86d3a2007-10-03 18:58:00 -040081 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +000082 struct cpuidle_driver_kobj *kobj_driver;
Daniel Lezcano728ce222013-06-12 15:08:51 +020083 struct cpuidle_device_kobj *kobj_dev;
Len Brown4f86d3a2007-10-03 18:58:00 -040084 struct list_head device_list;
Colin Cross4126c012012-05-07 17:57:41 -070085
86#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
Colin Cross4126c012012-05-07 17:57:41 -070087 cpumask_t coupled_cpus;
88 struct cpuidle_coupled *coupled;
89#endif
Len Brown4f86d3a2007-10-03 18:58:00 -040090};
91
92DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
Paul Burtonf08dbf82014-01-08 11:23:35 +000093DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
Len Brown4f86d3a2007-10-03 18:58:00 -040094
95/**
96 * cpuidle_get_last_residency - retrieves the last state's residency time
97 * @dev: the target CPU
Len Brown4f86d3a2007-10-03 18:58:00 -040098 */
99static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
100{
101 return dev->last_residency;
102}
103
104
105/****************************
106 * CPUIDLE DRIVER INTERFACE *
107 ****************************/
108
109struct cpuidle_driver {
Daniel Lezcanodb70b042012-03-26 14:51:27 +0200110 const char *name;
Len Brown4f86d3a2007-10-03 18:58:00 -0400111 struct module *owner;
Daniel Lezcano42f67f22012-10-31 16:44:45 +0000112 int refcnt;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530113
Daniel Lezcanoa06df062013-03-27 10:22:10 +0000114 /* used by the cpuidle framework to setup the broadcast timer */
115 unsigned int bctimer:1;
Daniel Lezcano8aef33a2013-01-15 14:18:04 +0100116 /* states array must be ordered in decreasing power consumption */
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530117 struct cpuidle_state states[CPUIDLE_STATE_MAX];
118 int state_count;
119 int safe_state_index;
Daniel Lezcano82467a52013-06-07 21:53:09 +0000120
121 /* the driver handles the cpus in cpumask */
Viresh Kumar6587fca2013-10-03 21:26:40 +0530122 struct cpumask *cpumask;
Len Brown4f86d3a2007-10-03 18:58:00 -0400123};
124
125#ifdef CONFIG_CPU_IDLE
Len Brownd91ee582011-04-01 18:28:35 -0400126extern void disable_cpuidle(void);
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100127extern bool cpuidle_not_available(struct cpuidle_driver *drv,
128 struct cpuidle_device *dev);
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100129
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100130extern int cpuidle_select(struct cpuidle_driver *drv,
131 struct cpuidle_device *dev);
132extern int cpuidle_enter(struct cpuidle_driver *drv,
133 struct cpuidle_device *dev, int index);
134extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
135
Len Brown4f86d3a2007-10-03 18:58:00 -0400136extern int cpuidle_register_driver(struct cpuidle_driver *drv);
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200137extern struct cpuidle_driver *cpuidle_get_driver(void);
138extern struct cpuidle_driver *cpuidle_driver_ref(void);
139extern void cpuidle_driver_unref(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400140extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
141extern int cpuidle_register_device(struct cpuidle_device *dev);
142extern void cpuidle_unregister_device(struct cpuidle_device *dev);
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000143extern int cpuidle_register(struct cpuidle_driver *drv,
144 const struct cpumask *const coupled_cpus);
145extern void cpuidle_unregister(struct cpuidle_driver *drv);
Len Brown4f86d3a2007-10-03 18:58:00 -0400146extern void cpuidle_pause_and_lock(void);
147extern void cpuidle_resume_and_unlock(void);
Preeti U Murthy8651f972012-07-09 10:12:56 +0200148extern void cpuidle_pause(void);
149extern void cpuidle_resume(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400150extern int cpuidle_enable_device(struct cpuidle_device *dev);
151extern void cpuidle_disable_device(struct cpuidle_device *dev);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100152extern int cpuidle_play_dead(void);
153
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +0000154extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
Catalin Marinas9bd616e2016-06-01 18:52:16 +0100155static inline struct cpuidle_device *cpuidle_get_device(void)
156{return __this_cpu_read(cpuidle_devices); }
Len Brown4f86d3a2007-10-03 18:58:00 -0400157#else
Len Brownd91ee582011-04-01 18:28:35 -0400158static inline void disable_cpuidle(void) { }
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100159static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
160 struct cpuidle_device *dev)
161{return true; }
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100162static inline int cpuidle_select(struct cpuidle_driver *drv,
163 struct cpuidle_device *dev)
164{return -ENODEV; }
165static inline int cpuidle_enter(struct cpuidle_driver *drv,
166 struct cpuidle_device *dev, int index)
167{return -ENODEV; }
168static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400169static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
Len Brown6b2c6762010-05-11 16:50:52 -0400170{return -ENODEV; }
Len Brown752138d2010-05-22 16:57:26 -0400171static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200172static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
173static inline void cpuidle_driver_unref(void) {}
Len Brown4f86d3a2007-10-03 18:58:00 -0400174static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
175static inline int cpuidle_register_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400176{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400177static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000178static inline int cpuidle_register(struct cpuidle_driver *drv,
179 const struct cpumask *const coupled_cpus)
180{return -ENODEV; }
181static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400182static inline void cpuidle_pause_and_lock(void) { }
183static inline void cpuidle_resume_and_unlock(void) { }
Preeti U Murthy8651f972012-07-09 10:12:56 +0200184static inline void cpuidle_pause(void) { }
185static inline void cpuidle_resume(void) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400186static inline int cpuidle_enable_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400187{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400188static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100189static inline int cpuidle_play_dead(void) {return -ENODEV; }
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200190static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
191 struct cpuidle_device *dev) {return NULL; }
Catalin Marinas9bd616e2016-06-01 18:52:16 +0100192static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; }
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200193#endif
194
195#if defined(CONFIG_CPU_IDLE) && defined(CONFIG_SUSPEND)
196extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
197 struct cpuidle_device *dev);
198extern int cpuidle_enter_freeze(struct cpuidle_driver *drv,
199 struct cpuidle_device *dev);
200#else
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100201static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
202 struct cpuidle_device *dev)
203{return -ENODEV; }
204static inline int cpuidle_enter_freeze(struct cpuidle_driver *drv,
205 struct cpuidle_device *dev)
206{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400207#endif
208
Rafael J. Wysockifaad3842015-05-10 01:18:03 +0200209/* kernel/sched/idle.c */
210extern void sched_idle_set_state(struct cpuidle_state *idle_state);
Rafael J. Wysocki827a5ae2015-05-10 01:18:46 +0200211extern void default_idle_call(void);
Rafael J. Wysockifaad3842015-05-10 01:18:03 +0200212
Colin Cross20ff51a2012-05-07 17:57:42 -0700213#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
214void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
Arnd Bergmannc7a9b092012-08-15 20:51:54 +0000215#else
216static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
217{
218}
Colin Cross20ff51a2012-05-07 17:57:42 -0700219#endif
220
Len Brown4f86d3a2007-10-03 18:58:00 -0400221/******************************
222 * CPUIDLE GOVERNOR INTERFACE *
223 ******************************/
224
225struct cpuidle_governor {
226 char name[CPUIDLE_NAME_LEN];
227 struct list_head governor_list;
228 unsigned int rating;
229
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530230 int (*enable) (struct cpuidle_driver *drv,
231 struct cpuidle_device *dev);
232 void (*disable) (struct cpuidle_driver *drv,
233 struct cpuidle_device *dev);
Len Brown4f86d3a2007-10-03 18:58:00 -0400234
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530235 int (*select) (struct cpuidle_driver *drv,
236 struct cpuidle_device *dev);
Deepthi Dharware978aa72011-10-28 16:20:09 +0530237 void (*reflect) (struct cpuidle_device *dev, int index);
Len Brown4f86d3a2007-10-03 18:58:00 -0400238
239 struct module *owner;
240};
241
242#ifdef CONFIG_CPU_IDLE
Len Brown4f86d3a2007-10-03 18:58:00 -0400243extern int cpuidle_register_governor(struct cpuidle_governor *gov);
Len Brown4f86d3a2007-10-03 18:58:00 -0400244#else
Len Brown4f86d3a2007-10-03 18:58:00 -0400245static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
246{return 0;}
Len Brown4f86d3a2007-10-03 18:58:00 -0400247#endif
248
venkatesh.pallipadi@intel.com9a0b8412008-01-31 17:35:06 -0800249#ifdef CONFIG_ARCH_HAS_CPU_RELAX
250#define CPUIDLE_DRIVER_STATE_START 1
251#else
252#define CPUIDLE_DRIVER_STATE_START 0
253#endif
254
Sudeep Holla220276e2016-07-19 18:52:56 +0100255#define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \
256({ \
257 int __ret; \
258 \
259 if (!idx) { \
260 cpu_do_idle(); \
261 return idx; \
262 } \
263 \
264 __ret = cpu_pm_enter(); \
265 if (!__ret) { \
266 __ret = low_level_idle_enter(idx); \
267 cpu_pm_exit(); \
268 } \
269 \
270 __ret ? -1 : idx; \
271})
272
Len Brown4f86d3a2007-10-03 18:58:00 -0400273#endif /* _LINUX_CPUIDLE_H */