1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver aquacomputer-d5next
4=================================
5
6Supported devices:
7
8* Aquacomputer D5 Next watercooling pump
9
10Author: Aleksa Savic
11
12Description
13-----------
14
15This driver exposes hardware sensors of the Aquacomputer D5 Next watercooling
16pump, which communicates through a proprietary USB HID protocol.
17
18Available sensors are pump and fan speed, power, voltage and current, as
19well as coolant temperature. Also available through debugfs are the serial
20number, firmware version and power-on count.
21
22Attaching a fan is optional and allows it to be controlled using temperature
23curves directly from the pump. If it's not connected, the fan-related sensors
24will report zeroes.
25
26The pump can be configured either through software or via its physical
27interface. Configuring the pump through this driver is not implemented, as it
28seems to require sending it a complete configuration. That includes addressable
29RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
30better suited for userspace tools.
31
32Usage notes
33-----------
34
35The pump communicates via HID reports. The driver is loaded automatically by
36the kernel and supports hotswapping.
37
38Sysfs entries
39-------------
40
41============ =============================================
42temp1_input  Coolant temperature (in millidegrees Celsius)
43fan1_input   Pump speed (in RPM)
44fan2_input   Fan speed (in RPM)
45power1_input Pump power (in micro Watts)
46power2_input Fan power (in micro Watts)
47in0_input    Pump voltage (in milli Volts)
48in1_input    Fan voltage (in milli Volts)
49in2_input    +5V rail voltage (in milli Volts)
50curr1_input  Pump current (in milli Amperes)
51curr2_input  Fan current (in milli Amperes)
52============ =============================================
53
54Debugfs entries
55---------------
56
57================ ===============================================
58serial_number    Serial number of the pump
59firmware_version Version of installed firmware
60power_cycles     Count of how many times the pump was powered on
61================ ===============================================
62