summaryrefslogtreecommitdiff
path: root/Documentation/hwmon/gigabyte_waterforce.rst
blob: d47f3e8516ee74ce39f25719da69d66feb58dcf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.. SPDX-License-Identifier: GPL-2.0-or-later

Kernel driver gigabyte_waterforce
=================================

Supported devices:

* Gigabyte AORUS WATERFORCE X240
* Gigabyte AORUS WATERFORCE X280
* Gigabyte AORUS WATERFORCE X360

Author: Aleksa Savic

Description
-----------

This driver enables hardware monitoring support for the listed Gigabyte Waterforce
all-in-one CPU liquid coolers. Available sensors are pump and fan speed in RPM, as
well as coolant temperature. Also available through debugfs is the firmware version.

Attaching a fan is optional and allows it to be controlled from the device. If
it's not connected, the fan-related sensors will report zeroes.

The addressable RGB LEDs and LCD screen are not supported in this driver and should
be controlled through userspace tools.

Usage notes
-----------

As these are USB HIDs, the driver can be loaded automatically by the kernel and
supports hot swapping.

Sysfs entries
-------------

=========== =============================================
fan1_input  Fan speed (in rpm)
fan2_input  Pump speed (in rpm)
temp1_input Coolant temperature (in millidegrees Celsius)
=========== =============================================

Debugfs entries
---------------

================ =======================
firmware_version Device firmware version
================ =======================