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