MPAP-100 RS-232 PCMCIA SYNCHRONOUS ADAPTER for PCMCIA Card Standard compatible machines User's Manual QUATECH, INC. 5675 Hudson Industrial Parkway Hudson, Ohio 44236 Quatech MPAP-100 User's Manual TEL: (330) 655-9000 FAX: (330) 655-9010 www.quatech.
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.
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.
Table of Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.1 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2 Hardware Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 3 DOS / Windows 3.x Software Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.1 MPAP-100 Client Driver for DOS . .
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.
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).
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.
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. Client Driver Enabler File name MPAP1CL.SYS MPAP1EN.
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.
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.
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.
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.
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.
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.
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.
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.
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".
6. If changes to the automatic configuration are necessary for compatibility with existing programs, uncheck the "Use Automatic Settings" box and doubleclick on the Resource Type that needs to be changed. Caution should be used to avoid creating device conflicts with other hardware in the system. 4.3 Configuration Options If the "Use Automatic Settings" box is unchecked, various options can be enabled by selecting a different basic configuration in the "Setting based on" dropdown box.
5 OS/2 Software Installation An OS/2 client driver is provided with the MPAP-100. This client driver works with OS/2's Card and Socket Services to allow operation of the MPAP-100 under OS/2. 5.1 5.2 System Requirements OS/2 2.1 or later. OS/2 PCMCIA Card and Socket Services support must be installed. See "Installing OS/2 PCMCIA support" below if you do not already have this support installed.
addr (required) The base I/O address of the MPAP-100. This number must be a three-digit hexadecimal value ending in 0. irq (required) 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. 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. 4.
5.3 OS/2 Client Driver Configuration Examples Example: Configure the MPAP-100 at base address 300 hex and IRQ 5. Configuration will fail if any of these resources are already in use. Only one MPAP-100 can be used. DEVICE=C:\MPAP-100\MPAP100.SYS (300,5) Example: Configure the MPAP-100 at base address 300 hex and IRQ 5. Configuration will fail if any of these resources are already in use. Only one MPAP-100 can be used. Additionally, allow software control of the SYNC input of SCC channel A.
If PCMCIA support was not selected when OS/2 was installed, add it by using the Selective Install facility in the System Setup folder. Full PCMCIA support is built into OS/2 Warp 3.0 and later. On OS/2 2.1 and 2.11, PCMCIA Card Services is built in, but you must add Socket Services separately.
6 Using the MPAP-100 with Syncdrive Syncdrive is a synchronous communications software driver package designed to aid users of Quatech synchronous communication hardware in the development of their application software. Syncdrive is included free of charge with all Quatech MPA-series synchronous communication products. The MPAP-100 is backward-compatible with software written for Quatech ISA-bus synchronous adapters and it operates with Syncdrive.
7 Addressing The MPAP-100 occupies a continuous 16-byte block of I/O addresses. For example, if the base address is set to 300 hex, then the MPAP-100 will occupy address locations 300 hex to 30F hex. If the computer in which the MPAP-100 is installed is running PCMCIA Card and Socket Services, the base address is set by the client driver. If PCMCIA Card and Socket Services are not being used, the base address is set by the MPAP-100 enabler program.
8 Interrupts The MPAP-100 will operate using the interrupt level (IRQ) assigned by the PCMCIA system. Interrupts can come from the SCC, the external FIFOs or RS-232 test mode. The interrupt source is selected by bits 4 and 5 of the Configuration Register (see page 41). When using interrupts with the MPAP-100, the application must have an interrupt service routine (ISR). There are several things that an ISR must do to allow proper system operation: 1.
9 SCC General Information The Serial Communications Controller (SCC) is a dual channel, multi-protocol data communications peripheral. The MPAP-100 provides a single channel for communications, however, portions of the second channel can be utilized to support some special circumstances. The SCC can be configured to satisfy a wide variety of serial communications applications.
9.1 Accessing the registers The mode of communication desired is established and monitored through the bit values of the internal read and write registers. The register set of the SCC includes 16 write registers and 9 read registers. These registers only occupy four address locations, which start at the MPAP-100's physical base address that is configured via the on board switches. This and all other addresses are referenced from this base address in the form Base+Offset.
Example 3: Write data into the transmit buffer of channel A. mov out Example 4: dx, base dx, al ; load base address ; write data in ax to buffer Read data from the receive buffer of channel A.
WR1 Interrupt control, Wait/DMA request control WR2 Interrupt vector WR3 Receiver initialization and control WR4 Transmit/Receive miscellaneous parameters and codes, clock rate, stop bits, parity WR5 Transmitter initialization and control WR6 Sync character (1st byte) or SDLC address field WR7 Sync character (2nd byte) or SDLC Flag WR7' Special HDLC Enhancement Register WR8 Transmit buffer WR9 Master interrupt control and reset WR10 Miscellaneous transmitter/receiver control bits, NRZI,
9.2 Baud Rate Generator Programming The baud rate generator (hereafter referred to as the BRG) of the SCC consists of a 16-bit down counter, two 8-bit time constant registers, and an output divide-by-two. The time constant for the BRG is programmed into WR12 (least significant byte) and WR13 (most significant byte).
The MPAP-100 is a single-channel device. Portions of SCC channel B are used to augment channel A. Channel B cannot be used for transmit, but may be used for receive, subject to certain limitations. 9.4.1 Receive data and clock signals The receive data signals RXDA and RXDB are tied together. The receive clock input signals RTxCA and RTxCB are also tied together. This can be useful in unusual applications.
9.5 SCC Incompatibility Warnings Due to the SCC implementation used by the MPAP-100, there are two minor incompatibilities that the software programmer must avoid. 9.5.1 Register Pointer Bits In a Zilog 85230, the control port register pointer bits can be set in either channel. With the implementation on the MPAP-100, however, both parts of an SCC control port access must use the same I/O address.
10 FIFO Operation The MPAP-100 is equipped with 1024-byte external FIFOs in the transmit and receive data paths. These FIFOs are implemented as extensions of the SCC's small internal FIFOs. They have been designed to be as transparent as possible to the software operating the MPAP-100. By using these FIFOs, it is possible to achieve high data rates despite the MPAP-100 not supporting DMA. The FIFOs are disabled by default after card insertion, power-up, or a socket reset. 10.
10.2.2 Receive FIFO The receive FIFO can service the receiver of either channel A or channel B of the SCC. If RXSRC (bit 1) of the Configuration Register (see page 41) is logic 1, the receive FIFO will service SCC channel B. If RXSRC is logic 0, the receive FIFO will service SCC channel A. If the FIFOs are enabled, an I/O read from either SCC Data Port (channel A or channel B) will read a byte from the receive FIFO.
10.3.1 Using channel A for both transmit and receive This is the mode in which most applications will run. Set RXSRC (bit 1) in the Configuration Register to logic 0. This will configure the MPAP-100 to use W/REQA for receive DMA and DTR/REQA for transmit DMA. In addition to any other desired SCC configuration, ensure that the following bits are set according to Table 6: Register Bit(s) Value 7 1 6 5 1 1 1 11 or 00 0 WR14A 2 1 Enable DMA request-on-transmit on DTR/REQA.
10.3.2 Using channel B for receive The MPAP-100 supplies only limited support for SCC channel B. This mode, therefore, is not recommended for most applications. Set RXSRC (bit 1) in the Configuration Register to logic 1. This will configure the MPAP-100 to use W/REQA for transmit DMA and W/REQB for receive DMA.
10.4 FIFO status and control Several registers are used to control the FIFOs and monitor their status. These registers are detailed in other chapters of this manual. 10.4.1 Interrupt status Three interrupt statuses, listed in Table 8, can be generated by four events related to FIFO activity. In each case, a latched bit in the Interrupt Status Register is set to a logic 1 (see page 43). These bits are write-clear, meaning that software must write a 1 to a bit in order to clear it.
10.4.2 Resetting the FIFOs The FIFOs are automatically disabled and reset at powerup or when the MPAP-100 is inserted into a PCMCIA socket. The transmit and receive FIFOs can also be independently reset by setting and clearing the appropriate bits in the FIFO Control Register. Resetting a FIFO sets the appropriate FIFO empty status bit and resets the FIFO's internal read and write pointers. The SCC's internal FIFOs are not affected when the external FIFOs are reset.
To make the external FIFOs more useful in byte-synchronous modes, the MPAP-100 can watch for a given character to be transferred consecutively a specific number of times from the SCC into the receive FIFO. When this occurs, the RX_PAT bit in the Interrupt Status Register (see page 43) is set. For instance, the MPAP-100 can watch for the end-of-text character to be received, or for three consecutive pad characters to be received.
10.7 Receive FIFO timeout With asynchronous operational modes, the same problem exists. Namely, how is one to determine when a reception is complete? While the receive pattern detection may be useful here, the MPAP-100 also offers a timeout feature on the external receive FIFO.
11 Communications Register The Communications Register is used to set options pertaining to the clocks. The source and type of clock to be transmitted or received can be specified. External synchronization and RS-232 DTE test modes and can also be controlled with this register. The address of the Communications Register is Base+4. Table 9 details its bit definitions.
receive unformatted serial data, as it allows the SCC receiver to be manually placed into sync under program control. This bit is ignored if bit 6 is set (logic 1). Bit 3: RCKEN --- Receive Clock Source: When set (logic 1), this bit allows the receive clock (RCLK) signal to be generated by the TRxC pin on channel B of the SCC. When cleared (logic 0), RCLK is received on pin 17 of the DB-25 connector. In either case, RCLK is always transmitted on pin 11 of the DB-25 connector.
12 Configuration Register The Configuration Register is used to set the interrupt source and enable the interface between the SCC and the external FIFOs. The address of this register is Base+5. Table 10 details the bit definitions of the register. Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 1 0 INTS1 INTS0 0 Bit 2 Bit 1 FIFOEN RXSRC Bit 0 0 Table 10 --- Configuration Register - Read/Write Bit 7: External Data FIFOs Present --- Reserved, always 1.
Bit 1: RXSRC --- Receive FIFO DMA Source: This bit determines which SCC pins are used to control transmit and receive DMA transactions between the SCC and the external FIFOs (when enabled). The transmit data FIFO is always used with SCC channel A. The receive data FIFO may be used with SCC channel A by setting RXSRC to logic 0, or with SCC channel B by setting RXSRC to logic 1. (See page 29 for information on using channel B.) Receive DMA Transmit DMA Bit 0: Reserved, always 0.
13 Interrupt Status Register The Interrupt Status Register is used to determine the cause of an interrupt generated by the MPAP-100. The address of this register is Base+8. Table 11 details the bit definitions of the register. The interrupt source in the Configuration Register (see page 41) must be set to INTSCC for any of the statuses indicated by this register to occur. This register can be ignored if the external FIFOs are not being used.
14 FIFO Status Register The FIFO Status Register is used to return current status information about the external FIFOs. The address of this read-only register is Base+9. Table 12 details the bit definitions of the register. This register can be ignored if the external FIFOs are not being used. Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 0 RXF RXH RXE 0 TXF TXH TXE Table 12 --- FIFO Status Register - Read Only Bit 7: Reserved, always 0.
15 FIFO Control Register The FIFO Control Register is used to control the external data FIFOs. The address of this register is Base+A (hex). Table 13 details the bit definitions of the register. This register can be ignored if the external FIFOs are not being used. Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 0 EN_PAT EN_TO RX_RESET 0 0 0 TX_RESET Table 13 --- FIFO Control Register - Read/Write Bit 7: Reserved, always 0.
16 Receive Pattern Character Register The Receive Pattern Character Register is used to set the character value to be used in receive pattern detection. The address of this register is Base+B (hex). This register can be ignored if the external FIFOs are not being used. Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 character value (0-255) Table 14 --- Receive Pattern Character Register - Read/Write Bits 7-0: Receive Pattern Character: This is the numeric value of the character to be detected.
17 Receive Pattern Count Register The Receive Pattern Count Register is used to set the counter value to be used in receive pattern detection. The address of this register is Base+C (hex). This register can be ignored if the external FIFOs are not being used.
18 Receive FIFO Timeout Register The Receive FIFO Timeout Register is used to control the operation of the external receive FIFO timeout feature. The address of this register is Base+D (hex). This register can be ignored if the external FIFOs are not being used. See page 38 for details on the receive FIFO timeout feature.
19 External Connections The MPAP-100 is configured as a Data Terminal Equipment (DTE) device, meeting the RS-232-D standard using a DB-25 male connector. There is no DCE version available. The control signals the DTE can generate are Request To Send (RTS) and Data Terminal Ready (DTR). It can receive the signals Carrier Detect (DCD), Clear to Send (CTS), and Data Set Ready (DSR).
N/C 13 N/C 12 RxCLK (DTE) 11 SYNCA 10 N/C 9 CD 8 DGND 7 DSR 6 CTS 5 RTS 4 RxD 3 TxD 2 CGND 1 25 24 23 22 21 20 19 18 17 16 15 14 TM (OUTPUT) TxCLK (DTE) N/C RING RLBK (OUTPUT) DTR N/C LLBK (OUTPUT) RxCLK (DCE) N/C TxCLK (DCE) N/C Figure 2 --- MPAP-100 Output Connector The testing signals the DTE can generate are Local Loopback (LL) and Remote Loopback (RL). These signals are asserted with certain bits in the Communications Register.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 X X X X X X X X X X X X X X X X CGND TXD RXD RTS CTS DSR DGND CD N/C SYNCA RXCLK (DTE) N/C N/C N/C TXCLK (DCE) N/C RXCLK (DCE) LLBK N/C DTR RLBK RING N/C TXCLK (DTE) TEST MODE BA BB CA CB CC AB CF TxDA pin RxDA pin RTSA pin CTSA pin DCDB pin DCDA pin * * SYNCA pin RTxCA or TRxCB pin DB TRxCA pin DD LL RTxCA pin Comm. Reg. bit 5 CD RL CE DTR/REQA pin Comm. Reg. bit 4 PCMCIA STSCHG signal DA TM TRxCA pin Comm. Reg.
20 DTE Interface Signals CIRCUIT AB - SIGNAL GROUND CONNECTOR NOTATION: DGND DIRECTION: Not applicable This conductor directly connects the DTE circuit ground to the DCE circuit ground. CIRCUIT BA - TRANSMITTED DATA CONNECTOR NOTATION: TXD DIRECTION: To DCE This signal transfers the data generated by the DTE through the communication channel to one or more remote DCE data stations.
CIRCUIT CC - DCE READY (DATA SET READY) CONNECTOR NOTATION: DSR DIRECTION: From DCE This signal indicates the status of the local DCE by reporting to the DTE device that a communication channel has been established. CIRCUIT CD - DTE READY (DATA TERMINAL READY) CONNECTOR NOTATION: DTR DIRECTION: To DCE This signal controls the switching of the DCE to the communication channel. The DTE will generate this signal to prepare the DCE to be connected to or removed from the communication channel.
CIRCUIT DB - TRANSMIT SIGNAL ELEMENT TIMING (DCE SOURCE) CONNECTOR NOTATION:TXCLK (DCE) DIRECTION: From DCE This signal, generated by the DCE, provides the DTE with element timing information pertaining to the data transmitted to the DCE. The DCE can use this information for its received data.
21 Specifications Bus interface: PCMCIA PC Card Standard 2.
22 Software Troubleshooting This appendix discusses how to resolve some common problems sometimes encountered when using the MPAP-100 configuration software. 22.1 DOS Client Driver 22.1.1 Generic "SuperClient" Drivers Many Card and Socket Services packages include a generic client driver (or SuperClient) which configures standard I/O devices such as serial ports or modems.
22.2.1 With Card and Socket Services The enabler should NOT be used if any Card and Socket Services are present on the system. If Card and Socket Services is installed, the enabler may interfere with its operation and with the device(s) it controls. The client driver should be used to configure the MPAP-100 if Card and Socket Services are installed. 22.2.2 Socket Numbers The enabler requires the socket number to be specified on the command line.
The base address or IRQ value may be out of range. Make sure that the base address is a hexadecimal number between 100 hex and 3F0 hex ending in 0. Make sure that the IRQ is a decimal number between 2 and 15.
MPAP-100 User's Manual Revision 2.
