Teledyne ST User Manual

PROTOCOL SOLUTIONS GROUP
3385

SCOTT BLVD

SANTA CLARA, CA 95054

Automated Test Suite

User Manual

ST

Manual Version 1.10

Software Version 1.10

November 2012

Document Disclaim er

The information contained in this document has been carefully checked and is believed to be
reliable. However, no responsibility can be assumed for inaccuracies that may not have been
detected. Teledyne LeCroy reserves the right to revise the information presented in this document
without notice or penalty.

Trademarks and Servicemarks

Teledyne LeCroy and ST Automated Test Suite are trademarks o f Teledyne LeCroy.
Microsoft and Windows are registered trademarks of Mi cr os o ft Inc.
All other trademarks are property of their respective companies.

Copyright

Teledyne LeCroy© 2012. All rights reserved.
This document may be printed and reproduced without additional permission, but all copies should

contain this copyright notice.

2

Contents

1. Introduction ...................................................................................................................... 4

1.1 Test Case Overview .................................................................................................. 4

1.2 Folder Structure ......................................................................................................... 4

2. Automated Test Suite Appl i cati o n S hell ........................................................................... 5

2.1 Main Toolbar .............................................................................................................. 6

2.2 Workspace Area ........................................................................................................ 8

2.3 Test Monitoring Console ............................................................................................ 9

2.4 Output Window ........................................................................................................ 10

2.5 Menus ...................................................................................................................... 10

3. Operation of the Automated Test Suite Software ........................................................... 11

4. Writing ATS VB Scripts .................................................................................................. 12

4.1 Creating the Main Objects ....................................................................................... 12

4.2 Specifying Port Configuration .................................................................................. 14

4.3 Running the Analyzer and Capturing a Trace File ................................................... 15

4.4 Running Host Emulator ............................................................................................ 16

4.5 Running Trainer ....................................................................................................... 17

4.6 Running InFusion ..................................................................................................... 19

4.7 Activating Device Emulator ...................................................................................... 20

4.8 Running Mixed Configurations/Functionalities ......................................................... 21

4.9 VSE Verification ....................................................................................................... 23

4.10 Loading Pre Emphasis Signal Settings............................................................... 32

How to Contact Teledyne LeCroy ............................................................................................ 33

3

1. Introduction

The ST Automated Test Suite is a turnkey verification system that allows developers to pre-test
devices for SAS/SATA specification conformance. The system generates specific traffic conditions to
the Host or Device under Test (DUT). The Analyzer simultaneously records and analyz es responses.
The ST Automated Test Suite includes a software console that manages the entire compliance
verification proc ess by allowing users to run individual test cases or run the full suite in batch mode
operation.

The ST Automated Test Suite operates on Sierra M6-4, Sierra M6-2 and Sierra M6-1 platforms.

1.1 Test Case Overview

Each individual test case is controlled by a VB script that automates operation of the hardware and
software. The ST Automat ed Tes t Suite has Available VB Scripts:

o General, such as PreemphasisLoad and VSE
o Analyzer, such as Multi-Open-Close, Run Analyzer project (Make recording), and Run Analyzer

project (Start-stop recording)

o Target Emulator, such as Activate-Deactivate and Analyzer-Target
o Host Emulator, such as AnalyzerExerciser and HostOnly
o Infusion, such as Analyzer-Infusion and Infusion
o Trainer, such as Analyzer-Trainer, Analyzer-Trainer - 1 Port, Analyzer-Trainer - 2 Ports, Trainer

Only, and Trainer WithEx i tC ode

o Mixture Configurations, such as AnalyzerDeviceInfusion, AnalyzerHostDevice, HostInfusion,

TargetInfusion, Trai n er In fusi o n

See Chapter 4, Writing ATS VB Scripts.

1.2 Folder Structure

The ST Automated Test Suite application has its own folder structure. These folder s are a t the top
level:

o Examples/Scripts: Contains VB scripts.
o Reports: Contains the generated reports.
o Output: Def ault fol der f or sav ing trace files. You can change the default folder in the

Settings dialog.

4

2. Automated Test Suite Application Shell

The ST Automated Test Suite installs an application that initiates the test process and manages the
test output (Figure 2-1).

Figure 2-1

The software contains the following main parts:

o Main Toolbar
o Workspace Area
o Monitoring Console
o Output Window
o Menus

5

2.1 Main Toolbar

Settings Button

The Settings button, at the left, opens the Settings dialog (Figure 2-2), which provides access to
user-configurable options.

Figure 2-2

VB Scripts root directory: Specifies the folder in which to save VB scripts.
Generated reports path: Specifies the folder in which to save reports.
Trace files path: Specifies the folder in which to save trace file output during test execution.
VB Script Editor: Specifies the application with which to open VB scripts.

Automatically Save Log: To automatically save log files, select the checkbox and enter the

File Path and the Max(imum) Size in kilobytes.

Project files path: Specifies the folder in which to save the project.
Automatically Save Log: To automatically save log files, select the checkbox and enter the

File Path and the Max(imum) Size in kilobytes.
ATS working protocol: Specifies SAS or SATA protocol.

6

Configuration Button
The Configuration button opens the Configuration dialog (Figure 2-3), in which you can enter the

DUT Name and then set the SAS Address and Speed (1.5 Gbps, 3.0 Gb ps, 6. 0 Gbps, or

AutoSpeed) for each Port number.

Figure 2-3
Click the Find Device button to locate devices.

Help Button

The Help button displays information about the application.

7

2.2 Workspace Area

The Workspace Area provides a nested tree structure that allows you to select individual tests to run
(Figure 2-4).

Figure 2-4
This window lists all available tests. Checkboxes allow selection of the entire suite or individual test

cases.

Buttons

After tests are selected, the Add button adds test(s) to the execution pipe.
After tests are selected, the Show VBS button, or double-clicking the test case name, opens the VB

script file in the Scripts Editor, such as the Notepad application.
The Refresh Test list button refreshes the list of tests, if tests have been added or modified within

the Scripts folder.

8

2.3 Test Monitoring Console

The Test Monitoring Console (Figure 2-5) lists the tests that have been selected for execution, their
results, and their descriptions.

Figure 2-5
After adding a test (using the Add button in the Workspace Area), the test appears in the

Test Monitoring Console.
The Result column displays the test status upon completi on . The Result field may display Passed,

Failed, or Done.

• When the test passes, Pass is shown in the Result field on a green background.

• When the test fails, Fail is shown in the Result field on a red background.

• When the test executes and the verification process is unable to confirm the expected behavior,

Done is shown in the Result fiel d on a gray background (rarely occurs).

• When the test is unable to capture a valid trace file, the software displays a message:
“Error during recording; No trace file created”.

If the test fails, the verification software shows an error code in the Description field.

Buttons

The green Run all button, at the left, starts execution in sequential order of all tests in the monitoring
window.

The black Stop button, second from left, allows you to stop execution of the current test run.
The Run Failed Test Case(s) button, third from left, runs the failed test cases again.
The Run Selected Test Case(s) button, fourth from left, runs the selected test cases. You can select

multiple rows using CTRL+Right-Click.
The Remove Selected Test Case(s) button, fifth form left, deletes the selected tests from the list of

potential running tests. You can select multiple rows using CTRL+Right-Click.

9

The Remove All Test Case(s) button, sixth from left, removes all tests from the running queue.
Upon completion of a test run, the View HTML report of latest run button, seventh form left, opens

a summary report. The HTML report summarizes the test results including the result, suspected error
code, and test execution details. If individual test cases generate a fail result, hyperlinks are added to
navigate directly to the error point in the trace file.(Figure 2-7):

Upon completion of a test run, the View XML report of latest run button, ei ghth from left, opens an
XML version of the summary report.

The Load Project button, second from right, loads saved Projects from a folder. A Project is a
collection of scripts. The scripts are listed in the right pane.

The Save Project button, at the right, saves the current Project to a folder.

2.4 Output Window

The Output Window (Figure 2-6) provides a real time test log in text format. The software generates
a text-based report during execution of the test run and appends the report to the Output Window as
each test completes. The log summarizes the status of the each test and alerts you to possible test
operation problems as they are detected.

Figure 2-6

Buttons

The Save Log button, second from left, saves the Log to a text file.
The Print Log button, second from right, prints the Log.
The Clear button, at the right, clears the window.

2.5 Menus

The Menus are:

o File: Configuration, Settings, Exit
o Run: Run, Stop
o Commands: Add, Remove, Add All, Remove All
o View: Toolbar, Status Bar, Workspace, Output
o Reports: HTML, XML
o Help: Help Topics, About LeCroy STATS

10

3. Operation of the Automated Test Suite Software

When an initial test run starts, the software takes t he following steps:

1) The Run all button starts execution in sequential order of all tests in the Test Monitoring Console.

2) Within the Output Window:

Start Recording indicates that the Analyzer begins recording traffic.
Start Generation indicates that the Trainer starts to execute the test script.
Waiting displays while the test is executi ng .
Stop Generation displays when the test script has finished executing.
Stop Recording displays when the Analyzer has stopped capturing data and automatically

begins uploading the trace file.
Run Verification Script indicates the appropriate verification script has been retrieved and is

automatically analyzing the results of the test.

Passed or Failed displays based on the result of the test .
Finished displays after the test result updates in the Test Monitoring Console.
Retry displays when Fail is logged for a given test and the automat ically re-run test option is

enabled in the Settings dialog.

3) Within the Test Monitoring Console:
Pass, Fail, or N/A is added to the Results column.
Error codes are added to the Description column.

11

4. Writing ATS VB Scripts

The most important and significant part of running an automation test is writing their VB Scripts. You
need to write your own VB Scripts for your automation tests and therefore you mus t unders t and how
VB Scripts should be prepared.

NOTE: Currently, ATS does support segmented memory and auto run. Auto run is an application
feature which the user can implement in VB script.

4.1 Creating the Main Objects

You must create two main automation objects at the begi nning of any VB Script. The first one is the
STATS object, which sends test results, reports, and possible errors to the STATS environment. The
second one is the SierraSASAnalyzer object, which runs Analyzer, Emulator, Trainer, InFusion, and
VSE projects.

