More documentation updates

git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@217 7894878c-1315-0410-8ee3-d5d059ff63e0

INSTALL

@@ -129,6 +129,16 @@ Replace /WHEREVER/lm_sensors-2.X.Y with the base directory of the package
 source code.
 
 Please examine the files in the doc subdirectory for more information, 
-especially about individual driver. You can always mail us at 
+especially about individual drivers. You can always mail us at 
 <lm78@stimpy.netroedge.com>. Alternatively, consider useing the (free)
 support site at http://www.netroedge.com/~lm78/support.html. Good luck!
+
+
+USEFUL PROGRAMS
+===============
+
+The prog subdirectory contains lots of useful programs, many of which are
+not installed. doc/progs contains some documentation for each of them.
+Most important are prog/mkdev/mkdev.sh, which creates /dev/i2c-* files,
+and prog/detect/dectect.pl, which tries to detect what adapters are
+present on your system.

Makefile

@@ -114,7 +114,7 @@ MANGRP := root
 
 # The subdirectories we need to build things in 
 SRCDIRS := kernel kernel/busses kernel/chips kernel/include lib prog/sensors \
-           prog/dump prog/doc etc
+           prog/dump prog/doc prog/detect etc
 ifeq ($(I2C),1)
 SRCDIRS += i2c i2c/detect i2c/drivers i2c/eeprom
 endif

doc/FAQ

@@ -4,7 +4,7 @@ Sensors FAQ for lm_sensors version 2
 [Internal comments/questions/uncertainties are in square brackets.]
 
 Note: some questions were specific for version 1. These are put together
-under chapter 5: version 1 questions.
+under chapter 6: version 1 questions.
 
 1 What sensors are available on my PC?
 1.1 What can a sensor chip like the "LM78" do? 
@@ -62,8 +62,8 @@ a few moments)" message. Why?
 
 1 What sensors are available on my PC?
 
-	Most medium/high-end computers since late 1997 now come with a LM78 or 
+	Most medium/high-end computers since late 1997 now come with a LM78- or 
-LM79 hardware health monitoring chip and an SMBus. 
+LM79-like hardware health monitoring chip and an SMBus. 
 	
 	
 1.1 What can a sensor chip like the "LM78" do? 
@@ -214,18 +214,20 @@ gl518sm.o and w83781d.o at this moment). Type 'sensors' to determine whether
 the read values make any sense. Remove modules if you are convinced that
 the values are bogus. Also, see some of the driver-specific questions below.
 	There will be an automatic detection program in later versions of
-this package; it is simply not implemented yet. We need the /dev interface
+this package; it is only partially  implemented yet. Look for it in the
-first. Sorry for the inconvenience, in the meantime.
+prog/detect directory. For 2.2.0, it will only be able to detect the bus
+type, not the chip type.
 
 
 3.3 Which modules should I insert?
 
-	Using modprobe, you should always insert i2c-proc.o. You need one
+	Using modprobe, you should always insert i2c-proc.o, and optionally
-module for each adapter you own; if there are chips on the ISA bus, this
+i2c-dev.o. You need one module for each adapter you own; if there are 
-includes isa.o. Finally, you need one module for each type of chip you
+chips on the ISA bus, this includes isa.o. Finally, you need one module 
-own. That's all. On my computer, I could use the following line:
+for each type of chip you own. That's all. On my computer, I could use the 
-    modprobe i2c-proc && modprobe isa && modprobe piix4 && modprobe lm78 \
+following line:
-                      && modprobe lm75
+    modprobe i2c-proc && modprobe i2c-isa && modprobe i2c-piix4 && \
+                         modprobe lm78 && modprobe lm75 && modprobe i2c-dev
 
 
 3.4 Do I need the configuration file?
@@ -512,6 +514,7 @@ can not be sure.
 
 
 -----------
+Rev 2.1 (Frodo) Corrections for lm_sensors 2.2, 19990112
 Rev 2.0 (Frodo) Major revision for lm_sensors 2.1, 19981229
 Rev 1.10 (Frodo) Modified 3.8, updated some other things, 19980924
 Rev 1.9 (Frodo) Added 3.15, 19980906

doc/cvs

@@ -5,7 +5,7 @@ the latest and greatest version of lm_sensors, or any older version.
 You need the rcs and cvs package, which can be retrieved from any GNU
 mirror site (prep.ai.mit.edu is the master site).
 
-1) Go to the directory where you want lm_sensors (and lm_sensors2?)
+1) Go to the directory where you want lm_sensors (and/or lm_sensors2)
    directory/ies to reside with the project source code.  A good choice is
    your home directory.
 
