projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ARM: ux500: cpuidle: replace for_each_online_cpu by for_each_possible_cpu
[deliverable/linux.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>
4f86d3a8
LB		 16#include <linux/kobject.h>
17#include <linux/completion.h>
e1689795 18#include <linux/hrtimer.h>
4f86d3a8
LB		 19
20#define CPUIDLE_STATE_MAX 8
21#define CPUIDLE_NAME_LEN 16
4fcb2fcd 22#define CPUIDLE_DESC_LEN 32
4f86d3a8 23
de477254
PG		 24struct module;
25
4f86d3a8 26struct cpuidle_device;
46bcfad7 27struct cpuidle_driver;
4f86d3a8
LB		 28
29
30/****************************
31 * CPUIDLE DEVICE INTERFACE *
32 ****************************/
33
4202735e 34struct cpuidle_state_usage {
dc7fd275 35 unsigned long long disable;
4202735e
DD		 36 unsigned long long usage;
37 unsigned long long time; /* in US */
38};
39
4f86d3a8
LB		 40struct cpuidle_state {
41 char name[CPUIDLE_NAME_LEN];
4fcb2fcd 42 char desc[CPUIDLE_DESC_LEN];
4f86d3a8
LB		 43
44 unsigned int flags;
45 unsigned int exit_latency; /* in US */
02401c06 46 int power_usage; /* in mW */
4f86d3a8 47 unsigned int target_residency; /* in US */
cbc9ef02 48 bool disabled; /* disabled on all CPUs */
4f86d3a8 49
4f86d3a8 50 int (*enter) (struct cpuidle_device *dev,
46bcfad7 51 struct cpuidle_driver *drv,
e978aa7d 52 int index);
1a022e3f
BO		 53
54 int (*enter_dead) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 55};
56
57/* Idle State Flags */
58#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4126c019 59#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e 60#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8
LB		 61
62#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
63
4f86d3a8 64struct cpuidle_device {
dcb84f33 65 unsigned int registered:1;
b5556a67 66 unsigned int enabled:1;
4f86d3a8
LB		 67 unsigned int cpu;
68
69 int last_residency;
70 int state_count;
4202735e 71 struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8 72 struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d 73 struct cpuidle_driver_kobj *kobj_driver;
4f86d3a8
LB		 74 struct list_head device_list;
75 struct kobject kobj;
76 struct completion kobj_unregister;
4126c019
CC		 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
4f86d3a8
LB		 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 {
db70b044 104 const char *name;
4f86d3a8 105 struct module *owner;
42f67f2a 106 int refcnt;
46bcfad7 107
a06df062
DL		 108 /* used by the cpuidle framework to setup the broadcast timer */
109 unsigned int bctimer:1;
8aef33a7 110 /* states array must be ordered in decreasing power consumption */
46bcfad7
DD		 111 struct cpuidle_state states[CPUIDLE_STATE_MAX];
112 int state_count;
113 int safe_state_index;
4f86d3a8
LB		 114};
115
116#ifdef CONFIG_CPU_IDLE
d91ee586 117extern void disable_cpuidle(void);
a0bfa137 118extern int cpuidle_idle_call(void);
4f86d3a8 119extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07
RW		 120extern struct cpuidle_driver *cpuidle_get_driver(void);
121extern struct cpuidle_driver *cpuidle_driver_ref(void);
122extern void cpuidle_driver_unref(void);
4f86d3a8
LB		 123extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
124extern int cpuidle_register_device(struct cpuidle_device *dev);
125extern void cpuidle_unregister_device(struct cpuidle_device *dev);
126
127extern void cpuidle_pause_and_lock(void);
128extern void cpuidle_resume_and_unlock(void);
8651f97b
PM		 129extern void cpuidle_pause(void);
130extern void cpuidle_resume(void);
4f86d3a8
LB		 131extern int cpuidle_enable_device(struct cpuidle_device *dev);
132extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f
BO		 133extern int cpuidle_play_dead(void);
134
bf4d1b5d
DL		 135extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
136extern int cpuidle_register_cpu_driver(struct cpuidle_driver *drv, int cpu);
137extern void cpuidle_unregister_cpu_driver(struct cpuidle_driver *drv, int cpu);
138
4f86d3a8 139#else
d91ee586 140static inline void disable_cpuidle(void) { }
a0bfa137 141static inline int cpuidle_idle_call(void) { return -ENODEV; }
4f86d3a8 142static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b 143{return -ENODEV; }
752138df 144static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07
RW		 145static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
146static inline void cpuidle_driver_unref(void) {}
4f86d3a8
LB		 147static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
148static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b 149{return -ENODEV; }
4f86d3a8
LB		 150static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
151
152static inline void cpuidle_pause_and_lock(void) { }
153static inline void cpuidle_resume_and_unlock(void) { }
8651f97b
PM		 154static inline void cpuidle_pause(void) { }
155static inline void cpuidle_resume(void) { }
4f86d3a8 156static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b 157{return -ENODEV; }
4f86d3a8 158static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f 159static inline int cpuidle_play_dead(void) {return -ENODEV; }
4f86d3a8
LB		 160#endif
161
20ff51a3
CC		 162#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
163void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
c7a9b09b
AB		 164#else
165static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
166{
167}
20ff51a3
CC		 168#endif
169
4f86d3a8
LB		 170/******************************
171 * CPUIDLE GOVERNOR INTERFACE *
172 ******************************/
173
174struct cpuidle_governor {
175 char name[CPUIDLE_NAME_LEN];
176 struct list_head governor_list;
177 unsigned int rating;
178
46bcfad7
DD		 179 int (*enable) (struct cpuidle_driver *drv,
180 struct cpuidle_device *dev);
181 void (*disable) (struct cpuidle_driver *drv,
182 struct cpuidle_device *dev);
4f86d3a8 183
46bcfad7
DD		 184 int (*select) (struct cpuidle_driver *drv,
185 struct cpuidle_device *dev);
e978aa7d 186 void (*reflect) (struct cpuidle_device *dev, int index);
4f86d3a8
LB		 187
188 struct module *owner;
189};
190
191#ifdef CONFIG_CPU_IDLE
192
193extern int cpuidle_register_governor(struct cpuidle_governor *gov);
194extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
195
196#else
197
198static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
199{return 0;}
200static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
201
202#endif
203
9a0b8415 204#ifdef CONFIG_ARCH_HAS_CPU_RELAX
205#define CPUIDLE_DRIVER_STATE_START 1
206#else
207#define CPUIDLE_DRIVER_STATE_START 0
208#endif
209
4f86d3a8 210#endif /* _LINUX_CPUIDLE_H */
Linux kernel - Deliverables
This page took 0.821204 seconds and 5 git commands to generate.