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

Revision 3237, 8.2 KB (checked in by khali, 7 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
9OVERVIEW 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
14FOR 2.6/2.5 KERNELS, use only the userspace tools in this package!
15Build and install them with 'make user' and 'make user_install'.
16The kernel modules in this package will not compile for 2.6/2.5;
17use the drivers already in the 2.6 kernel.
18
19=============================================================================
20
21This is the completely rewritten version 2 of lm_sensors, a collection of
22modules for general SMBus[1] access and hardware monitoring.
23Version 1 is now officially unsupported.
24
25WARNING! The drivers in this package will work on reasonably recent 2.4
26kernels only (2.4.10 and later).
27Use lm_sensors-2.4.5 for 2.0 kernels.
28Use lm_sensors-2.7.0 for 2.2, 2.3, and 2.4.0 - 2.4.9 kernels.
29Use the drivers already in the kernel for 2.6/2.5 kernels; if you need
30additional drivers in 2.6 please port and submit them to us.
31
32HOWEVER, the userspace tools in this package will work for
332.4, 2.5, and 2.6 kernels.
34
35WARNING! You must have at least i2c-2.9.0.
36EVEN IF your kernel does contain i2c support!
37
38The I2C[2] package in existing 2.4 kernels is NOT sufficient
39for compilation of this package.
40
41ADDITIONALLY, i2c-2.9.0 is API compatible to i2c releases 2.7.0 and earlier,
42but is not API compatible to i2c releases 2.8.0 - 2.8.8
43due to struct changes. Versions 2.8.x of i2c are considered deprecated.
44
45See the lm_sensors download page for further guidance:
46  http://secure.netroedge.com/~lm78/download.html
47
48
49WARNING! If you downloaded this package through our CVS archive, you walk
50the cutting edge. Things may not even compile! On the other hand, you will
51be the first to profit from new drivers and other changes. Have fun!
52
53=============================================================================
54
55At 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
74At 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
103We 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
115The list above may be out of date;
116see our New Drivers page http://www.lm-sensors.nu/~lm78/newdrivers.html
117for the latest information on supported devices.
118You may also refer to doc/chips/SUMMARY for details on what each chip
119can monitor.
120
121
122We always appreciate testers. If you own a specific monitoring chip listed
123on our 'new drivers' page, and are willing to help us out, please contact
124us. Even if you have no programming knowledge, you could help us by running
125new modules and reporting on the results and output. If you want to offer
126more substantial help, this is very welcome too, of course.
127
128
129Don't ask us whether we support a particular mainboard; we do not know.
130We *do* know what hardware we support, but usually, it is easier to
131install everything and run sensors-detect. It will tell you what hardware
132you have (and incidentally, what corresponding drivers are needed). You
133could also take a look at http://mbm.livewiredev.com/
134(this lists chips found on many mainboard, but regrettably not the adapters
135on 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
137chips, not adapters).
138
139
140SMBus, also known as System Management Bus, is a protocol for communicating
141through a I2C ('I squared C') bus. Many modern mainboards have a System
142Management Bus. There are a lot of devices which can be connected to a
143SMBus; the most notable are modern memory chips with EEPROM memories and
144chips for hardware monitoring.
145
146Most modern mainboards incorporate some form of hardware monitoring chips.
147These chips read things like chip temperatures, fan rotation speeds and
148voltage levels. There are quite a few different chips which can be used by
149mainboard builders for approximately the same results.
150
151Hardware monitoring chips often have an SMBus or I2C interface. Some are
152connected to ISA bus instead. Some of them can do both, in which case we
153either support both access methods (old drivers) or only support ISA
154access (new drivers) as it is faster.
155
156Because the SMBus is just a special case of the generalized I2C bus, we can
157simulate the SMBus protocol on plain I2C busses. These busses are sometimes
158used in other parts of your computer. If a supported chip is attached to
159one of these additional busses, they can be used too.
160
161Please read INSTALL before trying to compile and install these modules.
162There is a lot of additional documentation in the doc/ subdirectory.
163Amnong these is a list of supported busses and chips. Regrettably, there
164are too many mainboards to keep a list of busses and chips used on them.
165On the other hand, we provide a program called 'sensors-detect' which
166tries to figure out what hardware is available on your system.
167
168The developers of this package can be reached through a mailing-list
169(see http://secure.netroedge.com/~lm78/author.html). Do not hesitate
170to mail us if you have questions, suggestions, problems, want to
171contribute, or just want to report it works for you. But please try to
172read the documentation and FAQ before you ask any questions!
173
174The latest version of this package can always be found on our homepage:
175http://secure.netroedge.com/~lm78/. Pre-release versions can be retrieved
176through anonymous CVS; see doc/cvs for more information.
177
178This package may be distributed according to the GNU General Public
179License (GPL), as included in the file COPYING.
180
181Note that libsensors falls under the GPL, not the LGPL.  In more human
182language, that means it is FORBIDDEN to link any application to the
183library, even to the shared version, if the application itself does not
184fall 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.