Commit 514e6d20147b86900f3302ef756af58890641b4d

Authored by Zhang Rui
1 parent a00e55f9c8

Thermal: update documentation for thermal_zone_device_register

Update kernel Documentation for thermal_zone_device_register.

Signed-off-by: Zhang Rui <rui.zhang@intel.com>

Showing 1 changed file with 11 additions and 3 deletions Side-by-side Diff

Documentation/thermal/sysfs-api.txt
... ... @@ -31,15 +31,17 @@
31 31 1. thermal sysfs driver interface functions
32 32  
33 33 1.1 thermal zone device interface
34   -1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *name,
  34 +1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *type,
35 35 int trips, int mask, void *devdata,
36   - struct thermal_zone_device_ops *ops)
  36 + struct thermal_zone_device_ops *ops,
  37 + const struct thermal_zone_params *tzp,
  38 + int passive_delay, int polling_delay))
37 39  
38 40 This interface function adds a new thermal zone device (sensor) to
39 41 /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
40 42 thermal cooling devices registered at the same time.
41 43  
42   - name: the thermal zone name.
  44 + type: the thermal zone type.
43 45 trips: the total number of trip points this thermal zone supports.
44 46 mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.
45 47 devdata: device private data
... ... @@ -57,6 +59,12 @@
57 59 will be fired.
58 60 .set_emul_temp: set the emulation temperature which helps in debugging
59 61 different threshold temperature points.
  62 + tzp: thermal zone platform parameters.
  63 + passive_delay: number of milliseconds to wait between polls when
  64 + performing passive cooling.
  65 + polling_delay: number of milliseconds to wait between polls when checking
  66 + whether trip points have been crossed (0 for interrupt driven systems).
  67 +
60 68  
61 69 1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
62 70