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
13Author: Aleksa Savic
14
15Description
16-----------
17
18This driver exposes hardware sensors of listed Aquacomputer devices, which
19communicate through proprietary USB HID protocols.
20
21For the D5 Next pump, available sensors are pump and fan speed, power, voltage
22and current, as well as coolant temperature. Also available through debugfs are
23the serial number, firmware version and power-on count. Attaching a fan to it is
24optional and allows it to be controlled using temperature curves directly from the
25pump. If it's not connected, the fan-related sensors will report zeroes.
26
27The pump can be configured either through software or via its physical
28interface. Configuring the pump through this driver is not implemented, as it
29seems to require sending it a complete configuration. That includes addressable
30RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
31better suited for userspace tools.
32
33The Octo exposes four temperature sensors and eight PWM controllable fans, along
34with their speed (in RPM), power, voltage and current.
35
36The Farbwerk and Farbwerk 360 expose four temperature sensors. Depending on the device,
37not all sysfs and debugfs entries will be available.
38
39Usage notes
40-----------
41
42The devices communicate via HID reports. The driver is loaded automatically by
43the kernel and supports hotswapping.
44
45Sysfs entries
46-------------
47
48================ =============================================
49temp[1-4]_input  Temperature sensors (in millidegrees Celsius)
50fan[1-2]_input   Pump/fan speed (in RPM)
51power[1-2]_input Pump/fan power (in micro Watts)
52in[0-2]_input    Pump/fan voltage (in milli Volts)
53curr[1-2]_input  Pump/fan current (in milli Amperes)
54================ =============================================
55
56Debugfs entries
57---------------
58
59================ =================================================
60serial_number    Serial number of the device
61firmware_version Version of installed firmware
62power_cycles     Count of how many times the device was powered on
63================ =================================================
64