docs: hwmon: convert three docs to ReST format
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Mon, 22 Apr 2019 17:39:37 +0000 (14:39 -0300)
committerGuenter Roeck <linux@roeck-us.net>
Mon, 22 Apr 2019 22:27:27 +0000 (15:27 -0700)
Those three new drivers were missed on the initial conversion
to ReST format. So:

- Rename them to .rst;
- Add them to the hwmon index.rst index;
- add some blank lines at the "Supported systems:" part, in
  order to allow Sphinx to properly identify new lines,
  suppressing warnings and avoid it to output some random
  lines in bold;
- When multiple authors are involved, change the authors
  part to a list, in order to avoid adding blank lines.
- adjust the table cells (one of the tables seemed to be
  assuming that tab is 4 positions instead of 8) and add
  the table markup.
- be sure that the section markups have the same number of
  characters as the section title.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/hwmon/index.rst
Documentation/hwmon/ir38064 [deleted file]
Documentation/hwmon/ir38064.rst [new file with mode: 0644]
Documentation/hwmon/isl68137 [deleted file]
Documentation/hwmon/isl68137.rst [new file with mode: 0644]
Documentation/hwmon/lochnagar [deleted file]
Documentation/hwmon/lochnagar.rst [new file with mode: 0644]

index 893804414510c93a8e0859f36d778cbdb7d241ac..3fa14fe7b49ce64ff81621fc43c102ad2d5ce29c 100644 (file)
@@ -65,6 +65,8 @@ Hardware Monitoring Kernel Drivers
    ina2xx.rst
    ina3221.rst
    ir35221.rst
+   ir38064.rst
+   isl68137.rst
    it87.rst
    jc42.rst
    k10temp.rst
@@ -86,6 +88,7 @@ Hardware Monitoring Kernel Drivers
    lm93.rst
    lm95234.rst
    lm95245.rst
+   lochnagar.rst
    ltc2945.rst
    ltc2978.rst
    ltc2990.rst
