Documentation: ABI: Add sysfs platform and debugfs ABI documentation for alienware-wmi

Add ABI description for the alienware-wmi driver.

Reviewed-by: Armin Wolf <W_Armin@gmx.de>
Signed-off-by: Kurt Borja <kuurtb@gmail.com>
Link: https://lore.kernel.org/r/20250329-hwm-v7-12-a14ea39d8a94@gmail.com
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

diff --git a/Documentation/ABI/testing/debugfs-alienware-wmi b/Documentation/ABI/testing/debugfs-alienware-wmi
new file mode 100644 (file)
index 0000000..48cfd4d
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-alienware-wmi
@@ -0,0 +1,44 @@
+What:          /sys/kernel/debug/alienware-wmi-<wmi_device_name>/system_description
+Date:          March 2025
+KernelVersion: 6.15
+Contact:       Kurt Borja <kuurtb@gmail.com>
+Description:
+               This file exposes the raw ``system_description`` number reported
+               by the WMAX device.
+
+               Only present on devices with the AWCC interface.
+
+               See Documentation/admin-guide/laptops/alienware-wmi.rst for
+               details.
+
+               RO
+
+What:          /sys/kernel/debug/alienware-wmi-<wmi_device_name>/hwmon_data
+Date:          March 2025
+KernelVersion: 6.15
+Contact:       Kurt Borja <kuurtb@gmail.com>
+Description:
+               This file exposes HWMON private data.
+
+               Includes fan sensor count, temperature sensor count, internal
+               fan IDs and internal temp IDs.
+
+               See Documentation/admin-guide/laptops/alienware-wmi.rst for
+               details.
+
+               RO
+
+What:          /sys/kernel/debug/alienware-wmi-<wmi_device_name>/pprof_data
+Date:          March 2025
+KernelVersion: 6.15
+Contact:       Kurt Borja <kuurtb@gmail.com>
+Description:
+               This file exposes Platform Profile private data.
+
+               Includes internal mapping to platform profiles and thermal
+               profile IDs.
+
+               See Documentation/admin-guide/laptops/alienware-wmi.rst for
+               details.
+
+               RO

diff --git a/Documentation/ABI/testing/sysfs-platform-alienware-wmi b/Documentation/ABI/testing/sysfs-platform-alienware-wmi
new file mode 100644 (file)
index 0000000..4877b37
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-alienware-wmi
@@ -0,0 +1,14 @@
+What:          /sys/class/hwmon/hwmonX/fanY_boost
+Date:          March 2025
+KernelVersion: 6.15
+Contact:       Kurt Borja <kuurtb@gmail.com>
+Description:
+               This file exposes fan boost control for Dell gaming laptops with
+               the AWCC WMI interface.
+
+               See Documentation/admin-guide/laptops/alienware-wmi.rst for
+               details.
+
+               Integer value in the range 0 to 255
+
+               RW

diff --git a/MAINTAINERS b/MAINTAINERS
index e71e8109244bca02da862512f7da7745b1d84077..08b7a6b36b7b44cb9103788029e0ca05dbba1812 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -797,6 +797,8 @@ M:  Kurt Borja <kuurtb@gmail.com>
 L:     platform-driver-x86@vger.kernel.org
 L:     Dell.Client.Kernel@dell.com
 S:     Maintained
+F:     Documentation/ABI/testing/debugfs-alienware-wmi
+F:     Documentation/ABI/testing/sysfs-platform-alienware-wmi
 F:     Documentation/admin-guide/laptops/alienware-wmi.rst
 F:     Documentation/wmi/devices/alienware-wmi.rst
 F:     drivers/platform/x86/dell/alienware-wmi*