Quatech MPAP-100 User manual

Syncdrive Plus
Communications Software
User’s Manual
QUATECH, INC.
662 Wolf Ledges Parkway
Akron, Ohio 44311
Toll free: 1-800-553-1170
TEL: [phone]
FAX: [phone]
http://www.quatech.com
Syncdrive Plus
User’s Manual P/N: 940-0184-100
CONNECT WITH RELIABILITY

Copyright Copyright © 1984 - 2003, Quatech, Inc. All rights are reserved. The
information contained in this document cannot be reproduced in any form
without the written consent of Quatech, Inc. Any software programs that
might accompany this document can be used only in accordance with any
license agreement(s) between the purchaser and Quatech, Inc. Quatech,
Inc. reserves the right to change this documentation or the product to
which it refers at any time and without notice.
Trademarks QUATECH® is a registered trademarks of Quatech, Inc. IBM PC™,
PC-AT™, PS/2™, OS/2™, and Micro Channel™ are trademarks of
International Business Machines Corporation. Windows™ is a trademark
of Microsoft Corporation. Other product and brand names listed in this
manual may be trademarks of their respective owners.
Disclaimer The information in this manual is believed to be accurate and reliable at
the time of posting. Notwithstanding the foregoing, Quatech assumes no
responsibility for any damage or loss resulting from the use of this
manual, and expressly disclaims any liability or damages for loss of data,
loss of use, and property damage of any kind, direct, incidental or
consequential, in regard to or arising out of the performance or form of
the materials presented herein or in any software program(s) that may
accompany this document.
Changes or modifications to this device not explicitly approved by
Quatech will void the user's authority to operate this device.
Feedback Quatech, Inc. encourages and appreciates feedback concerning this
document. Please send any written comments to the Technical Support
department at the address listed on the cover page of this manual.

Quatech Syncdrive Plus User’s Manual Table of contents
Rev 01 (2/6/2003) Page i
Table of contents
Introduction----------------------------------------------------------------------------------------------------------------------- 1
System Requirements ---------------------------------------------------------------------------------------------------- 1
Installing Syncdrive plus------------------------------------------------------------------------------------------------ 2
Synchronous communication with Syncdrive Plus-------------------------------------------------------------------- 6
Understanding BIT-synchronous formatting---------------------------------------------------------------------- 6
Operational overview----------------------------------------------------------------------------------------------------------- 7
Data handling--------------------------------------------------------------------------------------------------------------- 7
Transmitting frames------------------------------------------------------------------------------------------------- 7
Receiving frames------------------------------------------------------------------------------------------------------ 8
Clocking parameters------------------------------------------------------------------------------------------------------ 8
Include file structure------------------------------------------------------------------------------------------------------ 9
Operating under Windows 2000/XP---------------------------------------------------------------------------------- 9
Building Syncdrive Plus applications -------------------------------------------------------------------------- 9
Terminating applications ------------------------------------------------------------------------------------------ 9
Tips and Techniques------------------------------------------------------------------------------------------------- 9
Syncdrive Plus data structures --------------------------------------------------------------------------------------------10
Syncdrive Plus application programming interface------------------------------------------------------------------16
Calling convention--------------------------------------------------------------------------------------------------------16
Return values --------------------------------------------------------------------------------------------------------------16
Examples--------------------------------------------------------------------------------------------------------------------17
Command reference------------------------------------------------------------------------------------------------------17
Using example programs-----------------------------------------------------------------------------------------------------29
Source code------------------------------------------------------------------------------------------------------------------29
Executable files------------------------------------------------------------------------------------------------------------29
Descriptions of example programs-----------------------------------------------------------------------------------29
LPBCKBI2K ----------------------------------------------------------------------------------------------------------29
FDBCKBI2K----------------------------------------------------------------------------------------------------------29
SENDBI2K ------------------------------------------------------------------------------------------------------------29
RECBI2K---------------------------------------------------------------------------------------------------------------30
THREADRX2K-------------------------------------------------------------------------------------------------------30
THREADTX2K-------------------------------------------------------------------------------------------------------30
Crossover cable-------------------------------------------------------------------------------------------------------30
Troubleshooting-----------------------------------------------------------------------------------------------------------------31
Verify that the hardware is configured properly ----------------------------------------------------------------31
Check the Syncdrive Plus configuration ---------------------------------------------------------------------------31
Check the clock sourcing------------------------------------------------------------------------------------------------31
Know the speed limits---------------------------------------------------------------------------------------------------31
Error codes -----------------------------------------------------------------------------------------------------------------------32
Appendix A-----------------------------------------------------------------------------------------------------------------------33
Definitions ------------------------------------------------------------------------------------------------------------------33

