[PATCH v4 2/3] hwmon: add Documentation

From: Marius Zachmann
Date: Wed Jun 24 2020 - 03:23:05 EST


Signed-off-by: Marius Zachmann <mail@xxxxxxxxxxxxxxxxx>
---
Documentation/hwmon/corsair-cpro.rst | 40 ++++++++++++++++++++++++++++
Documentation/hwmon/index.rst | 1 +
2 files changed, 41 insertions(+)
create mode 100644 Documentation/hwmon/corsair-cpro.rst

diff --git a/Documentation/hwmon/corsair-cpro.rst b/Documentation/hwmon/corsair-cpro.rst
new file mode 100644
index 000000000000..2383c6f72115
--- /dev/null
+++ b/Documentation/hwmon/corsair-cpro.rst
@@ -0,0 +1,40 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+Kernel driver corsair-cpro
+==========================
+
+Supported devices:
+
+ * Corsair Commander Pro
+ * Corsair Commander Pro (1000D)
+
+Author: Marius Zachmann
+
+Description
+-----------
+
+This driver implements the sysfs interface for the Corsair Commander Pro.
+The Corsair Commander Pro is a USB device with 6 fan connectors,
+4 temperature sensor connectors and 2 Corsair LED connectors.
+It can read the voltage levels on the SATA power connector.
+
+Usage Notes
+-----------
+
+Since it is a USB device, hotswapping is possible. The device is autodetected.
+
+Sysfs entries
+-------------
+
+======================= =====================================================================
+in0_input Voltage on SATA 12v
+in1_input Voltage on SATA 5v
+in2_input Voltage on SATA 3.3v
+temp[1-4]_input Temperature on connected temperature sensors
+temp[1-4] label Shows "nc" after name, when not connected
+fan[1-6]_input Connected fan rpm.
+fan[1-6]_label Shows connection status of the fan as detected by the device.
+pwm[1-6] Sets the fan speed. Values from 0-255.
+ When reading, it reports the last value if it was set by the driver.
+ Otherwise returns 0.
+======================= =====================================================================
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 55ff4b7c5349..750d3a975d82 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -47,6 +47,7 @@ Hardware Monitoring Kernel Drivers
bel-pfe
bt1-pvt
coretemp
+ corsair-cpro
da9052
da9055
dell-smm-hwmon
--
2.27.0