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