  =========================================================================
  
  @(#) README,v 0.8.2.2 2002/04/15 04:14:43 brian Exp
  
  =========================================================================
  
  This README is Copyright (C) 2001-2002 OpenSS7 Corporation
  This README is Copyright (C) 1997-2001 Brian Bidulock
  
  All Rights Reserved.
  
  Permission is granted to make and distribute verbatim copies of this
  README file provided the copyright notice and this permission notice are
  preserved on all copies.
  
  Permission is granted to copy and distribute modified versions of this
  manual under the conditions for verbatim copying, provided that the
  entire resulting derived work is distributed under the terms of a
  permission notice identical to this one
  
  Since the Linux kernel and libraries are constantly changing, this README
  file may be incorrect or out-of-date.  The author(s) assume no
  responsibility for errors or omissions, or for damages resulting from the
  use of the information contained herein.  The author(s) may not have
  taken the same level of care in the production of this manual, which is
  licensed free of charge, as they might when working professionally.
  
  Formatted or processed versions of this manual, if unaccompanied by the
  source, must acknowledge the copyright and authors of this work.
  
  =========================================================================
  
  Modified 2002/04/15 04:14:43 by brian
  
  =========================================================================


                        ++++++++++++++++++++++++++
                        OPENSS7 for STREAMS README
                        ++++++++++++++++++++++++++


    Welcome to the OpenSS7 package for LiS STREAMS.
    
    This is a pre-Beta release and is fully operational.  It provides a
    fully operational (and Q.781 conforming) Signalling Data Link UDP
    Emulation (sdl-udp) which emulates an SS7 Signalling Data Link with
    Linux UDP sockets within the driver.  The first actual hardware
    driver (ACB56) has not been made operational for this release, but
    the source is included for illustration.  Also included is a fully
    operation Stream Control Transmission Protocol (SCTP) stack with TPI
    and NPI interface, and an M2PA module for M2PA SS7 Links over IP
    using SCTP.  Also included is a TCP/IP socksys driver for Linux
    (this provides TCP/UDP/IP streams based on the TPI interface
    compatible with the iABI).

    The purpose for this release has been to publicly release the first
    LiS 2.13.17/Linux 2.4.x version of all of these components.  It is
    no longer necessary to load old LiS 2.10/Linux 2.2.x kernels to run
    the software (in fact you should only run this release on 2.4.x
    kernels).  This software has been tested with RedHat release
    2.4.7-10, RedHat release 2.4.9-31, and the "official" Linux 2.4.18
    kernel.

    In addition, this release provides a Q.781 conforming M2PA module
    which conforms to Draft 4 (draft-ietf-sigtran-m2pa-04.txt) as
    described in the conformance test suite provided in
    (draft-bidulock-sigtran-m2pa-test-01.txt).  Included in the release
    is the test-m2pa test program which performs the conformance test
    suite descrbed in draft-bidulock-sigtran-m2pa-test-01.txt, verifying
    the behaviour of the M2PA implementation.

    This release provides fully operational (and Q.781 tested) pushable
    STREAMS modules for the following components:

        m2pa -   SS7 MTP2-User Peer-to-Peer Adaptation Layer
        sdl  -   Signalling Data Link
        sdt  -   Signalling Data Terminal
        sl   -   Signalling Link

    For more information on the STREAMS design approach for OpenSS7, see the
    website at http://www.openss7.org/.

    This release also provides an iABI socksys driver which provides
    support for raw, ip, upd and tcp devices.  The TCP implementation is
    incomplete and unstable at this time, but the /dev/rawip and
    /dev/udp interfaces operate well.

    You will find INSTALATION INSTRUCTIONS in the top-level directory (along
    with this file) in the file named "INSTALL".  You will find the
    licensing terms (GPL) in the file named "LICENSE".  The Linux Software
    Map entry is in the file LSM.

    For an example of how to (or perhaps how no to) write user-level
    applications, see the test programs in the strss7-0.8.2/test/
    directory.  For more information, see the doc direction in the
    strss7-0.8.2/doc/ directory.

    Sun Apr 14 22:16:48 CDT 2002
    Brian F. G. Bidulock
    bidulock@openss7.org
    http://www.openss7.org/
