Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
eaf7b460 fe13225f

+12 -11
+1
Documentation/driver-api/index.rst
··· 65 65 dmaengine/index 66 66 slimbus 67 67 soundwire/index 68 + thermal/index 68 69 fpga/index 69 70 acpi/index 70 71 backlight/lp855x-driver.rst
Documentation/thermal/cpu-cooling-api.rst Documentation/driver-api/thermal/cpu-cooling-api.rst
Documentation/thermal/exynos_thermal.rst Documentation/driver-api/thermal/exynos_thermal.rst
Documentation/thermal/exynos_thermal_emulation.rst Documentation/driver-api/thermal/exynos_thermal_emulation.rst
+1 -1
Documentation/thermal/index.rst Documentation/driver-api/thermal/index.rst
··· 1 - :orphan: 1 + .. SPDX-License-Identifier: GPL-2.0 2 2 3 3 ======= 4 4 Thermal
Documentation/thermal/intel_powerclamp.rst Documentation/driver-api/thermal/intel_powerclamp.rst
Documentation/thermal/nouveau_thermal.rst Documentation/driver-api/thermal/nouveau_thermal.rst
Documentation/thermal/power_allocator.rst Documentation/driver-api/thermal/power_allocator.rst
+6 -6
Documentation/thermal/sysfs-api.rst Documentation/driver-api/thermal/sysfs-api.rst
··· 552 552 sustainable_power 553 553 An estimate of the sustained power that can be dissipated by 554 554 the thermal zone. Used by the power allocator governor. For 555 - more information see Documentation/thermal/power_allocator.rst 555 + more information see Documentation/driver-api/thermal/power_allocator.rst 556 556 557 557 Unit: milliwatts 558 558 ··· 563 563 controller during temperature overshoot. Temperature overshoot 564 564 is when the current temperature is above the "desired 565 565 temperature" trip point. For more information see 566 - Documentation/thermal/power_allocator.rst 566 + Documentation/driver-api/thermal/power_allocator.rst 567 567 568 568 RW, Optional 569 569 ··· 572 572 controller during temperature undershoot. Temperature undershoot 573 573 is when the current temperature is below the "desired 574 574 temperature" trip point. For more information see 575 - Documentation/thermal/power_allocator.rst 575 + Documentation/driver-api/thermal/power_allocator.rst 576 576 577 577 RW, Optional 578 578 ··· 580 580 The integral term of the power allocator governor's PID 581 581 controller. This term allows the PID controller to compensate 582 582 for long term drift. For more information see 583 - Documentation/thermal/power_allocator.rst 583 + Documentation/driver-api/thermal/power_allocator.rst 584 584 585 585 RW, Optional 586 586 587 587 k_d 588 588 The derivative term of the power allocator governor's PID 589 589 controller. For more information see 590 - Documentation/thermal/power_allocator.rst 590 + Documentation/driver-api/thermal/power_allocator.rst 591 591 592 592 RW, Optional 593 593 ··· 598 598 example, if integral_cutoff is 0, then the integral term only 599 599 accumulates error when temperature is above the desired 600 600 temperature trip point. For more information see 601 - Documentation/thermal/power_allocator.rst 601 + Documentation/driver-api/thermal/power_allocator.rst 602 602 603 603 Unit: millidegree Celsius 604 604
+1 -1
Documentation/thermal/x86_pkg_temperature_thermal.rst Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst
··· 40 40 - trip_point_1_temp 41 41 42 42 User can set any temperature between 0 to TJ-Max temperature. Temperature units 43 - are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for 43 + are in milli-degree Celsius. Refer to "Documentation/driver-api/thermal/sysfs-api.rst" for 44 44 thermal sys-fs details. 45 45 46 46 Any value other than 0 in these trip points, can trigger thermal notifications.
+1 -1
MAINTAINERS
··· 15916 15916 M: Javi Merino <javi.merino@kernel.org> 15917 15917 L: linux-pm@vger.kernel.org 15918 15918 S: Supported 15919 - F: Documentation/thermal/cpu-cooling-api.rst 15919 + F: Documentation/driver-api/thermal/cpu-cooling-api.rst 15920 15920 F: drivers/thermal/cpu_cooling.c 15921 15921 F: include/linux/cpu_cooling.h 15922 15922
+2 -2
include/linux/thermal.h
··· 251 251 * platform characterization. This value is relative to the 252 252 * rest of the weights so a cooling device whose weight is 253 253 * double that of another cooling device is twice as 254 - * effective. See Documentation/thermal/sysfs-api.rst for more 254 + * effective. See Documentation/driver-api/thermal/sysfs-api.rst for more 255 255 * information. 256 256 */ 257 257 int weight; ··· 259 259 /* 260 260 * This is a bit mask that gives the binding relation between this 261 261 * thermal zone and cdev, for a particular trip point. 262 - * See Documentation/thermal/sysfs-api.rst for more information. 262 + * See Documentation/driver-api/thermal/sysfs-api.rst for more information. 263 263 */ 264 264 int trip_mask; 265 265