treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / hwmon / adt7410.rst
blob24caaa83c8ec7336866ddd20e4d3e2244d165629
1 Kernel driver adt7410
2 =====================
4 Supported chips:
6   * Analog Devices ADT7410
8     Prefix: 'adt7410'
10     Addresses scanned: None
12     Datasheet: Publicly available at the Analog Devices website
14                http://www.analog.com/static/imported-files/data_sheets/ADT7410.pdf
15   * Analog Devices ADT7420
17     Prefix: 'adt7420'
19     Addresses scanned: None
21     Datasheet: Publicly available at the Analog Devices website
23                http://www.analog.com/static/imported-files/data_sheets/ADT7420.pdf
25   * Analog Devices ADT7310
27     Prefix: 'adt7310'
29     Addresses scanned: None
31     Datasheet: Publicly available at the Analog Devices website
33                http://www.analog.com/static/imported-files/data_sheets/ADT7310.pdf
35   * Analog Devices ADT7320
37     Prefix: 'adt7320'
39     Addresses scanned: None
41     Datasheet: Publicly available at the Analog Devices website
43                http://www.analog.com/static/imported-files/data_sheets/ADT7320.pdf
45 Author: Hartmut Knaack <knaack.h@gmx.de>
47 Description
48 -----------
50 The ADT7310/ADT7410 is a temperature sensor with rated temperature range of
51 -55°C to +150°C. It has a high accuracy of +/-0.5°C and can be operated at a
52 resolution of 13 bits (0.0625°C) or 16 bits (0.0078°C). The sensor provides an
53 INT pin to indicate that a minimum or maximum temperature set point has been
54 exceeded, as well as a critical temperature (CT) pin to indicate that the
55 critical temperature set point has been exceeded. Both pins can be set up with a
56 common hysteresis of 0°C - 15°C and a fault queue, ranging from 1 to 4 events.
57 Both pins can individually set to be active-low or active-high, while the whole
58 device can either run in comparator mode or interrupt mode. The ADT7410 supports
59 continuous temperature sampling, as well as sampling one temperature value per
60 second or even just get one sample on demand for power saving. Besides, it can
61 completely power down its ADC, if power management is required.
63 The ADT7320/ADT7420 is register compatible, the only differences being the
64 package, a slightly narrower operating temperature range (-40°C to +150°C), and
65 a better accuracy (0.25°C instead of 0.50°C.)
67 The difference between the ADT7310/ADT7320 and ADT7410/ADT7420 is the control
68 interface, the ADT7310 and ADT7320 use SPI while the ADT7410 and ADT7420 use
69 I2C.
71 Configuration Notes
72 -------------------
74 Since the device uses one hysteresis value, which is an offset to minimum,
75 maximum and critical temperature, it can only be set for temp#_max_hyst.
76 However, temp#_min_hyst and temp#_crit_hyst show their corresponding
77 hysteresis.
78 The device is set to 16 bit resolution and comparator mode.
80 sysfs-Interface
81 ---------------
83 ======================== ====================================================
84 temp#_input              temperature input
85 temp#_min                temperature minimum setpoint
86 temp#_max                temperature maximum setpoint
87 temp#_crit               critical temperature setpoint
88 temp#_min_hyst           hysteresis for temperature minimum (read-only)
89 temp#_max_hyst           hysteresis for temperature maximum (read/write)
90 temp#_crit_hyst          hysteresis for critical temperature (read-only)
91 temp#_min_alarm          temperature minimum alarm flag
92 temp#_max_alarm          temperature maximum alarm flag
93 temp#_crit_alarm         critical temperature alarm flag
94 ======================== ====================================================