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