drivers/cpuidle/driver.c

   1 /*
   2  * driver.c - driver support
   3  *
   4  * (C) 2006-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 #include <linux/mutex.h>
  12 #include <linux/module.h>
  13 #include <linux/sched.h>
  14 #include <linux/cpuidle.h>
  15 #include <linux/cpumask.h>
  16 #include <linux/clockchips.h>
  17
  18 #include "cpuidle.h"
  19
  20 DEFINE_SPINLOCK(cpuidle_driver_lock);
  21
  22 #ifdef CONFIG_CPU_IDLE_MULTIPLE_DRIVERS
  23
  24 static DEFINE_PER_CPU(struct cpuidle_driver *, cpuidle_drivers);
  25
  26 /**
  27  * __cpuidle_get_cpu_driver - return the cpuidle driver tied to a CPU.
  28  * @cpu: the CPU handled by the driver
  29  *
  30  * Returns a pointer to struct cpuidle_driver or NULL if no driver has been
  31  * registered for @cpu.
  32  */
  33 static struct cpuidle_driver *__cpuidle_get_cpu_driver(int cpu)
  34 {
  35         return per_cpu(cpuidle_drivers, cpu);
  36 }
  37
  38 /**
  39  * __cpuidle_unset_driver - unset per CPU driver variables.
  40  * @drv: a valid pointer to a struct cpuidle_driver
  41  *
  42  * For each CPU in the driver's CPU mask, unset the registered driver per CPU
  43  * variable. If @drv is different from the registered driver, the corresponding
  44  * variable is not cleared.
  45  */
  46 static inline void __cpuidle_unset_driver(struct cpuidle_driver *drv)
  47 {
  48         int cpu;
  49
  50         for_each_cpu(cpu, drv->cpumask) {
  51
  52                 if (drv != __cpuidle_get_cpu_driver(cpu))
  53                         continue;
  54
  55                 per_cpu(cpuidle_drivers, cpu) = NULL;
  56         }
  57 }
  58
  59 /**
  60  * __cpuidle_set_driver - set per CPU driver variables for the given driver.
  61  * @drv: a valid pointer to a struct cpuidle_driver
  62  *
  63  * Returns 0 on success, -EBUSY if any CPU in the cpumask have a driver
  64  * different from drv already.
  65  */
  66 static inline int __cpuidle_set_driver(struct cpuidle_driver *drv)
  67 {
  68         int cpu;
  69
  70         for_each_cpu(cpu, drv->cpumask) {
  71                 struct cpuidle_driver *old_drv;
  72
  73                 old_drv = __cpuidle_get_cpu_driver(cpu);
  74                 if (old_drv && old_drv != drv)
  75                         return -EBUSY;
  76         }
  77
  78         for_each_cpu(cpu, drv->cpumask)
  79                 per_cpu(cpuidle_drivers, cpu) = drv;
  80
  81         return 0;
  82 }
  83
  84 #else
  85
  86 static struct cpuidle_driver *cpuidle_curr_driver;
  87
  88 /**
  89  * __cpuidle_get_cpu_driver - return the global cpuidle driver pointer.
  90  * @cpu: ignored without the multiple driver support
  91  *
  92  * Return a pointer to a struct cpuidle_driver object or NULL if no driver was
  93  * previously registered.
  94  */
  95 static inline struct cpuidle_driver *__cpuidle_get_cpu_driver(int cpu)
  96 {
  97         return cpuidle_curr_driver;
  98 }
  99
 100 /**
 101  * __cpuidle_set_driver - assign the global cpuidle driver variable.
 102  * @drv: pointer to a struct cpuidle_driver object
 103  *
 104  * Returns 0 on success, -EBUSY if the driver is already registered.
 105  */
 106 static inline int __cpuidle_set_driver(struct cpuidle_driver *drv)
 107 {
 108         if (cpuidle_curr_driver)
 109                 return -EBUSY;
 110
 111         cpuidle_curr_driver = drv;
 112
 113         return 0;
 114 }
 115
 116 /**
 117  * __cpuidle_unset_driver - unset the global cpuidle driver variable.
 118  * @drv: a pointer to a struct cpuidle_driver
 119  *
 120  * Reset the global cpuidle variable to NULL.  If @drv does not match the
 121  * registered driver, do nothing.
 122  */
 123 static inline void __cpuidle_unset_driver(struct cpuidle_driver *drv)
 124 {
 125         if (drv == cpuidle_curr_driver)
 126                 cpuidle_curr_driver = NULL;
 127 }
 128
 129 #endif
 130
 131 /**
 132  * cpuidle_setup_broadcast_timer - enable/disable the broadcast timer
 133  * @arg: a void pointer used to match the SMP cross call API
 134  *
 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
 138  *
 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
 141  * directly.
 142  */
 143 static void cpuidle_setup_broadcast_timer(void *arg)
 144 {
 145         int cpu = smp_processor_id();
 146         clockevents_notify((long)(arg), &cpu);
 147 }
 148
 149 /**
 150  * __cpuidle_driver_init - initialize the driver's internal data
 151  * @drv: a valid pointer to a struct cpuidle_driver
 152  */
 153 static void __cpuidle_driver_init(struct cpuidle_driver *drv)
 154 {
 155         int i;
 156
 157         drv->refcnt = 0;
 158
 159         /*
 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.
 163          */
 164         if (!drv->cpumask)
 165                 drv->cpumask = (struct cpumask *)cpu_possible_mask;
 166
 167         /*
 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.
 171          */
 172         for (i = drv->state_count - 1; i >= 0 ; i--) {
 173                 if (drv->states[i].flags & CPUIDLE_FLAG_TIMER_STOP) {
 174                         drv->bctimer = 1;
 175                         break;
 176                 }
 177         }
 178 }
 179
 180 #ifdef CONFIG_ARCH_HAS_CPU_RELAX
 181 static int poll_idle(struct cpuidle_device *dev,
 182                 struct cpuidle_driver *drv, int index)
 183 {
 184         ktime_t t1, t2;
 185         s64 diff;
 186
 187         t1 = ktime_get();
 188         local_irq_enable();
 189         if (!current_set_polling_and_test()) {
 190                 while (!need_resched())
 191                         cpu_relax();
 192         }
 193         current_clr_polling();
 194
 195         t2 = ktime_get();
 196         diff = ktime_to_us(ktime_sub(t2, t1));
 197         if (diff > INT_MAX)
 198                 diff = INT_MAX;
 199
 200         dev->last_residency = (int) diff;
 201
 202         return index;
 203 }
 204
 205 static void poll_idle_init(struct cpuidle_driver *drv)
 206 {
 207         struct cpuidle_state *state = &drv->states[0];
 208
 209         snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
 210         snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
 211         state->exit_latency = 0;
 212         state->target_residency = 0;
 213         state->power_usage = -1;
 214         state->flags = CPUIDLE_FLAG_TIME_VALID;
 215         state->enter = poll_idle;
 216         state->disabled = false;
 217 }
 218 #else
 219 static void poll_idle_init(struct cpuidle_driver *drv) {}
 220 #endif /* !CONFIG_ARCH_HAS_CPU_RELAX */
 221
 222 /**
 223  * __cpuidle_register_driver: register the driver
 224  * @drv: a valid pointer to a struct cpuidle_driver
 225  *
 226  * Do some sanity checks, initialize the driver, assign the driver to the
 227  * global cpuidle driver variable(s) and set up the broadcast timer if the
 228  * cpuidle driver has some states that shut down the local timer.
 229  *
 230  * Returns 0 on success, a negative error code otherwise:
 231  *  * -EINVAL if the driver pointer is NULL or no idle states are available
 232  *  * -ENODEV if the cpuidle framework is disabled
 233  *  * -EBUSY if the driver is already assigned to the global variable(s)
 234  */
 235 static int __cpuidle_register_driver(struct cpuidle_driver *drv)
 236 {
 237         int ret;
 238
 239         if (!drv || !drv->state_count)
 240                 return -EINVAL;
 241
 242         if (cpuidle_disabled())
 243                 return -ENODEV;
 244
 245         __cpuidle_driver_init(drv);
 246
 247         ret = __cpuidle_set_driver(drv);
 248         if (ret)
 249                 return ret;
 250
 251         if (drv->bctimer)
 252                 on_each_cpu_mask(drv->cpumask, cpuidle_setup_broadcast_timer,
 253                                  (void *)CLOCK_EVT_NOTIFY_BROADCAST_ON, 1);
 254
 255         poll_idle_init(drv);
 256
 257         return 0;
 258 }
 259
 260 /**
 261  * __cpuidle_unregister_driver - unregister the driver
 262  * @drv: a valid pointer to a struct cpuidle_driver
 263  *
 264  * Check if the driver is no longer in use, reset the global cpuidle driver
 265  * variable(s) and disable the timer broadcast notification mechanism if it was
 266  * in use.
 267  *
 268  */
 269 static void __cpuidle_unregister_driver(struct cpuidle_driver *drv)
 270 {
 271         if (WARN_ON(drv->refcnt > 0))
 272                 return;
 273
 274         if (drv->bctimer) {
 275                 drv->bctimer = 0;
 276                 on_each_cpu_mask(drv->cpumask, cpuidle_setup_broadcast_timer,
 277                                  (void *)CLOCK_EVT_NOTIFY_BROADCAST_OFF, 1);
 278         }
 279
 280         __cpuidle_unset_driver(drv);
 281 }
 282
 283 /**
 284  * cpuidle_register_driver - registers a driver
 285  * @drv: a pointer to a valid struct cpuidle_driver
 286  *
 287  * Register the driver under a lock to prevent concurrent attempts to
 288  * [un]register the driver from occuring at the same time.
 289  *
 290  * Returns 0 on success, a negative error code (returned by
 291  * __cpuidle_register_driver()) otherwise.
 292  */
 293 int cpuidle_register_driver(struct cpuidle_driver *drv)
 294 {
 295         int ret;
 296
 297         spin_lock(&cpuidle_driver_lock);
 298         ret = __cpuidle_register_driver(drv);
 299         spin_unlock(&cpuidle_driver_lock);
 300
 301         return ret;
 302 }
 303 EXPORT_SYMBOL_GPL(cpuidle_register_driver);
 304
 305 /**
 306  * cpuidle_unregister_driver - unregisters a driver
 307  * @drv: a pointer to a valid struct cpuidle_driver
 308  *
 309  * Unregisters the cpuidle driver under a lock to prevent concurrent attempts
 310  * to [un]register the driver from occuring at the same time.  @drv has to
 311  * match the currently registered driver.
 312  */
 313 void cpuidle_unregister_driver(struct cpuidle_driver *drv)
 314 {
 315         spin_lock(&cpuidle_driver_lock);
 316         __cpuidle_unregister_driver(drv);
 317         spin_unlock(&cpuidle_driver_lock);
 318 }
 319 EXPORT_SYMBOL_GPL(cpuidle_unregister_driver);
 320
 321 /**
 322  * cpuidle_get_driver - return the driver tied to the current CPU.
 323  *
 324  * Returns a struct cpuidle_driver pointer, or NULL if no driver is registered.
 325  */
 326 struct cpuidle_driver *cpuidle_get_driver(void)
 327 {
 328         struct cpuidle_driver *drv;
 329         int cpu;
 330
 331         cpu = get_cpu();
 332         drv = __cpuidle_get_cpu_driver(cpu);
 333         put_cpu();
 334
 335         return drv;
 336 }
 337 EXPORT_SYMBOL_GPL(cpuidle_get_driver);
 338
 339 /**
 340  * cpuidle_get_cpu_driver - return the driver registered for a CPU.
 341  * @dev: a valid pointer to a struct cpuidle_device
 342  *
 343  * Returns a struct cpuidle_driver pointer, or NULL if no driver is registered
 344  * for the CPU associated with @dev.
 345  */
 346 struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev)
 347 {
 348         if (!dev)
 349                 return NULL;
 350
 351         return __cpuidle_get_cpu_driver(dev->cpu);
 352 }
 353 EXPORT_SYMBOL_GPL(cpuidle_get_cpu_driver);
 354
 355 /**
 356  * cpuidle_driver_ref - get a reference to the driver.
 357  *
 358  * Increment the reference counter of the cpuidle driver associated with
 359  * the current CPU.
 360  *
 361  * Returns a pointer to the driver, or NULL if the current CPU has no driver.
 362  */
 363 struct cpuidle_driver *cpuidle_driver_ref(void)
 364 {
 365         struct cpuidle_driver *drv;
 366
 367         spin_lock(&cpuidle_driver_lock);
 368
 369         drv = cpuidle_get_driver();
 370         if (drv)
 371                 drv->refcnt++;
 372
 373         spin_unlock(&cpuidle_driver_lock);
 374         return drv;
 375 }
 376
 377 /**
 378  * cpuidle_driver_unref - puts down the refcount for the driver
 379  *
 380  * Decrement the reference counter of the cpuidle driver associated with
 381  * the current CPU.
 382  */
 383 void cpuidle_driver_unref(void)
 384 {
 385         struct cpuidle_driver *drv;
 386
 387         spin_lock(&cpuidle_driver_lock);
 388
 389         drv = cpuidle_get_driver();
 390         if (drv && !WARN_ON(drv->refcnt <= 0))
 391                 drv->refcnt--;
 392
 393         spin_unlock(&cpuidle_driver_lock);
 394 }