User Diagnostics Manual (USERSTD.TXT) 9/18/97 Digi International, Inc. Table Of Contents 1.0 Scope 2.0 Applicable Documents 3.0 User Diagnostic Utility (UD-STD.EXE) 3.1 General Description 3.1.1 Display Conventions 3.1.2 Keyboard Conventions 3.1.3 Supported Product Families for the User Diagnostics 3.2 Functional Description 3.2.1 General Information Screen 3.2.2 Main Menu Screen 3.2.3 Main Help Screen 3.2.4 System Error Messages 3.3 PC/X Adapter Product Family 3.3.1 General Information 3.3.2 Help Screens 3.3.3 Basic Test Descriptions 3.3.4 Error Messages 3.4 MC/X Adapter Product Family 3.4.1 General Information 3.4.2 Help Screens 3.4.3 Basic Test Descriptions 3.4.4 Error Messages 1.0 Scope This document contains information related to the User Diagnostics package. All files for this package are contained on the floppy disk, and include this document, one executable program, and release notes. This document explains the user diagnostics (UD-STD.EXE). 2.0 Applicable Documents PC/8 or PC/4 Installation Guide & Reference Manual DBI 90021400 MC/16 Installation Guide & Reference Manual DBI 90022500 MC/8 or MC/4 Installation Guide & Reference Manual DBI 90022700 PC/16 Installation Guide & Reference Manual DBI 90023200 3.0 User Diagnostic Utility (UD-STD.EXE) 3.1 General Description The user diagnostic utility is an DOS based executable program that is designed to aid in the installation and troubleshooting of Digi hardware by performing a series of tests on the adapter. 3.1.1 Display Conventions When the user diagnostic utility is run, a general information screen is displayed, followed by the main screen. From the main screen, the operator may select a "Help" screen, run the diagnostic tests, or return to the operating system. There are four sections to the display. The upper section of the screen displays the current version of the utility and copyright information. The next section is the parameter selection section. The next section displays test results when the diagnostic is executing. The lower portion of the screen is used for the operator interface. 3.1.2 Keyboard Conventions There are multiple keyboard entries for the user diagnostic utility. Adapter parameters have unique keyboard entries. When all parameters have been entered, press to run the utility. Pressing displays various help screens. is used to return to the operating system. The utility uses the bottom of the screen to prompt the operator for keyboard inputs. 3.1.3 Supported Product Families For The User Diagnostics The current release of the user diagnostic supports the PC/X adapters, including the PC/4, PC/8, and PC/16 adapters. The user diagnostics also supports the MC/X adapters, including the MC/4, MC/8, and the MC/16 adapters. The MC/4 and MC/8 adapters use file @6FE5.ADF. The MC/16 adapters use file @6FE4.ADF. 3.2 Functional Description The user diagnostic is a program that will test a Digi product for system compatability and adapter reliability. After all parameters have been entered, the operator may run the diagnostic. A configuration file (UD-STD.CFG) is written to disk when program execution begins. When the program is run again, the configuration information is read and displayed for the operator. The operator can immediately run the diagnostics by pressing , or reenter any parameters prior to running the diagnostics. 3.2.1 General Information Screen This screen gives the operator an overview of how to correctly run the user diagnostics. Appropriate warning messages are also displayed. 3.2.2 Main Menu Screen Following the general information, the main screen appears. This program is designed to support multiple Digi products. The operator must select a product family displayed at the bottom of the screen. 3.2.3 Main Help Screen Prior to selecting a product family, pressing will display a product family information screen. 3.2.4 System Error Messages One of the items that is stored in the configuration file (UD-STD.CFG) is the system bus type. This is either ISA, EISA or Micro Channel. If the stored data does not match the bus the program has found, the following error message is displayed: ERROR! The diagnostics have detected a bus conflict. ERROR! The diagnostic reported an ISA/EISA bus. The disk file reported a Micro Channel bus. (or) The diagnostic reported a Micro Channel bus. The disk file reported an ISA/EISA bus. Erase file UD-STD.CFG, then rerun the diagnostics. When UD-STD.CFG is erased the operator must enter new parameters and the new UD-STD.CFG will be written upon execution. Executing the diagnostic again on the same machine should result in no further bus conflicts. 3.3 PC/X Adapter Product Family Adapters in this product family are nonintelligent communication adapters. They communicate with the host via assigned I/O ports, status register, and interrupts. They support asynchronous communication with 4, 8, or 16 ports. 3.3.1 General Information The PC/16 address and status register is preset with PALs on the adapter. Refer to the supplied documentation to determine this information. The PC/4 and PC/8 address and status register is set with switches on the adapter. Refer to the supplied documentation for the switch settings. Interrupts on all the PC/X adapters are set with jumpers. Refer to the supplied documentation for the jumper settings. 3.3.2 Help Screens There is a help screen associated with this product family. It explains each of the parameter entries. 3.3.3 Basic Test Descriptions There are three basic test areas for this product family. The first test is the data loopback test. This test is run in either internal or external loopback mode. It tests the ability of the port to transmit and receive data. The port is set to 9600 baud, 8 data bits, 1 stop bit and no parity. Various patterns are transmitted and the received data is checked against the transmitted data and the port's status is checked. The second test is the control signals loopback test. This test is run in either internal or external loopback mode. It tests the ability of the port to change its ouput signals and to read the states of the input signals. The third test is the IRQ interrupt test. This test is only run in the external loopback mode. It tests the ability of the port to generate an IRQ to the host and verifies that the status register reports the correct port information. The parameters allow for a single port to be tested. The diagnostic package includes an EIA-232 loopback cable for testing. The signals that are looped back on the supplied cable are TxD to RxD, DTR to DSR & DCD, and RTS to CTS & RING. The "L)oopback" parameter enables the operator to test the port in the internal (No) or external (Yes) mode. The loopback cable must be installed for valid test results in the external mode. The "C)ontinuous" parameter causes the port tests to run once (No) or continuously (Yes). The "S)top On First Error" parameter causes the test to stop when the 1st error is detected (Yes) or run until program termination (No). The EIA-232 loopback plug, part number 60000401, for the RJ-45 version consists of a 10-pin RJ-45 connector wired as follows: Pin 3 to pins 1 & 8 (RTS to RI and CTS) Pin 5 to pin 6 (TxD to RxD) Pin 9 to pins 2 & 10 (DTR to DSR and DCD) The EIA-232 loopback plug, part number 60000442, for the DB-25 version consists of a female DB-25 connector wired as follows: Pin 4 to pins 22 & 5 (RTS to RI and CTS) Pin 2 to pin 3 (TxD to RxD) Pin 20 to pins 6 & 8 (DTR to DSR and DCD) ********** SPECIAL NOTE ********** The selected 'P)ort Number' and 'A)ddress Of Port' are independent parameters. Incorrect results may appear if the 'A)ddress of Port' is not set to the matching 'P)ort Number' on the adapter; but set to a valid port address elsewhere on the adapter. The 'P)ort Number' is used to identify a bit associated with the IRQ test. The 'A)dress Of Port' is set to the port's corresponding DIP switch value. With multiple loopbacks installed, mismatches could cause the external data & control signals tests to pass, but fail the IRQ test. Mismatches with no loopback installed may pass all tests if the 'P)ort Address' is set to a valid DIP switch setting on the adapter. It is suggested that during external loopback testing, only 1 loopback plug be installed. ********** SPECIAL NOTE ********** 3.3.4 Error Messages There are two places where error messages may appear. The first is at the bottom of the screen in the operator interface section. Error messages here relate to parameter entry. These messages typically prompt the operator for another entry. All parameters must be entered before execution can begin. The second place error messages appear is in the test information section. These will be displayed in red with "Test FAILED" followed by a message to identify the error. For either the internal or external data test, the port's line status register (LSR) is checked. Following the transmission, the LSR should be equal to 61H. If not, the LSR value is displayed with the following message(s): ERROR! Line Status = ??. Data not ready. TX not empty. LSR error. ERROR! Data not ready is checked in bit 0. TX not empty is checked in bits 5 & 6. The remaining 5 bits constitute an LSR error. For either the internal or external data test, the received data is compared to the transmitted data. If they do not compare, the following message is displayed: ERROR! Data failure! Transmitted = ??, Data Received = ??. The internal control signals test places the port in internal loopback mode and toggles bits 0-3 in the modem control register. If an error occurs with the results in the modem status register the following message(s) are displayed: ERROR! Internal Control Signals Failed to set. Failed to clear. ERROR! The external control signals test uses bits 0 & 1 (DTR & RTS) in the modem control register to toggle the four input signals through the loopback connector. Depending on the control signal failure, the following message(s) are displayed: ERROR! External signals. DTR->DCD/DSR failed. RTS->CTS/RI failed. ERROR! The port IRQ interrupt test checks the ability of the selected port to generate an interrupt to the host CPU. This is done by setting the modem status interrupt bit and changing the state of the DTR signal. If an error occurs, the following message(s) are displayed: ERROR! No interrupt received from the port. Extra interrupt(s). ISR error. IIR error. MSR error. ERROR! An interrupt status register (ISR) error indicates that the value read from the selected status register is not equal to the value expected for the assigned port. An interrupt identification register (IIR) error indicates that the port incorrectly reported the expected interrupt or did not successfully clear the interrupt. A modem status register (MSR) error indicates that the expected value in the MSR was not present. 3.4 MC/X Adapter Product Family Adapters in this product family are nonintelligent communication adapters. They communicate with the host via assigned I/O ports, status register, and interrupts. They support asynchronous communication with 4, 8, or 16 ports. 3.4.1 General Information The Micro Channel addresses, status register, and interrrupts are selected from the POS setup program. This information is displayed for the operator and is not a selectable parameter. When the adapter is installed with the setup program (on the IBM reference diskette), these values will be used for the user diagnostics. 3.4.2 Help Screens There is a help screen associated with this product family. It explains each of the parameter entries. 3.4.3 Basic Test Descriptions There are four basic test areas for this product family. The first test is a basic communications test for the entire adapter. All ports are tested for basic communications. This test is only performed once per program E)xecution. The test writes a unique value into each of the port's scratch registers and then reads and compares the values. A failure does not prevent the other three tests from executing. The second test is the data loopback test. This test is run in either internal or external loopback mode. It tests the ability of the port to transmit and receive data. The port is set to 9600 baud, 8 data bits, 1 stop bit and no parity. Various patterns are transmitted and the received data is checked against the transmitted data and the port's status is checked. The third test is the control signals loopback test. This test is run in either internal or external loopback mode. It tests the ability of the port to change its ouput signals and to read the states of the input signals. The fourth test is the IRQ interrupt test. This test is only run in the external loopback mode. It tests the ability of the port to generate an IRQ to the host and verifies that the status register reports the correct port information. The parameters allow for a single port to be tested. The diagnostic package includes an EIA-232 loopback cable for testing. The signals that are looped back on the supplied cable are TxD to RxD, DTR to DSR & DCD, and RTS to CTS & RING. The "L)oopback" parameter enables the operator to test the port in the internal (No) or external (Yes) mode. The loopback cable must be installed for valid test results in the external mode. The "C)ontinuous" parameter causes the port tests to run once (No) or continuously (Yes). The "S)top On First Error" parameter causes the test to stop when the 1st error is detected (Yes) or run until program termination (No). The EIA-232 loopback plug, part number 60000401, for the RJ-45 version consists of a 10-pin RJ-45 connector wired as follows: Pin 3 to pins 1 & 8 (RTS to RI and CTS) Pin 5 to pin 6 (TxD to RxD) Pin 9 to pins 2 & 10 (DTR to DSR and DCD) The EIA-232 loopback plug, part number 60000442, for the DB-25 version consists of a female DB-25 connector wired as follows: Pin 4 to pins 22 & 5 (RTS to RI and CTS) Pin 2 to pin 3 (TxD to RxD) Pin 20 to pins 6 & 8 (DTR to DSR and DCD) ********** SPECIAL NOTE ********** The selected 'P)ort Number' and 'A)ddress Of Port' are independent parameters. Incorrect results may appear if the 'A)ddress of Port' is not set to the matching 'P)ort Number' on the adapter; but set to a valid port address elsewhere on the adapter. The 'P)ort Number' is used to identify a bit associated with the IRQ test. The 'A)dress Of Port' is set to the port's corresponding DIP switch value. With multiple loopbacks installed, mismatches could cause the external data & control signals tests to pass, but fail the IRQ test. Mismatches with no loopback installed may pass all tests if the 'P)ort Address' is set to a valid DIP switch setting on the adapter. It is suggested that during external loopback testing, only 1 loopback plug be installed. ********** SPECIAL NOTE ********** 3.3.4 Error Messages There are two places where error messages may appear. The first is at the bottom of the screen in the operator interface section. Error messages here relate to parameter entry. These messages typically prompt the operator for another entry. All parameters must be entered before execution can begin. The second place error messages appear is in the test information section. These will be displayed in red with "Test FAILED" followed by a message to identify the error. If the basic communications test has one or more ports that fail, the following message is displayed: ERROR! ?? port(s) did not pass basic communications. Mask = ??. ERROR! The number of failed ports is displayed along with a mask of which ports failed. Port 1 is assigned bit 0 and port 16 is assigned bit 15. For either the internal or external data test, the port's line status register (LSR) is checked. Following the transmission, the LSR should be equal to 61H. If not, the LSR value is displayed with the following message(s): ERROR! Line Status = ??. Data not ready. TX not empty. LSR error. ERROR! Data not ready is checked in bit 0. TX not empty is checked in bits 5 & 6. The remaining 5 bits constitute an LSR error. For either the internal or external data test, the received data is compared to the transmitted data. If they do not compare, the following message is displayed: ERROR! Data failure! Transmitted = ??, Data Received = ??. The internal control signals test places the port in internal loopback mode and toggles bits 0-3 in the modem control register. If an error occurs with the results in the modem status register the following message(s) are displayed: ERROR! Internal Control Signals Failed to set. Failed to clear. ERROR! The external control signals test uses bits 0 & 1 (DTR & RTS) in the modem control register to toggle the four input signals through the loopback connector. Depending on the control signal failure, the following message(s) are displayed: ERROR! External signals. DTR->DCD/DSR failed. RTS->CTS/RI failed. ERROR! The port IRQ interrupt test checks the ability of the selected port to generate an interrupt to the host CPU. This is done by setting the modem status interrupt bit and changing the state of the DTR signal. If an error occurs, the following message(s) are displayed: ERROR! No interrupt received from the port. Extra interrupt(s). ISR error. IIR error. MSR error. ERROR! An interrupt status register (ISR) error indicates that the value read from the status register is not equal to the value expected for the assigned port. An interrupt identification register (IIR) error indicates that the port incorrectly reported the expected interrupt or did not successfully clear the interrupt. A modem status register (MSR) error indicates that the expected value in the MSR was not present.