Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Armin Wolf <W_Armin@gmx.de>
To:     hdegoede@redhat.com, markgross@kernel.org
Cc:     corbet@lwn.net, bagasdotme@gmail.com,
        platform-driver-x86@vger.kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: [PATCH v2 2/2] platform/x86: dell-ddv: Update ABI documentation
Date:   Mon,  8 May 2023 22:42:41 +0200
Message-Id: <20230508204241.11076-2-W_Armin@gmx.de>
In-Reply-To: <20230508204241.11076-1-W_Armin@gmx.de>
References: <20230508204241.11076-1-W_Armin@gmx.de>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:s2XUhjDFoDA=;bGQjvKXQUKwYWW3MACdY8UPsDss
 qS7U8hAwayQQ4oXqshkRIgtufUbN0ZrqVA4+rrVk4kgeBQzIZl9cb5ulNqln1MKjK1UVk8f8S
 WWRhcHQH5AZKEnymXtLJKI73y3U7WUlv9Vg3Q6x8VN0ZYZjmTwrDZCtAXBuWEAWKj6LmEYONa
 nNkqpDP3p/EfL8tAE2kVLevlNui9WH1qHNPYWP5DwQ8ZZOD5RLarP9PMhSVjE7wifsyWVHVk3
 qta8AD3tm/7MI1M8yvpBktmS+49PyxBFav8kxIw116GELYocngazcAWPdeGo38gDM37gfOW+8
 tek62zI40ikUN7jf/qMeDDcuTSJ0mgfzg2hiNG3LvdsEpFEJOQQn6YG6SA/zf5Jk0DZRBzFiv
 /d8XfOBxgurikd5m02ZuY4BCAdlcDzZcu9mY8LHKZbvLtTEgM6r/dgiugldA3INoy2TntRwCM
 OprG9rYr7MKKDlxZtXD1+8WdUWvoIP4GytsY6/Z7WI59jEeOlkKoZKM/BnSQDNizjf4NPCiFB
 fp5/Hv3b1E4bax9V+9fP6oUDNmU4cYAl31awNSPDViEajrf/NtJ00fd0mwtTMcMY4FQGbYzRR
 zq4om2Ta1LAJGrDu1w4j7LePGYiSb2rCv2yh7yKdaBa5eFi1M+28EzTV9v6rDYQVwTI+CNuf6
 dDTWQh8oPvowUEdf4QPdv8KIdQuHdCy6+zmLlut/x7QUUScF0gqxueT8m0WmZeSVL1aKp4/V1
 J/s3UjnXYJmSwGZdbNRhD9d21IVSdOV27day1NyjQvbgPKjKcEvWsVkWEg1JpI8t7xUfeYEga
 WAsdopgIrMqA0vIhpGCEMhrqiwgPgJDgUnR2orumHnL14NR/xxddpZjn32EBxs/atUUARLf1k
 RXNPrWW8Q6P8VQ42dZ2lVqjhi4HGu0ecCv9adM8XGY481/35otgAbFCu0h94DnqIU70oF9r5s
 2xnum7wwQ+yUX4qJy4b7OdYuAfw=
Precedence: bulk

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>
=2D--
Changes in v2:
- None
=2D--
 .../ABI/testing/debugfs-dell-wmi-ddv          | 29 ++++++++++++++-----
 .../ABI/testing/sysfs-platform-dell-wmi-ddv   |  4 ++-
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/Documentation/ABI/testing/debugfs-dell-wmi-ddv b/Documentatio=
n/ABI/testing/debugfs-dell-wmi-ddv
index fbcc5d6f7388..81cfc788be15 100644
=2D-- a/Documentation/ABI/testing/debugfs-dell-wmi-ddv
+++ b/Documentation/ABI/testing/debugfs-dell-wmi-ddv
@@ -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_in=
formation
 Date:		September 2022
 KernelVersion:	6.1
 Contact:	Armin Wolf <W_Armin@gmx.de>
 Description:
-		This file contains the contents of the thermal sensor information buffe=
r,
-		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 meanin=
g,
-		interested people may use this file for reverse-engineering.
+		See Documentation/wmi/devices/dell-wmi-ddv.rst for details.
diff --git a/Documentation/ABI/testing/sysfs-platform-dell-wmi-ddv b/Docum=
entation/ABI/testing/sysfs-platform-dell-wmi-ddv
index 1d97ad615c66..a9d39d9e8865 100644
=2D-- a/Documentation/ABI/testing/sysfs-platform-dell-wmi-ddv
+++ b/Documentation/ABI/testing/sysfs-platform-dell-wmi-ddv
@@ -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.
=2D-
2.30.2