Siemens Multiplexer Driver User Manual

Multiplexer Driver Developer’s Guide

(Windows XP/2000) Siemens Cellular Engines

Version: 07 DocId: Mux_Drv_DevGuide_v07

User’s Guide

Multiplexer Driver Developer’s Guide

Document Name:

Version: Date: DocId: Status

General Notes

Product is deemed accepted by recipient and is provided without interface to recipient’s products. The documentation and/or product are pr ovided for testing, ev aluation, integ ration and information pu rposes. The do cumentation and/or product ar e provided on an “ as is” basis onl y and may conta in deficiencie s or inadequa cies. The documentation and/ or product a re provid ed without wa rranty of a ny kind, express or implie d. To the m aximum extent permitted by applicable law, Siemens further disclaims all warranties, including without limitation any implied warranties of merchantability, completeness, fitness for a particular purpose and non-infringement of thirdparty rights. The entire risk arising out of the use or performance of the product and documentation remains with recipient. This product is not intended for use in life support appliances, devices or systems where a malfunction of the product can reas on abl y be expec ted to r es ult in pe rson al i nj ury. A pp licat ion s i nc orpor at ing the d esc r ibed product must be designed to be in accordance with the technical specifications provided in these guidelines. Failure to comply with any of the required procedures can result in malfunctions or serious discrepancies in results. Furthermore, all safet y instructions regarding the use of mobile tec hnical systems, including GSM produ cts, which also apply to cellular phones must be followed. Siemens or its suppliers shall, regardless of any legal theory upon which the claim is based, not be liable for any consequential, incidental, direct, indirect, punitive or other damages whatsoev er (includin g, without l imitation, dam ages fo r loss of bu siness pr ofits, busi ness interru ption, loss of business inf ormati on or dat a, or o ther pe cuni ary los s) ari sing out t he u se of or i nabil ity to us e the do cumentation and/or product, even if Siemens has been advised of the possibility of such damages. The foregoing limitations of liability shall not apply in case of mandatory liability, e.g. under the German Product Liability Act, in case of intent, gros s n egl ig enc e, i nj ury of l ife , bod y o r hea lth, or breach of a conditio n wh ic h go es to th e r oo t of the contract. However, claims for damages arising f rom a breach of a condition, whic h goes to the root of the contract, shall be limited to the foreseeable damage, which is intrinsic to the contract, unless caused by intent or gross negligence or based on liability for inj ury of life, body or health. T he above provision does not imply a change on the burden of proof to the detriment of the recipient. Subject to change without notice at any time. The interpretation of thi s gen er al no te sh all b e g ov er ned an d co nst ru ed ac co rdin g to German law without r ef er enc e to any other substantive law.

Multiplexer Driver Develope r’s Guide

07 2006-9-27 Mux_Drv_DevGuide_v07 Confidential / Released

Transmittal, reproduction, dissemination and/or editing of this document as well as utilization of its contents and communication thereo f to others without e xpress authorizatio n are prohibited . Offenders will be held liable for payment of damages. Al l rig hts cr ea ted by patent grant or registration of a util ity mod el or de si gn pa ten t are re served.

Mux_Drv_DevGuide_v07 Page 2 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

Contents

0 Document History....................................................................................................................................7

1 Introduction..............................................................................................................................................9

1.1 Supported Product Versions .........................................................................................................10

1.2 Related Documents....................................................................................................................... 11

1.3 Abbreviations.................................................................................................................................11

2 Architecture............................................................................................................................................12

2.1 Hierarchy Chart in the System ......................................................................................................12

2.2 Handling of the Physical Serial Port..............................................................................................13

2.3 Module Detection ..........................................................................................................................13

2.4 Handling of Control Lines on Virtual Ports ....................................................................................14

2.5 Limitation of Virtual Ports ..............................................................................................................14

2.6 Module Initializing Sequence.........................................................................................................15

2.7 Module Re-initialization .................................................................................................................16

2.8 Power Down..................................................................................................................................16

2.8.1 Power Down on PC Suspend ........................................................................................ 16

2.8.2 Power Down after Closing the Last Port........................................................................16

2.8.3 Power Down on PC Shutdown ......................................................................................17

3 Installation.............................................................................................................................................. 18

3.1 Files Required for WinMux2k Driver Installation ...........................................................................18

3.2 Installing the WinMux2k Driver.......................... ....... ...... ...... ....... ...... ....... ...... ....... ........................18

3.3 Deinstalling the Driver ................................................................................................................... 19

4 Device Settings and Properties............................................................................................................ 20

4.1 Settings on the Serial Multiplexer Prope rties Page.................................. ...... ....... ...... ....... ...... ..... 20

