1
0
Fork 0

docs: hwmon: convert three docs to ReST format

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>
hifive-unleashed-5.2
Mauro Carvalho Chehab 2019-04-22 14:39:37 -03:00 committed by Guenter Roeck
parent 4f8d374b77
commit e57695e772
4 changed files with 33 additions and 14 deletions

View 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

View File

@ -2,15 +2,18 @@ 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>
- Maxim Sloyko <maxims@google.com>
- Patrick Venture <venture@google.com>
Description
-----------
@ -26,29 +29,30 @@ 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
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 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_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 Maximum output voltage
in2_max_alarm Output voltage high alarm
in2_min Minimum output voltage
in2_min Minimum output voltage
in2_min_alarm Output voltage low alarm
power1_label "pout1"
@ -58,4 +62,5 @@ 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
temp1_max_alarm Chip temperature high alarm
======================= ===========================

View File

@ -2,16 +2,22 @@ Kernel driver isl68137
======================
Supported chips:
* Intersil ISL68137
Prefix: 'isl68137'
Addresses scanned: -
Datasheet: Publicly available at the Intersil website
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>
- Maxim Sloyko <maxims@google.com>
- Robert Lippert <rlippert@google.com>
- Patrick Venture <venture@google.com>
Description
-----------
@ -32,6 +38,7 @@ 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"
@ -70,3 +77,4 @@ 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
======================= ====================================

View File

@ -1,5 +1,5 @@
Kernel Driver Lochnagar
========================
=======================
Supported systems:
* Cirrus Logic : Lochnagar 2
@ -21,6 +21,7 @@ by software.
Sysfs attributes
----------------
======================= =======================================================
temp1_input The Lochnagar board temperature (milliCelsius)
in0_input Measured voltage for DBVDD1 (milliVolts)
in0_label "DBVDD1"
@ -76,5 +77,7 @@ 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.
Note:
It is not possible to measure voltage on the SYSVDD rail.