hwmon: (pmbus) Add client driver for IR35221

[mirror_ubuntu-artful-kernel.git] / Documentation / hwmon / ir35221

diff --git a/Documentation/hwmon/ir35221 b/Documentation/hwmon/ir35221
new file mode 100644 (file)
index 0000000..f7e1127
--- /dev/null
+++ b/Documentation/hwmon/ir35221
@@ -0,0 +1,87 @@
+Kernel driver ir35221
+=====================
+
+Supported chips:
+  * Infinion IR35221
+    Prefix: 'ir35221'
+    Addresses scanned: -
+    Datasheet: Datasheet is not publicly available.
+
+Author: Samuel Mendoza-Jonas <sam@mendozajonas.com>
+
+
+Description
+-----------
+
+IR35221 is a Digital DC-DC Multiphase Converter
+
+
+Usage Notes
+-----------
+
+This driver does not probe for PMBus devices. You will have to instantiate
+devices explicitly.
+
+Example: the following commands will load the driver for an IR35221
+at address 0x70 on I2C bus #4:
+
+# modprobe ir35221
+# echo ir35221 0x70 > /sys/bus/i2c/devices/i2c-4/new_device
+
+
+Sysfs attributes
+----------------
+
+curr1_label            "iin"
+curr1_input            Measured input current
+curr1_max              Maximum current
+curr1_max_alarm                Current high alarm
+
+curr[2-3]_label                "iout[1-2]"
+curr[2-3]_input                Measured output current
+curr[2-3]_crit         Critical maximum current
+curr[2-3]_crit_alarm   Current critical high alarm
+curr[2-3]_highest      Highest output current
+curr[2-3]_lowest       Lowest output current
+curr[2-3]_max          Maximum current
+curr[2-3]_max_alarm    Current high alarm
+
+in1_label              "vin"
+in1_input              Measured input voltage
+in1_crit               Critical maximum input voltage
+in1_crit_alarm         Input voltage critical high alarm
+in1_highest            Highest input voltage
+in1_lowest             Lowest input voltage
+in1_min                        Minimum input voltage
+in1_min_alarm          Input voltage low alarm
+
+in[2-3]_label          "vout[1-2]"
+in[2-3]_input          Measured output voltage
+in[2-3]_lcrit          Critical minimum output voltage
+in[2-3]_lcrit_alarm    Output voltage critical low alarm
+in[2-3]_crit           Critical maximum output voltage
+in[2-3]_crit_alarm     Output voltage critical high alarm
+in[2-3]_highest                Highest output voltage
+in[2-3]_lowest         Lowest output voltage
+in[2-3]_max            Maximum output voltage
+in[2-3]_max_alarm      Output voltage high alarm
+in[2-3]_min            Minimum output voltage
+in[2-3]_min_alarm      Output voltage low alarm
+
+power1_label           "pin"
+power1_input           Measured input power
+power1_alarm           Input power high alarm
+power1_max             Input power limit
+
+power[2-3]_label       "pout[1-2]"
+power[2-3]_input       Measured output power
+power[2-3]_max         Output power limit
+power[2-3]_max_alarm   Output power high alarm
+
+temp[1-2]_input                Measured temperature
+temp[1-2]_crit         Critical high temperature
+temp[1-2]_crit_alarm   Chip temperature critical high alarm
+temp[1-2]_highest      Highest temperature
+temp[1-2]_lowest       Lowest temperature
+temp[1-2]_max          Maximum temperature
+temp[1-2]_max_alarm    Chip temperature high alarm