root/lm-sensors/branches/lm-sensors-3.0.0/README @ 4386

Revision 4386, 6.5 KB (checked in by khali, 8 years ago)

Delete all kernel bus drivers, documentation and references. We are
moving to a user-space-only package, all the drivers are maintained in
the Linux kernel tree itself.

  • 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 hardware sensor chips are supported:
46  Analog Devices ADM1021, ADM1021A, ADM1022, ADM1023, ADM1024,
47                 ADM1025, ADM1026, ADM1027, ADM1030, ADM1031,
48                 ADM1032, ADM9240, ADT7461 and ADT7463
49  Asus AS99127F, ASB100 Bach
50  Dallas Semiconductor DS75, DS1621, DS1625, DS1775, and DS1780
51  Hewlett Packard Maxilife (several revisions including '99 NBA)
52  Fintek F71805F/FG
53  Fujitsu Siemens Poseidon, Scylla, Hermes
54  Genesys Logic GL518SM, GL520SM, GL523SM
55  Intel Xeon processor embedded sensors
56  ITE IT8705F, IT8712F
57  Maxim MAX1617, MAX1617A, MAX1619, MAX6650, MAX6651,
58        MAX6633, MAX6634, MAX6635, MAX6657, MAX6658, MAX6659
59  Microchip TC1068, TCM1617, TCN75
60  Myson MTP008
61  National Semiconductor LM63, LM75, LM76, LM78, LM78-J, LM79,
62                         LM80, LM81, LM82, LM83, LM84, LM85, LM86, LM87,
63                         LM89, LM90, LM92, LM93, LM99, PC87360,
64                         PC87363, PC87364, PC87365, PC87366
65  Philips NE1617, NE1617A, NE1619
66  SiS 5595, 950 embedded sensors
67  SMSC 47M1xx embedded sensors, EMC6D100, EMC6D101, EMC6D102
68  TI THMC10 and THMC50
69  VIA Technologies VT1211, VT8231 and VT82C686A/B embedded sensors
70  Winbond W83781D, W83782D, W83783S, W83791D, W83792D,
71          W83627HF, W83627THF, W83637HF, W83687THF and W83697HF
72
73
74We also support some miscellaneous chips:
75  Dallas DS1307 real time clock
76  Intel Xeon processor embedded EEPROMs
77  Linear Technologies LTC1710
78  Philips Semiconductors PCF8574, PCF8591 
79  DDC Monitor embedded EEPROMs
80  SDRAM Dimms with Serial Presence Detect EEPROMs
81  Smart Battery sensors
82  IPMI-BMC sensors
83  Philips Semiconductors SAA1064
84
85
86The list above may be out of date;
87see our Devices page at http://www.lm-sensors.org/wiki/Devices
88for the latest information on supported devices.
89You may also refer to doc/chips/SUMMARY for details on what each chip
90can monitor.
91
92
93We always appreciate testers. If you own a specific monitoring chip we do
94not yet (properly) support, and are willing to help us out, please contact
95us. Even if you have no programming knowledge, you could help us by running
96new modules and reporting on the results and output. If you want to offer
97more substantial help, this is very welcome too, of course.
98
99
100Don't ask us whether we support a particular mainboard; we do not know.
101We *do* know what hardware we support, but usually, it is easier to
102install everything and run sensors-detect. It will tell you what hardware
103you have (and incidentally, what corresponding drivers are needed).
104
105
106SMBus, also known as System Management Bus, is a protocol for communicating
107through a I2C ('I squared C') bus. Many modern mainboards have a System
108Management Bus. There are a lot of devices which can be connected to a
109SMBus; the most notable are modern memory chips with EEPROM memories and
110chips for hardware monitoring.
111
112Most modern mainboards incorporate some form of hardware monitoring chips.
113These chips read things like chip temperatures, fan rotation speeds and
114voltage levels. There are quite a few different chips which can be used by
115mainboard builders for approximately the same results.
116
117Hardware monitoring chips often have an SMBus or I2C interface. Some are
118connected to ISA bus instead. Some of them can do both, in which case we
119either support both access methods (old drivers) or only support ISA
120access (new drivers) as it is faster.
121
122Because the SMBus is just a special case of the generalized I2C bus, we can
123simulate the SMBus protocol on plain I2C busses. These busses are sometimes
124used in other parts of your computer. If a supported chip is attached to
125one of these additional busses, they can be used too.
126
127Please read INSTALL before trying to compile and install these modules.
128There is a lot of additional documentation in the doc/ subdirectory.
129
130The developers of this package can be reached through a mailing-list
131(see http://www.lm-sensors.org/wiki/AuthorsAndContributors). Do not hesitate
132to mail us if you have questions, suggestions, problems, want to
133contribute, or just want to report it works for you. But please try to
134read the documentation and FAQ before you ask any questions!
135
136The latest version of this package can always be found at:
137http://www.lm-sensors.org/wiki/Download. Pre-release versions can be
138retrieved through anonymous SVN; see doc/svn for details.
139
140This package may be distributed according to the GNU General Public
141License (GPL), as included in the file COPYING.
142
143Note that libsensors falls under the GPL, not the LGPL.  In more human
144language, that means it is FORBIDDEN to link any application to the
145library, even to the shared version, if the application itself does not
146fall under the GPL.
147
148
149-----
150[1] SMBus is a trademark of Intel Corporation
151[2] I2C is a trademark of Philips Corporation
Note: See TracBrowser for help on using the browser.