drivers/thermal/cpu_cooling.c

   1 /*
   2  *  linux/drivers/thermal/cpu_cooling.c
   3  *
   4  *  Copyright (C) 2012  Samsung Electronics Co., Ltd(http://www.samsung.com)
   5  *  Copyright (C) 2012  Amit Daniel <amit.kachhap@linaro.org>
   6  *
   7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; version 2 of the License.
  11  *
  12  *  This program is distributed in the hope that it will be useful, but
  13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *  General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License along
  18  *  with this program; if not, write to the Free Software Foundation, Inc.,
  19  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  20  *
  21  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22  */
  23 #include <linux/module.h>
  24 #include <linux/thermal.h>
  25 #include <linux/cpufreq.h>
  26 #include <linux/err.h>
  27 #include <linux/slab.h>
  28 #include <linux/cpu.h>
  29 #include <linux/cpu_cooling.h>
  30
  31 /**
  32  * struct cpufreq_cooling_device - data for cooling device with cpufreq
  33  * @id: unique integer value corresponding to each cpufreq_cooling_device
  34  *      registered.
  35  * @cool_dev: thermal_cooling_device pointer to keep track of the
  36  *      registered cooling device.
  37  * @cpufreq_state: integer value representing the current state of cpufreq
  38  *      cooling devices.
  39  * @cpufreq_val: integer value representing the absolute value of the clipped
  40  *      frequency.
  41  * @allowed_cpus: all the cpus involved for this cpufreq_cooling_device.
  42  *
  43  * This structure is required for keeping information of each
  44  * cpufreq_cooling_device registered. In order to prevent corruption of this a
  45  * mutex lock cooling_cpufreq_lock is used.
  46  */
  47 struct cpufreq_cooling_device {
  48         int id;
  49         struct thermal_cooling_device *cool_dev;
  50         unsigned int cpufreq_state;
  51         unsigned int cpufreq_val;
  52         struct cpumask allowed_cpus;
  53 };
  54 static DEFINE_IDR(cpufreq_idr);
  55 static DEFINE_MUTEX(cooling_cpufreq_lock);
  56
  57 static unsigned int cpufreq_dev_count;
  58
  59 /* notify_table passes value to the CPUFREQ_ADJUST callback function. */
  60 #define NOTIFY_INVALID NULL
  61 static struct cpufreq_cooling_device *notify_device;
  62
  63 /**
  64  * get_idr - function to get a unique id.
  65  * @idr: struct idr * handle used to create a id.
  66  * @id: int * value generated by this function.
  67  *
  68  * This function will populate @id with an unique
  69  * id, using the idr API.
  70  *
  71  * Return: 0 on success, an error code on failure.
  72  */
  73 static int get_idr(struct idr *idr, int *id)
  74 {
  75         int ret;
  76
  77         mutex_lock(&cooling_cpufreq_lock);
  78         ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL);
  79         mutex_unlock(&cooling_cpufreq_lock);
  80         if (unlikely(ret < 0))
  81                 return ret;
  82         *id = ret;
  83
  84         return 0;
  85 }
  86
  87 /**
  88  * release_idr - function to free the unique id.
  89  * @idr: struct idr * handle used for creating the id.
  90  * @id: int value representing the unique id.
  91  */
  92 static void release_idr(struct idr *idr, int id)
  93 {
  94         mutex_lock(&cooling_cpufreq_lock);
  95         idr_remove(idr, id);
  96         mutex_unlock(&cooling_cpufreq_lock);
  97 }
  98
  99 /* Below code defines functions to be used for cpufreq as cooling device */
 100
 101 /**
 102  * is_cpufreq_valid - function to check frequency transitioning capability.
 103  * @cpu: cpu for which check is needed.
 104  *
 105  * This function will check the current state of the system if
 106  * it is capable of changing the frequency for a given @cpu.
 107  *
 108  * Return: 0 if the system is not currently capable of changing
 109  * the frequency of given cpu. !0 in case the frequency is changeable.
 110  */
 111 static int is_cpufreq_valid(int cpu)
 112 {
 113         struct cpufreq_policy policy;
 114
 115         return !cpufreq_get_policy(&policy, cpu);
 116 }
 117
 118 enum cpufreq_cooling_property {
 119         GET_LEVEL,
 120         GET_FREQ,
 121         GET_MAXL,
 122 };
 123
 124 /**
 125  * get_property - fetch a property of interest for a give cpu.
 126  * @cpu: cpu for which the property is required
 127  * @input: query parameter
 128  * @output: query return
 129  * @property: type of query (frequency, level, max level)
 130  *
 131  * This is the common function to
 132  * 1. get maximum cpu cooling states
 133  * 2. translate frequency to cooling state
 134  * 3. translate cooling state to frequency
 135  * Note that the code may be not in good shape
 136  * but it is written in this way in order to:
 137  * a) reduce duplicate code as most of the code can be shared.
 138  * b) make sure the logic is consistent when translating between
 139  *    cooling states and frequencies.
 140  *
 141  * Return: 0 on success, -EINVAL when invalid parameters are passed.
 142  */
 143 static int get_property(unsigned int cpu, unsigned long input,
 144                         unsigned int *output,
 145                         enum cpufreq_cooling_property property)
 146 {
 147         int i, j;
 148         unsigned long max_level = 0, level = 0;
 149         unsigned int freq = CPUFREQ_ENTRY_INVALID;
 150         int descend = -1;
 151         struct cpufreq_frequency_table *table =
 152                                         cpufreq_frequency_get_table(cpu);
 153
 154         if (!output)
 155                 return -EINVAL;
 156
 157         if (!table)
 158                 return -EINVAL;
 159
 160         for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
 161                 /* ignore invalid entries */
 162                 if (table[i].frequency == CPUFREQ_ENTRY_INVALID)
 163                         continue;
 164
 165                 /* ignore duplicate entry */
 166                 if (freq == table[i].frequency)
 167                         continue;
 168
 169                 /* get the frequency order */
 170                 if (freq != CPUFREQ_ENTRY_INVALID && descend != -1)
 171                         descend = !!(freq > table[i].frequency);
 172
 173                 freq = table[i].frequency;
 174                 max_level++;
 175         }
 176
 177         /* get max level */
 178         if (property == GET_MAXL) {
 179                 *output = (unsigned int)max_level;
 180                 return 0;
 181         }
 182
 183         if (property == GET_FREQ)
 184                 level = descend ? input : (max_level - input -1);
 185
 186
 187         for (i = 0, j = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
 188                 /* ignore invalid entry */
 189                 if (table[i].frequency == CPUFREQ_ENTRY_INVALID)
 190                         continue;
 191
 192                 /* ignore duplicate entry */
 193                 if (freq == table[i].frequency)
 194                         continue;
 195
 196                 /* now we have a valid frequency entry */
 197                 freq = table[i].frequency;
 198
 199                 if (property == GET_LEVEL && (unsigned int)input == freq) {
 200                         /* get level by frequency */
 201                         *output = descend ? j : (max_level - j - 1);
 202                         return 0;
 203                 }
 204                 if (property == GET_FREQ && level == j) {
 205                         /* get frequency by level */
 206                         *output = freq;
 207                         return 0;
 208                 }
 209                 j++;
 210         }
 211
 212         return -EINVAL;
 213 }
 214
 215 /**
 216  * cpufreq_cooling_get_level - for a give cpu, return the cooling level.
 217  * @cpu: cpu for which the level is required
 218  * @freq: the frequency of interest
 219  *
 220  * This function will match the cooling level corresponding to the
 221  * requested @freq and return it.
 222  *
 223  * Return: The matched cooling level on success or THERMAL_CSTATE_INVALID
 224  * otherwise.
 225  */
 226 unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq)
 227 {
 228         unsigned int val;
 229
 230         if (get_property(cpu, (unsigned long)freq, &val, GET_LEVEL))
 231                 return THERMAL_CSTATE_INVALID;
 232
 233         return (unsigned long)val;
 234 }
 235 EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level);
 236
 237 /**
 238  * get_cpu_frequency - get the absolute value of frequency from level.
 239  * @cpu: cpu for which frequency is fetched.
 240  * @level: cooling level
 241  *
 242  * This function matches cooling level with frequency. Based on a cooling level
 243  * of frequency, equals cooling state of cpu cooling device, it will return
 244  * the corresponding frequency.
 245  *      e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc
 246  *
 247  * Return: 0 on error, the corresponding frequency otherwise.
 248  */
 249 static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level)
 250 {
 251         int ret = 0;
 252         unsigned int freq;
 253
 254         ret = get_property(cpu, level, &freq, GET_FREQ);
 255         if (ret)
 256                 return 0;
 257
 258         return freq;
 259 }
 260
 261 /**
 262  * cpufreq_apply_cooling - function to apply frequency clipping.
 263  * @cpufreq_device: cpufreq_cooling_device pointer containing frequency
 264  *      clipping data.
 265  * @cooling_state: value of the cooling state.
 266  *
 267  * Function used to make sure the cpufreq layer is aware of current thermal
 268  * limits. The limits are applied by updating the cpufreq policy.
 269  *
 270  * Return: 0 on success, an error code otherwise (-EINVAL in case wrong
 271  * cooling state).
 272  */
 273 static int cpufreq_apply_cooling(struct cpufreq_cooling_device *cpufreq_device,
 274                                 unsigned long cooling_state)
 275 {
 276         unsigned int cpuid, clip_freq;
 277         struct cpumask *mask = &cpufreq_device->allowed_cpus;
 278         unsigned int cpu = cpumask_any(mask);
 279
 280
 281         /* Check if the old cooling action is same as new cooling action */
 282         if (cpufreq_device->cpufreq_state == cooling_state)
 283                 return 0;
 284
 285         clip_freq = get_cpu_frequency(cpu, cooling_state);
 286         if (!clip_freq)
 287                 return -EINVAL;
 288
 289         cpufreq_device->cpufreq_state = cooling_state;
 290         cpufreq_device->cpufreq_val = clip_freq;
 291         notify_device = cpufreq_device;
 292
 293         for_each_cpu(cpuid, mask) {
 294                 if (is_cpufreq_valid(cpuid))
 295                         cpufreq_update_policy(cpuid);
 296         }
 297
 298         notify_device = NOTIFY_INVALID;
 299
 300         return 0;
 301 }
 302
 303 /**
 304  * cpufreq_thermal_notifier - notifier callback for cpufreq policy change.
 305  * @nb: struct notifier_block * with callback info.
 306  * @event: value showing cpufreq event for which this function invoked.
 307  * @data: callback-specific data
 308  *
 309  * Callback to highjack the notification on cpufreq policy transition.
 310  * Every time there is a change in policy, we will intercept and
 311  * update the cpufreq policy with thermal constraints.
 312  *
 313  * Return: 0 (success)
 314  */
 315 static int cpufreq_thermal_notifier(struct notifier_block *nb,
 316                                         unsigned long event, void *data)
 317 {
 318         struct cpufreq_policy *policy = data;
 319         unsigned long max_freq = 0;
 320
 321         if (event != CPUFREQ_ADJUST || notify_device == NOTIFY_INVALID)
 322                 return 0;
 323
 324         if (cpumask_test_cpu(policy->cpu, &notify_device->allowed_cpus))
 325                 max_freq = notify_device->cpufreq_val;
 326
 327         /* Never exceed user_policy.max */
 328         if (max_freq > policy->user_policy.max)
 329                 max_freq = policy->user_policy.max;
 330
 331         if (policy->max != max_freq)
 332                 cpufreq_verify_within_limits(policy, 0, max_freq);
 333
 334         return 0;
 335 }
 336
 337 /* cpufreq cooling device callback functions are defined below */
 338
 339 /**
 340  * cpufreq_get_max_state - callback function to get the max cooling state.
 341  * @cdev: thermal cooling device pointer.
 342  * @state: fill this variable with the max cooling state.
 343  *
 344  * Callback for the thermal cooling device to return the cpufreq
 345  * max cooling state.
 346  *
 347  * Return: 0 on success, an error code otherwise.
 348  */
 349 static int cpufreq_get_max_state(struct thermal_cooling_device *cdev,
 350                                  unsigned long *state)
 351 {
 352         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 353         struct cpumask *mask = &cpufreq_device->allowed_cpus;
 354         unsigned int cpu;
 355         unsigned int count = 0;
 356         int ret;
 357
 358         cpu = cpumask_any(mask);
 359
 360         ret = get_property(cpu, 0, &count, GET_MAXL);
 361
 362         if (count > 0)
 363                 *state = count;
 364
 365         return ret;
 366 }
 367
 368 /**
 369  * cpufreq_get_cur_state - callback function to get the current cooling state.
 370  * @cdev: thermal cooling device pointer.
 371  * @state: fill this variable with the current cooling state.
 372  *
 373  * Callback for the thermal cooling device to return the cpufreq
 374  * current cooling state.
 375  *
 376  * Return: 0 on success, an error code otherwise.
 377  */
 378 static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev,
 379                                  unsigned long *state)
 380 {
 381         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 382
 383         *state = cpufreq_device->cpufreq_state;
 384
 385         return 0;
 386 }
 387
 388 /**
 389  * cpufreq_set_cur_state - callback function to set the current cooling state.
 390  * @cdev: thermal cooling device pointer.
 391  * @state: set this variable to the current cooling state.
 392  *
 393  * Callback for the thermal cooling device to change the cpufreq
 394  * current cooling state.
 395  *
 396  * Return: 0 on success, an error code otherwise.
 397  */
 398 static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev,
 399                                  unsigned long state)
 400 {
 401         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 402
 403         return cpufreq_apply_cooling(cpufreq_device, state);
 404 }
 405
 406 /* Bind cpufreq callbacks to thermal cooling device ops */
 407 static struct thermal_cooling_device_ops const cpufreq_cooling_ops = {
 408         .get_max_state = cpufreq_get_max_state,
 409         .get_cur_state = cpufreq_get_cur_state,
 410         .set_cur_state = cpufreq_set_cur_state,
 411 };
 412
 413 /* Notifier for cpufreq policy change */
 414 static struct notifier_block thermal_cpufreq_notifier_block = {
 415         .notifier_call = cpufreq_thermal_notifier,
 416 };
 417
 418 /**
 419  * cpufreq_cooling_register - function to create cpufreq cooling device.
 420  * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
 421  *
 422  * This interface function registers the cpufreq cooling device with the name
 423  * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
 424  * cooling devices.
 425  *
 426  * Return: a valid struct thermal_cooling_device pointer on success,
 427  * on failure, it returns a corresponding ERR_PTR().
 428  */
 429 struct thermal_cooling_device *cpufreq_cooling_register(
 430         const struct cpumask *clip_cpus)
 431 {
 432         struct thermal_cooling_device *cool_dev;
 433         struct cpufreq_cooling_device *cpufreq_dev = NULL;
 434         unsigned int min = 0, max = 0;
 435         char dev_name[THERMAL_NAME_LENGTH];
 436         int ret = 0, i;
 437         struct cpufreq_policy policy;
 438
 439         /* Verify that all the clip cpus have same freq_min, freq_max limit */
 440         for_each_cpu(i, clip_cpus) {
 441                 /* continue if cpufreq policy not found and not return error */
 442                 if (!cpufreq_get_policy(&policy, i))
 443                         continue;
 444                 if (min == 0 && max == 0) {
 445                         min = policy.cpuinfo.min_freq;
 446                         max = policy.cpuinfo.max_freq;
 447                 } else {
 448                         if (min != policy.cpuinfo.min_freq ||
 449                                 max != policy.cpuinfo.max_freq)
 450                                 return ERR_PTR(-EINVAL);
 451                 }
 452         }
 453         cpufreq_dev = kzalloc(sizeof(struct cpufreq_cooling_device),
 454                         GFP_KERNEL);
 455         if (!cpufreq_dev)
 456                 return ERR_PTR(-ENOMEM);
 457
 458         cpumask_copy(&cpufreq_dev->allowed_cpus, clip_cpus);
 459
 460         ret = get_idr(&cpufreq_idr, &cpufreq_dev->id);
 461         if (ret) {
 462                 kfree(cpufreq_dev);
 463                 return ERR_PTR(-EINVAL);
 464         }
 465
 466         snprintf(dev_name, sizeof(dev_name), "thermal-cpufreq-%d",
 467                  cpufreq_dev->id);
 468
 469         cool_dev = thermal_cooling_device_register(dev_name, cpufreq_dev,
 470                                                 &cpufreq_cooling_ops);
 471         if (!cool_dev) {
 472                 release_idr(&cpufreq_idr, cpufreq_dev->id);
 473                 kfree(cpufreq_dev);
 474                 return ERR_PTR(-EINVAL);
 475         }
 476         cpufreq_dev->cool_dev = cool_dev;
 477         cpufreq_dev->cpufreq_state = 0;
 478         mutex_lock(&cooling_cpufreq_lock);
 479
 480         /* Register the notifier for first cpufreq cooling device */
 481         if (cpufreq_dev_count == 0)
 482                 cpufreq_register_notifier(&thermal_cpufreq_notifier_block,
 483                                                 CPUFREQ_POLICY_NOTIFIER);
 484         cpufreq_dev_count++;
 485
 486         mutex_unlock(&cooling_cpufreq_lock);
 487
 488         return cool_dev;
 489 }
 490 EXPORT_SYMBOL_GPL(cpufreq_cooling_register);
 491
 492 /**
 493  * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
 494  * @cdev: thermal cooling device pointer.
 495  *
 496  * This interface function unregisters the "thermal-cpufreq-%x" cooling device.
 497  */
 498 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
 499 {
 500         struct cpufreq_cooling_device *cpufreq_dev = cdev->devdata;
 501
 502         mutex_lock(&cooling_cpufreq_lock);
 503         cpufreq_dev_count--;
 504
 505         /* Unregister the notifier for the last cpufreq cooling device */
 506         if (cpufreq_dev_count == 0)
 507                 cpufreq_unregister_notifier(&thermal_cpufreq_notifier_block,
 508                                         CPUFREQ_POLICY_NOTIFIER);
 509
 510         mutex_unlock(&cooling_cpufreq_lock);
 511
 512         thermal_cooling_device_unregister(cpufreq_dev->cool_dev);
 513         release_idr(&cpufreq_idr, cpufreq_dev->id);
 514         kfree(cpufreq_dev);
 515 }
 516 EXPORT_SYMBOL_GPL(cpufreq_cooling_unregister);