Changeset 569

Show
Ignore:
Timestamp:
09/20/99 17:28:44 (9 years ago)
Author:
frodo
Message:

More documentation updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • lm-sensors/trunk/INSTALL

    r568 r569  
    1919NOTE: IN EACH CASE, YOU WILL HAVE TO GET AND INSTALL THE I2C PACKAGE FIRST! 
    2020 
     21NOTE: PLEASE READ THE DOCUMENTATION IN THE DOC SUBDIRECTORY IF YOU GET STUCK! 
    2122 
    2223 
    …… 
    254255information. 
    255256 
     257There are many auxiliary programs not installed. You can find them under 
     258the prog subdirectory. A list can be found in doc/progs. 
     259 
    256260 
    257261Old and new I2C drivers 

  • lm-sensors/trunk/doc/modules

    r409 r569  
    1 This is a list of modules, the modules they depend on, and the module 
    2 parameters they define. First, some things about managing all these  
    3 modules. 
    4  
    51Managing Modules 
    62================ 
    …… 
    1814changing a module in one of the module directories; you also need to do 
    1915a 'killall -HUP kerneld' if you still use kerneld (kernel 2.2.x usually 
    20 uses kmod. 
     16uses kmod). 
    2117 
    2218Now you can do 'modprobe lm78', and all dependent modules are loaded 
    …… 
    3935  options i2c-core debug=2 
    4036 
    41 Finally, it is possible to auto-load the i2c-dev module if a /dev/i2c-* 
    42 file is accessed. You need the following line in the configuration file: 
    43   alias char-major-89 i2c-dev 
    44  
    4537With the above, the managing of all those modules is suddenly no problem 
    4638at all! 
    4739 
    4840 
    49 Available Modules 
    50 ================= 
    51  
    52 This does not list the chip and bus drivers; please examine the directories 
    53 doc/chips and doc/busses for more information about them. 
    54  
    55 (i2c) i2c-core: 
    56   The core i2c module (surprise!). Almost everything else depends on this one. 
    57   Module parameters: 
    58     i2c_debug (i) Set debug level 
    59  
    60 (src) i2c-proc: i2c-core 
    61   Creates /proc/bus/i2c* files. 
    62  
    63 (src) i2c-dev: smbus i2c-core 
    64   Grants access to /dev/i2c-* files 
    65  
    66 (src) smbus: i2c-core 
    67   SMBus emulation on i2c busses. Base algorithm, on which SMBus-only adapters 
    68   rely. 
    69  
    70 (src/busses) i2c-isa: i2c-core 
    71   Defines the ISA bus as being a I2C adapter. It isn't, of course; but this is 
    72   often used by sensor client modules, to keep the code small and simple. 
    73  
    74 (src) sensors: i2c-core 
    75   General purpose routines for sensor client modules 
    76  
    77 (i2c) algo-bit: i2c-core 
    78   The 'bit' algorithm, used by many i2c adapters 
    79   Module parameters: 
    80     bit_test (i) Test the lines of the bus to see if it is stuck 
    81     bit_scan (i) Scan for active chips on the bus 
    82     i2c_debug (i) debug level - 0 off; 1 normal; 2,3 more verbose;  
    83                   9 bit-protocol 
    84  
    85 (i2c) bit-lp: algo-bit i2c-core 
    86   I2C bus through the parallel port, Philips interface 
    87   Do not insert this module unless you are sure you have this interface; 
    88   it will block your parallel port, and cause fake devices to appear. 
    89   Module parameters: 
    90     base (i) Base address of parallel port 
    91  
    92 (i2c) bit-velle: algo-bit i2c-core 
    93   I2C bus through the parallel port, Vellemann K9000 interface 
    94   Do not insert this module unless you are sure you have this interface; 
    95   it will block your parallel port, and cause fake devices to appear. 
    96   Module parameters: 
    97     base (i) Base address of parallel port 
    98  
    99 (i2c) i2c-dev: i2c-core 
    100   /dev interface for I2C adapters. This is superseded by a module which 
    101   will also implement SMBus access. Please do not use this anymore. 
    102  
    103 Several other modules are not yet ported by Simon Vogl. They are mostly in 
    104 i2c/old-code. 
    105  
    106 Usually, if you load the modules through modprobe, you need the following 
    107 commands: 
    108   modprobe i2c-proc 
    109   modprobe i2c-dev  # Often not needed; see above 
    110   modprobe i2c-isa  # Unless you are certain no sensor chips live on the ISA bus 
    111   modprobe i2c-piix4 # One such line for each adapter you own 
    112   modprobe lm78     # One such line for each device you own 

  • lm-sensors/trunk/doc/progs

    r409 r569  
    88  and prints to stdout `bus' statements reflecting the currently detected 
    99  adapters. 
     10* prog/daemon/healthd.sh (written in bash, not installed) 
     11  An example of a very simple hardware health monitoring daemon. 
    1012* prog/detect/sensors-detect (written in Perl, installed by 'make install') 
    1113  This program tries to detect the available SMBus adapters and the chips 
    …… 
    5557  unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration 
    5658  file into account. 
    57  
    58 There are some programs distributed with Simon Vogl's i2c package too: 
    59 * i2c/detect/detect (written in C, not installed) 
    60   This program needs module `i2c-dev.o' to be loaded. It scans the complete 
    61   address range of a certain bus for connected devices. It will only work 
    62   for i2c-level drivers (not for PIIX4 busses). This program is superceded 
    63   by prog/detect/i2c-detect. 
    64 * i2c/eeprom/eeprom (written in C, not installed) 
    65   This program needs the i2c `eeprom.o' module (that is the one that is not 
    66   installed; it can be found in the i2c/drivers/ directory). It reads from 
    67   or writes to the eeprom. 
     59* prog/xeon/decode-xeon.pl (written in perl, not installed) 
     60  ID ROM data decoding for Xeon processors.