ÖÒ· ·Ö Ö· Ò· Ö· Ö· Ö· Ö· ÖÒ· º ºº ǽ Ƕ ºº ǽ ºº ǽ º Ð Ó½ ½Ó н Ó½ ½ Ó½ ½Ó Ð ÖÒ· Ö· Ò· Ö· Ö· ºÐº Ó· ºº ºº Ó· ½ Ð Ó½ н Ó½ Ó½ Star Gate Technologies, Inc. TurboPort/RA1 & TurboPort/RA2 DOS-Based Port Configuration Utilities Software Instruction Sheet (manual part number: 650164-02) 1.1 Introduction Turboget and Turboset are DOS-based utilities that are used to view and to change the settings of the COM ports in a computer, including the ports on a TurboPort/RA serial I/O controller operating in a DOS or a NetWare Connect client environment. To access these utilities, you must first copy the files TURBOGET.EXE and TURBOSET.EXE in this subdirectory (a:\dos) to a directory on your hard drive. NOTE In a NetWare Connect environment, Turboset and Turboget are to be used only for the client side of the connection, not for the server side. The recommended settings for operation in a NetWare Connect client environment are: 1. The TurboPort/RA hardware flow control should be enabled. See section 1.6 entitled "The Turboset Utility" in this instruction sheet. 2. Disable hardware flow control in the NetWare Connect client software. Follow the instructions in the section entitled "Configuring NRN" in Chapter 6 of the NOVELL NetWare Connect 1.0 Administration Guide. 1.2 Baud Rate Clocks and Fastbaud The setting of the clock jumper JMP1 selects either standard or fast baud rates for the TurboPort/RA1 and for port 1 of the TurboPort/RA2. (The clock jumper JMP2 selects either standard or fast baud rates for port 2 of the TurboPort/RA2.) If the jumper is in the standard clock position (pins 3 and 4 connected), only standard baud rates will be supported, and the FASTBAUD=ON | OFF parameter of the Turboset utility will have no effect on the port baud rate. If the clock jumper is in the fast baud position (pins 2 and 3 connected), only fast baud rates will be supported, and the FASTBAUD=ON | OFF parameter will have no effect on the port baud rate. If the clock jumper is in the software configurable position (pins 1 and 2 connected), the controller will default to standard baud rates at power-up time, but fast baud rates can be supported by using the FASTBAUD=ON parameter. See step 5 of the TurboPort/RA1 and TurboPort/RA2 Hardware Instruction Sheet for information on the jumper settings. 1.3 Using Fast Baud Rates with Standard Applications When using fast baud rates (either with the FASTBAUD=ON parameter or with the clock jumper in the fast position), standard applications must be configured to specify a baud rate which is 1/4 of the desired baud rate. For instance, to get a speed of 230,400 baud, set the TurboPort/RA port for fast baud rates (FASTBAUD=ON or clock jumper in the fast position) and select a baud rate of 57,600 in the application. The following table lists common fast baud rates and the baud rates that must be specified to achieve those fast baud rates. ----------------------------- Fast Baud | Baud Rate Rate | Selected Desired | in Application ----------------------------- 300 | 75 1200 | 300 2400 | 600 9600 | 2400 19,200 | 4800 28,800 | 7200 38,400 | 9600 57,600 | 14,400 115,200 | 28,800 230,400 | 57,600 460,800 | 115,200 1.4 Hardware Flow Control The TurboPort/RA supports hardware flow control for both input and output. Input flow control is achieved using the RTS output. The TurboPort/RA receiver will assert the RTS output when it is prepared to receive data, and it will negate the RTS output when it has no room left to accept additional data. Output flow control is achieved using the CTS input to control the TurboPort/RA transmitter. When the CTS input is asserted and the TurboPort/RA has data to send, it will transmit characters. When the CTS input becomes negated, the TurboPort/RA will complete transmission of the current character, but it will not send further characters until CTS is again asserted. 1.5 Software Flow Control Software flow control is supported for both input and output. XON and XOFF characters may be specified and can be different for input and output. Enabling software flow control (SWFLOW=ON in the Turboset command) enables software flow control for both the transmitter and receiver. When software flow control is enabled, the TurboPort/RA will transmit an XOFF character when the receiver is full, and it will subsequently transmit an XON character when the receiver has room for more data. The XON and XOFF characters which are transmitted may be specified with the TXXON=xx and TXXOFF=xx parameters of the Turboset utility. When software flow control is enabled, the TurboPort/RA will stop transmission when an XOFF character is received, and it will restart transmission when an XON character is subsequently received. The XON and XOFF characters which are received may be specified with the RXXON=xx and RXXOFF=xx parameters of the Turboset utility. If software flow control is enabled (SWFLOW=ON) and the XON and XOFF characters are not specified, both input and output XON characters default to 11 hex, and both input and output XOFF characters default to 13 hex. You can subsequently change any of the XON or XOFF characters by invoking the Turboset command again and using the TXXON, TXXOFF, RXXON, or RXXOFF parameters. You do not have to set the SWFLOW parameter to ON again when making these changes unless you had reset SWFLOW to OFF. 1.6 The Turboset Utility The Turboset utility is used to configure various features on a TurboPort/RA port that are not supported by a standard COM port that has a 16450 or a 16550 UART. You must invoke the Turboset command from the directory on your hard drive to which you copied the file TURBOSET.EXE. The syntax for the Turboset command is: TURBOSET COMx [FASTBAUD=ON | OFF] [HWFLOW=ON | OFF] [SWFLOW=ON | OFF] [TXXON=xx] [TXXOFF=xx] [RXXON=xx] [RXXOFF=xx] The parameters for the Turboset command are as follows: COMx This is the COM port identifier for the port to be configured. Allowable values are COM1, COM2, COM3 or COM4. This parameter is required. FASTBAUD=ON | OFF If the clock jumper is in the software configurable position (pins 1 and 2 of JMP1 or JMP2 connected), this parameter specifies whether the TurboPort/RA port will use the standard baud rate clock (FASTBAUD=OFF) or the fast baud rate clock (FASTBAUD=ON). This parameter is optional. If this parameter is not specified, the baud clock setting will not be changed if the clock jumper remains in the software configurable position. If the clock jumper is in the software configurable position, the default setting at power-up is the standard baud rates. HWFLOW=ON | OFF This parameter specifies whether or not the TurboPort/RA port will use hardware flow control. HWFLOW=ON will cause hardware flow control to be activated; HWFLOW=OFF will cause hardware flow control to be deactivated. This parameter is optional. If this parameter is not specified, the hardware flow control setting will not be changed. The default setting at power-up is hardware flow control OFF. SWFLOW=ON | OFF This parameter specifies whether or not the TurboPort/RA will handle software flow control using XOFF and XON characters. SWFLOW=ON will cause software flow control to be activated; SWFLOW=OFF will cause software flow control to be deactivated. This parameter is optional. If this parameter is not specified, the software flow control setting will not be changed. The default setting at power-up is software flow control OFF. TXXON=xx This parameter specifies the XON character that will be transmitted when software flow control is enabled. The xx parameter specifies the character as 1 or 2 hexadecimal digits. The default XON character is 11 hex. TXXOFF=xx This parameter specifies the XOFF character that will be transmitted when software flow control is enabled. The xx parameter specifies the character as 1 or 2 hexadecimal digits. The default XOFF character is 13 hex. RXXON=xx This parameter specifies the XON character that the receiver will recognize to restart transmission that was previously suspended by a received XOFF character when software flow control is enabled. The xx parameter specifies the character as 1 or 2 hexadecimal digits. The default XON character is 11 hex. RXXOFF=xx This parameter specifies the XOFF character that the receiver will recognize to suspend transmission when software flow control is enabled. The xx parameter specifies the character as 1 or 2 hexadecimal digits. The default XOFF character is 13 hex. 1.7 The Turboget Utility The Turboget utility is used to view the configuration of TurboPort/RA ports and other standard serial ports in the system. You must invoke the Turboget command from the directory on your hard drive to which you copied the file TURBOGET.EXE. (Simply enter turboget at the command line.) When the Turboget utility is executed, it displays a list of parameters for the standard COM port addresses on the screen. A sample screen is shown below. Note that hexadecimal values are indicated by a leading 0x. Base I/O Address 0x3F8 0x2F8 0x3E8 0x2E8 Detected by BIOS as COM1 COM2 COM3 Not Detected Baud Rate 9600 2400 2400 0 Parity Type Even None None None Data Bits per Character 7 8 8 8 Stop Bits per Character 1 1 1 1 State of RTS Output On On Off Off State of CTS Input Off Off Off Off State of DSR Input Off Off Off Off State of DCD Input Off Off Off Off State of DTR Output On Off Off Off State of RI Input Off Off Off Off UART Chip Used 8250/16450 16C650 16C650 Not Present FIFOs N/A Enabled Disabled N/A Hardware Flow Control N/A Enabled Disabled N/A Software Flow Control N/A Disabled Enabled N/A Transmitter XON Char N/A N/A 0x11 N/A Transmitter XOFF Char N/A N/A 0x13 N/A Receiver XON Char N/A N/A 0x11 N/A Receiver XOFF Char N/A N/A 0x13 N/A Base I/O Address These are the I/O addresses for the standard serial ports in the system. Turboget examines each of these addresses and lists appropriate parameters. Detected by BIOS as The system BIOS looks for COM ports during boot time and stores the base I/O addresses of detected COM ports in a table in memory. A port can be detected as COM1, COM2, COM3 or COM4, or it may be listed as Not Detected. Not Detected indicates that either no COM port is installed at that I/O address or the system BIOS did not detect a port at that address. Some older systems' BIOS only look for 2 COM ports and will not indicate COM3 or COM4 in the table. Baud Rate Fast baud rates are not displayed. Therefore, a displayed baud rate does not indicate whether the port is configured at a standard rate or at a fast baud rate. For example, in the screen above, COM1 is configured for either 9600 Baud in standard mode or for 38,400 Baud (9600 x 4) in fast baud mode. Parity Type The parity setting for the port. Values can be Even, Odd, Mark, Space or None. Data Bits per Character The number of data bits for each character. Values can be 5, 6, 7 or 8. Stop Bits per Character The number of stop bits for each character. Values can be 1 or 2 if Data Bits per Character is 6, 7 or 8. Values can be 1 or 1.5 if Data Bits per Character is 5. State of signal (XXX) Input/Output These lines show the state of the hardware handshake lines for the port. "On" indicates an asserted input or output, and "Off" indicates a negated input or output. UART Chip Used Indicates the type of UART detected by the utility. Values can be 8250/16450, 16550AF or 16C650. FIFOs Indicates whether or not transmit and receive FIFOs are being used by the port. Values can be Enabled or Disabled (for 16550 and 16650 only) or N/A (for 8250/16450). Hardware Flow Control Indicates whether or not hardware flow control is active. Values can be Enabled or Disabled (for 16C650 only) or N/A (for other types of UARTs). Software Flow Control Indicates whether or not software flow control is active. Values can be Enabled or Disabled (for 16C650 only) or N/A (for other types of UARTs). Transmitter XON Char Indicates the hexadecimal value of the transmitter XON character. If the UART is not a 16C650, or if software flow control is disabled, this field will be N/A. Transmitter XOFF Char Indicates the hexadecimal value of the transmitter XOFF character. If the UART is not a 16C650, or if software flow control is disabled, this field will be N/A. Receiver XON Char Indicates the hexadecimal value of the receiver XON character. If the UART is not a 16C650, or if software flow control is disabled, this field will be N/A. Receiver XOFF Char Indicates the hexadecimal value of the receiver XOFF character. If the UART is not a 16C650, or if software flow control is disabled, this field will be N/A. CUSTOMER ASSISTANCE For customer service or sales assistance, call 1-800-STAR GATE (1-800-782-7428) or 216-349-1860 from 8 a.m. to 6 p.m., Eastern Standard Time. You can also use our BBS (216-349-2904). Our technical support hours are from 8:00 a.m. to 5:30 p.m., EST. If you have any comments, suggestions, or corrections regarding this readme file, please print the affected page(s), indicate your comments on the copies, and mail or FAX the copies to the address or FAX number below. Star Gate Technologies, Inc. Attn: Technical Documentation Dept. 29300 Aurora Road Solon, Ohio 44139 FAX (216) 349-1978 LICENSE AGREEMENT License: You have the nonexclusive right to use the enclosed software on one host computer, plus the terminals connected to it, at a time. You may transfer the software from one computer system to another, provided the software is used only on one computer system at a time. Copyright: The Turboset and Turboget utilities and its documentation are owned by Star Gate Technologies, Inc., and are protected by United States copyright laws and international treaty provisions. You must treat this material like any other copyrighted materials, except that you may make one copy of the SOFTWARE solely for backup or archival purposes and transfer the SOFTWARE to a single hard disk. Term: This license is effective until terminated. You may terminate it by destroying the program, its documentation and all copies. This license can be terminated by Star Gate Technologies, Inc., if you fail to comply with any term or condition of this agreement. As Is: The program and its documentation are provided "AS IS" without warranty of any kind. The entire risk as to the results and performance of the software is assumed by you. Should the program prove to be defective, you (and not Star Gate Technologies, Inc., or its dealers) assume the entire cost of all necessary servicing, repairs or corrections. Further, Star Gate Technologies, Inc., does not warrant, guarantee or make any representations regarding the use of, or the results of the use of, the software in terms of correctness, accuracy, reliability, currentness or otherwise. You rely on the program and results solely at your own risk. No Warranties: Star Gate Technologies, Inc., disclaims all warranties, expressed or implied, including but not limited to the implied warranties of merchantability or fitness for a particular purpose, with respect to the software, the accompanying written materials, and any accompanying hardware. No Liability or Consequential Damages: Neither Star Gate Technologies, Inc., nor anyone else who has been involved in the creation, production or delivery of this program shall be liable for any direct, indirect, consequential or incidental damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use, the result of use, or the inability to use such product, even if Star Gate Technologies, Inc., has been advised of the possibility of such damages or claims. Because some states do not allow the exclusion or limitation of liability for consequential or incidental damages, the above limitation may not apply to you.