STANDARD MICROSYSTEMS CORPORATION Diagnostic Program For EtherCard PLUS Family LAN Adapters USER GUIDE This software is licensed by SMC for use by its customers only. Copyright (c) 1992 Standard Microsystems Corporation. All rights reserved. SYSTEM REQUIREMENTS The system must have at least 384 Kbytes of RAM installed. OPERATING INSTRUCTIONS This document contains the procedures for testing the following EtherCard PLUS Family LAN adapters: XT/AT Bus Adapters: StarLAN 8003S 8003SH Ethernet 8003E 8003EBT 8003EB 8003EP 8013EBT 8013EW 8013EP 8013EWC 8013EPC Ethernet TP 8003WT 8003W 8003WC 8013W 8013EW 8013WC 8013EWC Micro Channel Bus Adapters: StarLAN 8003ST/A Ethernet 8003ET/A 8003E/A 8013EP/A Ethernet TP 8003W/A 8013WP/A << DISK FILES >> DIAGNOSE.EXE Diagnostic Program $RUN.OVL -- SYS$MSG.DAT | SYS$HELP.DAT |-- Support FIles SYS$ERR.DAT | DIAGHLP.HLP -- USER.DOC User Documentation (this file) RELEASE.DOC Release Documentation All Diagnostic Program files must be in the same directory for proper operation. << OVERVIEW >> The Diagnostic Program is used to verify the correct configuration and operation of an EtherCard PLUS Family LAN adapter before installing the network software. << BEFORE STARTING THE PROGRAM >> 1. Be sure you know the configuration of any adapters that use jumpers to set the configuration. 2. After turning off the PC's power, insert the adapter into the PC. ** Ethernet adapters must be on a properly terminated cable (use a BNC "T" connector with two 50 Ohm terminators, an AUI loopback connector or connect the RJ45 connecter to a concentrater). 3. Boot the PC to a DOS prompt. ** Memory resident (TSR) programs and device drivers should not be loaded while the Diagnostic Program is active, so you may need to temporarily rename your CONFIG.SYS and AUTOEXEC.BAT files. The Diagnostic Program is always run without loading any network software. << STARTING THE PROGRAM >> 1. To run the Diagnostic Program, change to directory with the Diagnostic Program, type DIAGNOSE and press Enter. 2. Read the opening screen and press Enter. ** Press F1 any time in this program to get help 3. Press Enter to select an adapter to test. More than one adapter may be displayed depending on the number of adapters installed in the system. 4. If an error message is displayed then an adapter is not present. ** The adapter type and the Base I/O should appear. If two adapters are in the machine both adapters should be listed. Every network adapter in a PC must have a unique IRQ and Base I/O. ** If only one adapter is displayed, but more than one adapter is in the PC, then the Base I/O on the adapters is the same. Turn off the PC and check the Base I/O on all adapters. Change the Base I/O's so that each adapter has a unique value. Restart the PC and rerun the Diagnostic Program. 5. Select the adapter to test and press Enter. The adapter configuration is displayed. Board Type - Displays the adapter type Base I/O - found by searching all base I/O's IRQ - defaults to three (3) regardless of what IRQ the adapter is actually set to (see note 1) RAM size - defaults to most appropriate setting (see note 1) RAM address - always defaults to D0000 ROM size - defaults to most appropriate setting (see note 1) ROM status - defaults to most appropriate setting (see note 1) NOTE 1: The 8003EB, 8003EW and 8003W and Micro Channel adapters allow DIAGNOSE to correctly read the configuration information from the adapter. ** Read the file SYSMAP.DOC in the root of the SuperDisk for more information about the various settings available on the EtherCard PLUS Family network adapters. 6. Press any key to continue. << SET CONFIGURATION >> 1. Go to SET CONFIGURATION by pressing S or using the Up/Down arrows if the IRQ, RAM address, RAM Size, or ROM Size and Address need to be changed from the displayed value. 2. The adapter's network address is displayed. 3. Using the Up/Down arrows go to the setting that needs to be changed. 4. Press Enter and a menu of options displays. Again use the Up/Down arrows to position the highlight bar on the proper option and press Enter to select a new choice. ** The Base I/O and IRQ must match the adapter settings ** The RAM address selected here is only for the purpose of this program and has no effect on any other network software. 5. If an invalid selection is made the program will not stop the user from making that selection. 6. Press F10 to save the changes or ESC to exit without change. << BASIC ADAPTER TEST >> 1. The BASIC ADAPTER TEST must be run to verify correct operation. 2. Press B or move the highlight bar using the Up/Down arrows over the BASIC ADAPTER TEST option in the menu and press Enter. 3. This selection tests the basic adapter functions. The test takes less than a minute and displays "ALL BASIC ADAPTER TESTS COMPLETED SUCCESSFULLY" and "PRESS ANY KEY TO CONTINUE" upon successful completion. 4. The test has failed if any of these conditions occur: A) An error message displays at the bottom of the screen in a RED box; or B) The test hangs up at any blinking line and never completes. The blinking line is the test that failed. ** Read the error message or blinking line and write it down!! Then reboot the PC. ** Use the error message or blinking line to find the problem. Common problems include not terminating an Ethernet adapter in a thin coaxial topology and hardware or software conflicts with IRQ, Base I/O, or RAM address. ** An adapter may be considered defective if it does not pass this test and an identical adapter with the same configuration does pass. 5. If the adapter fails, recheck the adapter settings, try a different BNC "T" connector and terminator, or remove other adapters which may be causing a conflict from the PC. << INITIATE TEST MESSAGES and RESPOND TO TEST MESSAGES >> 1. The best test environment is two PCs directly cabled and terminated, but this test can be run with any PCs on a network. 2. These two tests must be run together on two different machines, both of which must have passed the basic adapter test. 3. In this example we will refer to COMPUTER A and COMPUTER B. Start with COMPUTER A: Press R or move the highlight bar using the Up/Down arrows to Respond To Test Messages, and press Enter. Press Enter again and a box opens in the middle of the screen with the message: Responding to test messages Press any key to stop COMPUTER A is now ready to respond to test messages and is called the Responder. Go to COMPUTER B: Press I or move the highlight bar using the Up/Down arrows to Initiate Test Messages, and press Enter. There are two methods to perform the test. 1. Press Enter to begin the test. The test will perform 1000 iterations after finding the first available responder. 2. If you have more than one responder on the network, press F2 and all active responders are displayed with their network addresses. Select the desired responder by using the Up/Down arrows and pressing Enter. Press Enter and the test will perform 1000 iterations. ** If an error message, No Responder Found, is displayed then the two computers cannot communicate across the network. The normal reason this test fails is that cabling, "T" connectors, or terminators are bad, the wrong resistance, or poorly connected. When the test is complete press F4 on both computers to view test results. ** A small number of collisions is normal on a live network or one with multiple test initiators; however, Alignment or CRC errors might mean that the adapter that initiated the messages (COMPUTER B) is bad. Press F6 to clear the results for the next test, then press ESC. At this point the test of the adapters is complete. There are further options available on the initiating computer (COMPUTER B). The option menu is selected by pressing F6. F6 will allow you to set parameters such as the frame length. The Up/Down arrows are used to select the parameters and the spacebar to change parameter values. Set the Iterations to non-stop to run a continuous test. To stop the continuous test press any key. This concludes this additional options test. There are other choices available under the additional options test. << ADVANCED USE >> The Diagnostic Program is also designed to operate from the command line. This method of operation is especially appropriate if your adapter uses a non-factory configuration. When you use the command line setup, you bypass constantly using the SET CONFIGURATION portion of the program. The following lists the command line parameters available: /base:aaa Specifies base I/O address. /irq:n Specifies interrupt level (IRQ). /ram:aaaaa Specifies base address of the on-board RAM. /rom:aaaaa Specifies base address of the boot ROM. /adapter:n Specifies adapter to test, see note 1. /slot:n Specifies Micro Channel slot adapter to test. /send Initiates test messages to the first available responder (automatically found). /send:xxxxxx Initiates test messages to network address 'xxxxxx'. Each 'x' is a two digit hex value (e.g. C0). /respond Echoes received test messages. /test Runs Basic Adapter Test. /oem Displays current OEM node address and card ID. /v Displays program version and copyright info. /? Displays this help screen. Note 1: Adapter is selected using Base I/O for systems with more than one network adapter. If /ADAPTER:2 was used then the adapter with the second Base I/O (in ascending order) is tested. These command line parameters can be used in combination with batch files. For example: diagnose /irq:7 /respond Initiates program using IRQ 7 and starts the computer in a responder mode. diagnose /base:320 /test Initiates program using a Base I/O of 320h and runs the Basic Test Program. << ERRORS >> When using certain command line parameters (i.e. /send, /respond, and /test) the batch file can interrogate the return code and inform the user of the result. The meanings of the return codes are described below. "NIC" refers to the Network Interface Controller chip on the adapter (a DP8390 or WD83C690 device); "CRC" refers to the Cyclic Redundancy Check code that is used for error checking in every message. 0x00 - No error. 0x01 - Insufficient memory to run program. 0x02 - No adapter appears to be in the machine. 0x03 - More than one adapter is in the machine and the user has not specified which one to Diagnose. 0x04 - Command line parameters are out of range. 0x05 - No adapter appears to be at the specified base I/O address. 0x06 - LAN address ROM does not produce a valid check sum. 0x07 - RAM base address is out of range. 0x08 - Other RAM occupies the specified RAM base address. 0x09 - ROM occupies the specified RAM base address. 0x0A - Program tried to write to RAM while it was disabled. 0x0B - RAM test failed. 0x0C - Network Interface Controller (NIC) chip is bad. 0x0D - ROM base address is out of range. 0x0E - RAM occupies the specified ROM base address. 0x0F - ROM base address conflicts with RAM base address. 0x10 - Unable to find a Boot ROM signature at the specified ROM base address. 0x11 - Unable to produce a valid Boot ROM check sum on the ROM at the specified ROM base address. * 0x12 - Loopback FIFO error. The data received does not compare with that sent (used with DP8390 device). * 0x13 - Loopback packet error. The data received does not compare with that sent (used with WD83C690 device). * 0x14 - A CRC error was expected but was not generated. * 0x15 - The NIC was unable to transmit a packet. This could be caused by an improperly terminated network. * 0x16 - A good CRC was manually appended to the loopback packet, but the NIC logged a CRC error. * 0x17 - A bad CRC was manually appended to the loopback packet, but the NIC did not log a CRC error. * 0x18 - The NIC accepted a packet whose address did not match that of the NIC. 0x19 - Interrupt not serviced. Usually caused by wrong IRQ setting. 0x1A - Receive timed out. Could be normal on a busy network. 0x1B - Max retries has been reached waiting for a packet to be echoed. No frames are being sent to this node. 0x1C - A packet is ready to be taken from the intelligent card. This should never be seen by the batch file. 0x1D - The packet received does not match the packet sent. 0x1E - A memory contention error has occurred. 0x1F - User has struck the keyboard in an attempt to exit the current operation. 0x20 - No responders can be found. Run Diagnose on another machine on this network. 0x21 - No frame has been sent. May be due to incorrect IRQ setting. 0x22 - No frame has been received. No responder is present on the network. 0x23 - Tried to transmit a packet, but the NIC was unable to transmit the previous packet. Perhaps the cable is not connected. 0x24 - Intelligent card does not respond. 0x25 - Error reading the installed Boot ROM 0x26 - Specified ROM size does not match the size read from the Boot ROM chip at the specified ROM base address. 0x27 - Specified IRQ value is out of range for the adapter being tested. 0x28 - The command line parameter '/adapter:n' has been used, however no adapter can be found. 0x29 - The command line parameter '/slot:n' has been used, however the machine running this code is not Micro Channel. 0x2A - The command line parameter '/slot:n' has been used, however no adapter can be found in slot n. 0x2B - This is an internal code never to be seen by the OS. 0x2C - An invalid command line parameter has been specified. 0x2D - Interrupt not enabled. This software configurable adapter has been improperly 'Setup', or not at all. The interrupt must be enabled via software 'Setup'. * Loopback results may be affected by traffic on a live network. Diagnose retries these tests to gain accurate results, however, these tests should be run with a Loopback connector attached to the LAN controller. << SUPPORT >> If you have any additional questions regarding your Diagnostic Program, contact your dealer or distributor technical support department. EtherCard PLUS, TokenCard, and SuperDisk are trademarks, and SMC and Standard Microsystems are registered trademarks of Standard Microsystems Corporation. Other trademarks mentioned herein belong to their respective companies.