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