To create automation objects, call the CreateObject function. LECROY is the name of the
namespace that includes all LeCroy automation objects.

To create the STATS automation object, use the following code in your VB Script:

Set MySTATS = WScript.CreateObject("LECROY.STATS")
If Err.Number <> 0 Then
WScript.Echo "STATS Creation Failed"
WScript.Quit
ELSE
MySTATS.ReportText ("My STATS started...")
MySTATS.ReportText ("STATS Automation object is created")
End If

To create the SierraSASAnalyzer automation object, use the follow i ng code in your VB Script:

Set MySASAutomation = WScript.CreateObject("LECROY.
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
End If
MySTATS.ReportText ("Analyzer is created successfully")

The STATS Object has the following reporting functions:

o HRESULT ReportText(BSTR bstrText); Reports the text that will appear on the output

bar in the STATS environment.

o HRESULT ReportError(LONG nErrorCode, BSTR bstrDescription): Reports

possible errors wi th error codes and descriptions that appear on both the output bar
and the Detail column of the running area in the STATS software.

o HRESULT ReportResult(LONG nResult): Sends the result of the automation test to

display on the Result column of the running area in the STATS environment. Numbers
indicate:
0 =Not Applicable (N/A)
1 = Pass
2 = Fail

o HRESULT ReportDetail(BSTR bstrDetailText): Sends the detail of the automation test

to display on the Detail column of the running area in the STATS environment.

SierraSASAnalyzer")

12

The STATS Object has also the following configuration functions:

o HRESULT GetProjectPath(BSTR* pbstrProjectPath): Returns the project path.
o HR ESU LT Set Pr oj ect P ath( BSTR bstrProjectFi l ePath) : S ets t he proje c t path. It ch ang es

the project file path in the settings dialog of the STATS software.

o HRESULT GetTraceFilePath(BSTR* pbstrTraceFilePath): Returns the trace file path

generated by the SAS or SATA software.

o HR ESU LT Set TraceFilePath(BS TR bstrTraceFilePath): Sets the trace file path. It

changes the trace file path in the settings dialog of the STATS software.

o HR ESU LT GetD UTName(BSTR* pbstrD UTName): Returns the DUT name.
o HRESULT SetDUTName(BSTR bstrDUTName): Sets the DUT name. It changes the

DUT name in the configuration dialog of the STATS software.

o HRESULT SetReportPath(BSTR bstrReportPath): Sets the generated report path. It

changes the report path in the settings di al og o f the STATS software.

The SierraSASAnalyzer object/SierraSTAnalyzer object has the following functions available:

o HRESULT GetVersion([in] EAnalyzerVersionType version_type,

[out,retval] WORD* analyzer_ver sion);

o HRESULT OpenFile([in] BSTR file_name, [out,retval] IDispatch** trace);
o HR ESU LT Star tGeneration([in] BSTR gen_file_name);
o HR ESU LT Sto pGeneration(void);
o HR ESU LT Star tR ecording([in] BSTR ro_file_name);
o HRESULT StopRecording([in] BOOL abort_upload);
o HRESULT MakeRecording([in] BSTR ro_file_name, [out,retval] IDispatch** trace);
o HR ESU LT Lo adD is pl a yOptions([in] BSTR do_file_name, [in] short do_layers);
o HR ESU LT GetR ecordingOptions( [out,retval] IDispatch** recording_options);
o HRESULT ResumeGeneration(void);
o HRESULT ActivateDevice( [in] BSTR bstrFileName);
o HRESULT DeactivateDevice();
o HR ESU LT Set Sc en ar i oToPor t ([ in]int nBoardIndex, [in]int nPortIndex,

[in]BSTR bstrLibraryName, [in]BSTR bstrScenarioName, [out, retval] int*
pnErrorCode);

o HR ESU LT Star t Sc en ar i o( [in]int nBoardIndex, [in]int nPortIndex);
o HR ESU LT Sto pSc e nario([in]int nBoardIndex, [in]int nPortIndex);
o HR ESU LT Set Por tC on fig ur at ion([in]int nBoardIndex, [in]int nPortConfiguration);
o HRESULT StartGenerationByPort([in] BSTR gen_file_n a me, [in] int nUnitIndex,

[in]int nPortIndex);

o HR ESU LT Sto pGenerationByPort ([ in] int nUnitIndex, [in]int nPortIndex);
o HR ESU LT Get Tr ainerExitCode([in] int nBoardIndex, [in] int nPortIndex,

[out, retval] BYTE* pyTrainerExitCode);

o HR ESU LT Lo adPr e Em phas is Si g nal Fi l e( [in]B STR bs tr Pr eE mp hasi sSignalFile,

[out, retval]BOOL* pbRetval);

For detailed descriptions of these functions, refer to the Automation API Reference Manual.

13

4.2 Specifying Port Configura t ion

After creating the SierraSASAnalyzer and STATS automation objects, specify the port configuration
by calling the SetPortConfiguration function. This function specifies the functionality for each port
(Refer to the Automation API Reference Manual for port configur ati o n lists and their values). Use the
following code to set port configuration:

MySASAutomation.SetPortConfiguration 0, 72 ' 72 is the code for DEVICE_CONFIG_AT_0_0_0
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Set port configuration is done")
End If

14

4.3 Running the Analyzer and Ca pt uring a Trace File

To run an Analyzer project and create a trace file, you have two options. The first one is Start/Stop
Recording, and the second one is MakeRecording.

Using either option, the captured trace file is stored in the Trace File Path specified in the Settings
dialog. The trace file name is the test name and is in a folder w i th a name similar to the device (DUT)
name specified in the Configuration dial og .

Start/Stop Recording

You can start capturing by calling the StartRecording function, using as inpu t param et er t he pat h of
the Analyzer project.

MySASAutomation.StartRecording("E:\ AnalyzerOnly.sac")
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Recording is started")
End If

WScript.Sleep(10000) ' Wait 10 seconds for our capturing process.

You stop recording by calling the StopRecording function after waiting enough time for the capturing
process to complete. The parameter specifies whether you want to stop capturing only or you want to
create your trace file also. The FALSE value creates a trace file.

MySASAutomation.StopRecording(FALSE)
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Recording is stopped")
End If

To get the object of the generated trace file, call the OpenFile function to open the file and return the
reference.

Set SASTracer = MySASAutomation.OpenFile("E:\Output\Device 1\AnalyzerOnly.scs")
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Trace file is opened")
End If

15

Make Recording

You can call the MakeRecording function, using as input parameter the pat h of the Analyzer project,
to start capturing, using the current the triggering strategy and specified sample size,. After those
limits are reached, the device stops, and the trace file is generated. With this option, you do not need
to wait for capturing. T he function return value is the reference to the generated trace file.

Set SASTracer = MySASAutomation.MakeRecording("E:\Make-Recording.sac")
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Trace is created")
End If

Closing
After SASTracer is opened and used, close it by calling the Close function. .

SASTracer.Close()

4.4 Running Host Emulator

Running a Host Emulator project is similar to running an Analyzer project. You can use ei th er the
Start Recording or MakeRecording option. Use the Host Emulator project as the par a me te r , rather
than the Analyzer project. Set your port configuration to the device type that has at least one port of
Host Emulator functionality (for example DEVICE_CONFIG_HE_0_0_0).

16

4.5 Running Trainer

To run a Trainer project, you must specify the SSG file for eac h port on which you want to start
Trainer. Call the StartGenerationByPort function and specify the Trainer file, board index, and port
index to start generation on the specified port. For example, if you have set port configuration to
DEVICE_CONFIG_AT_AT_0_0, then call StartGenerationByPort for the first and second ports. To
stop generation, call the StopGenerationByPort function for each port on which Trainer has started.

Use the following code to start and stop generat ion f or ports 0 and 1 :

'--------- Set port configuration to DEVICE_CONFIG_T_T_A_A --------­MySASAutomation.SetPortConfiguration 0, 88
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Set port configuration is done")
End If

'--------- Start first Generation on Port 0 --------­MySASAutomation.StartGenerationByPort "E: \Projects\AnalyzerTrainer-Port one.ssg", 0, 0
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is started on Port 1")
End If

'--------- Start second Generation on Port 1 --------­MySASAutomation.StartGenerationByPort "E:\Projects\AnalyzerTrainer-Port Two.ssg", 0, 1
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is started on Port 2")
End If

'-------- Stop Generation on Port 0 -------­MySASAutomation.StopGenerationByPort 0, 0
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is stopped on port 1")
End If

'-------- Stop Generation on Port 1 -------­MySASAutomation.StopGenerationByPort 0, 1
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is stopped on Port 2")
End If

17

If you have only one port for generation, you can use another pair of starting and stopping generation
functions, which require no board or port index, because Trainer can only be started on the single
Trainer port. Specify the Trainer port by the SetPortConfiguration function. Use the following code:

'--------- Set Port Configuration to DEVICE_CONFIG_AT_0_0_0 --------­MySASAutomation.SetPortConfiguration 0, 72
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Set port configuration is done")
End If

'--------- Start an generation file --------­MySASAutomation.StartGeneration "E:\Projects\AnalyzerTrainer.ssg"
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is started")
End If

'--------- Stop Generation --------­MySASAutomation.StopGeneration
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is stopped")
End If

To exit, call the GetTrainerExitCode function. Use the following code to exit generation for port 0 of
board 0.

ExitCode = MySASAutomation.GetTrainerExitCode(0, 0)
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("ExitCode is Received")
End If

18

4.6 Running InFusion

You can use the SierraSASAnalyzer automation object to run InFusion and start scenarios from
previously saved libraries:

1- Set scenario to port: Assigns a scenario from a library to a specific port of the board.
2- Start scenario: Starts scenario on the specified port of the board
3- Stop scenario: Stops scenario on the specified port of the board.

Depending on the port configuration and the number of Jammer ports, you may need to repeat the
steps. For example, if you have 2 ports of Jammer (DEVICE_CONFIG_J_J_0_0) and you want to
start scenario on ports 0 and 1, use the following code:

' --------- set port configuration of board to DEVICE_CONFIG_J_J_0_0 ---------

MySASAutomation.SetPortConfiguration 0, 68
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Set port configuration is done")
End If

' --------- Assign “FourthScenario” of VTSE.infdb library to the port 0 of board 0 --------­MySASAutomation.SetScenarioToPort 0, 0, "E: \Projects\VTSE.infdb", "FourthScenario"
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is set to port 0")
End If

' --------- Assign “ThirdScenario” of VTSE.infdb library to the port 1 of board 0 --------­MySASAutomation.SetScenarioToPort 0, 1, "E:\Projects\VTSE.infdb", "ThirdScenario"
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is set to port 1")
End If

'--------- Start scenario on port 0 board 0 --------­MySASAutomation.StartScenario 0, 0
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is started on port 0")
End If

'--------- Start scenario on port 1 board 0 --------­MySASAutomation.StartScenario 0, 1
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is started on port 1")
End If

'--------- Stop scenario on port 0 board 0 --------­MySASAutomation.StopScenario 0, 0
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is stopped on port 0")
End If

19

'--------- Stop scenario on port 1 board 0 --------­MySASAutomation.StopScenario 0, 1
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Scenario is stopped on port 1")
End If

4.7 Activating Device Emulator

To activate/deactivate Device Emulator projects, call the ActivateDevice and DeactivateDevice
functions from the SASAnalyer automation obj ec t, using as parameter the device emulator project.
Use the following code to activate/deactivate a device emulator:

'--------- Activate a Target Emulator project --------­MySASAutomation.ActivateDevice "E:\Projects\DeviceOnly.std"
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Device is activated")
End If

WScript.Sleep(5000)

'--------- Stop recording and make trace file --------­MySASAutomation.DeactivateDevice()
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Device is deactivated")
End If

20

4.8 Running Mixed Configurat ions/Functionalities

For several port configurations, you can run Analyzer, Trainer, Host Emulator, Device Emulator, and
Infusion at the same time. For possible port configurations, refer to the Automation API Reference
Manual.
You can run Analyzer with all other functionalities.
Use the following examples of Analyzer-Host-Device and Trainer-Infusion to write your own mixture
configuration automation tests: (Note that error checking parts have been removed from these
examples.)

Analyzer-Host-Device

'--------- set port configuration to DEVICE_CONFIG_AHE_0_ADE_0 --------­ MySASAutomation.SetPortConfiguration 0, 100

'--------- Run an Analyzer/Exerciser project --------­MySASAutomation.StartRecording("E:\AnalyzerHostDevice(AHE-0-ADE-0).sac")

'--------- Activate a Target Emulator project --------­ MySASAutomation.ActivateDevice "E:\Projects\DeviceOnly.std"

'--------- wait for 5 seconds --------­WScript.Sleep(5000)

'--------- Deactivate device --------­ MySASAutomation.DeactivateDevice()

'--------- Stop recording and make trace file --------­ MySASAutomation.StopRecording(FALSE)

'--------- Open trace file and have access to its trace file, and later close it -------

--

Set SASTracer = MySASAutomation.OpenFile("E:\AnalyzerHostDevice(AHE-0-ADE-0).scs")

'--------- call a function to see how many packet there are in trace file --------­MySTATS.ReportText ("Number of packets in trace file : " &
CSTR(SASTracer.GetPacketsCount()))

