Documentation/networking/wanpipe.txt

   1 ------------------------------------------------------------------------------
   2 Linux WAN Router Utilities Package
   3 ------------------------------------------------------------------------------
   4 Version 2.1.1
   5 Nov 08, 1999
   6 Author: Nenad Corbic <ncorbic@sangoma.com>
   7 Copyright (c) 1995-1999 Sangoma Technologies Inc.
   8 ------------------------------------------------------------------------------
   9
  10 INTRODUCTION
  11
  12 This is a set of utilities and shell scripts you need in order to be able to
  13 use Linux kernel-level WAN Router.  Please read WAN Router User's manual
  14 (router.txt) and WANPIPE driver documentation found in /usr/lib/router/doc
  15 directory for installation and configuration instructions.
  16
  17 You can find the latest version of this software in /pub/linux directory on
  18 Sangoma Technologies' anonymous FTP server (ftp.sangoma.com).
  19
  20 For technical questions and/or comments please e-mail to ncorbic@sangoma.com.
  21 For general inquiries please contact Sangoma Technologies Inc. by
  22
  23         Hotline:        1-800-388-2475  (USA and Canada, toll free)
  24         Phone:          (905) 474-1990
  25         Fax:            (905) 474-9223
  26         E-mail:         dm@sangoma.com  (David Mandelstam)
  27         WWW:            http://www.sangoma.com
  28
  29
  30
  31 COPYRIGHT AND LICENSING INFORMATION
  32
  33 This program is free software; you can redistribute it and/or modify it under
  34 the terms of the GNU General Public License as published by the Free Software
  35 Foundation; either version 2, or (at your option) any later version.
  36
  37 This program is distributed in the hope that it will be useful, but WITHOUT
  38 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  39 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  40
  41 You should have received a copy of the GNU General Public License along with
  42 this program; if not, write to the Free Software Foundation, Inc., 675 Mass
  43 Ave, Cambridge, MA 02139, USA.
  44
  45
  46
  47 ACKNOWLEDGEMENTS
  48
  49 This product is based on the WANPIPE(tm) Multiprotocol WAN Router developed
  50 by Sangoma Technologies Inc. for Linux 2.2.x.  Success of the WANPIPE
  51 together with the next major release of Linux kernel in summer 1996 commanded
  52 adequate changes to the WANPIPE code to take full advantage of new Linux
  53 features.
  54
  55 Instead of continuing developing proprietary interface tied to Sangoma WAN
  56 cards, we decided to separate all hardware-independent code into a separate
  57 module and defined two levels of interfaces - one for user-level applications
  58 and another for kernel-level WAN drivers.  WANPIPE is now implemented as a
  59 WAN driver compliant with the WAN Link Driver interface.  Also a general
  60 purpose WAN configuration utility and a set of shell scripts was developed to
  61 support WAN router at the user level.
  62
  63 Many useful ideas concerning hardware-independent interface implementation
  64 were given by Mike McLagan <mike.mclagan@linux.org> and his implementation
  65 of the Frame Relay router and drivers for Sangoma cards (dlci/sdla).
  66
  67 With the new implementation of the APIs being incorporated into the WANPIPE,
  68 a special thank goes to Alan Cox in providing insight into BSD sockets.
  69
  70 Special thanks to all the WANPIPE users who performed field-testing, reported
  71 bugs and made valuable comments and suggestions that help us to improve this
  72 product.
  73
  74
  75
  76 NEW IN THIS RELEASE
  77
  78 o Renamed startup script to wanrouter
  79 o Option to turn off/on each router
  80   separately
  81 o New source directory /usr/lib/wanrouter
  82 o New PPP driver
  83 o X25 is not supported in this release
  84
  85
  86 PRODUCT COMPONENTS AND RELATED FILES
  87
  88 /etc:
  89         wanpipe1.conf   default router configuration file
  90         wanrouter.rc    meta-configuration file (used by the Setup script)
  91
  92 /lib/modules/X.Y.Z/misc:
  93         wanrouter.o     router kernel loadable module
  94
  95 /lib/modules/X.Y.Z/net:
  96         sdladrv.o       Sangoma SDLA support module
  97         wanpipe.o       Sangoma WANPIPE(tm) driver module
  98
  99 /proc/net/wanrouter
 100         Config          reads current router configuration
 101         Status          reads current router status
 102         {name}          reads WAN driver statistics
 103
 104 /usr/sbin:
 105         wanrouter       router start-up script
 106         wanconfig       router configuration utility
 107         sdladump        WANPIPE adapter memory dump utility
 108         fpipemon        Monitor for Frame Relay
 109         cpipemon        Monitor for Cisco HDLC
 110
 111 /usr/lib/wanrouter:
 112         README          this file
 113         COPYING         GNU General Public License
 114         Setup           installation script
 115         Configure       configuration script
 116         Filelist        distribution definition file
 117
 118 /usr/lib/wanrouter/doc:
 119         WANPIPE_USER_MANUAL.txt WAN Router User's Manual
 120         WANPIPE_CONFIG.txt      WAN Configuration Manual
 121
 122 /usr/lib/wanrouter/interfaces:
 123         *               interface configuration files (TCP/IP configuration)
 124
 125 /usr/lib/wanrouter/patches:
 126         wanrouter-22.gz patch for Linux kernel 2.2.10 and 2.2.11
 127                         (compatible for all 2.2.X kernels)
 128         wanrouter-20.gz patch for Linux kernel 2.0.36
 129
 130         Fix_2.2.11.gz   patch to fix the 2.2.11 kernel so other patches
 131                         can be applied properly.
 132
 133 /usr/lib/wanrouter/samples:
 134         interface       sample interface configuration file
 135         wanpipe1.cpri   CHDLC primary port
 136         wanpipe2.csec   CHDLC secondary port
 137         wanpipe1.fr     Frame Relay protocol
 138         wanpipe1.ppp    PPP protocol )
 139         wanrouter.rc    sample meta-configuration file
 140
 141 /usr/lib/wanrouter/src:
 142         *               wan-tools source code
 143
 144 /usr/include/linux:
 145         wanrouter.h     router API definitions
 146         wanpipe.h       WANPIPE API definitions
 147         sdladrv.h       SDLA support module API definitions
 148         sdlasfm.h       SDLA firmware module definitions
 149
 150 /usr/src/linux/net/router:
 151         *               router source code
 152
 153 /var/log:
 154         wanrouter       router start-up log (created by the Setup script)
 155
 156 /var/lock:
 157         wanrouter       router lock file (created by the Setup script)
 158
 159 /usr/lib/wanrouter/wanpipe:
 160         fr514.sfm       Frame relay firmware for Sangoma S508/S514 card
 161         cdual514.sfm    Dual Port Cisco HDLC firmware for Sangoma S508/S514 card
 162         ppp514.sfm      PPP Firmware for Sangoma S508 and S514 cards
 163
 164
 165 REVISION HISTORY
 166
 167 1.0.0   December 31, 1996       Initial version
 168
 169 1.0.1   January 30, 1997        Status and statistics can be read via /proc
 170                                 filesystem entries.
 171
 172 1.0.2   April 30, 1997          Added UDP management via monitors.
 173
 174 1.0.3   June 3, 1997            UDP management for multiple boards using Frame
 175                                 Relay and PPP
 176                                 Enabled continuous transmission of Configure
 177                                 Request Packet for PPP (for 508 only)
 178                                 Connection Timeout for PPP changed from 900 to 0
 179                                 Flow Control Problem fixed for Frame Relay
 180
 181 1.0.4   July 10, 1997           S508/FT1 monitoring capability in fpipemon and
 182                                 ppipemon utilities.
 183                                 Configurable TTL for UDP packets.
 184                                 Multicast and Broadcast IP source addresses are
 185                                 silently discarded.
 186
 187 1.0.5   July 28, 1997           Configurable T391,T392,N391,N392,N393 for Frame
 188                                 Relay in router.conf.
 189                                 Configurable Memory Address through router.conf
 190                                 for Frame Relay, PPP and X.25. (commenting this
 191                                 out enables auto-detection).
 192                                 Fixed freeing up received buffers using kfree()
 193                                 for Frame Relay and X.25.
 194                                 Protect sdla_peek() by calling save_flags(),
 195                                 cli() and restore_flags().
 196                                 Changed number of Trace elements from 32 to 20
 197                                 Added DLCI specific data monitoring in FPIPEMON.
 198 2.0.0   Nov 07, 1997            Implemented protection of RACE conditions by
 199                                 critical flags for FRAME RELAY and PPP.
 200                                 DLCI List interrupt mode implemented.
 201                                 IPX support in FRAME RELAY and PPP.
 202                                 IPX Server Support (MARS)
 203                                 More driver specific stats included in FPIPEMON
 204                                 and PIPEMON.
 205
 206 2.0.1   Nov 28, 1997            Bug Fixes for version 2.0.0.
 207                                 Protection of "enable_irq()" while
 208                                 "disable_irq()" has been enabled from any other
 209                                 routine (for Frame Relay, PPP and X25).
 210                                 Added additional Stats for Fpipemon and Ppipemon
 211                                 Improved Load Sharing for multiple boards
 212
 213 2.0.2   Dec 09, 1997            Support for PAP and CHAP for ppp has been
 214                                 implemented.
 215
 216 2.0.3   Aug 15, 1998            New release supporting Cisco HDLC, CIR for Frame
 217                                 relay, Dynamic IP assignment for PPP and Inverse
 218                                 Arp support for Frame-relay.  Man Pages are
 219                                 included for better support and a new utility
 220                                 for configuring FT1 cards.
 221
 222 2.0.4   Dec 09, 1998            Dual Port support for Cisco HDLC.
 223                                 Support for HDLC (LAPB) API.
 224                                 Supports BiSync Streaming code for S502E
 225                                 and S503 cards.
 226                                 Support for Streaming HDLC API.
 227                                 Provides a BSD socket interface for
 228                                 creating applications using BiSync
 229                                 streaming.
 230
 231 2.0.5   Aug 04, 1999            CHDLC initialization bug fix.
 232                                 PPP interrupt driven driver:
 233                                 Fix to the PPP line hangup problem.
 234                                 New PPP firmware
 235                                 Added comments to the startup SYSTEM ERROR messages
 236                                 Xpipemon debugging application for the X25 protocol
 237                                 New USER_MANUAL.txt
 238                                 Fixed the odd boundary 4byte writes to the board.
 239                                 BiSync Streaming code has been taken out.
 240                                  Available as a patch.
 241                                 Streaming HDLC API has been taken out.
 242                                  Available as a patch.
 243
 244 2.0.6   Aug 17, 1999            Increased debugging in startup scripts
 245                                 Fixed installation bugs from 2.0.5
 246                                 Kernel patch works for both 2.2.10 and 2.2.11 kernels.
 247                                 There is no functional difference between the two packages
 248
 249 2.0.7   Aug 26, 1999            o  Merged X25API code into WANPIPE.
 250                                 o  Fixed a memory leak for X25API
 251                                 o  Updated the X25API code for 2.2.X kernels.
 252                                 o  Improved NEM handling.
 253
 254 2.1.0   Oct 25, 1999            o New code for S514 PCI Card
 255                                 o New CHDLC and Frame Relay drivers
 256                                 o PPP and X25 are not supported in this release
 257 >>>>>> END OF README <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<