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;
 148         unsigned long max_level = 0, level = 0;
 149         unsigned int freq = CPUFREQ_ENTRY_INVALID;
 150         int descend = -1;
 151         struct cpufreq_frequency_table *pos, *table =
 152                                         cpufreq_frequency_get_table(cpu);
 153
 154         if (!output)
 155                 return -EINVAL;
 156
 157         if (!table)
 158                 return -EINVAL;
 159
 160         cpufreq_for_each_valid_entry(pos, table) {
 161                 /* ignore duplicate entry */
 162                 if (freq == pos->frequency)
 163                         continue;
 164
 165                 /* get the frequency order */
 166                 if (freq != CPUFREQ_ENTRY_INVALID && descend == -1)
 167                         descend = freq > pos->frequency;
 168
 169                 freq = pos->frequency;
 170                 max_level++;
 171         }
 172
 173         /* No valid cpu frequency entry */
 174         if (max_level == 0)
 175                 return -EINVAL;
 176
 177         /* max_level is an index, not a counter */
 178         max_level--;
 179
 180         /* get max level */
 181         if (property == GET_MAXL) {
 182                 *output = (unsigned int)max_level;
 183                 return 0;
 184         }
 185
 186         if (property == GET_FREQ)
 187                 level = descend ? input : (max_level - input);
 188
 189         i = 0;
 190         cpufreq_for_each_valid_entry(pos, table) {
 191                 /* ignore duplicate entry */
 192                 if (freq == pos->frequency)
 193                         continue;
 194
 195                 /* now we have a valid frequency entry */
 196                 freq = pos->frequency;
 197
 198                 if (property == GET_LEVEL && (unsigned int)input == freq) {
 199                         /* get level by frequency */
 200                         *output = descend ? i : (max_level - i);
 201                         return 0;
 202                 }
 203                 if (property == GET_FREQ && level == i) {
 204                         /* get frequency by level */
 205                         *output = freq;
 206                         return 0;
 207                 }
 208                 i++;
 209         }
 210
 211         return -EINVAL;
 212 }
 213
 214 /**
 215  * cpufreq_cooling_get_level - for a give cpu, return the cooling level.
 216  * @cpu: cpu for which the level is required
 217  * @freq: the frequency of interest
 218  *
 219  * This function will match the cooling level corresponding to the
 220  * requested @freq and return it.
 221  *
 222  * Return: The matched cooling level on success or THERMAL_CSTATE_INVALID
 223  * otherwise.
 224  */
 225 unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq)
 226 {
 227         unsigned int val;
 228
 229         if (get_property(cpu, (unsigned long)freq, &val, GET_LEVEL))
 230                 return THERMAL_CSTATE_INVALID;
 231
 232         return (unsigned long)val;
 233 }
 234 EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level);
 235
 236 /**
 237  * get_cpu_frequency - get the absolute value of frequency from level.
 238  * @cpu: cpu for which frequency is fetched.
 239  * @level: cooling level
 240  *
 241  * This function matches cooling level with frequency. Based on a cooling level
 242  * of frequency, equals cooling state of cpu cooling device, it will return
 243  * the corresponding frequency.
 244  *      e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc
 245  *
 246  * Return: 0 on error, the corresponding frequency otherwise.
 247  */
 248 static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level)
 249 {
 250         int ret = 0;
 251         unsigned int freq;
 252
 253         ret = get_property(cpu, level, &freq, GET_FREQ);
 254         if (ret)
 255                 return 0;
 256
 257         return freq;
 258 }
 259
 260 /**
 261  * cpufreq_apply_cooling - function to apply frequency clipping.
 262  * @cpufreq_device: cpufreq_cooling_device pointer containing frequency
 263  *      clipping data.
 264  * @cooling_state: value of the cooling state.
 265  *
 266  * Function used to make sure the cpufreq layer is aware of current thermal
 267  * limits. The limits are applied by updating the cpufreq policy.
 268  *
 269  * Return: 0 on success, an error code otherwise (-EINVAL in case wrong
 270  * cooling state).
 271  */
 272 static int cpufreq_apply_cooling(struct cpufreq_cooling_device *cpufreq_device,
 273                                  unsigned long cooling_state)
 274 {
 275         unsigned int cpuid, clip_freq;
 276         struct cpumask *mask = &cpufreq_device->allowed_cpus;
 277         unsigned int cpu = cpumask_any(mask);
 278
 279
 280         /* Check if the old cooling action is same as new cooling action */
 281         if (cpufreq_device->cpufreq_state == cooling_state)
 282                 return 0;
 283
 284         clip_freq = get_cpu_frequency(cpu, cooling_state);
 285         if (!clip_freq)
 286                 return -EINVAL;
 287
 288         cpufreq_device->cpufreq_state = cooling_state;
 289         cpufreq_device->cpufreq_val = clip_freq;
 290         notify_device = cpufreq_device;
 291
 292         for_each_cpu(cpuid, mask) {
 293                 if (is_cpufreq_valid(cpuid))
 294                         cpufreq_update_policy(cpuid);
 295         }
 296
 297         notify_device = NOTIFY_INVALID;
 298
 299         return 0;
 300 }
 301
 302 /**
 303  * cpufreq_thermal_notifier - notifier callback for cpufreq policy change.
 304  * @nb: struct notifier_block * with callback info.
 305  * @event: value showing cpufreq event for which this function invoked.
 306  * @data: callback-specific data
 307  *
 308  * Callback to hijack the notification on cpufreq policy transition.
 309  * Every time there is a change in policy, we will intercept and
 310  * update the cpufreq policy with thermal constraints.
 311  *
 312  * Return: 0 (success)
 313  */
 314 static int cpufreq_thermal_notifier(struct notifier_block *nb,
 315                                     unsigned long event, void *data)
 316 {
 317         struct cpufreq_policy *policy = data;
 318         unsigned long max_freq = 0;
 319
 320         if (event != CPUFREQ_ADJUST || notify_device == NOTIFY_INVALID)
 321                 return 0;
 322
 323         if (cpumask_test_cpu(policy->cpu, &notify_device->allowed_cpus))
 324                 max_freq = notify_device->cpufreq_val;
 325         else
 326                 return 0;
 327
 328         /* Never exceed user_policy.max */
 329         if (max_freq > policy->user_policy.max)
 330                 max_freq = policy->user_policy.max;
 331
 332         if (policy->max != max_freq)
 333                 cpufreq_verify_within_limits(policy, 0, max_freq);
 334
 335         return 0;
 336 }
 337
 338 /* cpufreq cooling device callback functions are defined below */
 339
 340 /**
 341  * cpufreq_get_max_state - callback function to get the max cooling state.
 342  * @cdev: thermal cooling device pointer.
 343  * @state: fill this variable with the max cooling state.
 344  *
 345  * Callback for the thermal cooling device to return the cpufreq
 346  * max cooling state.
 347  *
 348  * Return: 0 on success, an error code otherwise.
 349  */
 350 static int cpufreq_get_max_state(struct thermal_cooling_device *cdev,
 351                                  unsigned long *state)
 352 {
 353         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 354         struct cpumask *mask = &cpufreq_device->allowed_cpus;
 355         unsigned int cpu;
 356         unsigned int count = 0;
 357         int ret;
 358
 359         cpu = cpumask_any(mask);
 360
 361         ret = get_property(cpu, 0, &count, GET_MAXL);
 362
 363         if (count > 0)
 364                 *state = count;
 365
 366         return ret;
 367 }
 368
 369 /**
 370  * cpufreq_get_cur_state - callback function to get the current cooling state.
 371  * @cdev: thermal cooling device pointer.
 372  * @state: fill this variable with the current cooling state.
 373  *
 374  * Callback for the thermal cooling device to return the cpufreq
 375  * current cooling state.
 376  *
 377  * Return: 0 on success, an error code otherwise.
 378  */
 379 static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev,
 380                                  unsigned long *state)
 381 {
 382         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 383
 384         *state = cpufreq_device->cpufreq_state;
 385
 386         return 0;
 387 }
 388
 389 /**
 390  * cpufreq_set_cur_state - callback function to set the current cooling state.
 391  * @cdev: thermal cooling device pointer.
 392  * @state: set this variable to the current cooling state.
 393  *
 394  * Callback for the thermal cooling device to change the cpufreq
 395  * current cooling state.
 396  *
 397  * Return: 0 on success, an error code otherwise.
 398  */
 399 static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev,
 400                                  unsigned long state)
 401 {
 402         struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
 403
 404         return cpufreq_apply_cooling(cpufreq_device, state);
 405 }
 406
 407 /* Bind cpufreq callbacks to thermal cooling device ops */
 408 static struct thermal_cooling_device_ops const cpufreq_cooling_ops = {
 409         .get_max_state = cpufreq_get_max_state,
 410         .get_cur_state = cpufreq_get_cur_state,
 411         .set_cur_state = cpufreq_set_cur_state,
 412 };
 413
 414 /* Notifier for cpufreq policy change */
 415 static struct notifier_block thermal_cpufreq_notifier_block = {
 416         .notifier_call = cpufreq_thermal_notifier,
 417 };
 418
 419 /**
 420  * __cpufreq_cooling_register - helper function to create cpufreq cooling device
 421  * @np: a valid struct device_node to the cooling device device tree node
 422  * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
 423  *
 424  * This interface function registers the cpufreq cooling device with the name
 425  * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
 426  * cooling devices. It also gives the opportunity to link the cooling device
 427  * with a device tree node, in order to bind it via the thermal DT code.
 428  *
 429  * Return: a valid struct thermal_cooling_device pointer on success,
 430  * on failure, it returns a corresponding ERR_PTR().
 431  */
 432 static struct thermal_cooling_device *
 433 __cpufreq_cooling_register(struct device_node *np,
 434                            const struct cpumask *clip_cpus)
 435 {
 436         struct thermal_cooling_device *cool_dev;
 437         struct cpufreq_cooling_device *cpufreq_dev = NULL;
 438         unsigned int min = 0, max = 0;
 439         char dev_name[THERMAL_NAME_LENGTH];
 440         int ret = 0, i;
 441         struct cpufreq_policy policy;
 442
 443         /* Verify that all the clip cpus have same freq_min, freq_max limit */
 444         for_each_cpu(i, clip_cpus) {
 445                 /* continue if cpufreq policy not found and not return error */
 446                 if (!cpufreq_get_policy(&policy, i))
 447                         continue;
 448                 if (min == 0 && max == 0) {
 449                         min = policy.cpuinfo.min_freq;
 450                         max = policy.cpuinfo.max_freq;
 451                 } else {
 452                         if (min != policy.cpuinfo.min_freq ||
 453                             max != policy.cpuinfo.max_freq)
 454                                 return ERR_PTR(-EINVAL);
 455                 }
 456         }
 457         cpufreq_dev = kzalloc(sizeof(struct cpufreq_cooling_device),
 458                               GFP_KERNEL);
 459         if (!cpufreq_dev)
 460                 return ERR_PTR(-ENOMEM);
 461
 462         cpumask_copy(&cpufreq_dev->allowed_cpus, clip_cpus);
 463
 464         ret = get_idr(&cpufreq_idr, &cpufreq_dev->id);
 465         if (ret) {
 466                 kfree(cpufreq_dev);
 467                 return ERR_PTR(-EINVAL);
 468         }
 469
 470         snprintf(dev_name, sizeof(dev_name), "thermal-cpufreq-%d",
 471                  cpufreq_dev->id);
 472
 473         cool_dev = thermal_of_cooling_device_register(np, dev_name, cpufreq_dev,
 474                                                       &cpufreq_cooling_ops);
 475         if (IS_ERR(cool_dev)) {
 476                 release_idr(&cpufreq_idr, cpufreq_dev->id);
 477                 kfree(cpufreq_dev);
 478                 return cool_dev;
 479         }
 480         cpufreq_dev->cool_dev = cool_dev;
 481         cpufreq_dev->cpufreq_state = 0;
 482         mutex_lock(&cooling_cpufreq_lock);
 483
 484         /* Register the notifier for first cpufreq cooling device */
 485         if (cpufreq_dev_count == 0)
 486                 cpufreq_register_notifier(&thermal_cpufreq_notifier_block,
 487                                           CPUFREQ_POLICY_NOTIFIER);
 488         cpufreq_dev_count++;
 489
 490         mutex_unlock(&cooling_cpufreq_lock);
 491
 492         return cool_dev;
 493 }
 494
 495 /**
 496  * cpufreq_cooling_register - function to create cpufreq cooling device.
 497  * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
 498  *
 499  * This interface function registers the cpufreq cooling device with the name
 500  * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
 501  * cooling devices.
 502  *
 503  * Return: a valid struct thermal_cooling_device pointer on success,
 504  * on failure, it returns a corresponding ERR_PTR().
 505  */
 506 struct thermal_cooling_device *
 507 cpufreq_cooling_register(const struct cpumask *clip_cpus)
 508 {
 509         return __cpufreq_cooling_register(NULL, clip_cpus);
 510 }
 511 EXPORT_SYMBOL_GPL(cpufreq_cooling_register);
 512
 513 /**
 514  * of_cpufreq_cooling_register - function to create cpufreq cooling device.
 515  * @np: a valid struct device_node to the cooling device device tree node
 516  * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
 517  *
 518  * This interface function registers the cpufreq cooling device with the name
 519  * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
 520  * cooling devices. Using this API, the cpufreq cooling device will be
 521  * linked to the device tree node provided.
 522  *
 523  * Return: a valid struct thermal_cooling_device pointer on success,
 524  * on failure, it returns a corresponding ERR_PTR().
 525  */
 526 struct thermal_cooling_device *
 527 of_cpufreq_cooling_register(struct device_node *np,
 528                             const struct cpumask *clip_cpus)
 529 {
 530         if (!np)
 531                 return ERR_PTR(-EINVAL);
 532
 533         return __cpufreq_cooling_register(np, clip_cpus);
 534 }
 535 EXPORT_SYMBOL_GPL(of_cpufreq_cooling_register);
 536
 537 /**
 538  * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
 539  * @cdev: thermal cooling device pointer.
 540  *
 541  * This interface function unregisters the "thermal-cpufreq-%x" cooling device.
 542  */
 543 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
 544 {
 545         struct cpufreq_cooling_device *cpufreq_dev;
 546
 547         if (!cdev)
 548                 return;
 549
 550         cpufreq_dev = cdev->devdata;
 551         mutex_lock(&cooling_cpufreq_lock);
 552         cpufreq_dev_count--;
 553
 554         /* Unregister the notifier for the last cpufreq cooling device */
 555         if (cpufreq_dev_count == 0)
 556                 cpufreq_unregister_notifier(&thermal_cpufreq_notifier_block,
 557                                             CPUFREQ_POLICY_NOTIFIER);
 558         mutex_unlock(&cooling_cpufreq_lock);
 559
 560         thermal_cooling_device_unregister(cpufreq_dev->cool_dev);
 561         release_idr(&cpufreq_idr, cpufreq_dev->id);
 562         kfree(cpufreq_dev);
 563 }
 564 EXPORT_SYMBOL_GPL(cpufreq_cooling_unregister);