Documentation/hwmon/nzxt-kraken3.rst

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