Quatech MPAP-100 User Manual

MPAP-100

RS-232 PCMCIA

SYNCHRONOUS ADAPTER

for PCMCIA Card Standard compatible machines

User's Manual

QUATECH, INC. TEL: [phone]
5675 Hudson Industrial Parkway FAX: [phone]
Hudson, Ohio 44236 www.quatech.com

Quatech MPAP-100 User's Manual 1

WARRANTY INFORMATION

Quatech Inc. warrants the MPAP-100 to be free of defects for one (1) year from the date
of purchase. Quatech Inc. will repair or replace any board that fails to perform under normal
operating conditions and in accordance with the procedures outlined in this document during the
warranty period. Any damage that results from improper installation, operation, or general
misuse voids all warranty rights.

Although every attempt has been made to guarantee the accuracy of this manual, Quatech
Inc. assumes no liability for damages resulting from errors in this document. Quatech Inc.
reserves the right to edit or append to this document at any time without notice.

Please complete the following information and retain for your records. Have this
information available when requesting warranty service.

DATE OF PURCHASE:

MODEL NUMBER: MPAP-100

PRODUCT DESCRIPTION: Single Channel PCMCIA RS-232-D

Synchronous Communications

Adapter

SERIAL NUMBER:

Quatech MPAP-100 User's Manual 2

Copyright 2001 Quatech, Inc.

NOTICE

The information contained in this document is protected by copyright, and cannot be
reproduced in any form without the written consent of Quatech, Inc. Likewise, any software
programs that might accompany this document are protected by copyright and 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.

The authors have taken due care in the preparation of this document and every attempt
has been made to ensure its accuracy and completeness. In no event will Quatech, Inc. be liable
for damages of any kind, incidental or consequential, in regard to or arising out of the
performance or form of the materials presented in this document or any software programs that
might accompany this document.

Quatech, Inc. encourages feedback about this document. Please send any written
comments to the Technical Support department at the address listed on the cover page of this
document.

Quatech MPAP-100 User's Manual 3

g

g

g

g

Table of Contents

1 Introduction .......................................................

1.1 System Requirements ...........................................

2 Hardware Installation ..............................................

3 DOS / Windows 3.x Software Installation ...........................

3.1 MPAP-100 Client Driver for DOS ..............................

3.1.1 DOS client driver installation ...............................

3.1.2 Auto Fallback configuration ................................

3.1.3 Hot Swappin

..............................................

3.2 DOS Client Driver examples ...................................

3.3 MPAP-100 Enabler for DOS ...................................

3.3.1 DOS Enabler Installation ...................................

3.3.2 Hot Swapping is not supported .............................

3.3.3 Configuring a card .........................................

3.3.4 Releasing a card's configuration ............................

3.4 DOS Enabler Examples ........................................

4 Windows 95/98 Installation ........................................

4.3 Configuration Options .........................................

5 OS/2 Software Installation .........................................

5.1 System Requirements ..........................................

5.2 OS/2 Client Driver Installation .................................

5.2.1 Tying a configuration to a particular socket ................

5.2.2 Auto Fallback configuration ................................

5.2.3 Hot Swappin

..............................................

5.3 OS/2 Client Driver Configuration Examples ....................

5.4 Monitoring The Status Of PCMCIACards .....................

5.5 Installing OS/2 PCMCIASupport ..............................

6 Using the MPAP-100 with Syncdrive ...............................

7 Addressin

........................................................

8 Interrupts ........................................................

9 SCC General Information .........................................

9.1 Accessing the registers .........................................

9.2 Baud Rate Generator Programmin

............................

9.3 SCC Data Encoding Methods ..................................

9.4 Support for SCC Channel B ..................................

9.4.1 Receive data and clock signals ..............................

9.4.2 Extra clock support for channel A ..........................

9.4.3 Extra handshaking for channel A ...........................

9.4.4 Other signals are not used ..................................

9.5 SCC Incompatibility Warnings ................................

9.5.1 Register Pointer Bits .......................................

9.5.2 Software Interrupt Acknowledge ...........................

10 FIFO Operation .................................................

10.1 Enabling and disabling the FIFOs .............................

10.2 Accessing the FIFOs ..........................................

10.2.1 Transmit FIFO ...........................................

10.2.2 Receive FIFO .............................................

6
6
7

8
10
10
11
11
13
14
14
14
14
16
17
18
22
23
23
23
24
24
24
25
25
26
27
28
29
30
31
34
34
34
35
35
35
35
36
36
36
37
37
37
37
38

