1 .. SPDX-License-Identifier: GPL-2.0-or-later 1 .. SPDX-License-Identifier: GPL-2.0-or-later
2 2
3 Kernel driver aquacomputer-d5next 3 Kernel driver aquacomputer-d5next
4 ================================= 4 =================================
5 5
6 Supported devices: 6 Supported devices:
7 7
8 * Aquacomputer Aquaero 5/6 fan controllers 8 * Aquacomputer Aquaero 5/6 fan controllers
9 * Aquacomputer D5 Next watercooling pump 9 * Aquacomputer D5 Next watercooling pump
10 * Aquacomputer Farbwerk RGB controller 10 * Aquacomputer Farbwerk RGB controller
11 * Aquacomputer Farbwerk 360 RGB controller 11 * Aquacomputer Farbwerk 360 RGB controller
12 * Aquacomputer Octo fan controller 12 * Aquacomputer Octo fan controller
13 * Aquacomputer Quadro fan controller 13 * Aquacomputer Quadro fan controller
14 * Aquacomputer High Flow Next sensor 14 * Aquacomputer High Flow Next sensor
15 * Aquacomputer Leakshield leak prevention syst 15 * Aquacomputer Leakshield leak prevention system
16 * Aquacomputer Aquastream XT watercooling pump 16 * Aquacomputer Aquastream XT watercooling pump
17 * Aquacomputer Aquastream Ultimate watercoolin 17 * Aquacomputer Aquastream Ultimate watercooling pump
18 * Aquacomputer Poweradjust 3 fan controller 18 * Aquacomputer Poweradjust 3 fan controller
19 * Aquacomputer High Flow USB flow meter 19 * Aquacomputer High Flow USB flow meter
20 * Aquacomputer MPS Flow devices 20 * Aquacomputer MPS Flow devices
21 21
22 Author: Aleksa Savic 22 Author: Aleksa Savic
23 23
24 Description 24 Description
25 ----------- 25 -----------
26 26
27 This driver exposes hardware sensors of listed 27 This driver exposes hardware sensors of listed Aquacomputer devices, which
28 communicate through proprietary USB HID protoc 28 communicate through proprietary USB HID protocols.
29 29
30 The Aquaero devices expose eight physical, eig 30 The Aquaero devices expose eight physical, eight virtual and four calculated
31 virtual temperature sensors, as well as two fl 31 virtual temperature sensors, as well as two flow sensors. The fans expose their
32 speed (in RPM), power, voltage and current. Te 32 speed (in RPM), power, voltage and current. Temperature offsets and fan speeds
33 can be controlled. 33 can be controlled.
34 34
35 For the D5 Next pump, available sensors are pu 35 For the D5 Next pump, available sensors are pump and fan speed, power, voltage
36 and current, as well as coolant temperature an 36 and current, as well as coolant temperature and eight virtual temp sensors. Also
37 available through debugfs are the serial numbe 37 available through debugfs are the serial number, firmware version and power-on
38 count. Attaching a fan to it is optional and a 38 count. Attaching a fan to it is optional and allows it to be controlled using
39 temperature curves directly from the pump. If 39 temperature curves directly from the pump. If it's not connected, the fan-related
40 sensors will report zeroes. 40 sensors will report zeroes.
41 41
42 The pump can be configured either through soft 42 The pump can be configured either through software or via its physical
43 interface. Configuring the pump through this d 43 interface. Configuring the pump through this driver is not implemented, as it
44 seems to require sending it a complete configu 44 seems to require sending it a complete configuration. That includes addressable
45 RGB LEDs, for which there is no standard sysfs 45 RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
46 better suited for userspace tools. 46 better suited for userspace tools.
47 47
48 The Octo exposes four physical and sixteen vir 48 The Octo exposes four physical and sixteen virtual temperature sensors, a flow sensor
49 as well as eight PWM controllable fans, along 49 as well as eight PWM controllable fans, along with their speed (in RPM), power, voltage
50 and current. Flow sensor pulses are also avail 50 and current. Flow sensor pulses are also available.
51 51
52 The Quadro exposes four physical and sixteen v 52 The Quadro exposes four physical and sixteen virtual temperature sensors, a flow
53 sensor and four PWM controllable fans, along w 53 sensor and four PWM controllable fans, along with their speed (in RPM), power,
54 voltage and current. Flow sensor pulses are al 54 voltage and current. Flow sensor pulses are also available.
55 55
56 The Farbwerk and Farbwerk 360 expose four temp 56 The Farbwerk and Farbwerk 360 expose four temperature sensors. Additionally,
57 sixteen virtual temperature sensors of the Far 57 sixteen virtual temperature sensors of the Farbwerk 360 are exposed.
58 58
59 The High Flow Next exposes +5V voltages, water 59 The High Flow Next exposes +5V voltages, water quality, conductivity and flow readings.
60 A temperature sensor can be connected to it, i 60 A temperature sensor can be connected to it, in which case it provides its reading
61 and an estimation of the dissipated/absorbed p 61 and an estimation of the dissipated/absorbed power in the liquid cooling loop.
62 62
63 The Leakshield exposes two temperature sensors 63 The Leakshield exposes two temperature sensors and coolant pressure (current, min, max and
64 target readings). It also exposes the estimate 64 target readings). It also exposes the estimated reservoir volume and how much of it is
65 filled with coolant. Pump RPM and flow can be 65 filled with coolant. Pump RPM and flow can be set to enhance on-device calculations,
66 but this is not yet implemented here. 66 but this is not yet implemented here.
67 67
68 The Aquastream XT pump exposes temperature rea 68 The Aquastream XT pump exposes temperature readings for the coolant, external sensor
69 and fan IC. It also exposes pump and fan speed 69 and fan IC. It also exposes pump and fan speeds (in RPM), voltages, as well as pump
70 current. 70 current.
71 71
72 The Aquastream Ultimate pump exposes coolant t 72 The Aquastream Ultimate pump exposes coolant temp and an external temp sensor, along
73 with speed, power, voltage and current of both 73 with speed, power, voltage and current of both the pump and optionally connected fan.
74 It also exposes pressure and flow speed readin 74 It also exposes pressure and flow speed readings.
75 75
76 The Poweradjust 3 controller exposes a single 76 The Poweradjust 3 controller exposes a single external temperature sensor.
77 77
78 The High Flow USB exposes an internal and exte 78 The High Flow USB exposes an internal and external temperature sensor, and a flow meter.
79 79
80 The MPS Flow devices expose the same entries a 80 The MPS Flow devices expose the same entries as the High Flow USB because they have
81 the same USB product ID and report sensors equ 81 the same USB product ID and report sensors equivalently.
82 82
83 Depending on the device, not all sysfs and deb 83 Depending on the device, not all sysfs and debugfs entries will be available.
84 Writing to virtual temperature sensors is not 84 Writing to virtual temperature sensors is not currently supported.
85 85
86 Usage notes 86 Usage notes
87 ----------- 87 -----------
88 88
89 The devices communicate via HID reports. The d 89 The devices communicate via HID reports. The driver is loaded automatically by
90 the kernel and supports hotswapping. 90 the kernel and supports hotswapping.
91 91
92 Sysfs entries 92 Sysfs entries
93 ------------- 93 -------------
94 94
95 ================ ============================= 95 ================ ==============================================================
96 temp[1-20]_input Physical/virtual temperature 96 temp[1-20]_input Physical/virtual temperature sensors (in millidegrees Celsius)
97 temp[1-8]_offset Temperature sensor correction 97 temp[1-8]_offset Temperature sensor correction offset (in millidegrees Celsius)
98 fan[1-9]_input Pump/fan speed (in RPM) / Flo 98 fan[1-9]_input Pump/fan speed (in RPM) / Flow speed (in dL/h)
99 fan1_min Minimal fan speed (in RPM) 99 fan1_min Minimal fan speed (in RPM)
100 fan1_max Maximal fan speed (in RPM) 100 fan1_max Maximal fan speed (in RPM)
101 fan1_target Target fan speed (in RPM) 101 fan1_target Target fan speed (in RPM)
102 fan5_pulses Quadro flow sensor pulses 102 fan5_pulses Quadro flow sensor pulses
103 fan9_pulses Octo flow sensor pulses 103 fan9_pulses Octo flow sensor pulses
104 power[1-8]_input Pump/fan power (in micro Watt 104 power[1-8]_input Pump/fan power (in micro Watts)
105 in[0-7]_input Pump/fan voltage (in milli Vo 105 in[0-7]_input Pump/fan voltage (in milli Volts)
106 curr[1-8]_input Pump/fan current (in milli Am 106 curr[1-8]_input Pump/fan current (in milli Amperes)
107 pwm[1-8] Fan PWM (0 - 255) 107 pwm[1-8] Fan PWM (0 - 255)
108 ================ ============================= 108 ================ ==============================================================
109 109
110 Debugfs entries 110 Debugfs entries
111 --------------- 111 ---------------
112 112
113 ================ ============================= 113 ================ =================================================
114 serial_number Serial number of the device 114 serial_number Serial number of the device
115 firmware_version Version of installed firmware 115 firmware_version Version of installed firmware
116 power_cycles Count of how many times the d 116 power_cycles Count of how many times the device was powered on
117 ================ ============================= 117 ================ =================================================
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.