@@ -18,6 +18,7 @@ mirror site (prep.ai.mit.edu is the master site).
      cvs -d :pserver:anon@penn.netroedge.com:/home/cvs checkout lm_sensors
    or:
      cvs -d :pserver:anon@penn.netroedge.com:/home/cvs checkout lm_sensors2
+   Use lm_sensors2 for the 2.x tree.
 
 4) Now you have a directory named "lm_sensors" (or lm_sensors2) with all
    the files in it. In a day or two when there have been some changes to

doc/modules

@@ -56,30 +56,48 @@ at all!
   SMBus emulation on i2c busses. Base algorithm, on which SMBus-only adapters
   rely.
 
-(src) i2c-piix4: smbus i2c-core
+(src/busses) i2c-piix4: smbus i2c-core
   PIIX4 SMBus access.
 
-(src) i2c-via: algo-bit i2c-core
+(src/busses) i2c-via: algo-bit i2c-core
   VIA VT82C586B bus access. This is often used instead of the PIIX4 as SMBus
   host.
 
-(src) i2c-isa: i2c-core
+(src/busses) i2c-ali15x3: smbus i2c-core
+  Acer Labs M1541 and M1543C bus access.
+
+(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
 
-(src) lm78: sensors smbus i2c-core
+(src/chips) lm78: sensors smbus i2c-core
   LM78, LM78-J and LM79 chip driver
 
-(src) lm75: sensors smbus i2c-core
+(src/chips) lm75: sensors smbus i2c-core
   LM75 chip driver
 
-(src) gl518sm: sensors smbus i2c-core
+(src/chips) gl518sm: sensors smbus i2c-core
   GL518SM revision 0x00 and 0x80 chip driver
 
-(src) eeprom: sensors smbus i2c-core
+(src/chips) adm1021: sensors smbus i2c-core
+  ADM1021 chip driver 
+
+(src/chips) adm9240: sensors smbus i2c-core
+  ADM9240 chip driver
+
+(src/chips) ltc1710: sensors smbus i2c-core
+  LTC1710 chip driver
+
+(src/chips) sis5595: sensors smbus i2c-core
+  SIS-5595 chipset hardware monitor driver
+
+(src/chips) w83781d: sensors smbus i2c-core
+  W83781D chip driver
+
+(src/chips) eeprom: sensors smbus i2c-core
   Driver for DIMMs connected to the SMBus. You need prog/eeprom/decode-dimms.pl
   to make sense of its output.
 
@@ -106,8 +124,8 @@ at all!
     base (i) Base address of parallel port
 
 (i2c) i2c-dev: i2c-core
-  /dev interface for I2C adapters. This will be superseded by a module which
+  /dev interface for I2C adapters. This is superseded by a module which
-  will also implement SMBus access.
+  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.
@@ -115,6 +133,6 @@ i2c/old-code.
 Usually, if you load the modules through modprobe, you need the following
 commands:
   modprobe i2c-proc
-  modprobe isa     # Unless you are certain no sensor chips live on the ISA bus
+  modprobe i2c-isa  # Unless you are certain no sensor chips live on the ISA bus
-  modprobe piix4   # One such line for each adapter you own
+  modprobe i2c-piix4 # One such line for each adapter you own
-  modprobe lm78    # One such line for each device you own
+  modprobe lm78     # One such line for each device you own

doc/progs

@@ -7,6 +7,18 @@ 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/detect/dectect.pl (written in Perl, not installed)
+  This program tries to detect the available SMBus adapters. In time, it will
+  also scan each adapter for supported devices (chips).
+* prog/detect/i2cdetect (written in C, not installed)
+  This program scans your complete I2C or SMBus adapter for connected devices.
+  Not all devices can be detected in this way, though; and it may hang your
+  bus. Syntax:
+    ./i2cdetect 0
+  Here the '0' stands for i2c-0 (check /proc/bus/i2c to find out which bus
+  you need).
+* prog/doc/doc-features (written in C, not installed)
+  This program is/will be used to help us generate chip driver documentation.
 * prog/dump/i2cdump (written in C, not installed)
   This program helps to dump the registers of a I2C device that understands
   the 'byte data' or 'word data' SMBus protocols. Usual syntax:
@@ -36,7 +48,8 @@ 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).
+  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

doc/version-2

@@ -17,3 +17,4 @@ package. Some of the more important ones:
   can (through libsensors) be used by any application, and which describes
   how all sensor readings are to be interpreted.
 * All code has been completely rewritten.
+* Many new drivers