projects / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| f3b4b146 AS |
1 | .. SPDX-License-Identifier: GPL-2.0-or-later |
| 2 | ||
| 3 | Kernel driver nzxt-kraken3 | |
| 4 | ========================== | |
| 5 | ||
| 6 | Supported devices: | |
| 7 | ||
| 8 | * NZXT Kraken X53 | |
| 9 | * NZXT Kraken X63 | |
| 10 | * NZXT Kraken X73 | |
| 11 | * NZXT Kraken Z53 | |
| 12 | * NZXT Kraken Z63 | |
| 13 | * NZXT Kraken Z73 | |
| 8ec8d6c5 AS |
14 | * NZXT Kraken 2023 |
| 15 | * NZXT Kraken 2023 Elite | |
| f3b4b146 AS |
16 | |
| 17 | Author: Jonas Malaco, Aleksa Savic | |
| 18 | ||
| 19 | Description | |
| 20 | ----------- | |
| 21 | ||
| 8ec8d6c5 AS |
22 | This driver enables hardware monitoring support for NZXT Kraken X53/X63/X73, |
| 23 | Z53/Z63/Z73 and Kraken 2023 (standard and Elite) all-in-one CPU liquid coolers. | |
| 24 | All models expose liquid temperature and pump speed (in RPM), as well as PWM | |
| 25 | control (either as a fixed value or through a temp-PWM curve). The Z-series and | |
| 26 | Kraken 2023 models additionally expose the speed and duty of an optionally connected | |
| 27 | fan, with the same PWM control capabilities. | |
| f3b4b146 AS |
28 | |
| 29 | Pump and fan duty control mode can be set through pwm[1-2]_enable, where 1 is | |
| 30 | for the manual control mode and 2 is for the liquid temp to PWM curve mode. | |
| 31 | Writing a 0 disables control of the channel through the driver after setting its | |
| 32 | duty to 100%. | |
| 33 | ||
| 34 | The temperature of the curves relates to the fixed [20-59] range, correlating to | |
| 35 | the detected liquid temperature. Only PWM values (ranging from 0-255) can be set. | |
| 36 | If in curve mode, setting point values should be done in moderation - the devices | |
| 37 | require complete curves to be sent for each change; they can lock up or discard | |
| 38 | the changes if they are too numerous at once. Suggestion is to set them while | |
| 39 | in an another mode, and then apply them by switching to curve. | |
| 40 | ||
| 41 | The devices can report if they are faulty. The driver supports that situation | |
| 42 | and will issue a warning. This can also happen when the USB cable is connected, | |
| 43 | but SATA power is not. | |
| 44 | ||
| 8ec8d6c5 AS |
45 | The addressable RGB LEDs and LCD screen (only on Z-series and Kraken 2023 models) |
| 46 | are not supported in this driver, but can be controlled through existing userspace | |
| 47 | tools, such as `liquidctl`_. | |
| f3b4b146 AS |
48 | |
| 49 | .. _liquidctl: https://github.com/liquidctl/liquidctl | |
| 50 | ||
| 51 | Usage Notes | |
| 52 | ----------- | |
| 53 | ||
| 54 | As these are USB HIDs, the driver can be loaded automatically by the kernel and | |
| 55 | supports hot swapping. | |
| 56 | ||
| 57 | Possible pwm_enable values are: | |
| 58 | ||
| 59 | ====== ========================================================================== | |
| 60 | 0 Set fan to 100% | |
| 61 | 1 Direct PWM mode (applies value in corresponding PWM entry) | |
| 62 | 2 Curve control mode (applies the temp-PWM duty curve based on coolant temp) | |
| 63 | ====== ========================================================================== | |
| 64 | ||
| 65 | Sysfs entries | |
| 66 | ------------- | |
| 67 | ||
| 68 | ============================== ================================================================ | |
| 69 | fan1_input Pump speed (in rpm) | |
| 70 | fan2_input Fan speed (in rpm) | |
| 71 | temp1_input Coolant temperature (in millidegrees Celsius) | |
| 72 | pwm1 Pump duty (value between 0-255) | |
| 73 | pwm1_enable Pump duty control mode (0: disabled, 1: manual, 2: curve) | |
| 74 | pwm2 Fan duty (value between 0-255) | |
| 75 | pwm2_enable Fan duty control mode (0: disabled, 1: manual, 2: curve) | |
| 76 | temp[1-2]_auto_point[1-40]_pwm Temp-PWM duty curves (for pump and fan), related to coolant temp | |
| 77 | ============================== ================================================================ |