| Download: |  |
| Mirror Download [FCC.gov] | |
| Document ID | 1292091 |
| Application ID | Nlub4rrT3zFLe1P4p/F29Q== |
| Document Description | User Manual |
| Short Term Confidential | No |
| Permanent Confidential | No |
| Supercede | No |
| Document Type | User Manual |
| Display Format | Adobe Acrobat PDF - pdf |
| Filesize | 74kB (925037 bits) |
| Date Submitted | 2010-06-08 00:00:00 |
| Date Available | 2010-06-08 00:00:00 |
| Creation Date | 2007-05-10 09:57:18 |
| Producing Software | AFPL Ghostscript 8.14 |
| Document Lastmod | 2007-05-10 09:57:18 |
| Document Title | ctm_ets_overview |
| Document Creator | PDFCreator Version 0.8.0 |
| Document Author: | lewis |
Engineering Test Software (ETS) Operation
This document provides final product specifications. VIA Telecom reserves the right to make
changes to this product at any time without notice.
This document contains proprietary information of VIA Telecom, Inc. The information contained
herein is not to be used by or disclosed to third parties without the express written permission of an
officer of VIA Telecom, Inc.
This document describes VIA Telecom’s Engineering Test Software and will remain the official
reference source for all revisions/releases of this product until rescinded by an update.
VIA Telecom, Inc. reserves the right to make changes to any product herein at any time without
notice. VIA Telecom does not assume any responsibility or liability arising out of the application or
use of any product described herein, except as expressly agreed to in writing by VIA Telecom; nor
does the purchase or use of a product from VIA Telecom convey a license under any patent rights,
copyrights, trademark rights, or any other of the intellectual property rights of VIA Telecom or third
parties.
The VIA Telecom logo design and VIA TELECOM are trademarks owned by the company.
Microsoft, Windows, Windows NT, Visual Basic, and Visual C++ are either registered trademarks
or trademarks of Microsoft Corporation in the United States and/or other countries. LabVIEW is a
trademark of National Instruments Corporation. CommLib is a trademark of sysFire LLC. All other
brand and product names may be trademarks of their respective companies.
VIA Telecom products are not intended for use in life-support appliances, devices, or systems. Use
of any VIA Telecom product in such applications without written consent of the appropriate VIA
Telecom officer is prohibited.
VIA Telecom is certified to the ISO 9001:2000 quality management system international standard.
VIA Telecom, Inc.
3390 Carmel Mountain Road
San Diego, CA 92121, U.S.A.
Tel: 858.350.5560
Internet: www.via-telecom.com
Copyright © VIA Telecom, Inc. 2006
All Rights Reserved. Printed in U.S.A.
January 2006
Engineering Test Software Operation
Engineering Test Software Operation
Revision:
Status:
Author:
Function:
Path and Filename:
File Type:
Version 32 Release Date:
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
32
Draft
Multiple
VIA Telecom, Inc.
C:\CM\CBPTOOLS\Docs\ctm_ets_overview.doc
Microsoft Word 2000
May 10, 2007
Internal Revision History Page
Engineering Test Software Operation
Revision History
Rev
32
31
30
29
Status*
Draft
Draft
Draft
Draft
Date
5/10/2007
1/24/2007
2/21/2006
1/19/2006
Author
C. Lewis
C. Lewis
C.Lewis
C. Lewis
M. Liu
D. Orloff
28
Approved
9/19/2005
27
Draft
09/02/2005
26
Approved
5/24/2005
25
Pending
05/02/2005
24
Approved
1/13/2005
R. Smith
J. Miller
23
Pending
01/06/2005
Chuck Lewis
Made generic to all CBP products
D. Orloff
Added section on DBM Templates and AutoRspQ
interface
Roy Davis,
Bryan Yang
C. Lewis
M. Liu
Roy Davis,
Bryan Yang
M. Liu
Reason for change/description
Corrected the description of non-bitpacked bit fields.
Added string and numeric field password description.
Added the Download.dll documentation.
Added ViaHub description, updated the EtsMain
command line options, added the ViaBinary interface to
the ViaIf.dll and the EtsIf.ocx interface.
Added BINLOG and GETDEF sections.
Added conditionally and invisible definition support
descriptions.
Rev 26_D approved for release as Rev 28_A
Added ViaIf.dll description and added explanations to the
Get Command, Error and Response interface functions.
Added USB support
Rev 25_P approved for release as Rev 26_A
Added the description of ViaCrypt utility and binary
EtsMsg.bin file
Rev 23_P approved for release as Rev 24_A.
Removed ETS Visual Basic Interface
Updated sections for adding Commands, Traces, Spies,
and Faults
Miscellaneous minor updates
ii
22
Draft
10/06/2004
H. Nguyen
Added Register OCX and updated External EXEs
21
Draft
08/17/2004
H. Nguyen
Added Auto Config Loading when phone is detected.
20
Draft
06/18/2004
H. Nguyen
Added External EXEs to ETS GUI
19
Draft
2/5/2004
C. Lewis
Added the Lock Config File command line option
18
Draft
10/13/2003
D. Schaeffer
Convert to customer template
17
Approved
7/15/2003
P. LaBarbera
R. Smith
S. O’Leary
Version 16_D approved for release as version 17_A
16
Draft
6/12/03
C. Lewis
Added the description of “Default ETS Options” section.
15
Draft
5/28/03
C. Lewis
Added descriptions of the following new options. Disabled
commands, hidden fields, read only fields and startup
command options. Updated with changes as
recommended in review. Added Fault Log section
description. Moved section 5 to the end.
14
Draft
4/14/03
C. Lewis
Updated the command line options and added the
COUNT_OF option to expression definitions.
12
Draft
3/10/03
C. Lewis
Added bitpacked arrays. Updated documentation for Lite
message definitions. Added description of the “Save
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
Rev
32
31
30
29
Status*
Draft
Draft
Draft
Draft
Date
5/10/2007
1/24/2007
2/21/2006
1/19/2006
Author
C. Lewis
C. Lewis
C.Lewis
C. Lewis
M. Liu
D. Orloff
28
Approved
9/19/2005
27
Draft
09/02/2005
26
Approved
5/24/2005
25
Pending
05/02/2005
Roy Davis,
Bryan Yang
M. Liu
11
Draft
2/14/03
D. Schaeffer
Made file “read-only recommended”
10
Draft
1/06/03
D. Schaeffer
Converted to new VIA Telecom template
Draft
12/20/02
W. Tang
Added globalVar section and #pragma section.
Draft
10/24/02
H. Nguyen
Added Command Function section.
Draft
10/10/02
W. Tang
Updated padding field usage and other minor changes.
Draft
9/17/02
S.Rodenbaugh
Major updates of all message definition sections.
Draft
8/02/02
A. Monteiro
Added a Section on Commands, Spies, Traces, Faults.
This section was ported from a stand alone document
written by Victor Nguyen for CBP3
Draft
6/22/01
H.Nguyen
Updated ActiveX section with functions.
Draft
5/29/01
E. Tarolli
Updated options and command line entries
Draft
7/8/00
K. Kim
Changed document name from tm_etssdd_cbp3.doc to
tm_ets_overview_cbp3.doc.
Draft
12/29/99
K. Kim
Original version.
Roy Davis,
Bryan Yang
C. Lewis
M. Liu
Reason for change/description
Corrected the description of non-bitpacked bit fields.
Added string and numeric field password description.
Added the Download.dll documentation.
Added ViaHub description, updated the EtsMain
command line options, added the ViaBinary interface to
the ViaIf.dll and the EtsIf.ocx interface.
Added BINLOG and GETDEF sections.
Added conditionally and invisible definition support
descriptions.
Rev 26_D approved for release as Rev 28_A
Added ViaIf.dll description and added explanations to the
Get Command, Error and Response interface functions.
Added USB support
Rev 25_P approved for release as Rev 26_A
Added the description of ViaCrypt utility and binary
EtsMsg.bin file
Definitions” menu item. Added Decode CDMA Message
description. Added Reset Board implementation. Added
Binary logging feature.
* Statuses include: D: Draft, P: Pending review/frozen, U: Update needed, A: Approved
Ver 28_A Approved by:
Ver 26_A Approved by:
Ver 24_A Approved by:
Ver 16_A Approved by:
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Roy Davis, Bryan Yang
Roy Davis, Bryan Yang
R. Smith, J. Miller
P. LaBarbera, R. Smith, S. O’Leary
Date:
Date:
Date:
Date:
Sept 19, 2005
May 24, 2005
January 13, 2005
Sept 15, 2003
Internal Revision History Page
Engineering Test Software Operation
Table of Contents
Introduction ...................................................................................................................................................... 1
1.1 Acronyms ............................................................................................................................................... 1
Interfaces ......................................................................................................................................................... 2
2.1 Communication Interface ....................................................................................................................... 2
Message Definition Files.................................................................................................................................. 3
3.1 File Usage Syntax .................................................................................................................................. 3
3.1.1 Include Files................................................................................................................................ 3
3.1.2 Define Statements ...................................................................................................................... 3
3.1.3 Syntax Checking Pragma ........................................................................................................... 3
3.1.3.1 Syntax_dupname ........................................................................................................ 4
3.1.3.2 #pragma push(syntax_dupname)................................................................................ 4
3.1.3.3 #pragma pop(syntax_dupname) ................................................................................. 4
3.1.3.4 #pragma disable(syntax_dupname)............................................................................ 4
3.1.3.5 Definitions.................................................................................................................... 4
3.2 Message and Record Definitions ........................................................................................................... 5
3.2.1 Message Naming Conventions................................................................................................... 5
3.2.1.1 Naming of Submessages in ETS Base Message ....................................................... 5
3.2.1.2 Naming of Submessages in ETS Named Submessages............................................ 6
3.2.1.3 Naming of Submessages in Non-ETS Named Submessages.................................... 7
3.2.2 Message and Record Parameters......................................................................................... 8
3.3
3.2.2.1 BitPack ........................................................................................................................ 8
3.2.2.2 PrintOnly...................................................................................................................... 8
3.2.2.3 TruncateBits=# ............................................................................................................ 8
3.2.3 BitPack Message and Record Format........................................................................................ 8
3.2.4 Message Examples .................................................................................................................... 9
3.2.4.1 Example of Command/Response Message................................................................ 9
3.2.4.2 Example of Response Only Message ......................................................................... 9
3.2.4.3 Example of Command/Response Sub-Message ........................................................ 9
3.2.5 Record Definitions and Examples............................................................................................. 10
3.2.6 GlobalVar Definition .................................................................................................................. 11
3.2.6.1 Associating a field with a global variable................................................................... 11
3.2.6.2 Using “exist” Condition Based on a Global Variable for a Field ................................ 11
3.2.6.3 Using “exist” Condition Based on a Global Variable for a Group of Fields ............... 11
3.2.7 Conditional Definitions .............................................................................................................. 11
3.2.8 Invisible Definitions ................................................................................................................... 12
3.2.9 Startup Commands Definition................................................................................................... 12
3.2.10 Extra Log Window Definition..................................................................................................... 13
3.2.11 Fault Log Definition ................................................................................................................... 13
3.2.12 Default ETS Options ................................................................................................................. 13
Field Definitions.................................................................................................................................... 14
3.3.1 Bit Fields ................................................................................................................................... 14
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
3.3.1.1 BitPack Bit Fields....................................................................................................... 14
3.3.1.2 Non-BitPack Bit Fields............................................................................................... 14
3.3.1.3 Bit Field Parameter Differences ................................................................................ 15
3.3.2 Numeric Fields .......................................................................................................................... 15
3.3.2.1 Password parameter ................................................................................................. 15
3.3.3 Padding Fields .......................................................................................................................... 16
3.3.4 Array Fields ............................................................................................................................... 16
3.3.5 Record Fields .......................................................................................................................... 17
3.3.6 String Fields .............................................................................................................................. 18
3.3.6.1 Fixed Length String ................................................................................................... 18
3.3.6.2 Variable Length String ............................................................................................... 18
3.3.6.3 Password parameter ................................................................................................. 19
3.3.7 Union Fields .............................................................................................................................. 19
3.3.7.1 Union Field Identifier.................................................................................................. 21
3.3.7.2 Union Field Examples................................................................................................ 22
3.3.8 Enumerations............................................................................................................................ 23
3.3.8.1 Enumerations: Short Form ........................................................................................ 23
3.3.8.2 Long Form ................................................................................................................. 23
3.3.8.3 Enumeration For Unions............................................................................................ 24
3.3.9 Field Parameters....................................................................................................................... 25
3.3.9.1 Field Parameter: base ............................................................................................... 26
3.3.9.2 Field Parameter: byteorder........................................................................................ 27
3.3.9.3 Field Parameter: bytes .............................................................................................. 27
3.3.9.4 Field Parameter: columns.......................................................................................... 27
3.3.9.5 Field Parameter: ConsumeBits ................................................................................. 27
3.3.9.6 Field Parameter: ConsumeBytes .............................................................................. 28
3.3.9.7 Field Parameter: count .............................................................................................. 28
3.3.9.8 Field Parameter: default ............................................................................................ 28
3.3.9.9 Field Parameter: enum .............................................................................................. 29
3.3.9.10 Field Parameter: exist............................................................................................... 29
3.3.9.11 Field Parameter: fields.............................................................................................. 30
3.3.9.12 Field Parameter: Format........................................................................................... 30
3.3.9.13 Field Parameter: indent ............................................................................................ 30
3.3.9.14 Field Parameter: length ............................................................................................ 30
3.3.9.15 Field Parameter: log10 ............................................................................................. 31
3.3.9.16 Field Parameter: logScale ........................................................................................ 31
3.3.9.17 Field Parameter: maxsize......................................................................................... 31
3.3.9.18 Field Parameter: min and max ................................................................................. 31
3.3.9.19 Field Parameter: minbytes........................................................................................ 32
3.3.9.20 Field Parameter: noexist........................................................................................... 32
3.3.9.21 Field Parameter: offset ............................................................................................. 32
3.3.9.22 Field Parameter: pos ................................................................................................ 33
3.3.9.23 Field Parameter: rows .............................................................................................. 33
3.3.9.24 Field Parameter: scale.............................................................................................. 34
3.3.9.25 Field Parameter: set ................................................................................................. 34
ii
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
3.3.9.26 Field Parameter: size................................................................................................ 34
3.3.9.27 Field Parameter: type ............................................................................................... 35
3.3.9.28 Field Parameter: Hidden........................................................................................... 36
3.3.9.29 Field Parameter: ReadOnly ...................................................................................... 36
3.3.10 Expression ................................................................................................................................ 36
3.3.10.1 Field Names as Entities............................................................................................ 37
3.3.10.2 COUNT_OF.............................................................................................................. 37
Utilities............................................................................................................................................................ 38
4.1 Include File Generator.......................................................................................................................... 38
4.1.1 Enumerated List Generation..................................................................................................... 38
4.1.2 String List Generation ............................................................................................................... 38
4.2 User Interface....................................................................................................................................... 39
4.2.1 Ets Options Dialog .................................................................................................................... 39
4.2.2 Logging ..................................................................................................................................... 42
4.2.2.1 Extra Log Windows ................................................................................................... 42
4.2.3 Menus and Dialogs ................................................................................................................... 42
4.3 Script Utility .......................................................................................................................................... 42
4.4 OLE Automation Interface.................................................................................................................... 43
4.5 Knobs, Dials, Graphs ........................................................................................................................... 43
4.6 ViaCrypt Utility...................................................................................................................................... 43
Modules.......................................................................................................................................................... 45
5.1 ETS Main ............................................................................................................................................. 45
5.1.1 Command Line Options ............................................................................................................ 46
5.1.1.1 Configuration File ...................................................................................................... 46
5.1.1.2 Syntax Check ............................................................................................................ 46
5.1.1.3 Communication Port.................................................................................................. 47
5.1.1.4 Window Mode............................................................................................................ 47
5.1.1.5 Defines ...................................................................................................................... 47
5.1.1.6 Save Definitions ........................................................................................................ 47
5.1.1.7 Lock Configuration .................................................................................................... 47
5.1.2 Lite Mode Of Operation ............................................................................................................ 47
5.1.3 Save Definitions ........................................................................................................................ 48
5.1.4 Message Control Library........................................................................................................... 48
5.1.4.1 Message Definition Processing ................................................................................. 48
5.1.4.2 Message Object ........................................................................................................ 48
5.1.4.3 Menu Handler ............................................................................................................ 48
5.1.4.4 Log Processing.......................................................................................................... 49
5.1.4.5 Trace Management ................................................................................................... 49
5.1.5 Communications Interface ........................................................................................................ 49
5.1.5.1 Serial Interface .......................................................................................................... 50
5.1.5.2 Message Encapsulation ............................................................................................ 50
5.1.6 Message Router........................................................................................................................ 50
5.1.7 OLE Automation Interface ........................................................................................................ 50
5.1.8 Specialized Message Handlers ................................................................................................ 50
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
iii
Engineering Test Software Operation
5.2
5.3
5.4
5.5
5.6
iv
5.1.8.1 Loopback Test ........................................................................................................... 50
5.1.8.2 Printf Message Handler ............................................................................................. 50
5.1.8.3 Trace Message Handler ............................................................................................ 50
5.1.8.4 Database Template Handling.................................................................................... 51
5.1.9 Decode CDMA Message .......................................................................................................... 51
5.1.10 Reset Board .............................................................................................................................. 51
5.1.11 Binary Logging and Playback ................................................................................................... 52
5.1.12 Flash Download ........................................................................................................................ 52
5.1.13 External Application Support..................................................................................................... 52
5.1.13.1 External EXE Definition and Register OCX.............................................................. 52
5.1.13.2 External Application Interface................................................................................... 53
5.1.14 Auto Configuration Loading ...................................................................................................... 53
Script Utility .......................................................................................................................................... 53
Control Panels...................................................................................................................................... 53
Test Drivers .......................................................................................................................................... 53
ETS ActiveX Interface .......................................................................................................................... 54
5.5.1 Overview ................................................................................................................................... 54
5.5.2 Initialization ............................................................................................................................... 54
5.5.3 Auto Script Support................................................................................................................... 54
5.5.4 Received Message Flow........................................................................................................... 55
5.5.4.1 Asynchronous Message Flow Functions................................................................... 55
5.5.4.2 Message Event Functions ......................................................................................... 55
5.5.5 Field Data Functions ................................................................................................................. 56
5.5.6 Array Field Functions ................................................................................................................ 56
5.5.7 File Functions............................................................................................................................ 57
5.5.8 Command Function................................................................................................................... 58
5.5.9 Serial Communication Functions .............................................................................................. 58
5.5.10 ETS Control Functions.............................................................................................................. 58
5.5.11 AutoRspQ.................................................................................................................................. 58
5.5.11.1 Function Create(pFilter As String, pName As String) As Long ................................ 58
5.5.11.2 Function Destroy() As Boolean................................................................................. 58
5.5.11.3 Function Enable(Enable As Boolean) As Boolean ................................................... 59
5.5.11.4 Function GetAllResponses() As String ..................................................................... 59
5.5.11.5 Function GetOverRunCount() As Long .................................................................... 59
5.5.11.6 Function GetResponse() As String........................................................................... 59
5.5.11.7 Sub SetSize(Size As Long) ...................................................................................... 59
VIAIF Dynamic Link Library.................................................................................................................. 59
5.6.1 ViaSetup Interface .................................................................................................................... 59
5.6.1.1 LoadDefinitions.......................................................................................................... 59
5.6.1.2 OpenCommInterface ................................................................................................. 59
5.6.1.3 UnloadDefinitions ...................................................................................................... 60
5.6.1.4 CloseCommInterface................................................................................................. 60
5.6.1.5 GetCommStatus ........................................................................................................ 60
5.6.1.6 GetCommStatistics.................................................................................................... 60
5.6.1.7 ResetCommStatistics ................................................................................................ 60
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
5.7
5.8
5.9
5.6.1.8 GetAutoRspQ ............................................................................................................ 60
5.6.1.9 RawHex ..................................................................................................................... 60
5.6.1.10 ResetPolarity ............................................................................................................ 61
5.6.1.11 ResetBoard............................................................................................................... 61
5.6.1.12 SendDeferredCommand........................................................................................... 61
5.6.2 ViaBinary Interface ................................................................................................................... 61
5.6.2.1 SendMessage ........................................................................................................... 61
5.6.2.2 GetMessage .............................................................................................................. 61
5.6.2.3 Clear Filter ................................................................................................................. 61
5.6.2.4 AddToFilter ................................................................................................................ 61
5.6.2.5 ClearRxQueue........................................................................................................... 62
ViaHub.................................................................................................................................................. 62
5.7.1 USB Connection Management ................................................................................................. 62
5.7.2 Application Access.................................................................................................................... 62
5.7.3 Command Line Options ............................................................................................................ 62
5.7.3.1 /ClearUsbPorts .......................................................................................................... 62
5.7.3.2 /Delay ........................................................................................................................ 62
ETS Message Commands ................................................................................................................... 62
5.8.1 BINLOG Messages................................................................................................................... 62
5.8.1.1 Create Binary Log File............................................................................................... 62
5.8.1.2 Close Binary Log File ................................................................................................ 63
5.8.1.3 Get Status of Binary Log File .................................................................................... 63
5.8.1.4 Playback Binary Log File........................................................................................... 63
5.8.2 GETDEF ................................................................................................................................... 64
5.8.2.1 Get Definition Entry Count......................................................................................... 64
5.8.2.2 Get Definition Entry Value by Entry Number............................................................. 64
5.8.2.3 Get Definition Entry Value by Entry Name ................................................................ 65
Download DLL...................................................................................................................................... 65
5.9.1 IDownloader interface............................................................................................................... 66
5.9.1.1 Methods..................................................................................................................... 66
5.9.1.2 Properties .................................................................................................................. 68
5.9.1.3 IDownloaderEvents Interface .................................................................................... 68
Adding Commands, Traces, Spies, Faults .................................................................................................... 70
6.1 ETS Commands................................................................................................................................... 70
6.1.1 Adding an ETS Command ........................................................................................................ 70
6.1.1.1 Modify ETS Message Id and Message Body Definition Text Files ........................... 70
6.1.1.2 Modify CBP CP Software Files.................................................................................. 70
6.1.2 Executing an ETS Command ................................................................................................... 71
6.2 ETS Traces .......................................................................................................................................... 71
6.2.1 Adding an ETS Trace ............................................................................................................... 71
6.2.1.1 Modify ETS Message Id and Message Body Definition Text files............................. 72
6.2.1.2 Modify CBP CP Software Files.................................................................................. 72
6.2.2 Enabling an ETS Trace............................................................................................................. 73
6.3 ETS Spies ............................................................................................................................................ 73
6.3.1 Adding an ETS Spy .................................................................................................................. 73
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
6.4
6.3.1.1 Modify ETS Message Id and Message Body Definition Text Files............................ 73
6.3.1.2 Modify CBP CP Software Files.................................................................................. 73
6.3.2 Enabling an ETS Spy................................................................................................................ 74
ETS Faults............................................................................................................................................ 74
6.4.1 Adding an ETS Fault................................................................................................................. 74
6.4.1.1 Modify ETS File mmi/mmi_errs.txt ............................................................................ 74
6.4.1.2 Modify CBP CP Files ................................................................................................. 74
6.4.2 Results of ETS Faults ............................................................................................................... 75
Rev 27_D Review Information ....................................................................................................................... 76
Rev 25_D Review Information ....................................................................................................................... 77
Ver 23_P Design Review Information ............................................................................................................ 78
10 Ver 14_D Design Review Information............................................................................................................ 79
vi
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
List of Figures
Figure 1. ETS Interfaces........................................................................................................................................ 2
Figure 2. Naming Conventions for ETS Base Message........................................................................................ 6
Figure 3. Naming Conventions for ETS Named Submessages ............................................................................ 7
Figure 4. Naming Convention: Non-ETS Named Submessages .......................................................................... 8
Figure 5. Message with Union Field .................................................................................................................... 20
Figure 6. Message with Union Submessage Substitution................................................................................... 21
Figure 7. Options Dialog...................................................................................................................................... 40
Figure 8. ETS Sub-Module Interfaces ................................................................................................................. 45
Figure 9. ETS Main Sub-Modules ....................................................................................................................... 46
Figure 10. Communications Interface ................................................................................................................. 49
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
vii
Engineering Test Software Operation
List of Tables
Table 1. Differences in Bit Field Parameters....................................................................................................... 15
Table 2. Field Types Versus Field Parameters ................................................................................................... 25
Table 3. Default Values for Min and Max Field Parameters................................................................................ 32
Table 4. Ets Options Dialog Selections ............................................................................................................... 41
viii
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software (ETS) Operation
1 Introduction
This document describes the operation of the VIA Telecom Engineering Test Software (ETS).
ETS is a Windows®-based PC software tool that allows designers to observe, control, and record in real-time
the behavior of CMDA handsets that use all versions of the VIA Telecom CDMA Baseband Processor (CBP)
products. Designers can use ETS in all phases of handset design, including development, field test, and
production. Features of ETS include real-time memory peak/poke functions for the CP and DSPs and the ability
to capture detailed software interaction information in real-time or in a log file.
ETS supports a Windows-COM interface that allows further customer PC applications to be developed on top of
ETS.
1.1
Acronyms
The following acronyms are used in this manual:
CBP
CO
CP
CR
CRM
CT
DSP
DTR
ETS
ICD
LSB
MCL
MMI
OAI
UART
VB
CDMA Baseband Processor
Command Only
Control Processor
Command Response
Command Response Message
Command Trace
Digital Signal Processor
Data Terminal Ready
Engineering Test Set
Interface Control Document
Least Significant Bit
Message Control Library
Man-Machine Interface
OLE Automation Interface
Universal Asynchronous Receiver Transmitter
Visual Basic®
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
2 Interfaces
ETS is a Windows-based PC program that provides designers with the capability to observe, control, and record
the behavior of the CBP Control Processor (CP) and Digital Signal Processors (DSP).
User Interface
OLE Automation
Interface
Engineering Test
Software
Message
Description File
Serial\USB
Port
Figure 1. ETS Interfaces
2.1
Communication Interface
The ETS communicates with the CP through a serial interface. Message exchanges fall into the following four
categories:
1. Command Response - A command message is sent from the ETS to the CP, and the CP immediately
returns a response message to the ETS.
2. Command Trace - A Trace command message is sent from the ETS to the CP to enable or disable the
transmission of a specific Trace message. When enabled, Trace messages are sent from the CP to the
ETS when the CP software determines a need. The command messages of this category all have the
same format, which is the message ID followed by a single boolean byte to enable or disable the trace.
3. Command Only - A command message is sent from the ETS to the CP. No acknowledgment is
returned.
4. Response - A response message is sent from the CP to the ETS without any solicitation from the ETS.
Notes:
1. A dialog window is provided to configure the serial interface.
2. Multiple instances of the ETS can be running concurrently on several different communication ports.
3. There is no high level flow control.
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
3 Message Definition Files
When ETS is loaded it reads the EtsMsg.txt file and all of the referenced include files. It contains descriptions of
each of the messages to be exchanged with the CP as well as various configurations items. A fatal error occurs
if an invalid message definition exists in the file. A list defining each message will be in the file, in addition to
definitions of the fields within each message.
An encrypted form of the ETS message definition file can also be used. The filename is EtsMsg.bin. It is used in
the same manner as EtsMsg.txt. Loading EtsMsg.bin will take precedence over EtsMsg.txt if they exist in the
same directory. Refer to section 4.6, “ViaCrypt Utility,” for details on how to create an encrypted definition file.
3.1
File Usage Syntax
3.1.1 Include Files
Multiple message definition files can be incorporated to better organize the message definitions. Include files
are specified outside of the definitions and cannot have circular references. The following format is used:
Include
3.1.2 Define Statements
A "C Language" like ifdef syntax is used to control the interpretation of the definitions. The definitions
themselves are specified using the "Defines" dialog box from the File/Defines… menu item. Definition strings
must not contain space or tab characters. The following statements are allowed:
#ifdef | Comments|
#ifndef | Comments|
#else| Comments|
#else ifdef | Comments|
#else ifndef | Comments|
#endif| Comments|
#define
These can be nested in the same manner that is done in the C language. Care should be taken since the effect
of the statements cross into and out of include files.
Parameters are either a single definition value or a boolean statement. For example:
#ifdef ADEFINITION This is a comment for a single definition.
Boolean statements must be surrounded by parentheses. Examples are:
#ifdef (FIRST & SECOND) This is a comment for a boolean statement
#ifdef (FIRST | SECOND)
#ifdef (~FIRST | SECOND)
#ifdef (FIRST | (SECOND & THIRD))
Comments can follow the parameters if desired. Either a space character or a trailing parenthesis will separate
the parameters from the comment.
3.1.3 Syntax Checking Pragma
There is a mode to run ETS called full syntax check mode, with option –s or /s. Under full syntax checking
mode, ETS will check for syntax errors in ETS text files. One of the syntax errors is field name duplication error.
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
Example:
Begin Message, Msg1
Field1, uint8, indent = 2
Field2, uint16, indent = 2
Field1, uint8, indent = 2
End
In this message, Field1 is used twice, and it will be reported as a syntax error. But due to legacy reasons,
some of the AMPS messages and records have used duplicated field names, and it is hard or impossible to
change them. The following syntax checking flag and pragmas are introduced to overcome this problem.
3.1.3.1
Syntax_dupname
This is a boolean flag used under full syntax checking. At the very beginning, it is set as true, which means ETS
will check for duplicated field names, and if a duplicate is found, ETS will report it as a syntax error.
3.1.3.2
#pragma push(syntax_dupname)
This pragma stores the boolean flag syntax_dupname to a stack.
3.1.3.3
#pragma pop(syntax_dupname)
This pragma restores the boolean flag syntax_dupname from a stack.
3.1.3.4
#pragma disable(syntax_dupname)
This pragma sets the boolean flag syntax_dupname as false.
Example:
The following is an example of how to use the pragmas described above:
#pragma push(syntax_dupname)
#pragma disable(syntax_dupnam)
Begin Message, Msg1
Field1, uint8, indent = 2
Field2, uint16, indent = 2
Field1, uint8, indent = 2
End
#pragma pop(syntax_dupname)
In this example, ETS will not report the duplicated field names as a syntax error for Message Msg1.
3.1.3.5
Definitions
The message description file contains sets of definitions. The following syntax rules apply:
•
Leading and trailing spaces are ignored.
•
Lines that begin with a semicolon are ignored.
•
All definitions start with a Begin line and end with an End line.
•
The Begin line specifies the type of definition. The valid types are "Message," "Enum," and "Record."
•
Definitions can contain Entry and Help lines.
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
•
Lines that start with the word Help contain one-line descriptions that are associated with either the definition
as a whole or with a single entry. A Help line applies to the definition as a whole if it immediately follows the
Begin line.
•
A line that starts with PrintFormat and follows the begin statement before the first entry defines a print
format for the definition as a whole.
•
An Entry line contains a name and an optional set of parameters. Its format is ", ".
The Parameters are specified in a comma-separated list.
Note: Help strings and PrintFormat strings are optional.
Example:
Begin , |, Option1….|
Help
PrintFormat,
|,parameters|
help
End
3.2
Message and Record Definitions
The following is an example of a message definition. It is also the base definition of the ETS message structure.
Begin Message, ETS
Help ETS Message frame
Id, uint16, base=enum:ETS Id
help Message Id
Message, union ,enum=Id
Help Message Data
End
3.2.1 Message Naming Conventions
ETS message naming conventions have the following variations, and each variation is described in the following
paragraphs:
• Submessages contained in the ETS Message ID Base Message
• Submessages contained in an ETS Named Submessage
• Submessages contained in a non-ETS Named Submessage
3.2.1.1
Naming of Submessages in ETS Base Message
ETS has a set of rules that govern message naming. All messages start from the “ETS Message ID Definition”
message shown in Figure 2. The ETS message is composed of an ID field plus one of the many messages
represented by the union (Message). The union is based on the “ETS Id” enumeration. As Figure 2 shows,
there is an implied relationship between the ETS message, the ETS Id enumeration, and the name of the
message.
The layout of the message names is as follows:
Form:
“ETS“ + “ “ + Enumeration Value + “ “ + (“Cmd” or “Rsp” or nothing)
Rules:
1.
2.
3.
All messages start with ETS.
The “Enumeration Value” is the actual enumeration item name found in the ETS Id enumeration.
The “Cmd” and “Rsp” extensions are governed by the message category parameter of the
enumeration item.
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
In Figure 2, the message name is created as follows:
“ETS” + “ “ + “CP DB Clear” + “Cmd”
to form
ETS CP DB Clear Cmd
“ETS” + “ “ + “CP DB Clear” + “Rsp”
to form
ETS CP DB Clear Rsp
3.2.1.2
Naming of Submessages in ETS Named Submessages
In Figure 3, the “ETS CP Trace” message represents a message generated from the ETS Base Message. The
ETS CP Trace message is composed of an Id field plus one of the many messages represented by the union
(TraceMsg). The union is based on the “CP TraceIds” enumeration. As Figure 3 shows, there is an implied
relationship between the “ETS CP Trace” message, the “CP TraceIds” enumeration, and the name of message.
The layout of the message names is:
Form:
(See notes 1 and 2) + “ “ + Enumeration Value + “ “ + (“Cmd” or “Rsp” or nothing)
Rules:
1.
2.
3.
4.
All message names start with the Base Message Name excluding the “ETS.”
If the Base Message Name ends in “Cmd” or “Rsp,” the extensions are excluded.
The “Enumeration Value” is the actual enumeration item name found in the enumeration.
The “Cmd” and “Rsp” extensions are governed by the message category parameter of the
enumeration item.
In Figure 3, the message name is created as follows:
“CP Trace” + “ “ + “CP Mon Msg Trace” + “Rsp”
;*****************************************************
ETS Message ID Definition
;*****************************************************
Begin Message, ETS
Id,
uint16, base=enum:ETS Id
Message, union, enum=Id
End
to form CP Trace CP Mon Msg Trace Rsp
Begin Enum, ETS Id
;-------------------------------------------------;
CP Message Id Definitions
;-------------------------------------------------.....
.....
.....
;----------- DB sub menu
CP DB Clear, 300, CR, CP/DB
CP DB Cache,
, CR, CP/DB
.....
.....
End
Begin Message, ETS CP DB Clear Cmd
DB Id, uint8, base=enum:CP/RF
End
;----------------------------------------------------Begin Message, ETS CP DB Clear Rsp
End
Figure 2. Naming Conventions for ETS Base Message
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
Begin Enum, CP TraceIds
All Off, 0, CT, CP/Trace
Begin Message, ETS CP Trace
TraceId, uint16, base=enum:CP TraceIds
TraceMsg, union, enum=TraceId
End
;----------- MON sub menu
CP MON Generic Dec1, , CT, CP/Trace/MON
CP MON Generic Dec2, , CT, CP/Trace/MON
CP MON Generic Hex1, , CT, CP/Trace/MON
CP MON Generic Hex2, , CT, CP/Trace/MON
CP MON Generic dB, , CT, CP/Trace/MON
CP MON Msg Trace, , CT, CP/Trace/MON
....
....
End
Begin Message, CP Trace CP MON Msg Trace Rsp
PrintFormat, 1, 1, 0x%08X CP - MON Msg Trace: Msg ID - %d, Source Task ID - %s, Dest Task ID - %s
Sys Time,
uint32
Msg ID,
uint32
Source Task ID, uint32, base=enum:CP Task Id
Dest Task ID, uint32, base=enum:CP Task Id
End
Figure 3. Naming Conventions for ETS Named Submessages
3.2.1.3
Naming of Submessages in Non-ETS Named Submessages
In Figure 4, the “CP Trace CP LMD Markov Trace Rsp” message represents a message generated from an
ETS Named Submessage. The ““CP Trace CP LMD Markov Trace Rsp”” message is composed of multiple
fields plus one of the many messages represented by the union (Data). The union is based on the “Markov
Functions” enumeration. As Figure 4 shows, there is an implied relationship between the “CP Trace CP LMD
Markov Trace Rsp” message, the “Markov Functions” enumeration, and the name of message. The layout of
the message names is as follows:
Form:
(See notes 1) + “ “ + Enumeration Value + “ “ + (“Cmd” or “Rsp” or nothing)
Rules:
1.
2.
3.
If the Base Message Name ends in “Cmd” or “Rsp,” the extensions are excluded.
The “Enumeration Value” is the actual enumeration item name found in the enumeration.
The “Cmd” and “Rsp” extensions are governed by the message category parameter of the
enumeration item.
In Figure 4, the message name is created as follows:
“CP Trace CP LMD Markov Trace” + “ “ + “Srv Opt Control” + “Rsp”
to form
CP Trace CP LMD Markov Trace Srv Opt Control Rsp
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
Begin Message, CP Trace CP LMD Markov Trace Rsp
PrintFormat, 1, 1, 0x%08X CP - LMD Markov Func=%s %s
Sys Time, uint32
Func,
uint32, base=enum:Markov Functions
Data,
union, enum=Func
End
Begin Enum, Markov Functions
Srv Opt Start,
0, RO
Srv Opt Control,
1, RO
.....
.....
End
Begin Message, CP LMD Markov Trace Srv Opt Control Rsp
CtlRecType,
uint32, base=enum:Mso Ctrl Rec Types
Data,
union, enum=CtlRecType
End
Figure 4. Naming Convention: Non-ETS Named Submessages
3.2.2 Message and Record Parameters
The following parameters can be placed on the Begin line of a message/record to provide extra control.
3.2.2.1
BitPack
The Bitpack parameter indicates that the message data can contain bit-fields and not necessarily be bytealigned. Refer to the BitPack section for details.
3.2.2.2
PrintOnly
The PrintOnly flag is used for spy response messages and indicates that a spy dialog will not appear when the
spy message is received. This causes the spy message to only be printed out.
3.2.2.3
TruncateBits=#
The TruncateBits option causes the specified number of bits to be truncated from the end of the message that is
received. This is used where interpretation of the trailing data is not desired. The value of the parameter is the
number of bits to truncate.
3.2.3 BitPack Message and Record Format
BitPack messages and records contain bit-aligned fields by default. Other messages and records contain bytealigned fields by default.
Example:
Begin Message, MsgName, BitPack
FieldName1, count=2
FieldName2, count=2,
base=enum:zero/one/two/three
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
FieldName3, uint16
End
Begin Record RecName, BitPack
Field1, count = 4
Field2, uint32
End
BitPack Bit Fields are numeric. The format of the field definitions is:
, count= <, numeric field parameters>
In the example the first field (FieldName1) is displayed or entered as a 2-bit numeric value. The second field
(FieldName2) is displayed or entered as an enumerated value. The third field (FieldName3) is an unsigned
16-bit integer.
The binary data for this example will be bit-aligned. There are a total of 20 bits packed as 2 two-bit fields
followed by a single 16-bit field.
3.2.4 Message Examples
3.2.4.1
Example of Command/Response Message
The Loopback message has an Id equal to zero, being a command response type and having a menu item
located under a Debug submenu. Also the descriptive text of the value is Loopback Message which would
appear when the command menu item for the loopback message is selected. Based on this definition, the
following two definitions for loopback command and response message can be made:
Begin Message, ETS CP Loopback Cmd
Help ETS Loopback message command
Data, array, type=uint8, maxsize=273, size=end, columns=60
End
Begin Message, ETS CP Loopback Rsp
Help ETS Loopback message response
Data, array,type=uint8, maxsize=273, size=end
End
3.2.4.2
Example of Response Only Message
The Fault message is a response only message and has an Id equal to 50. This allows for the associated
response message to be defined as follows:
Begin Message, ETS CP Fault Rsp
help Unit identifier
Unit, uint8, base=enum:CP Unit
Codes, union, enum=Unit
End
This case demonstrates that each message can itself contain a union and refer to other enumeration definitions.
In this specific example there is a union member for each processor.
3.2.4.3
Example of Command/Response Sub-Message
The Spies message is a command response sub-message type and has an Id equal to 1-1. Because it is a
CRM type it must refer to a message definition that contains a union. In this case the message definition is as
follows:
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
Begin Message, ETS CP Spy
SpyId, uint16, base=enum:CP SpyIds
SpyMsg, union, enum=SpyId
End
Begin ENUM, ETS SpyIds
All Off, 0, CT, CP/Spy, Lite
CP Tx DSPM Mbox, , CT, CP/Spy/MON
CP Tx DSPV Mbox, , CT, CP/Spy/MON
End
Begin Message, CP Spy Cmd
Enable, uint8, base=bool
End
Begin Message, CP Spy All Off Rsp
End
Begin Record, DSP HW Mailbox
Msg Id, uint16, base=enum:DSP HW Mailbox Ids
Length, uint16
Data,
array, type=uint16, maxsize=40, size=Length
End
Begin Message, CP Spy CP Tx DSPM Mbox Rsp
Sys Time, uint32
Length,
uint16
Num Msgs, uint16
Data,
record, type=DSP HW Mailbox, maxsize=10, size=Num Msgs
End
Begin Message, CP Spy CP Tx DSPV Mbox Rsp
Sys Time, uint32
Length,
uint16
Num Msgs, uint16
Data,
record, type=DSP HW Mailbox, maxsize=10, size=Num Msgs
End
3.2.5 Record Definitions and Examples
Record definitions are sets of fields and are very similar to message definitions. The following is an example:
Begin Message, AMessage
Data, record, type=ARecordName, maxsize=3
End
Begin Record, ARecordName
Field1, uint8
Field2, uint8
End
This defines AMessage which contains a fixed length 3-record array. The record ARecordName contains two
unsigned 8-bit fields.
10
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
3.2.6 GlobalVar Definition
GlobalVar section defines the global variables in all ETS text definitions. Each entry in this section specifies the
following:
• The name of the global variable
• The default value of this global variable
The following is an example:
Begin GlobalVar, Only One Global Var Block
PREV, default = 6
; add more here
End
There are two ways to use a global variable, as described in the next two sections.
3.2.6.1
Associating a field with a global variable
To associate a field with a global variable, use GlobalVar attribute for a field. For example:
P REV, count = 8, GlobalVar=PREV, indent = 2
This means that if ETS is going to consume a message with this field, ETS will set the global variable PREV
based on the value of this field. If ETS is going to produce a message with this field, ETS will use the value of
global variable PREV to encode this field.
3.2.6.2
Using “exist” Condition Based on a Global Variable for a Field
For example:
CDMA Freq, count = 8, indent = 2, exist = (PREV > 5)
Here the PREV is a global variable specified in the GlobalVar section.
3.2.6.3
Using “exist” Condition Based on a Global Variable for a Group of Fields
For example:
Begin Message, CP Spy CP PE ENG_LAYER2_TR 13 15 Rsp, BitPack
;…
Prat, count = 2, indent = 2
#existif (PREV >5)
CDMA Freq, count = 11, indent = 2
Ext CDMA Freq, count = 11, indent = 2
#endexistif
; …
End
The two fields, “CDMA Freq” and “Ext CDMA Freq”, only exist when the global variable PREV is greater than 5.
3.2.7 Conditional Definitions
ETS Definitions can be defined conditional on global variables using #existif, #orexistif, and #endexistif. Field
names must still be unique (no duplicated field allowed) even if they appear in different conditional statements.
The following is an example of the syntax for commands that are disabled based on a condition of a global
variable:
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
11
Engineering Test Software Operation
CP AMPS Tune Radio1, 801, CO, RF/AMPS, disabled=GBL_RF_OPTION==1
CP AMPS Tune Radio2, 801, CO, RF/AMPS, disabled=GBL_RF_OPTION>1
CP AMPS Tune Radio3, 801, CO, RF/AMPS, disabled=GBL_RF_OPTION<3
Another example of using #existif is below. Depending on the GBL_RF_OPTION conditional statement the field
"Use NVRAM data_FALSE" or "Use NVRAM data_TRUE" will display on the "CP AMPS Rx Cal Override" ETS
command window dialog.
Begin Message, ETS CP AMPS Rx Cal Override Cmd
#existif GBL_RF_OPTION==1
Use NVRAM data_FALSE,
uint8, base=bool, default=False
#orexistif GBL_RF_OPTION>1
Use NVRAM data_TRUE,
uint8, base=bool, default=True
#endexistif
Pdm step/dB slope, int16, base=16, default=0xcfa0
End
3.2.8 Invisible Definitions
ETS has an "invisible" definition feature that allows a command, database template or any field within a
definition to be set "invisible" within EtsMain or ETS log data. This invisible type will cause the field not to be
displayed at all depending on the conditional statement which will be evaluated (greater than, less than, equal,
combination of greater (or less) than and equal, etc...), but it doesn't disturb the others fields information.
The syntax is similar to the “hidden” field option. The difference is that for "hidden" the field name is shown but
the value is null bytes in the command or response; for "invisible" the field name won't show up at all in the
dialog box or in the response message.
The following is an example of the syntax for invisible commands based on a global variable:
AMPSGoodFrameCt, uint16, base=10, Invisible=GBL_AMPS_SUPPORTED==0
AMPSBadFrameCt, uint16, base=10, hidden=GBL_AMPS_SUPPORTED==0
The next example shows use within the NAM1 DBTemplate:
SlotCycleIndex,
uint8, base=10, Invisible=1
A final example shows how individual fields can be made invisible within a command:
Begin Message, ETS CP Rev Channel Data Cmd
ChnlDataRdy, uint16, base=16
FundRate,
uint16, base=10, Invisible=1
Words,
uint16, min=1, max=200
Data,
array, type=uint16, maxsize=200, size=end, columns=60
End
3.2.9 Startup Commands Definition
The startup commands section causes the messages listed to be sent when ETS starts up. Also there is a
menu selection “Debug/Send Startup Commands” that will send these messages when selected. The following
example will send the CP version command and a loopback command when ETS starts up.
Begin Record, Startup Commands
ETS, Id=CP Version
ETS, ID=CP Loopback
End
12
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary
Engineering Test Software Operation
3.2.10 Extra Log Window Definition
Extra log windows display selected messages. This definition file entry specifies the following:
• The title that will appear at the top of the window.
• The log entries that will be displayed.
• The menu selection of any spy messages that need to be turned off.
The format of the definition is as follows:
Begin LogExtra,
Menu,