From: Kurt Borja <kuurtb@gmail.com>
To: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
"Armin Wolf" <W_Armin@gmx.de>
Cc: Kurt Borja <kuurtb@gmail.com>,
Hans de Goede <hdegoede@redhat.com>,
platform-driver-x86@vger.kernel.org,
Dell.Client.Kernel@dell.com, linux-kernel@vger.kernel.org
Subject: [PATCH v4 12/12] Documentation: ABI: Add sysfs platform and debugfs ABI documentation for alienware-wmi
Date: Sat, 08 Mar 2025 15:23:24 -0500 [thread overview]
Message-ID: <20250308-hwm-v4-12-afa1342828f5@gmail.com> (raw)
In-Reply-To: <20250308-hwm-v4-0-afa1342828f5@gmail.com>
Add ABI description for the alienware-wmi driver.
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*
--
2.48.1
next prev parent reply other threads:[~2025-03-08 20:24 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-08 20:23 [PATCH v4 00/12] platform/x86: alienware-wmi-wmax: HWMON support + DebugFS + Improvements Kurt Borja
2025-03-08 20:23 ` [PATCH v4 01/12] platform/x86: alienware-wmi-wmax: Rename thermal related symbols Kurt Borja
2025-03-08 20:23 ` [PATCH v4 02/12] platform/x86: alienware-wmi-wmax: Refactor is_awcc_thermal_mode() Kurt Borja
2025-03-08 20:23 ` [PATCH v4 03/12] platform/x86: alienware-wmi-wmax: Improve internal AWCC API Kurt Borja
2025-03-08 20:23 ` [PATCH v4 04/12] platform/x86: alienware-wmi-wmax: Modify supported_thermal_profiles[] Kurt Borja
2025-03-08 20:23 ` [PATCH v4 05/12] platform/x86: alienware-wmi-wmax: Improve platform profile probe Kurt Borja
2025-03-08 20:23 ` [PATCH v4 06/12] platform/x86: alienware-wmi-wmax: Add support for the "custom" thermal profile Kurt Borja
2025-03-08 20:23 ` [PATCH v4 07/12] platform/x86: alienware-wmi-wmax: Add HWMON support Kurt Borja
2025-03-11 18:55 ` Armin Wolf
2025-03-12 5:06 ` Kurt Borja
2025-03-08 20:23 ` [PATCH v4 08/12] platform/x86: alienware-wmi-wmax: Add support for manual fan control Kurt Borja
2025-03-11 18:59 ` Armin Wolf
2025-03-08 20:23 ` [PATCH v4 09/12] platform/x86: alienware-wmi-wmax: Add a DebugFS interface Kurt Borja
2025-03-08 20:23 ` [PATCH v4 10/12] Documentation: wmi: Improve and update alienware-wmi documentation Kurt Borja
2025-03-08 20:23 ` [PATCH v4 11/12] Documentation: admin-guide: laptops: Add documentation for alienware-wmi Kurt Borja
2025-03-11 19:27 ` Armin Wolf
2025-03-08 20:23 ` Kurt Borja [this message]
2025-03-11 19:29 ` [PATCH v4 12/12] Documentation: ABI: Add sysfs platform and debugfs ABI " Armin Wolf
2025-03-08 21:23 ` [PATCH v4 00/12] platform/x86: alienware-wmi-wmax: HWMON support + DebugFS + Improvements Guenter Roeck
2025-03-09 16:05 ` Kurt Borja
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250308-hwm-v4-12-afa1342828f5@gmail.com \
--to=kuurtb@gmail.com \
--cc=Dell.Client.Kernel@dell.com \
--cc=W_Armin@gmx.de \
--cc=hdegoede@redhat.com \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=platform-driver-x86@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox