Teledyne-lecroy Verification Script Engine (VSE) Manual Manuel d'utilisateur

PROTOCOL SOLUTIONS GROUP 3385 SCOTT BLVD SANTA CLARA, CA 95054 Verification Script Engine for Teledyne LeCroy USB Protocol Suite™ Reference

Teledyne LeCroy Verification Script Engine Reference Manual Page 10 of 115 3 Interaction between Application and Verification Script The f

Teledyne LeCroy Verification Script Engine Reference Manual Page 100 of 115 20.4 OpenTraceFile() This function opens a trace file in the a

Teledyne LeCroy Verification Script Engine Reference Manual Page 101 of 115 21 COM/Automation Communication Functions This group of functi

Teledyne LeCroy Verification Script Engine Reference Manual Page 102 of 115 22 User Input Functions 22.1 MsgBox() Displays a message in

Teledyne LeCroy Verification Script Engine Reference Manual Page 103 of 115 Return Values: This function returns an integer value indicatin

Teledyne LeCroy Verification Script Engine Reference Manual Page 104 of 115 22.2 InputBox() Displays a prompt in a dialog box, waits for t

Teledyne LeCroy Verification Script Engine Reference Manual Page 105 of 115 Note: Although the dialog box input text parser tries to determi

Teledyne LeCroy Verification Script Engine Reference Manual Page 106 of 115 22.3 GetUserDlgLimit() This function returns the current limit

Teledyne LeCroy Verification Script Engine Reference Manual Page 107 of 115 22.4 SetUserDlgLimit() This function sets the current limit of

Teledyne LeCroy Verification Script Engine Reference Manual Page 108 of 115 23 String Manipulation/Formating Functions 23.1 FormatEx()

Teledyne LeCroy Verification Script Engine Reference Manual Page 109 of 115 Remarks: A conversion specification begins with a percent sign

Teledyne LeCroy Verification Script Engine Reference Manual Page 11 of 115 OnStartScript() Starting VSE running … Verification Script Call

Teledyne LeCroy Verification Script Engine Reference Manual Page 110 of 115 24 Miscellaneous Functions 24.1 ScriptForDisplayOnly() Spec

Teledyne LeCroy Verification Script Engine Reference Manual Page 111 of 115 24.2 Sleep() Asks VSE not to send any events to a script until

Teledyne LeCroy Verification Script Engine Reference Manual Page 112 of 115 24.3 ConvertToHTML() This function replaces spaces with "

Teledyne LeCroy Verification Script Engine Reference Manual Page 113 of 115 24.4 Pause() Pauses script running. Later, script execution ca

Teledyne LeCroy Verification Script Engine Reference Manual Page 114 of 115 25 The Important VSE Script Files The VSE working files are lo

Teledyne LeCroy Verification Script Engine Reference Manual Page 115 of 115 26 How to Contact Teledyne LeCroy Type of Service Contract Cal

Teledyne LeCroy Verification Script Engine Reference Manual Page 12 of 115 4 Running Verification Scripts from Application To run a verifi

Teledyne LeCroy Verification Script Engine Reference Manual Page 13 of 115 The Run verification scripts dialog opens where you choose then r

Teledyne LeCroy Verification Script Engine Reference Manual Page 14 of 115 4.1 Running Verification Scripts Push the button Run scripts af

Teledyne LeCroy Verification Script Engine Reference Manual Page 15 of 115 Right-clicking the script list displays some additional operation

Teledyne LeCroy Verification Script Engine Reference Manual Page 16 of 115 4.2 VSE GUI Settings After choosing Settings, the following di

Teledyne LeCroy Verification Script Engine Reference Manual Page 17 of 115 5 Verification Script Engine Input Context Members All verifica

Teledyne LeCroy Verification Script Engine Reference Manual Page 18 of 115 5.2 Trace Event-dependent Set of Members This set of members i

Teledyne LeCroy Verification Script Engine Reference Manual Page 19 of 115 Vbus Power parameter values: in.Power: The value of Vbus power a

Teledyne LeCroy Verification Script Engine Reference Manual Page 2 of 115 Document Disclaimer The information contained in this document has

