You are on page 1of 46

Catcher

1 Overview ...........................................................................................................3
1.1Overview of MTK Catcher MTK Catcher ............................................................................................................................................................................3
1.2 Using Catcher: Logging mode Catcherlogging ...........................................................................................................................................................5
1.3 Using Catcher: Off-line mode CatcherOff-line ...........................................................................................................................................................7

2 Frame Window and Dialogs ...................................................8


2.1 Trace & Primitive Log Window Trace & Primitive Log ..........................................................................................................................................................8
2.2 Sys Trace Window ..................................................................................................................................................................................................12
2.3 Err Msg Window .....................................................................................................................................................................................................14
2.4 MSC View Window MSC...................................................................................................................................................................16
2.5 Filter Dialog Filter ..............................................................................................................................................................................................................18
2.6 Engineering Mode Dialog ...................................................................................................................................................................................21
2.7 Sim Editor Dialog Sim ............................................................................................................................................................................................24
2.8 Exception Window ..........................................................................................................................................................................................................26
2.9 Statistics Window ...................................................................................................................................................................................................28

3 Menus ..............................................................................................................30
3.1 File menu ........................................................................................................................................................................................................................30
3.2 Edit menu ........................................................................................................................................................................................................................32
3.3 View menu ......................................................................................................................................................................................................................33
3.4 Control menu ..................................................................................................................................................................................................................35
3.5 Config menu ...................................................................................................................................................................................................................36
3.6 Advance menu ................................................................................................................................................................................................................37
3.7 Window menu .................................................................................................................................................................................................................39
3.8 Help menu .......................................................................................................................................................................................................................40
3.9 Tool Bar ...............................................................................................................................................................................................................................41
3.10 Command Tool Bar ...................................................................................................................................................................................................44

3.11 AT Command Tool Bar AT ........................................................................................................................................................................................45


3.12 Auto-Clear Tool Bar -........................................................................................................................................................................................46

1 Overview
1.1 Overview of MTK Catcher MTK Catcher
Catcher is a PC-side tool for MTK GSM/GPRS Products. The main function
of Catcher is for logging primitives and debug information.

The wireless protocol stack is composed of different modules. Each module


uses primitives (messages) to communicate with other modules through SAP
(service access point). Catcher can log these primitives by setting the correct
filters. Modules also use trace functions to display the debug information on
Catcher.

The structures of the primitives are parsed and collected during the
target-build process. An information-database will be generated after the process,
so Catcher can use the database to display primitives. Its important for catcher to
use the correct database. Using a mismatched database will result in confusion
and a wrong logging file.

Catcher has two operation modes: logging mode and off-line mode.

Catcher PC MTK GSM/GPRS


primitives debug

module module
primitivesmessages SAP module
filtersCatcher primitives log Modules trace
debug

target-build primitives
catcher primitives
catcher
logging

Catcher logging off-line


For logging mode, Catcher needs the database generated during the
target-build process. After setting the correct database, engineers can connect to
the target and set the filters for the information, which they want to analyze. All
the setting can be saved in a workspace file. The primitives and debug
information can be saved to a log-file.

Engineers can open the Engineering Dialog to see the data of the mobile
phone. SIM-Editor can be used to retrieve and set the data in the SIM Card.

During logging, Catcher also provides a facility to send " Proprietary


command" and "AT command" to modules of protocol stack. Protocol engineers
are therefore able to instantly control the states and behaviors of modules of
protocol stack. Engineers can also retrieve the exception and statistics
information of the mobile phone by using the menu commands on Catcher.

For off-line mode, engineers can open a log-file and analyzed the log
information. Off-line filters can be set to display the most useful information.
Catcher also supports the MSC View of the primitive log.

logging catcher target-build


target
filters workspace Primitives
debug log

Engineering Dialog
SIM SIM

logging catcher
module Proprietary AT
module Catcher
exception

Off-line log log


Off-line filters Catcher primitive log MSC
View

1.2 Using Catcher: Logging mode Catcherlogging


To enter the logging mode, users can open a pre-saved workspace in the
menu [File/Open Workspace] for logging mode, or do the following steps:

1.
Start Catcher and set the correct database.
On the Config menu, click Set Database Path to open a database, which
match the target-load on the mobile phone.

2.
Select the Logging mode.
Select the logging icon on the Toolbar or use the menu [Control/Mode].

3.
Modify the com port settings.
Select the configure RS232 icon on the Toolbar or use the menu
[Config/Configure RS232].

4.
Connect to the target.
Select the Connect and sync icon on the Toolbar or use the menu
[Control/Connect].
Make sure the serial line is connected to the target correctly before this
step.

