1. OLICOM.EXE Driver
2. INSTALL.TXT File Contents

INSTALL.TXT Driver File Contents (OLICOM.EXE)

Installing the Olicom Linux driver
==================================

The Olicom Linux Token-Ring driver (OLTR) is distributed as a
source-patch against the standard Linux 2.0.x and 2.2.x kernel
sources. To install it, you need to

* download the Linux kernel sources
* download the OLTR driver patch
* unpack the kernel sources
* apply the OLTR patch
* reconfigure the kernel
  (be sure to enable Token-Ring and Olicom support)
* recompile the kernel and kernel modules
* install the new kernel and modules
* reboot

A brief description of the proces is given below, but it is
recommended that you consult the "Kernel HOWTO" from the Linux
Documentation Project for a more in-depth discussion. This HOWTO
document can be found at

   http://sunsite.unc.edu/pub/LDP/HOWTO/Kernel-HOWTO.html

It is also included with many Linux distributions; look in the
/usr/doc/HOWTO directory on your Linux system to see if it is already
there.


Rebuilding the Linux kernel
===========================

NOTE: Rebuilding the kernel requires that your system has the
necessary development tools installed. The following programs should
be available before you attempt this:

- gzip                      [RPM package: gzip]
- tar                       [RPM package: tar]
- patch                     [RPM package: patch]
- make                      [RPM package: make]
- gcc                       [RPM package: gcc]
- ld, as, ar, nm, strip     [RPM package: binutils]
- as86, ld86                [RPM package: bin86]
- perl                      [RPM package: perl]

Before attempting to rebuild the Linux kernel, you should login as
"root" to ensure you have sufficient privileges. Also, make sure that
you have at least 30 MB of disk space available on the partition
holding the /usr/src directory.


Downloading the kernel sources
------------------------------

The Linux kernel sources are available from several ftp servers around
the globe. The official distribution sites for the 2.0 and 2.2 (stable)
kernels are:

   ftp://ftp.kernel.org/pub/linux/kernel/v2.0/
   ftp://ftp.kernel.org/pub/linux/kernel/v2.2/

However, this directory is mirrored on all of the major Linux ftp
archives, including sunsite.unc.edu, ftp.funet.fi, and tsx-11.mit.edu

At the time of writing, the latest 2.0 kernel is 2.0.36, so if you are
running a 2.0 kernel you should get the file "linux-2.0.36.tar.gz" from
the v2.0 directory.

At the time of writing, the latest 2.2 kernel is 2.2.9, so if you are
running a 2.2 kernel you should get the file "linux-2.2.9.tar.gz" from
the v2.2 directory.


Downloading the OLTR driver
---------------------------

The OLTR driver consists of two patches. The first patch is the driver
sources and the second is a kernel specific patch for modifying make
files etc.

The OLTR driver patch is available from

   ftp://ftp.olicom.dk/releases/Unix-Driver/Linux/oltr-134.gz

The OLTR patch for Linux 2.0.36 is available from

   ftp://ftp.olicom.dk/releases/Unix-Driver/Linux/oltr2036.gz

The OLTR patch for Linux 2.2.9 is available from

   ftp://ftp.olicom.dk/releases/Unix-Driver/Linux/oltr229.gz

The 2.2.9 kernel patch should work for all 2.2.x kernels whereas the
2.0.36 kernel patch will work for the 2.0.36 kernel only.


Unpacking the kernel sources
----------------------------

It is assumed that you have the linux-2.0.36.tar.gz file in the /tmp
directory. If they are located elsewhere on your system, change the
filenames accordingly in the commands shown below.

By convention, the Linux kernel sources are unpacked into the
/usr/src/linux directory. Before unpacking them, you should make sure
that this directory does not exist in advance:

   cd /usr/src
   ls -l

If you see something like this:
   lrwxrwxrwx   1 root  root    12 Jan 20 10:18 linux -> linux-2.0.32
   drwxr-xr-x  15 root  root  1024 Jan 20 15:37 linux-2.0.32

