===============================================================================

       Release_Note - Interphase IRIX ATM/SIGD Driver Installation

       UGRMF92-000,REVA  --  driver: sx00324.c00  --  signald: C04
===============================================================================

Files:

    README              # this Release_Note file
    Release_Note        # ID1.0 driver features
    inatm               # driver installation csh script
    bin/cellview        # GUI configuration utility
    bin/cvconf          # boot configuration utility
    bin/cvinit          # default configuration utility
    bin/iadump          # driver diagnostic/dump utility
    bin/ipatm           # 1577 Client configuration utility
    bin/ipatmdbg        # 1577 debug utility
    bin/learp           # LANE debug utility
    bin/lec             # LANE Client configuration utility
    bin/lecs            # LANE configuration utility
    bin/ledbg           # LANE Client debug utility
    bin/les             # LANE Server configuration utility
    bin/lesdbg          # LANE Server debug utility
    bin/pvc             # LANE PVC configuration/debug utility
    bin/sigd_start      # SIGD start/restart script
    bin/sigd_stop       # SIGD shutdown script
    bin/sigdbg          # SIGD debug application
    bin/signald         # SIGD application (UNI 3.0/3.1 signaling)
    bin/sigstat         # SIGD statistics application
    man/cvconf.1m.z     # packed man page
    man/cvconf.4.z      # packed man page
    man/ipatm.1m.z      # packed man page
    man/ipatmdbg.1m.z   # packed man page
    man/learp.1m.z      # packed man page
    man/lec.1m.z        # packed man page
    man/lecs.1m.z       # packed man page
    man/ledbg.1m.z      # packed man page
    man/les.1m.z        # packed man page
    man/lesdbg.1m.z     # packed man page
    man/pvc.1m.z        # packed man page
    man/sigdbg.1m.z     # packed man page
    man/signald.1m.z    # packed man page
    man/signald.7.z     # packed man page
    man/sigstat.1m.z    # packed man page
    old/drvr.idrv       # ID1 file list
    old/drvr.irix       # IRIX file list
    old/drvr.lane       # LANE file list
    old/drvr.pvc        # PVC file list
    old/rmatm           # driver removal script
    sys/ia.mfx          # hardware driver master file
    sys/ia.o            # hardware driver object
    sys/ia.smx          # hardware driver system file
    sys/li.mfx          # ATM driver master file
    sys/li.o            # ATM driver object
    sys/li.smx          # ATM driver system file


===============================================================================

Architecture:

    This driver consists of three basic parts: the signaling application, the
    Integrated Driver (ID1), and the hardware driver. Also provided are support
    and debug utilities and man pages.



    1) Signaling - signald

        This is run as an application and provides either the UNI 3.0
        or 3.1 signaling software. This must be invoked after both the
        ATM and hardware drivers are operational.

        Support/debug utilities:

                sigd_start, sigd_stop, sigdbg, sigstat

        Configuration file:

                cvconf



    2) Integrated driver - li.o

        This is a kernel level driver, and provides the interface
        for the signaling application and the IFNET network driver.
        This is setup to be loaded by the kernel at boot time.

        System files:

                li.smx, li.mfx

        Support/debug utilities:

                cellview, cvconf, lec, lecs, les, ipatm, pvc,
                ledbg, lesdbg, ipatmdbg

        Configuration files:

                cvconf, li.mfx



    3) Hardware driver - ia.o

        This is a kernel level driver and provides the interface
        between signaling, ID1, and the specific hardware platform.
        This is setup to be loaded by the kernel at boot time.

        System files:

                ia.smx, ia.mfx

	Support/debug utility:

                iadump, ipburn

===============================================================================

Pre-installation:

    Prior to installation the following needs to be known/determined:

    1. root password

    2. A unique IP address and name.

    3. A unique Major Device number for the ID1 driver.

    4. A unique Major Device number for the Hardware driver.

    5. A unique Short IO address for the Interphase controller(s).

    6. If not installing from CDROM, the tarfile is around 6688KB
       in size, and when extracted, requires an additional 6564KB.

    7. It is recommended that the IRIX network configurations are
       performed prior to running the drivers' install script.


===============================================================================

Install Script:

    usage:

        inatm [option(s)]

    options:

        [-i num]     major device number for ia driver (default: 60)
        [-l num]     major device number for li driver (default: 61)
        [-a addr]    adapter's short io address        (default: 0x6000)
        [-b path]    directory for binaries            (default: /usr/sbin)
        [-c path]    directory for config files        (default: /etc/config)
        [-m path]    directory for man pages (defualt: /usr/share/catman/a_man/cat1)
        [-u usr]     install 'user'                    (default: root)
        [-g grp]     install 'group'                   (default: sys)


    notes:

        1. The install script creates the following files by editing the
           respective distribution file, using command line options or
           installation defaults:

           created file                from          command option
           ------------------------    ----------    --------------
           /var/sysgen/system/ia.sm    sys/ia.smx      -a
           /var/sysgen/system/li.sm    sys/li.smx      -a
           /var/sysgen/master.d/ia     sys/ia.mfx      -i
           /var/sysgen/master.d/li     sys/li.mfx      -l

===============================================================================