Teledyne LeCroy Verification Script Engine Reference Manual Page 20 of 115 5.2.1.1 USB Bus Condition-specific Set of Members Note: Valid fo

Teledyne LeCroy Verification Script Engine Reference Manual Page 21 of 115 5.2.1.2 USB2 Packet-specific Set of Members Note: Valid for USB

Teledyne LeCroy Verification Script Engine Reference Manual Page 22 of 115 5.2.1.2.1 USB2 Token Packet Members in.Addr: Value of the Addre

Teledyne LeCroy Verification Script Engine Reference Manual Page 23 of 115 5.2.1.2.5 Link Power Management Extended Token Members in.HIRD:

Teledyne LeCroy Verification Script Engine Reference Manual Page 24 of 115 5.2.1.3 USB3 Packet-specific Set of Members Note 1: Valid for U

Teledyne LeCroy Verification Script Engine Reference Manual Page 25 of 115 5.2.1.3.5 Link Command Packet Members in.LnkCmd: Index of the

Teledyne LeCroy Verification Script Engine Reference Manual Page 26 of 115 5.2.1.3.10 Transaction Packet Members in.SubType: SubType valu

Teledyne LeCroy Verification Script Engine Reference Manual Page 27 of 115 5.2.1.3.12 Getting Values of the Fields not present in Input Co

Teledyne LeCroy Verification Script Engine Reference Manual Page 28 of 115 # Hex Value val = GetHexPktField ( "NumP&q

Teledyne LeCroy Verification Script Engine Reference Manual Page 29 of 115 5.2.2 Transaction-specific Set of Members in.TraToken: Token PID

Teledyne LeCroy Verification Script Engine Reference Manual Page 3 of 115 Contents 1 INTRODUCTION ...

Teledyne LeCroy Verification Script Engine Reference Manual Page 30 of 115 in.Split: Signals that the transaction is a start-split or comple

Teledyne LeCroy Verification Script Engine Reference Manual Page 31 of 115 5.2.3 Split Transaction-specific Set of Members All the input co

Teledyne LeCroy Verification Script Engine Reference Manual Page 32 of 115 5.2.4 Transfer-specific Set of Members in.XferType: Type of tra

Teledyne LeCroy Verification Script Engine Reference Manual Page 33 of 115 6 Verification Script Engine Output Context Members All verific

Teledyne LeCroy Verification Script Engine Reference Manual Page 34 of 115 7 Verification Script Engine Events VSE defines a large group o

Teledyne LeCroy Verification Script Engine Reference Manual Page 35 of 115 7.1 Packet Level Events The table below describes the current l

Teledyne LeCroy Verification Script Engine Reference Manual Page 36 of 115

Teledyne LeCroy Verification Script Engine Reference Manual Page 37 of 115 7.2 Transaction Level Events The table below describes the curr

Teledyne LeCroy Verification Script Engine Reference Manual Page 38 of 115 8 Sending Functions This topic contains information about the

Teledyne LeCroy Verification Script Engine Reference Manual Page 39 of 115 8.2 SendLevelOnly() This function specifies that ONLY events of

Teledyne LeCroy Verification Script Engine Reference Manual Page 4 of 115 9.1 GETDECODEDPKTFIELD() ...

Teledyne LeCroy Verification Script Engine Reference Manual Page 40 of 115 8.3 DontSendLevel() This function specifies that events of a sp

Teledyne LeCroy Verification Script Engine Reference Manual Page 41 of 115 8.4 SendChannel() This function specifies that events on the sp

Teledyne LeCroy Verification Script Engine Reference Manual Page 42 of 115 8.5 SendChannelOnly() This function specifies that ONLY events

Teledyne LeCroy Verification Script Engine Reference Manual Page 43 of 115 8.6 DontSendChannel() This function specifies that events occur

Teledyne LeCroy Verification Script Engine Reference Manual Page 44 of 115 8.7 SendAllChannels() This function specifies that events occur

Teledyne LeCroy Verification Script Engine Reference Manual Page 45 of 115 8.8 SendTraceEvent() This function specifies the events to be s

Teledyne LeCroy Verification Script Engine Reference Manual Page 46 of 115 8.9 DontSendTraceEvent() This function specifies that the event

Teledyne LeCroy Verification Script Engine Reference Manual Page 47 of 115 8.10 SendTraceEventOnly() This function specifies that ONLY the

Teledyne LeCroy Verification Script Engine Reference Manual Page 48 of 115 8.11 SendAllTraceEvents() This function specifies that ALL trac

Teledyne LeCroy Verification Script Engine Reference Manual Page 49 of 115 8.12 SendDirection() This function specifies more precise tunin

Teledyne LeCroy Verification Script Engine Reference Manual Page 5 of 115 19.1 OPENFILE() ...

Teledyne LeCroy Verification Script Engine Reference Manual Page 50 of 115 8.13 SendUsb2BusConditions() This function specifies more preci

Teledyne LeCroy Verification Script Engine Reference Manual Page 51 of 115 8.14 SendUsb2TokenPackets() This function specifies more precis

Teledyne LeCroy Verification Script Engine Reference Manual Page 52 of 115 8.15 SendUsb2DataPackets () This function specifies more precis

Teledyne LeCroy Verification Script Engine Reference Manual Page 53 of 115 8.16 SendUsb2HskPackets() This function specifies more precise

Teledyne LeCroy Verification Script Engine Reference Manual Page 54 of 115 8.17 SendTransaction() This function works on the Transaction l

Teledyne LeCroy Verification Script Engine Reference Manual Page 55 of 115 8.18 SendTransfer() This function works on the Transfer level a

Teledyne LeCroy Verification Script Engine Reference Manual Page 56 of 115 8.19 SendPktsWithBadCRC() This function instructs VSE to send pa

Teledyne LeCroy Verification Script Engine Reference Manual Page 57 of 115 9 Packet and Script Decoded Fields Retrieving Functions This g

Teledyne LeCroy Verification Script Engine Reference Manual Page 58 of 115 9.2 GetHexPktField() Extracts the raw hexadecimal value of the

Teledyne LeCroy Verification Script Engine Reference Manual Page 59 of 115 9.3 GetDecodedScriptField() Extracts information about the scr

Teledyne LeCroy Verification Script Engine Reference Manual Page 6 of 115 1 Introduction This document describes the Teledyne LeCroy USB

Teledyne LeCroy Verification Script Engine Reference Manual Page 60 of 115 9.4 GetHexScriptField() Extracts the raw hexadecimal value of t

Teledyne LeCroy Verification Script Engine Reference Manual Page 61 of 115 10 Timer Functions This group of functions covers VSE capabilit

Teledyne LeCroy Verification Script Engine Reference Manual Page 62 of 115 10.2 SetTimer() Starts a timing calculation from the event at w

Teledyne LeCroy Verification Script Engine Reference Manual Page 63 of 115 10.3 KillTimer() Stops a timing calculation for a specific time

Teledyne LeCroy Verification Script Engine Reference Manual Page 64 of 115 10.4 GetTimerTime() Retrieves a timing interval from the specif

Teledyne LeCroy Verification Script Engine Reference Manual Page 65 of 115 11 Time Construction Functions This group of functions is used

Teledyne LeCroy Verification Script Engine Reference Manual Page 66 of 115 12 Time Calculation Functions This group of functions covers VS

Teledyne LeCroy Verification Script Engine Reference Manual Page 67 of 115 12.2 SubtractTime() Subtracts two VSE time objects. Format: Su

Teledyne LeCroy Verification Script Engine Reference Manual Page 68 of 115 12.3 MulTimeByInt() Multiplies a VSE time object by an integer

Teledyne LeCroy Verification Script Engine Reference Manual Page 69 of 115 12.4 DivTimeByInt() Divides a VSE time object by an integer val

Teledyne LeCroy Verification Script Engine Reference Manual Page 7 of 115 2 Verification Script Structure Writing verification scripts is

Teledyne LeCroy Verification Script Engine Reference Manual Page 70 of 115 13 Time Logical Functions This group of functions covers VSE ca

Teledyne LeCroy Verification Script Engine Reference Manual Page 71 of 115 13.2 IsLessTime() Verifies that one VSE time object is less tha

