Linaro Git Browser
Code Review Sign In
review.linaro.org / kernel / linux-linaro-stable.git / 536657195e2fb24484eac985302dc7a1e0093f5c / . / include / linux / cpuidle.h
blob: 1312cde685047ad1b1eeb470320dd272bf08cc7b [file] [log] [blame]
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]1/*
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>
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]16#include <linux/kobject.h>
17#include <linux/completion.h>
Robert Leee1689792012-03-20 15:22:42 -0500[diff] [blame]18#include <linux/hrtimer.h>
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]19
Len Brown86239ce2013-02-27 13:18:50 -0500[diff] [blame]20#define CPUIDLE_STATE_MAX 10
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]21#define CPUIDLE_NAME_LEN 16
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -0800[diff] [blame]22#define CPUIDLE_DESC_LEN 32
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]23
Paul Gortmakerde477252011-05-26 13:46:22 -0400[diff] [blame]24struct module;
25
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]26struct cpuidle_device;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530[diff] [blame]27struct cpuidle_driver;
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]28
29
30/****************************
31 * CPUIDLE DEVICE INTERFACE *
32 ****************************/
33
Deepthi Dharwar42027352011-10-28 16:20:33 +0530[diff] [blame]34struct cpuidle_state_usage {
ShuoX Liudc7fd272012-07-03 19:05:31 +0200[diff] [blame]35 unsigned long long disable;
Deepthi Dharwar42027352011-10-28 16:20:33 +0530[diff] [blame]36 unsigned long long usage;
37 unsigned long long time; /* in US */
38};
39
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]40struct cpuidle_state {
41 char name[CPUIDLE_NAME_LEN];
Venkatesh Pallipadi4fcb2fc2008-02-11 17:46:31 -0800[diff] [blame]42 char desc[CPUIDLE_DESC_LEN];
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]43
44 unsigned int flags;
45 unsigned int exit_latency; /* in US */
Boris Ostrovsky02401c02012-03-13 19:55:10 +0100[diff] [blame]46 int power_usage; /* in mW */
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]47 unsigned int target_residency; /* in US */
Rafael J. Wysockicbc9ef02012-07-03 19:07:42 +0200[diff] [blame]48 bool disabled; /* disabled on all CPUs */
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]49
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]50 int (*enter) (struct cpuidle_device *dev,
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530[diff] [blame]51 struct cpuidle_driver *drv,
Deepthi Dharware978aa72011-10-28 16:20:09 +0530[diff] [blame]52 int index);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100[diff] [blame]53
54 int (*enter_dead) (struct cpuidle_device *dev, int index);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]55};
56
57/* Idle State Flags */
58#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
Colin Cross4126c012012-05-07 17:57:41 -0700[diff] [blame]59#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
Daniel Lezcanob60e6a02013-03-21 12:21:31 +0000[diff] [blame]60#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]61
62#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
63
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]64struct cpuidle_device {
Venkatesh Pallipadidcb84f32008-05-19 19:09:27 -0400[diff] [blame]65 unsigned int registered:1;
Harvey Harrisonb5556a62008-02-06 22:39:44 +0100[diff] [blame]66 unsigned int enabled:1;
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]67 unsigned int cpu;
68
69 int last_residency;
70 int state_count;
Deepthi Dharwar42027352011-10-28 16:20:33 +0530[diff] [blame]71 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]72 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +0000[diff] [blame]73 struct cpuidle_driver_kobj *kobj_driver;
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]74 struct list_head device_list;
75 struct kobject kobj;
76 struct completion kobj_unregister;
Colin Cross4126c012012-05-07 17:57:41 -0700[diff] [blame]77
78#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
79 int safe_state_index;
80 cpumask_t coupled_cpus;
81 struct cpuidle_coupled *coupled;
82#endif
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]83};
84
85DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
86
87/**
88 * cpuidle_get_last_residency - retrieves the last state's residency time
89 * @dev: the target CPU
90 *
91 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
92 */
93static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
94{
95 return dev->last_residency;
96}
97
98
99/****************************
100 * CPUIDLE DRIVER INTERFACE *
101 ****************************/
102
103struct cpuidle_driver {
Daniel Lezcanodb70b042012-03-26 14:51:27 +0200[diff] [blame]104 const char *name;
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]105 struct module *owner;
Daniel Lezcano42f67f22012-10-31 16:44:45 +0000[diff] [blame]106 int refcnt;
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530[diff] [blame]107
Daniel Lezcanoa06df062013-03-27 10:22:10 +0000[diff] [blame]108 /* used by the cpuidle framework to setup the broadcast timer */
109 unsigned int bctimer:1;
Daniel Lezcano8aef33a2013-01-15 14:18:04 +0100[diff] [blame]110 /* states array must be ordered in decreasing power consumption */
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530[diff] [blame]111 struct cpuidle_state states[CPUIDLE_STATE_MAX];
112 int state_count;
113 int safe_state_index;
Mark Brownce2bf4a2014-05-29 23:05:18 +0100[diff] [blame]114 struct cpumask *cpumask;
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]115};
116
117#ifdef CONFIG_CPU_IDLE
Len Brownd91ee582011-04-01 18:28:35 -0400[diff] [blame]118extern void disable_cpuidle(void);
Len Browna0bfa132011-04-01 19:34:59 -0400[diff] [blame]119extern int cpuidle_idle_call(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]120extern int cpuidle_register_driver(struct cpuidle_driver *drv);
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200[diff] [blame]121extern struct cpuidle_driver *cpuidle_get_driver(void);
122extern struct cpuidle_driver *cpuidle_driver_ref(void);
123extern void cpuidle_driver_unref(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]124extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
125extern int cpuidle_register_device(struct cpuidle_device *dev);
126extern void cpuidle_unregister_device(struct cpuidle_device *dev);
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000[diff] [blame]127extern int cpuidle_register(struct cpuidle_driver *drv,
128 const struct cpumask *const coupled_cpus);
129extern void cpuidle_unregister(struct cpuidle_driver *drv);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]130extern void cpuidle_pause_and_lock(void);
131extern void cpuidle_resume_and_unlock(void);
Preeti U Murthy8651f972012-07-09 10:12:56 +0200[diff] [blame]132extern void cpuidle_pause(void);
133extern void cpuidle_resume(void);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]134extern int cpuidle_enable_device(struct cpuidle_device *dev);
135extern void cpuidle_disable_device(struct cpuidle_device *dev);
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100[diff] [blame]136extern int cpuidle_play_dead(void);
137
Daniel Lezcanobf4d1b52012-10-31 16:44:48 +0000[diff] [blame]138extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
139extern int cpuidle_register_cpu_driver(struct cpuidle_driver *drv, int cpu);
140extern void cpuidle_unregister_cpu_driver(struct cpuidle_driver *drv, int cpu);
141
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]142#else
Len Brownd91ee582011-04-01 18:28:35 -0400[diff] [blame]143static inline void disable_cpuidle(void) { }
Len Browna0bfa132011-04-01 19:34:59 -0400[diff] [blame]144static inline int cpuidle_idle_call(void) { return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]145static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
Len Brown6b2c6762010-05-11 16:50:52 -0400[diff] [blame]146{return -ENODEV; }
Len Brown752138d2010-05-22 16:57:26 -0400[diff] [blame]147static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
Rafael J. Wysocki6e797a02012-06-16 15:20:11 +0200[diff] [blame]148static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
149static inline void cpuidle_driver_unref(void) {}
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]150static 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 -0400[diff] [blame]152{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]153static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
Daniel Lezcano4c637b22013-04-23 08:54:33 +0000[diff] [blame]154static 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 -0400[diff] [blame]158static inline void cpuidle_pause_and_lock(void) { }
159static inline void cpuidle_resume_and_unlock(void) { }
Preeti U Murthy8651f972012-07-09 10:12:56 +0200[diff] [blame]160static inline void cpuidle_pause(void) { }
161static inline void cpuidle_resume(void) { }
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]162static inline int cpuidle_enable_device(struct cpuidle_device *dev)
Len Brown6b2c6762010-05-11 16:50:52 -0400[diff] [blame]163{return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]164static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
Boris Ostrovsky1a022e32012-03-13 19:55:09 +0100[diff] [blame]165static inline int cpuidle_play_dead(void) {return -ENODEV; }
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]166#endif
167
Colin Cross20ff51a2012-05-07 17:57:42 -0700[diff] [blame]168#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 +0000[diff] [blame]170#else
171static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
172{
173}
Colin Cross20ff51a2012-05-07 17:57:42 -0700[diff] [blame]174#endif
175
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]176/******************************
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 +0530[diff] [blame]185 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 -0400[diff] [blame]189
Deepthi Dharwar46bcfad2011-10-28 16:20:42 +0530[diff] [blame]190 int (*select) (struct cpuidle_driver *drv,
191 struct cpuidle_device *dev);
Deepthi Dharware978aa72011-10-28 16:20:09 +0530[diff] [blame]192 void (*reflect) (struct cpuidle_device *dev, int index);
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]193
194 struct module *owner;
195};
196
197#ifdef CONFIG_CPU_IDLE
198
199extern int cpuidle_register_governor(struct cpuidle_governor *gov);
200extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
201
202#else
203
204static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
205{return 0;}
206static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
207
208#endif
209
venkatesh.pallipadi@intel.com9a0b8412008-01-31 17:35:06 -0800[diff] [blame]210#ifdef CONFIG_ARCH_HAS_CPU_RELAX
211#define CPUIDLE_DRIVER_STATE_START 1
212#else
213#define CPUIDLE_DRIVER_STATE_START 0
214#endif
215
Len Brown4f86d3a2007-10-03 18:58:00 -0400[diff] [blame]216#endif /* _LINUX_CPUIDLE_H */