User's Manual

Engineering Test Software Operation
Rev 28_A Sept 2005
24 VIA Telecom, Inc. Proprietary
Example:
Begin Message, CP DB Read CP Read Cmd
Segment, uint8, base=enum:CP DB Segments
Offset, uint16, base=10
Bytes, uint16, base=10, max=217
End
Begin Enum, CP DB Segments
DB PSW NAM, 0x00
DB PSW, 0x01
DB PSW MS CAP DB, 0x02
DB MMI MISC, 0x03
End
In this example, the Segment field is defined by the CP DB Segments enumeration.
3.3.8.3 Enumeration For Unions
A special type of enumeration definition is used to support a union field. The format of the enumeration is
extended to the following set of comma-separated tokens.
• Name The name of the enumerated value
• Value The value assigned to the name.
• Message category Message category (see below).
• Sub menu Menu specification (see below).
• Lite The word “lite” if this is part of the lite message set.
• Disabled Identifies conditionally disabled command messages (see below).
The following is an example of a enum declaration for a union message.
A Uim Message, 5, CR, CP/UIM, lite, disabled=GBL_UIM==1
3.3.8.3.1 Message Category
The Message Category is one of the following values:
CR - Command Response
Represents a command and a response id. In its simplest form a CR message could be a command
response pair that contains nothing but the message id. In which case there would be no associated
union member definition.
CT - Command Trace
Represents a command and a trace id. A command message of a trace message is defined only once.
Each trace response message needs to be defined.
CO - Command Only
Represents a command id only. No response will be returned for this message being sent.
RO - Response Only
Represents a response only message.
CRM - Command Response Message
Represents a command response message type. This type can only be used within a CR type. It means
that the union member identifies a set of sub-messages. The current example of this is the spy
messages.