From: Cryolitia PukNgae via B4 Relay <devnull+Cryolitia.gmail.com@kernel.org>
To: Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Cryolitia PukNgae <Cryolitia@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
linux-doc@vger.kernel.org,
"Celeste Liu" <CoelacanthusHex@gmail.com>,
"Yao Zi" <ziyao@disroot.org>,
"Derek John Clark" <derekjohn.clark@gmail.com>,
"Marcin Strągowski" <marcin@stragowski.com>,
someone5678 <someone5678.dev@gmail.com>,
"Justin Weiss" <justin@justinweiss.com>,
"Antheas Kapenekakis" <lkml@antheas.dev>,
command_block <mtf@ik.me>
Subject: [PATCH v6 2/2] hwmon: document: add gpd-fan
Date: Fri, 14 Mar 2025 04:10:31 +0800 [thread overview]
Message-ID: <20250314-gpd_fan-v6-2-1dc992050e42@gmail.com> (raw)
In-Reply-To: <20250314-gpd_fan-v6-0-1dc992050e42@gmail.com>
From: Cryolitia PukNgae <Cryolitia@gmail.com>
Add GPD fan driver document
Signed-off-by: Cryolitia PukNgae <Cryolitia@gmail.com>
---
Documentation/hwmon/gpd-fan.rst | 71 +++++++++++++++++++++++++++++++++++++++++
Documentation/hwmon/index.rst | 1 +
MAINTAINERS | 1 +
3 files changed, 73 insertions(+)
diff --git a/Documentation/hwmon/gpd-fan.rst b/Documentation/hwmon/gpd-fan.rst
new file mode 100644
index 0000000000000000000000000000000000000000..55059d1dfc5c6a1219c88c1c4c3c4c776fa79cdb
--- /dev/null
+++ b/Documentation/hwmon/gpd-fan.rst
@@ -0,0 +1,71 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver gpd-fan
+=========================
+
+Author:
+ - Cryolitia PukNgae <Cryolitia@gmail.com>
+
+Description
+------------
+
+Handheld devices from Shenzhen GPD Technology Co., Ltd. provide fan readings and fan control through
+their embedded controllers.
+
+Supported devices
+-----------------
+
+Currently the driver supports the following handhelds:
+
+ - GPD Win Mini (7840U)
+ - GPD Win Mini (8840U)
+ - GPD Win Mini (HX370)
+ - GPD Pocket 4
+ - GPD Duo
+ - GPD Win Max 2 (6800U)
+ - GPD Win Max 2 2023 (7840U)
+ - GPD Win Max 2 2024 (8840U)
+ - GPD Win Max 2 2025 (HX370)
+ - GPD Win 4 (6800U)
+ - GPD Win 4 (7840U)
+
+Module parameters
+-----------------
+
+gpd_fan_board
+ Force specific which module quirk should be used.
+ Use it like "gpd_fan_board=wm2".
+
+ - wm2
+ - GPD Win 4 (7840U)
+ - GPD Win Max 2 (6800U)
+ - GPD Win Max 2 2023 (7840U)
+ - GPD Win Max 2 2024 (8840U)
+ - GPD Win Max 2 2025 (HX370)
+ - win4
+ - GPD Win 4 (6800U)
+ - win_mini
+ - GPD Win Mini (7840U)
+ - GPD Win Mini (8840U)
+ - GPD Win Mini (HX370)
+ - GPD Pocket 4
+ - GPD Duo
+
+Sysfs entries
+-------------
+
+The following attributes are supported:
+
+fan1_input
+ Read Only. Reads current fan RPM.
+
+pwm1_enable
+ Read/Write. Enable manual fan control. Write "0" to disable control and run at
+ full speed. Write "1" to set to manual, write "2" to let the EC control decide
+ fan speed. Read this attribute to see current status.
+
+pwm1
+ Read/Write. Read this attribute to see current duty cycle in the range [0-255].
+ When pwm1_enable is set to "1" (manual) write any value in the range [0-255]
+ to set fan speed.
+
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 55f1111594b2e9ada4a881e5d4d8884f33256d1f..d5c7cd0cfdeb7059b6cd83050ae98aa7cb1334e6 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -80,6 +80,7 @@ Hardware Monitoring Kernel Drivers
gigabyte_waterforce
gsc-hwmon
gl518sm
+ gpd-fan
gxp-fan-ctrl
hih6130
hp-wmi-sensors
diff --git a/MAINTAINERS b/MAINTAINERS
index 777ba74ccb07ccc0840c3cd34e7b4d98d726f964..20faebeae981e4b7619fb10331c50525d98db944 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9766,6 +9766,7 @@ GPD FAN DRIVER
M: Cryolitia PukNgae <Cryolitia@gmail.com>
L: linux-hwmon@vger.kernel.org
S: Maintained
+F: Documentation/hwmon/gpd-fan.rst
F: drivers/hwmon/gpd-fan.c
GPD POCKET FAN DRIVER
--
2.48.1
prev parent reply other threads:[~2025-03-13 20:10 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-13 20:10 [PATCH v6 0/2] hwmon: add GPD devices sensor driver Cryolitia PukNgae via B4 Relay
2025-03-13 20:10 ` [PATCH v6 1/2] " Cryolitia PukNgae via B4 Relay
2025-03-13 20:58 ` Antheas Kapenekakis
2025-07-17 2:32 ` Guenter Roeck
2025-07-18 16:38 ` Antheas Kapenekakis
2025-07-30 9:24 ` Cryolitia
2025-07-30 17:26 ` Guenter Roeck
2025-07-31 3:30 ` Cryolitia PukNgae
2025-07-31 8:13 ` Antheas Kapenekakis
2025-07-31 12:53 ` Guenter Roeck
2025-08-12 3:18 ` Cryolitia PukNgae
2025-03-13 20:10 ` Cryolitia PukNgae via B4 Relay [this message]
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=20250314-gpd_fan-v6-2-1dc992050e42@gmail.com \
--to=devnull+cryolitia.gmail.com@kernel.org \
--cc=CoelacanthusHex@gmail.com \
--cc=Cryolitia@gmail.com \
--cc=corbet@lwn.net \
--cc=derekjohn.clark@gmail.com \
--cc=jdelvare@suse.com \
--cc=justin@justinweiss.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=lkml@antheas.dev \
--cc=marcin@stragowski.com \
--cc=mtf@ik.me \
--cc=someone5678.dev@gmail.com \
--cc=ziyao@disroot.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;
as well as URLs for NNTP newsgroup(s).