'--------- Close trace file --------­SASTracer.Close()

21

Trainer-Infusion

'--------- set port configuration to DEVICE_CONFIG_TJ_0_0_0 --------­ MySASAutomation.SetPortConfiguration 0, 80

'--------- Start a generation file --------­ MySASAutomation.StartGenerationByPort "E:\Projects\TrainerOnly.ssg", 0, 0

'--------- Assign scenario to port 0 board 0 --------­ MySASAutomation.SetScenarioToPort 0, 0, "E:\VTSE.infdb", "FirstScenario"

'--------- Start scenario --------­MySASAutomation.StartScenario 0, 0

'--------- Stop scenario --------­MySASAutomation.StopScenario 0, 0

'--------- Stop Generation --------­ MySASAutomation.StopGeneration 0, 0

22

4.9 VSE Verification

After a trace file is generated and its trace object is accessed, you can do VSE verification on that
trace file. Call the RunVerificationScript function, with parameter the VSE script, to verify the trace
file based and return the result of verification. The return value shows whether the result passes or
fails:

0 = FAIL
1 = PASS
2 = Done

Use the following code to run verification:

'--------- Open trace file --------­Set SASTracer = MySASAutomation.OpenFile("C:\Cascading-3 Board.scs")
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Sample file is opened")
End If

