Documentation: hwmon: Document the IBM CFF power supply

Signed-off-by: Edward A. James <eajames@us.ibm.com>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>

1 files changed, 54 insertions, 0 deletions

diff --git a/Documentation/hwmon/ibm-cffps b/Documentation/hwmon/ibm-cffps
new file mode 100644
index 000000000000..e05ecd8ecfcf
--- /dev/null
+++ b/Documentation/hwmon/ibm-cffps
@@ -0,0 +1,54 @@
+Kernel driver ibm-cffps
+=======================
+
+Supported chips:
+  * IBM Common Form Factor power supply
+
+Author: Eddie James <eajames@us.ibm.com>
+
+Description
+-----------
+
+This driver supports IBM Common Form Factor (CFF) power supplies. This driver
+is a client to the core PMBus driver.
+
+Usage Notes
+-----------
+
+This driver does not auto-detect devices. You will have to instantiate the
+devices explicitly. Please see Documentation/i2c/instantiating-devices for
+details.
+
+Sysfs entries
+-------------
+
+The following attributes are supported:
+
+curr1_alarm             Output current over-current alarm.
+curr1_input             Measured output current in mA.
+curr1_label             "iout1"
+
+fan1_alarm              Fan 1 warning.
+fan1_fault              Fan 1 fault.
+fan1_input              Fan 1 speed in RPM.
+fan2_alarm              Fan 2 warning.
+fan2_fault              Fan 2 fault.
+fan2_input              Fan 2 speed in RPM.
+
+in1_alarm               Input voltage under-voltage alarm.
+in1_input               Measured input voltage in mV.
+in1_label               "vin"
+in2_alarm               Output voltage over-voltage alarm.
+in2_input               Measured output voltage in mV.
+in2_label               "vout1"
+
+power1_alarm            Input fault or alarm.
+power1_input            Measured input power in uW.
+power1_label            "pin"
+
+temp1_alarm             PSU inlet ambient temperature over-temperature alarm.
+temp1_input             Measured PSU inlet ambient temp in millidegrees C.
+temp2_alarm             Secondary rectifier temp over-temperature alarm.
+temp2_input             Measured secondary rectifier temp in millidegrees C.
+temp3_alarm             ORing FET temperature over-temperature alarm.
+temp3_input             Measured ORing FET temperature in millidegrees C.