FarSync Drivers

Manual Software Installation

This section provides some helpful notes if you are not able to run the install script to perform the software installation, for example if you need to install the software on an embedded system.  However, it is assumed that you will build the software on a host system and then transfer the required modules and executables to your target system.  These notes are generic for all versions of the FarSync drivers.



Preparation

On your host system select a working directory and then untar the product archive into that directory.  For example

  mkdir /farsync
  cp farsync-1.09.05-b137.tar.gz /farsync
  cd /farsync
  tar -zxvf farsync-1.09.05-b137.tar.gz

It is suggested that the following directories are used to collect the various component outputs from each stage.

  mkdir build_outputs
  mkdir build_outputs/drivers
  mkdir build_outputs/utilities

The first step will be to build the Kernel modules.

Kernel Modules

If you are building on a host system and transferring the software to a target system, then the host and target system should be running the exact same version of the Kernel.  You should have made all the pre-installation checks to ensure that make, gcc and the Kernel headers are all in place etc.  Follow one of the following steps depending if you are installing the OEM or WAN driver.

Farsync OEM Driver

The required outputs from this stage are:

Proceed with the following steps:

cd farsync-1.09.05-b137
cd kernel2.6-oem
cp ../includes/*.h .
make
cp farsync.ko /farsync/build_outputs/drivers
cp fsflex.ko /farsync/build_outputs/drivers
cd ../common
make
cp farutil /farsync/build_outputs/utilities
cp -r downloads /farsync/build_outputs/utilities
cp farsync-init-rh /farsync/build_outputs/utilities

Farsync WAN Driver

The required outputs from this stage are:

Proceed with the following steps:

cd farsync-1.09.05-b137
cd kernel2.6-hdlc
cp ../includes/*.h .
make
cp farsync.ko /farsync/build_outputs/drivers
cp fsflex.ko /farsync/build_outputs/drivers
cd ../common
make
cp farutil /farsync/build_outputs/utilities
cp -r downloads /farsync/build_outputs/utilities
cp farsync-init-rh /farsync/build_outputs/utilities

Installing the Components

During this process we have been accumulating the components to be installed into the build_outputs directory.  It is now time to copy them in place.  You may need to make a tar.gz archive of the build_outputs directory to transfer to your target system. For the purposes of this example, however, the following describes where they would be copied to if the installation were being performed on Red Hat Enterprise Linux.

If you target platform doesn't support the init boot method, where startup scripts from /etc/init.d/ are linked to the /etc/rc.d/rcX.d directories for startup and shutdown in the various run levels then this example and the associated scripts will need much modification.

The following is the output of the example script above to copy the contents of the build_outputs directory on a Red Hat based system.

chkconfig is the Red Hat way of installing an init script into the init system.  The equivalent for SuSe is insserv and for Ubuntu is update-rc.d

mkdir /lib/modules/`uname -r`/kernel/drivers/net/wan
cp /farsync/build_outputs/drivers/farsync.ko /lib/modules/`uname -r`/kernel/drivers/net
cp /farsync/build_outputs/drivers/fsflex.ko /lib/modules/`uname -r`/kernel/drivers/net
cp /farsync/build_outputs/utilities/farutil /sbin
mkdir /etc/farsite
mkdir /etc/farsite/downloads
cp /farsync/build_outputs/utilities/downloads/* /etc/farsite/downloads
cp /farsync/build_outputs/utilities/farsync-init-rh /etc/init.d/farsync
chkconfig --add farsync
depmod -a

Starting the Driver

If the chkconfig (or equivalent) command was used then the drivers should be loaded when the system boots.  While the system is running, the drivers can be stopped and started with the following commands.

/etc/init.d/farsync stop
/etc/init.d/farsync start

Notes

  1. If your target system supports hotplug then when the farsync or the flex drivers are loaded it may produce a message in the system log reporting that a configuration file for the device could not be found.  This can be safely ignored.
  2. The above install process linked the init scripts into the init subsystem.  But your target system may not include this.  Please refer to you target system documentation as to how to load drivers and start daemon processes.

Copyright © 2001-2010 FarSite Communications Ltd.