nzxt-smart2.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .. SPDX-License-Identifier: GPL-2.0-or-later
  2. Kernel driver nzxt-smart2
  3. =========================
  4. Supported devices:
  5. - NZXT RGB & Fan controller
  6. - NZXT Smart Device v2
  7. Description
  8. -----------
  9. This driver implements monitoring and control of fans plugged into the device.
  10. Besides typical speed monitoring and PWM duty cycle control, voltage and current
  11. is reported for every fan.
  12. The device also has two connectors for RGB LEDs; support for them isn't
  13. implemented (mainly because there is no standardized sysfs interface).
  14. Also, the device has a noise sensor, but the sensor seems to be completely
  15. useless (and very imprecise), so support for it isn't implemented too.
  16. Usage Notes
  17. -----------
  18. The device should be autodetected, and the driver should load automatically.
  19. If fans are plugged in/unplugged while the system is powered on, the driver
  20. must be reloaded to detect configuration changes; otherwise, new fans can't
  21. be controlled (`pwm*` changes will be ignored). It is necessary because the
  22. device has a dedicated "detect fans" command, and currently, it is executed only
  23. during initialization. Speed, voltage, current monitoring will work even without
  24. reload. As an alternative to reloading the module, a userspace tool (like
  25. `liquidctl`_) can be used to run "detect fans" command through hidraw interface.
  26. The driver coexists with userspace tools that access the device through hidraw
  27. interface with no known issues.
  28. .. _liquidctl: https://github.com/liquidctl/liquidctl
  29. Sysfs entries
  30. -------------
  31. ======================= ========================================================
  32. fan[1-3]_input Fan speed monitoring (in rpm).
  33. curr[1-3]_input Current supplied to the fan (in milliamperes).
  34. in[0-2]_input Voltage supplied to the fan (in millivolts).
  35. pwm[1-3] Controls fan speed: PWM duty cycle for PWM-controlled
  36. fans, voltage for other fans. Voltage can be changed in
  37. 9-12 V range, but the value of the sysfs attribute is
  38. always in 0-255 range (1 = 9V, 255 = 12V). Setting the
  39. attribute to 0 turns off the fan completely.
  40. pwm[1-3]_enable 1 if the fan can be controlled by writing to the
  41. corresponding pwm* attribute, 0 otherwise. The device
  42. can control only the fans it detected itself, so the
  43. attribute is read-only.
  44. pwm[1-3]_mode Read-only, 1 for PWM-controlled fans, 0 for other fans
  45. (or if no fan connected).
  46. update_interval The interval at which all inputs are updated (in
  47. milliseconds). The default is 1000ms. Minimum is 250ms.
  48. ======================= ========================================================