Re: [PATCH v4 12/12] Documentation: ABI: Add sysfs platform and debugfs ABI documentation for alienware-wmi

Armin Wolf
2025-03-11T19:29:11Z

Am 08.03.25 um 21:23 schrieb Kurt Borja:

> Add ABI description for the alienware-wmi driver.

Reviewed-by: Armin Wolf <W_Armin@gmx.de>

>
> Signed-off-by: Kurt Borja <kuurtb@gmail.com>
> ---
> Documentation/ABI/testing/debugfs-alienware-wmi | 44 ++++++++++++++++++++++
> .../ABI/testing/sysfs-platform-alienware-wmi | 14 +++++++
> MAINTAINERS | 2 +
> 3 files changed, 60 insertions(+)
>
> diff --git a/Documentation/ABI/testing/debugfs-alienware-wmi b/Documentation/ABI/testing/debugfs-alienware-wmi
> new file mode 100644
> index 0000000000000000000000000000000000000000..48cfd4d0b002efd7b68d9c1d3aa91a3a05f49db5
> --- /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
> index 0000000000000000000000000000000000000000..4877b3745f4e5b503376d375bf48464250328ce2
> --- /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 c609bc321b8dc3ab0e8d92b04e42483be8cc171c..faa377126bda0b9c848760495dc893982f3a4c3a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -796,6 +796,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*
>