Documentation/thermal/sysfs-api.txt

   1 Generic Thermal Sysfs driver How To
   2 ===================================
   3
   4 Written by Sujith Thomas <sujith.thomas@intel.com>, Zhang Rui <rui.zhang@intel.com>
   5
   6 Updated: 2 January 2008
   7
   8 Copyright (c)  2008 Intel Corporation
   9
  10
  11 0. Introduction
  12
  13 The generic thermal sysfs provides a set of interfaces for thermal zone
  14 devices (sensors) and thermal cooling devices (fan, processor...) to register
  15 with the thermal management solution and to be a part of it.
  16
  17 This how-to focuses on enabling new thermal zone and cooling devices to
  18 participate in thermal management.
  19 This solution is platform independent and any type of thermal zone devices
  20 and cooling devices should be able to make use of the infrastructure.
  21
  22 The main task of the thermal sysfs driver is to expose thermal zone attributes
  23 as well as cooling device attributes to the user space.
  24 An intelligent thermal management application can make decisions based on
  25 inputs from thermal zone attributes (the current temperature and trip point
  26 temperature) and throttle appropriate devices.
  27
  28 [0-*]   denotes any positive number starting from 0
  29 [1-*]   denotes any positive number starting from 1
  30
  31 1. thermal sysfs driver interface functions
  32
  33 1.1 thermal zone device interface
  34 1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *name,
  35                 int trips, int mask, void *devdata,
  36                 struct thermal_zone_device_ops *ops)
  37
  38     This interface function adds a new thermal zone device (sensor) to
  39     /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
  40     thermal cooling devices registered at the same time.
  41
  42     name: the thermal zone name.
  43     trips: the total number of trip points this thermal zone supports.
  44     mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.
  45     devdata: device private data
  46     ops: thermal zone device call-backs.
  47         .bind: bind the thermal zone device with a thermal cooling device.
  48         .unbind: unbind the thermal zone device with a thermal cooling device.
  49         .get_temp: get the current temperature of the thermal zone.
  50         .get_mode: get the current mode (enabled/disabled) of the thermal zone.
  51             - "enabled" means the kernel thermal management is enabled.
  52             - "disabled" will prevent kernel thermal driver action upon trip points
  53               so that user applications can take charge of thermal management.
  54         .set_mode: set the mode (enabled/disabled) of the thermal zone.
  55         .get_trip_type: get the type of certain trip point.
  56         .get_trip_temp: get the temperature above which the certain trip point
  57                         will be fired.
  58
  59 1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
  60
  61     This interface function removes the thermal zone device.
  62     It deletes the corresponding entry form /sys/class/thermal folder and
  63     unbind all the thermal cooling devices it uses.
  64
  65 1.2 thermal cooling device interface
  66 1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name,
  67                 void *devdata, struct thermal_cooling_device_ops *)
  68
  69     This interface function adds a new thermal cooling device (fan/processor/...)
  70     to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
  71     to all the thermal zone devices register at the same time.
  72     name: the cooling device name.
  73     devdata: device private data.
  74     ops: thermal cooling devices call-backs.
  75         .get_max_state: get the Maximum throttle state of the cooling device.
  76         .get_cur_state: get the Current throttle state of the cooling device.
  77         .set_cur_state: set the Current throttle state of the cooling device.
  78
  79 1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
  80
  81     This interface function remove the thermal cooling device.
  82     It deletes the corresponding entry form /sys/class/thermal folder and
  83     unbind itself from all the thermal zone devices using it.
  84
  85 1.3 interface for binding a thermal zone device with a thermal cooling device
  86 1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
  87         int trip, struct thermal_cooling_device *cdev,
  88         unsigned long upper, unsigned long lower);
  89
  90     This interface function bind a thermal cooling device to the certain trip
  91     point of a thermal zone device.
  92     This function is usually called in the thermal zone device .bind callback.
  93     tz: the thermal zone device
  94     cdev: thermal cooling device
  95     trip: indicates which trip point the cooling devices is associated with
  96           in this thermal zone.
  97     upper:the Maximum cooling state for this trip point.
  98           THERMAL_NO_LIMIT means no upper limit,
  99           and the cooling device can be in max_state.
 100     lower:the Minimum cooling state can be used for this trip point.
 101           THERMAL_NO_LIMIT means no lower limit,
 102           and the cooling device can be in cooling state 0.
 103
 104 1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
 105                 int trip, struct thermal_cooling_device *cdev);
 106
 107     This interface function unbind a thermal cooling device from the certain
 108     trip point of a thermal zone device. This function is usually called in
 109     the thermal zone device .unbind callback.
 110     tz: the thermal zone device
 111     cdev: thermal cooling device
 112     trip: indicates which trip point the cooling devices is associated with
 113           in this thermal zone.
 114
 115 1.4 Thermal Zone Parameters
 116 1.4.1 struct thermal_bind_params
 117     This structure defines the following parameters that are used to bind
 118     a zone with a cooling device for a particular trip point.
 119     .cdev: The cooling device pointer
 120     .weight: The 'influence' of a particular cooling device on this zone.
 121              This is on a percentage scale. The sum of all these weights
 122              (for a particular zone) cannot exceed 100.
 123     .trip_mask:This is a bit mask that gives the binding relation between
 124                this thermal zone and cdev, for a particular trip point.
 125                If nth bit is set, then the cdev and thermal zone are bound
 126                for trip point n.
 127     .match: This call back returns success(0) if the 'tz and cdev' need to
 128             be bound, as per platform data.
 129 1.4.2 struct thermal_zone_params
 130     This structure defines the platform level parameters for a thermal zone.
 131     This data, for each thermal zone should come from the platform layer.
 132     This is an optional feature where some platforms can choose not to
 133     provide this data.
 134     .governor_name: Name of the thermal governor used for this zone
 135     .num_tbps: Number of thermal_bind_params entries for this zone
 136     .tbp: thermal_bind_params entries
 137
 138 2. sysfs attributes structure
 139
 140 RO      read only value
 141 RW      read/write value
 142
 143 Thermal sysfs attributes will be represented under /sys/class/thermal.
 144 Hwmon sysfs I/F extension is also available under /sys/class/hwmon
 145 if hwmon is compiled in or built as a module.
 146
 147 Thermal zone device sys I/F, created once it's registered:
 148 /sys/class/thermal/thermal_zone[0-*]:
 149     |---type:                   Type of the thermal zone
 150     |---temp:                   Current temperature
 151     |---mode:                   Working mode of the thermal zone
 152     |---policy:                 Thermal governor used for this zone
 153     |---trip_point_[0-*]_temp:  Trip point temperature
 154     |---trip_point_[0-*]_type:  Trip point type
 155     |---trip_point_[0-*]_hyst:  Hysteresis value for this trip point
 156
 157 Thermal cooling device sys I/F, created once it's registered:
 158 /sys/class/thermal/cooling_device[0-*]:
 159     |---type:                   Type of the cooling device(processor/fan/...)
 160     |---max_state:              Maximum cooling state of the cooling device
 161     |---cur_state:              Current cooling state of the cooling device
 162
 163
 164 Then next two dynamic attributes are created/removed in pairs. They represent
 165 the relationship between a thermal zone and its associated cooling device.
 166 They are created/removed for each successful execution of
 167 thermal_zone_bind_cooling_device/thermal_zone_unbind_cooling_device.
 168
 169 /sys/class/thermal/thermal_zone[0-*]:
 170     |---cdev[0-*]:              [0-*]th cooling device in current thermal zone
 171     |---cdev[0-*]_trip_point:   Trip point that cdev[0-*] is associated with
 172
 173 Besides the thermal zone device sysfs I/F and cooling device sysfs I/F,
 174 the generic thermal driver also creates a hwmon sysfs I/F for each _type_
 175 of thermal zone device. E.g. the generic thermal driver registers one hwmon
 176 class device and build the associated hwmon sysfs I/F for all the registered
 177 ACPI thermal zones.
 178
 179 /sys/class/hwmon/hwmon[0-*]:
 180     |---name:                   The type of the thermal zone devices
 181     |---temp[1-*]_input:        The current temperature of thermal zone [1-*]
 182     |---temp[1-*]_critical:     The critical trip point of thermal zone [1-*]
 183
 184 Please read Documentation/hwmon/sysfs-interface for additional information.
 185
 186 ***************************
 187 * Thermal zone attributes *
 188 ***************************
 189
 190 type
 191         Strings which represent the thermal zone type.
 192         This is given by thermal zone driver as part of registration.
 193         E.g: "acpitz" indicates it's an ACPI thermal device.
 194         In order to keep it consistent with hwmon sys attribute; this should
 195         be a short, lowercase string, not containing spaces nor dashes.
 196         RO, Required
 197
 198 temp
 199         Current temperature as reported by thermal zone (sensor).
 200         Unit: millidegree Celsius
 201         RO, Required
 202
 203 mode
 204         One of the predefined values in [enabled, disabled].
 205         This file gives information about the algorithm that is currently
 206         managing the thermal zone. It can be either default kernel based
 207         algorithm or user space application.
 208         enabled         = enable Kernel Thermal management.
 209         disabled        = Preventing kernel thermal zone driver actions upon
 210                           trip points so that user application can take full
 211                           charge of the thermal management.
 212         RW, Optional
 213
 214 policy
 215         One of the various thermal governors used for a particular zone.
 216         RW, Required
 217
 218 trip_point_[0-*]_temp
 219         The temperature above which trip point will be fired.
 220         Unit: millidegree Celsius
 221         RO, Optional
 222
 223 trip_point_[0-*]_type
 224         Strings which indicate the type of the trip point.
 225         E.g. it can be one of critical, hot, passive, active[0-*] for ACPI
 226         thermal zone.
 227         RO, Optional
 228
 229 trip_point_[0-*]_hyst
 230         The hysteresis value for a trip point, represented as an integer
 231         Unit: Celsius
 232         RW, Optional
 233
 234 cdev[0-*]
 235         Sysfs link to the thermal cooling device node where the sys I/F
 236         for cooling device throttling control represents.
 237         RO, Optional
 238
 239 cdev[0-*]_trip_point
 240         The trip point with which cdev[0-*] is associated in this thermal
 241         zone; -1 means the cooling device is not associated with any trip
 242         point.
 243         RO, Optional
 244
 245 passive
 246         Attribute is only present for zones in which the passive cooling
 247         policy is not supported by native thermal driver. Default is zero
 248         and can be set to a temperature (in millidegrees) to enable a
 249         passive trip point for the zone. Activation is done by polling with
 250         an interval of 1 second.
 251         Unit: millidegrees Celsius
 252         Valid values: 0 (disabled) or greater than 1000
 253         RW, Optional
 254
 255 *****************************
 256 * Cooling device attributes *
 257 *****************************
 258
 259 type
 260         String which represents the type of device, e.g:
 261         - for generic ACPI: should be "Fan", "Processor" or "LCD"
 262         - for memory controller device on intel_menlow platform:
 263           should be "Memory controller".
 264         RO, Required
 265
 266 max_state
 267         The maximum permissible cooling state of this cooling device.
 268         RO, Required
 269
 270 cur_state
 271         The current cooling state of this cooling device.
 272         The value can any integer numbers between 0 and max_state:
 273         - cur_state == 0 means no cooling
 274         - cur_state == max_state means the maximum cooling.
 275         RW, Required
 276
 277 3. A simple implementation
 278
 279 ACPI thermal zone may support multiple trip points like critical, hot,
 280 passive, active. If an ACPI thermal zone supports critical, passive,
 281 active[0] and active[1] at the same time, it may register itself as a
 282 thermal_zone_device (thermal_zone1) with 4 trip points in all.
 283 It has one processor and one fan, which are both registered as
 284 thermal_cooling_device.
 285
 286 If the processor is listed in _PSL method, and the fan is listed in _AL0
 287 method, the sys I/F structure will be built like this:
 288
 289 /sys/class/thermal:
 290
 291 |thermal_zone1:
 292     |---type:                   acpitz
 293     |---temp:                   37000
 294     |---mode:                   enabled
 295     |---policy:                 step_wise
 296     |---trip_point_0_temp:      100000
 297     |---trip_point_0_type:      critical
 298     |---trip_point_1_temp:      80000
 299     |---trip_point_1_type:      passive
 300     |---trip_point_2_temp:      70000
 301     |---trip_point_2_type:      active0
 302     |---trip_point_3_temp:      60000
 303     |---trip_point_3_type:      active1
 304     |---cdev0:                  --->/sys/class/thermal/cooling_device0
 305     |---cdev0_trip_point:       1       /* cdev0 can be used for passive */
 306     |---cdev1:                  --->/sys/class/thermal/cooling_device3
 307     |---cdev1_trip_point:       2       /* cdev1 can be used for active[0]*/
 308
 309 |cooling_device0:
 310     |---type:                   Processor
 311     |---max_state:              8
 312     |---cur_state:              0
 313
 314 |cooling_device3:
 315     |---type:                   Fan
 316     |---max_state:              2
 317     |---cur_state:              0
 318
 319 /sys/class/hwmon:
 320
 321 |hwmon0:
 322     |---name:                   acpitz
 323     |---temp1_input:            37000
 324     |---temp1_crit:             100000
 325
 326 4. Event Notification
 327
 328 The framework includes a simple notification mechanism, in the form of a
 329 netlink event. Netlink socket initialization is done during the _init_
 330 of the framework. Drivers which intend to use the notification mechanism
 331 just need to call thermal_generate_netlink_event() with two arguments viz
 332 (originator, event). Typically the originator will be an integer assigned
 333 to a thermal_zone_device when it registers itself with the framework. The
 334 event will be one of:{THERMAL_AUX0, THERMAL_AUX1, THERMAL_CRITICAL,
 335 THERMAL_DEV_FAULT}. Notification can be sent when the current temperature
 336 crosses any of the configured thresholds.
 337
 338 5. Export Symbol APIs:
 339
 340 5.1: get_tz_trend:
 341 This function returns the trend of a thermal zone, i.e the rate of change
 342 of temperature of the thermal zone. Ideally, the thermal sensor drivers
 343 are supposed to implement the callback. If they don't, the thermal
 344 framework calculated the trend by comparing the previous and the current
 345 temperature values.
 346
 347 5.2:get_thermal_instance:
 348 This function returns the thermal_instance corresponding to a given
 349 {thermal_zone, cooling_device, trip_point} combination. Returns NULL
 350 if such an instance does not exist.
 351
 352 5.3:notify_thermal_framework:
 353 This function handles the trip events from sensor drivers. It starts
 354 throttling the cooling devices according to the policy configured.
 355 For CRITICAL and HOT trip points, this notifies the respective drivers,
 356 and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
 357 The throttling policy is based on the configured platform data; if no
 358 platform data is provided, this uses the step_wise throttling policy.
 359
 360 5.4:thermal_cdev_update:
 361 This function serves as an arbitrator to set the state of a cooling
 362 device. It sets the cooling device to the deepest cooling state if
 363 possible.
 364
 365 5.5:thermal_register_governor:
 366 This function lets the various thermal governors to register themselves
 367 with the Thermal framework. At run time, depending on a zone's platform
 368 data, a particular governor is used for throttling.
 369
 370 5.6:thermal_unregister_governor:
 371 This function unregisters a governor from the thermal framework.