53cd829f3f4d97dfea3336a6d3a954c81408665a
[safe/jmp/linux-2.6] / Documentation / hwmon / lm90
1 Kernel driver lm90
2 ==================
3
4 Supported chips:
5   * National Semiconductor LM90
6     Prefix: 'lm90'
7     Addresses scanned: I2C 0x4c
8     Datasheet: Publicly available at the National Semiconductor website
9                http://www.national.com/pf/LM/LM90.html
10   * National Semiconductor LM89
11     Prefix: 'lm99'
12     Addresses scanned: I2C 0x4c and 0x4d
13     Datasheet: Publicly available at the National Semiconductor website
14                http://www.national.com/mpf/LM/LM89.html
15   * National Semiconductor LM99
16     Prefix: 'lm99'
17     Addresses scanned: I2C 0x4c and 0x4d
18     Datasheet: Publicly available at the National Semiconductor website
19                http://www.national.com/pf/LM/LM99.html
20   * National Semiconductor LM86
21     Prefix: 'lm86'
22     Addresses scanned: I2C 0x4c
23     Datasheet: Publicly available at the National Semiconductor website
24                http://www.national.com/mpf/LM/LM86.html
25   * Analog Devices ADM1032
26     Prefix: 'adm1032'
27     Addresses scanned: I2C 0x4c and 0x4d
28     Datasheet: Publicly available at the ON Semiconductor website
29                http://www.onsemi.com/PowerSolutions/product.do?id=ADM1032
30   * Analog Devices ADT7461
31     Prefix: 'adt7461'
32     Addresses scanned: I2C 0x4c and 0x4d
33     Datasheet: Publicly available at the ON Semiconductor website
34                http://www.onsemi.com/PowerSolutions/product.do?id=ADT7461
35   * Maxim MAX6657
36     Prefix: 'max6657'
37     Addresses scanned: I2C 0x4c
38     Datasheet: Publicly available at the Maxim website
39                http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2578
40   * Maxim MAX6658
41     Prefix: 'max6657'
42     Addresses scanned: I2C 0x4c
43     Datasheet: Publicly available at the Maxim website
44                http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2578
45   * Maxim MAX6659
46     Prefix: 'max6657'
47     Addresses scanned: I2C 0x4c, 0x4d (unsupported 0x4e)
48     Datasheet: Publicly available at the Maxim website
49                http://www.maxim-ic.com/quick_view2.cfm/qv_pk/2578
50   * Maxim MAX6680
51     Prefix: 'max6680'
52     Addresses scanned: I2C 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b,
53                            0x4c, 0x4d and 0x4e
54     Datasheet: Publicly available at the Maxim website
55                http://www.maxim-ic.com/quick_view2.cfm/qv_pk/3370
56   * Maxim MAX6681
57     Prefix: 'max6680'
58     Addresses scanned: I2C 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b,
59                            0x4c, 0x4d and 0x4e
60     Datasheet: Publicly available at the Maxim website
61                http://www.maxim-ic.com/quick_view2.cfm/qv_pk/3370
62
63
64 Author: Jean Delvare <khali@linux-fr.org>
65
66
67 Description
68 -----------
69
70 The LM90 is a digital temperature sensor. It senses its own temperature as
71 well as the temperature of up to one external diode. It is compatible
72 with many other devices, many of which are supported by this driver.
73
74 Note that there is no easy way to differentiate between the MAX6657,
75 MAX6658 and MAX6659 variants. The extra address and features of the
76 MAX6659 are not supported by this driver. The MAX6680 and MAX6681 only
77 differ in their pinout, therefore they obviously can't (and don't need to)
78 be distinguished.
79
80 The specificity of this family of chipsets over the ADM1021/LM84
81 family is that it features critical limits with hysteresis, and an
82 increased resolution of the remote temperature measurement.
83
84 The different chipsets of the family are not strictly identical, although
85 very similar. For reference, here comes a non-exhaustive list of specific
86 features:
87
88 LM90:
89   * Filter and alert configuration register at 0xBF.
90   * ALERT is triggered by temperatures over critical limits.
91
92 LM86 and LM89:
93   * Same as LM90
94   * Better external channel accuracy
95
96 LM99:
97   * Same as LM89
98   * External temperature shifted by 16 degrees down
99
100 ADM1032:
101   * Consecutive alert register at 0x22.
102   * Conversion averaging.
103   * Up to 64 conversions/s.
104   * ALERT is triggered by open remote sensor.
105   * SMBus PEC support for Write Byte and Receive Byte transactions.
106
107 ADT7461:
108   * Extended temperature range (breaks compatibility)
109   * Lower resolution for remote temperature
110
111 MAX6657 and MAX6658:
112   * Better local resolution
113   * Remote sensor type selection
114
115 MAX6659:
116   * Better local resolution
117   * Selectable address
118   * Second critical temperature limit
119   * Remote sensor type selection
120
121 MAX6680 and MAX6681:
122   * Selectable address
123   * Remote sensor type selection
124
125 All temperature values are given in degrees Celsius. Resolution
126 is 1.0 degree for the local temperature, 0.125 degree for the remote
127 temperature, except for the MAX6657, MAX6658 and MAX6659 which have a
128 resolution of 0.125 degree for both temperatures.
129
130 Each sensor has its own high and low limits, plus a critical limit.
131 Additionally, there is a relative hysteresis value common to both critical
132 values. To make life easier to user-space applications, two absolute values
133 are exported, one for each channel, but these values are of course linked.
134 Only the local hysteresis can be set from user-space, and the same delta
135 applies to the remote hysteresis.
136
137 The lm90 driver will not update its values more frequently than every
138 other second; reading them more often will do no harm, but will return
139 'old' values.
140
141 PEC Support
142 -----------
143
144 The ADM1032 is the only chip of the family which supports PEC. It does
145 not support PEC on all transactions though, so some care must be taken.
146
147 When reading a register value, the PEC byte is computed and sent by the
148 ADM1032 chip. However, in the case of a combined transaction (SMBus Read
149 Byte), the ADM1032 computes the CRC value over only the second half of
150 the message rather than its entirety, because it thinks the first half
151 of the message belongs to a different transaction. As a result, the CRC
152 value differs from what the SMBus master expects, and all reads fail.
153
154 For this reason, the lm90 driver will enable PEC for the ADM1032 only if
155 the bus supports the SMBus Send Byte and Receive Byte transaction types.
156 These transactions will be used to read register values, instead of
157 SMBus Read Byte, and PEC will work properly.
158
159 Additionally, the ADM1032 doesn't support SMBus Send Byte with PEC.
160 Instead, it will try to write the PEC value to the register (because the
161 SMBus Send Byte transaction with PEC is similar to a Write Byte transaction
162 without PEC), which is not what we want. Thus, PEC is explicitly disabled
163 on SMBus Send Byte transactions in the lm90 driver.
164
165 PEC on byte data transactions represents a significant increase in bandwidth
166 usage (+33% for writes, +25% for reads) in normal conditions. With the need
167 to use two SMBus transaction for reads, this overhead jumps to +50%. Worse,
168 two transactions will typically mean twice as much delay waiting for
169 transaction completion, effectively doubling the register cache refresh time.
170 I guess reliability comes at a price, but it's quite expensive this time.
171
172 So, as not everyone might enjoy the slowdown, PEC can be disabled through
173 sysfs. Just write 0 to the "pec" file and PEC will be disabled. Write 1
174 to that file to enable PEC again.