Quatech Syncdrive Plus User’s Manual Table of contents
Rev 01 (2/6/2003) Page ii
Table of figures
Figure 1 - Found new hardware prompt....................................................................................................2
Figure 2 - Welcome screen ..........................................................................................................................2
Figure 3 - Install Hardware Device Drivers screen...................................................................................3
Figure 4 - Locate Driver Files screen.........................................................................................................3
Figure 5 - Insert installation disk prompt .................................................................................................4
Figure 6 - Locate File screen.......................................................................................................................4
Figure 7 - Driver Files Search Results screen...........................................................................................5
Figure 8 - Completing the Found New Hardware Wizard screen............................................................5
Figure 9 - Syncdrive Plus bit-synchronous frame format.........................................................................6
Figure 10 - RS-232 Crossover cable pinouts............................................................................................30
Figure 11 - RS-422/485 Crossover cable pinouts.....................................................................................30

Quatech Syncdrive Plus User’s Manual Introduction
Rev 01 (2/6/2003) Page 1
Introduction
Syncdrive Plus is a synchronous communications software driver
package that helps users of Quatech synchronous communication
hardware to develop their application software.
The Syncdrive Plus driver package includes these features:
! Multiple communication channels using multiple MPA-series
adapters
! Support for bit-synchronous (SDLC, HDLC) communications
! User-control of most communication parameters
! Relieves programmers of the burden of directly programming the
synchronous communications hardware
! User can change or upgrade synchronous communication
hardware with minimal modifications to the application software
! Support for all Quatech MPA-series PCI bus and PCMCIA
adapters:
* MPAP-100: Multi-protocol RS-232 synchronous serial card
* MPAP-200/300: Multi-protocol RS-422/485 synchronous serial
card
* MPAC-100: Single port RS-232 synchronous board.
! Versions for Windows 2000 and Windows XP
Written specifically for use with C, Syncdrive Plus is also compatible
with other languages that support C-type subroutine interfaces.
System Requirements
The system requirements are as follows:
! PC running either Windows 2000 or Windows XP
! Available PCI slot or PC Card slot
We recommend that you install the latest service packs.
All other requirements are the same as for the respective operating
systems.
Note: For on-line technical
support, see Quatech’s Web site:
http://www.quatech.com/technical
.htm
Note: See Quatech’s Internet
site for the latest drivers and
updates:
http://www.quatech.com/.

Quatech Syncdrive Plus User’s Manual Introduction
Rev 01 (2/6/2003) Page 2
Installing Syncdrive plus
Follow this procedure to install your Quatech Syncdrive Plus
synchronous communication software.
Step Procedure Description
! Step 1 Insert the Quatech installation CD-ROM
into your CD-ROM drive. This is the CD that shipped with the MPAX-XXX adapter.
! Step 2 Insert the MPAX-XXX adapter into any
available PC Card socket. The Found New Hardware prompt displays briefly, followed by the Found
New Hardware Wizard’s Welcome screen.
Figure1- Foundnewhardwareprompt
Figure2-Welcomescreen
Step Procedure Description
! Step 3 Press Next to continue. The Install Hardware Device Drivers
screen displays.

