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