This electronic product is subject to
disposal and recycling regulations that
vary by country and region. Many
countries prohibit the disposal of
waste electronic equipment in
standard waste receptacles.
For more information about proper
disposal and recycling of your LeCroy
product, please visit
www.lecroy.com/recycle.
Document Disclaimer
The information 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 in this document without
notice or penalty.
[page intentionally blank to preserve odd-even pagination]
viLeCroy Corporation
SimPASS PE Software User ManualChapter 1: Overview
Chapter 1: Overview
The Teledyne LeCroy SimPASS PE™ PCI Express Protocol Analyzer Software is a
powerful and intuitive expert software system embedding detailed knowledge of the
protocol hierarchy and intricacies, as defined in the protocol specification. It allows you
to import your simulation results and analyze them in a graphical display that has been
optimized for fast and easy navigation through a simulated traffic session. Users are
alerted as violations are detected at all levels of the protocol layering and can easily drill
down on areas of interest or collapse and hide fields that are not relevant. It is based on
Teledyne LeCroy PETracer™ PCI Express Analysis Software running in the Windows
operating system.
Features and Benefits
The Teledyne LeCroy PCI Express Protocol Analyzer Software has the following features
and benefits:
FeaturesBenefits
Powerful and Intuitive
CATC Trace™ Analysis Software
Extensive DecodingComplete, accurate and reliable decoding of TLPs (Transaction
Intelligent Reporting
Sophisticated ViewingView Packet, Link, and Split transaction levels of the PCI Express
Dword to Transaction Level
Viewer
Faster interpretation and debug of PCI Express traffic with
color-coded, clearly labeled protocol elements in a graphical
display. Reduces coding and deciphering.
Layer Packets), DLLPs (Data Link Layer Packets),and all PCI
Express Primitives.
Quickly identify and track error rates and abnormal link or timing
conditions. Display configuration space and protocol specification
details.
protocol. Collapsible/expandable headers with Tool tip explanations
make it easy to navigate and interpret packet contents, headers,
and commands. View packets, transactions of TLPs and DLLPs in
classic CATC Trace™ format or in raw bit stream for deeper
analysis.
View Dwords, Packet, Link and Split Transaction levels of the PCI
Express protocol.
1.1 Other Documents
For more information, refer to the following documents:
Chapter 2: InstallationSimPASS PE Software User Manual
Chapter 2: Installation
The SimPASS PE™ software is installed on a Linux®-based PC running in a Windows®
emulation environment that is installed together with SimPASS PE software.
Please consult the readme file on the installation CD for the latest PC requirements.
To install the SimPASS PE software on the Host PC:
Step 1 Insert the CD into the CD ROM drive of the PC.
Alternatively, you can download the SimPASS PE installation from the
Teledyne LeCroy web site.
Step 2 The SimPASS PE software installs automatically on the PC hard disk.
Follow the onscreen instructions.
Starting the Application
Launch the SimPASS PE program to open the SimPASS PE main window.:
2LeCroy Corporation
SimPASS PE Software User ManualChapter 3: Licensing
Chapter 3: Licensing
3.1 Installing a License File
To i mp or t .simpass files requires an appropriate license.
After obtaining a SimPASS PE License file, install it using the following procedure.
Step 1 Run the SimPASS PE application.
Step 2 Select Help > Install Software License File.
Step 3 Use the Open dialog box file browser to locate and select the license file.
If the license is valid, it will install itself. Otherwise, contact PSG support.
See “How to Contact LeCroy” on page 107 to purchase a valid license.
Note: You do not need a license to view recorded or imported trace files in SimPASS PE.
3.2 Checking License Information
To view the SimPASS PE license registered with an instance of the SimPASS PE
application, open the application and select Help > Display License Information to
display a message.
The message shows the installed licenses and their respective expiration dates.
LeCroy Corporation 3
Chapter 4: Software OverviewSimPASS PE Software User Manual
Chapter 4: Software Overview
4.1 The SimPASS PE Software
The SimPASS PE™ software administers Analyzer platforms and handles all
CATC Trace analysis and display.
The software runs in a Windows
you to import simulation results for analysis.
®
-emulation environment on a Linux-based PC. It allows
4LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
4.2 Application Layout
The SimPASS PE application contains the following components:
Title bar: The title bar is at the top of the application window and displays the CATC Trace
file name or generation script name.
Menu bar: The menu bar is located below the title bar, by default. The menu bar can be
moved by clicking a blank area of the bar and then dragging the menu to a new position.
It can be docked in another part of the application window or moved outside of the window
to become a floating menu.
Toolbar: The toolbar is composed of buttons that represent the commonly used
commands. The toolbar divides into smaller toolbars that can be moved and docked in a
new position or made to float outside of the window.
Display area: The display area is the main part of the application window in which traces
are displayed.
Status bar: The status bar is located at the bottom of the application window. The left end
of the status bar displays descriptions of buttons and menu items when the mouse is
positioned over them. The right end of the bar shows the search direction.
4.3 Using the Toolbar
You can use the SimPASS PE application Toolbar as a shortcut to most of the operations
supplied by the menus.
Opens a previously recorded, or
imported,
Save As
Allows the open file to be saved
with a new name.
CATC Trace file.
LeCroy Corporation 5
Chapter 4: Software OverviewSimPASS PE Software User Manual
Setup Display Options
Opens the Display Options dialog
box.
Zoom in display.Wraps display information.
Zoom out display.
Hide Training Sequence.Hide Downstream traffic/recording.
Hide SKIP and Update FC
packets.
Hide Upstream recording/traffic.Compact View
Find
Opens a dialog box that allows you
to select one or more items to find
in the recording, then searches to
that point.
View Packet Level data.
View Link Transaction Level data.View Split Transaction Level data
Advanced Hiding Options
Opens a dialog box that allows you to select
items to hide from view.
Toggles compacting of training sequences to
analyze
compacting to display more data.
Find Next. Repeats last Find or Search action.
CATC Trace data faster, or no
6LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
File Information
Lists the conditions under which
the recording was made.
Error Report
Opens a window that lists all errors
identified in the recording.
Traffic Summary
Opens a window that lists all
events that occurred during the
recording
Navigator. Shows/hides the
Navigator bar - a utility that lets you
easily navigate the CATC Trace.
Displays the Data/Payload
window for the current packet.
Bus Utilization
Opens a window that graphically represents
various information about the recording.
Link Tracker
Opens a window that displays symbol information
per lane.
Opens the Data Flow window.
Shows recorded data in a compressed tabular
format.
LTSSM Flow Graph
Shows a state diagram of the Link Training
and Status State machine.
Displays the Packet Header bar.
Opens a window that displays the header
information in the current packet, as it would be
viewed in the specification.
Opens the Timing and Bus Usage
Calculations window.
Multi-Segment Toolbar
First Segment. Open first segment
in the multisegment CATC Trace.
Previous segment. Open previous
segment in the multisegment
CATC Trace.
Running Verification Scripts
Opens a dialog that allows you to select and run
verification scripts.
Index file. This button becomes active if a
multisegment CATC Trace file is open and
displays the index file for the recording.
Next Segment. Open next segment in
multisegment CATC Trace.
Last segment. Open last segment in
multisegment CATC Trace.
LeCroy Corporation 7
Chapter 4: Software OverviewSimPASS PE Software User Manual
Toolbar Hide Buttons
The SimPASS PE application toolbar has five buttons related to show/hide of
CATC Trace file contents. The buttons allow you to quickly adjust the display to your
needs.
Hide Training: Brings up a drop-down menu that lets you to hide all or a portion of the
packets in the training portion of the CATC Trace.
Hide SKIP and Update FC: Brings up a drop-down menu that lets you hide SKIP or
Update FC packets in a CATC Trace.
Hide Upstream: Hide all traffic from endpoint devices to the root complex.
{
Hide Downstream: Hide all traffic from the root complex to endpoint devices.
8LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
Advanced Hiding Options: Brings up the Level Hiding pane of the Display Options
window. Use this pane to tune the show/hide options within the CATC Trace display.
LeCroy Corporation 9
Chapter 4: Software OverviewSimPASS PE Software User Manual
4.4 Using the Menus
The SimPASS PE application main display includes the following set of pull-down menus:
File Menu
New Generator ScriptCreates a new Traffic Generation file.
OpenOpens a file.
CloseCloses the current file.
Save asSaves all or a specified range of packets to a uniquely named file.
Convert Old FilesConvert CATC Trace files.
PrintPrints part or all of the current traffic data file.
Print PreviewProduces an on-screen preview before printing.
Print SetupSetup your current or new printer.
Import SimPASS File to
Protocol Trace
Import SimPASS File to
Bit Trace
Edit CommentCreate or edit the comment field in a CATC Trace file.
Export
>> to Text
>> Packets to CSV Text
>> to Generator
File Format
ExitExit the SimPASS PE application.
Imports a .simpass file as a CATC Trace file.
CATC Trace files are optimized for protocol analysis.
Imports a .simpass file as a BitTracer file.
BitTracer files are optimized for link and phy layer analysis.
Saves all or part of a CATC Trace to a text file or traffic generation file. This text file
summarizes the traffic in the CATC Trace.
Saves the CATC Trace to a text file in Comma Separated Value (CSV) format.
Saves the CATC Trace to a generation file.
10LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
Setup Menu
Display OptionsAllows you to customize display options such as field colors, field formats and level
hiding.
Report Menu
Report Menu operations are only available when you are working with a CATC Trace file.
File InformationDisplays information about the file contents and describes the conditions of the file’s
recording (Recording Options, hardware information, and so on).
Error SummaryDisplays an error summary of the current CATC Trace file and allows you to go to a
specific packet, and save the error file to a uniquely named file.
Traffic SummaryDetails the number and types of packets that were transferred during the recording.
You can hide, save, send, text, print, and view.
Bus UtilizationOpens a window with graphs of bus usage for the open CATC Trace.
Link TrackerOpens a window for displaying a detailed chronological view of traffic. The window
provides view and navigation options.
Data FlowOpens the Data Flow Window, providing a tabular view of transactions and their
payload.
Trace NavigatorShows the Navigator bar for navigating a CATC Trace. Shows a snapshot of the
recording and allows you to adjust the memory area for the view.
LTSSM Flow Graph
Shows a state diagram of bus activity. Also allows you to navigate through
the LTSSM, based on the current recording.
Packet HeaderOpens the Packet Header bar, showing the Packet Header information as it would be
viewed in the specification.
Packet Data/View DataOpens the Data Window for the current packet, with the options: Hide, Save,
Hexadecimal, ASCII, Decimal, Binary, MSB Format, LSB Format, Big Endian, and
Little Endian. Format Line allows you to enter the number of bytes, words, or dwords
per line.
Configuration SpacePresents a list of Configuration Spaces. Clicking an item displays the selected
Configuration Space in a Configuration Table format.
LeCroy Corporation 11
Chapter 4: Software OverviewSimPASS PE Software User Manual
Search Menu
Search Menu operations are only available when you are working with a CATC Trace file.
Go to TriggerRepositions the display to show the first packet following the trigger event.
Go to Segment/ PacketRepositions the display to a specific packet, Link or Split transaction number.
Go to TimeRepositions the display to specific timestamp.
Go to MarkerRepositions the display to a previously marked packet, Link Transaction, or
Split Transaction.
Go to PacketAllows searching for specific link events: TLP Type, DLLP Type, Ordered Set,
Link Event, Traffic Class, DLLP Virtual Channel, TLP Virtual Channel, Direction,
Speed, Link Width, Requester ID, Completer ID, Data Lengths, Errors.
FindDisplays the Find dialog to allow searching for various events within a CATC Trace.
You can search by Display Level: Packets, Link Transactions, Split Transactions.
You can search packets by Event Group: TLP Type, TLP Header, TLP Requester ID,
TLP Completer ID, TLP Data Pattern, TLP Data Lengths, TLP Tag, TLP Sequence
Number, DLLP Type, DLLP Header, DLLP Virtual Channel, ACK/NAK Seq Number,
Ordered Sets, Link Event, Direction, Errors.
You can search link transactions by Event Group: TLP Type, Traffic Class, Virtual
Channel, Direction, Requester ID, Completer ID, Status, Tag.
You can search split transactions by Event Group: TLP Type, Traffic Class, Virtual
Channel, Direction, Requester ID, Completer ID, Status, Tag.
Find allows you to create complex searches based on numerous criteria.
You can search by Display Level: Packets, Link Transactions, Split Transactions.
You can search packets by Event Group: TLP Type, TLP Header, TLP Requester ID,
TLP Completer ID, TLP Data Pattern, TLP Data Lengths, TLP Tag,
TLP Sequence Number, DLLP Type, DLLP Header, DLLP Virtual Channel,
ACK/NAK Seq Number, Ordered Sets, Link Event, Direction, Errors.
You can search link transactions by Event Group: TLP Type, Traffic Class,
Virtual Channel, Direction, Requester ID, Completer ID, Status, Tag.
You can search split transactions by Event Group: TLP Type, Traffic Class,
Virtual Channel, Direction, Requester ID, Completer ID, Status, Tag.
Find allows you to create complex searches based on numerous criteria.
Find NextRepeats the previous Find or Search operation.
Search DirectionAllows you to specify a forward or backward search of a CATC Trace file.
12LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
View Menu
Toolbars>>Displays available toolbars: Standard, Frequently Used, Analysis, and Transaction
Level. Use Customize to display the Windows Customize window.
Script EditorDisplays the Script Editor (only appears if a .peg file is open).
Status BarSwitches display of the Status Bar on or off.
Zoom InZoom in increases the size of the displayed elements.
Zoom OutZoom out decreases the size of the displayed elements.
WrapAllows the display to wrap.
FC CreditsToggles a display for tracking Flow Control Credit update and consumption on a PCI
Express link.
FC Credits SetupAllows you to customize the display for tracking Flow Control Credits.
Compact View
Toggles compacting of the Link Training sequence to analyze CATC Trace
data faster or no compacting to display more data.
Packet LevelView the current recording at the Packet Level.
Link Transaction LevelView the current recording at the Link Transaction Level.
Split Transaction LevelView the current recording at the Split Transaction Level.
LeCroy Corporation 13
Chapter 4: Software OverviewSimPASS PE Software User Manual
Tools Menu
TC to VC MappingAllows Traffic Classes to be mapped to Virtual Channels for purposes of simplifying
navigation (for example, Search > Go to > TLP Virtual Channel) and changing the way
the CATC Trace is displayed (for example, in Split Transactions).
Timing CalculationsStarts the mode-less calculator dialog for calculating various timing and bandwidth
parameters in the recording file.
Run Verification ScriptsPresents a list of verification scripts, from which you can run a verification script.
Window Menu
New WindowOpens a copy of the current CATC Trace window.
CascadeDisplays all open CATC Trace windows in an overlapping arrangement.
TileDisplays all open CATC Trace windows as a series of strips across the display.
Arrange IconsArranges minimized CATC Trace windows at the bottom of the display.
Synchronize TracesSynchronizes the CATC Trace View windows so that a move in one window
repositions the other window of the same recording.
Help Menu
User ManualsAccesses the SimPASS PE application user manuals.
Display License Information
Install Software License FIleInstalls a valid license file.
Register Product OnlineRegister at the Teledyne LeCroy website registration page.
AboutDisplays version information about the currently running SimPASS PE software.
Displays the installed licenses and their respective expiration dates.
14LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
4.5 Tool Tips
Tool tips provide details about fields within the CATC Trace. To see a tool tip, position your
mouse pointer over a field within the CATC Trace.
You can turn off this capability in the Display Options menu.
4.6 Keyboard Shortcuts
KeystrokesOperation
Ctrl + OOpen file
Ctrl + PPrint
Ctrl + SSave file
Ctrl + HomeJump to first packet
Ctrl + EndJump to last packet
Ctrl + GGo to packet ...
Ctrl + FSearch forward
F3Find next
F6Next pane
Shift + F6Previous pane
Ctrl + BSearch backward
4.7 Search Direction Indicator
A segment in the status bar indicates search direction. The direction can be changed by
selecting Search Direction from the Search menu.
LeCroy Corporation 15
Chapter 4: Software OverviewSimPASS PE Software User Manual
4.8 Importing a SimPASS PE File
The SimPASS PE software creates and uses two related file types:
•Teledyne LeCroy PCI Express BitTracer Analyzer File (BitTracer file): Trace
files optimized for link and phy layer analysis
SimPASS PE import files have the extension ".simpass". Simulation environments of
participating vendors create these files to allow importing the logical PCI Express
simulation traffic into a CATC Trace file and into a BitTracer file.
To i mp or t a .simpass file to a CATC Trace file:
Step 1 Select File > Import SimPASS File to BitTrace...
Step 2 Select a .simpass file.
4.9 Opening CATC Trace Files
To open an existing CATC Trace file, click File > Open or .
16LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
4.10 Saving CATC Trace Files
Using the Save As Function
When you record a CATC Trace file, the Analyzer software provides a pre-defined name
to the CATC Trace file (data.pex or any other that you specified in the Recording
Options). If you do consecutive recordings, each time the previous recording is
overwritten. If you see a recording you want to analyze later, you need to give a unique
name to the CATC Trace file, so it is not overwritten with the next recording.
Also, when you analyze a recorded CATC Trace file, you might be interested in
preserving just a part of the PCI Express traffic that was recorded. If you save a portion
of a CATC Trace file, it can get significantly smaller, allowing you to attach it to an e-mail.
To save a portion of a CATC Trace file or the whole file to a unique name, select Save As
from the File menu.
If you want to give a unique name to the CATC Trace file, select the All option and keep
Rename original file checked. This is the default setting for the dialog.
Saving a Portion of a CATC Trace
If you want to save a portion of a CATC Trace file, select Save packet range. Enter
starting and ending packet numbers in the From Packet and To Packet fields. By default,
it has the numbers of the first and the last packets in the file. The software is going to save
all the packets in specified range to the new file, unless you have Do not save hidden packets checked. In this case it is going to save all packets in the range, EXCLUDING
the currently hidden packets.
LeCroy Corporation 17
Chapter 4: Software OverviewSimPASS PE Software User Manual
4.11 Exporting a CATC Trace File
By default, SimPASS PE saves CATC Trace files in the .pex format. However, you can
export a CATC Trace to a file in any of the following other formats:
•Text
•Comma Separated Value (CSV)
•Generator file format
Exporting to Generator file format is a simple way to create a script file from your
CATC Trace.
To export a CATC Trace file, select File > Export:
18LeCroy Corporation
SimPASS PE Software User ManualChapter 4: Software Overview
4.12 Printing Data Files
To print all or part of the open CATC Trace:
Step 1 Select File > Print from the menu or
click the Printer button on the toolbar.
The Print Packets dialog opens:
Step 2 To select a range of packets, enter values in the From packet # and To
packet # fields and click Print.
Step 3 To print an entire file, leave the From and To fields empty and click Print.
The specified traffic information is printed as currently displayed, in color or gray scale as
supported by your printer. Any CATC Trace File comments you entered are printed
following the current document name at the top of each page.
Note: CATC Trace File comments can be created by using Edit Comment on the File
menu.
LeCroy Corporation 19
Chapter 5: Reading CATC TracesSimPASS PE Software User Manual
Chapter 5: Reading CATC Traces
5.1 Viewing PCI Express CATC Traces
SimPASS PE™ displays traffic as labeled, color-coded, and time-stamped rows.
Tool tips provide details about fields within the CATC Trace. Hold the mouse cursor over
a field to see a tool tip.
Additional information is available from pop-up menus. For example, if you click the left
mouse button on the first cell in a packet a menu appears with an option to view
Raw 10b Codes.
5.2 Expand and Collapse Data Fields
Packet data fields are displayed in a short format by default.
You can view a data field’s long format by performing one of the following three actions:
•Click the small triangle in the left corner.
•Double-click anywhere in the data field.
•Click once in the Data Field with the left mouse button, then choose
Expand Data from the pop-up menu.
A repeat of any above methods causes the display to return to a Short Data format.
5.3 Resizing Cells
Data cells can be resized by pointing the mouse pointer on the edge of a data cell,
depressing and holding the left mouse button, and then repositioning the mouse pointer
while keeping the mouse button depressed.
20LeCroy Corporation
SimPASS PE Software User ManualChapter 5: Reading CATC Traces
5.4 Pop-up Menus
The Analyzer software makes extensive use of pop-up menus. In some instances,
pop-up menus provide the only means of accessing dialog boxes that contain detailed
information about cells within the CATC Trace, for example, the Show Configuration
Space dialog box.
To see a pop-up menu, left-click or right-click a cell within the CATC Trace. Right-click or
left-click behavior depends on the Display Options setting. For default left-click, the
right-click menu is not cell-dependent. For other left-click behavior, the type of menu that
opens varies depending on the type of cell that is selected. Take some time to explore
CATC Traces and the various pop-up menus.
5.5 View Data Block
To view the raw bits that make up the data in a data field, left-click a data field, then click
or select View Data Block from the pop-up menu to display the Data Block window.
You can display data in Hexadecimal, ASCII, Decimal, or Binary formats.
Bit Order is Most Significant Bit or Least Significant Bit.
You can display data in Big Endian or Little Endian.
Format lets you display data as BYTEs, WORDs, or DWORDs.
Columns lets you select the number of columns.
You can enter hexadecimal offset values.
You can go to or search Previous or Next.
LeCroy Corporation 21
Chapter 5: Reading CATC TracesSimPASS PE Software User Manual
5.6 Show Raw 10b Codes
You can view the raw bits that make up the data field by left-clicking the field and selecting
View Data Block from the pop-up menu.
To view Raw 10b Codes:
Step 1 Left-click the first cell in a packet.
Step 2 Select Show Raw 10b Codes from the pop-up menu to display the
Raw 10b Codes window.
Step 3 To change the format of the data, use the options along the right side of
the dialog.
Step 4 To navigate the CATC Trace, use the Prev and Next buttons.
22LeCroy Corporation
SimPASS PE Software User ManualChapter 5: Reading CATC Traces
5.7 Show Header Fields
You can view details about header fields by opening the Show Header Fields dialog box.
Step 1 Click a header. A pop-up menu appears.
Step 2 Select Show Header Fields. The following dialog box opens.
Step 3 Use the Prev and Next buttons to navigate to other headers.
LeCroy Corporation 23
Chapter 5: Reading CATC TracesSimPASS PE Software User Manual
5.8 Packet Cell Popup Menus
The Packet cell has a left-click pop-up menu that includes the Show Raw 10b Codes
command:
The right-click pop-up menu from Packet cell is:
Packet Header R-> Cell Popup Menu
The Packet Header R-> cell has a pop-up menu with the Swap Upstream/Downstream
command, which changes the directionality of the packets in the CATC Trace.
24LeCroy Corporation
Loading...
+ 90 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.