Quatech Syncdrive Plus User’s Manual Introduction
Rev 01 (2/6/2003) Page 3
Figure3- InstallHardwareDeviceDriversscreen
Step Procedure Description
! Step 4 Select the Search for a suitable driver for
my device (recommended) option.
Press Next to continue.
The Locate Driver Files screen displays.
Figure4-LocateDriverFilesscreen
Step Procedure Description
! Step 5 Select the Specify a location option.
Press Next to continue. The Insert installation disk prompt displays.

Quatech Syncdrive Plus User’s Manual Introduction
Rev 01 (2/6/2003) Page 4
Figure5- Insertinstallationdiskprompt
Step Procedure Description
! Step 6 Browse to the correct drive location on your
CD-ROM drive.
Click OK to continue.
The complete path is E:\Synchronous
Adapters\Software\Windows 2000,
XP\Syncdrive Plus. Replace E: with your
CD-ROM drive designation.
The Locate File screen displays.
Figure6- LocateFilescreen
Step Procedure Description
! Step 7 Select the Quainf.inf file and click Open. The Driver Files Search Results screen
displays, showing the path to the Quainf.inf
driver.

Quatech Syncdrive Plus User’s Manual Introduction
Rev 01 (2/6/2003) Page 5
Figure7-DriverFilesSearchResultsscreen
Step Procedure Description
! Step 8 Make sure the directory path ends at the
Quainf.inf file. Click Next to continue. The Completing the Found New Hardware Wizard screen displays.
Figure8- CompletingtheFoundNewHardwareWizardscreen
Step Procedure Description
! Step 9 Click Finish to continue. The Installation Wizard completes the
installation of the Syncdrive Plus driver.
Note: You can find your
Syncdrive Plus adapter listed
in the Windows Device
Manager under Synchronous
Communication

Quatech Syncdrive Plus User’s Manual Synchronous Communication with Syncdrive Plus
Rev 01 (2/6/2003) Page 6
Synchronous communication with Syncdrive Plus
Most data communications in personal computers is handled
asynchronously using standard communication ports. Asynchronous
communication transfers data one character at a time with
significant overhead due to the addition of the start and stop bits
required for each character. These additions can decrease the rate of
data transfer by 20% or more.
In contrast, synchronous communication transfers data in a format
referred to as a frame. Each frame consists of a block of data plus a
fixed amount of overhead from the insertion of control, synchronization,
and error detection characters. Since the amount of overhead is
independent of the data block size, the percentage of the total
transfer time devoted to the frame overhead diminishes as the size of
the data block increases.
Synchronous communication is further divided into bit-synchronous
and byte-synchronous transfers. Bit-synchronous transfers treat the
data block as a series of data bits with no specific character
boundaries. Byte-synchronous transfers treat the data block as a
series of fixed-length characters.
The first release of Syncdrive Plus transfers data in bit-synchronous
mode only. The bit-synchronous mode can be used to implement such
protocols as SDLC or HDLC. Syncdrive Plus does not implement any
specific protocol itself, but supports most protocols implemented by
the application software. Future releases of Syncdrive Plus will add
support for byte-synchronous modes such as BISYNC.
Understanding BIT-synchronous formatting
Syncdrive's bit-synchronous mode generates a frame formatted
according to the scheme shown below.
Figure9- SyncdrivePlusbit-synchronousframeformat
flag data CRC flag
The hardware uses the frame's start flag and end flag characters for
synchronization purposes. When the application transmits a block of
data, Syncdrive Plus automatically appends these flag characters to
the frame. When receiving a frame, the driver automatically removes
these flag characters from the frame before returning it to the
application.
Syncdrive Plus uses the frame's CRC bytes for error detection
purposes. When transmitting a block of data, it automatically
generates and transmits the CRC after it sends all of the data. When
receiving a frame, Syncdrive Plus automatically checks the CRC to
determine if the frame was corrupted. If a CRC error occurs,
Syncdrive Plus returns an error code (see MPA_GetData() return
values).
Note: Syncdrive Plus uses
synchronous communication
for faster data transfer rates
with less overhead.

