xref: /OK3568_Linux_fs/kernel/Documentation/hwmon/nct6683.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunKernel driver nct6683
2*4882a593Smuzhiyun=====================
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunSupported chips:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun  * Nuvoton NCT6683D
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun    Prefix: 'nct6683'
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun    Addresses scanned: ISA address retrieved from Super I/O registers
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun    Datasheet: Available from Nuvoton upon request
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunAuthors:
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun	Guenter Roeck <linux@roeck-us.net>
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunDescription
19*4882a593Smuzhiyun-----------
20*4882a593Smuzhiyun
21*4882a593SmuzhiyunThis driver implements support for the Nuvoton NCT6683D eSIO chip.
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunThe chips implement up to shared 32 temperature and voltage sensors.
24*4882a593SmuzhiyunIt supports up to 16 fan rotation sensors and up to 8 fan control engines.
25*4882a593Smuzhiyun
26*4882a593SmuzhiyunTemperatures are measured in degrees Celsius. Measurement resolution is
27*4882a593Smuzhiyun0.5 degrees C.
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunVoltage sensors (also known as IN sensors) report their values in millivolts.
30*4882a593Smuzhiyun
31*4882a593SmuzhiyunFan rotation speeds are reported in RPM (rotations per minute).
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunUsage Note
34*4882a593Smuzhiyun----------
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunLimit register locations on Intel boards with EC firmware version 1.0
37*4882a593Smuzhiyunbuild date 04/03/13 do not match the register locations in the Nuvoton
38*4882a593Smuzhiyundatasheet. Nuvoton confirms that Intel uses a special firmware version
39*4882a593Smuzhiyunwith different register addresses. The specification describing the Intel
40*4882a593Smuzhiyunfirmware is held under NDA by Nuvoton and Intel and not available
41*4882a593Smuzhiyunto the public.
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunSome of the register locations can be reverse engineered; others are too
44*4882a593Smuzhiyunwell hidden. Given this, writing any values from the operating system is
45*4882a593Smuzhiyunconsidered too risky with this firmware and has been disabled. All limits
46*4882a593Smuzhiyunmust all be written from the BIOS.
47*4882a593Smuzhiyun
48*4882a593SmuzhiyunThe driver has only been tested with the Intel firmware, and by default
49*4882a593Smuzhiyunonly instantiates on Intel boards. To enable it on non-Intel boards,
50*4882a593Smuzhiyunset the 'force' module parameter to 1.
51*4882a593Smuzhiyun
52*4882a593SmuzhiyunTested Boards and Firmware Versions
53*4882a593Smuzhiyun-----------------------------------
54*4882a593Smuzhiyun
55*4882a593SmuzhiyunThe driver has been reported to work with the following boards and
56*4882a593Smuzhiyunfirmware versions.
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun=============== ===============================================
59*4882a593SmuzhiyunBoard		Firmware version
60*4882a593Smuzhiyun=============== ===============================================
61*4882a593SmuzhiyunIntel DH87RL	NCT6683D EC firmware version 1.0 build 04/03/13
62*4882a593SmuzhiyunIntel DH87MC	NCT6683D EC firmware version 1.0 build 04/03/13
63*4882a593SmuzhiyunIntel DB85FL	NCT6683D EC firmware version 1.0 build 04/03/13
64*4882a593Smuzhiyun=============== ===============================================
65