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