User's Manual

Engineering Test Software Operation
Rev 28_A Sept 2005
VIA Telecom, Inc. Proprietary 5
• 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 "<name>, <parameters>".
The Parameters are specified in a comma-separated list.
Note: Help strings and PrintFormat strings are optional.
Example:
Begin <Definition Type>, <Name>|, Option1….|
Help <help string for definition>
PrintFormat, <printf format string for definition>
<Entry Name>|,parameters|
help <help string for entry>
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. All messages start with ETS.
2. The “Enumeration Value” is the actual enumeration item name found in the ETS Id enumeration.
3. The “Cmd” and “Rsp” extensions are governed by the message category parameter of the
enumeration item.