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 Aquaero 5/6 fan controllers
   9 * Aquacomputer D5 Next watercooling pump
  10 * Aquacomputer Farbwerk RGB controller
  11 * Aquacomputer Farbwerk 360 RGB controller
  12 * Aquacomputer Octo fan controller
  13 * Aquacomputer Quadro fan controller
  14 * Aquacomputer High Flow Next sensor
  15 * Aquacomputer Leakshield leak prevention system
  16 * Aquacomputer Aquastream XT watercooling pump
  17 * Aquacomputer Aquastream Ultimate watercooling pump
  18 * Aquacomputer Poweradjust 3 fan controller
  19
  20 Author: Aleksa Savic
  21
  22 Description
  23 -----------
  24
  25 This driver exposes hardware sensors of listed Aquacomputer devices, which
  26 communicate through proprietary USB HID protocols.
  27
  28 The Aquaero devices expose eight physical, eight virtual and four calculated
  29 virtual temperature sensors, as well as two flow sensors. The fans expose their
  30 speed (in RPM), power, voltage and current. Temperature offsets and fan speeds
  31 can be controlled.
  32
  33 For the D5 Next pump, available sensors are pump and fan speed, power, voltage
  34 and current, as well as coolant temperature and eight virtual temp sensors. Also
  35 available through debugfs are the serial number, firmware version and power-on
  36 count. Attaching a fan to it is optional and allows it to be controlled using
  37 temperature curves directly from the pump. If it's not connected, the fan-related
  38 sensors will report zeroes.
  39
  40 The pump can be configured either through software or via its physical
  41 interface. Configuring the pump through this driver is not implemented, as it
  42 seems to require sending it a complete configuration. That includes addressable
  43 RGB LEDs, for which there is no standard sysfs interface. Thus, that task is
  44 better suited for userspace tools.
  45
  46 The Octo exposes four physical and sixteen virtual temperature sensors, as well as
  47 eight PWM controllable fans, along with their speed (in RPM), power, voltage and
  48 current.
  49
  50 The Quadro exposes four physical and sixteen virtual temperature sensors, a flow
  51 sensor and four PWM controllable fans, along with their speed (in RPM), power,
  52 voltage and current. Flow sensor pulses are also available.
  53
  54 The Farbwerk and Farbwerk 360 expose four temperature sensors. Additionally,
  55 sixteen virtual temperature sensors of the Farbwerk 360 are exposed.
  56
  57 The High Flow Next exposes +5V voltages, water quality, conductivity and flow readings.
  58 A temperature sensor can be connected to it, in which case it provides its reading
  59 and an estimation of the dissipated/absorbed power in the liquid cooling loop.
  60
  61 The Leakshield exposes two temperature sensors and coolant pressure (current, min, max and
  62 target readings). It also exposes the estimated reservoir volume and how much of it is
  63 filled with coolant. Pump RPM and flow can be set to enhance on-device calculations,
  64 but this is not yet implemented here.
  65
  66 The Aquastream XT pump exposes temperature readings for the coolant, external sensor
  67 and fan IC. It also exposes pump and fan speeds (in RPM), voltages, as well as pump
  68 current.
  69
  70 The Aquastream Ultimate pump exposes coolant temp and an external temp sensor, along
  71 with speed, power, voltage and current of both the pump and optionally connected fan.
  72 It also exposes pressure and flow speed readings.
  73
  74 The Poweradjust 3 controller exposes a single external temperature sensor.
  75
  76 Depending on the device, not all sysfs and debugfs entries will be available.
  77 Writing to virtual temperature sensors is not currently supported.
  78
  79 Usage notes
  80 -----------
  81
  82 The devices communicate via HID reports. The driver is loaded automatically by
  83 the kernel and supports hotswapping.
  84
  85 Sysfs entries
  86 -------------
  87
  88 ================ ==============================================================
  89 temp[1-20]_input Physical/virtual temperature sensors (in millidegrees Celsius)
  90 temp[1-8]_offset Temperature sensor correction offset (in millidegrees Celsius)
  91 fan[1-8]_input   Pump/fan speed (in RPM) / Flow speed (in dL/h)
  92 fan1_min         Minimal fan speed (in RPM)
  93 fan1_max         Maximal fan speed (in RPM)
  94 fan1_target      Target fan speed (in RPM)
  95 fan5_pulses      Quadro flow sensor pulses
  96 power[1-8]_input Pump/fan power (in micro Watts)
  97 in[0-7]_input    Pump/fan voltage (in milli Volts)
  98 curr[1-8]_input  Pump/fan current (in milli Amperes)
  99 pwm[1-8]         Fan PWM (0 - 255)
 100 ================ ==============================================================
 101
 102 Debugfs entries
 103 ---------------
 104
 105 ================ =================================================
 106 serial_number    Serial number of the device
 107 firmware_version Version of installed firmware
 108 power_cycles     Count of how many times the device was powered on
 109 ================ =================================================