diff mbox series

[v2,4/6] asus-wmi: Document previously added attributes

Message ID 20220808030420.8633-5-luke@ljones.dev (mailing list archive)
State Superseded, archived
Headers show
Series asus-wmi: Add support for RGB keyboards | expand

Commit Message

Luke Jones Aug. 8, 2022, 3:04 a.m. UTC
Documents some previously added attributes:
- dgpu_disable
- egpu_enable
- panel_od
- keyboard_rgb_mode
- keyboard_rgb_state

Signed-off-by: Luke D. Jones <luke@ljones.dev>
---
 .../ABI/testing/sysfs-platform-asus-wmi       | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)

Comments

Andy Shevchenko Aug. 8, 2022, 4:11 p.m. UTC | #1
On Mon, Aug 8, 2022 at 5:09 AM Luke D. Jones <luke@ljones.dev> wrote:
>
> Documents some previously added attributes:
> - dgpu_disable
> - egpu_enable
> - panel_od
> - keyboard_rgb_mode
> - keyboard_rgb_state

...

> +What:          /sys/devices/platform/<platform>/dgpu_disable
> +Date:          Aug 2022
> +KernelVersion: 5.17
> +Contact:       "Luke Jones" <luke@ljones.dev>
> +Description:
> +               Disable discrete GPU:
> +                       * 0 - Enable dGPU,
> +                       * 1 - Disable dGPU,
> +
> +What:          /sys/devices/platform/<platform>/egpu_enable
> +Date:          Aug 2022
> +KernelVersion: 5.17
> +Contact:       "Luke Jones" <luke@ljones.dev>
> +Description:
> +               Enable the external GPU paired with ROG X-Flow laptops.
> +               Toggling this setting will also trigger ACPI to disable the dGPU:
> +                       * 0 - Disable,
> +                       * 1 - Enable,
> +
> +What:          /sys/devices/platform/<platform>/panel_od
> +Date:          Aug 2022
> +KernelVersion: 5.17
> +Contact:       "Luke Jones" <luke@ljones.dev>
> +Description:
> +               Enable an LCD response-time boost to reduce or remove ghosting:
> +                       * 0 - Disable,
> +                       * 1 - Enable,

These should be in  separate patch(es) with the corresponding Fixes
tags. (The latter may not be so important, though. I leave it to Hans
to decide)

...

> +What:          /sys/devices/platform/<platform>/keyboard_rgb_mode
> +Date:          Aug 2022
> +KernelVersion: 6.0

These should go separately. Dunno if it should be a separate
documentation change for the both, or should it be split and
reattached to the respective patches from the series. Up to Hans.

> +Contact:       "Luke Jones" <luke@ljones.dev>
> +Description:
> +               Set some RGB keyboard modes and features (write-only).
> +
> +               The accepted input is "save mode speed", where "n n n" options
> +               are:
> +                       * save - 0 or 1, if 0 then settings are not retained on boot
> +                       * mode - 0 to 12, each is an RGB such as static, rainbow, pulse.
> +                                       Not all keyboards accept every mode.
> +                       * speed - 0, 1, 2, equal to low, medium, high.
> +                                       Only applies to certain modes.
> +
> +What:          /sys/devices/platform/<platform>/keyboard_rgb_state
> +Date:          Aug 2022
> +KernelVersion: 6.0
> +Contact:       "Luke Jones" <luke@ljones.dev>
> +Description:
> +               Set some RGB keyboard power states (write-only).
> +
> +               The accepted input is "boot awake sleep keyboard", where "n n n n n"
> +               options are:
> +                       * save - 0 or 1, if 0 then settings are not retained on boot
> +                       * boot - 0 or 1, controls if a boot animation is shown
> +                       * awake - 0 or 1, controls if the keyboard LED are on during awake
> +                       * sleep - 0 or 1, controls if a suspended animation is shown.
> +                                               This is only active if the AC is connected.
> +                       * keyboard - 0 or 1, unknown what effect this really has
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-platform-asus-wmi b/Documentation/ABI/testing/sysfs-platform-asus-wmi
index 04885738cf15..66b262476d92 100644
--- a/Documentation/ABI/testing/sysfs-platform-asus-wmi
+++ b/Documentation/ABI/testing/sysfs-platform-asus-wmi
@@ -57,3 +57,62 @@  Description:
 			* 0 - default,
 			* 1 - overboost,
 			* 2 - silent
+
+What:		/sys/devices/platform/<platform>/dgpu_disable
+Date:		Aug 2022
+KernelVersion:	5.17
+Contact:	"Luke Jones" <luke@ljones.dev>
+Description:
+		Disable discrete GPU:
+			* 0 - Enable dGPU,
+			* 1 - Disable dGPU,
+
+What:		/sys/devices/platform/<platform>/egpu_enable
+Date:		Aug 2022
+KernelVersion:	5.17
+Contact:	"Luke Jones" <luke@ljones.dev>
+Description:
+		Enable the external GPU paired with ROG X-Flow laptops.
+		Toggling this setting will also trigger ACPI to disable the dGPU:
+			* 0 - Disable,
+			* 1 - Enable,
+
+What:		/sys/devices/platform/<platform>/panel_od
+Date:		Aug 2022
+KernelVersion:	5.17
+Contact:	"Luke Jones" <luke@ljones.dev>
+Description:
+		Enable an LCD response-time boost to reduce or remove ghosting:
+			* 0 - Disable,
+			* 1 - Enable,
+
+What:		/sys/devices/platform/<platform>/keyboard_rgb_mode
+Date:		Aug 2022
+KernelVersion:	6.0
+Contact:	"Luke Jones" <luke@ljones.dev>
+Description:
+		Set some RGB keyboard modes and features (write-only).
+
+		The accepted input is "save mode speed", where "n n n" options
+		are:
+			* save - 0 or 1, if 0 then settings are not retained on boot
+			* mode - 0 to 12, each is an RGB such as static, rainbow, pulse.
+					Not all keyboards accept every mode.
+			* speed - 0, 1, 2, equal to low, medium, high.
+					Only applies to certain modes.
+
+What:		/sys/devices/platform/<platform>/keyboard_rgb_state
+Date:		Aug 2022
+KernelVersion:	6.0
+Contact:	"Luke Jones" <luke@ljones.dev>
+Description:
+		Set some RGB keyboard power states (write-only).
+
+		The accepted input is "boot awake sleep keyboard", where "n n n n n"
+		options	are:
+			* save - 0 or 1, if 0 then settings are not retained on boot
+			* boot - 0 or 1, controls if a boot animation is shown
+			* awake - 0 or 1, controls if the keyboard LED are on during awake
+			* sleep - 0 or 1, controls if a suspended animation is shown.
+						This is only active if the AC is connected.
+			* keyboard - 0 or 1, unknown what effect this really has