diff --git a/INSTALL b/INSTALL index e1e27416..fb96702b 100644 --- a/INSTALL +++ b/INSTALL @@ -18,6 +18,7 @@ NOTE: OPTION 2 WILL CURRENTLY NOT WORK FOR 2.0 AND OLDER 2.1 KERNELS! NOTE: IN EACH CASE, YOU WILL HAVE TO GET AND INSTALL THE I2C PACKAGE FIRST! +NOTE: PLEASE READ THE DOCUMENTATION IN THE DOC SUBDIRECTORY IF YOU GET STUCK! Installing the i2c package @@ -253,6 +254,9 @@ sensor devices. There is also a manual page for this program. Calling specified in /etc/sensors.conf. Again, read the manual pages for more information. +There are many auxiliary programs not installed. You can find them under +the prog subdirectory. A list can be found in doc/progs. + Old and new I2C drivers ======================= diff --git a/doc/modules b/doc/modules index c8b46419..3c15e2a7 100644 --- a/doc/modules +++ b/doc/modules @@ -1,7 +1,3 @@ -This is a list of modules, the modules they depend on, and the module -parameters they define. First, some things about managing all these -modules. - Managing Modules ================ @@ -17,7 +13,7 @@ which file is used depends on your distribution): Do always a 'depmod -a' after changing either your configuration file or changing a module in one of the module directories; you also need to do a 'killall -HUP kerneld' if you still use kerneld (kernel 2.2.x usually -uses kmod. +uses kmod). Now you can do 'modprobe lm78', and all dependent modules are loaded automatically. You could, of course, add this statement (and related @@ -38,75 +34,7 @@ enter at the insmod command, in the configuration file. The syntax is as follows: options i2c-core debug=2 -Finally, it is possible to auto-load the i2c-dev module if a /dev/i2c-* -file is accessed. You need the following line in the configuration file: - alias char-major-89 i2c-dev - With the above, the managing of all those modules is suddenly no problem at all! -Available Modules -================= - -This does not list the chip and bus drivers; please examine the directories -doc/chips and doc/busses for more information about them. - -(i2c) i2c-core: - The core i2c module (surprise!). Almost everything else depends on this one. - Module parameters: - i2c_debug (i) Set debug level - -(src) i2c-proc: i2c-core - Creates /proc/bus/i2c* files. - -(src) i2c-dev: smbus i2c-core - Grants access to /dev/i2c-* files - -(src) smbus: i2c-core - SMBus emulation on i2c busses. Base algorithm, on which SMBus-only adapters - rely. - -(src/busses) i2c-isa: i2c-core - Defines the ISA bus as being a I2C adapter. It isn't, of course; but this is - often used by sensor client modules, to keep the code small and simple. - -(src) sensors: i2c-core - General purpose routines for sensor client modules - -(i2c) algo-bit: i2c-core - The 'bit' algorithm, used by many i2c adapters - Module parameters: - bit_test (i) Test the lines of the bus to see if it is stuck - bit_scan (i) Scan for active chips on the bus - i2c_debug (i) debug level - 0 off; 1 normal; 2,3 more verbose; - 9 bit-protocol - -(i2c) bit-lp: algo-bit i2c-core - I2C bus through the parallel port, Philips interface - Do not insert this module unless you are sure you have this interface; - it will block your parallel port, and cause fake devices to appear. - Module parameters: - base (i) Base address of parallel port - -(i2c) bit-velle: algo-bit i2c-core - I2C bus through the parallel port, Vellemann K9000 interface - Do not insert this module unless you are sure you have this interface; - it will block your parallel port, and cause fake devices to appear. - Module parameters: - base (i) Base address of parallel port - -(i2c) i2c-dev: i2c-core - /dev interface for I2C adapters. This is superseded by a module which - will also implement SMBus access. Please do not use this anymore. - -Several other modules are not yet ported by Simon Vogl. They are mostly in -i2c/old-code. - -Usually, if you load the modules through modprobe, you need the following -commands: - modprobe i2c-proc - modprobe i2c-dev # Often not needed; see above - modprobe i2c-isa # Unless you are certain no sensor chips live on the ISA bus - modprobe i2c-piix4 # One such line for each adapter you own - modprobe lm78 # One such line for each device you own diff --git a/doc/progs b/doc/progs index 0ed38a92..9952287c 100644 --- a/doc/progs +++ b/doc/progs @@ -7,6 +7,8 @@ this package. file. It read /proc/bus/i2c (or the file specified on the command-line), and prints to stdout `bus' statements reflecting the currently detected adapters. +* prog/daemon/healthd.sh (written in bash, not installed) + An example of a very simple hardware health monitoring daemon. * prog/detect/sensors-detect (written in Perl, installed by 'make install') This program tries to detect the available SMBus adapters and the chips connected to them and/or the ISA bus. It also generates modprobe lines @@ -54,14 +56,5 @@ this package. console application, using stdin and stdout. It is essential, because unlike the raw /proc/sys/dev/sensors/*/* files, it takes your configuration file into account. - -There are some programs distributed with Simon Vogl's i2c package too: -* i2c/detect/detect (written in C, not installed) - This program needs module `i2c-dev.o' to be loaded. It scans the complete - address range of a certain bus for connected devices. It will only work - for i2c-level drivers (not for PIIX4 busses). This program is superceded - by prog/detect/i2c-detect. -* i2c/eeprom/eeprom (written in C, not installed) - This program needs the i2c `eeprom.o' module (that is the one that is not - installed; it can be found in the i2c/drivers/ directory). It reads from - or writes to the eeprom. +* prog/xeon/decode-xeon.pl (written in perl, not installed) + ID ROM data decoding for Xeon processors.