FarSync Drivers

OEM Configuration Utility

When using the OEM driver it is expected that the application will configure the line interfaces rather than using the  farutil program.  However, the farutil program will be useful for monitoring the port status etc.  With this utility you can: This command is called by the startup and configuration script to issue farutil commands, based upon the contents of the configuration files. The syntax of the command is as follows:

farutil [-v] interface command [parameters...]

The -v option can be used at any time to report additional information.

Note that the naming convention for the interface used in the farutil command is as follows:

Configure ports

Although this is not recommended to configure interfaces in this way, the syntax of the farutil command for setting parameters is as follows:

farutil < ifname > set [parameters]

where:
ifname is a name of the form syncX, e.g. sync0

The list of card parameters that can be used with the farutil command is given here. Example:

farutil sync0 set media x21 proto raw clock ext

Note on use of config files
If you have used the ifup file in combination with the config file to set the card parameters, then the application will not be able to set an MTU size greater than 1500 bytes.  The application can set any size MTU as long as the ifup scripts have not been used or the driver has been restarted.

Display card details

To display card details the farutil command should be used in the following format:
farutil < ifname > card
This will display the following information:
[root@minion common]# farutil sync0 card
  card:           T4U FarSync WAN T-Series
  ports:          4
  state:          Running normally
root@minion common]#
For a Flex USB device the following will be displayed:
[root@zaphod kernel2.6-oem]# farutil sync4 card
  card:           FarSync Flex WAN
  ports:          1
  state:          Running normally
root@zaphod kernel2.6-oem]#

Display status information

To display port status information the farutil command should be used in the following format:
farutil < ifname > info 
This will display the following information:
card:           T4U FarSync WAN T-Series
ports:          4
state:          Running normally

firmware id:    5       firmware vers:  1.02.03

Configuration for port 0 
physical:       V.24 (RS232C)
  cable status:         Cable presence detected
  active inputs:        None
  active outputs:       None
  clock:                External, Not detected
  speed:                9600
protocol:       Raw packet interface
Buffer configuration:
  no of rx buffers:     8       size of rx buffers:     8192
  no of tx buffers:     8       size of tx buffers:     8192
root@minion common]#

Note
Once dual clocking mode has been configured the physical interface will be displayed as x21d.
When the clock phase has been inverted, the clock will be displayed as Internal/Inverted

Display Stats Information

To display port transmit and receive statistics the farutil command can be used in the following format:

farutil < ifname > stats 
This will display the following information:
card: T2U FarSync WAN T-Series
ports: 2
state: Running normally
Port Statistics:
	Rx packets 254085708 	Rx bytes 259450471210
	Tx packets 252438310 	Tx bytes 255695421894
	Rx errors 2 		Tx errors 34
	Rx dropped 0 		Tx dropped 0

Rx errors detail: 		Tx errors detail:
	Rx length 0 		Tx aborted 18
	Rx over run 0 		Tx carrier 0
	Rx crc 2 			Tx fifo 0
	Rx frame 2 		Tx under run 0
	Rx fifo 0

Download firmware

To down load the card firmware the farutil command should be used in the following format:

farutil < ifname > load [bios] [firmware]

where:

ifname    is a name of the form syncX, e.g. sync0
bios      is the trtbios.cde file from the downloads directory
firmware  is the farsync2.cde file from the downloads directory 

Example:

[root@minion common]# farutil -v sync0 load downloads/trtbios.cde downloads/farsync2.cde 
BIOS code start address: 0000:0550
BIOS code header size  : 512 bytes
Skipping 484 header bytes
Read 2934 bytes of BIOS code
Firmware start address: 018A:0016
Firmware header size  : 512 bytes
Read 9728 bytes of Firmware
Card running

[root@minion common]# 

Identify a card

The ordering of PCI slots used to idetify different cards in the system does not always follow a simple mechanical sequence. Some system cases even miss-label the slots, being intended for different motherboards. This can be quite confusing. To address this problem a card identifying facility is provided. The command:
farutil syncX set led flash
will identify the board to which the interface syncX is attached to by causing the board's status LEDs to flash continuously. Normal operation of the LEDs can be restored with:
farutil syncX set led normal
Copyright 2001-2010 FarSite Communications Ltd.