docs: hwmon: convert remaining files to ReST format
[linux-block.git] / Documentation / hwmon / smsc47m192
index 45d6453cd435d7f4cb63b497ad5da7f6c839fd02..a2e86ab67918ff13104e31fb3f9fa36193c65ad7 100644 (file)
@@ -2,23 +2,35 @@ Kernel driver smsc47m192
 ========================
 
 Supported chips:
-  * SMSC LPC47M192 and LPC47M997
+
+  * SMSC LPC47M192, LPC47M15x, LPC47M292 and LPC47M997
+
     Prefix: 'smsc47m192'
+
     Addresses scanned: I2C 0x2c - 0x2d
+
     Datasheet: The datasheet for LPC47M192 is publicly available from
-               http://www.smsc.com/
-               The LPC47M997 is compatible for hardware monitoring.
 
-Author: Hartmut Rick <linux@rick.claranet.de>
-        Special thanks to Jean Delvare for careful checking
-        of the code and many helpful comments and suggestions.
+              http://www.smsc.com/
+
+              The LPC47M15x, LPC47M292 and LPC47M997 are compatible for
+
+              hardware monitoring.
+
+
+
+Author:
+      - Hartmut Rick <linux@rick.claranet.de>
+
+      - Special thanks to Jean Delvare for careful checking
+       of the code and many helpful comments and suggestions.
 
 
 Description
 -----------
 
 This driver implements support for the hardware sensor capabilities
-of the SMSC LPC47M192 and LPC47M997 Super-I/O chips.
+of the SMSC LPC47M192 and compatible Super-I/O chips.
 
 These chips support 3 temperature channels and 8 voltage inputs
 as well as CPU voltage VID input.
@@ -51,52 +63,54 @@ Reading them more often repeats the same values.
 sysfs interface
 ---------------
 
-in0_input      - +2.5V voltage input
-in1_input      - CPU voltage input (nominal 2.25V)
-in2_input      - +3.3V voltage input
-in3_input      - +5V voltage input
-in4_input      - +12V voltage input (may be missing if used as VID4)
-in5_input      - Vcc voltage input (nominal 3.3V)
-                 This is the supply voltage of the sensor chip itself.
-in6_input      - +1.5V voltage input
-in7_input      - +1.8V voltage input
+===================== ==========================================================
+in0_input            +2.5V voltage input
+in1_input            CPU voltage input (nominal 2.25V)
+in2_input            +3.3V voltage input
+in3_input            +5V voltage input
+in4_input            +12V voltage input (may be missing if used as VID4)
+in5_input            Vcc voltage input (nominal 3.3V)
+                     This is the supply voltage of the sensor chip itself.
+in6_input            +1.5V voltage input
+in7_input            +1.8V voltage input
 
 in[0-7]_min,
-in[0-7]_max    - lower and upper alarm thresholds for in[0-7]_input reading
+in[0-7]_max          lower and upper alarm thresholds for in[0-7]_input reading
 
-                 All voltages are read and written in mV.
+                     All voltages are read and written in mV.
 
-in[0-7]_alarm  - alarm flags for voltage inputs
-                 These files read '1' in case of alarm, '0' otherwise.
+in[0-7]_alarm        alarm flags for voltage inputs
+                     These files read '1' in case of alarm, '0' otherwise.
 
-temp1_input    - chip temperature measured by on-chip diode
-temp[2-3]_input        - temperature measured by external diodes (one of these would
-                 typically be wired to the diode inside the CPU)
+temp1_input          chip temperature measured by on-chip diode
+temp[2-3]_input              temperature measured by external diodes (one of these
+                     would typically be wired to the diode inside the CPU)
 
 temp[1-3]_min,
-temp[1-3]_max  - lower and upper alarm thresholds for temperatures
+temp[1-3]_max        lower and upper alarm thresholds for temperatures
 
-temp[1-3]_offset - temperature offset registers
-                 The chip adds the offsets stored in these registers to
-                 the corresponding temperature readings.
-                 Note that temp1 and temp2 offsets share the same register,
-                 they cannot both be different from zero at the same time.
-                 Writing a non-zero number to one of them will reset the other
-                 offset to zero.
+temp[1-3]_offset      temperature offset registers
+                     The chip adds the offsets stored in these registers to
+                     the corresponding temperature readings.
+                     Note that temp1 and temp2 offsets share the same register,
+                     they cannot both be different from zero at the same time.
+                     Writing a non-zero number to one of them will reset the other
+                     offset to zero.
 
-                 All temperatures and offsets are read and written in
-                 units of 0.001 degC.
+                     All temperatures and offsets are read and written in
+                     units of 0.001 degC.
 
-temp[1-3]_alarm - alarm flags for temperature inputs, '1' in case of alarm,
-                 '0' otherwise.
-temp[2-3]_input_fault diode fault flags for temperature inputs 2 and 3.
-                 A fault is detected if the two pins for the corresponding
-                 sensor are open or shorted, or any of the two is shorted
-                 to ground or Vcc. '1' indicates a diode fault.
+temp[1-3]_alarm       alarm flags for temperature inputs, '1' in case of alarm,
+                     '0' otherwise.
+temp[2-3]_input_fault diode fault flags for temperature inputs 2 and 3.
+                     A fault is detected if the two pins for the corresponding
+                     sensor are open or shorted, or any of the two is shorted
+                     to ground or Vcc. '1' indicates a diode fault.
 
-cpu0_vid       - CPU voltage as received from the CPU
+cpu0_vid             CPU voltage as received from the CPU
 
-vrm            - CPU VID standard used for decoding CPU voltage
+vrm                  CPU VID standard used for decoding CPU voltage
+===================== ==========================================================
 
-                 The *_min, *_max, *_offset and vrm files can be read and
-                 written, all others are read-only.
+The `*_min`, `*_max`, `*_offset` and `vrm` files can be read and written,
+all others are read-only.