'--------- Run Verification with SASVS script --------­VSEResult = SASTracer.RunVerificationScript ("C:\sample_ssp_protocol.sasvs")
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Run Verification finished")
End If

'--------- Report result --------­MySTATS.ReportText ("VSE Result - " & CSTR(VSEResult))
If VSEResult = 0 Then
MySTATS.ReportText ("VSE Result - FAILED")
End If

If VSEResult = 1 Then
MySTATS.ReportText ("VSE Result - PASSED")
End If

If VSEResult = 2 Then
MySTATS.ReportText ("VSE Result - DONE")
End If

23

VSTools.inc File of Verification Script Tools

You should include the VSTools.inc include file in all verificatio n script s. This file contains important script
functions and is a supplement to the Verification Script Engine API provided by the application.It also has
some useful examples.

#########################################################################################
# Copyright (c) 1998 - 2005, LeCroy - All Rights Reserved #
# #
# VSTools.inc #
# #
# Verification Script Tools #
# version 1.0 #
# #
# NOTE: This file contains important script functions and is a supplement to the #
# Verification Script Engine API provided by the application. #
# #
# This file SHOULD be included in all verification scripts. #
#########################################################################################

%include "../IEEE/IEEECompanies.inc"
%include "VS_Primitives.inc"
%include "VS_constants.inc"

