Merge remote-tracking branch 'stable/linux-5.15.y' into rpi-5.15.y
[platform/kernel/linux-rpi.git] / Documentation / hwmon / nzxt-kraken2.rst
1 .. SPDX-License-Identifier: GPL-2.0-or-later
2
3 Kernel driver nzxt-kraken2
4 ==========================
5
6 Supported devices:
7
8 * NZXT Kraken X42
9 * NZXT Kraken X52
10 * NZXT Kraken X62
11 * NZXT Kraken X72
12
13 Author: Jonas Malaco
14
15 Description
16 -----------
17
18 This driver enables hardware monitoring support for NZXT Kraken X42/X52/X62/X72
19 all-in-one CPU liquid coolers.  Three sensors are available: fan speed, pump
20 speed and coolant temperature.
21
22 Fan and pump control, while supported by the firmware, are not currently
23 exposed.  The addressable RGB LEDs, present in the integrated CPU water block
24 and pump head, are not supported either.  But both features can be found in
25 existing user-space tools (e.g. `liquidctl`_).
26
27 .. _liquidctl: https://github.com/liquidctl/liquidctl
28
29 Usage Notes
30 -----------
31
32 As these are USB HIDs, the driver can be loaded automatically by the kernel and
33 supports hot swapping.
34
35 Sysfs entries
36 -------------
37
38 ======================= ========================================================
39 fan1_input              Fan speed (in rpm)
40 fan2_input              Pump speed (in rpm)
41 temp1_input             Coolant temperature (in millidegrees Celsius)
42 ======================= ========================================================