Design

The MicroGate Serial API provides a serial communications Application Program Interface for Microsoft Windows using the SyncLink family of adapters (PCI, PCI Express, PCMCIA, PC/104+). The API supports multiple serial protocols (when supported by specific adapter model), including SDLC, HDLC, BISYNC, MONOSYNC, asynchronous, and raw bit-synchronous. These protocols are used to build applications for networking, X.25, frame relay, IBM SDLC (SNA), satellite, radio and other serial communications. The API allows direct control of the serial hardware (Base API), or high level control of the link layer protocol (Link Layer API). 

Supported Windows Versions

  • Windows 2000
  • Windows XP (32-bit, 64-bit)
  • Windows Server 2003/2008 (32-bit, 64-bit)
  • Windows Vista (32-bit, 64-bit)
  • Windows 7 (32-bit, 64-bit)

The API is accessed through a standard Windows DLL, and can be used by any programming language that allows calling functions in a standard Windows DLL. Sample programs with source are supplied for the C/C++ and C# languages. 

Supported Development Tools

  • Microsoft Visual C/C++ 6 (32-bit)
  • Microsoft Visual Studio 2005 (C, C++, C#, 32-bit, 64-bit)
  • Windows Server 2003 DDK Tools (C, C++, 64-bit)
  • Borland C/C++ 5.5 (32-bit)

The API can be used in two ways: the base API and the link layer extensions.

An application uses the base API to send and receive data where the application controls the exact contents and timing of data transfer.

An application uses the extended API to send and receive data where the API implements the details of a higher level protocol like LAPB. The extended API handles frame sequencing, retries, and timeouts. A sample C application is included demonstrating LAPB communications.

HARDWARE SUPPORT

Hardware support for API features depends on the specific model. For example, the PCMCIA adapter only supports HDLC and asynchronous modes of operation. For a complete list of adapter specific support of each API feature, click here.

Base API Options

  • SDLC, HDLC, BISYNC, MONOSYNC, ASYNC, raw bit-synchronous protocols
  • Selectable hardware CRC: CRC-16, CRC-32, None
  • DPLL clock recovery
  • Separate, selectable transmit and receive data clock inputs
  • Baud Rate Generator for sourcing data clocks
  • Variety of transmit preamble and idle patterns
  • Encoding: NRZ,NRZB,NRZ-L,NRZI,NRZ-M,NRZ-S,BIPHASE,FM0,FM1,Manchester,differential biphase level
  • Full control and monitoring of DTR,RTS,DSR,DCD,CTS,RI
  • Loopback mode for diagnostics
The link layer extensions implement the general procedures of ISO4335 for HDLC. The application configures the API to implement specific protocols such as LAPB, LAPD and SDLC. 

Link Layer Options

  • Normal Response Mode (NRM) for SDLC (half and full duplex)
  • Asynchronous Balanced Mode (ABM) for LAPB and related protocols
  • Multiple links on a single physical interface (Multidrop/LAPD)
  • Initialization Mode (SIM/RIM)
  • XID support.
  • Modulus 8 and 128 operation.
  • Selective and multi-selective reject (SREJ) support.
  • Address fields up to 16 bytes in length.

The MicroGate Serial API is packaged as a Software Development Kit (SDK) and a Run Time Kit (RTK).

Software Development Kit

The MicroGate Serial SDK contains documentation, development support files, sample C and C# programs, and the Run Time Kit.

Run Time Kit

The MicroGate Serial RTK contains the redistributable software components necessary to support deployment of a serial applicaiton.

Optional General Purpose I/O Signals

The SyncLink GT family of serial adapters can be ordered with an optional header that provides general purpose digital (TTL) input/output signals. These signals can be configured (direction), controlled, and monitored through the serial API. Contact our sales department for ordering details.

Hardware Branding

The MicroGate Serial API SDK offers developers seamless application integration.  With individually assigned PCI hardware IDs, the SyncLink adapters may be recognized and installed as distinctive cards, carrying your own company name or model classification.

Documentation

Serial API DOWNLOADS

HDLCSDK.EXE Complete SDK, documentation, and sample program source.
HDLCRTK.EXE Run-Time-Kit and documentation 

PRODUCT CONFIGURATIONS

PCI Adapters
Product Code 
MicroGate Serial API w/SyncLink GT/PCI/V.35
191173
MicroGate Serial API w/SyncLink GT/PCI/RS-232
192173
MicroGate Serial API w/SyncLink GT/PCI/RS-422/X.21
193173
 
MicroGate Serial API w/SyncLink GT4/PCI/V.35/4p
491173
MicroGate Serial API w/SyncLink GT4/PCI/RS-232/4p
492173
MicroGate Serial API w/SyncLink GT4/PCI/RS-422/X.21/4p
493173
PCI Express Adapters
MicroGate Serial API w/SyncLink GT2e/V.35
201173
MicroGate Serial API w/SyncLink GT2e/RS-232
202173
MicroGate Serial API w/SyncLink GT2e/RS-422/X.21
203173
 
MicroGate Serial API w/SyncLink GT4e/V.35/4p
401173
MicroGate Serial API w/SyncLink GT4e/RS-232/4p
402173
MicroGate Serial API w/SyncLink GT4e/RS-422/X.21/4p
403173
PC/104+ Adapters
MicroGate Serial API w/SyncLink GT/PC104+/V.35
1P1173
MicroGate Serial API w/SyncLink GT/PC104+/RS-232
1P2173
MicroGate Serial API w/SyncLink GT/PC104+/RS-422/X.21
1P3173
 
MicroGate Serial API w/SyncLink GT4/PC104+/RS-232
4P2173
 
PC Card Adapters
MicroGate Serial API w/SyncLink PCMCIA
P10173
Cables
V.35 cable
2534GT
RS-232 cable
CMF000
RS-449 cable
2537FM
RS-530 cable
CMF000
X.21 cable
2515FM
Hardware Manuals
SyncLink GT User's Manual and Specifications
 SyncLink GT4 User's Manual and Specifications
SyncLink GT2e/GT4e User's Manual and Specifications
SyncLink GT PC/104+ User's Manual and Specifications
SyncLink GT4 PC/104+ User's Manual and Specifications
SyncLink PCMCIA User's Manual and Specifications