Design

MicroGate HDLC API for Windows Technical Information 

Software Development Kit Installation

The product diskette holds a self-extracting ZIP (HDLCSDK.EXE) file containing the documentation, import libraries, API C header file and sample source code. To extract the SDK type:

A:\> HDLCSDK

From the command prompt or double click HDLCSDK.EXE from Windows explorer.

Installation Overview

  • Install the software component of the HDLC API SDK following the instructions found in the user's manual (HDLCAPI.CHM) located on the product diskette. 
  • Follow the hardware installation instructions in the appropriate section below for the hardware you are installing. Test the adapter with the diagnostics contained in the device manager property page. Refer to "Testing the Adapter" for more information.
  • Review the remaining sections of this document for information regarding warranty, technical support, repair procedures, and updates. The adapter is now ready for use with your application.

PCI Adapter Installation

  • Follow the instructions supplied by the manufacturer of your computer for the installation of a PCI adapter. Some systems reserve interrupts for use by ISA expansion cards. This may require changes to your CMOS settings to free interrupts for use by a PCI adapter.
  • Review Data Port Interface Selection if your adapter has configurable port interfaces.  

PC/104+ Adapter Installation

  • A PC/104+ adapter is electrically and logically the same as a PCI adapter, and only the physical connectors are different. The PC/104+ adapter appears to the system as a PCI adapter.
  • PC/104+ adapters may be installed in a stack of up to four adapters. A switch on each adapter selects one of four possible stack positions. This selection MUST be unique for each adapter in the stack. The switch is located on the side of the adapter with positions labeled 0 - 7.
    Switch Position Stack Position
    0 or 4 1
    1 or 5 2
    2 or 6 3
    3 or 7 4
  • The PC/104+ adapter has two large connectors that connect to the system and other adapters in the stack: The 120 pin (PCI) connector is a rectangular array (30 x 4) of pins. The 104 pin (ISA) connector is an uneven array of pins with two rows shorter than the other 2 rows.
  • A plastic fixture is placed on the 104 pin connector during shipping to protect the pins from bending. Remove this fixture before installation. The fixture vertically slides on and off of the pins. Save the fixture for future adapter removal.
  • The 120 pin connector includes a plastic fixture (shroud) that permanently remains on the adapter, even during installation.
  • The PC/104+ adapter has four mounting holes at the corners of the adapter. These may be used for mounting hardware (stand-offs and screws) to secure the adapter to the system or adapter stack. Stand-offs and screws are NOT included with the adapter.
  • Follow the instructions supplied by the manufacturer of your computer for the installation of a PC/104+ adapter. Some systems reserve interrupts for use by ISA expansion cards. This may require changes to your CMOS settings to free interrupts for use by a PC/104+ adapter.
  • Review Data Port Interface Selection if your adapter has configurable port interfaces.  

Data Port Interface Selection

Adapters with selectable port interfaces are configured by placing jumpers on one of three jumper blocks so as to completely cover a jumper block. Each jumper block is labeled with a port number (if adapter has more than one port) and either RS-232, V.35, or RS-422/485.

Interface Jumper Relocation
The adapter is shipped from the factory with one of the three serial interfaces configured. In cases where the serial interface is to be changed, the following field-upgrade procedure is to be followed to relocate the interface jumper:

1.      Two black 8-pin jumpers separated by a single-pin colored jumper form the 17-position interface jumper. Remove the jumpers by first removing the colored jumper, then the black 8-pin jumpers one at a time using pliers. Do not attempt removal with a screwdriver. This may damage the jumpers or the adapter.

2.      Insert the jumpers by hand onto the desired interface jumper block and push down firmly.

RS-232

    • V.28 single-ended drivers and receiver
    • standard DB-25 connector (no adapter cable required)
    • used for low speed devices (modems)

V.35

    • V.11 differential drivers and receivers for data and clock signals
    • V.28 single ended drivers and receivers for other signals.
    • requires DB-25 to ISO-2593 34-pin connector adapter cable

    RS-422/485
    • V.11 differential drivers and receivers
    • standard DB-25 (RS-530) connector (no adapter cable required)
    • RS-449 (DB-37) and X.21 (DB-15) require adapter cables
    • used for high speed devices (CSU/DSU)

Installing the SyncLink PC Card

The SyncLink PC Card can be inserted into PCMCIA sockets that accept Type-II, 16-bit, 5 Volt PC Cards. Most PCMCIA sockets meet this requirement. There are no jumper or switch settings.

Windows operating systems support plug and play, automatically detect the PC Card, and assign the necessary resources. The PC Card can be inserted at any time, and can be removed after stopping the device.

The serial interface selection (RS-232/V.35/RS-422) is made through the device property page in the device manager. The default serial interface state is disabled. The interface selection must match the interface requirements of the attached device. A mismatched interface selection may result in damaged hardware.

Windows 2000 Driver Installation

Windows automatically detects the new hardware and starts the 'Found New Hardware Wizard' after the next login.

  • Click Next
  • Select Search for a suitable driver and click Next
  • Select Specify a location and click Next
  • Enter the path of the adapter drivers and click OK
  • Driver search results are displayed
  • Click Next, the wizard copies any necessary files 
  • Click Finish to complete installation

Windows XP/Server 2003 Driver Installation

Windows automatically detects the new hardware and starts the 'Found New Hardware Wizard' after the next login.

  • Select Install from a list or specific location (advanced)
  • Click Next
  • Select Search for best driver in these locations
  • Select Include this location in the search and enter the location of the adapter drivers (floppy disk or directory for downloaded drivers)
  • Click Next, the wizard copies any necessary files 
  • Click Finish to complete device installation

Testing the Adapter

The adapter driver software includes integrated diagnostic tests which you can run to verify the operation of the adapter.

  • Right click My Computer from desktop or Start menu
  • Click Properties from pop-up menu
  • Select Hardware tab
  • Click Device Manager button
  • Double click SyncLink Adapters item to display installed adapters
  • Double click the appropriate adapter
  • Select Diagnostics tab and follow the prompts to test the adapter.
  • When testing is complete, close the property page and the Device Manager

DOCUMENTATION

AVAILABLE DOWNLOADS

The latest HDLC API software development kit is available here.