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