Quatech Syncdrive Plus User’s Manual Operational overview
Rev 01 (2/6/2003) Page 7
Operational overview
Data handling
The Syncdrive Plus driver simplifies application development.
Applications simply read and write frames as they would files
without any worry about buffer management, interrupts, or register
handling.
Once a handle is opened to the driver, the application can write as
many frames as desired if the handle was opened with overlapped
I/O. Syncdrive Plus queues the frames in the order in which they
were received and sends them out one at a time. The number of
frames that can be queued is limited only by system resources.
However, if the handle is opened without overlapped I/O, only a single
frame can be transmitted at one time. Control returns to the
application when the transfer is completed.
The driver can also queue frame buffers for receive if non-overlapped
I/O is specified. The buffers are filled as frames arrive. Alternately, if
the application did not queue read buffers, buffers in the driver can
store received frames until the application requests them. The size
and quantity of these driver receive buffers are dynamically
configurable.
If non-overlapped I/O is specified, only one frame can be read at a
time. If a frame has already been received, it is copied into the
application buffer immediately; otherwise, the driver waits until it
receives a complete frame before returning control to the application.
Transmitting frames
Queued transmit frames use Windows’ built-in I/O request queuing,
which stores data in a system buffer until it can be transmitted. The
application can obtain transfer status by using MPA_GetTransferStatus().
However, transmit frames are not queued for non-overlapped I/O. In
this case, the application waits until the frame has been transferred
before regaining control.
The Quatech board has a 1-KB transmit FIFO to supplement the 4-
byte transmit FIFO in the Zilog ESCC chip. If it receives an end-of-
frame (EOF) or the transmitter is not busy, the driver immediately
transfers as much data as possible into the transmit FIFOs. If the
frame is smaller than the FIFO size, then the transmit code waits
until the frame is transmitted completely before starting the next
frame. If the frame is larger than the FIFO depth, the driver waits for
an interrupt that indicates that the transmit FIFO has drained to
half capacity. At this point, the transmit code fills the transmit FIFO
up to its capacity. This process repeats until the entire frame buffer
has been transferred into the FIFOs. When the driver receives an
EOF interrupt indicating that the frame has been transmitted
completely, it starts the next frame (if there is one queued).
Note: The application can loop
on MPA_GetFrameCount() until
a frame is received. Once the
application receives a frame, it
calls MPA_GetFrameSize() to
determine the frame’s size so
that it can allocate an
appropriately sized buffer.

Quatech Syncdrive Plus User’s Manual Operational overview
Rev 01 (2/6/2003) Page 8
Receiving frames
The receive code has driver-allocated buffers that receive frames
without needing a user-supplied buffer. This allows the application to
allocate buffers as frames arrive.
A typical approach is to call MPA_GetFrameCount() until frame(s)
arrive. The application then uses MPA_GetFrameSize() to allocate the
buffer size and retrieves the frame using MPA_GetData().
Alternatively, the application can keep read buffers queued in
anticipation of incoming frames.
The receive logic works in a similar fashion to the transmit logic. The
Quatech board has a 1-KB receive FIFO to supplement the 8-byte
receive FIFO in the Zilog ESCC chip. If it receives a frame is that is
smaller than half of the receive FIFO depth, the receive code simply
acknowledges the EOF interrupt and transfers the frame either into
an internal buffer if there is no queued read buffer, or directly into
the user's read buffer if there is one. For frames larger than half-
FIFO size, the receive code generates interrupts when the half-FIFO
depth is reached. The driver then drains the receive FIFO by filling
either the internal buffer or the user's buffer. This process repeats
until the EOF is reached.
The receive buffers are configurable using MPA_SetConfig() as detailed
in the API (see Syncdrive Plus application programming interface)
and Structure (see Syncdrive Plus data structures) sections. The
driver allocates these buffers when the device is opened. Be sure to
take care to minimize requirements because the driver uses non-
paged system memory, which is scarce after boot-up.
The maximum number of internal receive buffers matches the
maximum number of frames that can be queued in the ESCC, which
is 10 frames. The ESCC has a status FIFO that queues the frame
lengths, so the frames do not have to be serviced immediately. The
maximum internal buffer length matches the depth of the internal
ESCC counters, 16 K. Once again, transmit buffers are only limited
by system resources.
Clocking parameters
The API supports many different clocking configurations. It is up to
the application to configure valid combinations. The application can
control the following:
! Transmit clock source
! Receive clock source
! Output of TRxC pin
! DPLL clock source and mode if DPLL used
! Baud rate of the baud rate generator (BRG), if BRG is used
Clocking can originate from two sources within the Quatech board:
1. Baud rate generator (BRG)
2. Digital phase locked loop (DPLL)
Note: Typically, you would use
this approach for known frame
sizes and arrival times.
Note: There are no internal
buffers for transmit because
queued transmit buffers use
the system buffers.

