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