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