Commit eaf7b460 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: thermal: add it to the driver API

The file contents mostly describes driver internals.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent fe13225f
...@@ -65,6 +65,7 @@ available subsections can be seen below. ...@@ -65,6 +65,7 @@ available subsections can be seen below.
dmaengine/index dmaengine/index
slimbus slimbus
soundwire/index soundwire/index
thermal/index
fpga/index fpga/index
acpi/index acpi/index
backlight/lp855x-driver.rst backlight/lp855x-driver.rst
......
:orphan: .. SPDX-License-Identifier: GPL-2.0
======= =======
Thermal Thermal
......
...@@ -552,7 +552,7 @@ emul_temp ...@@ -552,7 +552,7 @@ emul_temp
sustainable_power sustainable_power
An estimate of the sustained power that can be dissipated by An estimate of the sustained power that can be dissipated by
the thermal zone. Used by the power allocator governor. For 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 Unit: milliwatts
...@@ -563,7 +563,7 @@ k_po ...@@ -563,7 +563,7 @@ k_po
controller during temperature overshoot. Temperature overshoot controller during temperature overshoot. Temperature overshoot
is when the current temperature is above the "desired is when the current temperature is above the "desired
temperature" trip point. For more information see temperature" trip point. For more information see
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
RW, Optional RW, Optional
...@@ -572,7 +572,7 @@ k_pu ...@@ -572,7 +572,7 @@ k_pu
controller during temperature undershoot. Temperature undershoot controller during temperature undershoot. Temperature undershoot
is when the current temperature is below the "desired is when the current temperature is below the "desired
temperature" trip point. For more information see temperature" trip point. For more information see
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
RW, Optional RW, Optional
...@@ -580,14 +580,14 @@ k_i ...@@ -580,14 +580,14 @@ k_i
The integral term of the power allocator governor's PID The integral term of the power allocator governor's PID
controller. This term allows the PID controller to compensate controller. This term allows the PID controller to compensate
for long term drift. For more information see for long term drift. For more information see
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
RW, Optional RW, Optional
k_d k_d
The derivative term of the power allocator governor's PID The derivative term of the power allocator governor's PID
controller. For more information see controller. For more information see
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
RW, Optional RW, Optional
...@@ -598,7 +598,7 @@ integral_cutoff ...@@ -598,7 +598,7 @@ integral_cutoff
example, if integral_cutoff is 0, then the integral term only example, if integral_cutoff is 0, then the integral term only
accumulates error when temperature is above the desired accumulates error when temperature is above the desired
temperature trip point. For more information see temperature trip point. For more information see
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
Unit: millidegree Celsius Unit: millidegree Celsius
......
...@@ -40,7 +40,7 @@ This contains two trip points: ...@@ -40,7 +40,7 @@ This contains two trip points:
- trip_point_1_temp - trip_point_1_temp
User can set any temperature between 0 to TJ-Max temperature. Temperature units 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. thermal sys-fs details.
Any value other than 0 in these trip points, can trigger thermal notifications. Any value other than 0 in these trip points, can trigger thermal notifications.
......
...@@ -15916,7 +15916,7 @@ M: Viresh Kumar <viresh.kumar@linaro.org> ...@@ -15916,7 +15916,7 @@ M: Viresh Kumar <viresh.kumar@linaro.org>
M: Javi Merino <javi.merino@kernel.org> M: Javi Merino <javi.merino@kernel.org>
L: linux-pm@vger.kernel.org L: linux-pm@vger.kernel.org
S: Supported 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: drivers/thermal/cpu_cooling.c
F: include/linux/cpu_cooling.h F: include/linux/cpu_cooling.h
......
...@@ -251,7 +251,7 @@ struct thermal_bind_params { ...@@ -251,7 +251,7 @@ struct thermal_bind_params {
* platform characterization. This value is relative to the * platform characterization. This value is relative to the
* rest of the weights so a cooling device whose weight is * rest of the weights so a cooling device whose weight is
* double that of another cooling device is twice as * 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. * information.
*/ */
int weight; int weight;
...@@ -259,7 +259,7 @@ struct thermal_bind_params { ...@@ -259,7 +259,7 @@ struct thermal_bind_params {
/* /*
* This is a bit mask that gives the binding relation between this * This is a bit mask that gives the binding relation between this
* thermal zone and cdev, for a particular trip point. * 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; int trip_mask;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment