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