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