Changeset 409

Show
Ignore:
Timestamp:
04/22/99 15:06:24 (10 years ago)
Author:
frodo
Message:

Even more documentation updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • lm-sensors/trunk/doc/FAQ

    r217 r409  
    44444.14 How do I set new limits? 
    45454.15 Some sensors are doubly detected? 
     464.16 I ran sensors-detect, but now I get very strange readings?!? 
    4647 
    47485 How to ask for help:  
     
    1981993.2 How do I know which chips I own? 
    199200 
    200         At the moment this is written (just before version 2.1.0 is released), 
    201 the adapter (SMBus host) detection is quite good, but the chip detection 
    202 is quite worthless (I wrote it myself, so I am allowed to say this :-)). 
    203         As always, the best way to do this is to read the documentation, in 
    204 this case, your mainboard manual (I hope you ever got one; if not, go 
    205 complain to your salesperson). Usually, it tells you what adapter and chips 
    206 are present. 
    207         If you really have no idea what is supported on your mainboard, you 
    208 will have to experiment. First, try to find out your adapter. First try 
    209 the piix4.o module; if it does not load, try the bit-mb.o (VIA) module. 
    210 You can type 'dmesg' to see what happened. Also, insert the isa.o module; 
    211 it may be enough, even if no other module loads succesfully. 
    212         Now, the chips. Try the drivers one by one (lm78.o, lm80.o, lm75.o, 
    213 gl518sm.o and w83781d.o at this moment). Type 'sensors' to determine whether 
    214 the read values make any sense. Remove modules if you are convinced that 
    215 the values are bogus. Also, see some of the driver-specific questions below. 
    216         There will be an automatic detection program in later versions of 
    217 this package; it is only partially  implemented yet. Look for it in the 
    218 prog/detect directory. For 2.2.0, it will only be able to detect the bus 
    219 type, not the chip type. 
     201        By now, chip detection is fairly good. That means that it is  
     202relatively harmless to insert more chip drivers than you need. This approach 
     203can still lead to problems, though. 
     204        In the past, you had to muddle your way through and just tried 
     205several drivers. But starting with 2.3.0, we have an excellent program 
     206that scans all your hardware. It is called 'sensors-detect' and is 
     207installed when you call 'make install'. Just execute this script, and 
     208it will tell you exactly what you want to know. 
    220209 
    221210 
     
    410399loaded the approprate adapter drivers, it will be detected on both), and 
    411400some chips simulate other chips (the Winbond W83781D simulates LM75 chips 
    412 on the SMBus, for example). Remove the offending adapter or chip driver, 
    413 or live with it for now. 
    414  
     401on the SMBus, for example). Remove the offending adapter or chip driver, or 
     402run sensors-detect and add the insmod parameters it suggests. 
     403 
     404 
     4054.16 I ran sensors-detect, but now I get very strange readings?!? 
     406 
     407        Your SMBus (PIIX4?) is probably crashed. There are some mainboards 
     408which connect a clock chip to the SMBus. Unfortunately, this clock chip 
     409hangs the PIIX4 if it is read (it is an I2C device, but not SMBus compatible). 
     410We have found no way of solving this, except for rebooting your computer. 
     411Next time when you run sensors-detect, you may want to exclude addresses 
     4120x69 and/or 0x6a, by entering 's' when you are asked whether you want to 
     413scan the PIIX4. 
    415414 
    4164155 How to ask for help: 
  • lm-sensors/trunk/doc/modules

    r232 r409  
    22parameters they define. First, some things about managing all these  
    33modules. 
     4 
     5Managing Modules 
     6================ 
    47 
    58The hardcore way is to insmod each of them by hand. This is not very 
     
    1215  (modutils-2.1.x): 
    1316    path=/lib/modules/current/extra 
    14 Do always a 'killall -HUP kerneld; depmod -a' after changing either your 
    15 configuration file or changing a module in one of the module directories. 
     17Do always a 'depmod -a' after changing either your configuration file or  
     18changing a module in one of the module directories; you also need to do 
     19a 'killall -HUP kerneld' if you still use kerneld (kernel 2.2.x usually 
     20uses kmod. 
    1621 
    1722Now you can do 'modprobe lm78', and all dependent modules are loaded 
     
    4247 
    4348 
     49Available Modules 
     50================= 
     51 
     52This does not list the chip and bus drivers; please examine the directories 
     53doc/chips and doc/busses for more information about them. 
     54 
    4455(i2c) i2c-core: 
    4556  The core i2c module (surprise!). Almost everything else depends on this one. 
     
    5768  rely. 
    5869 
    59 (src/busses) i2c-piix4: smbus i2c-core 
    60   PIIX4 SMBus access. 
    61  
    62 (src/busses) i2c-via: algo-bit i2c-core 
    63   VIA VT82C586B bus access. This is often used instead of the PIIX4 as SMBus 
    64   host. 
    65  
    66 (src/busses) i2c-ali15x3: smbus i2c-core 
    67   Acer Labs M1541 and M1543C bus access. 
    68  
    6970(src/busses) i2c-isa: i2c-core 
    7071  Defines the ISA bus as being a I2C adapter. It isn't, of course; but this is 
     
    7374(src) sensors: i2c-core 
    7475  General purpose routines for sensor client modules 
    75  
    76 (src/chips) lm78: sensors smbus i2c-core 
    77   LM78, LM78-J and LM79 chip driver 
    78  
    79 (src/chips) lm75: sensors smbus i2c-core 
    80   LM75 chip driver 
    81  
    82 (src/chips) gl518sm: sensors smbus i2c-core 
    83   GL518SM revision 0x00 and 0x80 chip driver 
    84  
    85 (src/chips) adm1021: sensors smbus i2c-core 
    86   ADM1021 and MAX1617 chip driver  
    87  
    88 (src/chips) adm9240: sensors smbus i2c-core 
    89   ADM9240 chip driver 
    90  
    91 (src/chips) ltc1710: sensors smbus i2c-core 
    92   LTC1710 chip driver 
    93  
    94 (src/chips) sis5595: sensors smbus i2c-core 
    95   SIS-5595 chipset hardware monitor driver 
    96  
    97 (src/chips) w83781d: sensors smbus i2c-core 
    98   W83781D chip driver 
    99  
    100 (src/chips) eeprom: sensors smbus i2c-core 
    101   Driver for DIMMs connected to the SMBus. You need prog/eeprom/decode-dimms.pl 
    102   to make sense of its output. 
    10376 
    10477(i2c) algo-bit: i2c-core 
     
    134107commands: 
    135108  modprobe i2c-proc 
     109  modprobe i2c-dev  # Often not needed; see above 
    136110  modprobe i2c-isa  # Unless you are certain no sensor chips live on the ISA bus 
    137111  modprobe i2c-piix4 # One such line for each adapter you own 
  • lm-sensors/trunk/doc/progs

    r217 r409  
    88  and prints to stdout `bus' statements reflecting the currently detected 
    99  adapters. 
    10 * prog/detect/dectect.pl (written in Perl, not installed) 
    11   This program tries to detect the available SMBus adapters. In time, it will 
    12   also scan each adapter for supported devices (chips). 
     10* prog/detect/sensors-detect (written in Perl, installed by 'make install') 
     11  This program tries to detect the available SMBus adapters and the chips 
     12  connected to them and/or the ISA bus. It also generates modprobe lines 
     13  and module options. This program is interactive and will ask you about 
     14  all information it needs. 
    1315* prog/detect/i2cdetect (written in C, not installed) 
    1416  This program scans your complete I2C or SMBus adapter for connected devices. 
     
    1820  Here the '0' stands for i2c-0 (check /proc/bus/i2c to find out which bus 
    1921  you need). 
    20 * prog/doc/doc-features (written in C, not installed) 
    21   This program is/will be used to help us generate chip driver documentation. 
     22* prog/doc/doc-features.pl (written in Perl, not installed) 
     23  This program is used to help us generate driver documentation; it scans 
     24  some C source programs to do this. Syntax: 
     25    ./doc-features.pl BASE [PREFIX...] 
     26  BASE is the path to the base directory of the lm_sensors tree 
     27  PREFIX is one of more prefixes of chips you want documented; if left out, 
     28  all chips are documented. 
     29* prog/doc/doc-insmod.pl (written in Perl, not installed) 
     30  This program is used to help us generate driver documentation; it reads 
     31  all module information and outputs insmod parameter information. Syntax: 
     32    ./doc-insmod.pl DRIVER 
    2233* prog/dump/i2cdump (written in C, not installed) 
    2334  This program helps to dump the registers of a I2C device that understands 
  • lm-sensors/trunk/doc/version-2

    r217 r409  
    1919* All code has been completely rewritten. 
    2020* Many new drivers 
     21 
     22By now (version 2.3.0) so many things have changed that we do not even try 
     23to keep the above list up-to-date. Just don't use version 1 anymore.