#########################################################################################
# Common Globals #
#########################################################################################

set State = 0; # Main state machine input.
# This variable may be used for implementation of different kinds of
# state machines.

set StartScript = 1; # indicates that it first run

set str = ""; # global buffer supposedly for string values
set val = 0; # global buffer supposedly for integer or other values

########################################################################################
# FUNCTIONS #
########################################################################################

####################################################################
# Common reset actions which should be performed for any #
# verification script preparing it for consecutive runs. #
# #
# The VSE will call this function for any script after it #
# has finished running. #
####################################################################

OnResetScript()
{
State = 0;
StartScript = 1;

ResetScript();
}

########################################################################
# This function specifies that the verification is passed and the #
# script should complete its work. #
########################################################################

ScriptPassed()
{
out.Result = _VERIFICATION_PASSED;
}

24

########################################################################
# This function specifies that the verification is failed and the #
# script should complete its work. #
########################################################################

ScriptFailed()
{
out.Result = _VERIFICATION_FAILED;
}

########################################################################
# This function specifies that the verification is done and the #
# script should complete its work. #
########################################################################

ScriptDone()
{
out.Result = _VERIFICATION_PASSED;
}

########################################################################
# This function returns the name of the level where the current #
# event occurred. #
########################################################################
GetLevelName()
{
level = in.Level;

level_name =
select
{
level == _IDLE : "Idle";
level == _LINK : "Link";
level == _OOB_SEQ : "OOB_Seq";
level == _TRANSPORT : "Transp";
level == _ATA : "ATA";
level == _SCSI : "SCSI";
level == _SMP : "SMP";
level == _TASK : "TASK";

default : FormatEx("%d", level); #"Unknown";

};

return level_name;
}

########################################################################
# This function returns the name of the link speed where the current #
# event occurred. #
########################################################################
GetLinkSpeedName()
{
speed = in.LinkSpeed;

speed_name =
select
{
speed == _LINK_SPEED_1_5 : "1.5G";
speed == _LINK_SPEED_3_0 : "3G";
speed == _LINK_SPEED_6_0 : "6G";

default : FormatEx("%d", speed); #"Unknown";
};

return speed_name;
}

25

########################################################################
# This function returns the name of the channel where the current #
# event occurred. #
########################################################################

