Installation Notes for the Madge Smart Ringnode Driver for Unixware 2.1
=======================================================================
                            
                            

May 1997
--------

SUMMARY
-------

This document describes how to install and configure  the  mtok device
driver for Madge Smart Ringnodes under Unixware 2.1. 

The  mtok  driver  for  Unixware  2.1  supports  the  following  Smart
Ringnodes:

ISA Bus Ringnodes:

    Smart 16/4 PC Ringnode
    Smart 16/4 AT Ringnode
    Smart 16/4 AT Plus Ringnode
    Smart 16/4 AT PnP Ringnode
    Smart 16/4 ISA Client Ringnode
    Smart 16/4 ISA Client Plus Ringnode
    Smart 16 Ringnode
    Smart 16/4 ISA Client PnP Ringnode

EISA Bus Ringnodes:

    Smart 16/4 EISA Ringnode

Microchannel Bus Ringnodes:

    Smart 16/4 MC Ringnode
    Smart 16/4 MC32 Ringnode

PCI Bus Ringnodes:

    Smart 16/4 PCI Ringnode
    Smart 16/4 PCI Ringnode (BM)
 
Please  note that Plug&Play Ringnodes  (i.e. Smart 16/4 ISA Client PnP
Ringnodes and  Smart  16/4  AT PnP Ringnodes)  must be set  to non-PnP
mode using the Madge Wizard utility.


1. CREATING AN INSTALLATION DISKETTE
------------------------------------

If  you  have received  your  Madge driver on an installation diskette
then you should skip this section and  proceed  directly to section 2.
This section describes how to create an installation diskette with the
installation diskette image file  mdgunx21.img  from  the  Madge CD or
bulletin board.

To create an installation diskette:

    a) Log into your Unixware system as "root".

    b) Copy the mdgunx21.img file into the /tmp directory.

    c) Place a blank formatted 3.5inch diskette in the diskette driver
       and enter the command

       dd if=/tmp/mdgunx21.img of=/dev/fd0
      
    d) The diskette is  now  an IHV installation diskette for the mtok
       driver.


2. PRE-INSTALLATION
-------------------
 
Please  note  the  following  points before you attempt to install the 
mtok  device driver:

1. The Smart Ringnodes(s) for which you wish to install  mtok must  be
   physically present in  your PC  and  be  connected  to a token ring
   network before you install mtok.

2. For ISA bus Smart Ringnodes you must  know  the  hardware  resource
   settings for  which  the  Ringnodes have been configured.  That is,
   the I/O locations, the IRQ numbers and for Smart 16/4 AT Ringnodes,
   Smart 16/4 AT Plus Ringnodes and Smart 16/4 AT  PnP  Ringnodes  the
   DMA channels.  For older Ringnodes with switches these  values  can
   be determined from the switches. For newer,  switchless  Ringnodes,
   these values may be determined with the Madge Wizard utility.

   
3. INSTALLATION
---------------

To  install  the  mtok  device  driver  for  one  or  more Madge Smart 
Ringnodes that are already  present  in your PC and are connected to a
token ring network proceed as follows:

1. Run the NIC Setup utility. This can be done from the graphical user
  interface by double clicking on the Admin_Tools/Networking/NIC_Setup
   icon.  The utility can also be run  from  the  command  line whilst
   logged on as root with the command niccfg.
   
2. From the NIC Setup utility's menu screen choose the option:

       Install driver from IHV diskette
            
   When you are asked for an IHV diskette use the diskette created  in
   section 1 above. 
   
   After the mtok device driver has been copied  from  the  diskette a
   message will  be  displayed  saying  that  the mtok driver has been
   added.   Press  ENTER to dismiss the message and return to the menu
   screen.
    
3. At  the  top of the  menu screen there will be a list of all of the
   Network Interface Cards in the PC that Unixware knows about.
    
4. If you  have  none  ISA  bus  Smart Ringnodes in your PC you should
   see them listed automatically at the  top  of the screen.   (If you
   do not see them  listed  then you should exit the NIC Setup utility
   and re-run it.)
   
