blob: d262f620890efc300712517bb7fb881da415b138 [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 Dharwar4202735e2011-10-28 16:20:33 +053032struct cpuidle_state_usage {
ShuoX Liudc7fd272012-07-03 19:05:31 +020033 unsigned long long disable;
Deepthi Dharwar4202735e2011-10-28 16:20:33 +053034 unsigned long long usage;
35 unsigned long long time; /* in US */
Rafael J. Wysocki64bdff62018-03-14 12:27:21 +010036#ifdef CONFIG_SUSPEND
37 unsigned long long s2idle_usage;
38 unsigned long long s2idle_time; /* in US */
39#endif
Deepthi Dharwar4202735e2011-10-28 16:20:33 +053040};
41
Len Brown4f86d3a2007-10-03 18:58:00 -040042struct cpuidle_state {
43 char name[CPUIDLE_NAME_LEN];
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -080044 char desc[CPUIDLE_DESC_LEN];
Len Brown4f86d3a2007-10-03 18:58:00 -040045
46 unsigned int flags;
47 unsigned int exit_latency; /* in US */
Boris Ostrovsky02401c02012-03-13 19:55:10 +010048 int power_usage; /* in mW */
Len Brown4f86d3a2007-10-03 18:58:00 -040049 unsigned int target_residency; /* in US */
Rafael J. Wysockicbc9ef02012-07-03 19:07:42 +020050 bool disabled; /* disabled on all CPUs */
Len Brown4f86d3a2007-10-03 18:58:00 -040051
Len Brown4f86d3a2007-10-03 18:58:00 -040052 int (*enter) (struct cpuidle_device *dev,
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +053053 struct cpuidle_driver *drv,
Deepthi Dharware978aa72011-10-28 16:20:09 +053054 int index);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +010055
56 int (*enter_dead) (struct cpuidle_device *dev, int index);
Rafael J. Wysocki124cf9112015-02-13 23:50:43 +010057
58 /*
Rafael J. Wysocki28ba0862017-08-10 00:14:45 +020059 * CPUs execute ->enter_s2idle with the local tick or entire timekeeping
Rafael J. Wysocki124cf9112015-02-13 23:50:43 +010060 * suspended, so it must not re-enable interrupts at any point (even
61 * temporarily) or attempt to change states of clock event devices.
62 */
Rafael J. Wysocki28ba0862017-08-10 00:14:45 +020063 void (*enter_s2idle) (struct cpuidle_device *dev,
Rafael J. Wysocki124cf9112015-02-13 23:50:43 +010064 struct cpuidle_driver *drv,
65 int index);
Len Brown4f86d3a2007-10-03 18:58:00 -040066};
67
68/* Idle State Flags */
Gautham R. Shenoy9e9fc6f2017-01-25 14:06:27 +053069#define CPUIDLE_FLAG_NONE (0x00)
Rafael J. Wysockidc2251b2017-08-23 23:19:57 +020070#define CPUIDLE_FLAG_POLLING (0x01) /* polling state */
Colin Cross4126c012012-05-07 17:57:41 -070071#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
Daniel Lezcanob60e6a02013-03-21 12:21:31 +000072#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
Len Brown4f86d3a2007-10-03 18:58:00 -040073
74#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
75
Daniel Lezcano728ce222013-06-12 15:08:51 +020076struct cpuidle_device_kobj;
Daniel Lezcano1a706432013-06-12 15:08:52 +020077struct cpuidle_state_kobj;
78struct cpuidle_driver_kobj;
Daniel Lezcano728ce222013-06-12 15:08:51 +020079
Len Brown4f86d3a2007-10-03 18:58:00 -040080struct 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;
Jacob Panbb8313b2016-11-28 23:03:04 -080083 unsigned int use_deepest_state:1;
Len Brown4f86d3a2007-10-03 18:58:00 -040084 unsigned int cpu;
85
86 int last_residency;
Deepthi Dharwar4202735e2011-10-28 16:20:33 +053087 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
Len Brown4f86d3a2007-10-03 18:58:00 -040088 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +000089 struct cpuidle_driver_kobj *kobj_driver;
Daniel Lezcano728ce222013-06-12 15:08:51 +020090 struct cpuidle_device_kobj *kobj_dev;
Len Brown4f86d3a2007-10-03 18:58:00 -040091 struct list_head device_list;
Colin Cross4126c012012-05-07 17:57:41 -070092
93#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
Colin Cross4126c012012-05-07 17:57:41 -070094 cpumask_t coupled_cpus;
95 struct cpuidle_coupled *coupled;
96#endif
Len Brown4f86d3a2007-10-03 18:58:00 -040097};
98
99DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
Paul Burtonf08dbf82014-01-08 11:23:35 +0000100DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
Len Brown4f86d3a2007-10-03 18:58:00 -0400101
Len Brown4f86d3a2007-10-03 18:58:00 -0400102/****************************
103 * CPUIDLE DRIVER INTERFACE *
104 ****************************/
105
106struct cpuidle_driver {
Daniel Lezcanodb70b042012-03-26 14:51:27 +0200107 const char *name;
Len Brown4f86d3a2007-10-03 18:58:00 -0400108 struct module *owner;
Daniel Lezcano42f67f22012-10-31 16:44:45 +0000109 int refcnt;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530110
Daniel Lezcanoa06df062013-03-27 10:22:10 +0000111 /* used by the cpuidle framework to setup the broadcast timer */
112 unsigned int bctimer:1;
Daniel Lezcano8aef33a2013-01-15 14:18:04 +0100113 /* states array must be ordered in decreasing power consumption */
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530114 struct cpuidle_state states[CPUIDLE_STATE_MAX];
115 int state_count;
116 int safe_state_index;
Daniel Lezcano82467a52013-06-07 21:53:09 +0000117
118 /* the driver handles the cpus in cpumask */
Viresh Kumar6587fca2013-10-03 21:26:40 +0530119 struct cpumask *cpumask;
Len Brown4f86d3a2007-10-03 18:58:00 -0400120};
121
122#ifdef CONFIG_CPU_IDLE
Len Brownd91ee582011-04-01 18:28:35 -0400123extern void disable_cpuidle(void);
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100124extern bool cpuidle_not_available(struct cpuidle_driver *drv,
125 struct cpuidle_device *dev);
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100126
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100127extern int cpuidle_select(struct cpuidle_driver *drv,
Rafael J. Wysocki45f1ff52018-03-22 17:50:49 +0100128 struct cpuidle_device *dev,
129 bool *stop_tick);
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100130extern int cpuidle_enter(struct cpuidle_driver *drv,
131 struct cpuidle_device *dev, int index);
132extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
133
Len Brown4f86d3a2007-10-03 18:58:00 -0400134extern int cpuidle_register_driver(struct cpuidle_driver *drv);
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200135extern struct cpuidle_driver *cpuidle_get_driver(void);
136extern struct cpuidle_driver *cpuidle_driver_ref(void);
137extern void cpuidle_driver_unref(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400138extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
139extern int cpuidle_register_device(struct cpuidle_device *dev);
140extern void cpuidle_unregister_device(struct cpuidle_device *dev);
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000141extern int cpuidle_register(struct cpuidle_driver *drv,
142 const struct cpumask *const coupled_cpus);
143extern void cpuidle_unregister(struct cpuidle_driver *drv);
Len Brown4f86d3a2007-10-03 18:58:00 -0400144extern void cpuidle_pause_and_lock(void);
145extern void cpuidle_resume_and_unlock(void);
Preeti U Murthy8651f972012-07-09 10:12:56 +0200146extern void cpuidle_pause(void);
147extern void cpuidle_resume(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400148extern int cpuidle_enable_device(struct cpuidle_device *dev);
149extern void cpuidle_disable_device(struct cpuidle_device *dev);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100150extern int cpuidle_play_dead(void);
151
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +0000152extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
Catalin Marinas9bd616e2016-06-01 18:52:16 +0100153static inline struct cpuidle_device *cpuidle_get_device(void)
154{return __this_cpu_read(cpuidle_devices); }
Len Brown4f86d3a2007-10-03 18:58:00 -0400155#else
Len Brownd91ee582011-04-01 18:28:35 -0400156static inline void disable_cpuidle(void) { }
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100157static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
158 struct cpuidle_device *dev)
159{return true; }
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100160static inline int cpuidle_select(struct cpuidle_driver *drv,
Rafael J. Wysocki45f1ff52018-03-22 17:50:49 +0100161 struct cpuidle_device *dev, bool *stop_tick)
Daniel Lezcano907e30f2014-03-03 08:48:50 +0100162{return -ENODEV; }
163static inline int cpuidle_enter(struct cpuidle_driver *drv,
164 struct cpuidle_device *dev, int index)
165{return -ENODEV; }
166static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400167static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
Len Brown6b2c6762010-05-11 16:50:52 -0400168{return -ENODEV; }
Len Brown752138d2010-05-22 16:57:26 -0400169static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200170static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
171static inline void cpuidle_driver_unref(void) {}
Len Brown4f86d3a2007-10-03 18:58:00 -0400172static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
173static inline int cpuidle_register_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400174{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400175static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000176static inline int cpuidle_register(struct cpuidle_driver *drv,
177 const struct cpumask *const coupled_cpus)
178{return -ENODEV; }
179static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400180static inline void cpuidle_pause_and_lock(void) { }
181static inline void cpuidle_resume_and_unlock(void) { }
Preeti U Murthy8651f972012-07-09 10:12:56 +0200182static inline void cpuidle_pause(void) { }
183static inline void cpuidle_resume(void) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400184static inline int cpuidle_enable_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400185{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400186static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100187static inline int cpuidle_play_dead(void) {return -ENODEV; }
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200188static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
189 struct cpuidle_device *dev) {return NULL; }
Catalin Marinas9bd616e2016-06-01 18:52:16 +0100190static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; }
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200191#endif
192
Jacob Panbb8313b2016-11-28 23:03:04 -0800193#ifdef CONFIG_CPU_IDLE
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200194extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
195 struct cpuidle_device *dev);
Rafael J. Wysocki28ba0862017-08-10 00:14:45 +0200196extern int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200197 struct cpuidle_device *dev);
Jacob Panbb8313b2016-11-28 23:03:04 -0800198extern void cpuidle_use_deepest_state(bool enable);
Rafael J. Wysocki87e9b9f2015-05-16 01:38:15 +0200199#else
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100200static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
201 struct cpuidle_device *dev)
202{return -ENODEV; }
Rafael J. Wysocki28ba0862017-08-10 00:14:45 +0200203static inline int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
Rafael J. Wysockief2b22a2015-03-02 22:26:55 +0100204 struct cpuidle_device *dev)
205{return -ENODEV; }
Jacob Panbb8313b2016-11-28 23:03:04 -0800206static inline void cpuidle_use_deepest_state(bool enable)
207{
208}
Len Brown4f86d3a2007-10-03 18:58:00 -0400209#endif
210
Rafael J. Wysockifaad3842015-05-10 01:18:03 +0200211/* kernel/sched/idle.c */
212extern void sched_idle_set_state(struct cpuidle_state *idle_state);
Rafael J. Wysocki827a5ae2015-05-10 01:18:46 +0200213extern void default_idle_call(void);
Rafael J. Wysockifaad3842015-05-10 01:18:03 +0200214
Colin Cross20ff51a2012-05-07 17:57:42 -0700215#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
216void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
Arnd Bergmannc7a9b092012-08-15 20:51:54 +0000217#else
218static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
219{
220}
Colin Cross20ff51a2012-05-07 17:57:42 -0700221#endif
222
Rafael J. Wysockid7212cf2018-02-12 11:34:22 +0100223#if defined(CONFIG_CPU_IDLE) && defined(CONFIG_ARCH_HAS_CPU_RELAX)
Rafael J. Wysocki1b39e3f2017-08-29 03:14:37 +0200224void cpuidle_poll_state_init(struct cpuidle_driver *drv);
Rafael J. Wysocki34c2f652017-08-23 23:21:07 +0200225#else
Rafael J. Wysocki1b39e3f2017-08-29 03:14:37 +0200226static inline void cpuidle_poll_state_init(struct cpuidle_driver *drv) {}
Rafael J. Wysocki34c2f652017-08-23 23:21:07 +0200227#endif
228
Len Brown4f86d3a2007-10-03 18:58:00 -0400229/******************************
230 * CPUIDLE GOVERNOR INTERFACE *
231 ******************************/
232
233struct cpuidle_governor {
234 char name[CPUIDLE_NAME_LEN];
235 struct list_head governor_list;
236 unsigned int rating;
237
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530238 int (*enable) (struct cpuidle_driver *drv,
239 struct cpuidle_device *dev);
240 void (*disable) (struct cpuidle_driver *drv,
241 struct cpuidle_device *dev);
Len Brown4f86d3a2007-10-03 18:58:00 -0400242
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530243 int (*select) (struct cpuidle_driver *drv,
Rafael J. Wysocki45f1ff52018-03-22 17:50:49 +0100244 struct cpuidle_device *dev,
245 bool *stop_tick);
Deepthi Dharware978aa72011-10-28 16:20:09 +0530246 void (*reflect) (struct cpuidle_device *dev, int index);
Len Brown4f86d3a2007-10-03 18:58:00 -0400247};
248
249#ifdef CONFIG_CPU_IDLE
Len Brown4f86d3a2007-10-03 18:58:00 -0400250extern int cpuidle_register_governor(struct cpuidle_governor *gov);
Rafael J. Wysocki0fc784f2018-05-30 13:43:01 +0200251extern int cpuidle_governor_latency_req(unsigned int cpu);
Len Brown4f86d3a2007-10-03 18:58:00 -0400252#else
Len Brown4f86d3a2007-10-03 18:58:00 -0400253static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
254{return 0;}
Len Brown4f86d3a2007-10-03 18:58:00 -0400255#endif
256
Prashanth Prakashdb50a742017-11-15 10:11:49 -0700257#define __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, is_retention) \
258({ \
259 int __ret = 0; \
260 \
261 if (!idx) { \
262 cpu_do_idle(); \
263 return idx; \
264 } \
265 \
266 if (!is_retention) \
267 __ret = cpu_pm_enter(); \
268 if (!__ret) { \
269 __ret = low_level_idle_enter(idx); \
270 if (!is_retention) \
271 cpu_pm_exit(); \
272 } \
273 \
274 __ret ? -1 : idx; \
Sudeep Holla220276e2016-07-19 18:52:56 +0100275})
276
Prashanth Prakashdb50a742017-11-15 10:11:49 -0700277#define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \
278 __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 0)
279
280#define CPU_PM_CPU_IDLE_ENTER_RETENTION(low_level_idle_enter, idx) \
281 __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 1)
282
Len Brown4f86d3a2007-10-03 18:58:00 -0400283#endif /* _LINUX_CPUIDLE_H */