GetChannelName()
{
channel = in.Channel;

channel_name =
select
{
channel == _I1 : "I1";
channel == _T1 : "T1";
channel == _I2 : "I2";
channel == _T2 : "T2";
channel == _I3 : "I3";
channel == _T3 : "T3";
channel == _I4 : "I4";
channel == _T4 : "T4";
channel == _I5 : "I5";
channel == _T5 : "T5";
channel == _I6 : "I6";
channel == _T6 : "T6";
channel == _I7 : "I7";
channel == _T7 : "T7";
channel == _I8 : "I8";
channel == _T8 : "T8";
channel == _T8 : "T8";
channel == _I9 : "I9";
channel == _T9 : "T9";
channel == _I10 : "I10";
channel == _T10 : "T10";
channel == _I11 : "I11";
channel == _T11 : "T11";
channel == _I12 : "I12";
channel == _T12 : "T12";
channel == _I13 : "I13";
channel == _T13 : "T13";
channel == _I14 : "I14";
channel == _T14 : "T14";
channel == _I15 : "I15";
channel == _T15 : "T15";
channel == _I16 : "I16";
channel == _T16 : "T16";
channel == _I17 : "I17";
channel == _T17 : "T17";
channel == _I18 : "I18";
channel == _T18 : "T18";
channel == _I19 : "I19";
channel == _T19 : "T19";
channel == _I20 : "I20";
channel == _T20 : "T20";
channel == _I21 : "I21";
channel == _T21 : "T21";
channel == _I22 : "I22";
channel == _T22 : "T22";
channel == _I23 : "I23";
channel == _T23 : "T23";
channel == _I24 : "I24";
channel == _T24 : "T24";
channel == _I25 : "I25";
channel == _T25 : "T25";
channel == _I26 : "I26";
channel == _T26 : "T26";
channel == _I27 : "I27";
channel == _T27 : "T27";
channel == _I28 : "I28";

26

channel == _T28 : "T28";
channel == _I29 : "I29";
channel == _T29 : "T29";
channel == _I30 : "I30";
channel == _T30 : "T30";
channel == _I31 : "I31";
channel == _T31 : "T31";
channel == _I32 : "I32";
channel == _T32 : "T32";
channel == _I33 : "I33";
channel == _T33 : "T33";
channel == _I34 : "I34";
channel == _T34 : "T34";
channel == _I35 : "I35";
channel == _T35 : "T35";
channel == _I36 : "I36";
channel == _T36 : "T36";

#Muxing Channels-----------------------

channel == _I1_1 : "I1_1";
channel == _T1_1 : "T1_1";
channel == _I2_1 : "I2_1";
channel == _T2_1 : "T2_1";
channel == _I3_1 : "I3_1";
channel == _T3_1 : "T3_1";
channel == _I4_1 : "I4_1";
channel == _T4_1 : "T4_1";
channel == _I5_1 : "I5_1";
channel == _T5_1 : "T5_1";
channel == _I6_1 : "I6_1";
channel == _T6_1 : "T6_1";
channel == _I7_1 : "I7_1";
channel == _T7_1 : "T7_1";
channel == _I8_1 : "I8_1";
channel == _T8_1 : "T8_1";
channel == _T8_1 : "T8_1";
channel == _I9_1 : "I9_1";
channel == _T9_1 : "T9_1";
channel == _I10_1 : "I10_1";
channel == _T10_1 : "T10_1";
channel == _I11_1 : "I11_1";
channel == _T11_1 : "T11_1";
channel == _I12_1 : "I12_1";
channel == _T12_1 : "T12_1";
channel == _I13_1 : "I13_1";
channel == _T13_1 : "T13_1";
channel == _I14_1 : "I14_1";
channel == _T14_1 : "T14_1";
channel == _I15_1 : "I15_1";
channel == _T15_1 : "T15_1";
channel == _I16_1 : "I16_1";
channel == _T16_1 : "T16_1";
channel == _I17_1 : "I17_1";
channel == _T17_1 : "T17_1";
channel == _I18_1 : "I18_1";
channel == _T18_1 : "T18_1";
channel == _I19_1 : "I19_1";
channel == _T19_1 : "T19_1";
channel == _I20_1 : "I20_1";
channel == _T20_1 : "T20_1";
channel == _I21_1 : "I21_1";
channel == _T21_1 : "T21_1";
channel == _I22_1 : "I22_1";
channel == _T22_1 : "T22_1";
channel == _I23_1 : "I23_1";
channel == _T23_1 : "T23_1";
channel == _I24_1 : "I24_1";

27

channel == _T24_1 : "T24_1";
channel == _I25_1 : "I25_1";
channel == _T25_1 : "T25_1";
channel == _I26_1 : "I26_1";
channel == _T26_1 : "T26_1";
channel == _I27_1 : "I27_1";
channel == _T27_1 : "T27_1";
channel == _I28_1 : "I28_1";
channel == _T28_1 : "T28_1";
channel == _I29_1 : "I29_1";
channel == _T29_1 : "T29_1";
channel == _I30_1 : "I30_1";
channel == _T30_1 : "T30_1";
channel == _I31_1 : "I31_1";
channel == _T31_1 : "T31_1";
channel == _I32_1 : "I32_1";
channel == _T32_1 : "T32_1";
channel == _I33_1 : "I33_1";
channel == _T33_1 : "T33_1";
channel == _I34_1 : "I34_1";
channel == _T34_1 : "T34_1";
channel == _I35_1 : "I35_1";
channel == _T35_1 : "T35_1";
channel == _I36_1 : "I36_1";
channel == _T36_1 : "T36_1";

default : FormatEx("%d", channel); #"Unknown";
};

return channel_name;
}

########################################################################
# This function returns the name of the current event. #
########################################################################

GetEventName()
{
event = in.TraceEvent;

event_name =
select
{
# packet level events...

event == _FRM_PRIMITIVE : "_FRM_PRIMITIVE";
event == _FRM_AF_OPEN : "_FRM_AF_OPEN";
event == _FRM_AF_IDENTIFY : "_FRM_AF_IDENTIFY";
event == _FRM_SSP : "_FRM_SSP";
event == _FRM_SMP : "_FRM_SMP";
event == _FRM_STP : "_FRM_STP";
event == _FRM_OOB_SIGNAL : "_FRM_OOB_SIGNAL";
event == _FRM_STP_INCOMPELETE : "_FRM_STP_INCOMPELETE";

default : FormatEx( "Unknown(%d)", event );
};

return event_name;
}

28

GetFullTimestamp ( time_obj )
{
seconds = time_obj [0];
total_nanoseconds = time_obj [1];

miliseconds = total_nanoseconds / 1000000;
microseconds = (total_nanoseconds - 1000000*miliseconds) / 1000;
nanoseconds = (total_nanoseconds - 1000000*miliseconds - 1000*microseconds);

timestamp_str = FormatEx ( "%4d . %03d %03d %03d", seconds,
miliseconds,
microseconds,
nanoseconds );
return timestamp_str;
}

GetCurrTimestamp ()
{
return GetFullTimestamp ( in.Time );
}