5.
Set the filters.

logging [File/Open Workspace]


workspace

1. Catcher
Config/Set Database Path
target-load

2. logging
logging [Control/Mode]

3. com port
RS232 [Config/Configure
RS232]

4. target
Connect and sync
[Control/Connect]
target

Select the Filter icon on the Toolbar use the menu [Control/Set Filter].
Be careful not to turn on too many filters that exceed the RS232
bandwidth, or data lost will happen. Please refer to the setting of the
Filter.

6.

Start logging.
The primitives and trace information will be displayed on the Trace &
Primitive Log Window.
After logging, users may want to save the logged information in the
menu [File/Save Log] and save all the workspace settings in [File/Save
Workspace].

5. filters
Filter [Control/Set Filter]
filters RS232
Filter

6. logging
Primitives trace Trace& Primitive Log
Logging [File/Save Log] logged
[File/Save Workspace] workspace

1.3 Using Catcher: Off-line mode CatcherOff-line


To enter the off-line mode, users can open a pre-saved workspace in the
menu [File/Open Workspace] for Off-line mode, or do the following steps:

1. Start Catcher and open a log file (.clg).


On the File menu, click Open to open a log file (.clg).

2. Set the off-line filters.


Select the Filter icon on the Toolbar or use the menu [Control/Set
Filter].
Please refer to the setting of the Filter.
You can save all the workspace settings in [File/Save Workspace].

off-line [File/Open Workspace]


Off-line

1. Catcher log .clg


File/Open log .clg

2. off-line filters
Filter [Control/Set Filter]
Filter
[File/Save Workspace] workspace

2 Frame Window and Dialogs


2.1 Trace & Primitive Log Window Trace & Primitive Log
This child frame window, which split into 2 views, is dedicated for Trace &
Primitive Log. The top view will display the received Traces and Primitive Log
together, and only summary information of them are displayed. The summary
information includes type, index, frame number, time, source module, destination
module, sap/class name, and message ID. In the type column of this top view,
different icon is used for identifying the type of logged information.

When users select one Trace or Primitive Log in the top view, the
corresponding details will be displayed in the bottom view. In addition, if the
selected item is a Primitive Log, it will show the description of each field,
including its value and data type. Users can also set the text color of each data
type for the bottom view (See Filter Dialog). Besides, users can set the number of
display columns for both the views by mouse right clicking.

There are two different styles for this frame window. The first style shows
all the logged information in an integrated window: all the Traces and Primitive

Trace & Primitive


Traces Primitive Log
frame module modulesap/class
type logged

Trace Primitive Log


item Primitive Log
field
Filter Dialog

logged Traces Primitive Log

log are displayed in only one window. The second style shows the logged
information in separated windows: each window is dedicated for each module,
and only shows the logging messages dumped by itself. (See Config Menu).

Users can click the right mouse button to change settings or execute
commands:

Upper view

logged module
dump logging Config Menu

Scroll

Save to Clg
Save to Text
Customize

If the view is scrolled after receiving new Trace or


Primitive Log.
The selected messages and those corresponding
messages will be saved to the specific clg file.
The selected messages will be saved to the specific
text file.
It will pop up a dialog to set which column to be
displayed.

Lower view
Expand
Decode Peer
Save to Text

Clg

Trace Primitive Log

Text

clg
text

If the tree structures of local parameter/peer buffer


are expanded.
If the peer buffer will be decoded by MCD.
The raw data will be saved to the specific text file by

/peer buffer

Peer

peer buffer MCD


?

Customize
Customize Expand

tree format.
It will pop up a dialog to set which column to be
displayed.
It will pop up a dialog to set the number of
expanding layers.

Column Description
Type
Index
Frame # / Time
Local Time
Source / Destination
Message / SAP Name

Message type (Trace/Primitive Log).


The message index in this window.
The sending time of this message.
The received time of this message on PC host.
Which module sends message to which module.
Name of message / SAP or trace class.

# /

/
/SAP

Trace/Primitive Log

PC host
module module
/SAP trace class

2.2 Sys Trace Window


This child frame window is dedicated for system-dumped messages.
Users can click the right mouse button to change settings or execute commands:

Pop-up Menu Description


Scroll
Save Selected to Clg
Save Selected to text
Save all to text

If the view is scrolled after receiving the new


Sys_Trace messages.
The selected Sys_Trace and those corresponding
messages will be saved to the specific clg file.
The selected Sys_Trace will be saved to the specific
text file.
All the received Sys_Trace will be saved to the
specific text file.

