xref: /linux/Documentation/hwmon/nct6683.rst (revision 24bce201d79807b668bf9d9e0aca801c5c0d5f78)
1Kernel driver nct6683
2=====================
3
4Supported chips:
5
6  * Nuvoton NCT6683D/NCT6687D
7
8    Prefix: 'nct6683'
9
10    Addresses scanned: ISA address retrieved from Super I/O registers
11
12    Datasheet: Available from Nuvoton upon request
13
14Authors:
15
16	Guenter Roeck <linux@roeck-us.net>
17
18Description
19-----------
20
21This driver implements support for the Nuvoton NCT6683D eSIO chip.
22
23The chips implement up to shared 32 temperature and voltage sensors.
24It supports up to 16 fan rotation sensors and up to 8 fan control engines.
25
26Temperatures are measured in degrees Celsius. Measurement resolution is
270.5 degrees C.
28
29Voltage sensors (also known as IN sensors) report their values in millivolts.
30
31Fan rotation speeds are reported in RPM (rotations per minute).
32
33Usage Note
34----------
35
36Limit register locations on Intel boards with EC firmware version 1.0
37build date 04/03/13 do not match the register locations in the Nuvoton
38datasheet. Nuvoton confirms that Intel uses a special firmware version
39with different register addresses. The specification describing the Intel
40firmware is held under NDA by Nuvoton and Intel and not available
41to the public.
42
43Some of the register locations can be reverse engineered; others are too
44well hidden. Given this, writing any values from the operating system is
45considered too risky with this firmware and has been disabled. All limits
46must all be written from the BIOS.
47
48The driver has only been tested with the Intel firmware, and by default
49only instantiates on Intel boards. To enable it on non-Intel boards,
50set the 'force' module parameter to 1.
51
52Tested Boards and Firmware Versions
53-----------------------------------
54
55The driver has been reported to work with the following boards and
56firmware versions.
57
58=============== ===============================================
59Board		Firmware version
60=============== ===============================================
61Intel DH87RL	NCT6683D EC firmware version 1.0 build 04/03/13
62Intel DH87MC	NCT6683D EC firmware version 1.0 build 04/03/13
63Intel DB85FL	NCT6683D EC firmware version 1.0 build 04/03/13
64ASRock X570	NCT6683D EC firmware version 1.0 build 06/28/19
65MSI B550	NCT6687D EC firmware version 1.0 build 05/07/20
66=============== ===============================================
67