Documentation/hwmon/aquacomputer_d5next.rst

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