Notes on Installing and Use of the Madge ======================================== SCO Unixware 7 Token-Ring Adapter Driver ======================================== LSS 6.1(1) update, Nov 1999 --------------------------- Contents -------- 1. Adapters Supported 2. Removing Existing Drivers 3. Installing the Driver Package 4. Installing the Driver for an Adapter 5. Configuring the Driver 6. Using Adapter Mirroring with PCI Ringnodes 7. Removing the Driver and the Driver Package 8. Permanently Disabling Promiscuous Mode on the Smart 16/4 PCI Ringnode Mk3, the Smart 100/16/4 PCI-HS Ringnode and the Smart 100/16/4 PCI Ringnode. 9. Error Messages Note: several of the following sections refer to the SCO Unixware 7 network configuration utility called netcfg. The instructions below refer to using the "arrow" and [TAB] keys to drive the utility. This assumes that netcfg has been run outside of the Unixware 7 GUI. If you are running netcfg from inside the Unixware 7 GUI use the mouse to drive netcfg. 1. Adapters Supported --------------------- This package supports the following Madge Token-Ring adapters: * Madge Smart 16/4 AT Plus Ringnode * Madge Smart 16/4 ISA Client PnP Ringnode * Madge Smart 16/4 EISA Ringnode * Madge Smart 16/4 PCI Ringnode Mk1 * Madge Smart 16/4 PCI Ringnode Mk2 * Madge Smart 16/4 PCI Ringnode Mk3 * Madge Smart 100/16/4 PCI-HS Ringnode * Madge Smart 100/16/4 PCI Ringnode 2. Removing Existing Drivers ---------------------------- If you have previously installed a driver for a Madge Token-Ring adapter then this must be removed before the new driver may be installed. To remove the existing driver proceed as follows: a) Log into your SCO Unixware 7 system as "root". b) Execute the command: netcfg A list of network devices will be displayed. c) Use the [TAB] key and the "arrow" keys to highlight the Madge device. d) From the "Hardware" menu select "Remove network device". e) Repeat steps c) and d) for any other Madge devices. f) From the "Hardware" menu select "Exit" and answer "Yes". g) Execute the command: pkgrm mtok The Madge driver package will be removed. h) Re-boot your SCO Unixware 7 system. 3. Installing the Driver Package -------------------------------- a) Make sure that your Madge Token-Ring adapter(s) is present in your machine and that it is attached to a Token-Ring. b) If you are using a Smart 16/4 ISA Client PnP Ringnode Ringnode then you should use the Madge Assist program to put the adapter into none PnP mode. c) Log into your SCO Unixware 7 system as "root". d) Copy the package archive sco7.tar into the directory: /tmp e) In the above directory execute the command: tar -xf sco7.tar f) You may now delete the sco7.tar file. g) Execute the command: pkgadd -d /tmp mtok The Madge Token-Ring driver package will be installed. 4. Installing the Driver for an Adapter --------------------------------------- a) Ensure that the Driver Package has been installed successfully (see section 3 above). b) Log into your SCO Unixware 7 system as "root". c) Execute the command: netcfg A list of network devices will be displayed. d) From the "Hardware" menu select "Add new LAN adapter". For PCI and EISA adapters: A list of Madge PCI and/or EISA adapters for which the driver has not yet been installed will be displayed. Use the "arrow" keys to select the adapter for which you wish to install the driver and then select "Continue". For ISA adapter: A list of all the networking adapters for which a driver package has been installed will be displayed. Using the "arrow" keys select the type of Madge adapter you have in your SCO Unixware 7 system. When asked if you wish to search for the adapter say no. e) A dialogue box entitled "Network Driver Configuration" will appear and you will be offered the chance to set some driver parameters. Unless you have an ISA adapter you will not normally need to set any of the driver parameters. For ISA adapters, the I/O base, IRQ number and possibly the DMA channel must be set. The driver parameters that may be set are: I/O Address This is the I/O base address being used by an ISA adapter. Interrupt Vector This is the interrupt number being used by an ISA adapter. DMA Channel This is DMA channel being used by an ISA adapter that supports bus master DMA. Maximum Frame Size This is the maximum size of frame that the adapter may send or receive. The value is chosen from a list of alternatives with the "arrow" keys. The default value is 4096. Ring Speed This is the speed at which the token ring is operating. There are five possible values: 4 Force the adapter to operate at 4 MBit/s. 16 Force the adapter to operate at 16 MBit/s. 100 Force the adapter to operate at 100 MBit/s. Default Use the default ring speed for which the adapter has been configured by Madge Assist. Locally Administered Address This is the 6 byte IEEE address that the adapter should use. By default the adapter will use the unique address (the BIA) that is stored in the adapter's EPROM. You may change the value to any valid Token-Ring locally administered address. That is a 6 byte address whose first byte is in the range 40 (hexidecimal) to 7f (hexidecimal). The value should either be blank or a 12 character hexidecimal address. e.g. "4000a1b2c3d4". Once you have set any required parameters choose "OK". f) You will be offered the chance to attach a network protocol to the Madge Token-Ring adapter. Choose the protocol you wish to use and supply any configuration information required. Please refer to the SCO documentation for details. g) Repeat steps d) to f) for all Madge Token-Ring adapters for which you wish to install the driver. h) From the "Hardware" menu select "Exit". i) Re-boot your SCO Unixware 7 system. 5. Configuring the Driver ------------------------- a) Log into your SCO Unixware 7 system as "root". b) Execute the command: netcfg A list of network devices will be displayed. c) Use the [TAB] key and the "arrow" keys to highlight the Madge device. d) From the "Hardware" menu select "Modify hardware configuration". e) A dialogue box entitled "Network Driver Configuration" will appear. From within this dialogue the following driver parameters may be set: I/O Address This is the I/O base address being used by an ISA adapter. Interrupt Vector This is the interrupt number being used by an ISA adapter. DMA Channel This is DMA channel being used by an ISA adapter that supports bus master DMA. Maximum Frame Size This is the maximum size of frame that the adapter may send or receive. The value is chosen from a list of alternatives with the "arrow" keys. The default value is 4096. Ring Speed This is the speed at which the token ring is operating. There are four possible values: 4 Force the adapter to operate at 4 MBit/s. 16 Force the adapter to operate at 16 MBit/s. Default Use the default ring speed for which the adapter has been configured by Madge Assist. Locally Administered Address This is the 6 byte IEEE address that the adapter should use. By default the adapter will use the unique address (the BIA) that is stored in the adapter's EPROM. You may change the value to any valid Token-Ring locally administered address. That is a 6 byte address whose first byte is in the range 40 (hexidecimal) to 7f (hexidecimal). The value should either be blank or a 12 character hexidecimal address. e.g. "4000a1b2c3d4". Once you have set any required parameters choose "OK". f) From the "Hardware" menu select "Exit". g) Re-boot your SCO Unixware 7 system. 6. Using Adapter Mirroring with PCI Ringnodes --------------------------------------------- It is possible to use a pair of Smart [100/]16/4 PCI Ringnodes to provide protection against failure of one of the adapters or of the Token-Ring cabling. This technique is known as "mirroring". Mirroring works as follows: Two physical Token-Ring adapters are installed, referred to as the master and the slave. The Token-Ring device-driver tells Unixware 7 that there is only one (logical) adapter installed. Initially the master adapter is used for network communication. If the device-driver detects that the master adapter is no-longer functioning properly it will closedown the master adapter and switch to using the slave adapter. If at a later date the device-driver detects that the slave adapter has ceased working properly it will switch back to the master, and so forth. The switch between master and slave adapters is completely transparent to OSR5 and to any protocols and applications (except for a slight delay whilst the switch takes place) as long as both master and slave adapter are connected to the same Token-Ring. That is they are both connected into the same Bridge/Switch port or into different ports on the same Switch in transparent mode. (For Token-Ring experts - the source route to both adapters must be the same.) The device-driver deems that an adapter is not working properly if there is a lobe-cable fault, a hard ring-error, the adapter has been single-station for more than a given period or the ring has been beaconing for more than a given period. The following constraints apply to mirroring: a) Master and slave adapters must both be the same type of Smart [100/]16/4 PCI Ringnodes. That is master and slave must be a pair of Smart 16/4 PCI Ringnode Mk1s, a pair of Smart 16/4 PCI Ringnode Mk2s, a pair of Smart 16/4 PCI Ringnode Mk3s, a pair of Smart 100/16/4 PCI-HS Ringnodes or a pair of Smart 100/16/4 PCI Ringnodes. b) Master and slave adapters must be on the same PCI bus. c) A locally administered address must be used. To install a pair of mirrored adapters proceed as follows: a) Make sure that both adapters are present in the SCO Unixware 7 machine. b) Ensure that the Driver Package has been installed successfully (see section 3 above). c) Log into your SCO Unixware 7 system as "root". d) Execute the command: netcfg A list of network devices will be displayed. e) From the "Hardware" menu select "Add new LAN adapter". A list of Madge PCI adapters for which the driver has not yet been installed will be displayed. Use the "arrow" keys to select the adapter that you would like to be the master and then select "Continue". The driver will automatically use the PCI adapter with the next highest PCI device number after the master as the slave. So make sure that you choose the adapter of your pair that has the lower PCI device number. f) A dialogue box entitled "Network Driver Configuration" will appear and you will be offered the chance to set some driver parameters (see section 5 above). You must set a locally administered address. g) Once you have made any required parameter changes choose the "Advanced Options" option. A dialogue box entitled "Advanced Network Driver Configuration" will now appear. From within this dialogue box the following driver parameters may be set: Mirrored Pair This option should be set to "yes" if this adapter is to be the master of a mirrored pair. Max Seconds Single-Station Before Mirror This option specifies the number of seconds an adapter may be single-station before the driver switches to the other adapter. "Disabled" means that the driver will not cause a switch because an adapter is single-station. Max Seconds Beaconing Before Mirror This option specifies the number of seconds an adapter may be beaconing before the driver switches to the other adapter. "Disabled" means that the driver will not cause a switch because an adapter is beaconing. To enable mirroring you must set "Mirrored Pair" to "yes". h) Once you have made the required parameters changes choose the "OK" option. You will now be returned to the "Network Driver Configuration" dialogue box. Choose the "OK" option again. i) You will be offered the chance to attach a network protocol to the Madge Token-Ring adapter. Choose the protocol you wish to use and supply any configuration information required. Please refer to the SCO documentaton. j) From the "Hardware" menu select "Exit". k) Re-boot your SCO Unixware 7 system. 7. Removing the Driver and the Driver Package --------------------------------------------- a) Log into your SCO Unixware 7 as "root". b) Execute the command: netcfg A list of network devicess will be displayed. c) Use the [TAB] key and the "arrow" keys to highlight the Madge device. d) From the "Hardware" menu select "Remove network device". e) Repeat steps c) and d) for any other Madge devices. f) From the "Hardware" menu select "Exit". g) Execute the command: pkgrm mtok The Madge driver package will be removed. h) Use the [TAB] and "arrow" keys to highlight the Madge Token-Ring driver. i) Re-boot your SCO Unixware 7 system. 8. Permanently Disabling Promiscuous Mode on the Smart 16/4 PCI Ringnode Mk3, ----------------------------------------------------------------------------- the Smart 100/16/4 PCI-HS Ringnode and the Smart 100/16/4 PCI Ringnode. ----------------------------------------------------------------------- It is possible to permanently disable promiscous mode on a Smart 16/4 PCI Ringnode Mk3, a Smart 100/16/4 PCI-HS Ringnode and a Smart 100/16/4 PCI Ringnode. To do this, use the netcfg utility to modify the adaptetr's advanced configuration. In the "Advanced Network Driver Configuration" dialogue set the "Kill Promiscuous Mode" parameter to "yes". Exit netcfg and re-boot your SCO Unixware 7 system. Once this process has been carried out your adapter WILL NEVER BE ABLE TO SUPPORT promiscuous mode. 9. Error Messages ----------------- Below is a list of the most commonly occuring information and error messages. Messages are of the form: mtok?: XXXXXXXX-CC-DDDD: Where XXXXXXXX is a hexidecimal error code and CC-DDDD is further diagnostic information. If you report an error to Madge Technical support please quote all components of the message. If an error message is displayed that is not listed below please consult the exhaustive error list in the file "ERRORS.TXT". The XXXXXXXX value is the error code given in this file. Please run the Madge Assist program to diagnose any hardware configuration problems. If Assist does not diagnose the problem then contact Madge Technical Support. If "mtok?" is suffixed by "-slv" then the message refers to the slave adapter in a mirrored pair. -------- "mtok?: 00000010-CC-DDDD: No adapter of given type at IO location" "mtok?: 00000011-CC-DDDD: No adapter of given type at PCI number" "mtok?: 00001003-CC-DDDD: No adapter at specified I/O location" The driver cannot find the adapter at the I/O location or PCI number specified when the driver was installed. The most common causes are that the adapter has been removed from the computer, an ISA adapter's I/O location has been changed or a PCI adapter has been moved to a different slot. Use netconfig to remove and then re-add the driver. -------- "mtok?: 00000041-CC-DDDD: Insufficient adapter memory for requested maximum frame size" Your adapter does not have enough memory to support the frame size you have chosen. Try reducing the maximum frame size. See section 6 above. -------- "mtok?: 00000135-CC-DDDD: Adapter hardware failure" "mtok?: 00000140-CC-DDDD: The adapter has failed to initialise" "mtok?: 00000160-CC-DDDD: Bring up diagnostics failed" "mtok?: 00000161-CC-DDDD: Bring up diagnostics failed" "mtok?: 00000162-CC-DDDD: Bring up diagnostics failed: Adapter RAM test failed" "mtok?: 00000163-CC-DDDD: Bring up diagnostics failed: Instruction test failed" "mtok?: 00000164-CC-DDDD: Bring up diagnostics failed" "mtok?: 00000165-CC-DDDD: Bring up diagnostics failed" "mtok?: 00000166-CC-DDDD: Bring up diagnostics failed" "mtok?: 00000167-CC-DDDD: Bring up diagnostics timed out without a specific error being reported" The adapter hardware failed to initialize. Please run the Madge Assist program to diagnose the fault. -------- "mtok?: 00000141-CC-DDDD: Timed out waiting for response from adapter" "mtok?: 00001113-CC-DDDD: Initialization timed-out - possible interrupt clash" The adapter took too long to initialise. This is usually due to an interrupt clash. Try running Madge Assist. -------- "mtok?: 00001112-CC-DDDD: Initialization failed - transfer test failed" Part of the adapter's self test sequence is to do a transfer test. This has failed. Please run Madge Assist to diagnose the problem. -------- "mtok?: 00010001-CC-DDDD: Insufficient kernel memory available" There is not enough memory available to allocate transfer buffers. Try reducing the maximum frame size. See section 6 above. -------- "mtok?: 00010002-CC-DDDD: Invalid ring speed specified (XXMBit/s), using default" A ring speed of XX was specified which is invalid for this adapter. The default ring speed is being used instead. -------- "mtok?: 00010003-CC-DDDD: Cannot map shared memory at address XXXX" The adapter's shared memory at address XXXX cannot be accessed. Please run Madge Assist to diagnose the problem. -------- "mtok?: 00010004-CC-DDDD: Could not complete adapter configuration" This is an internal error - please contact Madge Technical support. -------- "mtok?: 00010005-CC-DDDD: LAA specified is invalid, using the adapter's BIA" The driver has been configured to use an invalid locally administered node address. Please see section 6 for information on setting the node address. -------- "mtok?: 00010006-CC-DDDD: Failed to open, please check cabling" The adapter failed to open onto the Token-Ring. The most likely cause is that the lobe cable is not correctly attached to the adapter or to the hub. Other possible causes are that the driver is set to the wrong ring speed or that the driver is using an alternative address that is already in use on the token ring. -------- "mtok?: 00010007-CC-DDDD: Adapter has been removed" The adapter has been removed from the computer. -------- "mtok?: 00010008-CC-DDDD: Adapter has died" The adapter has died, possibly due to an adapter or computer hardware fault. Please run Madge Assist to diagnose the problem. -------- "mtok?: 00010009-CC-DDDD: Cannot find a slave adapter - using master only" The driver could not find an adapter to use as the slave of a mirrored pair. Mirroring has been disabled. The two adapters in a mirrored pair must be Smart 16/4 PCI Ringnodes, must be of the same type and must be on the same PCI bus. The slave adapter must have a higher PCI device number than the master. See section 9. -------- "mtok?: 0001000A-CC-DDDD: Cannot initialise the slave adapter - using master only" The driver cannot initialise the slave adapter. Mirroring has been disabled. Please run Madge Assist to diagnose the problem. -------- "mtok?: 0001000B-CC-DDDD: Only PCI adapters can be used for mirroring - using master only" Only Smart 16/4 PCI Ringnodes may be mirrored. Mirroring has been disabled. See section 9. -------- "mtok?: 0001000C-CC-DDDD: Mirroring requires a valid LAA - using master only" A valid locally administered address must be specified for mirroring. Mirroring has been disabled. See section 9. -------- "mtok?: 0001000D-CC-DDDD: Cannot register interrupt vector X" The driver failed to register interrupt vector number X with Unixware. -------- "mtok?: 0001000E-CC-DDDD: The machine does not contain an ISA bus" An attempt has been made to install the driver software for an ISA adapter in a machine that does not contain an ISA bus. -------- "mtok?: 0001000F-CC-DDDD: Cannot read XXXX from the resource manager" The driver could not read the parameter called XXXX from the resource manager. -------- "mtok?: 00010010-CC-DDDD: Cannot automatically reconfigure ISA adapter at I/O base XXXX" The driver has been asked to change the configuration of the ISA adapter at I/O base XXXX. This cannot be done by the driver. Please use Madge Assist to change the adaper's configuration. -------- "mtok?: 00010011-CC-DDDD: Too many adapters" An attempt has been made to install more adapters than the driver can support. -------- "mtok?: 00010012-CC-DDDD: Invalid maximum frame size (XXXX) using default" A maximum frame size of XXXX that is too large has been specified. The default of 4096 is being used instead. -------- "mtok?: 00010013-CC-DDDD: Cannot set the interrupt type in the resource manager" The driver cannot set the interrupt type (level or edge triggered) in the resource manager. -------- "mtok?: 00010014-CC-DDDD: The adapter cannot use interrupt number XX" The adapter is not capable of using interrupt number XX. -------- "mtok?: 00010015-CC-DDDD: The adapter cannot use DMA channel X" The adapter is not capable of using DMA channel X. -------- "mtok?: 00010016-CC-DDDD: The adapter's address can only be changed to a valid LAA" A request has been made to set the adaper's node address to a value that is not a valid locally administered address. -------- "mtok?: 00010017-CC-DDDD: Cannot set the IPL in the resource manager" The driver cannot set the interrupt priority level in the resource manager. -------- "mtok?: 00020002-CC-DDDD: Opened in Classic mode" The adapter has open in Classic Token-Ring mode. -------- "mtok?: 00020003-CC-DDDD: Opened in DTR mode" The adapter has open in Dedicated Token-Ring (full duplex) mode. -------- "mtok?: 00020004-CC-DDDD: Opened in single-station mode" The adapter has opened but is the only adapter open on the ring. -------- "mtok?: 00020005-CC-DDDD: Ring status has changed to XXXX" The state of the Token-Ring has changed to XXXX". -------- "mtok?: 00020006-CC-DDDD: Closed - trying to re-open" The adapter has closed and is trying to re-open. -------- "mtok?: 00020007-CC-DDDD: A mirrored adapter switch has occurred" The driver has switched to using the other adapter in a mirrored pair. **** End of sco7.txt **************************************************