root/lm-sensors/tags/V2-10-0/README

Revision 3237, 8.2 kB (checked in by khali, 2 years ago)

Sparse minor fixes, and rewrite of the SMBus vs. ISA paragraph.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 =============================================================================
2
3      FOR QUICK INSTALLATION INSTRUCTIONS SEE THE 'QUICKSTART' FILE.
4      FOR FULL INSTALLATION INSTRUCTIONS SEE THE 'INSTALL' FILE.
5      FOR THE FAQ SEE THE 'doc/FAQ' or 'doc/lm_sensors-FAQ.html' FILES.
6
7 =============================================================================
8
9 OVERVIEW OF THE LM_SENSORS PACKAGE AND SUMMARY OF SUPPORTED DEVICES
10
11 !!! This package is ONLY for 2.6, 2.5, and 2.4 kernels (2.4.10 or later) !!!
12 !!! THIS PACKAGE REQUIRES i2c-2.9.0 or later!!!
13
14 FOR 2.6/2.5 KERNELS, use only the userspace tools in this package!
15 Build and install them with 'make user' and 'make user_install'.
16 The kernel modules in this package will not compile for 2.6/2.5;
17 use the drivers already in the 2.6 kernel.
18
19 =============================================================================
20
21 This is the completely rewritten version 2 of lm_sensors, a collection of
22 modules for general SMBus[1] access and hardware monitoring.
23 Version 1 is now officially unsupported.
24
25 WARNING! The drivers in this package will work on reasonably recent 2.4
26 kernels only (2.4.10 and later).
27 Use lm_sensors-2.4.5 for 2.0 kernels.
28 Use lm_sensors-2.7.0 for 2.2, 2.3, and 2.4.0 - 2.4.9 kernels.
29 Use the drivers already in the kernel for 2.6/2.5 kernels; if you need
30 additional drivers in 2.6 please port and submit them to us.
31
32 HOWEVER, the userspace tools in this package will work for
33 2.4, 2.5, and 2.6 kernels.
34
35 WARNING! You must have at least i2c-2.9.0.
36 EVEN IF your kernel does contain i2c support!
37
38 The I2C[2] package in existing 2.4 kernels is NOT sufficient
39 for compilation of this package.
40
41 ADDITIONALLY, i2c-2.9.0 is API compatible to i2c releases 2.7.0 and earlier,
42 but is not API compatible to i2c releases 2.8.0 - 2.8.8
43 due to struct changes. Versions 2.8.x of i2c are considered deprecated.
44
45 See the lm_sensors download page for further guidance:
46   http://secure.netroedge.com/~lm78/download.html
47
48
49 WARNING! If you downloaded this package through our CVS archive, you walk
50 the cutting edge. Things may not even compile! On the other hand, you will
51 be the first to profit from new drivers and other changes. Have fun!
52
53 =============================================================================
54
55 At least the following I2C/SMBus adapters are supported:
56   Acer Labs M1533, M1535, M1543C and M1563
57   AMD 756, 766, 768 and 8111
58   AMD 8111 SMBus 2.0
59   Apple Hydra (used on some PPC machines)
60   DEC 21272/21274 (Tsunami/Typhoon - on Alpha boards)
61   Intel I801 ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6 (82801xx), 6300ESB, ICH7
62   Intel PIIX4 (used in many Intel chipsets)
63   Intel I810/I810E/I815/I845G GMCH
64   Intel 82443MX (440MX)
65   NVidia nForce, nForce2, nForce3, nForce4
66   ServerWorks OSB4, CSB5, CSB6
67   SiS 5595, 630, 645, 655, 730
68   SMSC Victory66
69   3Dfx Voodoo 3 and Banshee
70   VIA Technologies VT82C586B, VT82C596A/B, VT82C686A/B, VT8231,
71                    VT8233, VT8233A, VT8235 and VT8237R
72
73
74 At least the following hardware sensor chips are supported:
75   Analog Devices ADM1021, ADM1021A, ADM1022, ADM1023, ADM1024,
76                  ADM1025, ADM1026, ADM1027, ADM1030, ADM1031,
77                  ADM1032, ADM9240, ADT7461 and ADT7463
78   Asus AS99127F, ASB100 Bach
79   Dallas Semiconductor DS75, DS1621, DS1625, DS1775, and DS1780
80   Hewlett Packard Maxilife (several revisions including '99 NBA)
81   Fintek F71805F/FG
82   Fujitsu Siemens Poseidon, Scylla, Hermes
83   Genesys Logic GL518SM, GL520SM, GL523SM
84   Intel Xeon processor embedded sensors
85   ITE IT8705F, IT8712F embedded sensors
86   Maxim MAX1617, MAX1617A, MAX1619, MAX6650, MAX6651,
87         MAX6633, MAX6634, MAX6635, MAX6657, MAX6658, MAX6659
88   Microchip TC1068, TCM1617, TCN75
89   Myson MTP008
90   National Semiconductor LM63, LM75, LM76, LM78, LM78-J, LM79,
91                          LM80, LM81, LM83, LM84, LM85, LM86, LM87,
92                          LM89, LM90, LM92, LM93, LM99, PC87360,
93                          PC87363, PC87364, PC87365, PC87366
94   Philips NE1617, NE1617A, NE1619
95   SiS 5595, 950 embedded sensors
96   SMSC 47M1xx embedded sensors, EMC6D100, EMC6D101, EMC6D102
97   TI THMC10 and THMC50
98   VIA Technologies VT1211, VT8231 and VT82C686A/B embedded sensors
99   Winbond W83781D, W83782D, W83783S, W83791D, W83792D,
100           W83627HF, W83627THF, W83637HF, W83687THF and W83697HF
101
102
103 We also support some miscellaneous chips:
104   Dallas DS1307 real time clock
105   Intel Xeon processor embedded EEPROMs
106   Linear Technologies LTC1710
107   Philips Semiconductors PCF8574, PCF8591 
108   DDC Monitor embedded EEPROMs
109   SDRAM Dimms with Serial Presence Detect EEPROMs
110   Smart Battery sensors
111   IPMI-BMC sensors
112   Philips Semiconductors SAA1064
113
114
115 The list above may be out of date;
116 see our New Drivers page http://www.lm-sensors.nu/~lm78/newdrivers.html
117 for the latest information on supported devices.
118 You may also refer to doc/chips/SUMMARY for details on what each chip
119 can monitor.
120
121
122 We always appreciate testers. If you own a specific monitoring chip listed
123 on our 'new drivers' page, and are willing to help us out, please contact
124 us. Even if you have no programming knowledge, you could help us by running
125 new modules and reporting on the results and output. If you want to offer
126 more substantial help, this is very welcome too, of course.
127
128
129 Don't ask us whether we support a particular mainboard; we do not know.
130 We *do* know what hardware we support, but usually, it is easier to
131 install everything and run sensors-detect. It will tell you what hardware
132 you have (and incidentally, what corresponding drivers are needed). You
133 could also take a look at http://mbm.livewiredev.com/
134 (this lists chips found on many mainboard, but regrettably not the adapters
135 on them) or http://web01.fureai.or.jp/~hirobo/project/reserch_project.html
136 (yes, it is Japanese; you want the ninth column, and it again lists only
137 chips, not adapters).
138
139
140 SMBus, also known as System Management Bus, is a protocol for communicating
141 through a I2C ('I squared C') bus. Many modern mainboards have a System
142 Management Bus. There are a lot of devices which can be connected to a
143 SMBus; the most notable are modern memory chips with EEPROM memories and
144 chips for hardware monitoring.
145
146 Most modern mainboards incorporate some form of hardware monitoring chips.
147 These chips read things like chip temperatures, fan rotation speeds and
148 voltage levels. There are quite a few different chips which can be used by
149 mainboard builders for approximately the same results.
150
151 Hardware monitoring chips often have an SMBus or I2C interface. Some are
152 connected to ISA bus instead. Some of them can do both, in which case we
153 either support both access methods (old drivers) or only support ISA
154 access (new drivers) as it is faster.
155
156 Because the SMBus is just a special case of the generalized I2C bus, we can
157 simulate the SMBus protocol on plain I2C busses. These busses are sometimes
158 used in other parts of your computer. If a supported chip is attached to
159 one of these additional busses, they can be used too.
160
161 Please read INSTALL before trying to compile and install these modules.
162 There is a lot of additional documentation in the doc/ subdirectory.
163 Amnong these is a list of supported busses and chips. Regrettably, there
164 are too many mainboards to keep a list of busses and chips used on them.
165 On the other hand, we provide a program called 'sensors-detect' which
166 tries to figure out what hardware is available on your system.
167
168 The developers of this package can be reached through a mailing-list
169 (see http://secure.netroedge.com/~lm78/author.html). Do not hesitate
170 to mail us if you have questions, suggestions, problems, want to
171 contribute, or just want to report it works for you. But please try to
172 read the documentation and FAQ before you ask any questions!
173
174 The latest version of this package can always be found on our homepage:
175 http://secure.netroedge.com/~lm78/. Pre-release versions can be retrieved
176 through anonymous CVS; see doc/cvs for more information.
177
178 This package may be distributed according to the GNU General Public
179 License (GPL), as included in the file COPYING.
180
181 Note that libsensors falls under the GPL, not the LGPL.  In more human
182 language, that means it is FORBIDDEN to link any application to the
183 library, even to the shared version, if the application itself does not
184 fall under the GPL.
185
186
187 -----
188 [1] SMBus is a trademark of Intel Corporation
189 [2] I2C is a trademark of Philips Corporation
Note: See TracBrowser for help on using the browser.