]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/cpuidle.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
rhashtable: Mark internal/private inline functions as such
[mirror_ubuntu-bionic-kernel.git] / include / linux / cpuidle.h
CommitLineData
4f86d3a8
LB		 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>
e1689795 16#include <linux/hrtimer.h>
4f86d3a8 17
86239ceb 18#define CPUIDLE_STATE_MAX 10
4f86d3a8 19#define CPUIDLE_NAME_LEN 16
4fcb2fcd 20#define CPUIDLE_DESC_LEN 32
4f86d3a8 21
de477254
PG		 22struct module;
23
4f86d3a8 24struct cpuidle_device;
46bcfad7 25struct cpuidle_driver;
4f86d3a8
LB		 26
27
28/****************************
29 * CPUIDLE DEVICE INTERFACE *
30 ****************************/
31
4202735e 32struct cpuidle_state_usage {
dc7fd275 33 unsigned long long disable;
4202735e
DD		 34 unsigned long long usage;
35 unsigned long long time; /* in US */
36};
37
4f86d3a8
LB		 38struct cpuidle_state {
39 char name[CPUIDLE_NAME_LEN];
4fcb2fcd 40 char desc[CPUIDLE_DESC_LEN];
4f86d3a8
LB		 41
42 unsigned int flags;
43 unsigned int exit_latency; /* in US */
02401c06 44 int power_usage; /* in mW */
4f86d3a8 45 unsigned int target_residency; /* in US */
cbc9ef02 46 bool disabled; /* disabled on all CPUs */
4f86d3a8 47
4f86d3a8 48 int (*enter) (struct cpuidle_device *dev,
46bcfad7 49 struct cpuidle_driver *drv,
e978aa7d 50 int index);
1a022e3f
BO		 51
52 int (*enter_dead) (struct cpuidle_device *dev, int index);
124cf911
RW		 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);
4f86d3a8
LB		 62};
63
64/* Idle State Flags */
4126c019 65#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 66#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB		 67
68#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
69
728ce22b 70struct cpuidle_device_kobj;
1a706438
DL		 71struct cpuidle_state_kobj;
72struct cpuidle_driver_kobj;
728ce22b 73
4f86d3a8 74struct cpuidle_device {
dcb84f33 75 unsigned int registered:1;
b5556a67 76 unsigned int enabled:1;
4f86d3a8
LB		 77 unsigned int cpu;
78
79 int last_residency;
80 int state_count;
4202735e 81 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 82 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 83 struct cpuidle_driver_kobj *kobj_driver;
728ce22b 84 struct cpuidle_device_kobj *kobj_dev;
4f86d3a8 85 struct list_head device_list;
4126c019
CC		 86
87#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
88 int safe_state_index;
89 cpumask_t coupled_cpus;
90 struct cpuidle_coupled *coupled;
91#endif
4f86d3a8
LB		 92};
93
94DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
f08dbf8a 95DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
4f86d3a8
LB		 96
97/**
98 * cpuidle_get_last_residency - retrieves the last state's residency time
99 * @dev: the target CPU
4f86d3a8
LB		 100 */
101static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
102{
103 return dev->last_residency;
104}
105
106
107/****************************
108 * CPUIDLE DRIVER INTERFACE *
109 ****************************/
110
111struct cpuidle_driver {
db70b044 112 const char *name;
4f86d3a8 113 struct module *owner;
42f67f2a 114 int refcnt;
46bcfad7 115
a06df062
DL		 116 /* used by the cpuidle framework to setup the broadcast timer */
117 unsigned int bctimer:1;
8aef33a7 118 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD		 119 struct cpuidle_state states[CPUIDLE_STATE_MAX];
120 int state_count;
121 int safe_state_index;
82467a5a
DL		 122
123 /* the driver handles the cpus in cpumask */
6587fca2 124 struct cpumask *cpumask;
4f86d3a8
LB		 125};
126
127#ifdef CONFIG_CPU_IDLE
d91ee586 128extern void disable_cpuidle(void);
ef2b22ac
RW		 129extern bool cpuidle_not_available(struct cpuidle_driver *drv,
130 struct cpuidle_device *dev);
907e30f1 131
907e30f1
DL		 132extern int cpuidle_select(struct cpuidle_driver *drv,
133 struct cpuidle_device *dev);
134extern int cpuidle_enter(struct cpuidle_driver *drv,
135 struct cpuidle_device *dev, int index);
136extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
137
4f86d3a8 138extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 139extern struct cpuidle_driver *cpuidle_get_driver(void);
140extern struct cpuidle_driver *cpuidle_driver_ref(void);
141extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 142extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
143extern int cpuidle_register_device(struct cpuidle_device *dev);
144extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21
DL		 145extern int cpuidle_register(struct cpuidle_driver *drv,
146 const struct cpumask *const coupled_cpus);
147extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8
LB		 148extern void cpuidle_pause_and_lock(void);
149extern void cpuidle_resume_and_unlock(void);
8651f97b
PM		 150extern void cpuidle_pause(void);
151extern void cpuidle_resume(void);
4f86d3a8
LB		 152extern int cpuidle_enable_device(struct cpuidle_device *dev);
153extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f 154extern int cpuidle_play_dead(void);
ef2b22ac
RW		 155extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
156 struct cpuidle_device *dev);
157extern int cpuidle_enter_freeze(struct cpuidle_driver *drv,
158 struct cpuidle_device *dev);
1a022e3f 159
bf4d1b5d 160extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
4f86d3a8 161#else
d91ee586 162static inline void disable_cpuidle(void) { }
ef2b22ac
RW		 163static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
164 struct cpuidle_device *dev)
165{return true; }
907e30f1
DL		 166static inline int cpuidle_select(struct cpuidle_driver *drv,
167 struct cpuidle_device *dev)
168{return -ENODEV; }
169static inline int cpuidle_enter(struct cpuidle_driver *drv,
170 struct cpuidle_device *dev, int index)
171{return -ENODEV; }
172static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8 173static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 174{return -ENODEV; }
752138df 175static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 176static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
177static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 178static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
179static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 180{return -ENODEV; }
4f86d3a8 181static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21
DL		 182static inline int cpuidle_register(struct cpuidle_driver *drv,
183 const struct cpumask *const coupled_cpus)
184{return -ENODEV; }
185static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8
LB		 186static inline void cpuidle_pause_and_lock(void) { }
187static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM		 188static inline void cpuidle_pause(void) { }
189static inline void cpuidle_resume(void) { }
4f86d3a8 190static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 191{return -ENODEV; }
4f86d3a8 192static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 193static inline int cpuidle_play_dead(void) {return -ENODEV; }
ef2b22ac
RW		 194static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
195 struct cpuidle_device *dev)
196{return -ENODEV; }
197static inline int cpuidle_enter_freeze(struct cpuidle_driver *drv,
198 struct cpuidle_device *dev)
199{return -ENODEV; }
c8cc7d4d
DL		 200static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
201 struct cpuidle_device *dev) {return NULL; }
4f86d3a8
LB		 202#endif
203
20ff51a3
CC		 204#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
205void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB		 206#else
207static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
208{
209}
20ff51a3
CC		 210#endif
211
4f86d3a8
LB		 212/******************************
213 * CPUIDLE GOVERNOR INTERFACE *
214 ******************************/
215
216struct cpuidle_governor {
217 char name[CPUIDLE_NAME_LEN];
218 struct list_head governor_list;
219 unsigned int rating;
220
46bcfad7
DD		 221 int (*enable) (struct cpuidle_driver *drv,
222 struct cpuidle_device *dev);
223 void (*disable) (struct cpuidle_driver *drv,
224 struct cpuidle_device *dev);
4f86d3a8 225
46bcfad7
DD		 226 int (*select) (struct cpuidle_driver *drv,
227 struct cpuidle_device *dev);
e978aa7d 228 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 229
230 struct module *owner;
231};
232
233#ifdef CONFIG_CPU_IDLE
4f86d3a8 234extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8 235#else
4f86d3a8
LB		 236static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
237{return 0;}
4f86d3a8
LB		 238#endif
239
9a0b8415 240#ifdef CONFIG_ARCH_HAS_CPU_RELAX
241#define CPUIDLE_DRIVER_STATE_START 1
242#else
243#define CPUIDLE_DRIVER_STATE_START 0
244#endif
245
4f86d3a8 246#endif /* _LINUX_CPUIDLE_H */
ubuntu-bionic-kernel mirror