Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 514e6d20 authored by Zhang Rui's avatar Zhang Rui
Browse files

Thermal: update documentation for thermal_zone_device_register 



Update kernel Documentation for thermal_zone_device_register.

Signed-off-by: default avatarZhang Rui <rui.zhang@intel.com>
parent a00e55f9

Documentation/thermal/sysfs-api.txt

+11 −3
Original line number Original line Diff line number Diff line
@@ -31,15 +31,17 @@ temperature) and throttle appropriate devices. 
1. thermal sysfs driver interface functions

1. thermal sysfs driver interface functions





1.1 thermal zone device interface

1.1 thermal zone device interface

1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *name,

1.1.1 struct thermal_zone_device *thermal_zone_device_register(char *type,

		int trips, int mask, void *devdata,

		int trips, int mask, void *devdata,

		struct thermal_zone_device_ops *ops)

		struct thermal_zone_device_ops *ops,

		const struct thermal_zone_params *tzp,

		int passive_delay, int polling_delay))





    This interface function adds a new thermal zone device (sensor) to

    This interface function adds a new thermal zone device (sensor) to

    /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the

    /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the

    thermal cooling devices registered at the same time.

    thermal cooling devices registered at the same time.





    name: the thermal zone name.

    type: the thermal zone type.

    trips: the total number of trip points this thermal zone supports.

    trips: the total number of trip points this thermal zone supports.

    mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.

    mask: Bit string: If 'n'th bit is set, then trip point 'n' is writeable.

    devdata: device private data

    devdata: device private data
@@ -57,6 +59,12 @@ temperature) and throttle appropriate devices. 
			will be fired.

			will be fired.

	.set_emul_temp: set the emulation temperature which helps in debugging

	.set_emul_temp: set the emulation temperature which helps in debugging

			different threshold temperature points.

			different threshold temperature points.

    tzp: thermal zone platform parameters.

    passive_delay: number of milliseconds to wait between polls when

	performing passive cooling.

    polling_delay: number of milliseconds to wait between polls when checking

	whether trip points have been crossed (0 for interrupt driven systems).







1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)

1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)