s
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
Mux_Drv_DevGuide_v07 Page 2 of 36 2006-9-27
Confidential / Released
s
General Notes
Product is deemed accepted by recipient and is provided without interface to recipient’s products. The documentation and/or product are prov ided for test ing, evalu ation, 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 max imum
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 reason abl y be ex pec ted to r esult i n pe rs on al inj ur y. Applications incorporating the d esc rib ed
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 products ,
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 whatsoever (includin g, without l imitation, dam ages for loss of busi ness profi ts, busines s interru ption,
loss of business inf ormation or dat a, or o ther pe cuni ary los s) arisi ng out t he use of or ina bility 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, inj ur y of life , bod y o r hea lth , or br ea ch of a co ndi tio n wh ic h go es to th e roo t of
the contract. However, claims for damages arising fro m a breach of a condition, which 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. Th e 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 note shall be governed an d construed according t o G er m an law wi thou t r ef erenc e
to any other substantive law.
Copyright
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 crea ted by pat ent gr an t or regis trati on of a ut ility mod el or de sign patent are reserved.
Copyright © Siemens AG 2006
Document Name:
Multiplexer Driver Develope r’ s Guide
Version:
07
Date:
2006-9-27
DocId:
Mux_Drv_DevGuide_v07
Status
Confidential / Released
Multiplexer Driver Developer’s Guide
Contents
s
Mux_Drv_DevGuide_v07 Page 3 of 36 2006-9-27
Confidential / Released
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 Propert ies 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
Multiplexer Driver Developer’s Guide
Contents
s
Mux_Drv_DevGuide_v07 Page 4 of 36 2006-9-27
Confidential / Released
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
Multiplexer Driver Developer’s Guide
List of Tables
s
Mux_Drv_DevGuide_v07 Page 5 of 36 2006-9-27
Confidential / Released
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
Multiplexer Driver Developer’s Guide
List of Figures
s
Mux_Drv_DevGuide_v07 Page 6 of 36 2006-9-27
Confidential / Released
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
Multiplexer Driver Developer’s Guide
0 Document History
s
Mux_Drv_DevGuide_v07 Page 7 of 36 2006-9-27
Confidential / Released
0 Document History
Preceding document: "Multiplexer Driver Developer’s Guide", Version 06
New document: "Multiplexer Driver Developer’s Guide" Version 07
Preceding document: "Multiplexer Driver Developer’s Guide", Version 05
New document: "Multiplexer Driver Developer’s Guide" Version 06
Preceding document: "Multiplexer Driver Developer’s Guide", Version 04
New document: "Multiplexer Driver Developer’s Guide" Version 05
Preceding document: "Multiplexer Driver Developer’s Guide", Version 03
New document: "Multiplexer Driver Developer’s Guide" Version 04
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.
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.
Chapter What is new
1.1 Updated list of supported products.
2.6 Changed description within Table 4 to cover all supported modul es. Deleted tabl es for
particular modules.
3.2 Hints on migration to different modules changed.
4.2 Updated description of the Registry values “ModemInit”, “ClosePort”, “WaitforDSR”
Chapter What is new
Throughout
manual
In several chapters, added information specific to XC18.
1.1 Updated list of supported products.
2.6 Added note regarding user profile settings
4.1 Added figure and modified descripti on.
Multiplexer Driver Developer’s Guide
s
Mux_Drv_DevGuide_v07 Page 8 of 36 2006-9-27
Confidential / Released
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.
Multiplexer Driver Developer’s Guide
1 Introduction
s
Mux_Drv_DevGuide_v07 Page 9 of 36 2006-9-27
Confidential / Released
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 t o b e par ti tio ned i nto th re e virt ual c ha nnel s. T h is a llows y ou to ta ke a dv anta ge of thr ee s i multaneous 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 Sieme ns usi ng a varie ty of appl icat ions an d platfo rms, but nat urall 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
Multiplexer Driver Developer’s Guide
1.1 Supported Product Versions
s
Mux_Drv_DevGuide_v07 Page 10 of 36 2006-9-27
Confidential / Released
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 packed into a zip file containing the compl ete source files together with correspon ding MS
Visual Studio 6.0 project files, see Chapter 6.
Multiplexer Driver Developer’s Guide
1.2 Related Documents
s
Mux_Drv_DevGuide_v07 Page 11 of 36 2006-9-27
Confidential / Released
1.2 Related Document s
[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 Telecomm unicatio ns Syste ms (Phase 2+ ); Termin al Equipment to Mobile Stati on (TE-M S)
“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
Multiplexer Driver Developer’s Guide
2 Architecture
s
Mux_Drv_DevGuide_v07 Page 12 of 36 2006-9-27
Confidential / Released
2 Architecture
2.1 Hierarchy Chart in the System
Figure 1: Driver architecture
Sessions running simultaneously
Fax application
data transfers
channel 1
(COM10)
Read battery
status
channel 3
(COM 12)
SMS functions
channel 2
(COM 11)
Terminal
COM1
direct connection
File object for
virtual COM port
File object for
virtual COM port
File obje ct for
virtual COM port
File obje ct for
physical COM1
port
Device object
"winmux2k.sys"
Multiplexer Protocol GSM 07.10
Serial.sys
port COM1
Phys. serial port
Modem
Siemens GSM
engine with
Multiplexer Protocol
User
Kernel
Hardwa re
RS-232
connection
one control channel and
data channels
Multiplexer Driver Developer’s Guide
2.2 Handling of the Physical Serial Port
s
Mux_Drv_DevGuide_v07 Page 13 of 36 2006-9-27
Confidential / Released
Figure 1 shows the driver architecture of winmux2k.sys in the operating system. The device driver winmux2k.sys
emulates virtual serial ports. The lower layer of the WinMux2k driver is the physical serial port driver (serial.sys).
The WinMux2k driver is loaded during system startup. It creates virtual port objects. The physical port is opened,
when the first virtual port is opened by an application.
If the last virtual port is closed the physical port will be released by the WinMux2k driver. This allows applications
to access the module without the WinMux2k driver.
If the WinMux2k driver is opened by at least one application a special device object is attached to the driver stack
of the serial.sys driver. This device object is used to control the power management request. It is detached from
the stack if the last handle is closed.
2.2 Handling of the Physical Serial Port
When the physical port is opened, the WinMux 2k driver ini tiali zes it. During the initi aliz ation the phys ical port is
set to hardware handshake. This means the RTS and CTS signals on the port side are controlled by the hardware
and the WinMux2k device driver. The DTR signal is set to 1. The port mode is set to 8 bits, 1 stop bit, no parity.
The baud rate can be configured using the winmux2k.inf file or the Serial Multiplexer property page. If fast baud
rates are selected (e.g. 1 15200 bps) the receive FIFO of the UAR T should be co nfigured for a size o f 8 bytes.
This can be done using the property page of the COM Port in the device manager.
2.3 Module Detection
The module supports an auto-baud mode and constant baud rates. Furthermore, the module can stay in “normal
AT command mode” or in W inMux2k mode. To e stabl ish a comm unic ation to t he module th e cor rect baud rate
and the state of the module must be found. Therefore it is recommended to set the module into auto baud mode.
If the baud rate is pr ogrammed t o a constant v alue, the drive r has to find the correct b aud rate. To do so, the
driver sends an “AT” command to the module, trying different baud rates until the correct one is found. If the module doesn’t answer to th e initial “AT” sen t at the first ba ud rate, the driver tries to disable th e possibly enable d
multiplexer mode. This is done because the module might still be kept in multiplexer mode due to an earlier failure. If this fails, the driver sends again the initial “AT” command using the next baud rate from the list of supported
baud rates. The driver must wai t for a given timeout before the decision ca n be ma de tha t the module does not
answer at any baud rate. The timeo ut value can be changed in the Windows Registry ( see “RequestTimeout”
value in Table 6). It can take som e tim e be for e the driv er fin ds the c or rect baud ra te or bef ore the dri ver fail s to
call the Open() functi on. Even i f the mod ule is not co nnecte d to t he seria l port or is turne d off, the lon g timeou t
period occurs.
If the connection to the module has been establishe d the baud rate set in the Registry is used for fur ther communications.
Closing the last port deactivates the multiplexer mode and causes the module to return to “normal AT command
mode” without multiplexe r. Also, autobauding (AT+IPR=0) wil l be enabled once again. Finally, the AT^SMSO
command will be sent to switch the module off. Only in the case of TC45 and XC18, AT^SMSO will not be sent.
Instead, TC45 and XC18 remain in “normal AT command mode” and can be quickly accessed from the PC debug
environment.
Table 1: Physical serial port
Signal Description
RTS/CTS Hardware controlled
DTR Set to 1
Baud rate Variable, parameter read from registry
Data bits 8
Parity No
Stop bits 1
Multiplexer Driver Developer’s Guide
2.4 Handling of Control Lines on Virtual Ports
s
Mux_Drv_DevGuide_v07 Page 14 of 36 2006-9-27
Confidential / Released
2.4 Handling of Control Lines on Virtual Ports
Summary of control line handling.
2.5 Limitation of Virtual Ports
Flow control can be set to RTS/CTS or DSR/DTR. XON/XOFF flow control is not supported. Hardware flow control on the virtual COM ports is handled internally by the Multiplexer Protocol.
The WinMux2k driver handles neither modem nor serenum IO-control requests.
The WinMux2k driver supports only 8 data bits, no parity, and one stop bit.
The function IOCTL_SERIAL_XOFF_COUNTER is not supported.
The following functions return “success”, but have no effect at all:
• IOCTL_SERIAL_SET_BREAK_ON
• IOCTL_SERIAL_SET_BREAK_OFF
• IOCTL_SERIAL_SET_XOFF
• IOCTL_SERIAL_SET_XON
• IOCTL_SERIAL_RESET_DEVICE
Virtual ports accept any bau d rate, th ough the c hanged settin g will be igno red. Call ing the fun ction Open() to a
virtual port can take up to 40 seconds. It fails if the module is not connected.
Table 2: Virtual serial port with Multiplexer Protocol version 2
Signal Description
RING Read from hardware port, distributed to the first virtual port
DCD Read from hardware port, distributed to the first virtual port
DSR Received with Modem Status Command
DTR Set by user, sent with Modem Status Command, initialized with 1
CTS Received with Modem Status Command
RTS Set by user, sent with Modem Status Command, initialized with 1
Table 3: Virtual serial port with Multiplexer Protocol version 3
Signal Description
RING Received with Modem Status Command
DCD Received with Modem Status Command
DSR Received with Modem Status Command
DTR Set by user, sent with Modem Status Command, initialized with 1
CTS Received with Modem Status Command
RTS Set by user, Send with Modem Status Command, initialized with 1
Multiplexer Driver Developer’s Guide
2.6 Module Initializing Sequence
s
Mux_Drv_DevGuide_v07 Page 15 of 36 2006-9-27
Confidential / Released
2.6 Module Initializing Sequence
Due to different requirements of the supported products the initialization sequence varies with the module type.
This means that when you migrate to another module type you are required to uninstall the driver and reinstall it
with the new module. The settings are taken from the winmux2k.inf file.
The tables below list the comman ds sent to the mod ule durin g the initializ ation. As the in it string info rmation is
stored in the Windows Registry the corresponding values are also listed. For further details on the Registry see
Section 4.2.
Note: The initialization sequence overrides the user profile settings defined with AT&W on channel 1 for the commands AT&S, AT\Qn and AT+ICF. Af ter restart without mult iplexer, the user profil e will be lo aded with al l your
individual settings.
Table 4: Module initialization of supported modules
Command Response Function Associated Registry
value
AT OK Detection of connected module.
AT+IPR=115200 OK Baud rate specified in the Windows
Registry during WinMux2k installation.
The value may be different according to
individual settings.
“BaudRateString”
AT OK Check if change of baud rate was suc-
cessful.
“ModemInit”
AT&S0\Q3 OK Sets DSR always on and hardware flow
control. The settings are read from the
Windows Registry.
“ModemInit”
AT+ICF=3 OK/ERROR Sets interface mode 8N1. This com-
mand works only on modules supporting different interface modes (TC35i,
TC63, TC65, MC75, AC75). The settings are read from the Windows Registry.
The resulting ERROR on modules without support of the AT+ICF command is
ignored by the WinMux2k driver.
“ModemInit”
AT+CMUX=0 OK Switches to multiplexer mode. This
sequence is read from the Windows
Registry. More AT commands can be
sent to the module at this point.
“ModemInit”
Multiplexer Driver Developer’s Guide
2.7 Module Re-initialization
s
Mux_Drv_DevGuide_v07 Page 16 of 36 2006-9-27
Confidential / Released
2.7 Module Re-initialization
If the module is disconnected or powered off during normal operation, the driver detects this and tries to reinitialize the module. Because the modul e state c an be chan ged whil e disconn ected the mult iplexer mode has to be
completely initialized. The driver checks the following situations:
• Invalid frames from the module are received.
• Timeout occurs during sending frames.
• DSR signal goes to zero, can be turned off with Registry value.
If one of these conditions is detected the driver starts the following actions:
• Try to send an MSC command to the module. If the module answers it is assumed that the module is working
and no re-initialization is required.
• Generate an RTS impulse.
• Wait for CTS to ensure that the module has been properly started after re-initialization.
• Reinitialize the module.
2.8 Power Down
The module switches to Power down mod e when the PC en ters the susp end mode or shuts dow n or when th e
last virtual port is closed. The following sections describe the behavior of the software in these three cases.
The commands sent to the module are taken from the Registry values „PowerDown” for PC suspend, “ClosePort”
for closing the last virtual port and “ShutDown” for a shut down of the PC . These values are c opied from the
“winmux2k.inf file into the Registry during installation of the driver. For further details on the Registry values see
below and Section 4.2.
2.8.1 Power Down on PC Suspend
When the PC enters the suspend mode, the module stays in multiplexer mode. A virtual channel is activated and
used to send the commands from the Registry value “PowerDown” or via the “PowerDownFrame” available from
Multiplexer Protocol version 3 onwards. All pending send requests are stopped.
When the PC wakes up the module gets an RTS impulse and the pending send buffers are re-enabled.
2.8.2 Power Down after Closing the Last Port
When the last virtual port is closed the module switches from multiplexer mode to “normal AT command mode”.
This is accomplished by sending the string s of the Registry value “ ClosePort” to the modul e (AT+IPR=0 and,
depending on the product, AT^SMSO).
If the module is switched off with A T^SMSO , the driver wait s for the DSR s ignal to go l ow after swit ch-off. Otherwise reopening a virtual port may fail because the module hasn’t finished its shutdown procedure. This behavior is supported by Multiplexer Protocol version 3 or later and enabled by the Registry value “WaitForDSR” = 1.
Due to different requirements of the supported products the Registry values “ClosePort” and “WaitForDSR” vary
with the module ty pe. By default, all module s except f or TC45 and X C18 will be switched to autobauding with
IPR=0 and then turne d o ff by AT^S MS O , with the “ Wa itFo rDSR” fe atu re be ing en abl ed . TC45 and XC18, however, will only be set to autobauding and not switche d off, and theref ore the “WaitForDSR” fea ture is disabled .
As stated in Sectio n 2.3, this default behav ior of TC45 and XC1 8 was impleme nted for faster ac cess from the
PC debug environment.
Multiplexer Driver Developer’s Guide
2.8 Power Down
s
Mux_Drv_DevGuide_v07 Page 17 of 36 2006-9-27
Confidential / Released
2.8.3 Power Down on PC Shutdown
When the PC is shut down, the multiplexer mode is turned off and the strings from the Registry value “ShutDown”
are sent to the module, if a virtual port is in use.
Note: During shutdown, some PCs may generate an impulse on the lines of the serial interface. In applications
where the DTR line connec ts to t he ignitio n line ( IGT), a n impuls e recei ved on DTR will immediate ly caus e the
module to be restarted from Power Down mode.
Multiplexer Driver Developer’s Guide
3 Installation
s
Mux_Drv_DevGuide_v07 Page 18 of 36 2006-9-27
Confidential / Released
3 Installation
3.1 Files Required for WinMux2k Driver Installation
3.2 Installing the WinMux2k Driver
Before starting the installation make sure that all files are located in the same folder as the wmuxinst.exe:
• winmux2k.inf
• winmux2k.sys
• wmuxprop.dll
1 Start the program wmuxinst.exe.
2 Ensure that the module is connected to a serial port and turn the module power on.
3 Press the “Scan” button of the application. All Siemens modules found will be listed in a box. If no modem has
been installed yet, the virtual ports can be selected. If it is properly installed, the virtual ports are shown. If at
least one modem is found, the “Install” button becomes acti ve. Pressing th is button will cau se the selecte d
modules to be installed.
4 Use the Device Manager to check that the installation was successful.
The virtual ports are available without reboot. The driver instances are visible in the device manager class “Multiport Serial Adapters”. If you wish to uninstall the driver see Section 3.3.
When migrating from TC45 or XC18 to another module type or vice versa we recommend to uninstall the driver
and reinstall it with t he new module. This way, you can take ad vantage of the module specific power dow n
sequence determined during the driver installation and executed each time after closing the last virtual port (see
Section 2.8.2 and Section 4.2).
Although it is not recommended, it is possible to modify the driver’s factory defaults by editing, prior to the driver
installation, the parameter s contained in the winmux2k.in f file. This approac h can be used, for examp le, if you
want to use another default baud rate or if y ou want to repla ce the string AT +CFUN= 0 with one of th e CYCLIC
SLEEP mode settings supported by your module, such as AT+CFUN=5 or 6 or 7 or 8 or 9. See also Section 4.2.
Note: During the installation a pop-u p dialog with "Digita l Signature Not Found" wil l appear. Plea se ignore this
message and continue the installation process. The reason for the message is that the driver has not been registered with Microsoft, but its correct functionality is ensured.
Table 5: Required driver files
File Comment
Wmuxinst.exe WinMux2k driver installation program
Winmux2k.inf INF file for the WinMux2k driver. It contains all driver settings and module specific set-
tings stored in the Windows Registry during the installation. See Section 4.2 for fur-
ther details on the Registry.
Winmux2k.sys Device driver image
Wmuxprop.dll Property page for the module, co-installer
Multiplexer Driver Developer’s Guide
3.3 Deinstalling the Driver
s
Mux_Drv_DevGuide_v07 Page 19 of 36 2006-9-27
Confidential / Released
3.3 Deinstalling the Driver
In order to uninstall the Windows Multiplexer Driver perform the following steps:
Windows 2000
1 Start the Control Panel.
2 Select System.
3 Select the Hardware property sheet.
4 Double click the Device Manager button.
5 Under Multi-port serial adapters right click Serial Multip lexer.
6 Choose Uninstall Driver and answer the confirm dialog with yes to finally uninstall the driver.
Windows XP (new desktop, not the classic desktop)
1 Start the Control Panel.
2 Under Performance and Maintenan ce select System.
3 Select the Hardware property sheet.
4 Double click the Device Manager button.
5 Under Multi-port serial adapters right click Serial Multip lexer.
6 Choose Uninstall Driver and select Yes from the Confirm File Deletion dialog.
Multiplexer Driver Developer’s Guide
4 Device Settings and Properties
s
Mux_Drv_DevGuide_v07 Page 20 of 36 2006-9-27
Confidential / Released
4 Device Settings and Properties
4.1 Settings on the Serial Multiplexer Properties Page
From the Serial Multiplexer Properties page (see Section 3.3 for deta ils wh ere to fin d the page) se lect t he Port
Settings tab. The baud rate used on the physical serial port can be changed individually.
Figure 2: Serial Multiplexer Properties page
Multiplexer Driver Developer’s Guide
4.2 Settings Stored in the Windows Registry
s
Mux_Drv_DevGuide_v07 Page 21 of 36 2006-9-27
Confidential / Released
4.2 Settings Stored in the Windows Registry
The WinMux2k driver parameters are located in the registry path
HKLM\System\CurrentControlSet\Enum\Root\winmux\000X\Device Parameters.
X is the number of the device instance.
All values lis ted bel ow wil l be c reated during the i nstal lation of th e Win Mux2k d river . The sett ings ar e pr ovided
by the winmux2k.inf file. If you want to write your own preferences to the Registry you can edit the inf file before
installing the driver.
Table 6: Registry values
Value Data (Example) Properties
BasePort COM1 The physical serial port that connects the module to the PC.
BaudRate 115200 Baud rate used on the physical port.
BaudRateString AT+IPR=115200 This string is used to set the module to the given baud rate.
Note: This string must contain the same value as the
BaudRate value.
If you select a higher baud rate be sure it is supported by the
module. For details see [3].
ModemInit AT
AT&S0
AT\Q3
AT+ICF=3
AT+CMUX=0
This multi-string value contains several AT commands
which are used to switch the module to multiplexer mode.
Possible ERROR codes resulting from unsupported commands are ignored by the WinMux2k initialization sequence.
RequestTimeout 2000 Timeout value used only during the initialization of the mod-
ule. 2000 is the maximum number of milliseconds the module can take to respond to AT requests.
VirtPort1 COM10 Name of the first virtual port. Each virtual port must have a
unique name. Otherwise the driver will fail to start up.
VirtPort2 COM11 See VirtPort1
VirtPort3 COM12 See VirtPort1
VirtualChannels 3 Number of Virtual Channels visible as COM ports. The
WinMux2k driver supports up to 3 virtual ports. The number
of VirtualChannels must be less or equal to TotalChannels.
TotalChannels 3 If the number of TotalChannels is greater than VirtualChan-
nels and no VirtPortX value for additional channels is
defined, these additional ports are not visible as COM ports.
They can be accessed by the link named
SERMUX_CONTROL_PREFIX defined in sermux_i.h. This
allows to hide virtual ports to the user. Each physical port
can have one hidden port.
WakeUpTime 4000 Timeout during module initialization. The timeout takes
effect only when the driver tries to restart the module from
Power Down or to wake it up from SLEEP mode
AT+CFUN=0. The time is given in milliseconds.
PowerCmdPort 3 This virtual channel is used to send the power down com-
mands to the module. The data state on this channel may be
disturbed during power down and cannot be reconstructed
by the driver.
Multiplexer Driver Developer’s Guide
4.2 Settings Stored in the Windows Registry
s
Mux_Drv_DevGuide_v07 Page 22 of 36 2006-9-27
Confidential / Released
ReinitOnDSR 1 0 Default for XC18
The driver does not try to reconnect to the module if DSR
changes. This feature can be switched off if an application
controls the DSR line with AT&S.
1 Default for all modules except XC18
The driver tries to reconnect to the module if DSR changes.
The driver can detect if the module was disconnected and
reinitializes it before the first data errors occur.
ClosePort
(not applicable to
TC45 and XC18)
AT+IPR=0
AT^SMSO
A multi-string sent to the module if the last port is closed.
ClosePort
(TC45, XC18 only)
AT+IPR=0 A multi-string sent to the module if the last port is closed.
PowerDown AT+CFUN= 0 A multi-strin g se nt t o th e m o dule if th e PC g oes t o su sp end
mode or hibernate state.
The command AT+CFUN=0 has been chosen as factory
default for compatibility with older Siemens products. If you
prefer to use one of the more efficient CYCLIC SLEEP
modes it can be replaced with AT+CFUN=5 or 6 or 7 or 8 or
9. See [3] and [4] to verify the SLEEP mode types supported
by your product. To avoid editing the Windows Registry you
can alter the corresponding parameter in the winmux2k.inf
file and then reinstall the driver.
ShutDown AT+IPR=0
AT^SMSO
A multi-string sent to the module if the PC is shut down or
rebooted.
Note: Some PCs generate a DTR spike during turn off and
the module wakes up again.
WaitForDSR 1 0 Default for TC45 and XC18
The driver does not wait for the DSR signal to go low when
the module is shut down. Instead, the parameter Recover-
Time (see below) is used.
1 Default for all modules except TC45 and XC18
The driver waits for the DSR signal to go low when the mod-
ule is shut down. In this case the parameter RecoverTime is
not used. If the module is not switched off with the AT com-
mands defined in the parameter ClosePort this parameter
must be set to 0.
RecoverTime 2000 Minimum number of milliseconds between close and the
next open call.
PowerDownFrame 2 From version 3 onwards, the Multiplexer Protocol supports
power saving control with a special multiplex control frame.
This provides the possibility of sending power down com-
mands to the module without accessing any data channel.
If the connected module only supports the Multiplexer Pro-
tocol version 2 this value is not used. If the supported Multi-
plexer Protocol version is 3 or higher, the multiplex power
control is used instead of the values “PowerCmdPort” and
“PowerDown”. In this case this value corresponds to the
power down command of the multiplex power down frame
described in [5]. If the value is greater than 255 there is no
power down frame sent for Multiplexer Protocol 3.
Table 6: Registry values
Value Data (Example) Properties
Multiplexer Driver Developer’s Guide
4.2 Settings Stored in the Windows Registry
s
Mux_Drv_DevGuide_v07 Page 23 of 36 2006-9-27
Confidential / Released
Optional values supported as of Multiplexer Protocol version 4, i.e. supported by the WinMux2k driver
version 3.000 or later.
The following optional values can be manually added to the Registry when needed.
MaxMuxVersion 3 This registry value provides the possibility to force the driver
to use a lower multiplex protocol version than the maximum
supported. The multiplex protocol has been improved con-
tinuously by adding several features. The multiplex protocol
version is negotiated with the connected module during mul-
tiplex startup. It is used to ensure compatibility between dif-
ferent multiplex driver and module generations. The registry
value isn’t mandatory, by default the WinMu x driv er uses
always the latest protocol implementation with all available
features. If for some reason an older multiplex protocol shall
be used it can be controlled with that registry value. For fur-
ther information about the multiplex protocol versions refer
to the “Multiplexer User’s Guide”.
HdlcWindowSize 4 Modules with multiplex protocol version 4 and above use a
kind of HDLC framing to secure the data transmission on the
virtual ports and avoid data loss at high transfer rates and
much data traffic. This registry value provides the possibility
to adjust the size of the HDLC window which defines the
maximal number of outstanding HDLC packets. It can be
between 2 and 7.
This Registry value is not mandatory. If it is not added to the
Registry the value 4 will be assumed by default. Please note
that the value is negotiated with the module.
Table 6: Registry values
Value Data (Example) Properties
Multiplexer Driver Developer’s Guide
4.2 Settings Stored in the Windows Registry
s
Mux_Drv_DevGuide_v07 Page 24 of 36 2006-9-27
Confidential / Released
The following Registry values in the path
HKLM \System\CurrentContro lSet\Services\winmux2k\Paramet ers are used to configure the TRAC E out-
puts. These values are only valid for the debug version of the device driver.
Table 7: Registry values for trace outputs
Values Data (Example) Properties
DebugBaud 57600 Baud rate: used if DebugPort is different from 0.
DebugMask 0x0000003 DebugMask determine, which reports from the device driver
are printed to the DebugPort.
Masks:
0x0000001 Errors
0x0000002 Warnings
0x0000004 Information’s
0x0000008 PnP
0x0000010 Power management
0x0000020 Data control co mma nds
0x0000040 Open/Close/Cleanup
0x0000080 Dispatch Device Control
0x0000100 Dispatch Read/Write
0x0000200 Submit control requests
0x0004000 framed data read/write
0x0008000 frequently traces submit/wrsupport
The mask 0x7 means, that all three traces are on.
The next masks are only for driver checks and represent
internal variables and states of the serial Multiplexer Device
driver.
0x0001 0000 Frame information, send and receive
0x0002 0000 Frame information, HDLC
0x0004 0000 Status information from virtual channels
0x0008 0000 Status information from Multiplexer control
channel
0x0010 0000 Output Names from WinMux2k functions
0x1000 0000 traces how and because a Request completed
0x2000 0000 traces V.24 signals and change of these sig-
nals
0x4000 0000 traces, in which state is the parser for scanning
the +++ sequence
0x8000 0000 traces states for scanning a Frame
DebugPort 0x0 0 Output from the driver is redirected to the kernel debugger.
(default value)
1...4: Output is redirected to a COM port
Multiplexer Driver Developer’s Guide
5 Settings for Applications
s
Mux_Drv_DevGuide_v07 Page 25 of 36 2006-9-27
Confidential / Released
5 Settings for Applications
5.1 Dial-up Network Settings
The dial-up network settings must be confi gured according to the requ irements of the network prov ider. The
WinMux2k driver has no special requirements.
5.2 Fax Settings
There are no special settings for the fax service of the operating systems.
Note: If the fax service is enabled for receiving fax messages, the virtual port is opened all the time. In this case
the driver cannot be disabled or unloaded. To change port settings the PC must be rebooted.
Multiplexer Driver Developer’s Guide
6 Translate Source Code
s
Mux_Drv_DevGuide_v07 Page 26 of 36 2006-9-27
Confidential / Released
6 Translate Source Code
6.1 Software Requirements
The WinMux build environ ment has been designe d to work together wit h a Microsoft Visu al Studio 6.0 SP3 or
higher and the Microsof t Wind ows XP SP 1 DDK. It is poss ible to us e a Win dows 2000 DD K as we ll, but in this
case adaptations to the different build control files might be necessary.
6.2 Preparing the Translation
1 Create the environment variables “WINMUXVSTUDIOROOT” and “WINMUXDDKROOT” containing the path
to the root of your Visual Studio and Windows DDK installation. Alternatively you can edit the file
“driver\dir_env.cmd” and enter the correct paths to the DDK and the VC 6.0 there.
2 Open the workspace sermux in the root directory. Select batch build.
3 The executable files can be found under lib\wdm\[fre|chk] _wxp_x86\i386.
Note: The DDK is a software tool for Windows driver development.
6.3 Compiler Flags
There is only one compil er flag “MUX_ MANUAL” for a c ondition al compile of the driver. Wi th this com piler flag
set the driver can be compiled in a special manual version where opening and closing of the multiplexer can be
controlled via special DeviceIoControl() commands instead of automatic control via the opened virtual channels.
This manual version is used for internal automated module testing and is not relevant for usual driver operation.
Multiplexer Driver Developer’s Guide
7 Additional Source Documentation
s
Mux_Drv_DevGuide_v07 Page 27 of 36 2006-9-27
Confidential / Released
7 Additional Source Documentation
This chapter contains add itional flow charts and state diagram s which give more detailed information on th e
structure and the content of the sources.
7.1 Interaction of the Different Driver Objects
Figure 3: Interaction of the different driver objects
Object chart of the device driver winmux2k. sys
PORT_OBJ
(virtual serial port)
Device extension
- struct DEVICE
Device object
IRP_QUEUE Read queue
Port objects DLIST
Wait Irp for serial events
Control Irp for serial driver
IRP_QUEUE Write queue
SendBuffer
RcvBuffer
WinMux object
IRP Complete object
Driver object "winmux2k"
SER_PORT
CIRCBUF Objects for circular send
and receive buffer
Buffer for read and write requests
DLIST Sendqueue
DLIST Rcv queue
Parameter for the virtual serial port
Context
SerMux
PtrSerPort[]*SerMux
SerPort0 object
ChkFrame object
WDM - Model
ANSI-C
DPOOL request pool
Multiplexer Driver Developer’s Guide
7.2 Internal Driver States
s
Mux_Drv_DevGuide_v07 Page 28 of 36 2006-9-27
Confidential / Released
7.2 Internal Driver States
Figure 4: State diagram o f the internal driver states
STATE_CLOSE_
DOWN
initial state
STATE_
VERSION_
REQUEST
this state exists
only for port 0
STATE_
CONNECT_
REQUEST
STATE_
DISCONNECT
REQUEST
STATE_
CONNECT
STATE_
VERSION_ERROR
this state exists
only for port 0
send a SABM-Frame
rcv. a TEST-command
with a VERSION Controlbyte
STATE_
DISCONNECT
Versionstring from
MS- and TS-Version are identical
not correct Version
WrDisconnectPort(),
send a DISC-Frame
rcv. a DM-Frame
WrConnectPort()
send aSABM-Frame
WrConnectPort()
send a SABM-Frame
SerMux internal states
for Ports other than port 0
receive a UA-Frame for the desired port
rcv. a DM (Disconnect)
Frame
Multiplexer Driver Developer’s Guide
7.3 Buffer Handling
s
Mux_Drv_DevGuide_v07 Page 29 of 36 2006-9-27
Confidential / Released
7.3 Buffer Handling
Figure 5: Driver internal buffer handling
SerMux
void WrIndicateReadBuffer(void *Buffer,ULONG Length);
Wrapper
SerPort 0
Write Buffer
Pool
Read Buffer
Pool
WrGetWriteBuffer(void *Buffer,ULONG &Length);
WrSubmitWriteBuffer(v oid *Buffer,ULONG
Length);
WrWriteComplete();
WrReturnWriteBuffer();
IndicateRead {
ProcessData(); // check frame, crc
SerPortIndicateFrame()
// indicate frame to a SerPort instance
}
Frame Assembly and check
state machine Demux
Send function:
while(GetWriteBuffer) {
SerPort=GetNextSerPort();
SerPort->GetFrame();
SubmitWriteBuffer();
}
Channel number
Priority with MaxSequence
Timeouts (Request Timeouts and
Scanning Timeouts)
Statistics
V24 Status from itself and the
Modem
Handshake Status
Current Read and Write Status
Circular Buffer Params
ScanSendRequest
RCV
Queue
Requests
Send
Queue
Requests
Circular
buffer
RCV
Circular
buffer
Send
Special control functions:
EstablishDLC
ReleaseDLC
CloseDown
SetModemStatus
SendVersionCommand
Circular
buffer
Send
CommandBuffer
ConfirmCommand
Buffer
if receive a Control Command
GetFrameBufferPort0() SerPort0IndicateFrame()
SerPortN
Mulitplexer Control Port 0
Timer functions:
WrTimer()
OnTimerSerPort0()
OnTimerSerPort()
Control Timeouts for Sen d and Receive Queue Requests for
repeating Control Commands and Timeouts for scanning the
Escape Sequence
Multiplexer Driver Developer’s Guide
7.4 Data Transfer
s
Mux_Drv_DevGuide_v07 Page 30 of 36 2006-9-27
Confidential / Released
7.4 Data Transfer
7.4.1 Block Flow Diagram for Data Received by the Module
Figure 6: Block flow diagram for data received by the module
SerMux functions sequence, if characters from the physical Device
to the S erMux Object are indicated
W rIndicateReadBuffer
ProcessChar
Frame valid?
Address != DLC I 0
&& U IH-Frame?
Dem uxIndicateFrame
SerPortIndicateFrame
other ports than 0
yes
yes
no
UIH-Frame?
UA-Frame
or
DM -F ra m e ?
SerPort0ConfirmRequest
no
no
yes
yes
SABM or
DISC Frame
no t v a lid
(M as te r)
SerPort0ScanUIHControl see
sheet 2,
check a UIH-ControlFrame
return SendPort
all UIH-Control
Com m ands scanned ?
search the next Control Com m and
in the
Information field
no
all by te s
scanned?
no
yes
no
no
yes
ret
SerPort0IndicateFrame()
SendPort==
TRUE?
Se rM u xS e n d(), m ust
call if receive a FC-Bit=0, then
start the sending
Multiplexer Driver Developer’s Guide
7.4 Data Transfer
s
Mux_Drv_DevGuide_v07 Page 31 of 36 2006-9-27
Confidential / Released
7.4.2 Block Flow Diagram for Data Sent to the Module via Virtual Port
Figure 7: Block flow diagram for data sent to the module via a virtual port
WrSendRequest()
Send Request Flow of a virtual Channel with
scanning of Break Signal '+++'
only the schema
ReadIntervalTime=0
TotalTIme=0
ScanFlags=0
PlusNb=0
TimeStamp=ActualTimerTick
DlistInsertHead
SerMuxSend()
end
Multiplexer Driver Developer’s Guide
7.4 Data Transfer
s
Mux_Drv_DevGuide_v07 Page 32 of 36 2006-9-27
Confidential / Released
7.4.3 SerMuxSend Function
The figure shows the flow diagram of the SerMuxSend function which sends the data to the module.
Figure 8: SerMuxSend function
SerMuxSend and SerMuxSendPort0 Functions
Locations from where to c a ll the SerMux S en d F unc tions
SerMuxSend
Send UIH-Frames from
WriteRequests to the
virtuals Ports
Function that calls from SerMux
Wrapper:
WrTimer()
WrWriteComplete()
SerMuxSendPort0
Send Control-Frames to
the Multiple xer C ont rol
Port (Channel 0)
Function that calls from SerMux
Wrapper:
WrSendReq uest()
Function that calls from SerPort0 :
EstablishDLC()
ReleaseDLC()
CloseDown()
SetMo d emS ta t u s ( )
SendVersionComm and ()
SendUAFram e()
Function that calls from ChkFrame:
SerP o rt 0 In dicateF r a me()
SerPortIndicateFrame()
Multiplexer Driver Developer’s Guide
7.4 Data Transfer
s
Mux_Drv_DevGuide_v07 Page 33 of 36 2006-9-27
Confidential / Released
Figure 9: Send function from the virtual communication ports
Send function from the virtual Communicat ion Ports
(the SerPort Object)
Function SerMuxSend() only sends UIH-Frames (unnumbered
information) which come in from WriteRequest to the virtual serial
communication port.
Start
GetFrameBufferPort
Frame ?
WrSubmitWriteBuffer
asked all Port two
times and no Frames
sent?
ret
WrGetWriteBuffer
Get
WriteBuffer?
WrReturnWriteBuffer
no
no
yes
yes
no
GetBuffer?
yes
no
yes
Multiplexer Driver Developer’s Guide
7.5 The +++-Parser
s
Mux_Drv_DevGuide_v07 Page 34 of 36 2006-9-27
Confidential / Released
7.5 The +++-Parser
The following state diagram shows the states of the +++-parser.
Figure 10: State diagram of the +++-parser
Internal states of the ScanRequest Object for scanning each
character in a Send Request for one Port Object
PLUS
PLUS_TIMEOUTWAIT_BREAK
COMP LETE_P LU S
Timeout 1s and
rcv. BreakChar '+'
if BreakCount = 3
rcv. any character
with time differences over O ne
second to the last c harac ter
or the ScanRequest Timer go to zero
in the Timer
rcv. char. unequal '+'
or Timeout 1s
or difference between current and
last Request too big
1. If the next incoming request
has a TImeout to the last request,
then switch to WAIT_BRE A K without
Timerfunction
Request-Flag =SCAN_LATER
2. if the ScanRequest Timer go to zero.
Send MSC
command with
ESCAPE =1
if receive the MS C Res po ns e
Timeout
WaitResponseTimer
if BreakCount > 0, then send first
the breaks. After ch eck fo r incoming
Request also check if Break
Count>0 and then '+' characters.
SerMuxSend(), BreakCount=0
If rcv. a SendRequest, then
Flag = SCAN_LATER
If rcv. a SendRequ est, then
Flag = SCAN_LATER
if Timer go to zero:
if STATE_PLUS then STATE_WAIT_CHAR
if STATE_PLUS_TIMEOUT then STATE_WAIT_BREAK
if Timer go to 0:
if STATE_WAIT_BREAK then STATE_WAIT_CHAR
WAIT_CHAR()
ScanRequest
->WaitResponse
Timer
ScanRequest
->Ti mer
if rcv "++" then
BreakCount +1
Multiplexer Driver Developer’s Guide
8 Known Problems
s
Mux_Drv_DevGuide_v07 Page 35 of 36 2006-9-27
Confidential / Released
8 Known Problems
8.1 Booting Operating System
Windows 2000 and Wind ows XP toggle the signals of the serial in terfaces. As a result, the module will be
switched on, even if the WinMux2 driver is not active. The driver accesses the connected module only when the
virtual ports are accessed.
If the WinMux2k driver is used by accessing one or more of the virtual ports, it switches off the module when the
last virtual port is closed again. Only TC45 and XC18 do not switch off in this case.
8.2 Shutdown of the Operating System
If the supported operati ng system has been installed in ACPI mode, the power supply will be automatically
switched off. This power down might cause pulses on those signals of the serial interfaces which are responsible
for switching the module on. This may happen, even if it had correctly switched off before by the driver.
If the module has its own power supply it might s tay swit ch ed on afte r the shut down proced ur e of the co mpu ter
has completed.
8.3 Standby of the Operating System
If the operating system has been installed in ACPI mode, it supports improved power management by also sending computer components into suspend mode. The serial WinMux2k driver supports this power management by
switching the module in to standby mode, if the dr iver is i n use by acce ssing one or more of the virtual por ts. If
the operating system has bee n prop erly c onfigure d togethe r with the BIO S, inc oming call s or re al clo ck alar ms
wake the operating system up again. During this wake up the first characters sent by the module to the operating
system via the ser ial interface are lost. This is no restricti on of the serial WinMux2k driver , but caused by the
operating system.
E.g. in case of an incoming c all the fir st RING ev ent is lost . Usually this cau ses no pr oblem bec ause th e RING
is repeated every few seconds. However, in case of the real clock alarm the module only sends one CALA URC.
As a result, the URC will not be indicated though the alarm will be correctly executed.
Additionally, in some cases when the computer switches to suspend mode, this causes pulses on the serial interface signals which wake up the module again.
8.4 Wake on Ring
If the operating sy stem is i n standby mode an d the mod ule has not been switched off, inc oming ca lls and real
time clock alarms should wake up the operating system (wake on RING). This feature belongs to the ACPI power
management mechanisms which are not properly implemented on all PC systems. It is independent of the multiplexer driver. When the ring signal toggles on the seri al interface like on incomin g calls and real time clock
alarms, this should wake up the operating system, if the PC has been properly configured. On some systems not
the RING signal but data transferred to the PC (the “RING” or “CALA” messages from the module) wake up the
operating system.
To avoid loss o f data the mul tiplexer driver swi tches on the hardware flo w control o n the mod ule. This me ans
that the module cannot send data to the PC, if the operating system is in standby mode and therefore the serial
interface is blocked by the har d war e flo w co ntr ol . As a con se que nc e the o per ati ng sys te m doe s no t wak e up, if
the system ignores the RING sign al, because the module can not send the “RING ” or “CALA” mes sages to th e
PC.
Multiplexer Driver Developer’s Guide
8.5 Special Environments
s
Mux_Drv_DevGuide_v07 Page 36 of 36 2006-9-27
Confidential / Released
8.5 Special Environments
The driver expects a module connected to the COM port in a way where the ignition signal to start the module is
connected with the D TR signal of the COM port so that the driver is able to switch th e module o n via the DT R
signal. If the driv er is used for m odules built into environmen ts where this connection do es not exist (e.g. like
laptops with a hard moun ted m odu le) i t ca nno t powe r on th e mod ul e. In t his c as e the auto mat ic powe r d own of
the module after closing the last virtual channel has to be disabled by replacing the line
HKR,,ClosePort,0x00010000,"AT+IPR=0","AT^SMSO"
with the line
HKR,,ClosePort,0x00010000,"AT+IPR=0"
In the case of TC45 and XC18, there is no need to alter the value “ClosePort” in the Registry.
8.6 Operation on Virtual USB Port
This section applies only to Siemens GSM modules equipped with a USB interface.
To configure the USB interface for use with the WinMux2k driver the virtual COM port assigned to the module’s
USB interface shall be s et to max . 1 152 00 b ps . To do so, use the
Serial Multiple xer Pr ope rties page desc r ibe d
in Section 4.1. The setting is only needed to open the virtual multiplex channels on the virtual COM port assigned
to the USB interface. There is no loss of performance because the virtual baud rate on the USB interface has no
influence on the data transfer rate.
8.7 Automatic Shutdown in case of Emergency
Please note that while Multipl ex mode is active the automatic shutd own mechanism described in [3] and [4] is
not effective. If fau lt conditions arise, such as over- and under temperature or undervoltage (over voltage shutdown is product dependent) the module shuts down after sending the alert URCs (e.g. “^SBC: undervoltage” or
“^SCTM_A/B: 2/-2”, but is then restarted by the WinMux2k driver.
Therefore, to avoid problems it is strongly recommended to close all virtual ports as soon as alert URCs are sent
by the module. Please refer to [3] and [4] as the “^SBC” and “^SCTM” URCs are product specific.
Loading...