Page: 1/18
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Revision: 001
Date: 2007/01/31
Using Optitrace
Gx64 APPLICATION NOTE
Reference:
W
I_DEV_Gx64_APN_011
Trademarks
®, WAVECOM
®
, WISMO
®
, Open AT
®
, Wireless CPU
®
, Wireless Microprocessor
®
and certain
other trademarks and logos appearing on this document, are filed or registered trademarks
of Wavecom S.A. in France or in other countries. All other company and/or product names
mentioned may be filed or registered trademarks of their respective owners.
Copyright
This manual is copyrighted by WAVECOM with all rights reserved. No part of this manual
may be reproduced in any form without the prior written permission of WAVECOM.
No patent liability is assumed with respect to the use of the information contained herein.
No Warranty
WAVECOM publishes this manual without making any warranty as to the content contained
herein. Further Wavecom Inc reserves the right to make modifications, additions and
deletions to this manual due to typographical errors, inaccurate information, or
improvements to programs and/or equipment at any time and without notice. Such
changes will, nevertheless be incorporated into new editions of this manual.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 2/18
Table of Contents
1 General................................................................................................. 5
1.1 SCOPE.................................................................................................................... 5
1.2 ABBREVIATIONS AND TERMS .................................................................................. 5
2 Optitrace .............................................................................................. 6
2.1 OVERVIEW.............................................................................................................. 6
2.2 DOWNLOADING OPTITRACE ................................................................................... 6
3 Hardware .............................................................................................. 8
3.1 OVERVIEW.............................................................................................................. 8
3.2 GR64 ..................................................................................................................... 8
3.3 GS64 ..................................................................................................................... 8
3.3.1 USE WITH THE UNIVERSAL DEVELOPERS KIT..................................................... 8
4 Running Optitrace................................................................................. 9
4.1 OVERVIEW.............................................................................................................. 9
4.2 TRDATA.XML ......................................................................................................... 9
4.3 PROJECT FILES...................................................................................................... 11
4.4 MAIN WINDOW..................................................................................................... 12
4.5 TCP/IP ................................................................................................................. 13
4.6 EMBEDDED APPLICATIONS.................................................................................... 14
5 Reporting an Issue.............................................................................. 15
5.1 FIRMWARE VERSION ............................................................................................. 15
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 3/18
5.2 FIRMWARE UPGRADE ............................................................................................ 15
5.3 HARDWARE PLATFORM......................................................................................... 15
5.4 PROBLEM DESCRIPTION ........................................................................................ 15
5.5 LOCATION ........................................................................................................... 15
5.6 COPY OF SCRIPT .................................................................................................. 16
5.7 OPTITRACE LOG................................................................................................... 16
5.8 PCAP FILE (SOCKETS ONLY) .................................................................................. 16
6 References.......................................................................................... 17
6.1 OPTITRACE .......................................................................................................... 17
6.2 AT COMMANDS.................................................................................................... 17
6.3 INTEGRATORS MANUAL........................................................................................ 17
6.4 TOOLS ................................................................................................................. 17
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 4/18
1 General
1.1 Scope
This application note describes how to use the Optitrace tool used to capture debug
logging information from the GR64 or GS64. This document is meant to be used in
addition to the Integrators Manual and the AT Command Manual for the GR/GS64
wireless CPU.
1.2 Abbreviations and Terms
Abbreviation Description
EA
Embedded Applications - Customer script stored in
GR/GS64 non volatile memory which can be invoked to
control GR/GS64.
External
Application
Customer hardware and software that contain and control
the GR/GS64 via AT commands.
IDE Integrated Development Environment
GR47/48 Legacy GSM/GPRS module
QBGC Quad Band GSM/GPRS Core (GR/GS64 product line)
TCP/IP Transmission Control Protocol/Internet Protocol
APN Access Point Name
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 5/18
2 Optitrace
2.1 Overview
With the next generation Gx64 Wireless CPUs a new set of tools are required when
debugging. The platform has the ability to log debug information from all
subsystems such as SIM, GSM layer 3, SMS, CSD, etc using the Optitrace application.
If a customer has problems with the GR64 that are not easily reproduced at
Wavecom facilities then this application is designed to be easily setup on a standard
Microsoft Windows PC to capture debug information that may be analyzed by
Wavecom engineers. This tool can be downloaded from the Wavecom website.
This document provides a guide to using the application with both the GR and GS
models.
Gx64 APPLICATION NOTE
Using Optitrace
2.2 Downloading Optitrace
In order to download the files required to run Optitrace the user must have a
Wavecom.com extranet account. Optitrace can be found in the “Product” tab, in the
“G/C Series Support” product section, under the “Gx64 Software” subsection.
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 6/18
In this area of the extranet you can not only download the latest version of the
Optitrace application but also the software updater for the latest version of
firmware. In order to run optitrace you must have one additional file, the trdata.xml
file which debug trace information. This xml file must match the version of the of
the firmware currently installed on the Wireless CPU.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 7/18
3 Hardware
3.1 Overview
The GR64 and the GS64 send all debug information out via UART2. Wavecom
recommends that customers design their PCBs to allow the second UART to be
populated during the design and development phase so that debug information may
be retrieved when required. Also, debug information may be retrieved from the
second UART output of the UMA or TINA development boards.
3.2 GR64
The GR64 was designed to be as backwards compatible with the Gx4x modules as
possible. One of the major differences between the platforms was the Gx4x had
three UARTs and UART 2 was used for debugging but the Gx64 only has two UARTs.
In the GR64, the pins for the second UART are laid out where the pins for UART 3
were laid out for the GR47 (pins 43 and 44).
3.3 GS64
The GS64 has the debug UART lead out of pins 63 and 64.
3.3.1 Use with the Universal Developers Kit
When using the universal developers kit with the GS64 adaptor boards you should
move the jumpers X501 and X502 to the SEC PORT position, this is due to the
second UART being routed out through the UART2 pins on the GR47 system
connector.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 8/18
4 Running Optitrace
4.1 Overview
This section will describe how to setup and run Optitrace after it has been installed.
4.2 TRdata.xml
For each build of software that is loaded onto the module a file called trdata.xml is
created. The purpose of this file is to tell optitrace what traces have been activated
within the build, without the correct file optitrace will be unable to interpret the
information coming out of the unit. The software revision currently loaded on the
Wireless CPU can be found by typing “AT+CGMR”.
Prior to running optitrace the trdata.xml file for the corresponding build on the
module should be placed in the optitrace directory as shown in the windows
explorer screen shot below. Once you have downloaded the file from the extranet,
rename the file to “trdata.xml” and copy it to the directory that holds Optitrace.exe.
If you would like to work with more than one firmware version please review the
Optitrace users manual installed with the application.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 9/18
When the module is turned on and you are able to see logging data running through
the window, the two check sums, Trace table CRC and Mobile CRC should match, if
they do not then the trdata.xml file does not correspond with the build of software
that is on the module.You can tell what the value of the XML CRC and the CRC the
module expects in the bottom left hand corner of the application. If you see a red
box with an “X” through it, you are using the wrong trdata.xml file. See below for an
example.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 10/18
Currently pointing to the correct trdata.xml file.
Currently pointing to the wrong trdata.xml file.
4.3 Project Files
When Optitrace is run the first window that will be presented forces you to select a
trace project file. Essentially this is a file that holds filter sets to set which debug
information the Wireless CPU will send to the host. Default filter that is supplied is a
good starting point. But, if a problem has been reported to your FAE then you may
be provided a project file that has filters turned on to output information required
by Wavecom engineering to debug the problem.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 11/18
Attached to this document is a project file that is useful as a starting point for
tracking down a problem. This project file contains a filter called
“AT_EA_IP_AllErrorsWarnings” because it has all errors and warnings in the system
turned on. Therefore, when reporting a problem it will help Wavecom engineers
start to narrow down the source of the issue.
CustTest.trproj
4.4 Main Window
Through the main window you are able to see all of the traces that are being sent
from the Wireless CPU to the host PC. Beyond this the main controls that are you are
to know about to log information from the module are as follows.
• File
o Save project settings as – This will save the current filter settings to a file
named by you.
• Serial
o Settings – Controls the settings of the port, the default is 115200bps and
this is correct for the module.
• Trace log – This menu controls the saving of the actual log file that has been
taken.
• Start/Stop button – The short cut button on the top left of the screen starts and
stops Optitrace logging.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 12/18
4.5 TCP/IP
In addition to printing the out debug print statements, the Optitrace tool has the
ability to output a PCAP file when you are doing IP transfers. If you are having
problems with sending or receiving TCP/IP traffic then reading the PCAP file from
the module will tell you what data the module sent and received. The PCAP file is
generated when the IPTracePackets filter, in the Internet Protocol Trace Group, is on.
In version 1.4.2 of Optitrace, toggling the connection to off [past red-grean light
here] isn’t good enough to generate the PCAP file. The application must be
shutdown after taking the trace for the PCAP file to be generated.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 13/18
4.6 Embedded Applications
Optitrace is also used to enable debugging of the embedded applications if you are
using it. To enable the prtf traces to be received by Optitrace the following needs to
be set in the filters.
GS – GLTraceHigh
It is recommended that the following is also set as it gives an insight into what is
happening internally to the embedded applications interpreter which might in turn
help with debugging the software.
Wavecom - EmbeddedAppsError
Wavecom - EmbeddedAppsWarning
Wavecom - EmbeddedAppsCommandInfo
Wavecom – EmbeddedAppsCommandFunction
Note : If you are using the prtfdir function to redirect the traces to UART1 then you
do not need to use Optitrace, in this case you only require a terminal program. If the
UART is set to auto baud then terminal will need to send ‘at’ to the unit so that it
knows what baud rate to output the debug information.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 14/18
5 Reporting an Issue
When reporting an issue with the GR64 or GS64 firmware there are a lot of items
that Wavecom support needs to know about to help us resolve your issue as quickly
as possible. If these information items can be included in the initial trouble report it
will cut down on the amount of time required to understand the problem.
5.1 Firmware Version
On all correspondence involving issues must include the firmware revision number.
If you don’t know your software version number you can get it by typing in the AT
command “AT+CGMR”.
5.2 Firmware Upgrade
Before reporting any issue please check the extranet to see if a later version of
firmware is available. If so, please attempt to reproduce the problem in the latest
software release. Your problem may have already been solved, or feature added, in a
later revision. The release notes will specify what fixes were made in the latest
version. If you firmware version is old there is a good possibility that any problem
you’ve experienced has already been solved.
5.3 Hardware Platform
What hardware are you using when the problem occurs? Is it a Wavecom
development board or a proprietary system? Does this platform have a second
UART?
5.4 Problem Description
Please provide as much detail as possible describing what the symptoms of the
problem are and how to reproduce the problem.
5.5 Location
If the fault happens while the module is moving (i.e. field testing) then please give
as much information as possible on what route the module took and where the
problem occurred. This includes the country, city, and the Carrier or Operator being
used.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 15/18
5.6 Copy of script
If you are using Embedded Apps please include a copy of the script you were
running when the problem occurred. If the problem happened with AT commands
please send a listing of the AT commands entered and their response. If the scripts
hold proprietary information then please provide a script or AT sequence that
reproduces the problem but doesn’t include your proprietary code. Without a copy
of a script or AT command sequence that reproduces the problem there will be
significant delays in resolving the problem.
5.7 Optitrace Log
In addition to the script, it is important to include a copy of an Optitrace log that
shows the problem. There are many filters provided in the CustTest.trproj file.
Please indicate which filter set you used in the provided log. Feel free to send the
entire log, even if large, but please use Zip to compress large files. If you have
changed the project file then feel free to send it as well. If the filter set used didn’t
include enough information to locate the source of the problem there may be times
when it is required to retest the failure using a new project file specifically designed
by the Wavecom engineering team to provide more information in the important
areas.
5.8 PCAP File (Sockets Only)
If you are doing socket development then it is important to also include the PCAP
file that is generated in the Optitrace home directory. Also, if you own the IP server
that you are communicating with then providing a PCAP file of the server side is very
helpful as well.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 16/18
6 References
6.1 Optitrace
Optitrace Includes a Users Manual that is installed with the application.
6.2 AT Commands
AT Command Manual
Application Note for Socket AT Commands
6.3 Integrators Manual
Integrators Manual holds information on memory limitations of Embedded
Applications scripts.
6.4 Tools
An important tool for TCP/IP debugging is Ethereal (http://www.ethereal.com/).
This application is used for reading PCAP files generated by Optitrace and creating
IP traces from your IP servers.
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
Page: 17/18
Page: 18/18
Gx64 APPLICATION NOTE
Using Optitrace
T
his document is the sole and exclusive property of WAVECOM. Not to be distributed or divulged without prior written agreement.
Ce document est la propriété exclusive de WAVECOM. Il ne peut être communiqué ou divulgué à des tiers sans son autorisation préalable
WAVECOM S.A. - 3 esplanade du Foncet - 92442 Issy-les-Moulineaux Cedex - France - Tel: +33(0)1 46 29 08 00 - Fax: +33(0)1 46 29 08 08
Wavecom, Inc. - 430 Davis Dr. Suite 300 - Research Triangle Park, NC 27709 - USA - Tel: +1 919 237 4000 - Fax: +1 919 237 4140
WAVECOM Asia Pacific Ltd. - Unit 201-207, 2
P
nd
P
Floor - Bio-Informatics Centre - No. 2 Science Park West Avenue - Hong Kong Science Park,
Shatin - New Territories, Hong Kong - Tel: +852 2824 0254 - Fax: +852 2824 0255
-
1
-
2
-
3
-
4
-
5
-
6
-
7
-
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