4.2 Settings Stored in the Windows Registry......................................................................................21

5 Settings for Applications................................................. ...... ...... ....... ...... ............................................ 25

5.1 Dial-up Network Settings............................................................................................................... 25

5.2 Fax Settings ..................................................................................................................................25

6 Translate Source Code.......................................................................................................................... 26

6.1 Software Requirements............................................................................ ...... ....... ...... ....... ........... 26

6.2 Preparing the Translation..............................................................................................................26

6.3 Compiler Flags .............................................................................................................................. 26

7 Additional Source Documentation.......................................................................................................27

7.1 Interaction of the Different Driver Objects.....................................................................................27

7.2 Internal Driver States.....................................................................................................................28

7.3 Buffer Handling..............................................................................................................................29

7.4 Data Transfer ................................................................................................................................30

7.4.1 Block Flow Diagram for Data Received by the Module .................................................30

7.4.2 Block Flow Diagram for Data Sent to the Module via Virtual Port .................................31

7.4.3 SerMuxSend Function ................................................................................................... 32

7.5 The +++-Parser.............................................................................................................................34

8 Known Problems .......... ...... ....... ...... ....... ...... ....... ...... ....... ...... ...... ....... ...... ....... ...... ....... ........................35

8.1 Booting Operating System............................................................................................................ 35

Mux_Drv_DevGuide_v07 Page 3 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

Contents

8.2 Shutdown of the Operating System...............................................................................................35

8.3 Standby of the Operating System .................................................................................................35

8.4 Wake on Ring................................................................................................................................ 35

8.5 Special Environments....................................................................................................................36

8.6 Operation on Virtual USB Port ......................................................................................................36

8.7 Automatic Shutdown in case of Emergency.................................................................................. 36

Mux_Drv_DevGuide_v07 Page 4 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

List of Tables

Tables

Table 1: Physical serial port......................................................................................................................13

Table 2: Virtual serial port with Multiplexer Protocol version 2 .................................................................14

Table 3: Virtual serial port with Multiplexer Protocol version 3 .................................................................14

Table 4: Module initialization of supported modules.................................................................................15

Table 5: Required driver files.................................................................................................................... 18

Table 6: Registry values........................................................................................................................... 21

Table 7: Registry values for trace outputs ................................................................................................ 24

Mux_Drv_DevGuide_v07 Page 5 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

List of Figures

Figures

Figure 1: Driver architecture ..................................................................................................................... 12

Figure 2: Serial Multiplexer Properties page............................................................................................. 20

Figure 3: Interaction of the different driver objects.................................................................................... 27

Figure 4: State diagram of the internal driver states................................................................................. 28

Figure 5: Driver internal buffer handling.................................................................................................... 29

Figure 6: Block flow diagram for data received by the module ................................................................. 30

Figure 7: Block flow diagram for data sent to the module via a virtual port .............................................. 31

Figure 8: SerMuxSend function ................................................................................................................ 32

Figure 9: Send function from the virtual communication ports.................................................................. 33

Figure 10: State diagram of the +++-parser................................................................................................ 34

Mux_Drv_DevGuide_v07 Page 6 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

0 Document History

Preceding document: "Multiplexer Driver Developer’s Guide", Version 06 New document: "Multiplexer Driver Developer’s Guide" Version 07

Chapter What is new

1.1 Enhanced list of supported products.

4.2 Table 6: Added optional Registry values supported as of Multiplexer Protocol version 4. Table 7: Added value 0x0002 0000 Frame information, HDLC.

6.1, 6.2 Updated requirements for Windows environment.

Preceding document: "Multiplexer Driver Developer’s Guide", Version 05 New document: "Multiplexer Driver Developer’s Guide" Version 06

Chapter What is new

1.1 Enhanced list of supported products.

8.6 Added Chapter Operation on Virtual USB Port.

8.7 Added Chapter Automatic Shutdown in case of Emergency.

Preceding document: "Multiplexer Driver Developer’s Guide", Version 04 New document: "Multiplexer Driver Developer’s Guide" Version 05

Chapter What is new

1.1 Updated list of supported products.

2.6 Changed description within Table 4 to cover all supported modul es. Delet ed tables for

particular modules.

3.2 Hints on migration to different modules changed.

4.2 Updated description of the Registry values “ModemInit”, “ClosePort”, “WaitforDSR”

Preceding document: "Multiplexer Driver Developer’s Guide", Version 03 New document: "Multiplexer Driver Developer’s Guide" Version 04

Chapter What is new

Throughout manual

1.1 Updated list of supported products.

2.6 Added note regarding user profile settings

4.1 Added figure and modified descripti on.

Mux_Drv_DevGuide_v07 Page 7 of 36 2006-9-27 Confiden tial / Released