Column Description
Frame # / Time
Local Time
Message

The sending time of this message.


The received time of this message on PC host.
Message content.

-dump

Sys_Trace

Clg

Sys_Trace
clg
Sys_Trace

Sys_Trace

# /

PC host

2.3 Err Msg Window


This child frame window is dedicated for catcher-dumped error messages.
Users can click the right mouse button to change settings or execute commands:

Pop-up Menu Description


Scroll
Save Selected to Clg
Save Selected to text
Save all to text

If the view is scrolled after receiving the new error


messages.
The selected error messages and those corresponding
messages will be saved to the specific clg file.
The selected error messages will be saved to a specific
text file.
All the received error messages will be saved to the
specific text file.

Column Description
Local Time
Message

The received time of this message on PC host.


Message content.

catcher-dumped

Clg

clg

PC host

2.4 MSC View Window MSC


The MSC View, which is dedicated for Primitive Log displays the message flow
in graphic mode. It uses arrows to describe the message directions, and the
sending time will also be included . If the message name cant be totally shown,
you can move cursor to the position of the message and then a tool tip will be
popped up.

Furthermore, it provide the following functionalities for users:

Functionalities
Description
Zoom In / Out
Change
modulesposition
Copy
the
current
screen
Sync with Trace &
Primitive Log Window

Change the y-axis scale by clicking menu or toolbar.


Drag the selected module and drop to another
module.
Click menu [Edit / Copy] or button [Copy].
Click the message in MSC View, and then the
corresponding Primitive Log in Trace & Primitive
Log Window will be selected.
Click the Primitive Log in Trace & Primitive Log
Window, and then corresponding message in MSC

MSC Primitive Log

tool tip


module

y
moduledrop to module

Edit / Copy Copy

Trace & Primitive


Log

MSC Trace & Primitive Log


Primitive Log

Trace & Primitive Log Primitive


LogMSC

View will be selected.

2.5 Filter Dialog Filter


The filter dialog, which is composed of two property pages, is used to set
online/offline filters and background color for Trace & Primitive Log Window.
[Online filters]: It means during the connection period in the online mode.
[Offline filters]: It means in the offline mode.

Description

Property page

Filter online/offline filters Trace &


Primitive Log

Online filters online

Offline filters offline

The first property page is used to set filters for L1


Trace. You can set filter on/off for different trace
classes of each L1 module (class-level).

L1 Trace filters
L1 module class
traceclasses filter

The second property page is used to set filters for


Trace & Primitive Log. You can set filter on/off for
different trace classes of each PS module
(class-level); and choose different SAP levels for PS
primitive log (SAP-level).
In other words, the filter of PS primitive is
determined by two conditions: if the SAP level is
greater than 0 and if the source module filter is on.
Furthermore, you can configure the background
colors: [Trace]: It depends on the color of its trace
class.[Primitive Log]: It depends on the color of its
SAP.

Trace & Primitive Log


filter PS moduleclass-level
trace classes filter PS
Primitive logSAP SAP
PS primitive condition
SAP 0 module filter on
[Trace] trace class
[Primitive Log] SAP

2.6 Engineering Mode Dialog


After entering Engineering mode, each protocol module is supposed to report
status and information either periodically or whenever information was changed.
The following property pages will display the information in text or graphic
mode.
Description
The first property page is used to display the
information of serving cell.

Property page

module

serving cell

The second property page is used to display the


information of serving cell and neighbor cell.

serving cell cell

The third property page is used to display the


information of top 10 power level cell.

top10 power level cell

The forth property page is used to display the power


level history in recent 10 minutes. When the cell is
changed, it will show a white-circle with new arfcn.
You can click the [Zoom In/Out] button to change
the scale of Y-axis, then use mouse wheel or left
button drag to move the picture. Besides, the
visibility of each curve can be configurable at the
right side on the bottom.

10 power level
cell arfcn
Zoom In/Out Y

The fifth property page is used to display the other


related information about module MM, CC, SS etc.

MM, CC, SS
module

2.7 Sim Editor Dialog Sim


Sim editor provides two ways to access the files of SIM card. The one on the top
is the general UI, which provides three functions:

Function
Description
Input
1. File information Get file size and number of File id
records.
2. Read
Read the file content from File id, Length and
SIM.
Record
3. Write
Write the file content to SIM. File id, Length, Record
and Data

Otherwise, it also provides the dedicated UI to access the specific files on the
bottom. It supports three functions:

Function
Description
Input
1. Connect
Read out all these files from
SIM.
2. Write
Write the file content to SIM. Data
3. Reset
Reset the file content to 0xff.

