Ö· ·Ö Ö· Ö· Ö· ÖÒ· Ö· Ö· Ƕ ºº Ƕ ºº Ó· º Ƕ ǽ ½Ó Ó/ ½Ó ½Ó Ó½ Ð ½Ó ½Ó Ò· ÖÄ ·Ö ÖÄ Ò Ö· Ö· ÖÄ Ö· Ö· ºº Ç ºº Ç º ºº ǽ Ç Ç½ Ó· н ÓÄ Ó/ ÓÄ ÓÄ Ó½ ½ ÓÄ ½Ó Ó½ ÖÒ· Ö· Ö· ·Ö Ö· Ò ºÐº Ƕ ºº ºº Ƕ º ½ Ð ½Ó ½Ó Ó½ ½Ó ÓÄ CONTENTS Introduction 1 1.2 Diskette Contents 1 1.3 The A100LOAD Utility 2 1.3.1 A100LOAD for EISA Bus Adapters 1.3.2 A100LOAD for Micro Channel Bus Adapters 2 1.3.3 A100LOAD for ISA Bus Adapters 3 1.4 The A100CFG Utility 4 1.4.1 A100CFG for EISA Bus Adapters 4 1.4.2 A100CFG for Micro Channel Bus Adapters 5 1.4.3 A100CFG for ISA Bus Adapters 5 1.4.4 Parameter Tokens 6 1.5 Sample Programs 8 1.6 Source Code 8 Customer Assistance 9 License Agreement 10 Avanstar Family Developer's Disk Software Guide manual part number: 650131-02 c 1994 by Star Gate Technologies, Inc. Printed in U.S. A. All brand and product names are trademarks or registered trademarks of their respective companies. 1.1 Introduction The Avanstar Family Developer's Disk is intended to provide the developer with the necessary tools for successful driver development in the DOS environment. This package is not intended for development of control program software that will reside on the Avanstar family hardware itself. Contact Star Gate for assistance in developing board-resident software. 1.2 Diskette Contents The Avanstar Family Developer's Disk contains the following items:  Control programs for all Avanstar family hardware  A control program download utility (A100LOAD)  A port configuration utility (A100CFG)  Sample programs (with source code)  Source code for the utility programs All programs on the diskette were created using Microsoft C version 6.00A. Each program has its own MAKEFILE that is used to build the executable. To build a program, just type NMAKE at the DOS prompt. 1.3 The A100LOAD Utility The A100LOAD program is used to download control program software to any Avanstar family adapter. A100LOAD is invoked from the DOS command prompt with command line arguments dependent upon the adapter that is being downloaded to. 1.3.1 A100LOAD for EISA Bus Adapters The command line to download to an EISA bus adapter is as follows: a100load e[off] [slot] [...] where:  slot is the EISA slot number where the EISA board to be downloaded is located. If slot is not specified, the proper control program will be downloaded to every Avanstar family EISA bus adapter in the system. There can be more than one slot number on the command line. If e is specified, the dual port(s) remain enabled after the download operation has completed. Specify eoff to disable the dual port(s) after the download. 1.3.2 A100LOAD for Micro ChannelTM Bus Adapters The command line to download to a Micro Channel bus adapter is as follows: a100load m [slot] [...] where slot is the Micro Channel slot number where the board to be downloaded is located. If slot is not specified, the proper control program will be downloaded to every Avanstar family MCA adapter contained in the system. There can be more than one slot number on the command line. 1.3.3 A100LOAD for ISA Bus Adapters The command line to download to an ISA bus adapter is as follows: a100load i[off] [iobase [/Ddpaddr] [/Iirq]] [...]  If i is specified, the dual port(s) remain enabled after the download operation has completed. Specify ioff to disable the dual port(s) after the download.  iobase is the hexadecimal base I/O address that is assigned to the adapter to be downloaded. The valid base I/O addresses are 200, 208, 300, 308, 600, 608, 700,and 708. 1. Multiple sets of the iobase with optional dpaddr and irq parameters are allowed. For example, a100load i 200 /DD0000 208 /I5 300 is allowed. 2. If iobase is not specified, the proper control program will be downloaded to every Avanstar ISA bus adapter contained in the system.  dpaddr is the address of local memory that is mapped to the dual port memory of the adapter to be downloaded. dpaddr may be at 16K byte boundaries like D0000, D4000, D8000,DC000, etc. The /D preceding the address value separates it from the other parameters. 1. You can not use the dpaddr parameter unless you first specify an iobase. For example, a100load i /DD0000 is not valid. 2. If no dpaddr is specified, the value currently programmed in the adapter's Control Register 2 will be used if it is not zero.  irq is the IRQ number through which the adapter may interrupt the host. The valid IRQ numbers are 3, 4, 5, 9, 10, 11, 12 and 15. The /I preceding the IRQ number separates it from the other parameters. 1. You can not use the irq parameter unless you first specify an iobase. For example, a100load i /I5 is not valid. 2. If no irq is specified, the value currently programmed in the adapter's Control Register 1 will be used if it is not zero. 1.4 The A100CFG Utility The A100CFG program is used to read or set operational parameters for any port on an Avanstar family adapter. A100CFG is invoked from the DOS command prompt with command line arguments dependent upon the adapter that is being configured. 1.4.1 A100CFG for EISA Bus Adapters The command line for an EISA bus adapter is as follows: a100cfg e slot port [param=x] [...] where:  slot is the EISA slot where the board is located.  port is the number of the port to configure. The first port is number 1.  param is a token representing the parameter to be set. If no parameter token is specified, current port settings are displayed. There can be more than one parameter token specified on the command line. See section 1.4.4 for detailed descriptions of the parameter tokens that can be setAfter the A100CFG program reads or configures port parameters, the dual port RAM is returned to the state it was in (enabled or disabled) before the program was executed. 1.4.2 A100CFG for Micro Channel Bus Adapters The command line for Micro Channel adapters is as follows: a100cfg m slot port [param=x] [...] where:  slot is the Micro Channel slot where the board is located.  port is the number of the port to configure. The first port is number 1.  param is a token representing the parameter to be set. If no parameter token is specified, current port settings are displayed. There can be more than one parameter token specified on the command line. See section 1.4.4 for detailed descriptions of the parameter tokens that can be set. After the A100CFG program reads or configures port parameters, the dual port RAM is returned to the state it was in (enabled or disabled) before the program was executed. 1.4.3 A100CFG for ISA Bus Adapters The command line for ISA bus adapters is as follows: a100cfg i iobase port [param=x] [...] where:  iobase is the hexadecimal base I/O address that is assigned to the adapter to be downloaded. The valid base I/O addresses are 200, 208, 300, 308, 600, 608, 700, and 708. There can be only one iobase on the command line.  port is the number of the port to configure. The first port is number 1.  param is a token representing the parameter to be set. If no parameter token is specified, current port settings are displayed. There can be more than one parameter token specified on the command line. See section 1.4.4 for detailed descriptions of the parameter tokens that can be set. After the A100CFG program reads or configures port parameters, the dual port RAM is returned to the state it was in (enabled or disabled) before the program was executed. 1.4.4 Parameter Tokens Supported parameter tokens for the A100CFG program are: B (baud rate) D (data bits) F (flow control) I (input buffer size) O (output buffer size) P (parity) S (stop bits) The A100CFG program parameter tokens are not case sensitive. Baud Rates The following baud rates may be set with the B token: 50 600 7200 75 1050 9600 110 1200 19200 134.5 1800 38400 150 2000 57600 200 2400 76800 300 4800 115200 For example, to set the baud rate to 9600 bits per second, the parameter b=9600 would be included on the command line. To set the baud rate to 134.5, use b=134 on the command line. See the Avanstar Family Technical Reference Manual to determine possible baud rates for the particular Avanstar family adapter in your system. Data Bits With the D token, data bits can be set to 5, 6, 7, or 8. For example, to set data bits to 5, the parameter d=5 would be included on the command line. Flow Control With the F token, flow control can be set to X (xon/xoff), C (cts/rts), or N (none). It is valid to set X and C simultaneously (f=XC). Input Buffer Size With the I token, input buffer size can be set to anything from 2 to the maximum buffer size. For example, to set input buffer size to 2, the parameter i=2 would be included on the command line. See the Avanstar Family Technical Reference Manual for details on buffer sizes for specific adapters. Output Buffer Size With the O token, output buffer size can be set to anything from 2 to the maximum buffer size. For example, to set output buffer size to 2, the parameter o=2 would be included on the command line. See the Avanstar Family Technical Reference Manual for details on buffer sizes for specific adapters. Parity With the P token, parity can be set to N (none), O (odd), E (even), M (mark), or S (space). For example, to set parity to even, the parameter p=E would be included on the command line. Stop Bits With the S token, stop bits can be set to 1 or 2. For example, to set stop bits to 2, the parameter s=2 would be included on the command line. Example As an example, the command line: a100cfg m 3 5 b=1200 f=xc configures port 5 of an Avanstar MCA adapter in slot 3 to 1200 bits per second and flow control of CTS/RTS and XON/XOFF. 1.5 Sample Programs The directory \SOURCE\SAMPLES contains sample programs with source code for examples of control program functionality. 1.6 Source Code All source code is contained under the directory \SOURCE. The directory \SOURCE\INCLUDE contains the A100.H include file. This file contains definitions of all control program structures. It also contains definitions of all configuration, control, and status values for the control programs. Using A100.H in your development will save much of the effort of creating all of this information yourself. Using A100.H would also give you and our support staff a common basis for communication if you would need assistance during your product development. Customer Assistance For Customer Service or Sales, call 1-800-STAR GATE (1-800-782-7428) from 8 a.m. to 6 p.m., Eastern Standard Time. For your convenience, we have extended Tech Support hours from 7:30 a.m. to 7 p.m., E.S.T. If you still need technical assistance after reading this manual, please call and ask for Technical Support. Our specialists will try to provide solutions over the phone. If you face a shipment or order processing difficulty, please ask for Customer Service. An experienced Customer Service representative will be pleased to assist you. 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 LICENSE AGREEMENT License: You have the nonexclusive right to use the supplied software on one network, plus the computers and terminals connected to it, at a time. You may transfer the software from one network to another, provided the software is used only on one network system at a time. Copyright: The Star Gate Avanstar Family Developer's Disk software 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. This limited warranty gives you specific legal rights. 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 software 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.