Merge tag 'bitmain-soc-5.2' of git://git.kernel.org/pub/scm/linux/kernel/git/mani...
[sfrench/cifs-2.6.git] / Documentation / hwmon / adt7410
1 Kernel driver adt7410
2 =====================
3
4 Supported chips:
5   * Analog Devices ADT7410
6     Prefix: 'adt7410'
7     Addresses scanned: None
8     Datasheet: Publicly available at the Analog Devices website
9                http://www.analog.com/static/imported-files/data_sheets/ADT7410.pdf
10   * Analog Devices ADT7420
11     Prefix: 'adt7420'
12     Addresses scanned: None
13     Datasheet: Publicly available at the Analog Devices website
14                http://www.analog.com/static/imported-files/data_sheets/ADT7420.pdf
15   * Analog Devices ADT7310
16     Prefix: 'adt7310'
17     Addresses scanned: None
18     Datasheet: Publicly available at the Analog Devices website
19                http://www.analog.com/static/imported-files/data_sheets/ADT7310.pdf
20   * Analog Devices ADT7320
21     Prefix: 'adt7320'
22     Addresses scanned: None
23     Datasheet: Publicly available at the Analog Devices website
24                http://www.analog.com/static/imported-files/data_sheets/ADT7320.pdf
25
26 Author: Hartmut Knaack <knaack.h@gmx.de>
27
28 Description
29 -----------
30
31 The ADT7310/ADT7410 is a temperature sensor with rated temperature range of
32 -55°C to +150°C. It has a high accuracy of +/-0.5°C and can be operated at a
33 resolution of 13 bits (0.0625°C) or 16 bits (0.0078°C). The sensor provides an
34 INT pin to indicate that a minimum or maximum temperature set point has been
35 exceeded, as well as a critical temperature (CT) pin to indicate that the
36 critical temperature set point has been exceeded. Both pins can be set up with a
37 common hysteresis of 0°C - 15°C and a fault queue, ranging from 1 to 4 events.
38 Both pins can individually set to be active-low or active-high, while the whole
39 device can either run in comparator mode or interrupt mode. The ADT7410 supports
40 continuous temperature sampling, as well as sampling one temperature value per
41 second or even just get one sample on demand for power saving. Besides, it can
42 completely power down its ADC, if power management is required.
43
44 The ADT7320/ADT7420 is register compatible, the only differences being the
45 package, a slightly narrower operating temperature range (-40°C to +150°C), and
46 a better accuracy (0.25°C instead of 0.50°C.)
47
48 The difference between the ADT7310/ADT7320 and ADT7410/ADT7420 is the control
49 interface, the ADT7310 and ADT7320 use SPI while the ADT7410 and ADT7420 use
50 I2C.
51
52 Configuration Notes
53 -------------------
54
55 Since the device uses one hysteresis value, which is an offset to minimum,
56 maximum and critical temperature, it can only be set for temp#_max_hyst.
57 However, temp#_min_hyst and temp#_crit_hyst show their corresponding
58 hysteresis.
59 The device is set to 16 bit resolution and comparator mode.
60
61 sysfs-Interface
62 ---------------
63
64 temp#_input             - temperature input
65 temp#_min               - temperature minimum setpoint
66 temp#_max               - temperature maximum setpoint
67 temp#_crit              - critical temperature setpoint
68 temp#_min_hyst          - hysteresis for temperature minimum (read-only)
69 temp#_max_hyst          - hysteresis for temperature maximum (read/write)
70 temp#_crit_hyst         - hysteresis for critical temperature (read-only)
71 temp#_min_alarm         - temperature minimum alarm flag
72 temp#_max_alarm         - temperature maximum alarm flag
73 temp#_crit_alarm        - critical temperature alarm flag