FarSync Drivers

WAN Configuration Utility

The farutil program is used in all aspects of device and line management. 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 will depend on which driver is being used, as follows:

Configure ports

To create, or change, the configuration of a port, the farutil command should be used in the following format:
    farutil < ifname > set [parameters]

where:
ifname is hdlcX, e.g. hdlc0

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

Examples:

    farutil hdlc0 set media e1 proto cisco mode master datarate 64000 startslot 15
    farutil sync0 set media x21 proto ppp clock ext
    farutil sync0 set proto cisco interval 100 timeout 5
    farutil hdlc0 set proto fr lmi ansi

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:   T2U FarSync WAN T-Series
    ports:  2
    state:  Running normally

For a Flex USB device the following will be displayed:

    [root@zaphod kernel-oem]# farutil sync4 card
    card:           FarSync Flex WAN
    ports:          1
    state:          Running normally

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:

    [root@minion common]# farutil sync0 info

    card:   T2U Farsync WAN T-Series
    ports:  2
    state:  Running normally

    firmware id:    3
    firmware vers:  0.00.03

    Configuration for port 0
    physical:       X.21 (RS422/V.11)
    cable status:   Cable presence detected
    active inputs:  Indicate
    active outputs: Control
    clock:          External, Detected
    speed:          0
    protocol:       Sync PPP

Note
When dual clocking mode has been configured the physical interface will displayed as X21d. 
When the clock phase has been inverted, the clock will be displayed as Internal/Inverted
Clock detection means that a transmit clock is present.

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

Identify a card

The ordering of PCI slots used to identify 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 <ifname> 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 <ifname> set led normal

Create FR dlci

When using the Frame Relay protocol you will need to create a dlci on an existing frame relay interface in order to send and receive data over Frame Relay.  The farutil command can be used in the following way to do this:

    farutil < ifname > create [dlci]
where:
ifname  is a name of the form hdlcX, e.g. hdlc0
dlci  is a number in the range 16 to 1023

Note:
The <ifname> interface must already exist.

Example:

    farutil hdlc0 create 16

Delete FR dlci

To delete an existing dlci, the farutil command should be used in the following format:
    farutil < ifname > delete [dlci]

where:
ifname is a name of the form hdlcX, e.g. hdlc0
dlci     is a number in the range 16 to 1023

Note: The <ifname> interface must already exist.

Example:

    farutil hdlc0 delete 16

Download firmware

To download 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
Copyright © 2001-2021 FarSite Communications Ltd.