| 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://www.lm-sensors.org/wiki/Download |
|---|
| 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 | ATI IXP200, IXP300, IXP400 |
|---|
| 61 | DEC 21272/21274 (Tsunami/Typhoon - on Alpha boards) |
|---|
| 62 | Intel I801 ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6 (82801xx), 6300ESB, ICH7 |
|---|
| 63 | Intel PIIX4 (used in many Intel chipsets) |
|---|
| 64 | Intel I810/I810E/I815/I845G GMCH |
|---|
| 65 | Intel 82443MX (440MX) |
|---|
| 66 | NVidia nForce, nForce2, nForce3, nForce4 |
|---|
| 67 | ServerWorks OSB4, CSB5, CSB6, HT-1000 |
|---|
| 68 | SiS 5595, 630, 645, 655, 730 |
|---|
| 69 | SMSC Victory66 |
|---|
| 70 | 3Dfx Voodoo 3 and Banshee |
|---|
| 71 | VIA Technologies VT82C586B, VT82C596A/B, VT82C686A/B, VT8231, |
|---|
| 72 | VT8233, VT8233A, VT8235 and VT8237R |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | At least the following hardware sensor chips are supported: |
|---|
| 76 | Analog Devices ADM1021, ADM1021A, ADM1022, ADM1023, ADM1024, |
|---|
| 77 | ADM1025, ADM1026, ADM1027, ADM1030, ADM1031, |
|---|
| 78 | ADM1032, ADM9240, ADT7461 and ADT7463 |
|---|
| 79 | Asus AS99127F, ASB100 Bach |
|---|
| 80 | Dallas Semiconductor DS75, DS1621, DS1625, DS1775, and DS1780 |
|---|
| 81 | Hewlett Packard Maxilife (several revisions including '99 NBA) |
|---|
| 82 | Fintek F71805F/FG |
|---|
| 83 | Fujitsu Siemens Poseidon, Scylla, Hermes |
|---|
| 84 | Genesys Logic GL518SM, GL520SM, GL523SM |
|---|
| 85 | Intel Xeon processor embedded sensors |
|---|
| 86 | ITE IT8705F, IT8712F embedded sensors |
|---|
| 87 | Maxim MAX1617, MAX1617A, MAX1619, MAX6650, MAX6651, |
|---|
| 88 | MAX6633, MAX6634, MAX6635, MAX6657, MAX6658, MAX6659 |
|---|
| 89 | Microchip TC1068, TCM1617, TCN75 |
|---|
| 90 | Myson MTP008 |
|---|
| 91 | National Semiconductor LM63, LM75, LM76, LM78, LM78-J, LM79, |
|---|
| 92 | LM80, LM81, LM82, LM83, LM84, LM85, LM86, LM87, |
|---|
| 93 | LM89, LM90, LM92, LM93, LM99, PC87360, |
|---|
| 94 | PC87363, PC87364, PC87365, PC87366 |
|---|
| 95 | Philips NE1617, NE1617A, NE1619 |
|---|
| 96 | SiS 5595, 950 embedded sensors |
|---|
| 97 | SMSC 47M1xx embedded sensors, EMC6D100, EMC6D101, EMC6D102 |
|---|
| 98 | TI THMC10 and THMC50 |
|---|
| 99 | VIA Technologies VT1211, VT8231 and VT82C686A/B embedded sensors |
|---|
| 100 | Winbond W83781D, W83782D, W83783S, W83791D, W83792D, |
|---|
| 101 | W83627HF, W83627THF, W83637HF, W83687THF and W83697HF |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | We also support some miscellaneous chips: |
|---|
| 105 | Dallas DS1307 real time clock |
|---|
| 106 | Intel Xeon processor embedded EEPROMs |
|---|
| 107 | Linear Technologies LTC1710 |
|---|
| 108 | Philips Semiconductors PCF8574, PCF8591 |
|---|
| 109 | DDC Monitor embedded EEPROMs |
|---|
| 110 | SDRAM Dimms with Serial Presence Detect EEPROMs |
|---|
| 111 | Smart Battery sensors |
|---|
| 112 | IPMI-BMC sensors |
|---|
| 113 | Philips Semiconductors SAA1064 |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | The list above may be out of date; |
|---|
| 117 | see our New Drivers page at http://www.lm-sensors.org/wiki/NewDrivers |
|---|
| 118 | for the latest information on supported devices. |
|---|
| 119 | You may also refer to doc/chips/SUMMARY for details on what each chip |
|---|
| 120 | can monitor. |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | We always appreciate testers. If you own a specific monitoring chip listed |
|---|
| 124 | on our 'new drivers' page, and are willing to help us out, please contact |
|---|
| 125 | us. Even if you have no programming knowledge, you could help us by running |
|---|
| 126 | new modules and reporting on the results and output. If you want to offer |
|---|
| 127 | more substantial help, this is very welcome too, of course. |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | Don't ask us whether we support a particular mainboard; we do not know. |
|---|
| 131 | We *do* know what hardware we support, but usually, it is easier to |
|---|
| 132 | install everything and run sensors-detect. It will tell you what hardware |
|---|
| 133 | you have (and incidentally, what corresponding drivers are needed). You |
|---|
| 134 | could also take a look at http://mbm.livewiredev.com/ |
|---|
| 135 | (this lists chips found on many mainboard, but regrettably not the adapters |
|---|
| 136 | on them) or http://web01.fureai.or.jp/~hirobo/project/reserch_project.html |
|---|
| 137 | (yes, it is Japanese; you want the ninth column, and it again lists only |
|---|
| 138 | chips, not adapters). |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | SMBus, also known as System Management Bus, is a protocol for communicating |
|---|
| 142 | through a I2C ('I squared C') bus. Many modern mainboards have a System |
|---|
| 143 | Management Bus. There are a lot of devices which can be connected to a |
|---|
| 144 | SMBus; the most notable are modern memory chips with EEPROM memories and |
|---|
| 145 | chips for hardware monitoring. |
|---|
| 146 | |
|---|
| 147 | Most modern mainboards incorporate some form of hardware monitoring chips. |
|---|
| 148 | These chips read things like chip temperatures, fan rotation speeds and |
|---|
| 149 | voltage levels. There are quite a few different chips which can be used by |
|---|
| 150 | mainboard builders for approximately the same results. |
|---|
| 151 | |
|---|
| 152 | Hardware monitoring chips often have an SMBus or I2C interface. Some are |
|---|
| 153 | connected to ISA bus instead. Some of them can do both, in which case we |
|---|
| 154 | either support both access methods (old drivers) or only support ISA |
|---|
| 155 | access (new drivers) as it is faster. |
|---|
| 156 | |
|---|
| 157 | Because the SMBus is just a special case of the generalized I2C bus, we can |
|---|
| 158 | simulate the SMBus protocol on plain I2C busses. These busses are sometimes |
|---|
| 159 | used in other parts of your computer. If a supported chip is attached to |
|---|
| 160 | one of these additional busses, they can be used too. |
|---|
| 161 | |
|---|
| 162 | Please read INSTALL before trying to compile and install these modules. |
|---|
| 163 | There is a lot of additional documentation in the doc/ subdirectory. |
|---|
| 164 | Amnong these is a list of supported busses and chips. Regrettably, there |
|---|
| 165 | are too many mainboards to keep a list of busses and chips used on them. |
|---|
| 166 | On the other hand, we provide a program called 'sensors-detect' which |
|---|
| 167 | tries to figure out what hardware is available on your system. |
|---|
| 168 | |
|---|
| 169 | The developers of this package can be reached through a mailing-list |
|---|
| 170 | (see http://www.lm-sensors.org/wiki/AuthorsAndContributors). Do not hesitate |
|---|
| 171 | to mail us if you have questions, suggestions, problems, want to |
|---|
| 172 | contribute, or just want to report it works for you. But please try to |
|---|
| 173 | read the documentation and FAQ before you ask any questions! |
|---|
| 174 | |
|---|
| 175 | The latest version of this package can always be found on our homepage: |
|---|
| 176 | http://www.lm-sensors.org. Pre-release versions can be retrieved |
|---|
| 177 | through anonymous SVN; see doc/svn for details. |
|---|
| 178 | |
|---|
| 179 | This package may be distributed according to the GNU General Public |
|---|
| 180 | License (GPL), as included in the file COPYING. |
|---|
| 181 | |
|---|
| 182 | Note that libsensors falls under the GPL, not the LGPL. In more human |
|---|
| 183 | language, that means it is FORBIDDEN to link any application to the |
|---|
| 184 | library, even to the shared version, if the application itself does not |
|---|
| 185 | fall under the GPL. |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | ----- |
|---|
| 189 | [1] SMBus is a trademark of Intel Corporation |
|---|
| 190 | [2] I2C is a trademark of Philips Corporation |
|---|