Teledyne LeCroy Verification Script Engine Reference Manual Page 72 of 115 13.3 IsGreaterTime() Verifies that one VSE time object is great

Teledyne LeCroy Verification Script Engine Reference Manual Page 73 of 115 13.4 IsTimeInInterval() Verifies that a VSE time object is grea

Teledyne LeCroy Verification Script Engine Reference Manual Page 74 of 115 14 Time Text Functions This group of functions covers VSE capab

Teledyne LeCroy Verification Script Engine Reference Manual Page 75 of 115 15 Output Functions This group of functions covers VSE capabili

Teledyne LeCroy Verification Script Engine Reference Manual Page 76 of 115 15.2 EnableOutput() Enables showing information in the output w

Teledyne LeCroy Verification Script Engine Reference Manual Page 77 of 115 15.3 DisableOutput() Disables showing information in the output

Teledyne LeCroy Verification Script Engine Reference Manual Page 78 of 115 16 Information Functions 16.1 GetTraceName() This function

Teledyne LeCroy Verification Script Engine Reference Manual Page 79 of 115 16.2 GetScriptName() This function returns the name of the veri

Teledyne LeCroy Verification Script Engine Reference Manual Page 8 of 115 ##################################################################

Teledyne LeCroy Verification Script Engine Reference Manual Page 80 of 115 16.3 GetApplicationFolder() This function returns the full path

Teledyne LeCroy Verification Script Engine Reference Manual Page 81 of 115 16.4 GetCurrentTime() This function returns the string represen

Teledyne LeCroy Verification Script Engine Reference Manual Page 82 of 115 16.5 GetTraceStartTime() This function returns the VSE Time obj

Teledyne LeCroy Verification Script Engine Reference Manual Page 83 of 115 16.6 GetTraceEndTime() This function returns the VSE Time objec

Teledyne LeCroy Verification Script Engine Reference Manual Page 84 of 115 17 Power Tracker Functions This functions can be used to retrie

Teledyne LeCroy Verification Script Engine Reference Manual Page 85 of 115 17.2 GetPwrPowerValue() This function returns the captured val

Teledyne LeCroy Verification Script Engine Reference Manual Page 86 of 115 17.3 GetPwrVoltageValue() This function returns the captured v

Teledyne LeCroy Verification Script Engine Reference Manual Page 87 of 115 17.4 GetPwrCurrentValue() This function returns the captured v

Teledyne LeCroy Verification Script Engine Reference Manual Page 88 of 115 18 Navigation Functions 18.1 GotoEvent() This function force

Teledyne LeCroy Verification Script Engine Reference Manual Page 89 of 115 18.2 SetMarker() This function sets a marker for some trace eve

Teledyne LeCroy Verification Script Engine Reference Manual Page 9 of 115 ##################################################################

Teledyne LeCroy Verification Script Engine Reference Manual Page 90 of 115 19 File Functions This group of functions covers VSE capabiliti

Teledyne LeCroy Verification Script Engine Reference Manual Page 91 of 115 19.1 OpenFile() This function opens a file for writing. Format

Teledyne LeCroy Verification Script Engine Reference Manual Page 92 of 115 19.2 CloseFile() This function closes an opened file. Format:

Teledyne LeCroy Verification Script Engine Reference Manual Page 93 of 115 19.3 WriteString() This function writes a text string to the fi

Teledyne LeCroy Verification Script Engine Reference Manual Page 94 of 115 19.4 Write() This function writes data to the file. Format: Wr

Teledyne LeCroy Verification Script Engine Reference Manual Page 95 of 115 19.5 ShowInBrowser() This function opens a file in the Windows

Teledyne LeCroy Verification Script Engine Reference Manual Page 96 of 115 20 Trace File Exporting Functions This group of functions cove

Teledyne LeCroy Verification Script Engine Reference Manual Page 97 of 115 20.1 CreateTraceFile() This function creates a trace file. For

Teledyne LeCroy Verification Script Engine Reference Manual Page 98 of 115 20.2 CloseTraceFile() This function closes an open trace file.

Teledyne LeCroy Verification Script Engine Reference Manual Page 99 of 115 20.3 AddEventToTraceFile() This function adds the current trace