summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-04-17 05:46:20 -0400
committerGuenter Roeck <linux@roeck-us.net>2019-04-17 12:51:03 -0400
commit1288cfe0437e3affee6cccc68e288eb6492c1f8b (patch)
tree458489e9733363e26d500996cecea290212b1f26 /Documentation/hwmon
parenta4710b72190a5ee1953ffba60cdbdced52a28466 (diff)
docs: hwmon: asc7621: convert to ReST format
Convert asc7621 to ReST format, in order to allow it to be parsed by Sphinx. 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/asc7621146
1 files changed, 88 insertions, 58 deletions
diff --git a/Documentation/hwmon/asc7621 b/Documentation/hwmon/asc7621
index 7287be7e1f21..b5a9fad0f172 100644
--- a/Documentation/hwmon/asc7621
+++ b/Documentation/hwmon/asc7621
@@ -1,10 +1,15 @@
1=====================
1Kernel driver asc7621 2Kernel driver asc7621
2================== 3=====================
3 4
4Supported chips: 5Supported chips:
6
5 Andigilog aSC7621 and aSC7621a 7 Andigilog aSC7621 and aSC7621a
8
6 Prefix: 'asc7621' 9 Prefix: 'asc7621'
10
7 Addresses scanned: I2C 0x2c, 0x2d, 0x2e 11 Addresses scanned: I2C 0x2c, 0x2d, 0x2e
12
8 Datasheet: http://www.fairview5.com/linux/asc7621/asc7621.pdf 13 Datasheet: http://www.fairview5.com/linux/asc7621/asc7621.pdf
9 14
10Author: 15Author:
@@ -73,8 +78,10 @@ Finally, we have added a tach disable function that turns off the tach
73measurement system for individual tachs in order to save power. That is 78measurement system for individual tachs in order to save power. That is
74in register 75h. 79in register 75h.
75 80
76-- 81--------------------------------------------------------------------------
82
77aSC7621 Product Description 83aSC7621 Product Description
84===========================
78 85
79The aSC7621 has a two wire digital interface compatible with SMBus 2.0. 86The aSC7621 has a two wire digital interface compatible with SMBus 2.0.
80Using a 10-bit ADC, the aSC7621 measures the temperature of two remote diode 87Using a 10-bit ADC, the aSC7621 measures the temperature of two remote diode
@@ -102,6 +109,8 @@ System voltages of VCCP, 2.5V, 3.3V, 5.0V, and 12V motherboard power are
102monitored efficiently with internal scaling resistors. 109monitored efficiently with internal scaling resistors.
103 110
104Features 111Features
112--------
113
105- Supports PECI interface and monitors internal and remote thermal diodes 114- Supports PECI interface and monitors internal and remote thermal diodes
106- 2-wire, SMBus 2.0 compliant, serial interface 115- 2-wire, SMBus 2.0 compliant, serial interface
107- 10-bit ADC 116- 10-bit ADC
@@ -110,7 +119,7 @@ Features
110- Noise filtering of temperature reading for fan speed control 119- Noise filtering of temperature reading for fan speed control
111- 0.25C digital temperature sensor resolution 120- 0.25C digital temperature sensor resolution
112- 3 PWM fan speed control outputs for 2-, 3- or 4-wire fans and up to 4 fan 121- 3 PWM fan speed control outputs for 2-, 3- or 4-wire fans and up to 4 fan
113 tachometer inputs 122 tachometer inputs
114- Enhanced measured temperature to Temperature Zone assignment. 123- Enhanced measured temperature to Temperature Zone assignment.
115- Provides high and low PWM frequency ranges 124- Provides high and low PWM frequency ranges
116- 3 GPIO pins for custom use 125- 3 GPIO pins for custom use
@@ -123,17 +132,20 @@ Except where noted below, the sysfs entries created by this driver follow
123the standards defined in "sysfs-interface". 132the standards defined in "sysfs-interface".
124 133
125temp1_source 134temp1_source
135 = ===============================================
126 0 (default) peci_legacy = 0, Remote 1 Temperature 136 0 (default) peci_legacy = 0, Remote 1 Temperature
127 peci_legacy = 1, PECI Processor Temperature 0 137 peci_legacy = 1, PECI Processor Temperature 0
128 1 Remote 1 Temperature 138 1 Remote 1 Temperature
129 2 Remote 2 Temperature 139 2 Remote 2 Temperature
130 3 Internal Temperature 140 3 Internal Temperature
131 4 PECI Processor Temperature 0 141 4 PECI Processor Temperature 0
132 5 PECI Processor Temperature 1 142 5 PECI Processor Temperature 1
133 6 PECI Processor Temperature 2 143 6 PECI Processor Temperature 2
134 7 PECI Processor Temperature 3 144 7 PECI Processor Temperature 3
145 = ===============================================
135 146
136temp2_source 147temp2_source
148 = ===============================================
137 0 (default) Internal Temperature 149 0 (default) Internal Temperature
138 1 Remote 1 Temperature 150 1 Remote 1 Temperature
139 2 Remote 2 Temperature 151 2 Remote 2 Temperature
@@ -142,8 +154,10 @@ temp2_source
142 5 PECI Processor Temperature 1 154 5 PECI Processor Temperature 1
143 6 PECI Processor Temperature 2 155 6 PECI Processor Temperature 2
144 7 PECI Processor Temperature 3 156 7 PECI Processor Temperature 3
157 = ===============================================
145 158
146temp3_source 159temp3_source
160 = ===============================================
147 0 (default) Remote 2 Temperature 161 0 (default) Remote 2 Temperature
148 1 Remote 1 Temperature 162 1 Remote 1 Temperature
149 2 Remote 2 Temperature 163 2 Remote 2 Temperature
@@ -152,10 +166,12 @@ temp3_source
152 5 PECI Processor Temperature 1 166 5 PECI Processor Temperature 1
153 6 PECI Processor Temperature 2 167 6 PECI Processor Temperature 2
154 7 PECI Processor Temperature 3 168 7 PECI Processor Temperature 3
169 = ===============================================
155 170
156temp4_source 171temp4_source
172 = ===============================================
157 0 (default) peci_legacy = 0, PECI Processor Temperature 0 173 0 (default) peci_legacy = 0, PECI Processor Temperature 0
158 peci_legacy = 1, Remote 1 Temperature 174 peci_legacy = 1, Remote 1 Temperature
159 1 Remote 1 Temperature 175 1 Remote 1 Temperature
160 2 Remote 2 Temperature 176 2 Remote 2 Temperature
161 3 Internal Temperature 177 3 Internal Temperature
@@ -163,58 +179,65 @@ temp4_source
163 5 PECI Processor Temperature 1 179 5 PECI Processor Temperature 1
164 6 PECI Processor Temperature 2 180 6 PECI Processor Temperature 2
165 7 PECI Processor Temperature 3 181 7 PECI Processor Temperature 3
182 = ===============================================
166 183
167temp[1-4]_smoothing_enable 184temp[1-4]_smoothing_enable / temp[1-4]_smoothing_time
168temp[1-4]_smoothing_time
169 Smooths spikes in temp readings caused by noise. 185 Smooths spikes in temp readings caused by noise.
170 Valid values in milliseconds are: 186 Valid values in milliseconds are:
171 35000 187
172 17600 188 * 35000
173 11800 189 * 17600
174 7000 190 * 11800
175 4400 191 * 7000
176 3000 192 * 4400
177 1600 193 * 3000
178 800 194 * 1600
195 * 800
179 196
180temp[1-4]_crit 197temp[1-4]_crit
181 When the corresponding zone temperature reaches this value, 198 When the corresponding zone temperature reaches this value,
182 ALL pwm outputs will got to 100%. 199 ALL pwm outputs will got to 100%.
183 200
184temp[5-8]_input 201temp[5-8]_input / temp[5-8]_enable
185temp[5-8]_enable
186 The aSC7621 can also read temperatures provided by the processor 202 The aSC7621 can also read temperatures provided by the processor
187 via the PECI bus. Usually these are "core" temps and are relative 203 via the PECI bus. Usually these are "core" temps and are relative
188 to the point where the automatic thermal control circuit starts 204 to the point where the automatic thermal control circuit starts
189 throttling. This means that these are usually negative numbers. 205 throttling. This means that these are usually negative numbers.
190 206
191pwm[1-3]_enable 207pwm[1-3]_enable
208 =============== ========================================================
192 0 Fan off. 209 0 Fan off.
193 1 Fan on manual control. 210 1 Fan on manual control.
194 2 Fan on automatic control and will run at the minimum pwm 211 2 Fan on automatic control and will run at the minimum pwm
195 if the temperature for the zone is below the minimum. 212 if the temperature for the zone is below the minimum.
196 3 Fan on automatic control but will be off if the temperature 213 3 Fan on automatic control but will be off if the
197 for the zone is below the minimum. 214 temperature for the zone is below the minimum.
198 4-254 Ignored. 215 4-254 Ignored.
199 255 Fan on full. 216 255 Fan on full.
217 =============== ========================================================
200 218
201pwm[1-3]_auto_channels 219pwm[1-3]_auto_channels
202 Bitmap as described in sysctl-interface with the following 220 Bitmap as described in sysctl-interface with the following
203 exceptions... 221 exceptions...
222
204 Only the following combination of zones (and their corresponding masks) 223 Only the following combination of zones (and their corresponding masks)
205 are valid: 224 are valid:
206 1
207 2
208 3
209 2,3
210 1,2,3
211 4
212 1,2,3,4
213 225
214 Special values: 226 * 1
215 0 Disabled. 227 * 2
216 16 Fan on manual control. 228 * 3
217 31 Fan on full. 229 * 2,3
230 * 1,2,3
231 * 4
232 * 1,2,3,4
233
234 * Special values:
235
236 == ======================
237 0 Disabled.
238 16 Fan on manual control.
239 31 Fan on full.
240 == ======================
218 241
219 242
220pwm[1-3]_invert 243pwm[1-3]_invert
@@ -226,22 +249,22 @@ pwm[1-3]_freq
226 PWM frequency in Hz 249 PWM frequency in Hz
227 Valid values in Hz are: 250 Valid values in Hz are:
228 251
229 10 252 * 10
230 15 253 * 15
231 23 254 * 23
232 30 (default) 255 * 30 (default)
233 38 256 * 38
234 47 257 * 47
235 62 258 * 62
236 94 259 * 94
237 23000 260 * 23000
238 24000 261 * 24000
239 25000 262 * 25000
240 26000 263 * 26000
241 27000 264 * 27000
242 28000 265 * 28000
243 29000 266 * 29000
244 30000 267 * 30000
245 268
246 Setting any other value will be ignored. 269 Setting any other value will be ignored.
247 270
@@ -251,17 +274,17 @@ peci_enable
251peci_avg 274peci_avg
252 Input filter average time. 275 Input filter average time.
253 276
254 0 0 Sec. (no Smoothing) (default) 277 * 0 0 Sec. (no Smoothing) (default)
255 1 0.25 Sec. 278 * 1 0.25 Sec.
256 2 0.5 Sec. 279 * 2 0.5 Sec.
257 3 1.0 Sec. 280 * 3 1.0 Sec.
258 4 2.0 Sec. 281 * 4 2.0 Sec.
259 5 4.0 Sec. 282 * 5 4.0 Sec.
260 6 8.0 Sec. 283 * 6 8.0 Sec.
261 7 0.0 Sec. 284 * 7 0.0 Sec.
262 285
263peci_legacy 286peci_legacy
264 287 = ============================================
265 0 Standard Mode (default) 288 0 Standard Mode (default)
266 Remote Diode 1 reading is associated with 289 Remote Diode 1 reading is associated with
267 Temperature Zone 1, PECI is associated with 290 Temperature Zone 1, PECI is associated with
@@ -270,10 +293,12 @@ peci_legacy
270 1 Legacy Mode 293 1 Legacy Mode
271 PECI is associated with Temperature Zone 1, 294 PECI is associated with Temperature Zone 1,
272 Remote Diode 1 is associated with Zone 4 295 Remote Diode 1 is associated with Zone 4
296 = ============================================
273 297
274peci_diode 298peci_diode
275 Diode filter 299 Diode filter
276 300
301 = ====================
277 0 0.25 Sec. 302 0 0.25 Sec.
278 1 1.1 Sec. 303 1 1.1 Sec.
279 2 2.4 Sec. (default) 304 2 2.4 Sec. (default)
@@ -282,15 +307,20 @@ peci_diode
282 5 6.8 Sec. 307 5 6.8 Sec.
283 6 10.2 Sec. 308 6 10.2 Sec.
284 7 16.4 Sec. 309 7 16.4 Sec.
310 = ====================
285 311
286peci_4domain 312peci_4domain
287 Four domain enable 313 Four domain enable
288 314
315 = ===============================================
289 0 1 or 2 Domains for enabled processors (default) 316 0 1 or 2 Domains for enabled processors (default)
290 1 3 or 4 Domains for enabled processors 317 1 3 or 4 Domains for enabled processors
318 = ===============================================
291 319
292peci_domain 320peci_domain
293 Domain 321 Domain
294 322
323 = ==================================================
295 0 Processor contains a single domain (0) (default) 324 0 Processor contains a single domain (0) (default)
296 1 Processor contains two domains (0,1) 325 1 Processor contains two domains (0,1)
326 = ==================================================