blob: 50fcbb0ac4e7033922508aa1fc805936087cd5f2 [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);
Len Brown4f86d3a2007-10-03 18:58:00 -040053};
54
55/* Idle State Flags */
56#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
Colin Cross4126c012012-05-07 17:57:41 -070057#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
Daniel Lezcanob60e6a02013-03-21 12:21:31 +000058#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
Len Brown4f86d3a2007-10-03 18:58:00 -040059
60#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
61
Daniel Lezcano728ce222013-06-12 15:08:51 +020062struct cpuidle_device_kobj;
Daniel Lezcano1a706432013-06-12 15:08:52 +020063struct cpuidle_state_kobj;
64struct cpuidle_driver_kobj;
Daniel Lezcano728ce222013-06-12 15:08:51 +020065
Len Brown4f86d3a2007-10-03 18:58:00 -040066struct cpuidle_device {
Venkatesh Pallipadidcb84f32008-05-19 19:09:27 -040067 unsigned int registered:1;
Harvey Harrisonb5556a62008-02-06 22:39:44 +010068 unsigned int enabled:1;
Len Brown4f86d3a2007-10-03 18:58:00 -040069 unsigned int cpu;
70
71 int last_residency;
72 int state_count;
Deepthi Dharwar42027352011-10-28 16:20:33 +053073 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
Len Brown4f86d3a2007-10-03 18:58:00 -040074 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +000075 struct cpuidle_driver_kobj *kobj_driver;
Daniel Lezcano728ce222013-06-12 15:08:51 +020076 struct cpuidle_device_kobj *kobj_dev;
Len Brown4f86d3a2007-10-03 18:58:00 -040077 struct list_head device_list;
Colin Cross4126c012012-05-07 17:57:41 -070078
79#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
80 int safe_state_index;
81 cpumask_t coupled_cpus;
82 struct cpuidle_coupled *coupled;
83#endif
Len Brown4f86d3a2007-10-03 18:58:00 -040084};
85
86DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
87
88/**
89 * cpuidle_get_last_residency - retrieves the last state's residency time
90 * @dev: the target CPU
91 *
92 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
93 */
94static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
95{
96 return dev->last_residency;
97}
98
99
100/****************************
101 * CPUIDLE DRIVER INTERFACE *
102 ****************************/
103
104struct cpuidle_driver {
Daniel Lezcanodb70b042012-03-26 14:51:27 +0200105 const char *name;
Len Brown4f86d3a2007-10-03 18:58:00 -0400106 struct module *owner;
Daniel Lezcano42f67f22012-10-31 16:44:45 +0000107 int refcnt;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530108
Daniel Lezcanoa06df062013-03-27 10:22:10 +0000109 /* used by the cpuidle framework to setup the broadcast timer */
110 unsigned int bctimer:1;
Daniel Lezcano8aef33a2013-01-15 14:18:04 +0100111 /* states array must be ordered in decreasing power consumption */
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530112 struct cpuidle_state states[CPUIDLE_STATE_MAX];
113 int state_count;
114 int safe_state_index;
Daniel Lezcano82467a52013-06-07 21:53:09 +0000115
116 /* the driver handles the cpus in cpumask */
Viresh Kumar6587fca2013-10-03 21:26:40 +0530117 struct cpumask *cpumask;
Len Brown4f86d3a2007-10-03 18:58:00 -0400118};
119
120#ifdef CONFIG_CPU_IDLE
Len Brownd91ee582011-04-01 18:28:35 -0400121extern void disable_cpuidle(void);
Len Browna0bfa132011-04-01 19:34:59 -0400122extern int cpuidle_idle_call(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400123extern int cpuidle_register_driver(struct cpuidle_driver *drv);
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200124extern struct cpuidle_driver *cpuidle_get_driver(void);
125extern struct cpuidle_driver *cpuidle_driver_ref(void);
126extern void cpuidle_driver_unref(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400127extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
128extern int cpuidle_register_device(struct cpuidle_device *dev);
129extern void cpuidle_unregister_device(struct cpuidle_device *dev);
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000130extern int cpuidle_register(struct cpuidle_driver *drv,
131 const struct cpumask *const coupled_cpus);
132extern void cpuidle_unregister(struct cpuidle_driver *drv);
Len Brown4f86d3a2007-10-03 18:58:00 -0400133extern void cpuidle_pause_and_lock(void);
134extern void cpuidle_resume_and_unlock(void);
Preeti U Murthy8651f972012-07-09 10:12:56 +0200135extern void cpuidle_pause(void);
136extern void cpuidle_resume(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400137extern int cpuidle_enable_device(struct cpuidle_device *dev);
138extern void cpuidle_disable_device(struct cpuidle_device *dev);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100139extern int cpuidle_play_dead(void);
140
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +0000141extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
Len Brown4f86d3a2007-10-03 18:58:00 -0400142#else
Len Brownd91ee582011-04-01 18:28:35 -0400143static inline void disable_cpuidle(void) { }
Len Browna0bfa132011-04-01 19:34:59 -0400144static inline int cpuidle_idle_call(void) { return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400145static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
Len Brown6b2c6762010-05-11 16:50:52 -0400146{return -ENODEV; }
Len Brown752138d2010-05-22 16:57:26 -0400147static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200148static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
149static inline void cpuidle_driver_unref(void) {}
Len Brown4f86d3a2007-10-03 18:58:00 -0400150static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
151static inline int cpuidle_register_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_unregister_device(struct cpuidle_device *dev) { }
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000154static inline int cpuidle_register(struct cpuidle_driver *drv,
155 const struct cpumask *const coupled_cpus)
156{return -ENODEV; }
157static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400158static inline void cpuidle_pause_and_lock(void) { }
159static inline void cpuidle_resume_and_unlock(void) { }
Preeti U Murthy8651f972012-07-09 10:12:56 +0200160static inline void cpuidle_pause(void) { }
161static inline void cpuidle_resume(void) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400162static inline int cpuidle_enable_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400163{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400164static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100165static inline int cpuidle_play_dead(void) {return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400166#endif
167
Colin Cross20ff51a2012-05-07 17:57:42 -0700168#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
169void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
Arnd Bergmannc7a9b092012-08-15 20:51:54 +0000170#else
171static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
172{
173}
Colin Cross20ff51a2012-05-07 17:57:42 -0700174#endif
175
Len Brown4f86d3a2007-10-03 18:58:00 -0400176/******************************
177 * CPUIDLE GOVERNOR INTERFACE *
178 ******************************/
179
180struct cpuidle_governor {
181 char name[CPUIDLE_NAME_LEN];
182 struct list_head governor_list;
183 unsigned int rating;
184
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530185 int (*enable) (struct cpuidle_driver *drv,
186 struct cpuidle_device *dev);
187 void (*disable) (struct cpuidle_driver *drv,
188 struct cpuidle_device *dev);
Len Brown4f86d3a2007-10-03 18:58:00 -0400189
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530190 int (*select) (struct cpuidle_driver *drv,
191 struct cpuidle_device *dev);
Deepthi Dharware978aa72011-10-28 16:20:09 +0530192 void (*reflect) (struct cpuidle_device *dev, int index);
Len Brown4f86d3a2007-10-03 18:58:00 -0400193
194 struct module *owner;
195};
196
197#ifdef CONFIG_CPU_IDLE
Len Brown4f86d3a2007-10-03 18:58:00 -0400198extern int cpuidle_register_governor(struct cpuidle_governor *gov);
Len Brown4f86d3a2007-10-03 18:58:00 -0400199#else
Len Brown4f86d3a2007-10-03 18:58:00 -0400200static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
201{return 0;}
Len Brown4f86d3a2007-10-03 18:58:00 -0400202#endif
203
venkatesh.pallipadi@intel.com9a0b8412008-01-31 17:35:06 -0800204#ifdef CONFIG_ARCH_HAS_CPU_RELAX
205#define CPUIDLE_DRIVER_STATE_START 1
206#else
207#define CPUIDLE_DRIVER_STATE_START 0
208#endif
209
Len Brown4f86d3a2007-10-03 18:58:00 -0400210#endif /* _LINUX_CPUIDLE_H */