Merge tag 'm68knommu-for-v5.20' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-block.git] / Documentation / hwmon / aquacomputer_d5next.rst
CommitLineData
0e35f63f
AS
1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3Kernel driver aquacomputer-d5next
4=================================
5
6Supported 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
0e35f63f
AS
13
14Author: Aleksa Savic
15
16Description
17-----------
18
2fd3eec1
AS
19This driver exposes hardware sensors of listed Aquacomputer devices, which
20communicate through proprietary USB HID protocols.
0e35f63f 21
2fd3eec1
AS
22For the D5 Next pump, available sensors are pump and fan speed, power, voltage
23and current, as well as coolant temperature. Also available through debugfs are
24the serial number, firmware version and power-on count. Attaching a fan to it is
25optional and allows it to be controlled using temperature curves directly from the
26pump. If it's not connected, the fan-related sensors will report zeroes.
0e35f63f
AS
27
28The pump can be configured either through software or via its physical
29interface. Configuring the pump through this driver is not implemented, as it
30seems to require sending it a complete configuration. That includes addressable
31RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
32better suited for userspace tools.
33
752b9279
AS
34The Octo exposes four temperature sensors and eight PWM controllable fans, along
35with their speed (in RPM), power, voltage and current.
36
cdbe34da
AS
37The Quadro exposes four temperature sensors, a flow sensor and four PWM controllable
38fans, along with their speed (in RPM), power, voltage and current.
39
229b159c 40The Farbwerk and Farbwerk 360 expose four temperature sensors. Depending on the device,
2fd3eec1
AS
41not all sysfs and debugfs entries will be available.
42
0e35f63f
AS
43Usage notes
44-----------
45
2fd3eec1 46The devices communicate via HID reports. The driver is loaded automatically by
0e35f63f
AS
47the kernel and supports hotswapping.
48
49Sysfs entries
50-------------
51
cdbe34da 52================ ==============================================
2fd3eec1 53temp[1-4]_input Temperature sensors (in millidegrees Celsius)
cdbe34da
AS
54fan[1-8]_input Pump/fan speed (in RPM) / Flow speed (in dL/h)
55power[1-8]_input Pump/fan power (in micro Watts)
56in[0-7]_input Pump/fan voltage (in milli Volts)
57curr[1-8]_input Pump/fan current (in milli Amperes)
58pwm[1-8] Fan PWM (0 - 255)
59================ ==============================================
0e35f63f
AS
60
61Debugfs entries
62---------------
63
2fd3eec1
AS
64================ =================================================
65serial_number Serial number of the device
0e35f63f 66firmware_version Version of installed firmware
2fd3eec1
AS
67power_cycles Count of how many times the device was powered on
68================ =================================================