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>hifive-unleashed-5.2
parent
a4710b7219
commit
1288cfe043
|
@ -1,10 +1,15 @@
|
||||||
|
=====================
|
||||||
Kernel driver asc7621
|
Kernel driver asc7621
|
||||||
==================
|
=====================
|
||||||
|
|
||||||
Supported chips:
|
Supported chips:
|
||||||
|
|
||||||
Andigilog aSC7621 and aSC7621a
|
Andigilog aSC7621 and aSC7621a
|
||||||
|
|
||||||
Prefix: 'asc7621'
|
Prefix: 'asc7621'
|
||||||
|
|
||||||
Addresses scanned: I2C 0x2c, 0x2d, 0x2e
|
Addresses scanned: I2C 0x2c, 0x2d, 0x2e
|
||||||
|
|
||||||
Datasheet: http://www.fairview5.com/linux/asc7621/asc7621.pdf
|
Datasheet: http://www.fairview5.com/linux/asc7621/asc7621.pdf
|
||||||
|
|
||||||
Author:
|
Author:
|
||||||
|
@ -73,8 +78,10 @@ Finally, we have added a tach disable function that turns off the tach
|
||||||
measurement system for individual tachs in order to save power. That is
|
measurement system for individual tachs in order to save power. That is
|
||||||
in register 75h.
|
in register 75h.
|
||||||
|
|
||||||
--
|
--------------------------------------------------------------------------
|
||||||
|
|
||||||
aSC7621 Product Description
|
aSC7621 Product Description
|
||||||
|
===========================
|
||||||
|
|
||||||
The aSC7621 has a two wire digital interface compatible with SMBus 2.0.
|
The aSC7621 has a two wire digital interface compatible with SMBus 2.0.
|
||||||
Using a 10-bit ADC, the aSC7621 measures the temperature of two remote diode
|
Using 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
|
||||||
monitored efficiently with internal scaling resistors.
|
monitored efficiently with internal scaling resistors.
|
||||||
|
|
||||||
Features
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
- Supports PECI interface and monitors internal and remote thermal diodes
|
- Supports PECI interface and monitors internal and remote thermal diodes
|
||||||
- 2-wire, SMBus 2.0 compliant, serial interface
|
- 2-wire, SMBus 2.0 compliant, serial interface
|
||||||
- 10-bit ADC
|
- 10-bit ADC
|
||||||
|
@ -110,7 +119,7 @@ Features
|
||||||
- Noise filtering of temperature reading for fan speed control
|
- Noise filtering of temperature reading for fan speed control
|
||||||
- 0.25C digital temperature sensor resolution
|
- 0.25C digital temperature sensor resolution
|
||||||
- 3 PWM fan speed control outputs for 2-, 3- or 4-wire fans and up to 4 fan
|
- 3 PWM fan speed control outputs for 2-, 3- or 4-wire fans and up to 4 fan
|
||||||
tachometer inputs
|
tachometer inputs
|
||||||
- Enhanced measured temperature to Temperature Zone assignment.
|
- Enhanced measured temperature to Temperature Zone assignment.
|
||||||
- Provides high and low PWM frequency ranges
|
- Provides high and low PWM frequency ranges
|
||||||
- 3 GPIO pins for custom use
|
- 3 GPIO pins for custom use
|
||||||
|
@ -123,17 +132,20 @@ Except where noted below, the sysfs entries created by this driver follow
|
||||||
the standards defined in "sysfs-interface".
|
the standards defined in "sysfs-interface".
|
||||||
|
|
||||||
temp1_source
|
temp1_source
|
||||||
|
= ===============================================
|
||||||
0 (default) peci_legacy = 0, Remote 1 Temperature
|
0 (default) peci_legacy = 0, Remote 1 Temperature
|
||||||
peci_legacy = 1, PECI Processor Temperature 0
|
peci_legacy = 1, PECI Processor Temperature 0
|
||||||
1 Remote 1 Temperature
|
1 Remote 1 Temperature
|
||||||
2 Remote 2 Temperature
|
2 Remote 2 Temperature
|
||||||
3 Internal Temperature
|
3 Internal Temperature
|
||||||
4 PECI Processor Temperature 0
|
4 PECI Processor Temperature 0
|
||||||
5 PECI Processor Temperature 1
|
5 PECI Processor Temperature 1
|
||||||
6 PECI Processor Temperature 2
|
6 PECI Processor Temperature 2
|
||||||
7 PECI Processor Temperature 3
|
7 PECI Processor Temperature 3
|
||||||
|
= ===============================================
|
||||||
|
|
||||||
temp2_source
|
temp2_source
|
||||||
|
= ===============================================
|
||||||
0 (default) Internal Temperature
|
0 (default) Internal Temperature
|
||||||
1 Remote 1 Temperature
|
1 Remote 1 Temperature
|
||||||
2 Remote 2 Temperature
|
2 Remote 2 Temperature
|
||||||
|
@ -142,8 +154,10 @@ temp2_source
|
||||||
5 PECI Processor Temperature 1
|
5 PECI Processor Temperature 1
|
||||||
6 PECI Processor Temperature 2
|
6 PECI Processor Temperature 2
|
||||||
7 PECI Processor Temperature 3
|
7 PECI Processor Temperature 3
|
||||||
|
= ===============================================
|
||||||
|
|
||||||
temp3_source
|
temp3_source
|
||||||
|
= ===============================================
|
||||||
0 (default) Remote 2 Temperature
|
0 (default) Remote 2 Temperature
|
||||||
1 Remote 1 Temperature
|
1 Remote 1 Temperature
|
||||||
2 Remote 2 Temperature
|
2 Remote 2 Temperature
|
||||||
|
@ -152,10 +166,12 @@ temp3_source
|
||||||
5 PECI Processor Temperature 1
|
5 PECI Processor Temperature 1
|
||||||
6 PECI Processor Temperature 2
|
6 PECI Processor Temperature 2
|
||||||
7 PECI Processor Temperature 3
|
7 PECI Processor Temperature 3
|
||||||
|
= ===============================================
|
||||||
|
|
||||||
temp4_source
|
temp4_source
|
||||||
|
= ===============================================
|
||||||
0 (default) peci_legacy = 0, PECI Processor Temperature 0
|
0 (default) peci_legacy = 0, PECI Processor Temperature 0
|
||||||
peci_legacy = 1, Remote 1 Temperature
|
peci_legacy = 1, Remote 1 Temperature
|
||||||
1 Remote 1 Temperature
|
1 Remote 1 Temperature
|
||||||
2 Remote 2 Temperature
|
2 Remote 2 Temperature
|
||||||
3 Internal Temperature
|
3 Internal Temperature
|
||||||
|
@ -163,58 +179,65 @@ temp4_source
|
||||||
5 PECI Processor Temperature 1
|
5 PECI Processor Temperature 1
|
||||||
6 PECI Processor Temperature 2
|
6 PECI Processor Temperature 2
|
||||||
7 PECI Processor Temperature 3
|
7 PECI Processor Temperature 3
|
||||||
|
= ===============================================
|
||||||
|
|
||||||
temp[1-4]_smoothing_enable
|
temp[1-4]_smoothing_enable / temp[1-4]_smoothing_time
|
||||||
temp[1-4]_smoothing_time
|
|
||||||
Smooths spikes in temp readings caused by noise.
|
Smooths spikes in temp readings caused by noise.
|
||||||
Valid values in milliseconds are:
|
Valid values in milliseconds are:
|
||||||
35000
|
|
||||||
17600
|
* 35000
|
||||||
11800
|
* 17600
|
||||||
7000
|
* 11800
|
||||||
4400
|
* 7000
|
||||||
3000
|
* 4400
|
||||||
1600
|
* 3000
|
||||||
800
|
* 1600
|
||||||
|
* 800
|
||||||
|
|
||||||
temp[1-4]_crit
|
temp[1-4]_crit
|
||||||
When the corresponding zone temperature reaches this value,
|
When the corresponding zone temperature reaches this value,
|
||||||
ALL pwm outputs will got to 100%.
|
ALL pwm outputs will got to 100%.
|
||||||
|
|
||||||
temp[5-8]_input
|
temp[5-8]_input / temp[5-8]_enable
|
||||||
temp[5-8]_enable
|
|
||||||
The aSC7621 can also read temperatures provided by the processor
|
The aSC7621 can also read temperatures provided by the processor
|
||||||
via the PECI bus. Usually these are "core" temps and are relative
|
via the PECI bus. Usually these are "core" temps and are relative
|
||||||
to the point where the automatic thermal control circuit starts
|
to the point where the automatic thermal control circuit starts
|
||||||
throttling. This means that these are usually negative numbers.
|
throttling. This means that these are usually negative numbers.
|
||||||
|
|
||||||
pwm[1-3]_enable
|
pwm[1-3]_enable
|
||||||
|
=============== ========================================================
|
||||||
0 Fan off.
|
0 Fan off.
|
||||||
1 Fan on manual control.
|
1 Fan on manual control.
|
||||||
2 Fan on automatic control and will run at the minimum pwm
|
2 Fan on automatic control and will run at the minimum pwm
|
||||||
if the temperature for the zone is below the minimum.
|
if the temperature for the zone is below the minimum.
|
||||||
3 Fan on automatic control but will be off if the temperature
|
3 Fan on automatic control but will be off if the
|
||||||
for the zone is below the minimum.
|
temperature for the zone is below the minimum.
|
||||||
4-254 Ignored.
|
4-254 Ignored.
|
||||||
255 Fan on full.
|
255 Fan on full.
|
||||||
|
=============== ========================================================
|
||||||
|
|
||||||
pwm[1-3]_auto_channels
|
pwm[1-3]_auto_channels
|
||||||
Bitmap as described in sysctl-interface with the following
|
Bitmap as described in sysctl-interface with the following
|
||||||
exceptions...
|
exceptions...
|
||||||
|
|
||||||
Only the following combination of zones (and their corresponding masks)
|
Only the following combination of zones (and their corresponding masks)
|
||||||
are valid:
|
are valid:
|
||||||
1
|
|
||||||
2
|
|
||||||
3
|
|
||||||
2,3
|
|
||||||
1,2,3
|
|
||||||
4
|
|
||||||
1,2,3,4
|
|
||||||
|
|
||||||
Special values:
|
* 1
|
||||||
0 Disabled.
|
* 2
|
||||||
16 Fan on manual control.
|
* 3
|
||||||
31 Fan on full.
|
* 2,3
|
||||||
|
* 1,2,3
|
||||||
|
* 4
|
||||||
|
* 1,2,3,4
|
||||||
|
|
||||||
|
* Special values:
|
||||||
|
|
||||||
|
== ======================
|
||||||
|
0 Disabled.
|
||||||
|
16 Fan on manual control.
|
||||||
|
31 Fan on full.
|
||||||
|
== ======================
|
||||||
|
|
||||||
|
|
||||||
pwm[1-3]_invert
|
pwm[1-3]_invert
|
||||||
|
@ -226,22 +249,22 @@ pwm[1-3]_freq
|
||||||
PWM frequency in Hz
|
PWM frequency in Hz
|
||||||
Valid values in Hz are:
|
Valid values in Hz are:
|
||||||
|
|
||||||
10
|
* 10
|
||||||
15
|
* 15
|
||||||
23
|
* 23
|
||||||
30 (default)
|
* 30 (default)
|
||||||
38
|
* 38
|
||||||
47
|
* 47
|
||||||
62
|
* 62
|
||||||
94
|
* 94
|
||||||
23000
|
* 23000
|
||||||
24000
|
* 24000
|
||||||
25000
|
* 25000
|
||||||
26000
|
* 26000
|
||||||
27000
|
* 27000
|
||||||
28000
|
* 28000
|
||||||
29000
|
* 29000
|
||||||
30000
|
* 30000
|
||||||
|
|
||||||
Setting any other value will be ignored.
|
Setting any other value will be ignored.
|
||||||
|
|
||||||
|
@ -251,17 +274,17 @@ peci_enable
|
||||||
peci_avg
|
peci_avg
|
||||||
Input filter average time.
|
Input filter average time.
|
||||||
|
|
||||||
0 0 Sec. (no Smoothing) (default)
|
* 0 0 Sec. (no Smoothing) (default)
|
||||||
1 0.25 Sec.
|
* 1 0.25 Sec.
|
||||||
2 0.5 Sec.
|
* 2 0.5 Sec.
|
||||||
3 1.0 Sec.
|
* 3 1.0 Sec.
|
||||||
4 2.0 Sec.
|
* 4 2.0 Sec.
|
||||||
5 4.0 Sec.
|
* 5 4.0 Sec.
|
||||||
6 8.0 Sec.
|
* 6 8.0 Sec.
|
||||||
7 0.0 Sec.
|
* 7 0.0 Sec.
|
||||||
|
|
||||||
peci_legacy
|
peci_legacy
|
||||||
|
= ============================================
|
||||||
0 Standard Mode (default)
|
0 Standard Mode (default)
|
||||||
Remote Diode 1 reading is associated with
|
Remote Diode 1 reading is associated with
|
||||||
Temperature Zone 1, PECI is associated with
|
Temperature Zone 1, PECI is associated with
|
||||||
|
@ -270,10 +293,12 @@ peci_legacy
|
||||||
1 Legacy Mode
|
1 Legacy Mode
|
||||||
PECI is associated with Temperature Zone 1,
|
PECI is associated with Temperature Zone 1,
|
||||||
Remote Diode 1 is associated with Zone 4
|
Remote Diode 1 is associated with Zone 4
|
||||||
|
= ============================================
|
||||||
|
|
||||||
peci_diode
|
peci_diode
|
||||||
Diode filter
|
Diode filter
|
||||||
|
|
||||||
|
= ====================
|
||||||
0 0.25 Sec.
|
0 0.25 Sec.
|
||||||
1 1.1 Sec.
|
1 1.1 Sec.
|
||||||
2 2.4 Sec. (default)
|
2 2.4 Sec. (default)
|
||||||
|
@ -282,15 +307,20 @@ peci_diode
|
||||||
5 6.8 Sec.
|
5 6.8 Sec.
|
||||||
6 10.2 Sec.
|
6 10.2 Sec.
|
||||||
7 16.4 Sec.
|
7 16.4 Sec.
|
||||||
|
= ====================
|
||||||
|
|
||||||
peci_4domain
|
peci_4domain
|
||||||
Four domain enable
|
Four domain enable
|
||||||
|
|
||||||
|
= ===============================================
|
||||||
0 1 or 2 Domains for enabled processors (default)
|
0 1 or 2 Domains for enabled processors (default)
|
||||||
1 3 or 4 Domains for enabled processors
|
1 3 or 4 Domains for enabled processors
|
||||||
|
= ===============================================
|
||||||
|
|
||||||
peci_domain
|
peci_domain
|
||||||
Domain
|
Domain
|
||||||
|
|
||||||
|
= ==================================================
|
||||||
0 Processor contains a single domain (0) (default)
|
0 Processor contains a single domain (0) (default)
|
||||||
1 Processor contains two domains (0,1)
|
1 Processor contains two domains (0,1)
|
||||||
|
= ==================================================
|
||||||
|
|
Loading…
Reference in New Issue