Network Configuration:

    It is assumed that whoever is installing this driver is somewhat
    familiar with the administration of IRIX networking. The following
    instructions are pretty generic in nature, and your specific setup
    may vary slightly.

    1. Add the interface(s) to the kernel by editing the file:
 
              /etc/config/netif.options

       Follow the directions provided in the file and note which ifname/
       ifaddr you use. This network's ifname is: li0.

              if_X_name=li0
              if_X_addr=NAME
       where:
              _X_ is the next available interface number
              NAME is the IP name to be specified in /etc/hosts


    2. Create the ifconfig file (where _X_ is the same as in step 1):

              /etc/config/ifconfig-_X_.options

       specifing the options your network requires, ie:

              broadcast 123.456.789.0 netmask 0xffffff00 up

    3. Add the IP NAME (where NAME is the same as in step 1) and address
       to the file:

              /etc/hosts

       ie:
              123.456.789.321  NAME


    NOTE: Steps 1, 2, and 3 must be repeated for each client required. This
          driver supports 4 LANE clients and 1 RFC1577 client. The if_X_names
          are specified as follows:

              li0  - LANE Client 0
              li1  - LANE Client 1
              li2  - LANE Client 2
              li3  - LANE Client 3
              li32 - 1577 Client 0


===============================================================================

Automating Bootup & Shutdown:

    The UNI signalling application must be started after the hardware device
    drivers have been loaded by the kernel. This may be done manually by the
    system administrator after bootup, or may be automated using the startup
    script provided with the driver package. Both startup and shutdown commands
    may be added to the file

            /etc/init.d/network

    NOTE: If you have installed a previous release of our drivers, the install
          script will remove/save the old files. However, you must either remove
          or comment out the old startup/shutdown commands provided here.
           

    1. ATM client(s) startup - at the end of the case 'start' (just before
       the fi;;), add the following:


              # ATM/ID1 startup
              if $IS_ON atmcv && test -x /usr/sbin/cvconf; then
                  /usr/sbin/cvconf -f /etc/atm/cvconf
              fi


       The installation script creates the file:

              /etc/config/atmcv

       with the contents:

              on

       which is used by the $IS_ON test above. To disable configuring the
       ATM at boot time, change the contents of this file to "off".
       This will mandate that the system administrator configure each client
       manually after every boot/reboot.


    2. Signald startup - at the end of the case 'start' (just before
       the fi;;), add the following:


              # ATM/SIGD startup
              if $IS_ON atmsigd && test -x /usr/sbin/sigd_start; then
                  /usr/sbin/sigd_start
              fi


       The installation script creates the file:

              /etc/config/atmsigd

       with the contents:

              on

       which is used by the $IS_ON test above. To disable starting the
       signaling application at boot time, change the contents of this file
       to "off".  This will mandate that the system administrator manually
       start the signald application after every boot/reboot.


    3. Most systems DO NOT provide a hardware reset during a reboot, and if
       not, the board remains active, and the kernel will PANIC upon receipt
       of the first receive packet. Software can provide this much needed
       reset by adding the shutdown command at the end of the case statement
       'stop' (just before the fi;;):


              # ATM/ID1 shutdown
              if $IS_ON atmdown && test -x /usr/sbin/iadump; then
                  /usr/sbin/iadump shutdown
              fi


       The installation script creates the file:

              /etc/config/atmdown

       with the contents:

              on

       which is used by the $IS_ON test above. To disable this reset during
       shutdown, change the contents of this file to "off". This will mandate
       that the system administrator manually reset the hardware prior to a
       reboot (or requires a power cycle before booting).



     NOTE: the paths to cvconf, sigd_start, and iadump above must match whatever
           is specified during the driver installation (the -b command line
           option). The path to cvconf, signald, and iadump, if changed from the
           install script's default (/usr/sbin/), must be changed in the above
           examples, and also in the scripts:

              cvconf, sigd_start, sigd_stop

              

===============================================================================

Installation steps:

     NOTE: OLD Drivers

     If old drivers are removed by the install script, the directory `./old'
     will be created to save the old driver files, requiring the tarfile
     directory to reside in a writable partition (see step 2 below).

     The startup/shutdown commands will still exist in the /etc/init.d/network
     file. These will need to be removed or commented out when adding the
     new startup/shutdown procedures.

  1. Login as root

  2. If installing from the tarfile, create a working directory (ie, /usr/atm),
     and extract the contents with the commands:

            mkdir /usr/atm
            cd /usr/atm
            tar xvf TARFILE

     or from CDROM:

            cd /CDROM/IRIX_6.2

  3. Check the following installation parameters, and if your environment
     requires changes, use the appropiate command line option(s) to alter:

            -a SHIO    = short I/O address
            -i IAMAJ   = major device number for the hardware driver
            -l LIMAJ   = major device number for the ID1 driver
            -b BINDIR  = directory to install executable binaries
            -c CFGDIR  = directory to install configuration files
            -m MANDIR  = directory to install man pages

     Any changes may be made by editing the script or with command line
     arguments.


  4. Run the install script. This will install all binaries, system files, and
     man pages. It also creates the directory /etc/atm, in which are placed
     the driver's default configuration files. After file installation, the
     kernel is reconfigured with the new driver.

  5. The new kernel is now ready for use. A reboot is required to load the
     new kernel. If the installation was succesful, the drivers will be loaded
     and the network interface(s) configured at boot time.

  6. After rebooting the new kernel, use the application cellview to fully
     configure your ATM environment. This is a GUI based application and
     requires a graphics monitor. If an ASCII terminal is all that is
     available, see the man page on cvconf to manually edit the cvconf,
     pvcconf, and/or lesconf files.

  7. If signalling and ID1 configuration were not setup to auto-start at
     bootup, they will need to be manually started after every boot/reboot.

             sigd_start   -script to start/restart the signaling application
                           (uses parameters in file: /etc/atm/cvconf)

             cvconf       -ID1 configuration application
                           (uses parameters in file: /etc/atm/cvconf)


===============================================================================

                          Interphase (i) Corp
                            13800 Senlac Dr
                            Dallas Tx 75234
                              214-654-5000

                         http://www.iphase.com/
                        email: intouch@iphase.com
