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