Quatech Syncdrive Plus User’s Manual Operational overview
Rev 01 (2/6/2003) Page 9
The BRG is a variable-rate clocking mechanism used with external
clock pins. The DPLL is used to encode the clocking signal within the
data stream, eliminating the need for an external clock pin. The
DPLL requires a clock and can either acquire it from the BRG or
externally through the RTxC pin.
Include file structure
QuaDLL.h – Provides function prototypes for Syncdrive Plus API
functions.
QuaDef.h – Defines structures that are used with Syncdrive Plus API
calls.
Operating under Windows 2000/XP
Building Syncdrive Plus applications
Link the application's object modules with the Syncdrive Plus API
import library file QuaDLL.LIB. The file can be found in the
\Synchronous Adapters\Software\Windows 2000, XP\Syncdrive Plus
\Examples directory of the Quatech CD-ROM.
Ensure that the Windows XP/2K device driver has been installed
properly on the system.
You can find all the required Syncdrive Plus include files in the
\Synchronous Adapters\Software\Windows 2000, XP\Syncdrive
Plus\Examples directory of the Quatech CD-ROM.
Syncdrive Plus applications must include the QuaDLL.h file.
Applications must use the MPADLL_API calling convention, defined in
the QuaDLL.h include file, in order to access the Windows DLL.
Terminating applications
Applications should ensure that any allocated memory is freed before
terminating.
Because applications can terminate unexpectedly due to bugs or
operator intervention, termination procedures should be called in exit
handler functions.
Tips and Techniques
The following is an outline of the basic steps that an application must
take to transmit or receive data frames using Syncdrive Plus.
1. Allocate data structures.
2. Configure the channel.
3. Register buffer queues (optional).
4. Transmit or receive data.
5. Free buffer queues (if used).
6. Release the channel.
7. Deallocate data structures.
Note: Syncdrive Plus data
structures must be 8-byte-
aligned.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 10
Syncdrive Plus data structures
This section describes the structures that Syncdrive Plus uses with
API calls. Every structure passed to the API needs its structLen
member filled out with the structure's length in bytes. This is true
even if the structure is used to retrieve information from the driver.
MPA_CONFIG
Handles device configuration
Syntax:
typedef struct tagMPA_CONFIG
{
ULONG structLen;
union
{
struct
{
// Set the following bits to indicate which parameter(s) are to be set.
// Parameter value(s) with corresponding bits set to zero are not
// changed.
// Tx does not require buffers since pending I/O requests provide buffers.
UCHAR FrameBufferSizeRx : 1;
UCHAR NumFrameBuffersRx : 1;
UCHAR BaudRate : 1;
UCHAR ClockRate : 1;
UCHAR ClockMode : 1;
UCHAR InternalLoopback : 1;
UCHAR RxClockSource : 1;
UCHAR TxClockSource : 1;
UCHAR TRXCOutput : 1;
UCHAR Encoding : 1;
UCHAR DPLLClockSource : 1;
UCHAR DPLLMode : 1;
UCHAR AutoRTSDeact : 1;
UCHAR CRCPreset : 1;
UCHAR IdleLineControl : 1;
ULONG pad : (8*sizeof(ULONG) - 13);
} bits;
ULONG all; // Used to clear/set all bits at once.
} set;
ULONG FrameBufferSizeRx; // In bytes.
ULONG NumFrameBuffersRx;
ULONG BaudRate;
ULONG ClockRate;
ULONG ClockMode;
BOOLEAN InternalLoopback;
CLOCK_SOURCE RxClockSource;
CLOCK_SOURCE TxClockSource;
TRXC_OUTPUT TRXCOutput;
ENCODING Encoding;
DPLL_CLOCK_SOURCE DPLL ClockSource;
DPLL_MODE DPLLMode;
BOOLEAN AutoRTSDeact;
BOOLEAN CRCPreset;
IDLE_LINE_CONTROL IdleLineControl;
} MPA_CONFIG, *PMPA_CONFIG;
Note: This design ensures that
the application uses the same
header file as the driver files
and helps to minimize difficult
memory overwrite debugging.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 11
MPA_CONFIG
Continued
Description: Used to set or get device configuration(s).
.
API Functions Used: MPA_SetConfig() and MPA_GetConfig() only.
Parameters:
structLen Length of the MPA_CONFIG structure in bytes. Should be filled in before
calling MPA_GetConfig() or MPA_SetConfig() functions.
set Union composed of set structure and a ULONG all. Bits in set structure
are set to tell the driver the corresponding value is valid and should be
set in hardware. Use all to clear or set all bits simultaneously. Pad is
reserved and is only used to align the structure.
FrameBufferSizeRx The size of each of the receive buffer(s) in bytes. This should be set to the
largest frame expected. The value should be as small as possible since it
requires non-paged system memory. This value only changes when the
device is opened. For the new values to take effect, you must close and
re-open the device.
NumFrameBuffers The number of receive frame buffers for use by the driver. This setting
should be based on how quickly frames will be read from the driver. If
frame sizes are large, infrequent, or frame servicing will be handled as
frames arrive, then this value can be small. Back-to-back small frames
that cannot be serviced as they arrive would require a larger value. The
value should be as small as possible since it requires non-paged system
memory. This value only changes when the device is opened. For the new
values to take effect, you must close and re-open the device.
BaudRate The baud rate in baud. Valid ranges are 1 to 1/6 of clock rate.
ClockRate The clock rate in Hz. The clock rate is determined by the Quatech
hardware. Factory standard configuration is 9.8304 MHz. This value
may be different if you are using custom-configured Quatech hardware.
ClockMode The clock mode rate. Can be X1, X16, X32, or X64.
InternalLoopback TRUE to enable internal loopback. Internal loopback allows transmit and
receive testing from a single card without any external connections.
RxClockSource The source of the receive clock. Use the following enumeration to set
clock source. Any other value is invalid.
typedef enum tagCLOCK_SOURCE
{
RTXC,
TRXC,
BAUD_RATE_GEN,
DPLL
} CLOCK_SOURCE;
Note: When configuring baud rate, be sure to remember to set both the clock rate
and the clock mode. The driver needs to know the oscillator frequency in order to
run at the baud rate specified. Because FM DPLL requires a clock rate 16 times
the data rate, the clock mode will be 16 in this case. Similarly, NRZI DPLL
requires a clock rate 32 times the data rate. Notice that clock mode acts as a
divisor and results in a lower maximum data rate.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 12
MPA_CONFIG
Continued
Parameters, cont.:
TxClockSource The source of the transmit clock. Use the following enumeration to set
clock source. Any other value is invalid.
typedef enum tagCLOCK_SOURCE
{
RTXC,
TRXC,
BAUD_RATE_GEN,
DPLL
} CLOCK_SOURCE;
TRXCOutput Selection for what should be output the TRxC pin. Use the following
enumeration to set TRxC source. Any other value is invalid.
typedef enum tagTRXC_OUTPUT
{
CRYSTAL_OUT,
TX_CLOCK,
BAUD_RATE_GEN_OUT,
DPLL_OUT
} TRXC_OUTPUT;
Encoding Encoding method for both transmit and receive. Use the following
enumeration to set encoding method. Any other value is invalid.
typedef enum tagENCODING
{
NRZ,
NRZI,
FM1,
FM0
} ENCODING;
DPLLClockSource The source for the DPLL clock. This is required if DPLL is used. Use the
following enumeration to set DPLL clock source. Any other value is invalid.
typedef enum tagDPLL_CLOCK_SOURCE
{
DPLL_SRC_BAUD_RATE_GEN,
DPLL_SRC_RTXC
} DPLL_CLOCK_SOURCE;
DPLLMode The DPLL mode. This is required if DPLL is used. Use the following
enumeration to set DPLL mode. Any other value is invalid.
typedef enum tagDPLL_MODE
{
DPLL_MODE_NRZI,
DPLL_MODE_FM
} DPLL_MODE;
AutoRTSDeact TRUE to select automatic RTS deactivation.
CRCPreset The preset value (either 0 or 1) to which the receive CRC checker and
transmit CRC generator should be set.
IdleLineControl Specifies what should be transmitted on an idle line. The choices are
either to send all ones or the flag character (usually 7Eh for SDLC).
Sending all zeros is not supported on the ESCC chip. Use the following
enumeration to set idle line control. Any other value is invalid.
typedef enum tagIDLE_LINE_CONTROL
{
IDLE_LINE_FLAGS,
IDLE_LINE_ONES // ESCC doesn't support sending continuous 0s.
} IDLE_LINE_CONTROL;

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 13
MPA_DRIVER_VERSION
Used to get driver version
Syntax:
typedef struct tagMPA_DRIVER_VERSION
{
ULONG structLen;
// Driver version is in format major.minor.
UCHAR major;
UCHAR minor;
} MPA_DRIVER_VERSION, *PMPA_DRIVER_VERSION;
Description: Structure for retrieving driver version. Driver version is in format
major.minor.
API Functions Used: MPA_GetDriverVersion() only.
Parameters:
structLen Length of the MPA_DRIVER_VERSION structure in bytes. Should be
filled in before calling MPA_GetDriverVersion().
major The major driver version.
minor The minor driver version.
MPA_HANDLE
Used to store handle information for open device
Syntax:
typedef struct tagMPA_HANDLE
{
ULONG structLen;
HANDLE hndDevice;
BOOLEAN overlapped;
} MPA_HANDLE, *PMPA_HANDLE;
Description: Used to store handle information for an open device. Other than filling
out structLen before calling MPA_Open(), no modifications should be
made to this structure. Structure should remain available until device is
successfully closed with MPA_Close().
API Functions Used: All MPA_Xxx() functions.
Parameters:
structLen Length of the MPA_HANDLE structure in bytes. Should be filled in before
calling MPA_Open().
hndDevice System-supplied handle to the device. Should not be modified by the
application.
overlapped TRUE or FALSE indicating whether device was opened with overlapped
capability. Should not be modified by the application.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 14
MPA_NODE_ADDRESS Handles node addressing
Syntax:
typedef struct tagMPA_NODE_ADDRESS
{
ULONG structLen;
union
{
struct
{
// Set the following bits to indicate which parameter(s) are to be set.
// Parameter value(s) with corresponding bits set to zero are not
// changed.
UCHAR addr : 1;
UCHAR enable : 1;
UCHAR pad : (8*sizeof(UCHAR) - 2);
} bits;
ULONG all; // Used to clear/set all bits at once.
} set;
UCHAR addr;
BOOLEAN enable;
} MPA_NODE_ADDRESS, *PMPA_NODE_ADDRESS;
Description: Used to set the device's node address and/or enable node addressing.
API Functions Used: MPA_SetNodeAddress() only.
Parameters:
structLen Length of the MPA_NODE_ADDRESS structure in bytes. Should be filled
in before calling MPA_SetNodeAddress().
set This is a union composed of set structure and a ULONG all. Bits in the set
structure are set to tell the driver the corresponding value is valid and
should be set in hardware. Use all to clear or set all bits simultaneously.
Pad is reserved and is only used to align the structure.
addr The node address to set for this device. This will only be set in hardware
if the corresponding addr bit is set in the set structure. If the
corresponding addr bit in the set structure is cleared, addr will be
ignored by the driver.
enable TRUE or FALSE value used to enable or disable node addressing. This
will only be set in hardware if the corresponding enable bit is set in the
set structure. If the corresponding enable bit in the set structure is
cleared, the driver will ignore enable.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus data structures
Rev 01 (2/6/2003) Page 15
MPA_RESET_FRAMES Used to reset transmit and/or receive frames
Syntax:
typedef struct tagMPA_RESET_FRAMES
{
ULONG structLen;
BOOLEAN tx;
BOOLEAN rx;
} MPA_RESET_FRAMES, *PMPA_RESET_FRAMES;
Description: Used to reset frames. Transmit and receive frames can be reset
individually or simultaneously.
API Functions Used: MPA_ResetFrames() only.
Parameters:
structLen Length of the MPA_RESET_FRAMES structure in bytes. Should be filled
in before calling MPA_ResetFrames().
tx TRUE to reset transmit frames. FALSE to leave transmit frames
unchanged.
rx TRUE to reset receive frames. FALSE to leave receive frames unchanged.

