ABI: testing: sysfs-class-oxp: add missing documentation
authorAntheas Kapenekakis <lkml@antheas.dev>
Fri, 25 Apr 2025 11:18:09 +0000 (13:18 +0200)
committerIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Wed, 30 Apr 2025 11:05:28 +0000 (14:05 +0300)
Add missing documentation about the tt_toggle attribute that was added
in kernel 6.5.

Fixes: be144ee491272 ("hwmon: (oxp-sensors) Add tt_toggle attribute on supported boards")
Reviewed-by: Thomas Weißschuh <linux@weissschuh.net>
Reviewed-by: Derek J. Clark <derekjohn.clark@gmail.com>
Signed-off-by: Antheas Kapenekakis <lkml@antheas.dev>
Link: https://lore.kernel.org/r/20250425111821.88746-5-lkml@antheas.dev
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Documentation/ABI/testing/sysfs-platform-oxp [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-platform-oxp b/Documentation/ABI/testing/sysfs-platform-oxp
new file mode 100644 (file)
index 0000000..091269a
--- /dev/null
@@ -0,0 +1,13 @@
+What:          /sys/devices/platform/<platform>/tt_toggle
+Date:          Jun 2023
+KernelVersion: 6.5
+Contact:       "Antheas Kapenekakis" <lkml@antheas.dev>
+Description:
+               Takeover TDP controls from the device. OneXPlayer devices have a
+               turbo button that can be used to switch between two TDP modes
+               (usually 15W and 25W). By setting this attribute to 1, this
+               functionality is disabled, handing TDP control over to (Windows)
+               userspace software and the Turbo button turns into a keyboard
+               shortcut over the AT keyboard of the device. In addition,
+               using this setting is a prerequisite for PWM control for most
+               newer models (otherwise it NOOPs).