Sim SIM top general UI

1.

id
2.

SIM

id

3.

SIM

id

UI

1.
SIM
2.
SIM

3.
0xff

item copy/paste


Furthermore, both of the data item can be selected and use copy/paste to itself or
to system clipboard.

2.8 Exception Window


After connecting with target, if there are valid exception records in NVRAM,
Catcher will receive the notice messages and show them in the Sys Trace
Window. It provides two ways to get the information of exception:

Type
Click
Description
Online
Advance/Ret
It is used to read/reset exception records from
rieve Exception NVRAM. After users click the [Read] button,
Catcher will receive the corresponding Primitive
Log then decode these exception records by
different structures according to its exception
type.
Offline
Advance/Show It is used to decode the raw data into tree
Exception
structures. Users have to select the Primitive Log
(READ_CNF for exception) in the Trace &
Primitive Log Window, and then click this item to
show the exception records in tree format.

NVRAM Catcher
Sys Trace

Online
/ NVRAM /[Read]

Catcher Primitive Log

Offline
/ Trace
& Primitive Log Primitive Log (

READ_CNF) item

2.9 Statistics Window

System statistics is used to analysis the system information for users. Like
exception handling, it also provides two ways to get the information of system
statistics:

Type
Click
Description
Online
Advance/Retrieve It is used to read/reset/clear flag for
Statistics
statistics records in NVRAM. After users
click the [Read] button, Catcher will
receive the corresponding Primitive Log,
and then decode the statistics records by
predefined structures.
Offline
Advance/Show
It is used to decode the raw data into tree
Statistics
structures. Users have to select the
Primitive Log (READ_CNF for system
statistics) in the Trace & Primitive Log
Window, and then click this item to show
the statistics records in tree format.

handling

Online
/ // flag NVRAM

[Read]Catcher
Primitive Log

Offline

Trace & Primitive Log


Primitive Log (
READ_CNF) item

3 Menus
3.1 File menu
The File menu offers the following commands:

Open
Use this command to open a existing log file.

log

Close
Use this command to close the active document.

Open Workspace
Use this command to open a existing workspace file.

workspace
workspace

Save Workspace
Use this command to save the workspace.

Workspace
workspace

Save Log
Use this command to save the logging messages.

Log
logging

Save Log As
Use this command to save as the logging messages.

Log
logging

Recent Logs
Use this command to open a recent log file.

Logs
log

Recent Workspaces
Use this command to open a recent workspace file.

Workspaces
workspace

Exit
Use this command to quit the application

3.2 Edit menu


The Edit menu offers the following commands:

Cut
Use this command to cut the selection and move it to the clipboard.

Copy
Use this command to copy the selection to the clipboard.

Paste
Use this command to insert clipboard contents at the insertion point.

Find
Use this command to find the specified text.

Go To
Use this command to move to the specified position in Primitive Log Window.

Primitive Log

MSC

Zoom In
Use this command to zoom in the MSC View Window.
Zoom Out

Use this command to zoom out the MSC View Window.

MSC

3.3 View menu


The View menu offers the following commands, which enable you to display and
hide the specified window. A check mark appears in front of the menu item when
the window is displayed.

SYS Trace
Use this command to display and hide the Sys Trace Window.
See Sys Trace Window to see the details.

check mark

SYS Trace
Sys Trace
Sys Trace

PS Integrated
Use this command to display and hide the Trace & Primitive Log Window.
See Trace & Primitive Log Window to see the details.

PS
Trace & Primitive Log
Trace & Primitive Log

Error Message
Use this command to display and hide the Err Msg Window.
See Err Msg Window to see the details.
Toolbar
Use this command to display and hide the Toolbar, which includes buttons

for some of the most common commands in Catcher, such as File Open.
See Toolbar for help on using the toolbar.
Command
Use this command to display and hide the Command Toolbar, which
provides the facility to send proprietary command to modules of protocol
stack.
See Command Toolbar for help on using the command toolbar.
AT Command
Use this command to display and hide the AT Command Toolbar, which
provides the facility to send AT command to modules of protocol stack.
See AT Command Toolbar for help on using the AT command toolbar.

Catcher

module proprietary

AT
AT AT
modules AT
AT

3.4 Control menu


The Control menu offers the following commands:

Mode
Use this command to enter logging mode.

logging

Connect
Use this command to connect to the target.

target

Disconnect
Use this command to disconnect from the target.

target

Set Filter
Use this command to change the filter settings and background color for
Trace & Primitive Log Window.

Filter
filter Trace & Primitive Log

Filter
Catcher.ini filter
Filter

Set Default Filter


