| Aleksa Savic | 0e35f63 | 2021-08-28 07:26:28 +0200 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0-or-later |
| 2 | |
| 3 | Kernel driver aquacomputer-d5next |
| 4 | ================================= |
| 5 | |
| 6 | Supported devices: |
| 7 | |
| 8 | * Aquacomputer D5 Next watercooling pump |
| 9 | |
| 10 | Author: Aleksa Savic |
| 11 | |
| 12 | Description |
| 13 | ----------- |
| 14 | |
| 15 | This driver exposes hardware sensors of the Aquacomputer D5 Next watercooling |
| 16 | pump, which communicates through a proprietary USB HID protocol. |
| 17 | |
| 18 | Available sensors are pump and fan speed, power, voltage and current, as |
| 19 | well as coolant temperature. Also available through debugfs are the serial |
| 20 | number, firmware version and power-on count. |
| 21 | |
| 22 | Attaching a fan is optional and allows it to be controlled using temperature |
| 23 | curves directly from the pump. If it's not connected, the fan-related sensors |
| 24 | will report zeroes. |
| 25 | |
| 26 | The pump can be configured either through software or via its physical |
| 27 | interface. Configuring the pump through this driver is not implemented, as it |
| 28 | seems to require sending it a complete configuration. That includes addressable |
| 29 | RGB LEDs, for which there is no standard sysfs interface. Thus, that task is |
| 30 | better suited for userspace tools. |
| 31 | |
| 32 | Usage notes |
| 33 | ----------- |
| 34 | |
| 35 | The pump communicates via HID reports. The driver is loaded automatically by |
| 36 | the kernel and supports hotswapping. |
| 37 | |
| 38 | Sysfs entries |
| 39 | ------------- |
| 40 | |
| 41 | ============ ============================================= |
| 42 | temp1_input Coolant temperature (in millidegrees Celsius) |
| 43 | fan1_input Pump speed (in RPM) |
| 44 | fan2_input Fan speed (in RPM) |
| 45 | power1_input Pump power (in micro Watts) |
| 46 | power2_input Fan power (in micro Watts) |
| 47 | in0_input Pump voltage (in milli Volts) |
| 48 | in1_input Fan voltage (in milli Volts) |
| 49 | in2_input +5V rail voltage (in milli Volts) |
| 50 | curr1_input Pump current (in milli Amperes) |
| 51 | curr2_input Fan current (in milli Amperes) |
| 52 | ============ ============================================= |
| 53 | |
| 54 | Debugfs entries |
| 55 | --------------- |
| 56 | |
| 57 | ================ =============================================== |
| 58 | serial_number Serial number of the pump |
| 59 | firmware_version Version of installed firmware |
| 60 | power_cycles Count of how many times the pump was powered on |
| 61 | ================ =============================================== |