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