diff --git a/Documentation/hwmon/ir38064 b/Documentation/hwmon/ir38064
deleted file mode 100644 (file)
index 9f218c3..0000000
+++ /dev/null
@@ -1,61 +0,0 @@
-Kernel driver ir38064
-=====================
-
-Supported chips:
-  * Infineon IR38064
-    Prefix: 'ir38064'
-    Addresses scanned: -
-    Datasheet: Publicly available at the Infineon webiste
-      https://www.infineon.com/dgdl/Infineon-IR38064MTRPBF-DS-v03_07-EN.pdf?fileId=5546d462584d1d4a0158db0d9efb67ca
-
-Authors:
-        Maxim Sloyko <maxims@google.com>
-        Patrick Venture <venture@google.com>
-
-Description
------------
-
-IR38064 is a Single-input Voltage, Synchronous Buck Regulator, DC-DC Converter.
-
-Usage Notes
------------
-
-This driver does not probe for PMBus devices. You will have to instantiate
-devices explicitly.
-
-Sysfs attributes
-----------------
-
-curr1_label            "iout1"
-curr1_input            Measured output current
-curr1_crit             Critical maximum current
-curr1_crit_alarm       Current critical high alarm
-curr1_max              Maximum current
-curr1_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_min                Minimum input voltage
-in1_min_alarm          Input voltage low alarm
-
-in2_label              "vout1"
-in2_input              Measured output voltage
-in2_lcrit              Critical minimum output voltage
-in2_lcrit_alarm        Output voltage critical low alarm
-in2_crit               Critical maximum output voltage
-in2_crit_alarm         Output voltage critical high alarm
-in2_max                Maximum output voltage
-in2_max_alarm          Output voltage high alarm
-in2_min                Minimum output voltage
-in2_min_alarm          Output voltage low alarm
-
-power1_label           "pout1"
-power1_input           Measured output power
-
-temp1_input            Measured temperature
-temp1_crit             Critical high temperature
-temp1_crit_alarm       Chip temperature critical high alarm
-temp1_max              Maximum temperature
-temp1_max_alarm        Chip temperature high alarm
diff --git a/Documentation/hwmon/ir38064.rst b/Documentation/hwmon/ir38064.rst
new file mode 100644 (file)
index 0000000..c455d75
--- /dev/null
@@ -0,0 +1,66 @@
+Kernel driver ir38064
+=====================
+
+Supported chips:
+
+  * Infineon IR38064
+
+    Prefix: 'ir38064'
+    Addresses scanned: -
+
+    Datasheet: Publicly available at the Infineon webiste
+      https://www.infineon.com/dgdl/Infineon-IR38064MTRPBF-DS-v03_07-EN.pdf?fileId=5546d462584d1d4a0158db0d9efb67ca
+
+Authors:
+      - Maxim Sloyko <maxims@google.com>
+      - Patrick Venture <venture@google.com>
+
+Description
+-----------
+
+IR38064 is a Single-input Voltage, Synchronous Buck Regulator, DC-DC Converter.
+
+Usage Notes
+-----------
+
+This driver does not probe for PMBus devices. You will have to instantiate
+devices explicitly.
+
+Sysfs attributes
+----------------
+
+======================= ===========================
+curr1_label            "iout1"
+curr1_input            Measured output current
+curr1_crit             Critical maximum current
+curr1_crit_alarm       Current critical high alarm
+curr1_max              Maximum current
+curr1_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_min                        Minimum input voltage
+in1_min_alarm          Input voltage low alarm
+
+in2_label              "vout1"
+in2_input              Measured output voltage
+in2_lcrit              Critical minimum output voltage
+in2_lcrit_alarm                Output voltage critical low alarm
+in2_crit               Critical maximum output voltage
+in2_crit_alarm         Output voltage critical high alarm
+in2_max                        Maximum output voltage
+in2_max_alarm          Output voltage high alarm
+in2_min                        Minimum output voltage
+in2_min_alarm          Output voltage low alarm
+
+power1_label           "pout1"
+power1_input           Measured output power
+
+temp1_input            Measured temperature
+temp1_crit             Critical high temperature
+temp1_crit_alarm       Chip temperature critical high alarm
+temp1_max              Maximum temperature
+temp1_max_alarm                Chip temperature high alarm
+======================= ===========================
diff --git a/Documentation/hwmon/isl68137 b/Documentation/hwmon/isl68137
deleted file mode 100644 (file)
index 92e5c5f..0000000
+++ /dev/null
@@ -1,72 +0,0 @@
-Kernel driver isl68137
-======================
-
-Supported chips:
-  * Intersil ISL68137
-    Prefix: 'isl68137'
-    Addresses scanned: -
-    Datasheet: Publicly available at the Intersil website
-      https://www.intersil.com/content/dam/Intersil/documents/isl6/isl68137.pdf
-
-Authors:
-        Maxim Sloyko <maxims@google.com>
-        Robert Lippert <rlippert@google.com>
-        Patrick Venture <venture@google.com>
-
-Description
------------
-
-Intersil ISL68137 is a digital output 7-phase configurable PWM
-controller with an AVSBus interface.
-
-Usage Notes
------------
-
-This driver does not probe for PMBus devices. You will have to instantiate
-devices explicitly.
-
-The ISL68137 AVS operation mode must be enabled/disabled at runtime.
-
-Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute.
-
-Additional Sysfs attributes
----------------------------
-
-avs(0|1)_enable                Controls the AVS state of each rail.
-
-curr1_label            "iin"
-curr1_input            Measured input current
-curr1_crit             Critical maximum current
-curr1_crit_alarm       Current critical 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
-
-in1_label              "vin"
-in1_input              Measured input voltage
-in1_lcrit              Critical minimum input voltage
-in1_lcrit_alarm                Input voltage critical low alarm
-in1_crit               Critical maximum input voltage
-in1_crit_alarm         Input voltage critical high 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
-
-power1_label           "pin"
-power1_input           Measured input power
-power1_alarm           Input power high alarm
-
-power[2-3]_label       "pout[1-2]"
-power[2-3]_input       Measured output power
-
-temp[1-3]_input                Measured temperature
-temp[1-3]_crit         Critical high temperature
-temp[1-3]_crit_alarm   Chip temperature critical high alarm
-temp[1-3]_max          Maximum temperature
-temp[1-3]_max_alarm    Chip temperature high alarm
diff --git a/Documentation/hwmon/isl68137.rst b/Documentation/hwmon/isl68137.rst
new file mode 100644 (file)
index 0000000..a5a7c85
--- /dev/null
@@ -0,0 +1,80 @@
+Kernel driver isl68137
+======================
+
+Supported chips:
+
+  * Intersil ISL68137
+
+    Prefix: 'isl68137'
+
+    Addresses scanned: -
+
+    Datasheet:
+
+      Publicly available at the Intersil website
+      https://www.intersil.com/content/dam/Intersil/documents/isl6/isl68137.pdf
+
+Authors:
+      - Maxim Sloyko <maxims@google.com>
+      - Robert Lippert <rlippert@google.com>
+      - Patrick Venture <venture@google.com>
+
+Description
+-----------
+
+Intersil ISL68137 is a digital output 7-phase configurable PWM
+controller with an AVSBus interface.
+
+Usage Notes
+-----------
+
+This driver does not probe for PMBus devices. You will have to instantiate
+devices explicitly.
+
+The ISL68137 AVS operation mode must be enabled/disabled at runtime.
+
+Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute.
+
+Additional Sysfs attributes
+---------------------------
+
+======================= ====================================
+avs(0|1)_enable                Controls the AVS state of each rail.
+
+curr1_label            "iin"
+curr1_input            Measured input current
+curr1_crit             Critical maximum current
+curr1_crit_alarm       Current critical 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
+
+in1_label              "vin"
+in1_input              Measured input voltage
+in1_lcrit              Critical minimum input voltage
+in1_lcrit_alarm                Input voltage critical low alarm
+in1_crit               Critical maximum input voltage
+in1_crit_alarm         Input voltage critical high 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
+
+power1_label           "pin"
+power1_input           Measured input power
+power1_alarm           Input power high alarm
+
+power[2-3]_label       "pout[1-2]"
+power[2-3]_input       Measured output power
+
+temp[1-3]_input                Measured temperature
+temp[1-3]_crit         Critical high temperature
+temp[1-3]_crit_alarm   Chip temperature critical high alarm
+temp[1-3]_max          Maximum temperature
+temp[1-3]_max_alarm    Chip temperature high alarm
+======================= ====================================
diff --git a/Documentation/hwmon/lochnagar b/Documentation/hwmon/lochnagar
deleted file mode 100644 (file)
index e9686fb..0000000
+++ /dev/null
@@ -1,80 +0,0 @@
-Kernel Driver Lochnagar
-========================
-
-Supported systems:
-  * Cirrus Logic : Lochnagar 2
-
-Author: Lucas A. Tanure Alves
-
-Description
------------
-
-Lochnagar 2 features built-in Current Monitor circuitry that allows for the
-measurement of both voltage and current on up to eight of the supply voltage
-rails provided to the minicards. The Current Monitor does not require any
-hardware modifications or external circuitry to operate.
-
-The current and voltage measurements are obtained through the standard register
-map interface to the Lochnagar board controller, and can therefore be monitored
-by software.
-
-Sysfs attributes
-----------------
-
-temp1_input             The Lochnagar board temperature (milliCelsius)
-in0_input               Measured voltage for DBVDD1 (milliVolts)
-in0_label               "DBVDD1"
-curr1_input             Measured current for DBVDD1 (milliAmps)
-curr1_label             "DBVDD1"
-power1_average          Measured average power for DBVDD1 (microWatts)
-power1_average_interval Power averaging time input valid from 1 to 1708mS
-power1_label            "DBVDD1"
-in1_input               Measured voltage for 1V8 DSP (milliVolts)
-in1_label               "1V8 DSP"
-curr2_input             Measured current for 1V8 DSP (milliAmps)
-curr2_label             "1V8 DSP"
-power2_average          Measured average power for 1V8 DSP (microWatts)
-power2_average_interval Power averaging time input valid from 1 to 1708mS
-power2_label            "1V8 DSP"
-in2_input               Measured voltage for 1V8 CDC (milliVolts)
-in2_label               "1V8 CDC"
-curr3_input             Measured current for 1V8 CDC (milliAmps)
-curr3_label             "1V8 CDC"
-power3_average          Measured average power for 1V8 CDC (microWatts)
-power3_average_interval Power averaging time input valid from 1 to 1708mS
-power3_label            "1V8 CDC"
-in3_input               Measured voltage for VDDCORE DSP (milliVolts)
-in3_label               "VDDCORE DSP"
-curr4_input             Measured current for VDDCORE DSP (milliAmps)
-curr4_label             "VDDCORE DSP"
-power4_average          Measured average power for VDDCORE DSP (microWatts)
-power4_average_interval Power averaging time input valid from 1 to 1708mS
-power4_label            "VDDCORE DSP"
-in4_input               Measured voltage for AVDD 1V8 (milliVolts)
-in4_label               "AVDD 1V8"
-curr5_input             Measured current for AVDD 1V8 (milliAmps)
-curr5_label             "AVDD 1V8"
-power5_average          Measured average power for AVDD 1V8 (microWatts)
-power5_average_interval Power averaging time input valid from 1 to 1708mS
-power5_label            "AVDD 1V8"
-curr6_input             Measured current for SYSVDD (milliAmps)
-curr6_label             "SYSVDD"
-power6_average          Measured average power for SYSVDD (microWatts)
-power6_average_interval Power averaging time input valid from 1 to 1708mS
-power6_label            "SYSVDD"
-in6_input               Measured voltage for VDDCORE CDC (milliVolts)
-in6_label               "VDDCORE CDC"
-curr7_input             Measured current for VDDCORE CDC (milliAmps)
-curr7_label             "VDDCORE CDC"
-power7_average          Measured average power for VDDCORE CDC (microWatts)
-power7_average_interval Power averaging time input valid from 1 to 1708mS
-power7_label            "VDDCORE CDC"
-in7_input               Measured voltage for MICVDD (milliVolts)
-in7_label               "MICVDD"
-curr8_input             Measured current for MICVDD (milliAmps)
-curr8_label             "MICVDD"
-power8_average          Measured average power for MICVDD (microWatts)
-power8_average_interval Power averaging time input valid from 1 to 1708mS
-power8_label            "MICVDD"
-
-Note: It is not possible to measure voltage on the SYSVDD rail.
diff --git a/Documentation/hwmon/lochnagar.rst b/Documentation/hwmon/lochnagar.rst
new file mode 100644 (file)
index 0000000..1d609c4
--- /dev/null
@@ -0,0 +1,83 @@
+Kernel Driver Lochnagar
+=======================
+
+Supported systems:
+  * Cirrus Logic : Lochnagar 2
+
+Author: Lucas A. Tanure Alves
+
+Description
+-----------
+
+Lochnagar 2 features built-in Current Monitor circuitry that allows for the
+measurement of both voltage and current on up to eight of the supply voltage
+rails provided to the minicards. The Current Monitor does not require any
+hardware modifications or external circuitry to operate.
+
+The current and voltage measurements are obtained through the standard register
+map interface to the Lochnagar board controller, and can therefore be monitored
+by software.
+
+Sysfs attributes
+----------------
+
+======================= =======================================================
+temp1_input             The Lochnagar board temperature (milliCelsius)
+in0_input               Measured voltage for DBVDD1 (milliVolts)
+in0_label               "DBVDD1"
+curr1_input             Measured current for DBVDD1 (milliAmps)
+curr1_label             "DBVDD1"
+power1_average          Measured average power for DBVDD1 (microWatts)
+power1_average_interval Power averaging time input valid from 1 to 1708mS
+power1_label            "DBVDD1"
+in1_input               Measured voltage for 1V8 DSP (milliVolts)
+in1_label               "1V8 DSP"
+curr2_input             Measured current for 1V8 DSP (milliAmps)
+curr2_label             "1V8 DSP"
+power2_average          Measured average power for 1V8 DSP (microWatts)
+power2_average_interval Power averaging time input valid from 1 to 1708mS
+power2_label            "1V8 DSP"
+in2_input               Measured voltage for 1V8 CDC (milliVolts)
+in2_label               "1V8 CDC"
+curr3_input             Measured current for 1V8 CDC (milliAmps)
+curr3_label             "1V8 CDC"
+power3_average          Measured average power for 1V8 CDC (microWatts)
+power3_average_interval Power averaging time input valid from 1 to 1708mS
+power3_label            "1V8 CDC"
+in3_input               Measured voltage for VDDCORE DSP (milliVolts)
+in3_label               "VDDCORE DSP"
+curr4_input             Measured current for VDDCORE DSP (milliAmps)
+curr4_label             "VDDCORE DSP"
+power4_average          Measured average power for VDDCORE DSP (microWatts)
+power4_average_interval Power averaging time input valid from 1 to 1708mS
+power4_label            "VDDCORE DSP"
+in4_input               Measured voltage for AVDD 1V8 (milliVolts)
+in4_label               "AVDD 1V8"
+curr5_input             Measured current for AVDD 1V8 (milliAmps)
+curr5_label             "AVDD 1V8"
+power5_average          Measured average power for AVDD 1V8 (microWatts)
+power5_average_interval Power averaging time input valid from 1 to 1708mS
+power5_label            "AVDD 1V8"
+curr6_input             Measured current for SYSVDD (milliAmps)
+curr6_label             "SYSVDD"
+power6_average          Measured average power for SYSVDD (microWatts)
+power6_average_interval Power averaging time input valid from 1 to 1708mS
+power6_label            "SYSVDD"
+in6_input               Measured voltage for VDDCORE CDC (milliVolts)
+in6_label               "VDDCORE CDC"
+curr7_input             Measured current for VDDCORE CDC (milliAmps)
+curr7_label             "VDDCORE CDC"
+power7_average          Measured average power for VDDCORE CDC (microWatts)
+power7_average_interval Power averaging time input valid from 1 to 1708mS
+power7_label            "VDDCORE CDC"
+in7_input               Measured voltage for MICVDD (milliVolts)
+in7_label               "MICVDD"
+curr8_input             Measured current for MICVDD (milliAmps)
+curr8_label             "MICVDD"
+power8_average          Measured average power for MICVDD (microWatts)
+power8_average_interval Power averaging time input valid from 1 to 1708mS
+power8_label            "MICVDD"
+======================= =======================================================
+
+Note:
+    It is not possible to measure voltage on the SYSVDD rail.