Quatech MPAP-100 User's Manual iii

g

)

)

Table of Contents

10.3 SCC configuration for FIFO operation ........................

10.3.1 Using channel A for both transmit and receive .............

10.3.2 Using channel B for receive ................................

10.4 FIFO status and control ......................................

10.4.1 Interrupt status ...........................................

10.4.2 Resetting the FIFOs .......................................

10.4.3 Reading current FIFO status ..............................

10.4.4 Controlling the FIFOs .....................................

10.5 Accessing the SCC while FIFOs are enabled ...................

10.6 Receive pattern detection .....................................

10.7 Receive FIFO timeout ........................................

11 Communications Register ........................................

12 Configuration Register ...........................................

13 Interrupt Status Register .........................................

14 FIFO Status Register .............................................

15 FIFO Control Register ...........................................

16 Receive Pattern Character Register ...............................

17 Receive Pattern Count Register ...................................

18 Receive FIFO Timeout Register ..................................

19 External Connections ............................................

19.1 SYNCA (pin 10

19.2 RING (pin 22

..............................................

................................................

19.3 Null-modem cables ...........................................

20 DTE Interface Signals ............................................

21 Specifications ....................................................

22 Software Troubleshootin

........................................

22.1 DOS Client Driver ............................................

22.1.1 Generic "SuperClient" Drivers ............................

22.1.2 Lack of Available Resources ...............................

22.1.3 Multiple Configuration Attempts ..........................

22.1.4 Older Versions of Card and Socket Services ................

22.2 DOS Enabler .................................................

22.2.1 With Card and Socket Services ............................

22.2.2 Socket Numbers ..........................................

22.2.3 Memory range exclusion ..................................

22.3 OS/2 Client Driver ...........................................

22.3.1 Resources Not Available ..................................

22.3.2 Insufficient Number Of Command Line Arguments ........

22.3.3 Bad Parameters ...........................................

38
39
40
41
41
42
42
42
42
42
44
45
47
49
50
51
52
53
54
55
56
56
57
58
61
62
62
62
62
62
62
63
63
63
63
63
63
63
64

Quatech MPAP-100 User's Manual iii

1 Introduction

The Quatech MPAP-100 is a PCMCIA Type II (5 mm) card and is PCMCIA PC Card
Standard Specification 2.1 compliant. It provides a single-channel RS-232 synchronous
communication port. The base address and IRQ are configured through the PCMCIA hardware
and software using utility programs provided by Quatech. There are no switches or jumpers to
set.

The MPAP-100 uses a Zilog 85230-compatible Serial Communications Controller
(SCC). The SCC can support asynchronous formats, byte-oriented synchronous protocols such
as IBM Bisync, and bit-oriented synchronous protocols such as HDLC and SDLC. The SCC also
offers internal functions such as on-chip baud
rate generators, and digital phase-lock loop (DPLL) for recovering data clocking from received
data streams.

Because the PCMCIA 2.1 standard does not include a direct memory access (DMA)
interface, the MPAP-100 supports only interrupt-driven communications. To compensate for the
lack of DMA, the MPAP-100 is equipped with 1024-byte FIFOs for transmit and receive data.
The FIFOs provide for high data throughput with very low interrupt overhead.

1.1 System Requirements

 16 bytes of contiguous I/O address space

 one hardware interrupt (IRQ)

 One available PCMCIA Type II socket

2 Hardware Installation

Hardware installation for the MPAP-100 is a very simple process:

1. Insert the MPAP-100 into a vacant PCMCIA Type II adapter socket.

2. If PCMCIA Card and Socket Services and a Quatech MPAP-100 Client Driver are
installed, the MPAP-100 will be configured for use automatically. Under DOS, it is also
possible to use the Quatech MPAP-100 Enabler program. (Software installation and
configuration is covered in other chapters of this manual.)

3. Attach the narrow connector on the supplied cable to the socket on the end of the
MPAP-100. The connector is keyed so that it can only be inserted in one orientation.
The connector should attach firmly and smoothly. Do not force the connector into the
socket!

4. Attach the male DB-25 connector on the supplied cable to the external equipment in use.

3 DOS / Windows 3.x Software Installation

Two DOS configuration software programs are provided with the MPAP-100: a client

driver and a card enabler. These programs are executed from DOS (before entering Windows)
and allow operation of the MPAP-100 in both the DOS and Windows 3.x environments. Table 1
highlights the differences between these programs.

EnablerClient Driver

File name

File type

Interfaces to

Automatic configuration of

MPAP-100 upon insertion

(Hot Swapping)

PCMCIA Card and Socket
Services software required

Recommendation

PCMCIA card and

Socket Services

(socket-independent)

Best for most users.

MPAP1EN.EXEMPAP1CL.SYS

DOS executableDOS device driver

socket controller

(Intel 82365 or

compatible only)

noyes

noyes

Use if Card and
Socket Services

software is not

available and the

system has an Intel

82365 or compatible

socket controller.

Table 1 --- Client driver versus enabler for DOS/Windows 3.x.

IMPORTANT

Do not use both the client driver and the enabler!

If you are unsure whether Card and Socket Services software is currently installed on

your system, install the client driver. When loaded, the client driver will display an error
message if Card and Socket Services software is not detected. If you receive such an error
message, remove the client driver software and install the enabler instead.

3.1 MPAP-100 Client Driver for DOS

In order to use the MPAP-100 client driver, the system must be configured with Card and

Socket Services software. Card and Socket Services software is not provided with the
MPAP-100 but is available from Quatech.

3.1.1 DOS client driver installation

The MPAP-100 client driver accepts between zero and eight sets of desired

configurations from the user on the command line. When an MPAP-100 is inserted, desired
configurations are tried in the order they appear on the command line from left to right. If the
user does not provide any desired configurations, the client driver will ask Card Services to
automatically determine a configuration for the card.

Each desired configuration must be enclosed in parentheses and must be separated from

other desired configurations by a space on the command line. Within each desired configuration,
parameters are separated using commas (no spaces). In the descriptions below, replace the '#'
symbols with the appropriate numeric values.

1. Copy the file MPAP1CL.SYS from the MPAP-100 distribution diskette onto the system's
hard drive.

2. Using an ASCII text editor, open the system's CONFIG.SYS file located in the root
directory of the boot drive.

3. Locate the line(s) in the CONFIG.SYS file where the Card and Socket Services software
is installed.

4. BELOW the line(s) installing the Card and Socket Services software, add the following
line to the CONFIG.SYS file:

DEVICE=drive:\path\MPAP1CL.SYS (S#,B#,I#,C) ... (S#,B#,I#,C)

where drive:\path specifies the drive letter and directory to which you copied the client

driver file, and (S#,B#,I#,C) ... (S#,B#,I#,C) stand for a variable number of desired
configurations. The configuration parameters are described below.

S# The PCMCIA socket into which the MPAP-100 must be inserted for this

configuration to be used. This value is a decimal number ranging from 0 to 15. If
this parameter is not used, the configuration can apply to any socket.

B# The base I/O address of the MPAP-100. This number must be a three-digit

hexadecimal value ending in 0. If this parameter is omitted, a base address will be
assigned by Card Services.

I# The interrupt level (IRQ) of the MPAP-100. This decimal number must be one of

the following values: 3, 4, 5, 7, 9, 10, 11, 12, 14, 15, or 0 if no IRQ is desired. If
this parameter is omitted, an interrupt level will be assigned by Card Services.

C Drive SYNC input of SCC channel A with the Remote Loopback bit of

Communications Register (see page 39). If this parameter is omitted, the SYNC
input of SCC channel A will be undefined.

5. Save the CONFIG.SYS file and exit the text editor.

6. Insert an MPAP-100 card in a PCMCIA socket, and reboot the computer. (If a card is
present in a socket at boot time, the card's configuration is reported on the screen as the
client driver loads. This feature can be used to verify the changes just made to the
CONFIG.SYS file.)

7. If the Client Driver reports the desired configuration, the installation process is complete
and the MPAP-100 may be removed from the system if desired.

8. If configuration of the card fails, the client driver will display an error message. If
"Invalid command line option" is displayed, correct the entry in the CONFIG.SYS file
and reboot the computer again. If "Card and Socket Services not found" is displayed,
install Card and Socket Services on the system or use the enabler program instead of the
client driver.

3.1.2 Auto Fallback configuration

The client driver can be instructed to try desired configurations first but fallback to

allowing Card Services to determine a configuration if none of the desired configurations are
available. This is done by adding a null configuration "()" to the end of the command line.

3.1.3 Hot Swapping

The client driver supports "hot swapping." After installation, it is not necessary for the

MPAP-100 to be inserted in the PCMCIA socket at boot time. When the card is inserted, it will
be configured according to the command line options. When the card is removed, the resources
it used will be made available for other devices.

If the MPAP-100 is in a socket at boot time, the client driver will display a message

indicating whether the card can be successfully configured and what resources will be used. This

is helpful if the user allows Card Services to select resources instead of specifying them on the
command line.

3.2 DOS Client Driver examples

Example: Attempt to configure an MPAP-100 inserted into any socket with a base address and
IRQ automatically assigned by Card Services.

DEVICE=C:\MPAP-100\MPAP1CL.SYS

Example: Attempt to configure an MPAP-100 inserted into any socket with a base address of
300 hex and an IRQ assigned by Card Services. Software control of SYNCA will be enabled. If
address 300 hex is unavailable, the card will not be configured.

DEVICE=C:\MPAP-100\MPAP1CL.SYS (b300,c)

Example: Attempt to configure an MPAP-100 inserted into socket 0 with a base address of 300
hex and IRQ 5. If address 300 hex or IRQ 5 is unavailable, the card will not be configured. In
addition, if an MPAP-100 is inserted into any other socket, it will not be configured.

DEVICE=C:\MPAP-100\MPAP1CL.SYS (s0,b300,i5)

Example: Attempt to configure an MPAP-100 inserted into any socket with a base address of
300 hex and IRQ 5. If address 300 hex or IRQ 5 is unavailable, attempt to configure the card
with a base address assigned by Card Services and IRQ 10. If IRQ 10 is also unavailable,
attempt to configure the card with a base address and an IRQ assigned by Card and Socket
Services.

DEVICE=C:\MPAP-100\MPAP1CL.SYS (b300,i5) (i10) ()

Example: Attempt to configure an MPAP-100 inserted into socket 0 with a base address of 300
hex and IRQ 5. Attempt to configure an MPAP-100 inserted into socket 1 with a base address of
340 hex and IRQ 10. This type of configuration may be desirable in systems where more than
one MPAP-100 is to be installed. It allows the user to force the MPAP-100 address and IRQ
settings to be socket-specific which may simplify cable connections and software development.

DEVICE=C:\MPAP-100\MPAP1CL.SYS (s0,b300,i5) (s1,b340,i10)

3.3 MPAP-100 Enabler for DOS

For systems that are not using PCMCIA Card and Socket Services software, the

MPAP-100 DOS enabler may be used to enable and configure the card. The enabler will operate
on any DOS system using an Intel 82365SL (PCIC) or PCIC-compatible PCMCIA socket adapter
including the Cirrus Logic CL-PD6710/6720, the VLSI VL82C146, and the Vadem VG-365
among others.

IMPORTANT

The enabler can be used ONLY if Card and Socket

Services is NOT installed on the system!

3.3.1 DOS Enabler Installation

To install the DOS enabler program, copy the file MPAP1EN.EXE from the MPAP-100

distribution diskette onto the system's hard drive. No setup steps are required.

IMPORTANT

The enabler requires a region of high DOS memory when configuring

an MPAP-100. This region is 1000H bytes (4KB) long and by default

begins at address D0000H (the default address may be changed using

the "W" option). If a memory manager such as EMM386, QEMM, or

386Max is installed on the system, this region of DOS memory must

be excluded from the memory manager's control. Consult the

documentation provided with the memory manager software for

instructions on how to exclude this memory region.

3.3.2 Hot Swapping is not supported

The MPAP-100 enabler does not support automatic configuration of adapters upon

insertion, commonly referred to as "Hot Swapping". The enabler must be executed after
insertion of an MPAP-100 card. If more than one MPAP-100 is installed in a system, the enabler
must be executed separately for each card. A card that is removed and reinserted must be
reconfigured by executing the enabler again.

3.3.3 Configuring a card

The enabler requires a single desired configuration to be provided on the command line.

The card will not be configured if the desired configuration is not provided. The desired
configuration must be enclosed in parentheses and it contains parameters separated using
commas (no spaces). In the descriptions below, replace the '#' symbols with the appropriate
numeric values.

MPAP1EN (S#,B#,I#,W#,C)

S# The PCMCIA socket into which the MPAP-100 will be inserted. This value is a

decimal number ranging from 0 to 15. This parameter is always required when
configuring a card.

B# The base I/O address of the MPAP-100. This number must be a three-digit

hexadecimal value ending in 0. This parameter is always required when
configuring a card.

I# The interrupt level (IRQ) of the MPAP-100. This decimal number must be one of

the following values: 3, 4, 5, 7, 9, 10, 11, 12, 14, 15, or 0 if no IRQ is desired.
This parameter is always required when configuring a card.

W# (optional) The base address of the memory window used by the enabler. This

two-digit hexadecimal number can be one of the following values: C8, CC, D0
(default), D4, D8, or DC. Use D4 for a memory window at segment D400, D8 for
a memory window at segment D800, etc. If this parameter is omitted, the default
setting of D000 will be used.

C (optional) Drive SYNC input of SCC channel A with the Remote Loopback bit of

Communications Register (see page 39). If this parameter is omitted, the SYNC
input of SCC channel A will be undefined.

If configuration is successful, the enabler will display a message showing the

configuration on the screen. If the MPAP-100 is not successfully configured, then the
information in this section along with the Troubleshooting chapter of this manual should be
consulted to determine the cause of the problem.

3.3.4 Releasing a card's configuration

Before removing a MPAP-100 from its PCMCIA socket, the enabler should be executed

again to free the system resources allocated when the card was installed. Use the 'R' parameter to
do this.

MPAP1EN (S#,R,W#)

S# The PCMCIA socket into which the MPAP-100 will be inserted. This value is a

decimal number ranging from 0 to 15. This parameter is always required when
releasing a card's configuration.

R Release the resources previously allocated to the MPAP-100. This parameter is

always required when releasing a card's configuration. This option must not be
used when configuring an MPAP-100.

W# (optional) The base address of the memory window used by the enabler. This

two-digit hexadecimal number can be one of the following values: C8, CC, D0
(default), D4, D8, or DC. Use D4 for a memory window at segment D400, D8 for
a memory window at segment D800, etc. If this parameter is omitted, the default
setting of D000 will be used.

3.4 DOS Enabler Examples

Example: Configure the MPAP-100 in socket 0 with a base address of 300H and IRQ 5.
Software control of SYNCA will be enabled.

MPAP1EN.EXE (s0,b300,i5,c)

Example: Configure the MPAP-100 in socket 1 with a base address of 300H and IRQ 3 using a
configuration memory window at segment D800.

MPAP1EN.EXE (s1,b300,i3,wd8)

Example: Release the configuration used by the MPAP-100 in socket 0.

MPAP1EN.EXE (s0,r)

Example: Release the configuration used by the MPAP-100 in socket 1 using a configuration
memory window at segment CC00.

MPAP1EN.EXE (s1,r,wcc)

4 Windows 95/98 Installation

Windows 95/98 maintains a registry of all known hardware installed in your computer.

Inside this hardware registry Windows keeps track of all of your system resources, such as I/O
locations, IRQ levels, and DMA channels. The "Add New Hardware Wizard" utility was
designed to add new hardware and update this registry.

An "INF" configuration file is included with the MPAP-100 to allow easy configuration

in the Windows 95/98 environment. Windows uses the "INF" file to determine the system
resources required by the MPAP-100, searches for available resources to fill the boards
requirements, and then updates the hardware registry with an entry that allocates these resources.
The Syncdrive DLL and VxD can then be used to access the card.

4.1 Using the "Add New Hardware" Wizard

The following instructions provide step-by-step instructions on installing the MPAP-100

in Windows 98 using the "Add New Hardware" wizard. Windows 95 uses a similar process to
load the INF file from a floppy disk with slightly different dialog boxes.

1. After inserting an MPAP-100 for the first time, the "Add New Hardware" wizard will
start. Click the "Next" button.

2. Click the "Next" button. Select the radio button for "Search for the best driver for your
device." Click the "Next" button to continue.

3. On the next dialog, select the "CD-ROM drive" checkbox. Insert the Quatech COM CD
(shipped with the card) into the CD-ROM drive. Click the "Next" button.

4. Windows should locate the INF file on the CD and display a dialog that looks like this.
Click the "Next" button.

5. Windows will copy the INF file from the CD and display a final dialog indicating that the
process is complete. Click the "Finish" button.

4.2 Viewing Resources with Device Manager

The following instructions provide step-by-step instructions on viewing resources used by

the MPAP-100 in Windows 95/98 using the "Device Manager" utility.

1. Double click the "System" icon inside the Control Panel folder. This opens up the
System Properties box.

2. Click the "Device Manager" tab located along the top of the System Properties box.

3. Double click the device group "Synchronous_Communication". The MPAP-100 model
name should appear in the list of adapters.

4. Double click the MPAP-100 model name and a properties box should open for the
hardware adapter.

5. Click the "Resources" tab located along the top of the properties box to view the
resources Windows has allocated for the MPAP-100 match the hardware configuration.
Click "Cancel" to exit without making changes.