summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-04-22 13:39:37 -0400
committerGuenter Roeck <linux@roeck-us.net>2019-04-22 18:27:27 -0400
commite57695e772e87e270ee451483b76ba1ccc1f1cfc (patch)
treed17674606f76876c4b614e65af2c9f1d56f9612b /Documentation/hwmon
parent4f8d374b770a2e26088186d6c18acf582227129d (diff)
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>
Diffstat (limited to 'Documentation/hwmon')
-rw-r--r--Documentation/hwmon/index.rst3
-rw-r--r--Documentation/hwmon/ir38064.rst (renamed from Documentation/hwmon/ir38064)21
-rw-r--r--Documentation/hwmon/isl68137.rst (renamed from Documentation/hwmon/isl68137)16
-rw-r--r--Documentation/hwmon/lochnagar.rst (renamed from Documentation/hwmon/lochnagar)7
4 files changed, 33 insertions, 14 deletions
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
index 893804414510..3fa14fe7b49c 100644
--- a/Documentation/hwmon/index.rst
+++ b/Documentation/hwmon/index.rst
@@ -65,6 +65,8 @@ Hardware Monitoring Kernel Drivers
65 ina2xx.rst 65 ina2xx.rst
66 ina3221.rst 66 ina3221.rst
67 ir35221.rst 67 ir35221.rst
68 ir38064.rst
69 isl68137.rst
68 it87.rst 70 it87.rst
69 jc42.rst 71 jc42.rst
70 k10temp.rst 72 k10temp.rst
@@ -86,6 +88,7 @@ Hardware Monitoring Kernel Drivers
86 lm93.rst 88 lm93.rst
87 lm95234.rst 89 lm95234.rst
88 lm95245.rst 90 lm95245.rst
91 lochnagar.rst
89 ltc2945.rst 92 ltc2945.rst
90 ltc2978.rst 93 ltc2978.rst
91 ltc2990.rst 94 ltc2990.rst
diff --git a/Documentation/hwmon/ir38064 b/Documentation/hwmon/ir38064.rst
index 9f218c39bfe6..c455d755a267 100644
--- a/Documentation/hwmon/ir38064
+++ b/Documentation/hwmon/ir38064.rst
@@ -2,15 +2,18 @@ Kernel driver ir38064
2===================== 2=====================
3 3
4Supported chips: 4Supported chips:
5
5 * Infineon IR38064 6 * Infineon IR38064
7
6 Prefix: 'ir38064' 8 Prefix: 'ir38064'
7 Addresses scanned: - 9 Addresses scanned: -
10
8 Datasheet: Publicly available at the Infineon webiste 11 Datasheet: Publicly available at the Infineon webiste
9 https://www.infineon.com/dgdl/Infineon-IR38064MTRPBF-DS-v03_07-EN.pdf?fileId=5546d462584d1d4a0158db0d9efb67ca 12 https://www.infineon.com/dgdl/Infineon-IR38064MTRPBF-DS-v03_07-EN.pdf?fileId=5546d462584d1d4a0158db0d9efb67ca
10 13
11Authors: 14Authors:
12 Maxim Sloyko <maxims@google.com> 15 - Maxim Sloyko <maxims@google.com>
13 Patrick Venture <venture@google.com> 16 - Patrick Venture <venture@google.com>
14 17
15Description 18Description
16----------- 19-----------
@@ -26,29 +29,30 @@ devices explicitly.
26Sysfs attributes 29Sysfs attributes
27---------------- 30----------------
28 31
32======================= ===========================
29curr1_label "iout1" 33curr1_label "iout1"
30curr1_input Measured output current 34curr1_input Measured output current
31curr1_crit Critical maximum current 35curr1_crit Critical maximum current
32curr1_crit_alarm Current critical high alarm 36curr1_crit_alarm Current critical high alarm
33curr1_max Maximum current 37curr1_max Maximum current
34curr1_max_alarm Current high alarm 38curr1_max_alarm Current high alarm
35 39
36in1_label "vin" 40in1_label "vin"
37in1_input Measured input voltage 41in1_input Measured input voltage
38in1_crit Critical maximum input voltage 42in1_crit Critical maximum input voltage
39in1_crit_alarm Input voltage critical high alarm 43in1_crit_alarm Input voltage critical high alarm
40in1_min Minimum input voltage 44in1_min Minimum input voltage
41in1_min_alarm Input voltage low alarm 45in1_min_alarm Input voltage low alarm
42 46
43in2_label "vout1" 47in2_label "vout1"
44in2_input Measured output voltage 48in2_input Measured output voltage
45in2_lcrit Critical minimum output voltage 49in2_lcrit Critical minimum output voltage
46in2_lcrit_alarm Output voltage critical low alarm 50in2_lcrit_alarm Output voltage critical low alarm
47in2_crit Critical maximum output voltage 51in2_crit Critical maximum output voltage
48in2_crit_alarm Output voltage critical high alarm 52in2_crit_alarm Output voltage critical high alarm
49in2_max Maximum output voltage 53in2_max Maximum output voltage
50in2_max_alarm Output voltage high alarm 54in2_max_alarm Output voltage high alarm
51in2_min Minimum output voltage 55in2_min Minimum output voltage
52in2_min_alarm Output voltage low alarm 56in2_min_alarm Output voltage low alarm
53 57
54power1_label "pout1" 58power1_label "pout1"
@@ -58,4 +62,5 @@ temp1_input Measured temperature
58temp1_crit Critical high temperature 62temp1_crit Critical high temperature
59temp1_crit_alarm Chip temperature critical high alarm 63temp1_crit_alarm Chip temperature critical high alarm
60temp1_max Maximum temperature 64temp1_max Maximum temperature
61temp1_max_alarm Chip temperature high alarm 65temp1_max_alarm Chip temperature high alarm
66======================= ===========================
diff --git a/Documentation/hwmon/isl68137 b/Documentation/hwmon/isl68137.rst
index 92e5c5fc5b77..a5a7c8545c9e 100644
--- a/Documentation/hwmon/isl68137
+++ b/Documentation/hwmon/isl68137.rst
@@ -2,16 +2,22 @@ Kernel driver isl68137
2====================== 2======================
3 3
4Supported chips: 4Supported chips:
5
5 * Intersil ISL68137 6 * Intersil ISL68137
7
6 Prefix: 'isl68137' 8 Prefix: 'isl68137'
9
7 Addresses scanned: - 10 Addresses scanned: -
8 Datasheet: Publicly available at the Intersil website 11
12 Datasheet:
13
14 Publicly available at the Intersil website
9 https://www.intersil.com/content/dam/Intersil/documents/isl6/isl68137.pdf 15 https://www.intersil.com/content/dam/Intersil/documents/isl6/isl68137.pdf
10 16
11Authors: 17Authors:
12 Maxim Sloyko <maxims@google.com> 18 - Maxim Sloyko <maxims@google.com>
13 Robert Lippert <rlippert@google.com> 19 - Robert Lippert <rlippert@google.com>
14 Patrick Venture <venture@google.com> 20 - Patrick Venture <venture@google.com>
15 21
16Description 22Description
17----------- 23-----------
@@ -32,6 +38,7 @@ Beyond the normal sysfs pmbus attributes, the driver exposes a control attribute
32Additional Sysfs attributes 38Additional Sysfs attributes
33--------------------------- 39---------------------------
34 40
41======================= ====================================
35avs(0|1)_enable Controls the AVS state of each rail. 42avs(0|1)_enable Controls the AVS state of each rail.
36 43
37curr1_label "iin" 44curr1_label "iin"
@@ -70,3 +77,4 @@ temp[1-3]_crit Critical high temperature
70temp[1-3]_crit_alarm Chip temperature critical high alarm 77temp[1-3]_crit_alarm Chip temperature critical high alarm
71temp[1-3]_max Maximum temperature 78temp[1-3]_max Maximum temperature
72temp[1-3]_max_alarm Chip temperature high alarm 79temp[1-3]_max_alarm Chip temperature high alarm
80======================= ====================================
diff --git a/Documentation/hwmon/lochnagar b/Documentation/hwmon/lochnagar.rst
index e9686fb3eb40..1d609c4d18c3 100644
--- a/Documentation/hwmon/lochnagar
+++ b/Documentation/hwmon/lochnagar.rst
@@ -1,5 +1,5 @@
1Kernel Driver Lochnagar 1Kernel Driver Lochnagar
2======================== 2=======================
3 3
4Supported systems: 4Supported systems:
5 * Cirrus Logic : Lochnagar 2 5 * Cirrus Logic : Lochnagar 2
@@ -21,6 +21,7 @@ by software.
21Sysfs attributes 21Sysfs attributes
22---------------- 22----------------
23 23
24======================= =======================================================
24temp1_input The Lochnagar board temperature (milliCelsius) 25temp1_input The Lochnagar board temperature (milliCelsius)
25in0_input Measured voltage for DBVDD1 (milliVolts) 26in0_input Measured voltage for DBVDD1 (milliVolts)
26in0_label "DBVDD1" 27in0_label "DBVDD1"
@@ -76,5 +77,7 @@ curr8_label "MICVDD"
76power8_average Measured average power for MICVDD (microWatts) 77power8_average Measured average power for MICVDD (microWatts)
77power8_average_interval Power averaging time input valid from 1 to 1708mS 78power8_average_interval Power averaging time input valid from 1 to 1708mS
78power8_label "MICVDD" 79power8_label "MICVDD"
80======================= =======================================================
79 81
80Note: It is not possible to measure voltage on the SYSVDD rail. 82Note:
83 It is not possible to measure voltage on the SYSVDD rail.