2 * driver.c - driver support
4 * (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
8 * This code is licenced under the GPL.
11 #include <linux/mutex.h>
12 #include <linux/module.h>
13 #include <linux/cpuidle.h>
14 #include <linux/cpumask.h>
15 #include <linux/clockchips.h>
19 DEFINE_SPINLOCK(cpuidle_driver_lock
);
21 #ifdef CONFIG_CPU_IDLE_MULTIPLE_DRIVERS
23 static DEFINE_PER_CPU(struct cpuidle_driver
*, cpuidle_drivers
);
26 * __cpuidle_get_cpu_driver - return the cpuidle driver tied to a CPU.
27 * @cpu: the CPU handled by the driver
29 * Returns a pointer to struct cpuidle_driver or NULL if no driver has been
30 * registered for @cpu.
32 static struct cpuidle_driver
*__cpuidle_get_cpu_driver(int cpu
)
34 return per_cpu(cpuidle_drivers
, cpu
);
38 * __cpuidle_unset_driver - unset per CPU driver variables.
39 * @drv: a valid pointer to a struct cpuidle_driver
41 * For each CPU in the driver's CPU mask, unset the registered driver per CPU
42 * variable. If @drv is different from the registered driver, the corresponding
43 * variable is not cleared.
45 static inline void __cpuidle_unset_driver(struct cpuidle_driver
*drv
)
49 for_each_cpu(cpu
, drv
->cpumask
) {
51 if (drv
!= __cpuidle_get_cpu_driver(cpu
))
54 per_cpu(cpuidle_drivers
, cpu
) = NULL
;
59 * __cpuidle_set_driver - set per CPU driver variables for the given driver.
60 * @drv: a valid pointer to a struct cpuidle_driver
62 * For each CPU in the driver's cpumask, unset the registered driver per CPU
65 * Returns 0 on success, -EBUSY if the CPUs have driver(s) already.
67 static inline int __cpuidle_set_driver(struct cpuidle_driver
*drv
)
71 for_each_cpu(cpu
, drv
->cpumask
) {
73 if (__cpuidle_get_cpu_driver(cpu
)) {
74 __cpuidle_unset_driver(drv
);
78 per_cpu(cpuidle_drivers
, cpu
) = drv
;
86 static struct cpuidle_driver
*cpuidle_curr_driver
;
89 * __cpuidle_get_cpu_driver - return the global cpuidle driver pointer.
90 * @cpu: ignored without the multiple driver support
92 * Return a pointer to a struct cpuidle_driver object or NULL if no driver was
93 * previously registered.
95 static inline struct cpuidle_driver
*__cpuidle_get_cpu_driver(int cpu
)
97 return cpuidle_curr_driver
;
101 * __cpuidle_set_driver - assign the global cpuidle driver variable.
102 * @drv: pointer to a struct cpuidle_driver object
104 * Returns 0 on success, -EBUSY if the driver is already registered.
106 static inline int __cpuidle_set_driver(struct cpuidle_driver
*drv
)
108 if (cpuidle_curr_driver
)
111 cpuidle_curr_driver
= drv
;
117 * __cpuidle_unset_driver - unset the global cpuidle driver variable.
118 * @drv: a pointer to a struct cpuidle_driver
120 * Reset the global cpuidle variable to NULL. If @drv does not match the
121 * registered driver, do nothing.
123 static inline void __cpuidle_unset_driver(struct cpuidle_driver
*drv
)
125 if (drv
== cpuidle_curr_driver
)
126 cpuidle_curr_driver
= NULL
;
132 * cpuidle_setup_broadcast_timer - enable/disable the broadcast timer
133 * @arg: a void pointer used to match the SMP cross call API
135 * @arg is used as a value of type 'long' with one of the two values:
136 * - CLOCK_EVT_NOTIFY_BROADCAST_ON
137 * - CLOCK_EVT_NOTIFY_BROADCAST_OFF
139 * Set the broadcast timer notification for the current CPU. This function
140 * is executed per CPU by an SMP cross call. It not supposed to be called
143 static void cpuidle_setup_broadcast_timer(void *arg
)
145 int cpu
= smp_processor_id();
146 clockevents_notify((long)(arg
), &cpu
);
150 * __cpuidle_driver_init - initialize the driver's internal data
151 * @drv: a valid pointer to a struct cpuidle_driver
153 static void __cpuidle_driver_init(struct cpuidle_driver
*drv
)
160 * Use all possible CPUs as the default, because if the kernel boots
161 * with some CPUs offline and then we online one of them, the CPU
162 * notifier has to know which driver to assign.
165 drv
->cpumask
= (struct cpumask
*)cpu_possible_mask
;
168 * Look for the timer stop flag in the different states, so that we know
169 * if the broadcast timer has to be set up. The loop is in the reverse
170 * order, because usually one of the deeper states have this flag set.
172 for (i
= drv
->state_count
- 1; i
>= 0 ; i
--) {
173 if (drv
->states
[i
].flags
& CPUIDLE_FLAG_TIMER_STOP
) {
181 * __cpuidle_register_driver: register the driver
182 * @drv: a valid pointer to a struct cpuidle_driver
184 * Do some sanity checks, initialize the driver, assign the driver to the
185 * global cpuidle driver variable(s) and set up the broadcast timer if the
186 * cpuidle driver has some states that shut down the local timer.
188 * Returns 0 on success, a negative error code otherwise:
189 * * -EINVAL if the driver pointer is NULL or no idle states are available
190 * * -ENODEV if the cpuidle framework is disabled
191 * * -EBUSY if the driver is already assigned to the global variable(s)
193 static int __cpuidle_register_driver(struct cpuidle_driver
*drv
)
197 if (!drv
|| !drv
->state_count
)
200 if (cpuidle_disabled())
203 __cpuidle_driver_init(drv
);
205 ret
= __cpuidle_set_driver(drv
);
210 on_each_cpu_mask(drv
->cpumask
, cpuidle_setup_broadcast_timer
,
211 (void *)CLOCK_EVT_NOTIFY_BROADCAST_ON
, 1);
217 * __cpuidle_unregister_driver - unregister the driver
218 * @drv: a valid pointer to a struct cpuidle_driver
220 * Check if the driver is no longer in use, reset the global cpuidle driver
221 * variable(s) and disable the timer broadcast notification mechanism if it was
225 static void __cpuidle_unregister_driver(struct cpuidle_driver
*drv
)
227 if (WARN_ON(drv
->refcnt
> 0))
232 on_each_cpu_mask(drv
->cpumask
, cpuidle_setup_broadcast_timer
,
233 (void *)CLOCK_EVT_NOTIFY_BROADCAST_OFF
, 1);
236 __cpuidle_unset_driver(drv
);
240 * cpuidle_register_driver - registers a driver
241 * @drv: a pointer to a valid struct cpuidle_driver
243 * Register the driver under a lock to prevent concurrent attempts to
244 * [un]register the driver from occuring at the same time.
246 * Returns 0 on success, a negative error code (returned by
247 * __cpuidle_register_driver()) otherwise.
249 int cpuidle_register_driver(struct cpuidle_driver
*drv
)
253 spin_lock(&cpuidle_driver_lock
);
254 ret
= __cpuidle_register_driver(drv
);
255 spin_unlock(&cpuidle_driver_lock
);
259 EXPORT_SYMBOL_GPL(cpuidle_register_driver
);
262 * cpuidle_unregister_driver - unregisters a driver
263 * @drv: a pointer to a valid struct cpuidle_driver
265 * Unregisters the cpuidle driver under a lock to prevent concurrent attempts
266 * to [un]register the driver from occuring at the same time. @drv has to
267 * match the currently registered driver.
269 void cpuidle_unregister_driver(struct cpuidle_driver
*drv
)
271 spin_lock(&cpuidle_driver_lock
);
272 __cpuidle_unregister_driver(drv
);
273 spin_unlock(&cpuidle_driver_lock
);
275 EXPORT_SYMBOL_GPL(cpuidle_unregister_driver
);
278 * cpuidle_get_driver - return the driver tied to the current CPU.
280 * Returns a struct cpuidle_driver pointer, or NULL if no driver is registered.
282 struct cpuidle_driver
*cpuidle_get_driver(void)
284 struct cpuidle_driver
*drv
;
288 drv
= __cpuidle_get_cpu_driver(cpu
);
293 EXPORT_SYMBOL_GPL(cpuidle_get_driver
);
296 * cpuidle_get_cpu_driver - return the driver registered for a CPU.
297 * @dev: a valid pointer to a struct cpuidle_device
299 * Returns a struct cpuidle_driver pointer, or NULL if no driver is registered
300 * for the CPU associated with @dev.
302 struct cpuidle_driver
*cpuidle_get_cpu_driver(struct cpuidle_device
*dev
)
307 return __cpuidle_get_cpu_driver(dev
->cpu
);
309 EXPORT_SYMBOL_GPL(cpuidle_get_cpu_driver
);
312 * cpuidle_driver_ref - get a reference to the driver.
314 * Increment the reference counter of the cpuidle driver associated with
317 * Returns a pointer to the driver, or NULL if the current CPU has no driver.
319 struct cpuidle_driver
*cpuidle_driver_ref(void)
321 struct cpuidle_driver
*drv
;
323 spin_lock(&cpuidle_driver_lock
);
325 drv
= cpuidle_get_driver();
329 spin_unlock(&cpuidle_driver_lock
);
334 * cpuidle_driver_unref - puts down the refcount for the driver
336 * Decrement the reference counter of the cpuidle driver associated with
339 void cpuidle_driver_unref(void)
341 struct cpuidle_driver
*drv
;
343 spin_lock(&cpuidle_driver_lock
);
345 drv
= cpuidle_get_driver();
346 if (drv
&& !WARN_ON(drv
->refcnt
<= 0))
349 spin_unlock(&cpuidle_driver_lock
);