########################################################################
# This function returns SAS address value and related company name #
########################################################################
GetSASAddressString ( address_hi_dword, address_lo_dword )
{
company_name = GetIEEECompanyName ( (address_hi_dword >> 4) & 0x00FFFFFF );
company_name_str = select { company_name == "" : "";
default : Format ( " (%s)", company_name ); };

return FormatEx ( "0x%08X%08X%s\n", address_hi_dword,
address_lo_dword,
company_name_str );
}

########################################################################
# This function returns SAS address value and related company name #
########################################################################
GetSASAddressString2 (SASAddress)
{
address_hi_dword = Revert32BitData(GetSASAddressHi(SASAddress));
address_lo_dword = Revert32BitData(GetSASAddressLo(SASAddress));

return GetSASAddressString(address_hi_dword, address_lo_dword);
}

########################################################################
# This function reverts given 32 bit valus. #
########################################################################
Revert32BitData(Data)
{
NewData = (Data << 24);
NewData += ((Data & 0xFF00) << 8);
NewData += ((Data & 0xFF0000) >> 8);
NewData += ((Data >> 24) & 0xFF);

# Test = FormatEx ( "Data: 0x%08X NewData: %08X \n", Data, NewData);
# ReportText(Test);

return NewData;
}

29

RevertRawByteOrder(RawBytes)
{
RawSize = sizeof(RawBytes);
RevertRaw = RawBytes;
RevertRaw[RawSize - 1] = GetNBits(RawBytes, 0, 8);

for(index = 1; index < RawSize; index++)
{
RevertRaw[RawSize - index - 1] = NextNBits(8);
}

# for(index = 0; index < RawSize; index++)
# {
# Test = FormatEx ( "Data: 0x%02X RevertedData: %02X \n", RawBytes[index],
RevertRaw[index]);
# ReportText(Test);
# }

return RevertRaw;
}

########################################################################
# This function returns high dword of SAS address. #
########################################################################
GetSASAddressHi(SASAddress)
{
return GetNBits(SASAddress, 32, 32);
}

########################################################################
# This function returns low dword of SAS address. #
########################################################################
GetSASAddressLo(SASAddress)
{
return GetNBits(SASAddress, 0, 32);
}

########################################################################
# This function Format raw bytes to string. #
########################################################################
FormatRawBytes(RawBytes)
{
for(index = 0; index < sizeof(RawBytes); index++)
{
if(RawBytes[index] <= 0x0F)
{
ByteFormat = FormatEx("0%X", RawBytes[index]);
}
else
{
ByteFormat = FormatEx("%2X", RawBytes[index]);
}
RawFormat = ByteFormat + RawFormat;
# ReportText(RawFormat);
}

return RawFormat;
}

30

#############################################################################
# This function Check the left raw data value is bigger than the right one #
#############################################################################
IsRawDataBigger(LeftRaw, RightRaw)
{
LeftRawSize = sizeof(LeftRaw);
RightRawSize = sizeof(RightRaw);

if(LeftRawSize > RightRawSize)
return 1;

if(LeftRawSize < RightRawSize)
return 0;

if(LeftRawSize == RightRawSize)
{
for(index = RightRawSize - 1; index >= 0; index--)
#for(index = 0; index < RightRawSize; index--)
{
if(LeftRaw[index] > RightRaw[index])
return 1;

if(LeftRaw[index] < RightRaw[index])
return 0;
}
}

return 0;
}

########################################################################
# This function outputs the information of the current event. #
########################################################################

ReportEventInfo()
{
report = FormatEx( "TraceEvent: %6s #%04u, Channel : %s, Speed : %4s , Event : %s,
Time : %s, ",
GetLevelName(), in.Index, GetChannelName(), GetLinkSpeedName(), GetEventName(),
TimeToText( in.Time ) );

ReportText( report );
}

ReportPrimEventInfo()
{
if( in.TraceEvent == _FRM_PRIMITIVE )
{
report = FormatEx( "Primitive packet, value : 0x%X, Count : %d\n", in.Primitive,
in.Count );

ReportText( report );
}
}

31

4.10 Loading Pre Emphasis Signal Settings

You can load a previously saved pre emphasis signal-setting file by calling the
LoadPreEmphasisSignalFile function from the SierraSASAnalyzer automation object to retrieve
values from the specified fil e and loa d them into the connected board.

'--------- Load Pre Emphasis Signal File --------­MySASAutomation.LoadPreEmphasisSignalFile "F:\ForTestATS.sng"
If Err.Number <> 0 Then
MySTATS.ReportError Err.number, Err.Description
Else
MySTATS.ReportText ("Generation is started")
End If

32

Type of Service

Contract

Call for technical support…

US and Canada: 1 [phone]
Worldwide: 1 [phone]

Fax your questions…

Worldwide: 1 [phone]

Write a letter …

Teledyne LeCroy

Santa Clara, CA 95054

Send e-mail…

[e-mail]

Visit Teledyne LeCroy web site…

teledynelecroy.com/

How to Contact Teledyne LeCroy

Customer Support
3385 Scott Blvd.

33