GNU Linux-libre 6.9.1-gnu
[releases.git] / Documentation / hwmon / gigabyte_waterforce.rst
1 .. SPDX-License-Identifier: GPL-2.0-or-later
2
3 Kernel driver gigabyte_waterforce
4 =================================
5
6 Supported devices:
7
8 * Gigabyte AORUS WATERFORCE X240
9 * Gigabyte AORUS WATERFORCE X280
10 * Gigabyte AORUS WATERFORCE X360
11
12 Author: Aleksa Savic
13
14 Description
15 -----------
16
17 This driver enables hardware monitoring support for the listed Gigabyte Waterforce
18 all-in-one CPU liquid coolers. Available sensors are pump and fan speed in RPM, as
19 well as coolant temperature. Also available through debugfs is the firmware version.
20
21 Attaching a fan is optional and allows it to be controlled from the device. If
22 it's not connected, the fan-related sensors will report zeroes.
23
24 The addressable RGB LEDs and LCD screen are not supported in this driver and should
25 be controlled through userspace tools.
26
27 Usage notes
28 -----------
29
30 As these are USB HIDs, the driver can be loaded automatically by the kernel and
31 supports hot swapping.
32
33 Sysfs entries
34 -------------
35
36 =========== =============================================
37 fan1_input  Fan speed (in rpm)
38 fan2_input  Pump speed (in rpm)
39 temp1_input Coolant temperature (in millidegrees Celsius)
40 =========== =============================================
41
42 Debugfs entries
43 ---------------
44
45 ================ =======================
46 firmware_version Device firmware version
47 ================ =======================