INSTALL instructions for kernel module iowarrior

PREREQUSITES
------------
    The sources for your kernel must be installed
    The sources must be configured  

Everything else is done by the Makefile.

COMPILING
---------
    cd into the directory where you unpacked the sources for the module
    cd iowarrior-2.6
    make

This should compile the module. 

LOADING 
--------
If there where no errors during the compile stage we can now
load the module in the running kernel.
There are 2 different targets in the Makefile to do this

    make install       - loads the module into the kernel

    make install_debug - loads the modules with debugging messages 
                         enabled (read them with dmesg )

CREATING DEVICES-NODES WITH UDEV
--------------------------------
Now we have to create the device-nodes to which the iowarriors
will be attached. The preferred way to do this is to use the 
"udev"-daemon which is available on almost every modern
Linux distribution. The installed version of udev must be >= 059.
The script checks for the udev-binaries and config at:
    /sbin/udevd      
    /sbin/udevcontrol 
    /etc/udev/udev.conf

The Makefile target

    make udev

will try its best to detect wether udev is installed and update
the configuration so the iowarriors are handled by udev.

If you don't see any errors in this step, you are ready to test
you installation:
    
    list the contents of /dev/usb 
    (It's ok if the directory does not exist at all)

    plug your iowarrior

    the directory /dev/usb should now have two entries
    /dev/usb/iowarrior0 /dev/usb/iowarrior1

    unplug your iowarrior
    the device-nodes should be gone 
    (the directory /dev/usb probably too)

The permissions on the new device-nodes will grant read/write access
to group users.

CREATING STATIC DEVICES-NODES
-----------------------------
If you have udev installed - use it!

Using static device-nodes for the iowarrior is discouraged because :

1 ) The /dev directory might be on a temporary file-system 
    so the nodes will disappear on every reboot.

2)  You loose all the features udev provides like
    creating a unique device-name for an IOWarrior
    based on the product-id and/or serial-number  
    or notification on new devices through a socket.

But if you really want to go for it there is a target in the Makefile:
    make nodes 
This will create 16 static device nodes in directory /dev/usb
 
SAMPLES
-------
There a few examples (also a README and a Makefile) in the samples directory.

TESTED ENVIRONMENTS
-------------------
The module has been tested on
    Opensuse 10.0-i386
    Opensuse 10.1-i386
    Opensuse 10.1-x86_64
    Ubuntu 6.10	

KNOWN BUGS
----------
IOWarriors sometimes don't show up if the Option :
    
    Dynamic USB minor allocation (EXPERIMENTAL) (USB_DYNAMIC_MINORS)

is set in your kernel. 

