aquacomputer_d5next.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. .. SPDX-License-Identifier: GPL-2.0-or-later
  2. Kernel driver aquacomputer-d5next
  3. =================================
  4. Supported devices:
  5. * Aquacomputer D5 Next watercooling pump
  6. * Aquacomputer Farbwerk RGB controller
  7. * Aquacomputer Farbwerk 360 RGB controller
  8. * Aquacomputer Octo fan controller
  9. * Aquacomputer Quadro fan controller
  10. * Aquacomputer High Flow Next sensor
  11. Author: Aleksa Savic
  12. Description
  13. -----------
  14. This driver exposes hardware sensors of listed Aquacomputer devices, which
  15. communicate through proprietary USB HID protocols.
  16. For the D5 Next pump, available sensors are pump and fan speed, power, voltage
  17. and current, as well as coolant temperature and eight virtual temp sensors. Also
  18. available through debugfs are the serial number, firmware version and power-on
  19. count. Attaching a fan to it is optional and allows it to be controlled using
  20. temperature curves directly from the pump. If it's not connected, the fan-related
  21. sensors will report zeroes.
  22. The pump can be configured either through software or via its physical
  23. interface. Configuring the pump through this driver is not implemented, as it
  24. seems to require sending it a complete configuration. That includes addressable
  25. RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
  26. better suited for userspace tools.
  27. The Octo exposes four physical and sixteen virtual temperature sensors, as well as
  28. eight PWM controllable fans, along with their speed (in RPM), power, voltage and
  29. current.
  30. The Quadro exposes four physical and sixteen virtual temperature sensors, a flow
  31. sensor and four PWM controllable fans, along with their speed (in RPM), power,
  32. voltage and current.
  33. The Farbwerk and Farbwerk 360 expose four temperature sensors. Additionally,
  34. sixteen virtual temperature sensors of the Farbwerk 360 are exposed.
  35. The High Flow Next exposes +5V voltages, water quality, conductivity and flow readings.
  36. A temperature sensor can be connected to it, in which case it provides its reading
  37. and an estimation of the dissipated/absorbed power in the liquid cooling loop.
  38. Depending on the device, not all sysfs and debugfs entries will be available.
  39. Writing to virtual temperature sensors is not currently supported.
  40. Usage notes
  41. -----------
  42. The devices communicate via HID reports. The driver is loaded automatically by
  43. the kernel and supports hotswapping.
  44. Sysfs entries
  45. -------------
  46. ================ ==============================================================
  47. temp[1-20]_input Physical/virtual temperature sensors (in millidegrees Celsius)
  48. fan[1-8]_input Pump/fan speed (in RPM) / Flow speed (in dL/h)
  49. power[1-8]_input Pump/fan power (in micro Watts)
  50. in[0-7]_input Pump/fan voltage (in milli Volts)
  51. curr[1-8]_input Pump/fan current (in milli Amperes)
  52. pwm[1-8] Fan PWM (0 - 255)
  53. ================ ==============================================================
  54. Debugfs entries
  55. ---------------
  56. ================ =================================================
  57. serial_number Serial number of the device
  58. firmware_version Version of installed firmware
  59. power_cycles Count of how many times the device was powered on
  60. ================ =================================================