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* Aquacomputer Farbwerk RGB controller
10* Aquacomputer Farbwerk 360 RGB controller
11* Aquacomputer Octo fan controller
12* Aquacomputer Quadro fan controller
13* Aquacomputer High Flow Next sensor
14
15Author: Aleksa Savic
16
17Description
18-----------
19
20This driver exposes hardware sensors of listed Aquacomputer devices, which
21communicate through proprietary USB HID protocols.
22
23For the D5 Next pump, available sensors are pump and fan speed, power, voltage
24and current, as well as coolant temperature and eight virtual temp sensors. Also
25available through debugfs are the serial number, firmware version and power-on
26count. Attaching a fan to it is optional and allows it to be controlled using
27temperature curves directly from the pump. If it's not connected, the fan-related
28sensors will report zeroes.
29
30The pump can be configured either through software or via its physical
31interface. Configuring the pump through this driver is not implemented, as it
32seems to require sending it a complete configuration. That includes addressable
33RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
34better suited for userspace tools.
35
36The Octo exposes four physical and sixteen virtual temperature sensors, as well as
37eight PWM controllable fans, along with their speed (in RPM), power, voltage and
38current.
39
40The Quadro exposes four physical and sixteen virtual temperature sensors, a flow
41sensor and four PWM controllable fans, along with their speed (in RPM), power,
42voltage and current. Flow sensor pulses are also available.
43
44The Farbwerk and Farbwerk 360 expose four temperature sensors. Additionally,
45sixteen virtual temperature sensors of the Farbwerk 360 are exposed.
46
47The High Flow Next exposes +5V voltages, water quality, conductivity and flow readings.
48A temperature sensor can be connected to it, in which case it provides its reading
49and an estimation of the dissipated/absorbed power in the liquid cooling loop.
50
51Depending on the device, not all sysfs and debugfs entries will be available.
52Writing to virtual temperature sensors is not currently supported.
53
54Usage notes
55-----------
56
57The devices communicate via HID reports. The driver is loaded automatically by
58the kernel and supports hotswapping.
59
60Sysfs entries
61-------------
62
63================ ==============================================================
64temp[1-20]_input Physical/virtual temperature sensors (in millidegrees Celsius)
65temp[1-4]_offset Temperature sensor correction offset (in millidegrees Celsius)
66fan[1-8]_input   Pump/fan speed (in RPM) / Flow speed (in dL/h)
67fan5_pulses      Quadro flow sensor pulses
68power[1-8]_input Pump/fan power (in micro Watts)
69in[0-7]_input    Pump/fan voltage (in milli Volts)
70curr[1-8]_input  Pump/fan current (in milli Amperes)
71pwm[1-8]         Fan PWM (0 - 255)
72================ ==============================================================
73
74Debugfs entries
75---------------
76
77================ =================================================
78serial_number    Serial number of the device
79firmware_version Version of installed firmware
80power_cycles     Count of how many times the device was powered on
81================ =================================================
82