Comtrol API (6508) for the MS-DOS Manuel d'utilisateur

1RocketPort/ISAAPI (6508) for the MS-DOS Operating SystemFirst Edition, December 1993Revised April 1994Copyright © 1993, 1994, 1995, 1996. Comtrol Cor

10 Developing Applications* These are not part of the API, but are part of the application.2.3. Writing the Configuration FileThe configuration file i

Developing Applications 11Developing Applications• 900 - 943• D00 - D43This is normally of no concern because ISA peripherals often use only 10 bits o

12 Developing ApplicationsDeveloping Applications /* Initialize API */ aaInstallCtrlCHandler(); if((InitReturn = aaInit()) != NO_ERR) Step 4

Developing Applications 13Developing Applications2.8.1. Understanding Device NumbersEach serial device is identified by a device number. Most API func

14 Developing ApplicationsDeveloping Applications2.8.2.3. Parity ParameterThe parity parameter is used by aaOpen() and aaReconfigure() to set the type

Developing Applications 15Developing Applications2.8.2.7. Detection Enable ParameterThe detection enable parameter is used by aaOpen() and aaReconfigu

16 Developing ApplicationsDeveloping Applicationsyou can give the system software the name of an application program function that executes when a par

Developing Applications 17Developing Applicationsduring event functions and any functions called by event functions. Stack checking can be turned off

18 Troubleshooting3.1. Resolving Installation ProblemsIf installation fails or you are trying to resolve a problem, you should try the following befor

Troubleshooting 19Troubleshooting3.2. Placing a Support CallBefore you place a technical support call to Comtrol, please make sure that you have the f

2ScopeThis guide describes the following information about the DOS application program interface (API) for RocketPort controllers:• Installing the sof

20 TroubleshootingTroubleshootingContact Comtrol using one of the following methods.Corporate Headquarters:• email: [email protected]•FAX: (612) 631

21 TroubleshootingThis appendix contains reference pages for the RocketPort API. TableA-4 lists all of the API functions.Table A-4. API Function Ref

22 API FunctionsaaChangeModemStateaaChangeModemStateChanges the state of modem output lines.aaChangeModemState(Dev,RTSState,DTRState)int Dev Device nu

23 API FunctionsaaEnPeriodicEventaaEnPeriodicEventEnables or disables dispatching of the periodic event function.aaEnPeriodicEvent(State)int StateTRUE

24 API FunctionsaaFlushaaFlushFlushes the transmit or receive buffer, or both for a device.aaFlush(Dev,FlushFlags)int Dev Device numberunsigned char F

25 API FunctionsaaGetModemStatusaaGetModemStatusGets a device’s modem status.aaGetModemStatus(Dev)int Dev: Device numberunsigned char State of the mo

26 API FunctionsaaGetRxStatusaaGetRxStatusGets the status of the device’s receive buffer.aaGetRxStatus(Dev)int Dev Device numberint:NO_ERR if there ar

27 API FunctionsaaInitaaInitExecutes controller and API initialization.aaInit()unsigned intNO_ERR if no initialization errorsERR_ALLOCDEV if it can no

28 API FunctionsaaInstallMdmChgEventaaInstallMdmChgEventInstalls an application level event function to handle modem change events.aaInstallMdmChgEven

29 API FunctionsaaInstallRxEventaaInstallRxEventInstalls an application level event function to handle receive data available events.aaInstallRxEvent(

3Before You BeginScope ...2Purpose...

30 API FunctionsaaReadCOM_MDM_DTR, or both. If the flag is not set the line is OFF. If hardware flow control is in use for a modem line, it’s flag has

31 API FunctionsaaReadWithStatusaaReadWithStatusReads serial data and status from a device.aaReadWithStatus(Dev,Cnt,Buf)int Dev Device numberint Cnt M

32 API FunctionsaaSendBreakERR_PAR if invalid parity bits flagERR_DATAB if invalid data bits flagERR_STOPB if invalid stop bits flagERR_FLOW if invali

33 API FunctionsaaSetCloseDelayaaSetCloseDelaySets the maximum time aaClose() waits for a device’s transmit buffer to drain before flushing the transm

34 API FunctionsEvModemChangeEvModemChangeApplication modem input change event functionEvModemChange(Dev,unsigned char MdmChange,unsigned char MdmStat

35 API FunctionsEvPeriodicEvPeriodicApplication periodic event functionEvPeriodic()voidThis function is not part of the API, it must be written by the

36 TroubleshootingThis appendix contains a copy of the \ROCKET\SAMPLE\DBUF.C file for your convenience.File: DBUF.C Project: RocketPort DOS APIPurpose

Troubleshooting 37Troubleshooting aaEnPeriodicEvent(TRUE); /* Test background transmit and receive on device 0. A loopback plug can be insta

38 TroubleshootingTroubleshooting /* Update Tx queue In index */ q[Dev].TxIn = In; asm sti; /* enable interrupts */ return(NumOpen);}/********

Troubleshooting 39Troubleshooting /* Read more data if any room left at front of buffer and if device wasn't already emptied */ if((i !=

4FlowchartsFlowchart 1-1. Hardware and Software Installation Overview ...5Flowchart 2-1. How t

5 Installating RocketPort/ISA SystemsThis section contains a product overview and discusses installing the API for your system. The DOS API and Interr

6 Installating RocketPort/ISA SystemsInstallating RocketPort/ISA SystemsNote: Press <F1> on any item for button-sensitive Help.5. Select the I/O

Installating RocketPort/ISA Systems 7Installating RocketPort/ISA Systems1.4. Installing the ControllerTo prepare your controller for installation, you

8 Installating RocketPort/ISA SystemsInstallating RocketPort/ISA Systemsfrom 1 to 16.c. If applicable, set each port to the appropriate communications

9 Developing ApplicationsThis section describes the following topics:•API features and functions• Writing the configuration file• Using the API (flowc