In several chapters, added information specific to XC18.

Multiplexer Driver Developer’s Guide

Preceding document: "Multiplexer Driver Developer’s Guide", Version 02 New document: "Multiplexer Driver Developer’s Guide" Version 03

Chapter What is new

1.1, 1.2 Updated list of supported products and information about version control.

Throughout manual

Complete revision of all chapters. Added information specific to TC35i and TC45. Updated Description of Registry values.

Mux_Drv_DevGuide_v07 Page 8 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

1 Introduction

The multiplex mode accor ding to the ETSI TS 101 369, GSM 07.10 Multip lexer Protoco l enables one phys ical serial interface to be partitioned into th re e vi rt ual c ha nnel s . Th is a ll ows you to take advantage of three s i mul taneous sessions running on one serial interface. For example, you can send or receive data on the first channel, while the other two channels are free to control the GSM/GPRS engine with AT commands.

In order to properly communicate with the wireless modem, the application needs to support the Multiplexer Protocol and 3 virtual ports must be installed. For this purpose a Windows 2000/XP multiplexer driver WinMux2k can be provided. The driver of fers basic multiplexer functionality and serv es as a reference impleme ntation to aid developers and system integrators in designing, developing and testing customized multiplexer applications. As such, it has been teste d by Si emens using a var iety of appl icat ions an d platfo rms, b ut naturall y, eve n the mos t extensive test setup can never be adequate to cover all conceivable configurations.

The Siemens AG does not guarantee any support regarding the integration of the driver into a customer’s application. However, the documentation as well as code binaries and source files can be provided and used for further development.

This document describes how to install the Windows 2000/XP multiplexer driver WinMux2k in a Windows 2000/ XP based application.Related Documents

Mux_Drv_DevGuide_v07 Page 9 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

1.1 Supported Product Versions

Please note that this User’s Guide covers the three different versions of the Multiplexer Protocol. The following products support the Siemens Multiplexer Protocol version 2:

• TC35, TC35 Terminal and TC37 from Release 03.10

• MC35 from Release 03.00

•AC35

The following products support the Siemens Multiplexer Protocol version 3:

•AC43

•AC45

•MC35i

• MC35i Terminal

•MC39i

•MC45

•MC46

•MC388

•MC5x

• TC35i

• TC35i Terminal

•TC45

•XC18

•XT55

•XT56

•MC75

•TC63

•TC65

• TC65 Terminal

• WinMux2k driver earlier than version 3.000

The following products support the Siemens Multiplexer Protocol version 4:

•AC65

•AC75

•XT65

•XT75

• WinMux2k driver as of version 3.000

Where differences occur between the two Multiplexer Protocol versions or between the supported Siemens wireless modules they are particularly noted.

The Multiplexer sources are available on request. In the case you wish to receive the source code of the MinMux2k driver pack ed into a zip file containing the compl ete source files together with corres ponding MS Visual Studio 6.0 project files, see Chapter 6.

Mux_Drv_DevGuide_v07 Page 10 of 36 2006-9-27 Confiden tial / Released

Multiplexer Driver Developer’s Guide

1.2 Related Documents

[1] 3G TS 27.010, 3rd Generation Partnership Project; Technical Specification Group Terminals; Terminal

Equipment to Mobile Station (TE-MS) multiplexer protocol

[2] Digital Cellular Telec ommunica tions Syste ms (Phase 2+ ); Termin al Equipm ent to Mobile Station (TE -MS)

“Multiplexer Protocol”; ETSI TS 101 369 V7.1.0 (1999-11), GSM 07.10 Version 7.1.0, Release 1998

[3] AT Command Set of your Siemens wireless engine [4] Hardware Interface Description of your Siemens wireless engine [5] Multiplexer User’s Guide [6] MC35 Multiplexer User’s Guide (for MC35 only) [7] TC3x Multiplexer User’s Guide (for TC35 and TC37 only)

To visit the Siemens Website you can use the following link:

http://www.siemens.com/wm

1.3 Abbreviations

Abbreviation Description

ACPI Advanced Configuration and Power Interface CTS Clear to Send DCD Data Carrier Detect DDK Driver Development Kit (Microsoft driver development) DSR Data Set Ready DTR Data Terminal Ready ETSI European Telecommunications Standards Institute FIFO First in first out GPRS General Packet Radio Service GSM Global System of Mobile Communication MS Mobile Station PC Personal Computer PDA Personal Digital Assistant RI Ring Indicator RTS Request to Send TE Terminal Equipment UART Universal Asynchronous Receiver Transmitter

Mux_Drv_DevGuide_v07 Page 11 of 36 2006-9-27 Confiden tial / Released

+ 25 hidden pages