Documentation/thermal/cpu-cooling-api.txt

   1 CPU cooling APIs How To
   2 ===================================
   3
   4 Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
   5
   6 Updated: 12 May 2012
   7
   8 Copyright (c)  2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
   9
  10 0. Introduction
  11
  12 The generic cpu cooling(freq clipping) provides registration/unregistration APIs
  13 to the caller. The binding of the cooling devices to the trip point is left for
  14 the user. The registration APIs returns the cooling device pointer.
  15
  16 1. cpu cooling APIs
  17
  18 1.1 cpufreq registration/unregistration APIs
  19 1.1.1 struct thermal_cooling_device *cpufreq_cooling_register(
  20         struct cpumask *clip_cpus)
  21
  22     This interface function registers the cpufreq cooling device with the name
  23     "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
  24     cooling devices.
  25
  26    clip_cpus: cpumask of cpus where the frequency constraints will happen.
  27
  28 1.1.2 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
  29
  30     This interface function unregisters the "thermal-cpufreq-%x" cooling device.
  31
  32     cdev: Cooling device pointer which has to be unregistered.