diff mbox series

[v5,04/13] ABI: testing: add tt_toggle and tt_led entries

Message ID 20250317155349.1236188-5-lkml@antheas.dev
State New
Headers show
Series hwmon: (oxpsensors) Add devices, features, fix ABI and move to platform/x86 | expand

Commit Message

Antheas Kapenekakis March 17, 2025, 3:53 p.m. UTC
When tt_toggle was introduced, it was not added to the platform sysfs.
Add it, then add documentation for tt_led.

Signed-off-by: Antheas Kapenekakis <lkml@antheas.dev>
---
 Documentation/ABI/testing/sysfs-platform-oxp | 26 ++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-oxp

Comments

Mario Limonciello March 17, 2025, 9:58 p.m. UTC | #1
On 3/17/2025 10:53, Antheas Kapenekakis wrote:
> When tt_toggle was introduced, it was not added to the platform sysfs.
> Add it, then add documentation for tt_led.
> 

Ideally I think this commit should split into two and there should be a 
fixes tag for the commit when tt_toggle was introduced.


> Signed-off-by: Antheas Kapenekakis <lkml@antheas.dev>
> ---
>   Documentation/ABI/testing/sysfs-platform-oxp | 26 ++++++++++++++++++++
>   1 file changed, 26 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-platform-oxp
> 
> diff --git a/Documentation/ABI/testing/sysfs-platform-oxp b/Documentation/ABI/testing/sysfs-platform-oxp
> new file mode 100644
> index 0000000000000..776b7dee3d595
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-platform-oxp
> @@ -0,0 +1,26 @@
> +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).
> +
> +What:		/sys/devices/platform/<platform>/tt_led
> +Date:		Feb 2025
> +KernelVersion:	6.15
> +Contact:	"Antheas Kapenekakis" <lkml@antheas.dev>
> +Description:
> +		Some OneXPlayer devices (e.g., X1 series) feature a little LED
> +		nested in the Turbo button. This LED is illuminated when the
> +		device is in the higher TDP mode (e.g., 25W). Once tt_toggle
> +		is engaged, this LED is left dangling to its last state. This
> +		attribute allows userspace to control the LED state manually
> +		(either with 1 or 0). Only a subset of devices contain this LED.
> +
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-platform-oxp b/Documentation/ABI/testing/sysfs-platform-oxp
new file mode 100644
index 0000000000000..776b7dee3d595
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-oxp
@@ -0,0 +1,26 @@ 
+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).
+
+What:		/sys/devices/platform/<platform>/tt_led
+Date:		Feb 2025
+KernelVersion:	6.15
+Contact:	"Antheas Kapenekakis" <lkml@antheas.dev>
+Description:
+		Some OneXPlayer devices (e.g., X1 series) feature a little LED
+		nested in the Turbo button. This LED is illuminated when the
+		device is in the higher TDP mode (e.g., 25W). Once tt_toggle
+		is engaged, this LED is left dangling to its last state. This
+		attribute allows userspace to control the LED state manually
+		(either with 1 or 0). Only a subset of devices contain this LED.
+