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