platform/x86: dell-ddv: Update ABI documentation
authorArmin Wolf <W_Armin@gmx.de>
Mon, 8 May 2023 20:42:41 +0000 (22:42 +0200)
committerHans de Goede <hdegoede@redhat.com>
Tue, 9 May 2023 09:54:42 +0000 (11:54 +0200)
Synchronize the ABI documentation with the driver documentation
and direct users to the latter in case the search for more
detailed information.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
Link: https://lore.kernel.org/r/20230508204241.11076-2-W_Armin@gmx.de
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Documentation/ABI/testing/debugfs-dell-wmi-ddv
Documentation/ABI/testing/sysfs-platform-dell-wmi-ddv

index fbcc5d6f7388541637364b933d6fd1686e639d08..81cfc788be15e94ab403164217c79164d04ffa7c 100644 (file)
@@ -3,19 +3,32 @@ Date:         September 2022
 KernelVersion: 6.1
 Contact:       Armin Wolf <W_Armin@gmx.de>
 Description:
-               This file contains the contents of the fan sensor information buffer,
-               which contains fan sensor entries and a terminating character (0xFF).
+               This file contains the contents of the fan sensor information
+               buffer, which contains fan sensor entries and a terminating
+               character (0xFF).
 
-               Each fan sensor entry consists of three bytes with an unknown meaning,
-               interested people may use this file for reverse-engineering.
+               Each fan sensor entry contains:
+
+               - fan type (single byte)
+               - fan speed in RPM (two bytes, little endian)
+
+               See Documentation/wmi/devices/dell-wmi-ddv.rst for details.
 
 What:          /sys/kernel/debug/dell-wmi-ddv-<wmi_device_name>/thermal_sensor_information
 Date:          September 2022
 KernelVersion: 6.1
 Contact:       Armin Wolf <W_Armin@gmx.de>
 Description:
-               This file contains the contents of the thermal sensor information buffer,
-               which contains thermal sensor entries and a terminating character (0xFF).
+               This file contains the contents of the thermal sensor information
+               buffer, which contains thermal sensor entries and a terminating
+               character (0xFF).
+
+               Each thermal sensor entry contains:
+
+               - thermal type (single byte)
+               - current temperature (single byte)
+               - min. temperature (single byte)
+               - max. temperature (single byte)
+               - unknown field (single byte)
 
-               Each thermal sensor entry consists of five bytes with an unknown meaning,
-               interested people may use this file for reverse-engineering.
+               See Documentation/wmi/devices/dell-wmi-ddv.rst for details.
index 1d97ad615c66c6a5f4a201f70d9a158e27574608..a9d39d9e8865c745455518e6be9157bc1838ac7e 100644 (file)
@@ -3,5 +3,7 @@ Date:           September 2022
 KernelVersion: 6.1
 Contact:       Armin Wolf <W_Armin@gmx.de>
 Description:
-               Reports the Dell ePPID (electronic Dell Piece Part Identification)
+               Reports the Dell ePPID (electronic Piece Part Identification)
                of the ACPI battery.
+
+               See Documentation/wmi/devices/dell-wmi-ddv.rst for details.