Document Outline

• Voyager™ USB 3.0 Exerciser
• Generation Script Language
• List of Instructions, Comments, Definitions, Directives, Operators, Parameters, Primitives, Procedures, and Settings
• 1 Introduction
  • 1.1 Declaration Conventions
    • 1.1.1 Parentheses
    • 1.1.2 Brackets
  • 1.2 Script Example Highlighting
• 2 Script Language Structure
  • 2.1 Generation Script Structure
  • 2.2 Main Procedure and Other Procedures
• 3 Comments
  • 3.1 Line Comment
  • 3.2 Block Comment
• 4 File-Including Directives
  • 4.1 Inline Directive
  • 4.2 Include Directive
• 5 Constant Declarations
  • 5.1 Predefined Constants
  • 5.2 Constant Definition Examples
• 6 Data Pattern Declarations
  • 6.1 Constants and Data Patterns in Declarations
  • 6.2 Leading Zeroes
• 7 Global Generation Settings
  • 7.1 Device Mode Settings
  • 7.2 Link Configuration Settings
  • 7.3 Link Delay Settings
  • 7.4 Link Power Management Settings
  • 7.5 LFPS Settings
  • 7.6 Link Error Settings
  • 7.7 Link Advertisement Error Injection Settings
  • 7.8 Send Packet Error Retry Settings
  • 7.9 Framing Error Settings
  • 7.10 Script Parser Settings
  • 7.11 Transaction Engine Settings
  • 7.12 Device Emulation Settings
  • 7.13 Generation Settings Syntax
  • 7.14 Generation Settings outside Procedures
  • 7.15 Generation Settings inside Procedures
  • 7.16 Arithmetic Expressions in Constants
• 8 Packet and Structure Template Declarations
  • 8.1 Predefined Packet/Structure Templates
  • 8.2 Field Definitions
    • 8.2.1 Defining a Field at a Specific Offset
    • 8.2.2 Defining a Field at the Current Offset
    • 8.2.3 Defining a Field with Variable Length
    • 8.2.4 Defining a Default Field Value
    • 8.2.5 Specifying Byte Order in Field Definitions
    • 8.2.6 Using Byte Stream Literals in Field Assignments
    • 8.2.7 List of Possible Field Values Attribute
    • 8.2.8 Defining Subfields
  • 8.3 Constants/Arithmetic Expressions in Template Declarations
  • 8.4 Packet Template Inheritance
    • 8.4.1 Packet Template Single Inheritance
    • 8.4.2 Packet Template Multiple Inheritance
    • 8.4.3 Packet Template Insert Directive
    • 8.4.4 Complex Packet Templates
  • 8.5 Packet Template Multi-byte Field Byte Order Attribute
    • 8.5.1 Big Endian Byte Order
    • 8.5.2 Another Example
  • 8.6 Structure Declaration Examples
• 9 Generation Procedures
  • 9.1 Transaction Engine Instructions
    • 9.1.1 SendPipeCommand Instruction
    • 9.1.2 SetSequenceNumber Instruction
    • 9.1.3 Transaction Engine Scripts supplied with Voyager
  • 9.2 Device Emulation Instructions
    • 9.2.1 StartDeviceFrameworkHandler Instruction
    • 9.2.2 InitDevice Instruction
    • 9.2.3 AddDescriptor Instruction
    • 9.2.4 WaitForDeviceRequest Instruction
    • 9.2.5 AddDrive Instruction
  • 9.3 Send Packet Instruction
    • 9.3.1
  • 9.4 Using Local Fields in Send Packet Instructions
  • 9.5 Instruction Parameters
  • 9.6 Structure Variable Syntax
    • 9.6.1 Omitting the Send Keyword
  • 9.7 Changing a Generation Setting
  • 9.8 SetLinkState Instruction
  • 9.9 TxSleep Instruction
  • 9.10 SendFile Instruction
  • 9.11 Wait Packet Instruction
  • 9.12 Prepare Wait Packet Instruction
  • 9.13 Wait Event Instruction
  • 9.14 Loop Instruction
  • 9.15 BreakLoop Instruction
  • 9.16 Exit Instruction
  • 9.17 Analyzer Control Instructions
    • 9.17.1 StartRecording Instruction
    • 9.17.2 StopRecording Instruction
    • 9.17.3 TriggerAnalyzer instruction
    • 9.17.4 Trace Instruction
    • 9.17.5 Trace_B Instruction
• 10 Advanced Script Parser Features
  • 10.1 Local Numeric Parser Variables
  • 10.2 Local Structure Parser Variables
  • 10.3 Using Local Fields in Structure Variables
  • 10.4 Changing Structure Parser Variables
  • 10.5 Sending Frames using Structure Variables
  • 10.6 Using Special Data Pattern Creators in Field Assignments
  • 10.7 Using Structure Variables to Assign Field Values
  • 10.8 Using Multipliers to Assign Field Values
  • 10.9 Using the Append Operator in Field Assignments
  • 10.10 Initializing Struct Variables from Hex Streams
    • 10.10.1 Assignments for Variables with Fixed-length Fields
    • 10.10.2 Assignments for Variables with Variable Length Fields
  • 10.11 Sizeof Operators
  • 10.12 Preprocessor Integer Arithmetic
  • 10.13 Preprocessor If Operator
  • 10.14 Preprocessor Loop Operators
  • 10.15 Forward Declarations
  • 10.16 RAND Token
  • 10.17 RandStream( n ) Primitive
  • 10.18 Global Numeric and Structure Variables
  • 10.19 Using the Call Directive for Generation Procedure Insertions
    • 10.19.1 Calling a Generation Procedure with Parameters
    • 10.19.2 Calling a Generation Procedure with No Parameters
    • 10.19.3 Nested Calls Using Global Variables
  • 10.20 Parser Tracing Functions
    • 10.20.1 PTrace( ) : Parser Trace
    • 10.20.2 PTraceVar( ) : Parser Trace Variable
    • 10.20.3 PTraceVarEx( ) : Parser Trace Variable Extended
    • 10.20.4 PtraceTemplate( ) : Parser Trace Template
  • 10.21 Name Aliasing
  • 10.22 Include Path Directive
• 11 Appendix A – Generation Script Example
  • 11.1 Example Script 1
  • 11.2 Example Script 2
• 12 Appendix B - Raw Register Settings
  • The following registers can be set using the SetRegister function:
  • SetRegister(<register_address>, <value>)
  • 12.1.1 SKP_TIMER
  • 12.1.2 PM_ACCEPT_MODE
  • 12.1.3 CORRUPT_LC
  • 12.1.4 CORRUPT_LMP
  • 12.1.5 CORRUPT_SHP_FRAMING
  • 12.1.6 CORRUPT_SDP_FRAMING
  • 12.1.7 CORRUPT_END_FRAMING
  • 12.1.8 CORRUPT_SLC_FRAMING
  • 12.1.9 DELAY_LAU
  • 12.1.10 Insert K-Sym Error (LC and HP)
  • 12.1.11 LTSSM_SETTING
  • 12.1.12 LTSSM_U3EXIT_CONTROL
  • 12.1.13 LTSSM_HOTRESET_TIME
  • 12.1.14 LTSSM_RXDETECT_CONTROL
  • 12.1.15 Generate LFPS Command
• 13 How to Contact Teledyne LeCroy