Changeset 217

Show
Ignore:
Timestamp:
02/12/99 06:43:22 (10 years ago)
Author:
frodo
Message:

More documentation updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • lm-sensors/trunk/INSTALL

    r216 r217  
    130130 
    131131Please examine the files in the doc subdirectory for more information,  
    132 especially about individual driver. You can always mail us at  
     132especially about individual drivers. You can always mail us at  
    133133<lm78@stimpy.netroedge.com>. Alternatively, consider useing the (free) 
    134134support site at http://www.netroedge.com/~lm78/support.html. Good luck! 
     135 
     136 
     137USEFUL PROGRAMS 
     138=============== 
     139 
     140The prog subdirectory contains lots of useful programs, many of which are 
     141not installed. doc/progs contains some documentation for each of them. 
     142Most important are prog/mkdev/mkdev.sh, which creates /dev/i2c-* files, 
     143and prog/detect/dectect.pl, which tries to detect what adapters are 
     144present on your system. 

  • lm-sensors/trunk/Makefile

    r208 r217  
    115115# The subdirectories we need to build things in  
    116116SRCDIRS := kernel kernel/busses kernel/chips kernel/include lib prog/sensors \ 
    117            prog/dump prog/doc etc 
     117           prog/dump prog/doc prog/detect etc 
    118118ifeq ($(I2C),1) 
    119119SRCDIRS += i2c i2c/detect i2c/drivers i2c/eeprom 

  • lm-sensors/trunk/doc/FAQ

    r139 r217  
    55 
    66Note: some questions were specific for version 1. These are put together 
    7 under chapter 5: version 1 questions. 
     7under chapter 6: version 1 questions. 
    88 
    991 What sensors are available on my PC? 
    …… 
    63631 What sensors are available on my PC? 
    6464 
    65         Most medium/high-end computers since late 1997 now come with a LM78 or  
    66 LM79 hardware health monitoring chip and an SMBus.  
     65        Most medium/high-end computers since late 1997 now come with a LM78- or  
     66LM79-like hardware health monitoring chip and an SMBus.  
    6767         
    6868         
    …… 
    215215the values are bogus. Also, see some of the driver-specific questions below. 
    216216        There will be an automatic detection program in later versions of 
    217 this package; it is simply not implemented yet. We need the /dev interface 
    218 first. Sorry for the inconvenience, in the meantime. 
     217this package; it is only partially  implemented yet. Look for it in the 
     218prog/detect directory. For 2.2.0, it will only be able to detect the bus 
     219type, not the chip type. 
    219220 
    220221 
    2212223.3 Which modules should I insert? 
    222223 
    223         Using modprobe, you should always insert i2c-proc.o. You need one 
    224 module for each adapter you own; if there are chips on the ISA bus, this 
    225 includes isa.o. Finally, you need one module for each type of chip you 
    226 own. That's all. On my computer, I could use the following line: 
    227     modprobe i2c-proc && modprobe isa && modprobe piix4 && modprobe lm78 \ 
    228                       && modprobe lm75 
     224        Using modprobe, you should always insert i2c-proc.o, and optionally 
     225i2c-dev.o. You need one module for each adapter you own; if there are  
     226chips on the ISA bus, this includes isa.o. Finally, you need one module  
     227for each type of chip you own. That's all. On my computer, I could use the  
     228following line: 
     229    modprobe i2c-proc && modprobe i2c-isa && modprobe i2c-piix4 && \ 
     230                         modprobe lm78 && modprobe lm75 && modprobe i2c-dev 
    229231 
    230232 
    …… 
    513515 
    514516----------- 
     517Rev 2.1 (Frodo) Corrections for lm_sensors 2.2, 19990112 
    515518Rev 2.0 (Frodo) Major revision for lm_sensors 2.1, 19981229 
    516519Rev 1.10 (Frodo) Modified 3.8, updated some other things, 19980924 

  • lm-sensors/trunk/doc/cvs

    r108 r217  
    66mirror site (prep.ai.mit.edu is the master site). 
    77 
    8 1) Go to the directory where you want lm_sensors (and lm_sensors2?) 
     81) Go to the directory where you want lm_sensors (and/or lm_sensors2) 
    99   directory/ies to reside with the project source code.  A good choice is 
    1010   your home directory. 
    …… 
    1919   or: 
    2020     cvs -d :pserver:anon@penn.netroedge.com:/home/cvs checkout lm_sensors2 
     21   Use lm_sensors2 for the 2.x tree. 
    2122 
    22234) Now you have a directory named "lm_sensors" (or lm_sensors2) with all 

  • lm-sensors/trunk/doc/modules

    r186 r217  
    5757  rely. 
    5858 
    59 (src) i2c-piix4: smbus i2c-core 
     59(src/busses) i2c-piix4: smbus i2c-core 
    6060  PIIX4 SMBus access. 
    6161 
    62 (src) i2c-via: algo-bit i2c-core 
     62(src/busses) i2c-via: algo-bit i2c-core 
    6363  VIA VT82C586B bus access. This is often used instead of the PIIX4 as SMBus 
    6464  host. 
    6565 
    66 (src) i2c-isa: i2c-core 
     66(src/busses) i2c-ali15x3: smbus i2c-core 
     67  Acer Labs M1541 and M1543C bus access. 
     68 
     69(src/busses) i2c-isa: i2c-core 
    6770  Defines the ISA bus as being a I2C adapter. It isn't, of course; but this is 
    6871  often used by sensor client modules, to keep the code small and simple. 
    …… 
    7174  General purpose routines for sensor client modules 
    7275 
    73 (src) lm78: sensors smbus i2c-core 
     76(src/chips) lm78: sensors smbus i2c-core 
    7477  LM78, LM78-J and LM79 chip driver 
    7578 
    76 (src) lm75: sensors smbus i2c-core 
     79(src/chips) lm75: sensors smbus i2c-core 
    7780  LM75 chip driver 
    7881 
    79 (src) gl518sm: sensors smbus i2c-core 
     82(src/chips) gl518sm: sensors smbus i2c-core 
    8083  GL518SM revision 0x00 and 0x80 chip driver 
    8184 
    82 (src) eeprom: sensors smbus i2c-core 
     85(src/chips) adm1021: sensors smbus i2c-core 
     86  ADM1021 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 
    83101  Driver for DIMMs connected to the SMBus. You need prog/eeprom/decode-dimms.pl 
    84102  to make sense of its output. 
    …… 
    107125 
    108126(i2c) i2c-dev: i2c-core 
    109   /dev interface for I2C adapters. This will be superseded by a module which 
    110   will also implement SMBus access. 
     127  /dev interface for I2C adapters. This is superseded by a module which 
     128  will also implement SMBus access. Please do not use this anymore. 
    111129 
    112130Several other modules are not yet ported by Simon Vogl. They are mostly in 
    …… 
    116134commands: 
    117135  modprobe i2c-proc 
    118   modprobe isa     # Unless you are certain no sensor chips live on the ISA bus 
    119   modprobe piix4  # One such line for each adapter you own 
    120   modprobe lm78    # One such line for each device you own 
     136  modprobe i2c-isa  # Unless you are certain no sensor chips live on the ISA bus 
     137  modprobe i2c-piix4 # One such line for each adapter you own 
     138  modprobe lm78    # One such line for each device you own 

  • lm-sensors/trunk/doc/progs

    r166 r217  
    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). 
     13* prog/detect/i2cdetect (written in C, not installed) 
     14  This program scans your complete I2C or SMBus adapter for connected devices. 
     15  Not all devices can be detected in this way, though; and it may hang your 
     16  bus. Syntax: 
     17    ./i2cdetect 0 
     18  Here the '0' stands for i2c-0 (check /proc/bus/i2c to find out which bus 
     19  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. 
    1022* prog/dump/i2cdump (written in C, not installed) 
    1123  This program helps to dump the registers of a I2C device that understands 
    …… 
    3749  This program needs module `i2c-dev.o' to be loaded. It scans the complete 
    3850  address range of a certain bus for connected devices. It will only work 
    39   for i2c-level drivers (not for PIIX4 busses). 
     51  for i2c-level drivers (not for PIIX4 busses). This program is superceded 
     52  by prog/detect/i2c-detect. 
    4053* i2c/eeprom/eeprom (written in C, not installed) 
    4154  This program needs the i2c `eeprom.o' module (that is the one that is not 

  • lm-sensors/trunk/doc/version-2

    r108 r217  
    1818  how all sensor readings are to be interpreted. 
    1919* All code has been completely rewritten. 
     20* Many new drivers