docs: thermal: add it to the driver API

The file contents mostly describes driver internals.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-07-26 09:51:12 -03:00 коммит произвёл Jonathan Corbet
Родитель fe13225fdc
Коммит eaf7b46083
12 изменённых файлов: 12 добавлений и 11 удалений

Просмотреть файл

@ -65,6 +65,7 @@ available subsections can be seen below.
dmaengine/index
slimbus
soundwire/index
thermal/index
fpga/index
acpi/index
backlight/lp855x-driver.rst

Просмотреть файл

@ -1,4 +1,4 @@
:orphan:
.. SPDX-License-Identifier: GPL-2.0
=======
Thermal

Просмотреть файл

@ -552,7 +552,7 @@ emul_temp
sustainable_power
An estimate of the sustained power that can be dissipated by
the thermal zone. Used by the power allocator governor. For
more information see Documentation/thermal/power_allocator.rst
more information see Documentation/driver-api/thermal/power_allocator.rst
Unit: milliwatts
@ -563,7 +563,7 @@ k_po
controller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired
temperature" trip point. For more information see
Documentation/thermal/power_allocator.rst
Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@ -572,7 +572,7 @@ k_pu
controller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired
temperature" trip point. For more information see
Documentation/thermal/power_allocator.rst
Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@ -580,14 +580,14 @@ k_i
The integral term of the power allocator governor's PID
controller. This term allows the PID controller to compensate
for long term drift. For more information see
Documentation/thermal/power_allocator.rst
Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
k_d
The derivative term of the power allocator governor's PID
controller. For more information see
Documentation/thermal/power_allocator.rst
Documentation/driver-api/thermal/power_allocator.rst
RW, Optional
@ -598,7 +598,7 @@ integral_cutoff
example, if integral_cutoff is 0, then the integral term only
accumulates error when temperature is above the desired
temperature trip point. For more information see
Documentation/thermal/power_allocator.rst
Documentation/driver-api/thermal/power_allocator.rst
Unit: millidegree Celsius

Просмотреть файл

@ -40,7 +40,7 @@ This contains two trip points:
- trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units
are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for
are in milli-degree Celsius. Refer to "Documentation/driver-api/thermal/sysfs-api.rst" for
thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications.

Просмотреть файл

@ -15916,7 +15916,7 @@ M: Viresh Kumar <viresh.kumar@linaro.org>
M: Javi Merino <javi.merino@kernel.org>
L: linux-pm@vger.kernel.org
S: Supported
F: Documentation/thermal/cpu-cooling-api.rst
F: Documentation/driver-api/thermal/cpu-cooling-api.rst
F: drivers/thermal/cpu_cooling.c
F: include/linux/cpu_cooling.h

Просмотреть файл

@ -251,7 +251,7 @@ struct thermal_bind_params {
* platform characterization. This value is relative to the
* rest of the weights so a cooling device whose weight is
* double that of another cooling device is twice as
* effective. See Documentation/thermal/sysfs-api.rst for more
* effective. See Documentation/driver-api/thermal/sysfs-api.rst for more
* information.
*/
int weight;
@ -259,7 +259,7 @@ struct thermal_bind_params {
/*
* This is a bit mask that gives the binding relation between this
* thermal zone and cdev, for a particular trip point.
* See Documentation/thermal/sysfs-api.rst for more information.
* See Documentation/driver-api/thermal/sysfs-api.rst for more information.
*/
int trip_mask;