- DL manuals
- Quatech
- Software
- MPAP-100
- User Manual
Quatech MPAP-100 User Manual
Summary of MPAP-100
Page 1
Syncdrive plus communications software user’s manual quatech, inc. 662 wolf ledges parkway akron, ohio 44311 toll free: 1-800-553-1170 tel: (330) 434-3154 fax: (330) 434-1409 http://www.Quatech.Com syncdrive plus user’s manual p/n: 940-0184-100 connect with reliability.
Page 2
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 ...
Page 3
Quatech syncdrive plus user’s manual table of contents rev 01 (2/6/2003) page i table of contents introduction----------------------------------------------------------------------------------------------------------------------- 1 system requirements ------------------------------------------------...
Page 4
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 .......................................
Page 5
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 inclu...
Page 6
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. Thi...
Page 7
Quatech syncdrive plus user’s manual introduction rev 01 (2/6/2003) page 3 figure 3 - install hardware device drivers screen 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...
Page 8
Quatech syncdrive plus user’s manual introduction rev 01 (2/6/2003) page 4 figure 5 - insert installation disk prompt 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 200...
Page 9
Quatech syncdrive plus user’s manual introduction rev 01 (2/6/2003) page 5 figure 7 - driver files search results screen 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....
Page 10
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 ...
Page 11
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 ...
Page 12
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 cal...
Page 13
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 c...
Page 14
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 len...
Page 15
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 byte...
Page 16
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, tr...
Page 17
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, *pmp...
Page 18
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 v...
Page 19
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 ...
Page 20
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 belo...
Page 21
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 17 examples use of the syncdrive plus api functions is demonstrated in the numerous example programs supplied on the syncdrive plus cd- rom. These example programs are described in the using ...
Page 22
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 18 mpa_getconfig () continued return, cont.: err_device_ not_opened device was not opened with mpa_open(). Err_invalid_ struct_size the structure size in structlen did not match size in drive...
Page 23
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 19 mpa_getdata() continued return, cont.: err_incorrect_ num_bytes_read for non-overlapped i/o only. Bytes received differ from requested. Not necessarily an error if a larger buffer was allo...
Page 24
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 20 mpa_getdriverversion () continued return, cont.: err_invalid_ struct_size the structure size in structlen did not match size in driver. Err_ioctl_error communication error occurred between...
Page 25
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 21 mpa_getframesize () gets the size of the oldest received frame syntax: mpadll_api mpa_error_code mpa_getframesize ( in const pmpa_handle phandle, out pmpa_frame_size pframesize ); descript...
Page 26
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 22 mpa_getmodemcontrol signals () continued return: err_device_not_ opened device was not opened with mpa_open(). Err_invalid_ struct_size the structure size in structlen did not match size i...
Page 27
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 23 mpa_gettransferstatus() continued return: err_transfer_ status driver failed to return correct status to dll. Could indicate hardware failure. Parameters: phandle handle to the open device...
Page 28
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 24 mpa_open () continued parameters, cont.: devicenumber the number specifying which device to open. For systems with a single card installed, this will always be 0. For 2-card systems, selec...
Page 29
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 25 mpa_putdata () continued parameters, cont.: pbuffer pointer to a caller-supplied buffer of data to be transferred. Each call to mpa_putdata() sends the data in the buffer as a complete fra...
Page 30
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 26 mpa_setconfig () sets the configuration and gets the resulting configuration syntax: mpadll_api mpa_error_code mpa_setconfig ( in const pmpa_handle phandle, in const pmpa_config pconfigin,...
Page 31
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 27 mpa_setmodemcontrol signals() sets the modem control signal(s) and gets resulting configuration syntax: mpadll_api mpa_error_code mpa_setmodemcontrolsignals ( in const pmpa_handle phandle,...
Page 32
Quatech syncdrive plus user’s manual syncdrive plus application programming interface rev 01 (2/6/2003) page 28 mpa_setnodeaddress () sets the sdlc node address and/or enables addressing syntax: mpadll_api mpa_error_code mpa_setnodeaddr ( in const pmpa_handle phandle, in pmpa_node_address paddrin, o...
Page 33
Quatech syncdrive plus user’s manual using example programs rev 01 (2/6/2003) page 29 using example programs quatech supplies numerous small console application example programs with syncdrive plus. These examples cover the various operating modes of the product. We also supply source code and execu...
Page 34
Quatech syncdrive plus user’s manual using example programs rev 01 (2/6/2003) page 30 recbi2k this program receives single frames and runs in bit-synchronous mode. You can use it in tandem with sendbi2k running on another computer by connecting two mpa-series adapters with a crossover cable. You can...
Page 35
Quatech syncdrive plus user’s manual troubleshooting rev 01 (2/6/2003) page 31 troubleshooting verify that the hardware is configured properly a good first step in solving problems is to make sure that there are no hardware conflicts. One way to do this is to try a known-good syncdrive plus applicat...
Page 36
Quatech syncdrive plus user’s manual error codes rev 01 (2/6/2003) page 32 error codes the definitive source for error codes is the quadef.H include file. The error codes for release 1.00 are duplicated here for convenience. The significance of the error code depends on the function returning it. Se...
Page 37
Quatech syncdrive plus user’s manual appendix a – definitions rev 01 (2/6/2003) page 33 appendix a definitions term definition api (application programming interface) an application program interface is the specific method prescribed by a computer operating system or by an application program by whi...
Page 38
Quatech syncdrive plus user’s manual appendix a – definitions rev 01 (2/6/2003) page 34 term definition frame in telecommunications, a frame is data that is transmitted between network points as a unit complete with addressing and necessary protocol control information. A frame is usually transmitte...