[PATCH v12 15/17] HID: asus: document ROG XG Mobile sysfs attributes

From: Denis Benato

Date: Sat Oct 31 2026 - 13:47:15 EST


The driver publishes the station's model, serial, mainboard identifier,
part number, firmware version and hardware generation as read-only
sysfs files. Document each file: when it is created, what a read
returns, and when that read is an empty line.

Signed-off-by: Denis Benato <denis.benato@xxxxxxxxx>
---
.../ABI/testing/sysfs-driver-hid-asus | 95 +++++++++++++++++++
1 file changed, 95 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-driver-hid-asus

diff --git a/Documentation/ABI/testing/sysfs-driver-hid-asus b/Documentation/ABI/testing/sysfs-driver-hid-asus
new file mode 100644
index 000000000000..30e0d17d4cec
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-hid-asus
@@ -0,0 +1,95 @@
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_model
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Model of the connected ASUS ROG XG Mobile station, as
+ reported by the station. An example is "GC33Y".
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The value is one line and is never empty while the file
+ exists.
+
+ Access: Read only
+ Valid values: a single line of text
+
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_serial
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Serial number of the connected ASUS ROG XG Mobile station,
+ as reported by the station.
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The read is an empty line when the station did not report a
+ serial number.
+
+ Access: Read only
+ Valid values: a single line of text
+
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_mainboard
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Mainboard identifier of the connected ASUS ROG XG Mobile
+ station, as reported by the station.
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The read is an empty line when the station did not report a
+ mainboard identifier.
+
+ Access: Read only
+ Valid values: a single line of text
+
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_part_number
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Part number of the connected ASUS ROG XG Mobile station, as
+ reported by the station.
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The read is an empty line when the station did not report a
+ part number.
+
+ Access: Read only
+ Valid values: a single line of text
+
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_firmware_version
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Firmware version of the connected ASUS ROG XG Mobile
+ station, as reported by the station.
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The read is an empty line when the version query failed or
+ the station did not report a firmware version.
+
+ Access: Read only
+ Valid values: a single line of text
+
+What: /sys/bus/hid/drivers/asus/<dev>/xgm_generation
+Date: October 2026
+Contact: linux-input@xxxxxxxxxxxxxxx
+Description:
+ Hardware generation of the connected ASUS ROG XG Mobile
+ station, as reported by the station.
+
+ The file is created only for a supported station, one whose
+ model name starts with GC31, GC32 or GC33, and only while that
+ station is bound.
+ The read is an empty line when the version query failed or
+ the station did not report a generation.
+
+ Access: Read only
+ Valid values: a single line of text
--
2.47.3