Ö· ·Ö Ö· Ö· Ö· ÖÒ· Ö· Ö· Ƕ ºº Ƕ ºº Ó· º Ƕ ǽ ½Ó Ó/ ½Ó ½Ó Ó½ Ð ½Ó ½Ó Ö· Ö· Ò Ò ºº Ó· º º Ó½ Ó½ Ð Ð Ö· Ò ÖÒ· Ö· Ò ·Ö º º º ǽ º Ó· Ó½ Ð Ð ½Ó Ð ½Ó CONTENTS Chapter 1 Driver Installation 1 1.1 Introduction 1 1.2 Driver Installation on Micro Channel Bus Computers 2 1.2.1 Hardware Installation on Micro Channel Bus Computers 2 OS/2 Software Installation and Configuration on Micro Channel Bus Computers 1.2.3 Citrix A+ Server Software Installation and Configuration on Micro Channel Computers 3 1.3 Driver Installation on EISA Bus Computers 4 1.3.1 Hardware Installation on EISA Bus Computers 4 1.3.2 OS/2 Software Installation and Configuration on EISA Bus Computers 5 1.3.3 Citrix A+ Server Software Installation and Configuration on EISA Bus Computers 6 1.4 Driver Installation on ISA Bus Computers 7 1.4. Hardware Installation on ISA Bus Computers 7 1.4.2 OS/2 Software Installation and Configuration on ISA Bus Computers 7 1.4.3 Citrix A+ Server Software Installation and Configuration on ISA Bus Computers8 1.4.4 1.4.4 CONFIG.SYS Options for ISA Bus Systems 9 Chapter 2 Naming and Configuring Avanstar 100 Ports 11 2.1 Naming Avanstar 100 Family Ports 11 2.1.1 COM Naming Convention 11 2.1.2 A100 Naming Convention 12 2.2 Using A100MODE to Configure a Port 12 2.2.1 Line Settings 14 2.2.2 Flow Settings 14 Chapter 3 OS/2 IOCtl Functions and the Avanstar 100 Family 17 3.1 Overview 17 3.2 Supported OS/2-Defined Functions 17 3.3 Unsupported OS/2-Defined Functions 22 3.4 Avanstar 100 Family-Specific Functions 22 Customer Assistance 28 Technical Support Checklist 29 License Agreement 30 Avanstar 100 Family Device Driver for 32-bit OS/2 (Version 1.11) Software Installation Guide manual part number: 650091-04 O 1995 Star Gate Technologies, Inc. All brand and product names are trademarks or registered trademarks of their respective companies. Chapter 1 Driver Installation 1.1 Introduction The diskettes accompanying this manual contain device drivers and supporting software for the Star Gate AvanstarTM 100 Family adapters. This software is to be used with Citrix A+ server or with IBM OS/2 versions 2.0 and later. There are three device driver files shipped as a part of this package. The A100M.SYS driver is installed on Micro Channel Architecture computers (such as IBM PS/2 Models 80, 90 and 95), and is used with the Avanstar 100m adapters. The A100E.SYS driver is installed on EISA (Extended Industry Standard Architecture) computers and is used with the Avanstar 100e adapters. The A100I.SYS driver is installed on ISA (Industry Standard Architecture) computers and is used with the Avanstar 100i adapters. Each applicable driver file can support a maximum of 64 serial ports if four Avanstar adapters with 16-port external panels are installed. Depending upon the architecture of your computer, go to one of the following sections for driver istallation instructions: Section Architecture 1.2 Micro Channel 1.3 EISA 1.4 ISA 1.2 Driver Installation on Micro Channel Bus Computers 1.2.1 Hardware Installation on Micro Channel Bus Computers Install each Avanstar 100m adapter in the computer following the directions in the adapter's hardware installation guide. The only hardware setup necessary is performed using the system Reference Disk. The driver determines the Avanstar 100m adapter's hardware configuration at system boot time by accessing each adapter's POS register data. The driver requires that each Avanstar 100m adapter have an interrupt enabled. Avanstar 100m adapters may share an interrupt level with each other, but they may not share an interrupt level with devices which are not Avanstar 100m adapters. Alternatively, each Avanstar 100m adapter may be assigned a unique interrupt level. 1.2.2 OS/2 Software Installation and Configuration on Micro Channel Bus Computers Install the driver software by following the steps below. 1. Turn on the computer. 2. Start an OS/2 command line session as follows: a) From the OS/2 Workplace Shell, double click on the "OS/2 System" icon. b) Double click on the "Command Prompts" icon. c) Double click on either the "OS/2 Window" icon or the "OS/2 Full Screen" icon. A command line prompt should now appear. 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:install mc or b:install mc and wait for the driver files to be installed. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should read as follows: rem DEVICE=\A100\A100M.SYS 7. Delete the first four characters of the line ("rem ") so that the driver is loaded the next time the system is restarted. 8. If necessary, edit the line to include the CN parameter which is described in Chapter 2, section 2.1. 9. Save the file and exit the System Editor. 10. Restart the system by holding down the Ctrl and Alt keys and then pressing the Del key. This completes the driver installation process. 1.2.3 Citrix A+ Server Software Installation and Configuration on Micro Channel Computers Install the driver software by following the steps below. 1. Login as the system administrator. 2. Enter system maintenance mode by typing: shutdown /maint 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:citrix mc or b:citrix mc to install the Citrix A+ server driver files. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should read as follows: rem DEVICE=\A100\A100M.SYS 7. Delete the first four characters of the line ("rem") so that the driver is loaded the next time the system is restarted. 8. If necessary, edit the line to include the CN parameter described in Chapter 2, section 2.1. 9. Save the file and exit the System Editor. 10. Restart the system by typing: shutdown /reboot This completes the driver installation process. 1.3 Driver Installation on EISA Bus Computers 1.3.1 Hardware Installation on EISA Bus Computers Install each Avanstar 100e adapter in the computer following the directions in the adapter's hardware installation guide. The only hardware setup necessary is performed using the EISA Configuration Disk. The driver determines the Avanstar 100e adapter's hardware configuration at system boot time by accessing each adapter's EISA configuration data. The driver requires that each Avanstar 100e adapter have an interrupt enabled. Avanstar 100e adapters may share an interrupt level with each other, but they may not share an interrupt level with devices which are not Avanstar 100e adapters. Alternatively, each Avanstar 100e adapter may be assigned a unique interrupt level. 1.3.2 OS/2 Software Installation and Configuration on EISA Bus Computers Install the driver software by following the steps below. 1. Turn on the computer. 2. Start an OS/2 command line session as follows: a) From the OS/2 Workplace Shell, double click on the "OS/2 System" icon. b) Double click on the "Command Prompts" icon. c) Double click on either the "OS/2 Window" icon or the "OS/2 Full Screen" icon. A command line prompt should now appear. 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:install eisa or b:install eisa and wait for the driver files to install. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should read as follows: rem DEVICE=\A100\A100E.SYS 7. Delete the first four characters of the line ("rem") so that the driver is loaded the next time the system is restarted. 8. If necessary, edit the line to include the CN parameter described in Chapter 2, section 2.1. 9. Save the file and exit the System Editor. 10. Restart the system by holding down the Ctrl and Alt keys and then pressing the Del key. This completes the driver installation process. 1.3.3 Citrix A+ Server Software Installation and Configuration on EISA Bus Computers Install the driver software by following the steps below. 1. Login as the system administrator. 2. Enter system maintenance mode by typing: shutdown /maint 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:citrix eisa or b:citrix eisa to install the Citrix A+ server driver files. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should read as follows: rem DEVICE=\A100\A100E.SYS 7. Delete the first four characters of the line ("rem") so that the driver is loaded the next time the system is restarted. 8. If necessary, edit the line to include the CN parameter described in Chapter 2, section 2.1. 9. Save the file and exit the System Editor. 10. Restart the system by typing: shutdown /reboot This completes the driver installation process. 1.4 Driver Installation on ISA Bus Computers 1.4.1 Hardware Installation on ISA Bus Computers Install each Avanstar 100i adapter in the computer following the directions in the adapter's hardware installation guide. Record the I/O address switch settings for each adapter because this information will be needed for completion of the driver intallation. The driver requires that each Avanstar 100i adapter have a unique I/O address assigned to it. 1.4.2 OS/2 Software Installation and Configuration on ISA Bus Computers Install the driver software by following the steps below. 1. Turn on the computer. 2. Start an OS/2 command line session as follows: a) From the OS/2 Workplace Shell, double click on the "OS/2 System" icon. b) Double click on the "Command Prompts" icon. c) Double click on either the "OS/2 Window" icon or the "OS/2 Full Screen" icon. A command line prompt should now appear. 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:install isa or b:install isa and wait for the driver files to install. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should begin as follows: rem DEVICE=\A100\A100I.SYS /IO=200... 7. Delete the first four characters of the line ("rem") so that the driver is loaded the next time the system is restarted. 8. Edit the line so that the parameters specified for each installed Avanstar Family ISA bus adapter match the I/O address switch settings that were noted in section 1.4.1. Note that the line contains entries for four Avanstar Family ISA bus adapters. If you are not installing four adapters, be sure to delete the entries for the extra adapters from the command line. You can also select the port naming convention at this time by following the instructions in Chapter 2, section 2.1. See section 1.4.4 for a discussion of the other possible parameter settings. 9. Save the file and exit the System Editor. 10. Restart the system by holding down the Ctrl and Alt keys and then pressing the Del key. This completes the driver installation process. 1.4.3 Citrix A+ Server Software Installation and Configuration on ISA Bus Computers Install the driver software by following the steps below. 1. Login as the system administrator. 2. Enter system maintenance mode by typing: shutdown /maint 3. Insert the driver diskette into the a or b floppy disk drive on the computer. 4. Type a:citrix isa or b:citrix isa to install the Citrix A+ server driver files. 5. Open the CONFIG.SYS file for editing by typing: e config.sys 6. Move to the end of the file. The last line should read as follows: rem DEVICE=\A100\A100I.SYS /IO=200... 7. Delete the first four characters of the line ("rem") so that the driver is loaded the next time the system is restarted. 8. Edit the line so that the parameters specified for each installed Avanstar Family ISA bus adapter match the I/O address switch settings that were noted in section 1.4.1. Note that the line contains entries for four Avanstar Family ISA bus adapters. If you are not installing four adapters, be sure to delete the entries for the extra adapters from the command line. You can also select the port naming convention at this time by following the instructions in Chapter 2, section 2.1. See section 1.4.4 for a discussion of the other possible parameter settings. 9. Save the file and exit the System Editor. 10. Restart the system by typing: shutdown /reboot This completes the driver installation process. 1.4.4 CONFIG.SYS Options for ISA Bus Systems ISA bus computers have no facility for hardware-assisted configuration, as do Micro Channel computers. For this reason, it is necessary to use option parameters in the CONFIG.SYS file to provide the driver with hardware information required for boot-time configuration. The CONFIG.SYS command line has the form: DEVICE= \A100\A100I.SYS /IO=AAA,DP=bbbbb,RL=cc,CN=e /... Every occurrence of the / (slash) character begins parameters for the next installed adapter. The first set of parameters corresponds to the first adapter, the second set corresponds to the second adapter, and so on. NOTE If no parameters appear on the command line, the following defaults are assumed: Installed adapters: 1 Dual port address: D0000h I/O latch address: 200h IRQ level: 5 A100 naming convention The parameters are described in detail below: DP is used to specify the adapter's five or six-digit dual port RAM physical address. This is a hexadecimal value. If this parameter is not present, the dual port RAM address defaults to D0000h. IO is used to specify the adapter's I/O latch address. The value must match the I/O address switch settings that you were instructed to record in section 1.4.1. This is a hexadecimal value. If this parameter is not present, the I/O latch address defaults to 200h for the first adapter, 300h for the second adapter, 600h for the third adapter and 700h for the fourth adapter. RL is used to specify the interrupt request level (IRQ) to the host computer. Avanstar 100i adapters may share an interrupt level with each other, but they may not share an interrupt level with devices which are not Avanstar 100i adapters. Alternatively, each Avanstar 100i adapter may be assigned a unique interrupt level. If this parameter is not present, the request level defaults to 5. CN (This parameter is described in Chapter 2.) Chapter 2 Naming and Configuring Avanstar 100 Ports 2.1 Naming Avanstar 100 Family Ports After the driver has been successfully installed, unique names are automatically assigned to each Avanstar 100 Family port controlled by the device driver. These port names consist of an adapter designator prefix and a port number. The adapter designator prefix naming convention is controlled with the CN parameter of the CONFIG.SYS file. The CONFIG.SYS command line has the form: DEVICE=\A100\A100X.SYS /CN=a if the COM naming convention is desired, or DEVICE=\A100\A100X.SYS if the standard (A100) naming convention is desired. X has the following letter value, depending on the type of adapter installed: Adapter Letter Value of X Avanstar 100m M Avanstar 100e E Avanstar 100i I This option can be specified in the parameter list for any adapter, but it affects all adapters. 2.1.1 COM Naming Convention The CN parameter is used to select COM as the adapter designator prefix and to specify the starting number for COM naming. For instance, if CN=2, the port names would begin with COM2 (first adapter*, first port) and ascend contiguously for all ports. This parameter can be set to any number from 1 through 5. * For a Micro Channel or an EISA bus system, the first adapter is the adapter installed in the lowest numbered expansion slot, the second adapter is the adapter installed in the second lowest numbered expansion slot, etc. For an ISA bus system, the first adapter corresponds to the first set of parameters in the CONFIG.SYS command line, the second adapter to the second set, etc. The following are examples of port names assigned when the CN parameter is set to 1. Port 2 on adapter 1 would be named COM2 Port 7 on adapter 1 would be named COM7 Port 3 on adapter 2 would be named COM11 (assuming adapter 1 is an 8-port adapter) The COM naming convention is useful when a port needs to be accessed by the Presentation Manager Print Spooler, which can only access ports COM1-4 and LPT1-4. 2.1.2 A100 Naming Convention If the CN parameter is not specified, the A100 naming convention is used. For adapters using the A100 naming convention, the first adapter designator prefix would be A100A, the second, A100B, the third, A100C, and the fourth, A100D. The following are examples of port names assigned when the A100 naming convention is used. Port 3 on adapter 1* would be named A100A3 Port 4 on adapter 3* would be named A100C4 Port 16 on adapter 4* would be named A100D16 2.2 Using A100MODE to Configure a Port The A100MODE utility is used to change line and/or flow control settings for a specific Avanstar 100 port. The utility was designed to be syntactically similar to the OS/2 MODE command. Configuration changes made with A100MODE are valid until the next time the computer is booted or the configuration is changed again with A100MODE. Ports are configurable from an application program using the DOSDevIOCtl API function call to the device driver IOCtl interface. See Chapter 3 for more information. * For a Micro Channel or an EISA bus system, the first adapter is the adapter installed in the lowest numbered expansion slot, the second adapter is the adapter installed in the second lowest numbered expansion slot, etc. For an ISA bus system, the first adapter corresponds to the first set of parameters in the CONFIG.SYS command line, the second adapter to the second set, etc. At system boot time, the port configuration reverts to its default state. Avanstar 100 ports are configured to the following default settings at driver initialization time: 1200 bits per second Even parity 7 data bits 1 stop bit The A100MODE command line has the following form: A100MODE port:baud,parity,databits,stopbits [,flow] where port is the name of the port to be configured. The positional parameters (baud, parity, data bits and stop bits) must be entered in the order specified above. The flow parameters may be entered in any order, separated by commas. To view the current settings for a port, simply omit all parameters from the command line. The following command line: A100MODE A100B5 displays the current line and flow settings for port A100B5. To configure line settings, place the desired values in the proper parameter positions. This command line: A100MODE A100A1:9600,N,8,1 sets line settings for port A100A1 to 9600 bits per second, no parity, 8 data bits, 1 stop bit. If any parameter is omitted, its current value is retained. For instance, in the following command line: A100MODE A100A1:,,8 the data bits configuration for port A100A1 is set to 8, but all other line and flow settings remain the same. Flow parameters consist of a tag followed by an "=" and ended with a parameter value. In the command line: A100MODE A100A2:,,,,XON=ON,DTR=OFF Automatic Transmit Flow Control is set to ON, while DTR Enable mode is set to OFF for port A100A2. Note that the order in which flow parameters are specified on the command line is not significant. The command line below functions identically to the command line shown previously: A100MODE A100A2:,,,,DTR=OFF,XON=ON Sections 2.2.1 and 2.2.2 describe possible line and flow settings that can be established with A100MODE. 2.2.1 Line Settings baud Valid baud rate settings are dependent upon the particular type of Avanstar 100 Family adapter that is installed. Most common baud rate settings are supported. See the Avanstar Family Technical Reference Manual for adapter-specific information of this type. The initial baud rate is 1200. parity Valid parity settings are N (none), O (odd), E (even), M (mark) or S (space). The initial parity setting is E (even parity). databits Valid data bit settings are 5, 6, 7 or 8. The initial number of data bits is 7. stopbits Valid number of stop bits is 1 or 2. The initial number of stop bits is 1. 2.2.2 Flow Settings DTR This specifies the DTR enable state. Valid values are ON and OFF. When DTR=ON, the DTR output will be asserted as long as the port is open. When DTR=OFF, the DTR output will always be in the negated state. The initial setting is OFF. OCTS This specifies output handshaking using CTS state. Valid values are ON and OFF. When OCTS=ON, the port will not transmit data unless the CTS input is asserted. When OCTS=OFF, the state of the CTS line has no effect on data transmission. The initial setting is OFF. RTS This specifies RTS enable state. Valid values are ON, OFF, TOG, and HS. When RTS=ON, the RTS output will be asserted as long as the port remains open. When RTS=OFF, the RTS output will always be in the negated state. When RTS=HS, the RTS output will be asserted when the port is ready to receive data and negated when the port is not ready to receive data for any reason. The initial setting is OFF. When RTS=TOG, the RTS output will be asserted as long as there is data in the transmit buffer. IXON This specifies transmit xon/xoff handshaking. Valid values are ON and OFF. The initial value is OFF. When IXON=ON, the driver will transmit data until the xoff character is received. Transmission continues upon reception of the xon character. When IXON=OFF, the driver does not respond to xon/xoff characters when received. IXOFF This specifies receive xon/xoff handshaking. Valid values are ON and OFF. The initial value is OFF. When IXOFF=ON, the driver will transmit an xoff character when the receive buffer is full. When more data can be received, the driver will transmit an xon. RXTO This specifies the receive timeout state. When RXTO=ON, the driver uses the standard MS-DOS timeout of approximately 1 second and then returns if the request is not complete. When RXTO=NW (NO-WAIT) the driver returns immediately whether the request is completed or not. When RXTO=INF (INFINITE), the driver will never return until the request has been completed. The initial setting is ON. IB This specifies the input buffer size. Valid values range from a minimum of 2 to a maximum that is the sum of the current size of the input buffer and the size of the unused buffer space. Before increasing a port's input buffer size, it may be necessary to first reduce the size of that port's output buffer or the size of another port's input or output buffer. OB This specifies the output buffer size. Valid values range from a minimum of 2 to a maximum that is the sum of the current size of the output buffer and the size of the unused buffer space. Before increasing a port's output buffer size, it may be necessary to first reduce the size of that port's input buffer or the size of another port's input or output buffer. (For systems with configurable external panels only) INT This specifies the communication interface type. When INT=232, the configurable external panel interface will be set to EIA-232 mode. When INT=422, the interface will be set to EIA-422 mode. The initial state is EIA- 232. Chapter 3 OS/2 IOCtl Functions and the Avanstar 100 Family 3.1 Overview The Avanstar 100 Family OS/2 device driver supports a subset of the OS/2 Category 1 ASYNC IOCtl commands. These commands are described in detail in the IBM publication OS/2 2.0 Technical Library Physical Device Driver Reference which is contained in the OS/2 Technical Library product. This is a recommended (if not required) source of information for developing applications that use OS/2 device drivers. In the following text, each supported ASYNC IOCtl function is listed and information is provided to help clarify any differences between this implementation and the OS/2 Base ASYNC subsystem (COM.SYS) implementation of the IOCtl functions. In addition, there are detailed descriptions of the IOCtl functions specifically for the Avanstar 100 Family that were added to support functionality not provided by the base IOCtl calls. 3.2 Supported OS/2-Defined Functions 41H - SET BAUD RATE The following bit rate values are supported by this function: 110 4,800 150 7,200 300 9,600 600 19,200 1,200 38,400 1,800 57,600 2,000 2,400 The default bit rate is 1200 bits per second. The driver will report an Invalid Parameter error if the selected bit rate cannot be programmed for any reason. 42H - SET LINE CHARACTERISTICS Default Line Characteristics are: 7 data bits, Even parity, 1 stop bit. This functions as described in OS/2 documentation. 43H - EXTENDED SET BIT RATE Fractions cannot be programmed; otherwise, this functions as described in OS/2 documentation. 45H - SET BREAK OFF Functions as described in OS/2 documentation. 46H - SET MODEM CONTROL SIGNALS Functions as described in OS/2 documentation. 47H - BEHAVE AS IF XOFF RECEIVED (STOP TRANSMITTING) A function 48h (Behave as if XON Received) request is required for transmission to be resumed. 48H - BEHAVE AS IF XON RECEIVED (START TRANSMITTING) This function will resume transmission on a port that has previously received a function 47h (Behave as if XOFF Received) request. It will also resume transmission on a port with Automatic Transmit Flow Control en- abled, if that port's transmission had been stopped due to reception of an XOFF. 4BH - SET BREAK ON Functions as described in OS/2 documentation. 53H - SET DEVICE CONTROL BLOCK (DCB) The following parameter packet values can be programmed: Write Timeout value: In the range 0 - FFFFh. Read Timeout value: In the range 0 - FFFFh. FLAGS1 The following modes are supported: DTR Control Mode - Disable DTR Control Mode - Enable Enable output handshaking using CTS FLAGS 2 The following modes are supported: Enable automatic transmit flow control Enable automatic receive flow control RTS Control Mode - Disable RTS Control Mode - Enable RTS Control Mode - Input Handshaking FLAGS 3 The following modes are supported: Enable write infinite timeout processing Read Timeout Processing - Normal Read Timeout Processing - Wait for something Read Timeout Processing - No wait XON Character Any byte in the range 00h to FFh. If 00h is specified, the standard XON character (11h) will be programmed. XOFF CHARACTER Any byte in the range 00h to FFh. If 00h is specified, the standard XOFF character (13h) will be programmed. ERROR REPLACEMENT CHARACTER Any byte in the range 00h to FFh. Any other parameter packet values will cause the driver to report an Invalid Parameter error condition. 61H - GET BAUD RATE Functions as described in the OS/2 documentation. 62H - GET LINE CHARACTERISTICS Functions as described in OS/2 documentation. 63H - EXTENDED QUERY BIT RATE Functions as described in OS/2 documentation. 64H - GET COM STATUS The following status bits are returned by the driver: Bit 0 - TX waiting for CTS to be turned ON Bit 3 - TX waiting because XOFF received Bit 5 - TX waiting because BREAK being transmitted All other bits are returned as 0. 65H - GET TRANSMIT DATA STATUS The following status bits are returned by the driver: Bit 0 - WRITE request packets in progress or queued Bit 1 - Data in the device driver transmit queue Bit 2 - The transmit hardware is currently transmitting data All other bits are returned as 0. 66H - GET MODEM CONTROL OUTPUT SIGNALS Functions as described in OS/2 documentation. 67H - GET MODEM CONTROL INPUT SIGNALS Functions as described in OS/2 documentation except on Avanstar 100 Family products that do not support certain modem input signals. Unsupported signals are returned as 0 in these cases. See the Avanstar Family Technical Reference Manual or the hardware installation guide for the specific Avanstar 100 Family product you are using. 68H - GET NUMBER OF CHARACTERS IN THE RECEIVE QUEUE Functions as described in OS/2 documentation. 69H - GET NUMBER OF CHARACTERS IN THE TRANSMIT QUEUE Functions as described in OS/2 documentation. 6DH - GET COM ERROR INFORMATION Functions as described in OS/2 documentation. However, bit 1 (Receive Timeout Interrupt) is not supported because the driver does not support Extended Hardware Buffering. This behavior conforms with the IBM specification. Bit 1 will always be reported as 0. 72H - GET COM EVENT INFORMATION Functions as described in OS/2 documentation. 73H - GET DEVICE CONTROL BLOCK (DCB) INFORMATION Values are returned as programmed with exceptions below: Flags 1 Bits 2,4,5,6,7 - Always returned as 0. Flags 2 Bits 2, 3 - Always returned as 0 Bit 4 - Always returned as 0. Bit 5 - Always returned as 1. FLAGS 3 Bits 3-7 - Always returned as 0. BREAK REPLACEMENT CHARACTER Always returned as 0. ERROR REPLACEMENT CHARACTER Always returned as 0 3.3 Unsupported OS/2-Defined Functions 14H - Reserved 34H - Reserved 44H - Transmit Byte Immediate 49H - Reserved 54H - Set Enhanced Mode Parameters 74H - Query Enhanced Mode Parameters An Unknown Command error is returned if an application attempts to use one of these functions. 3.4 Avanstar 100 Family-Specific Functions CATEGORY 80H, FUNCTION 40H Set Extended Device Control Block PARAMETER PACKET FORMAT FIELD LENGTH Flags1 WORD Flags2 WORD EOBChar BYTE Flags1 Has the following bits: Bit 0: Reserved Bit 1: Reserved Bit 2: Reserved Flags2 Has the following bit: Bit 0: Enable Read Until End-of-Block mode. In this mode, the driver will return when the byte specified in EOBChar is received. The EOBChar is returned in the data buffer. All programmed Read functions (timeout value, etc.) are still in effect in this mode. EOBChar Has the following value and meaning: Any value between 00h and FFh, inclusive. In this mode, the driver will return when the byte specified in EOBChar is received. The EOBChar is returned in the data buffer. All programmed Read functions (timeout value, etc.) are still in effect in this mode. DATA PACKET FORMAT None. Packet pointer must be NULL. RETURNS Driver returns General Failure error if Data Packet pointer is not NULL. Driver returns Invalid Parameter error if Parameter Packet values are invalid. The application should call function 60H (Get Extended Device Control Block) before calling this function, just like SetDCB/GetDCB. CATEGORY 80H, FUNCTION 41H Set Interface type PARAMETER PACKET FORMAT FIELD LENGTH IntType WORD IntType can have one of the following values: 1 to select EIA-232 mode 2 to select EIA-422 mode DATA PACKET FORMAT None. Packet pointer must be NULL. RETURNS The driver returns a General Failure error if the Data Packet pointer is not NULL. The driver returns an Invalid Parameter error if this is not a configurable external panel port. The application should call function 61H (Get Panel Interface Info) to verify that the port is connected to a configurable EIA-232/422 panel. CATEGORY 80H, FUNCTION 42H Set Modem Panel Port to Default State PARAMETER PACKET FORMAT None. Packet pointer must be NULL. DATA PACKET FORMAT None. Packet pointer must be NULL. RETURNS The driver returns a General Failure error if either the Parameter Packet pointer or the Data Packet pointer is not NULL. CATEGORY 80H, FUNCTION 43H Set Buffer Sizes PARAMETER PACKET FORMAT FIELD LENGTH InBufSize WORD OutBufSize WORD Reserved WORD InBufSize is set to the size (in bytes) desired for the port's input buffer. This value must be greater than or equal to 2. OutBufSize is set to the size (in bytes) desired for the port's output buffer. This value must be greater than or equal to 2. The value contained in the Reserved field is not used by the driver. DATA PACKET FORMAT None. Packet pointer must be NULL. RETURNS The driver returns a General Failure error if the Data Packet pointer is not NULL. The driver returns an Invalid Parameter error if buffer sizes cannot be set. It may be necessary to reduce the size of this or another port's input or output buffer when using this function to increase the size of a buffer. The application should call function 63H (Get Buffer Sizes) to determine how much buffer space is available for any buffer size increase. CATEGORY 80H, FUNCTION 60H Get Extended Device Control Block PARAMETER PACKET FORMAT None. Packet Pointer must be NULL. DATA PACKET FORMAT FIELD LENGTH Flags1 WORD Flags2 WORD EOBChar BYTE Flags1 Has the following bits: Bit 0: Reserved (Always 0) Bit 1: Reserved (Always 0) Bit 2: Reserved (Always 0) Flags2 Has the following bits: Bit 0: Read Until End-of-Block mode enabled if set EOBChar Has the following value and meaning: The currently programmed End-Of- Block character. Valid only if Flags2, Bit 0 is set. RETURNS The driver returns a General Failure error if the Parameter Packet pointer is not NULL. CATEGORY 80H, FUNCTION 61H Get Panel Interface Info PARAMETER PACKET FORMAT None. Packet pointer must be NULL. DATA PACKET FORMAT FIELD LENGTH PanelChar WORD IntStat WORD PanelChar contains the following bit values: Bit 0: set if panel has EIA-232 capability Bit 1: set if panel has EIA-422 capability Bit 2: set if the interface connects to on-board modems Bit 7: set if RJ connectors are used instead of a panel Bit 8: set if the interface supports RI input signal Bit 9: set if the interface supports DCD input signal Bit 10: set if the interface supports DTR output signal Bit 11: set if the interface supports DSR input signal Bit 12: set if the interface supports CTS input signal Bit 13: set if the interface supports RTS output signal Bits 3,4,5,6,14,15 are reserved IntStat contains the following bit values: Bit 0: set if the panel is in EIA-232 mode Bit 1: set if the panel is in EIA-422 mode (configurable panel only) Bits 2-15 are reserved RETURNS The driver returns a General Failure error if the Parameter Packet pointer is not NULL. CATEGORY 80H, FUNCTION 63H Get Buffer Sizes PARAMETER PACKET FORMAT None. Packet pointer must be NULL. DATA PACKET FORMAT FIELD LENGTH InBufSize WORD OutBufSize WORD Unused WORD InBufSize contains the size of the input buffer in bytes. OutBufSize contains the size of the output buffer in bytes. Unused contains the number of bytes of currently unused space that can be allocated to buffers. RETURNS The driver returns a General Failure error if the Parameter Packet pointer is not NULL. 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 manual, please make photo-copies of the affected pages, indicate your comments on the copies, and mail or FAX the copies to the address or FAX number below. FAX (216) 349-1978 Star Gate Technologies, Inc. Attn: Technical Documentation Dept. 29300 Aurora Road Solon, Ohio 44139 Technical Support Checklist If you are having problems with installation, please have the following information at hand when calling for Technical Support: 1. From your Avanstar 100 Family adapter:  Adapter type-Avanstar 100e, Avanstar 100i or Avanstar 100m? 2. From the Avanstar 100 Family device driver diskette label:  Type and version of operating system and version of driver. 3. From your Avanstar 100 Family software driver installation: Call up the host PC's CONFIG.SYS file and record the DEVICES= line for each Avanstar 100 Family adapter. This lists software parameters for:  Memory address  Interrupt level  Number of ports 4. From your sales or purchase order form:  Number of ports  Size of dual port memory or catalog number 5. From your host PC and its installed hardware and software: Type of system used  CPU and bus speed of system  Are you using memory caching?  What type of graphics card?  What is your operating system and its version?  What other devices do you have in your system? Examples: Tape backup, LAN card . . .  Type and version of ROM BIOS used?  Do you have shadow RAM enabled or disabled? For each of these other devices installed, what is the:  I/O address range  Interrupt level, if any  Memory address range LICENSE AGREEMENT LICENSE: You have the nonexclusive right to use the Avanstar 100 Family OS/2 Device Driver on one host computer, plus the terminals connected to it, at a time. You may transfer the device driver from one computer system to another, provided the device driver is used only on one computer system at a time. COPYRIGHT: The Avanstar100 Family OS/2 Device Driver 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 device driver 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 device driver 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 claim. 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.