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>

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d12a80f386a656d97553940f15c91c06baf20f6b..37ac052ded859d5a6a2bd0bedbf12d0fa710036a 100644 (file)
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -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

diff --git a/Documentation/thermal/cpu-cooling-api.rst b/Documentation/driver-api/thermal/cpu-cooling-api.rst
similarity index 100%
rename from Documentation/thermal/cpu-cooling-api.rst
rename to Documentation/driver-api/thermal/cpu-cooling-api.rst

diff --git a/Documentation/thermal/exynos_thermal.rst b/Documentation/driver-api/thermal/exynos_thermal.rst
similarity index 100%
rename from Documentation/thermal/exynos_thermal.rst
rename to Documentation/driver-api/thermal/exynos_thermal.rst

diff --git a/Documentation/thermal/exynos_thermal_emulation.rst b/Documentation/driver-api/thermal/exynos_thermal_emulation.rst
similarity index 100%
rename from Documentation/thermal/exynos_thermal_emulation.rst
rename to Documentation/driver-api/thermal/exynos_thermal_emulation.rst

diff --git a/Documentation/thermal/index.rst b/Documentation/driver-api/thermal/index.rst
similarity index 86%
rename from Documentation/thermal/index.rst
rename to Documentation/driver-api/thermal/index.rst
index 8c1c00146cad6cf390962184f49906c1d5646e62..5ba61d19c6aebd738b05a62af3044cb479e328e7 100644 (file)
--- a/Documentation/thermal/index.rst
+++ b/Documentation/driver-api/thermal/index.rst
@@ -1,4 +1,4 @@
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
 
 =======
 Thermal

diff --git a/Documentation/thermal/intel_powerclamp.rst b/Documentation/driver-api/thermal/intel_powerclamp.rst
similarity index 100%
rename from Documentation/thermal/intel_powerclamp.rst
rename to Documentation/driver-api/thermal/intel_powerclamp.rst

diff --git a/Documentation/thermal/nouveau_thermal.rst b/Documentation/driver-api/thermal/nouveau_thermal.rst
similarity index 100%
rename from Documentation/thermal/nouveau_thermal.rst
rename to Documentation/driver-api/thermal/nouveau_thermal.rst

diff --git a/Documentation/thermal/power_allocator.rst b/Documentation/driver-api/thermal/power_allocator.rst
similarity index 100%
rename from Documentation/thermal/power_allocator.rst
rename to Documentation/driver-api/thermal/power_allocator.rst

diff --git a/Documentation/thermal/sysfs-api.rst b/Documentation/driver-api/thermal/sysfs-api.rst
similarity index 98%
rename from Documentation/thermal/sysfs-api.rst
rename to Documentation/driver-api/thermal/sysfs-api.rst
index e4930761d3e532ac1e2402b4fb1c74f4ab1463f3..fab2c9b36d084fd00020fee8f7c97a98b084b70c 100644 (file)
--- a/Documentation/thermal/sysfs-api.rst
+++ b/Documentation/driver-api/thermal/sysfs-api.rst
@@ -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
 

diff --git a/Documentation/thermal/x86_pkg_temperature_thermal.rst b/Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
similarity index 94%
rename from Documentation/thermal/x86_pkg_temperature_thermal.rst
rename to Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
index f134dbd3f5a97d513692ee3b908070dfac7c7711..2ac42ccd236f6b384c26a8fbe5ccc08e9e1b4000 100644 (file)
--- a/Documentation/thermal/x86_pkg_temperature_thermal.rst
+++ b/Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
@@ -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.

diff --git a/MAINTAINERS b/MAINTAINERS
index 7a07cda43592d0c7406703ac606b30f71180a18a..6326445952f6d09302af74b1600901ba94ed0c5c 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -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
 

diff --git a/include/linux/thermal.h b/include/linux/thermal.h
index 681047f8cc05773e6854b9db8809dea730a2801b..e45659c7592096e04cc2284026f5ab0bf153565c 100644 (file)
--- a/include/linux/thermal.h
+++ b/include/linux/thermal.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;