------------------------------------------------------------------------------
Linux WAN Router Utilities Package
------------------------------------------------------------------------------
Version 2.0.1
Nov 28, 1997
Author: Jaspreet Singh <jaspreet@sangoma.com>
Copyright (c) 1995-1997 Sangoma Technologies Inc.
------------------------------------------------------------------------------

INTRODUCTION

This is a set of utilities and shell scripts you need in order to be able to
use Linux kernel-level WAN Router.  Please read WAN Router User's manual
(router.txt) and WANPIPE driver documentation found in /usr/lib/router/doc
directory for installation and configuration instructions.

You can find the latest version of this software in /pub/linux directory on
Sangoma Technologies' anonymous FTP server (ftp.sangoma.com). 

For technical questions and/or comments please e-mail to jaspreet@sangoma.com.
For general inquiries please contact Sangoma Technologies Inc. by

	Hotline:	1-800-388-2475	(USA and Canada, toll free)
	Phone:		(905) 474-1990
	Fax:		(905) 474-9223
	E-mail:		dm@sangoma.com	(David Mandelstam)
	WWW:		http://www.sangoma.com



COPYRIGHT AND LICENSING INFORMATION

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 675 Mass
Ave, Cambridge, MA 02139, USA.



ACKNOLEDGEMENTS

This product is based on the WANPIPE(tm) Multiprotocol WAN Router developed
by Sangoma Technologies Inc. for Linux 1.2.x.  Success of the WANPIPE
together with the next major release of Linux kernel in summer 1996 commanded
adequate changes to the WANPIPE code to take full advantage of new Linux
features.

Instead of continuing developing proprietory interface tied to Sangoma WAN
cards, we decided to separate all hardware-independent code into a separate
module and defined two levels of interfaces - one for user-level applications
and another for kernel-level WAN drivers.  WANPIPE is now implemented as a
WAN driver compliant with the WAN Link Driver interface.  Also a general
purpose WAN configuration utility and a set of shell scripts was developed to 
support WAN router at the user level.

Many usefull ideas concerning hardware-independent interface implementation
were given by Mike McLagan <mike.mclagan@linux.org> and his implementation
of the Frame Relay router and drivers for Sangoma cards (dlci/sdla).

Special thanks to all the WANPIPE users who performed field-testing, reported
bugs and made valuable comments and suggestions that help us to improve this
product.



NEW IN THIS RELEASE

 o  This Version of WANPIPE supports only the S508 and S508/FT1 cards.  IF YOU
    OWN A S502E OR A S508 CARD THEN PLEASE CONTACT SANGOMA TECHNOLOGIES FOR AN
    UPGRADE. 

 o  Added new logic to avoid enabling of irq while it has been disabled by 
    another routine.

 o  Added more stats to reflect the above new logic.

 o  Improved Load Sharing for Multiple boards.

	

PRODUCT COMPONENTS AND RELATED FILES

/etc:
	router.conf	default router configuration file
	router.rc	meta-configuration file (used by the Setup script)

/lib/modules/X.Y.Z/misc:
	router.o	router kernel loadable module

/lib/modules/X.Y.Z/net:
	sdladrv.o	Sangoma SDLA support module
	wanpipe.o	Sangoma WANPIPE(tm) driver module

/proc/net/router
	Config		reads current router configuration
	Status		reads current router status
	{name}		reads WAN driver statistics

/usr/sbin:
	router		router start-up script
	wanconfig	router configuration utility
	sdladump	WANPIPE adapter memory dump utility
        fpipemon        Monitor for Frame Relay
        ppipemon        Monitor for PPP

/usr/lib/router:
	README		this file
	COPYING		GNU General Public License
	Setup		installation script
	Configure	configuration script
	Filelist	distribution definition file

/usr/lib/router/doc:
	router.txt	WAN Router User's Manual
	wanpipe.txt	WANPIPE(tm) WAN Driver User's Manual
	wanpipe.ipx	Notes on Configuring WANPIPE for IPX

/usr/lib/router/interfaces:
	*		interface configuration files (TCP/IP configuration)

/usr/lib/router/patches:
	router.gz	patche for Linux kernel 2.0.30.

/usr/lib/router/samples:
	interface	sample interface configuration file
	router.conf	sample router configuration file
	router.rc	sample meta-configuration file

/usr/lib/router/src:
	*		wan-tools source code

/usr/include/linux:
	router.h	router API definitions
	wanpipe.h	WANPIPE API definitions
	sdladrv.h	SDLA support module API definitions
	sdlasfm.h	SDLA firmware module definitions

/usr/src/linux/net/router:
	*		router source code

/var/log:
	router		router start-up log (created by the Setup script)

/var/lock:
	router		router lock file (created by the Setup script)

/usr/lib/router/wanpipe:
	x25_502.sfm	X.25 firmware for the Sangoma S502/S503 cards
	x25_508.sfm	X.25 firmware for the Sangoma S508 cards
	fr502.sfm	Frame relay firmware for the Sangoma S502/S503 cards
	fr508.sfm	Frame relay firmware for the Sangoma S508 card
	ppp502.sfm	PPP firmware for the Sangoma S502/S503 cards
	ppp508.sfm	PPP firmware for the Sangoma S508 card



REVISION HISTORY

1.0.0	December 31, 1996	Initial version

1.0.1	January 30, 1997	Status and statistics can be read via /proc
				filesystem entries.

1.0.2   April 30, 1997          Added UDP management via monitors.

1.0.3	June 3, 1997		UDP management for multiple boards using Frame
				Relay and PPP
				Enabled continuous transmission of Configure 
				Request Packet for PPP (for 508 only)
				Connection Timeout for PPP changed from 900 to 0
				Flow Control Problem fixed for Frame Relay

1.0.4	July 10, 1997		S508/FT1 monitoring capability in fpipemon and
				ppipemon utilities.
				Configurable TTL for UDP packets.
				Multicast and Broadcast IP source addresses are
				silently discarded.

1.0.5	July 28, 1997		Configurable T391,T392,N391,N392,N393 for Frame
				Relay in router.conf.
				Configurable Memory Address through router.conf 				for Frame Relay, PPP and X.25. (commenting this 				out enables auto-detection).
				Fixed freeing up received buffers using kfree() 				for Frame Relay and X.25.
				Protect sdla_peek() by calling save_flags(),
				cli() and restore_flags().
				Changed number of Trace elements from 32 to 20
				Added DLCI specific data monitoring in FPIPEMON. 
2.0.0	Nov 07, 1997		Implemented protection of RACE conditions by 
				critical flags for FRAME RELAY and PPP.
				DLCI List interrupt mode implemented.
				IPX support in FRAME RELAY and PPP.
				IPX Server Support (MARS)
				More driver specific stats included in FPIPEMON
				and PIPEMON.

2.0.1	Nov 28, 1997		Bug Fixes for version 2.0.0.
				Protection of "enable_irq()" while 
				"disable_irq()" has been enabled from any other
				routine (for Frame Relay, PPP and X25).
				Added additional Stats for Fpipemon and Ppipemon
				Improved Load Sharing for multiple boards
>>>>>> END OF README <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