5. Since  Unixware  cannot  automatically detect ISA bus adapters, ISA
   bus Smart  Ringnodes  will  not  be listed until you explicitly add
   them.
   
   To add an ISA bus Smart Ringnode choose the option:
   
       Add an entry for a card
       
   You  will be presented with a list of Ringnodes (and possibly other
   types of NICs) to choose from. Select a Ringnode from the list. You
   will then be asked  to enter the hardware resource settings for the
   Ringnodes.  Enter these.  You   will then be taken back to the menu
   screen.
   
6. When all  of  the  Smart Ringnodes present in your PC are listed at
   the top of the menu screen choose the option:
   
       Accept all entries
       
   The  NIC  Setup  utility  will  then  install  mtok  for all of the
   Ringnodes listed.
            
7. You  must now configure your network protocols e.g. TCP/IP and IPX.
   See the "SCO Unixware Installation Handbook"  for details on how to
   do this.
   
8. Finally shutdown and re-boot your PC.
  
   
4. ADVANCED CONFIGURATION
-------------------------

Some advanced configuration of the mtok  device  driver cannot be done
through the NIC Setup  utility.   There are two ways in which advanced
configuration can be done.

4.1 By editing space.c
----------------------
 
The file /etc/conf/pack.d/mtok/space.c contains C like  definitions of
various  configuration  parameters such as the maximum frame size  and
the source routing cache expiry time.
   
To  change  any  of  these  parameters  log  on  as  root and edit the
definition in /etc/conf/pack.d/mtok/space.c with a text editor such as
vi.  Then re-build the Unixware kernel with the command:
   
    /etc/conf/bin/idbuild -M mtok
       
Finally shutdown and re-boot your PC.

   
4.2 With the device configuration utility (dcu)
-----------------------------------------------

The  device  configuration  utility  (dcu) can  be  used to change the
hardware  resources  assigned  to  an adapter.  If you have previously 
installed mtok for a  Smart  Ringnode  and  then you change one of the
hardware resource settings on the  Ringnode,  you  should  use the dcu
to change the hardware resources assigned to the Ringnode so that they
match the settings on the Ringnode.

The  dcu  can  be  run  from  the  graphical  user interface by double
clicking on the Admin_Tools/Hardware_Setup icon.  The dcu can also  be
run from the command line whilst logged on as root  with  the  command
dcu.  See the "SCO Unixware Installation Handbook"  for details on how
to use the dcu.

Normally ISA bus adapters that support DMA are configured  to use  DMA
as this is the best transfer mode for Unixware.   However, if you wish
to force an ISA bus  adapter  to  use  programmed I/O (PIO),  then use
then use the DCU to change the DMAC  value  to  a "-" character.  When
you re-boot the Ringnode will be forced into PIO mode.


5. TROUBLESHOOTING
------------------

Should something go wrong with the operation of the mtok device driver
a message of the form:

WARNING: mtok0: xxxxxxxxxxxxxxxxxxxxxxxxx

will  be  displayed  on  the  console.   Most of  the  error  messages
are  self  explanitary - those  that  require  explination  are listed
below.

(a) "adapter start failure - error 8/1"

This  message  indicates that the Smart Ringnode could not insert into
the Token Ring.  The most common causes are that the lobe cable is not
correctly inserted or that the Ringnode has been configured to use the
wrong ring speed.

(b) "adapter start failure - error 5/5"

This  message  indicates that mtok was unable to find a Smart Ringnode
of the type specified in the NIC Setup utility. The most likely reason
is that the wrong type of ISA bus Ringnode was chosen.

(c) "adapter start failure - error 5/7"

This  message  means  that the Ringnode failed its DMA test.  The most
likely cause is  that  the  DMA  channel  specified  in  the NIC Setup
utility  for  an  ISA  bus  Ringnode does not match the setting on the
Ringnode.

(c) "adapter start failure - error 7/16"

This message means that mtok is failing to receive interrupts from the
Ringnode.  The  most likely cause is that the IRQ number specified  in
the NIC Setup utility  for  an  ISA  bus  Ringnode  does not match the
setting on the Ringnode.

---- End of readme.txt ---------------------------------------------------------
 

             
   