0001 .. SPDX-License-Identifier: GPL-2.0-or-later
0002
0003 Kernel driver aquacomputer-d5next
0004 =================================
0005
0006 Supported devices:
0007
0008 * Aquacomputer D5 Next watercooling pump
0009 * Aquacomputer Farbwerk RGB controller
0010 * Aquacomputer Farbwerk 360 RGB controller
0011 * Aquacomputer Octo fan controller
0012 * Aquacomputer Quadro fan controller
0013
0014 Author: Aleksa Savic
0015
0016 Description
0017 -----------
0018
0019 This driver exposes hardware sensors of listed Aquacomputer devices, which
0020 communicate through proprietary USB HID protocols.
0021
0022 For the D5 Next pump, available sensors are pump and fan speed, power, voltage
0023 and current, as well as coolant temperature. Also available through debugfs are
0024 the serial number, firmware version and power-on count. Attaching a fan to it is
0025 optional and allows it to be controlled using temperature curves directly from the
0026 pump. If it's not connected, the fan-related sensors will report zeroes.
0027
0028 The pump can be configured either through software or via its physical
0029 interface. Configuring the pump through this driver is not implemented, as it
0030 seems to require sending it a complete configuration. That includes addressable
0031 RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
0032 better suited for userspace tools.
0033
0034 The Octo exposes four temperature sensors and eight PWM controllable fans, along
0035 with their speed (in RPM), power, voltage and current.
0036
0037 The Quadro exposes four temperature sensors, a flow sensor and four PWM controllable
0038 fans, along with their speed (in RPM), power, voltage and current.
0039
0040 The Farbwerk and Farbwerk 360 expose four temperature sensors. Depending on the device,
0041 not all sysfs and debugfs entries will be available.
0042
0043 Usage notes
0044 -----------
0045
0046 The devices communicate via HID reports. The driver is loaded automatically by
0047 the kernel and supports hotswapping.
0048
0049 Sysfs entries
0050 -------------
0051
0052 ================ ==============================================
0053 temp[1-4]_input Temperature sensors (in millidegrees Celsius)
0054 fan[1-8]_input Pump/fan speed (in RPM) / Flow speed (in dL/h)
0055 power[1-8]_input Pump/fan power (in micro Watts)
0056 in[0-7]_input Pump/fan voltage (in milli Volts)
0057 curr[1-8]_input Pump/fan current (in milli Amperes)
0058 pwm[1-8] Fan PWM (0 - 255)
0059 ================ ==============================================
0060
0061 Debugfs entries
0062 ---------------
0063
0064 ================ =================================================
0065 serial_number Serial number of the device
0066 firmware_version Version of installed firmware
0067 power_cycles Count of how many times the device was powered on
0068 ================ =================================================