then you have an older copy of the Linux kernel sources installed. To
avoid getting these mixed up, rename the "linux" directory to
"linux.old":

   mv linux linux.old

Now, unpack the Linux 2.0.36 kernel sources using the command

   cd /usr/src
   tar zxf /tmp/linux-2.0.36.tar.gz

This unpacks all of the files, which might take a while. When done,
a "linux/" directory has been created.


Applying the OLTR driver patch
------------------------------

It is assumed that you have the oltr-134.gz and the oltr2036.gz files
in the /tmp directory.

   cd /usr/src/linux
   gzip -d -c /tmp/oltr-134.gz | patch -s -p1
   gzip -d -c /tmp/oltr2036.gz | patch -s -p1

There should be no error messages. Several new files should appear in
the drivers/net subdirectory, including "oltr_d.c", "trlld.h" and
several files with a ".uue" extension.


Configuring the kernel
----------------------

   cd /usr/src/linux
   make config

Reconfiguring the kernel means selecting or deselecting the drivers,
filesystems and other features that you want to include or leave out
the the kernel. An explanation of all the configuration options is
beyond the scope of this document; refer to the Kernel-HOWTO (see URL
above) or use the on-line help (enter "?" when prompted for an option)
to determine which options should be included in the kernel.

However, to use the Olicom driver you must enable (answer "Y" to):

- Networking support
- PCI BIOS support (if you use an Olicom PCI adapter)
- TCP/IP networking
- Network device support
- Token-Ring driver support
- Olicom Token-Ring adapter support

Even though it will work to compile the Olicom Token-Ring driver as
part of the kernel it is highly recommended that you compile it as
a loadable kernel module. To do so, you should answer 'M' (and not
'Y') to:

- Olicom Token-Ring adapter support

Also remember to enable loadable module support.

- Loadable Module support

Here answer 'Y' to enable loadable module support and Kernel module
loader. 

Note: Even if you compile the driver as a module, you still need to
recompile the kernel itself as the supplied kernel patch modifies
some of the non-device specific network source files.

Note: An alternative to the "make config" command is "make
menuconfig", or "make xconfig" (if you are running inside the X Window
environment). These have a nicer and easier to use interface.


Compiling the kernel and kernel modules
---------------------------------------

   cd /usr/src/linux
   make dep
   make clean
   make zImage     (or make bzImage)
   make modules

Note that depending upon the speed of your system and the amount of
RAM installed, this may take anywhere from a few minutes to several
hours to complete.


Installing the new kernel and kernel modules
--------------------------------------------

   cd /usr/src/linux
   cp arch/i386/boot/zImage /boot/vmlinuz-2.0.36
   cp System.map /boot/System.map-2.0.36
   make modules_install
   cd /boot
   ln -sf vmlinuz-2.0.36 vmlinuz
   ln -sf System.map-2.0.36 System.map

If you are using LILO (the Linux bootstrap loader included with most
distributions), you should check that the LILO configuration file has
an entry for booting the file "/boot/vmlinuz". There should be a
section in the file that looks like this:

   image = /boot/vmlinuz
     root = /dev/hda1
     label = Linux
     read-only

The actual device listed in "root =" may be different, depending upon
your disk partitioning. Also, the "label =" setting can be different.
If there is no entry for booting "/boot/vmlinuz", use the above
template but REMEMBER to change the "root =" setting to match your
system.

When the /etc/lilo.conf file is correct, run the command

   /sbin/lilo

to update the LILO boot-loader with the new kernel.


Rebooting with the new kernel
-----------------------------

Shutdown and restart the system. At the LILO: prompt, enter the label
that you selected in the LILO configuration for the new kernel. When
the system comes up, the Olicom driver should register network devices
for all Olicom cards - these will be called "eth0", "eth1" etc. Use
the standard Linux utilities (ifconfig, the RedHat control-panel etc.)
to configure the network according to your particular setup.

Note: If you are using the OLTR patch with a Linux 2.2.x kernel, the
network device will be called "tr0", "tr1" etc.