Quatech Syncdrive Plus User’s Manual Syncdrive Plus application programming interface
Rev 01 (2/6/2003) Page 16
Syncdrive Plus application programming interface
There are a number of functions that make up the application
programs entry points into Syncdrive Plus. These API functions are
listed below.
Function Description
MPA_Close() Closes previously opened handle to the MPA device
MPA_GetConfig() Gets the current configuration in an MPA_CONFIG structure
MPA_GetData() Used to receive a frame of data
MPA_GetDriverVersion() Gets the driver version of the kernel-mode driver
MPA_GetFrameCount() Gets the number of frames received but not yet transferred to caller
buffers via MPA_GetData()
MPA_GetFrameSize() Gets the frame size in bytes of the oldest received frame that hasn’t yet
been given to the caller
MPA_GetModemControlSignals() Gets the current configuration of the modem control signal(s)
MPA_GetTransferStatus() Used to get status of an overlapped transfer
MPA_Open() Opens a handle to the MPA device driver
MPA_PutData() Used to transmit a frame of data
MPA_ResetFrames() Resets transmit and/or receive frames by clearing out values
MPA_SetConfig() Sets the configuration for the device
MPA_SetModemControlSignals() Sets the modem control signals for the device
MPA_SetNodeAddress() Sets the node address for the device and/or enables addressing
Calling convention
All Syncdrive Plus functions use a C-language interface with the
MPADLL_API call linkage macro. This macro is defined in the
QuaDLL.h include file.
Return values
All Syncdrive Plus functions return an enumerated integer value of
type MPA_ERROR_CODE. A return code of ERR_NO_ERROR.
indicates a successful completion.
If Syncdrive Plus cannot successfully complete a function, it returns
an error code other than ERR_NO_ERROR. We define the error codes
in the QuaDef.h include file and describe them in the Error codes
section on page 32.
Note: All Syncdrive Plus API
functions are prototyped in the
QuaDLL.h Syncdrive Plus include
file.