Ö· Ö· Ò Ç¶ º º ½Ó Ó½ ÓÄ Developers Disk CONTENTS 1.1 Introduction 1 1.2 Diskette Contents 1 1.3 The ACLLOAD Utility 1 1.3.1 ACLLOAD for ISA Boards 1 1.3.2 ACLLOAD for Micro Channel Boards 2 1.4 The ACLCFG Utility 3 1.4.1 ACLCFG for ISA Boards 3 1.4.2 ACLCFG for Micro Channel Boards 4 1.4.3 Parameter Tokens 4 1.5 Sample Programs 6 1.6 Source Code 6 Customer Assistance 7 License Agreement 8 ACL Family Developer's Disk Software Guide manual part number: 650116-03 c 1995 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 ACL 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 ACL Family hardware itself. Contact Star Gate for assistance in developing board-resident software. 1.2 Diskette Contents The ACL Family Developer's Disk contains the following items:  Control programs for all ACL Family hardware  A control program download utility (ACLLOAD)  A port configuration utility (ACLCFG)  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 ACLLOAD Utility The ACLLOAD program is used to download control program software to any ACL Family board. ACLLOAD is invoked from the DOS command prompt with command line arguments dependent upon the board that is being downloaded to. 1.3.1 ACLLOAD for ISA Boards The command line to download to an ISA board (ACL, ACL II, ACL IIR, ACL 16, ACL II+, ACL IIR+, and ACL 16+) is as follows: aclload isa[off] ioaddr dpaddr [ioaddr dpaddr] [...] where:  ioaddr is the hex I/O port address where the board resides  dpaddr is the hex physical address of the board's dual port RAM At least one ioaddr and dpaddr must be specified. If isa is specified, the dual port(s) remain enabled after the download operation has completed. Specify isaoff to disable the dual port(s) after the download. 1.3.2 ACLLOAD for Micro Channel Boards The command line to download to a Micro ChannelTM board (ACL MC or ACL MC+) is as follows: aclload mc [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 ACL MC or ACL MC+ in the system. There can be more than one slot number on the command line. 1.4 The ACLCFG Utility The ACLCFG program is used to read or set operational parameters for any port on an ACL Family board. ACLCFG is invoked from the DOS command prompt with command line arguments dependent upon the board that is being configured. 1.4.1 ACLCFG for ISA Boards The command line for ISA boards is as follows: aclcfg isa ioaddr dpaddr port [param=x] [...] where:  ioaddr is the hex I/O port address where the board resides  dpaddr is the hex physical address of the board's dual port RAM  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 commmand line. See section 1.4.3 for detailed descriptions of the parameter tokens that can be set. After the ACLCFG 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 ACLCFG for Micro Channel Boards The command line for Micro Channel boards is as follows: aclcfg mc 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.3 for detailed descriptions of the parameter tokens that can be set. 1.4.3 Parameter Tokens Supported parameter tokens for the ACLCFG program are: B (baud rate) D (data bits) F (flow control) I (input buffer size) O (output buffer size) P (parity) S (stop bits) T (RS232 type - ACL II and ACL II+only) The ACLCFG 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 bits per second, the parameter b=134 would be included on the command line. See the ACL Family Technical Reference Manual to determine possible baud rates for the particular ACL family board 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 ACL Family Technical Reference Manual for details on buffer sizes for specific boards. 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 ACL Family Technical Reference Manual for details on buffer sizes for specific boards. 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 setstop bits to 2, the parameter s=2 would be included on the command line. RS232 Type With the T token, RS232 type can be set to T (DTE) or C (DCE). For example, to set the RS232 type to DTE, the parameter t=T would be included on the command line. This parameter is only valid for ACL II and ACL II+ boards. Example As an example, the command line: aclcfg mc d0000 5 b=1200 f=xc configures port 5 of an ACL MC board with dual port RAM located at D0000h 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 ACL.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 ACL.H in your development will save much of the effort of creating all of this information yourself. Using ACL.H would also give you and our support staff a common basis for communication if you would need assistance during your product development. stop bits to 2, the parameter s=2 would be included on the command line. RS232 Type With the T token, RS232 type can be set to T (DTE) or C (DCE). For example, to set the RS232 type to DTE, the parameter t=T would be included on the command line. This parameter is only valid for ACL II and ACL II+ boards. Example As an example, the command line: aclcfg mc d0000 5 b=1200 f=xc configures port 5 of an ACL MC board with dual port RAM located at D0000h 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 ACL.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 ACL.H in your development will save much of the effort of creating all of this information yourself. Using ACL.H would also give you and our support staff a common basis for communication if you would need assistance during your product development. 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 ACL 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.