root/lm-sensors/trunk/README @ 5368

Revision 5368, 7.4 KB (checked in by khali, 6 years ago)

Add support for the VIA VX800/VX820 SMBus. Backported from Linux 2.6.

  • 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 and 2.4 kernels (2.4.10 or later).   !!!
12!!! For 2.4 kernels, this package requires i2c-2.9.0 or later.        !!!
13
14FOR 2.6 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;
17use the drivers already in the 2.6 kernel. Check the QUICKSTART
18file for brief installation instructions please.
19
20=============================================================================
21
22This is the completely rewritten version 2 of lm_sensors, a collection of
23modules for general SMBus[1] access and hardware monitoring.
24Version 1 is now officially unsupported.
25
26WARNING! The drivers in this package will work on reasonably recent 2.4
27kernels only (2.4.10 and later).
28Use lm_sensors-2.4.5 for 2.0 kernels.
29Use lm_sensors-2.7.0 for 2.2, and early 2.4 (up to 2.4.9) kernels.
30Use the drivers already in the kernel for 2.6 kernels; if you need
31additional drivers in 2.6 please port and submit them to us.
32
33HOWEVER, the userspace tools in this package will work for
34both 2.4 and 2.6 kernels.
35
36The I2C[2] package in existing 2.4 kernels is NOT sufficient
37for compilation of this package. You need i2c-2.9.0 or later.
38
39See the lm_sensors download page for further guidance:
40  http://www.lm-sensors.org/wiki/Download
41
42
43=============================================================================
44
45At least the following I2C/SMBus adapters are supported:
46  Acer Labs M1533, M1535, M1543C and M1563
47  AMD 756, 766, 768 and 8111
48  AMD 8111 SMBus 2.0
49  Apple Hydra (used on some PPC machines)
50  ATI IXP200, IXP300, IXP400, SB600, SB700, SB800
51  DEC 21272/21274 (Tsunami/Typhoon - on Alpha boards)
52  Intel ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6/ICH7/ICH8/ICH9 (82801xx)
53  Intel 6300ESB, 631xESB/632xESB (ESB2)
54  Intel Tolapai, ICH10
55  Intel PIIX4 (used in many Intel chipsets)
56  Intel I810/I810E/I815/I845G GMCH
57  Intel 82443MX (440MX)
58  NVidia nForce, nForce2, nForce3, nForce4
59  ServerWorks OSB4, CSB5, CSB6, HT-1000
60  SiS 5595, 630, 645, 655, 730
61  SMSC Victory66
62  3Dfx Voodoo 3 and Banshee
63  VIA Technologies VT82C586B, VT82C596A/B, VT82C686A/B, VT8231,
64                   VT8233, VT8233A, VT8235, VT8237R/A, VT8251,
65                   CX700, VX800/VX820
66
67
68At least the following hardware sensor chips are supported:
69  Analog Devices ADM1021, ADM1021A, ADM1022, ADM1023, ADM1024,
70                 ADM1025, ADM1026, ADM1027, ADM1030, ADM1031,
71                 ADM1032, ADM9240, ADT7461 and ADT7463
72  Asus AS99127F, ASB100 Bach
73  Dallas Semiconductor DS75, DS1621, DS1625, DS1775, and DS1780
74  Hewlett Packard Maxilife (several revisions including '99 NBA)
75  Fintek F71805F/FG
76  Fujitsu Siemens Poseidon, Scylla, Hermes
77  Genesys Logic GL518SM, GL520SM, GL523SM
78  Intel Xeon processor embedded sensors
79  ITE IT8705F, IT8712F
80  Maxim MAX1617, MAX1617A, MAX1619, MAX6650, MAX6651,
81        MAX6633, MAX6634, MAX6635, MAX6657, MAX6658, MAX6659
82  Microchip TC1068, TCM1617, TCN75
83  Myson MTP008
84  National Semiconductor LM63, LM75, LM76, LM78, LM78-J, LM79,
85                         LM80, LM81, LM82, LM83, LM84, LM85, LM86, LM87,
86                         LM89, LM90, LM92, LM93, LM99, PC87360,
87                         PC87363, PC87364, PC87365, PC87366
88  Philips NE1617, NE1617A, NE1619
89  SiS 5595, 950 embedded sensors
90  SMSC 47M1xx embedded sensors, EMC6D100, EMC6D101, EMC6D102
91  TI THMC10 and THMC50
92  VIA Technologies VT1211, VT8231 and VT82C686A/B embedded sensors
93  Winbond W83781D, W83782D, W83783S, W83791D, W83792D,
94          W83627HF, W83627THF, W83637HF, W83687THF, W83697HF,
95          W83627EHF/EHG
96
97
98We also support some miscellaneous chips:
99  Dallas DS1307 real time clock
100  Intel Xeon processor embedded EEPROMs
101  Linear Technologies LTC1710
102  Philips Semiconductors PCF8574, PCF8591 
103  DDC Monitor embedded EEPROMs
104  SDRAM Dimms with Serial Presence Detect EEPROMs
105  Smart Battery sensors
106  IPMI-BMC sensors
107  Philips Semiconductors SAA1064
108
109
110The list above may be out of date;
111see our Devices page at http://www.lm-sensors.org/wiki/Devices
112for the latest information on supported devices.
113You may also refer to doc/chips/SUMMARY for details on what each chip
114can monitor.
115
116
117We always appreciate testers. If you own a specific monitoring chip we do
118not yet (properly) support, and are willing to help us out, please contact
119us. Even if you have no programming knowledge, you could help us by running
120new modules and reporting on the results and output. If you want to offer
121more substantial help, this is very welcome too, of course.
122
123
124Don't ask us whether we support a particular mainboard; we do not know.
125We *do* know what hardware we support, but usually, it is easier to
126install everything and run sensors-detect. It will tell you what hardware
127you have (and incidentally, what corresponding drivers are needed).
128
129
130SMBus, also known as System Management Bus, is a protocol for communicating
131through a I2C ('I squared C') bus. Many modern mainboards have a System
132Management Bus. There are a lot of devices which can be connected to a
133SMBus; the most notable are modern memory chips with EEPROM memories and
134chips for hardware monitoring.
135
136Most modern mainboards incorporate some form of hardware monitoring chips.
137These chips read things like chip temperatures, fan rotation speeds and
138voltage levels. There are quite a few different chips which can be used by
139mainboard builders for approximately the same results.
140
141Hardware monitoring chips often have an SMBus or I2C interface. Some are
142connected to ISA bus instead. Some of them can do both, in which case we
143either support both access methods (old drivers) or only support ISA
144access (new drivers) as it is faster.
145
146Because the SMBus is just a special case of the generalized I2C bus, we can
147simulate the SMBus protocol on plain I2C busses. These busses are sometimes
148used in other parts of your computer. If a supported chip is attached to
149one of these additional busses, they can be used too.
150
151Please read INSTALL before trying to compile and install these modules.
152There is a lot of additional documentation in the doc/ subdirectory.
153
154The developers of this package can be reached through a mailing-list
155(see http://www.lm-sensors.org/wiki/AuthorsAndContributors). Do not hesitate
156to mail us if you have questions, suggestions, problems, want to
157contribute, or just want to report it works for you. But please try to
158read the documentation and FAQ before you ask any questions!
159
160The latest version of this package can always be found at:
161http://www.lm-sensors.org/wiki/Download. Pre-release versions can be
162retrieved through anonymous SVN; see doc/svn for details.
163
164This package may be distributed according to the GNU General Public
165License (GPL), as included in the file COPYING.
166
167Note that libsensors falls under the GPL, not the LGPL.  In more human
168language, that means it is FORBIDDEN to link any application to the
169library, even to the shared version, if the application itself does not
170fall under the GPL.
171
172
173-----
174[1] SMBus is a trademark of Intel Corporation
175[2] I2C is a trademark of Philips Corporation
Note: See TracBrowser for help on using the browser.