Use this command to set a default filter defined in Catcher.ini.
See Filter Dialog for help on setting the filter.

3.5 Config menu


The Config menu offers the following commands:

Set Database Path


Use this command to specify the database path.

Configure RS232
Use this command to choose COM port and baud rate for RS232
connection.

RS232
RS232 COM port

Trace & Primitive Log

Appearance
Use this command to set the font size and text color of each data type in
Trace & Primitive Log Window.
Option
Use this command to set the number of Trace & Primitive Log Window. If
users select the first style, there will be only one integrated window;
otherwise there may be multiple separate windows to differentiate the Trace
& Primitive Log by its source module.

Trace & Primitive Log

module Trace & Primitive Log

3.6 Advance menu


The Advance menu offers the following commands:

Show MSC View


Use this command to show the MSC View.
See MSC View Window for help on using the frame window.

MSC
MSC
MSC

Engineering Mode
Use this command to enter Engineering Mode and show the status reported
by PS modules.
See Engineering Mode Dialog for help on using the dialog.
Sim Editor
Use this command to show the Sim Editor Dialog.
See Sim Editor for help on using the dialog.

PS modules

Sim
Sim
Sim

Download Debug Info


Use this command to download target debug information.
This command will save debug information to a file.

Debug
target debug
debug

Retrieve Exception
Use this command to show the Exception Window and get exception

records online.
See Exception Window for help on using the frame window.
Retrieve Statistics
Use this command to show the Statistics Window and get system statistics
online.
See Statistics Window for help on using the frame window.
Show Exception
Use this command to show the Exception Window and decode exception
records offline.
Show Statistics
Use this command to show the Statistics Window and decode statistics
records offline.

3.7 Window menu


The Window menu offers the following commands, which enable you to arrange
multiple views of multiple documents in the application window:

Cascade
Use this command to arrange multiple opened windows in an overlapped fashion.
Tile Horizontally
Use this command to horizontally arrange multiple opened windows in a
non-overlapped fashion.
Tile Vertically
Use this command to vertically arrange multiple opened windows in a
non-overlapped fashion.
1, 2, ... command (Window menu)
Catcher displays a list of currently open document windows at the bottom of the
Window menu. A check mark appears in front of the document name of the
active window. Choose a document from this list to make its window active.

1, 2, ... ()
Catcher
check mark

3.8 Help menu

Help Topics
Offers you an index to topics on which you can get help.

About
Displays the version number of this application.

The Help menu offers the following commands, which provide you assistance
with this application:

3.9 Tool Bar


The toolbar is displayed across the top of the application window, below the
menu bar. The toolbar provides quick mouse access to many tools used in
Catcher.
To hide or display the Toolbar, choose Toolbar from the View menu.
Click

Catcher Catcher

Remove selected data from the document and stores it on the


clipboard.
Copy the selection to the clipboard.

Catcher

Catcher

Insert the contents of the clipboard at the insertion point.

Enter logging mode.

To
Open an existing document. Catcher displays the Open dialog box,
in which you can locate and open the desired file.
Save the active document with its current name. If you have not
named the document, Catcher displays the Save As dialog box.

Change the filter settings and background color for Trace &
Primitive Log Window.
Choose COM port and baud rate for RS232 connection.

logging

Connect to target.

RS232 COM port

Connect and sync with target.

target

Disconnect from target.

target

Set all logging messages be suspended. It means all the filters will
be turned off, so users cant set filters in this situation. Users have
to click [Resume] button to return to the original state.
Set all filters be the same as original settings before entering the
[Suspend] situation.
Clear all logging messages.

target

Enter Engineering Mode and show the status reported by PS


modules.
Show the Sim Editor Dialog.

filter Trace & Primitive Log

logging filter
filter[Resume]

filter
logging
PS module

Zoom in the MSC View Window.


Sim
Zoom out the MSC View Window.
MSC

MSC

3.10 Command Tool Bar

The command toolbar is displayed across the top of the application window,
below the toolbar. It is used to send proprietary command to specific module of
protocol stack with an index value.
To hide or display the command toolbar; choose Command from the View menu.

Catcher proprietary
module

Command

3.11 AT Command Tool Bar AT

The AT command toolbar is displayed across the top of the application window,
below the command toolbar. It is used to send AT command to protocol stack.
To hide or display the AT command toolbar; choose AT Command from the View
menu.

AT Catcher
AT

AT AT Command

3.12 Auto-Clear Tool Bar -

The toolbar is used to set the duration for auto clearing. Catcher will clear up all
kinds of logging messages automatically every period.

Catcher
logging

You might also like