LeCroy PCIe Gen4 Summit M5x User manual

PCI Express® Protocol Analysis

SummitTM M5x Gen4

Analyzer / Jammer

User Manual

For PCIe Protocol Analysis Software Version 12.04

Generated: February 2, 2023 12:33pm

2 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

Teledyne LeCroy Protocol Solutions Group

Trademarks and Servicemarks

Teledyne LeCroy, CATC Trace, PETracer, PETracer Summit, Summit M5x, Summit T416, Summit T48, Summit T24,

Summit T28, Summit T34, Summit T3-8, Summit T3-16, Summit Z3-16, Summit Z416, PCIe Protocol Suite,

PCIe Protocol Analysis, Universal Protocol Analyzer System, UPAS, and BusEngine are trademarks of Teledyne LeCroy.

Microsoft and Windows are registered trademarks of Microsoft Corporation.

Intel and Pentium are registered trademarks of Intel Corporation.

All other trademarks and registered trademarks are property of their respective owners.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE

WITHOUT NOTICE. ALL INFORMATION, EXAMPLES AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE

ACCURATE BUT ARE REPRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS ARE FULLY

RESPONSIBLE FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN

INFORMATION THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE

UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT Teledyne LeCroy FOR A COPY.

This document may be printed and reproduced without additional permission, but all copies should contain this copyright

notice.

WEEE Program

Teledyne LeCroy

teledynelecroy.com

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 3

Contents

Chapter 1: Overview..............................................................................................23

1.1 PCIe Protocol Analysis™ Analyzer Hardware and Software............................................ 23

1.1.1 CATC Trace Software...........................................................................................................................25

1.1.2 Summit M5x Analyzer ..........................................................................................................................26

1.1.3 Features.................................................................................................................................................27

1.1.4 Other Documents .................................................................................................................................27

Chapter 2: Hardware Description ........................................................................29

2.1 System Components............................................................................................................ 29

2.2 Host Machine Requirements ............................................................................................... 29

2.3 Summit M5x Operation in AJ Mode and AJA Mode vs. Analyzer Only Mode ................. 30

2.4 Summit M5x Front Panel Description ................................................................................. 31

2.5 Status and Config Display (Summit M5x)........................................................................... 32

2.5.1 LCD Display and Button Functions for Analyzer Host Connection Setup......................................32

Press the Up Ý and Down ß buttons to navigate through the following menu items:................ 32

Set IP Configuration .......................................................................................................................... 33

Changing from Dynamic to Static IP Mode ..................................................................................... 33

Changing from Static to Dynamic IP Mode ..................................................................................... 34

Setting the Gateway and Subnet Mask............................................................................................ 35

2.6 Summit M5x Rear Panel Description .................................................................................. 36

2.7 Gen4 Host and Device Probe Cards (Analyzer/Jammer Mode)........................................ 37

2.7.1 Using Gen4 Host and Device Probe Cards ........................................................................................37

2.8 Interposers (Analyzer Mode only)....................................................................................... 38

2.8.1 Gen5 Slot Interposer (passive)............................................................................................................38

2.8.2 Gen5 x8 Interposer ...............................................................................................................................40

2.8.3 Gen5 x16 Interposer .............................................................................................................................41

2.8.4 Gen4 x8 Interposer ...............................................................................................................................42

Teledyne LeCroy

4 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

Chapter 3: Installation and Setup ........................................................................45

3.1 Installing the PCIe Protocol Analysis software ................................................................. 45

3.1.1 Downloading the PCIe Protocol Analysis software ..........................................................................45

3.1.2 Windows Server 2016/2019..................................................................................................................46

3.1.3 Launching the PCIe Protocol Analysis...............................................................................................55

3.2 Setting Up the Summit M5x Analyzer/Jammer using a USB Connection ....................... 56

3.3 Setting Up the Summit M5x Analyzer/Jammer using an Ethernet Connection .............. 57

3.3.1 TCP Port Connections for Different Modes .......................................................................................57

3.4 Adding Devices Manually .................................................................................................... 61

3.4.1 Adding a Summit M5x to an Ethernet Network..................................................................................63

Chapter 4: Software Overview .............................................................................69

4.1 The PCIe Protocol Analysis software ................................................................................. 69

4.2 Application Layout ............................................................................................................... 70

4.3 Using the Toolbar ................................................................................................................. 70

4.4 Multi-Segment Toolbar......................................................................................................... 74

4.4.1 Toolbar Hide Buttons ...........................................................................................................................74

4.4.2 Display Options: Level Hiding -> Direction........................................................................................76

4.5 Using the Menus................................................................................................................... 77

4.5.1 File Menu ..............................................................................................................................................77

File Dialog .......................................................................................................................................... 78

Clean Up Decoder Temp Files.......................................................................................................... 79

4.5.2 Setup Menu ...........................................................................................................................................83

4.5.3 Record Menu.........................................................................................................................................83

4.5.4 Report Menu..........................................................................................................................................84

4.5.5 Search Menu .........................................................................................................................................85

4.5.6 Quick Search Feature...........................................................................................................................88

4.5.7 View Menu .............................................................................................................................................89

4.5.8 Tools Menu............................................................................................................................................91

4.5.9 Window Menu (helps display the loaded traces)...............................................................................92

4.5.10 Help Menu ...........................................................................................................................................93

4.6 Dashboard View.................................................................................................................... 95

4.6.1 Launching and Setting Recording Option from Dashboard View ...................................................97

4.7 Jammer Log View ................................................................................................................. 97

4.8 Tool Tips................................................................................................................................ 98

4.9 Keyboard Shortcuts ............................................................................................................. 98

4.10 Status Bar............................................................................................................................ 99

4.10.1 Recording Progress Bar ....................................................................................................................99

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 5

Teledyne LeCroy

4.10.2 Recording Status................................................................................................................................99

4.10.3 Recording Activity............................................................................................................................101

4.10.4 Search Direction Indicator...............................................................................................................101

4.11 Making a PCI Express Recording.................................................................................... 101

4.11.1 Stopping a Recording ......................................................................................................................104

4.11.2 Saving a Recording ..........................................................................................................................104

4.12 PCIe Protocol Analysis Files ........................................................................................... 105

4.12.1 CATC Trace Files..............................................................................................................................105

4.12.2 Recording Options Files ..................................................................................................................105

4.12.3 Display Options Files .......................................................................................................................105

4.13 Saving CATC Trace Files ................................................................................................. 105

4.13.1 Using the Save As Function ............................................................................................................105

4.13.2 Saving a Portion of a CATC Trace ..................................................................................................107

4.13.3 Save Copy As Function ...................................................................................................................107

4.13.4 Trace File Structure..........................................................................................................................109

4.14 Exporting a CATC Trace File ........................................................................................... 110

4.14.1 Export: To Text .................................................................................................................................111

4.14.2 Export: Packets to CSV Text ...........................................................................................................113

4.14.3 Export: To Generator File Format ...................................................................................................115

Exporting a CATC Trace to a Traffic Generation File................................................................... 115

4.14.4 Export From Data Flow View ...........................................................................................................118

Data Flow CSV File: Legacy Format .............................................................................................. 119

Data Flow CSV File: New Format ................................................................................................... 120

4.15 Printing Data Files ............................................................................................................ 121

4.16 Analyzer Chat Window..................................................................................................... 121

4.16.1 CrossSyncTM Control Panel ...........................................................................................................123

Launching the CrossSyncTM Control Panel................................................................................. 123

Chapter 5: Recording Options: AJ Mode..........................................................125

5.1 Recording Overview........................................................................................................... 125

5.1.1 Analyzer/Jammer (AJ)........................................................................................................................125

5.2 Recording Option Dialog ................................................................................................... 125

5.3 Recording Type: Select Analyzer...................................................................................... 125

5.4 Recording Type: Summit M5x Jammer (AJ) Analyzer .................................................... 127

5.4.1 Recording Options: Simple Mode Summit M5x Jammer (AJ)........................................................127

5.4.2 Recording Options: Advanced Mode Summit M5x Jammer (AJ) ..................................................128

Options in Advanced Mode: Disable Auto Channel Swap .......................................................... 129

Options in Advanced Mode: TC to VC mapping........................................................................... 131

5.5 Recording Type: Triggering Options................................................................................ 132

5.5.1 Snapshot .............................................................................................................................................132

Teledyne LeCroy

6 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

5.5.2 Manual Trigger....................................................................................................................................132

5.5.3 Event Trigger ......................................................................................................................................132

Events: Triggering On (Simple Mode) ........................................................................................... 133

5.6 Trigger Mode....................................................................................................................... 134

5.7 Recording Mode.................................................................................................................. 137

5.7.1 Protocol Recording ............................................................................................................................137

Recording the CCIX Protocol ......................................................................................................... 137

5.8 Buffer Size........................................................................................................................... 139

5.9 Trigger Position .................................................................................................................. 140

5.10 Filter Out............................................................................................................................ 140

5.11 Jammer Action.................................................................................................................. 140

5.12 Advanced Trace File Settings.......................................................................................... 141

5.13 Trace Filename and Path ................................................................................................. 142

5.14 Saving and Loading Previously Saved Recording Options ......................................... 143

5.14.1 Saving Recording Options ..............................................................................................................143

5.14.2 Loading Recording Options ............................................................................................................143

5.14.3 Loading Recording Options ............................................................................................................143

5.14.4 Saving Recording Options ..............................................................................................................144

5.15 Transceiver Preset Settings ............................................................................................ 144

5.16 Viewing Legacy Multi-Segmented CATC Traces ........................................................... 145

5.17 Link Settings ..................................................................................................................... 146

5.17.1 Speed.................................................................................................................................................147

5.17.2 Link Width .........................................................................................................................................147

5.17.3 Upstream and Downstream .............................................................................................................148

5.17.4 Reference Clock ...............................................................................................................................149

Reference Clock: Cable A............................................................................................................... 151

Reference Clock: Cable B............................................................................................................... 151

5.17.5 Set Reference Clocks Independently .............................................................................................152

5.17.6 Disable Descambling .......................................................................................................................152

5.17.7 Auto-Configure Lane Polarity..........................................................................................................153

5.17.8 Ignore Idle Errors..............................................................................................................................153

5.17.9 Swizzling Config... ............................................................................................................................153

Manual Configure Lane Swizzle ..................................................................................................... 153

Example: Move Highest Source Lane First................................................................................... 155

Example: Move Lowest Source Lane First.................................................................................... 156

Working with Less Than Sixteen Lanes........................................................................................ 156

Auto-Configure Lane Swizzle......................................................................................................... 159

5.17.10 Decode Optimized Buffer Flush/Fill (OBFF).................................................................................160

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 7

Teledyne LeCroy

5.18 Triggering.......................................................................................................................... 161

5.18.1 Triggering On (Advanced Mode).....................................................................................................161

5.19 Navigating Recording Rules............................................................................................ 162

5.19.1 Toolbar ..............................................................................................................................................162

5.19.2 Available Events Area ......................................................................................................................162

5.19.3 Main Display Area.............................................................................................................................163

5.19.4 Recording Rules Buttons ................................................................................................................163

5.20 Recording Rules Overview .............................................................................................. 163

5.20.1 Defining Recording Rules................................................................................................................163

Steps to Create a Recording Rule.................................................................................................. 164

5.20.2 Resources .........................................................................................................................................166

Basic Matcher (x8)........................................................................................................................... 167

5.20.3 Ordered Set (OS) Matcher (x8) ........................................................................................................168

Trigger on Control Skip .................................................................................................................. 169

5.20.4 Data Link Layer Packets (DLLPs) Matcher (x8) .............................................................................171

5.20.5 Transaction Layer Packets (TLPs) Matcher (x8)............................................................................172

5.20.6 Global State and Sequence States .................................................................................................173

Global State...................................................................................................................................... 173

Sequence State................................................................................................................................ 175

5.20.7 Recording Rules Events ..................................................................................................................176

5.20.8 Properties Dialog Boxes for Events ...............................................................................................179

Accessing the Properties Dialog ................................................................................................... 179

Event Properties Dialog Box Features .......................................................................................... 179

Link State Dialog ............................................................................................................................. 180

Ordered Sets.................................................................................................................................... 183

Framing Token................................................................................................................................. 185

Error Properties Dialog................................................................................................................... 189

DLLP Packet Properties Dialog...................................................................................................... 190

TLP Header Properties Dialog........................................................................................................ 192

TLP Prefix Properties Dialog .......................................................................................................... 193

NVME Register Properties Dialog.................................................................................................. 196

PQI Register Properties Dialog ...................................................................................................... 199

5.20.9 Actions Properties Dialog................................................................................................................200

Filter Out........................................................................................................................................... 201

Filter-Out In Simple Mode............................................................................................................... 202

Filter-Out in Advanced Mode.......................................................................................................... 203

5.20.10 Filter In.............................................................................................................................................203

5.20.11 Valid Configuration ........................................................................................................................204

5.20.12 Invalid Configuration......................................................................................................................206

5.20.13 Filtering Events: (Electrical Idle, CLKREQ#, WAKE#).................................................................207

Example of CLKREQ# Filtering Enabled....................................................................................... 207

Example of CLKREQ# Filtering Not Enabled ................................................................................ 208

Teledyne LeCroy

8 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

5.20.14 Filtering Out NVMe CSTS, DLLP Ack and TLP Completions......................................................209

5.20.15 Triggering Configuration on a per Lane Basis ............................................................................220

DLLP/TLP Packets Category .......................................................................................................... 221

Errors Category ............................................................................................................................... 221

Ordered Sets Category ................................................................................................................... 222

5.20.16 Lane Trigger Configuration ...........................................................................................................223

Example 1:........................................................................................................................................ 223

Lane Trigger Configuration Example 2: ........................................................................................ 223

Lane Trigger Configuration Example 3: ........................................................................................ 224

5.20.17 Counter............................................................................................................................................226

How to Set a Counter ...................................................................................................................... 227

How to Increment or Reset a Counter ........................................................................................... 228

Changing the Value of the Counter ............................................................................................... 230

Deleting a Counter........................................................................................................................... 230

5.20.18 Timer................................................................................................................................................230

How to Set a Timer .......................................................................................................................... 231

How to Start or Reset a Timer ........................................................................................................ 232

Changing the Value of the Timer ................................................................................................... 233

Deleting a Timer............................................................................................................................... 234

5.20.19 Channel ...........................................................................................................................................234

5.20.20 Lane Margining ...............................................................................................................................235

5.21 Triggering On (Advanced Mode)..................................................................................... 237

5.21.1 Triggering On (Advanced Mode).....................................................................................................239

Selecting Triggers/Filters to be Active.......................................................................................... 239

Selected Items Settings .................................................................................................................. 240

Direction........................................................................................................................................... 240

5.22 Recording Options for Compute Express Link (CXL) Mode......................................... 241

5.22.1 Triggering On (Simple Mode): PCIe Phy & CXL.io ........................................................................242

5.22.2 Trigger On CXL.cache/mem ............................................................................................................243

5.22.3 Trigger On CXL Flits.........................................................................................................................244

5.22.4 CXL: Filter Out for PCIe Phy and CXL.io ........................................................................................245

5.22.5 CXL: Filter Out for CXL.cache/mem................................................................................................246

5.22.6 CXL: Filter Out for CXL Flits............................................................................................................246

Chapter 6: Recording Options: AJA Mode .......................................................247

6.1 Jammer Mode Overview..................................................................................................... 247

6.1.1 Jammer Mode (AJ) .............................................................................................................................247

6.1.2 Jammer Mode (AJA)...........................................................................................................................247

6.1.3 PCIe Protocol Analysis Software ......................................................................................................247

6.1.4 Recording Options .............................................................................................................................248

6.1.5 Recording Options: Recording Rules (AJ) ......................................................................................250

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 9

Teledyne LeCroy

6.1.6 Recording Rules AJ: New Events .....................................................................................................251

6.2 Converting Recording Rules and Jammer Actions from GUI to Script File (AJ).......... 252

6.2.1 Complex Recording Rules.................................................................................................................252

6.2.2 Jammer Options .................................................................................................................................254

Example: Jammer Replace............................................................................................................. 255

6.3 Script Mode ......................................................................................................................... 259

6.3.1 Script Parsing .....................................................................................................................................263

6.4 Commands .......................................................................................................................... 264

6.5 Events.................................................................................................................................. 265

6.6 Jammer Actions.................................................................................................................. 266

6.7 Scripting Jammer Functionality........................................................................................ 267

6.7.1 Example: Select Jammer Action: Delete ..........................................................................................267

6.8 Recording Options and Jammer Action Script................................................................ 272

6.9 Updating Jammer Action Script........................................................................................ 274

6.10 Warning Message if Mistake in Jammer Script.............................................................. 279

6.11 Updated GUI After Scripting Mistake Corrected............................................................ 281

6.12 Saving a Jammer Actions Script File.............................................................................. 282

6.13 Loading a Jammer Script File.......................................................................................... 283

6.14 Examples of Scripting for Common Events with Jammer Actions.............................. 287

6.14.1 Link State: Speed Change ...............................................................................................................288

6.14.2 Ordered Set: TS2 ..............................................................................................................................292

Ordered Set: TS1 ............................................................................................................................. 293

6.14.3 Framing Token: EDS ........................................................................................................................296

6.14.4 Errors: Symbol Error........................................................................................................................298

6.14.5 DLLP: Any ........................................................................................................................................300

6.14.6 TLP: Any...........................................................................................................................................302

6.14.7 NVMe..................................................................................................................................................304

NVMe Register ................................................................................................................................. 304

NVMe Command Submission: Any................................................................................................ 305

NVMe Command Completion: Any ................................................................................................ 308

6.15 Jammer Mode Overview (AJA)........................................................................................ 310

6.15.1 Examples of AJA Traces (Jammer Actions and Results).............................................................312

Delete: UpdateFC_P DLLP Packet ................................................................................................. 312

Insert Error: DROP_STP_SDP for UpdateFC_P Packet ............................................................... 315

Insert TLP After UpdateFC_NP Packet.......................................................................................... 318

Modify: UpdateFC_P Packet to UpdateFC_NP Packet................................................................. 321

Replace: UpdateFC_CP with TS1_PAD_PAD................................................................................ 324

Teledyne LeCroy

10 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

Chapter 7: Recording Options: Analyzer Only Mode.......................................327

7.1 Recording Overview........................................................................................................... 327

7.1 Recording Option Dialog ................................................................................................... 327

7.2 Select Summit M5x Analyzer for Recording .................................................................... 327

7.3 Recording Options M5x Analyzer: Simple Mode............................................................. 328

7.4 Recording Options M5x Analyzer: Event Trigger Mode.................................................. 329

7.5 Recording Options M5x Analyzer: Advanced Mode........................................................ 330

7.6 Recording Type................................................................................................................... 332

7.6.1 Snapshot .............................................................................................................................................332

7.6.2 Manual Trigger....................................................................................................................................332

7.6.3 Event Trigger ......................................................................................................................................333

......................................................................................................... Triggering On (Simple Mode) 334

Filter Out (Simple Mode)................................................................................................................. 335

7.7 Recording Mode.................................................................................................................. 336

7.7.1 Protocol Recording ............................................................................................................................336

7.7.2 Bit Tracer Recording ..........................................................................................................................337

7.8 Buffer Size........................................................................................................................... 337

7.9 Trigger Position .................................................................................................................. 337

7.10 Advanced Trace File Settings.......................................................................................... 338

7.11 Analyzer & Probe Settings............................................................................................... 339

7.11.1 Library ...............................................................................................................................................339

7.11.2 Search Filter......................................................................................................................................340

7.11.3 Saving a Selected Preset .................................................................................................................342

7.11.4 Library Operations ...........................................................................................................................344

Buttons & Functions ....................................................................................................................... 345

7.12 Trace Filename and Path ................................................................................................. 346

7.13 Saving and Loading Previously Saved Recording Options ......................................... 346

7.13.1 Saving Recording Options ..............................................................................................................346

7.13.2 Loading Recording Options ............................................................................................................347

7.13.3 Loading Recording Options ............................................................................................................347

7.13.4 Saving Recording Options ..............................................................................................................347

7.14 Viewing Legacy Multi-Segmented CATC Traces ........................................................... 348

7.15 Link Settings ..................................................................................................................... 348

7.15.1 Speed.................................................................................................................................................349

7.15.2 Link Width .........................................................................................................................................351

7.15.3 Upstream and Downstream .............................................................................................................353

7.15.4 Reference Clock ...............................................................................................................................353

Internal.............................................................................................................................................. 354

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 11

Teledyne LeCroy

External ............................................................................................................................................ 354

SMA................................................................................................................................................... 355

7.15.5 Set Reference Clock Independently ...............................................................................................356

7.15.6 Auto-Configure Lane Polarity..........................................................................................................357

7.15.7 Ignore Idle Errors..............................................................................................................................357

7.15.8 Swizzling Config... ............................................................................................................................357

Manual Configure Lane Swizzle ..................................................................................................... 357

Example: Move Highest Source Lane First................................................................................... 360

Example: Move Lowest Source Lane First.................................................................................... 360

Working with Less Than Eight Lanes............................................................................................ 361

Auto-Configure Lane Swizzle......................................................................................................... 362

7.15.9 Decode Optimized Buffer Flush/Fill (OBFF)...................................................................................364

7.15.10 Disable Descrambling ....................................................................................................................364

7.15.11 Ignore EDS ......................................................................................................................................364

7.16 General guidelines to do the Calibration and AutoTuning........................................... 364

7.16.1 Interposer Host to DUT Path ...........................................................................................................366

Interposer Host to DUT Autotune .................................................................................................. 367

Using Z516 or Z58 as a DUT ........................................................................................................... 369

Auto-tuning algorithms................................................................................................................... 370

Host is on Linux OS: ....................................................................................................................... 385

Write to Interposer........................................................................................................................... 391

Write to RAM.................................................................................................................................... 391

Write to Flash + RAM ...................................................................................................................... 391

Write Default to Flash + RAM ......................................................................................................... 391

Configurations: U2 x2, U2 x4.......................................................................................................... 391

Read from Interposer ...................................................................................................................... 391

Set All Lanes.................................................................................................................................... 392

Log.................................................................................................................................................... 392

Save to File....................................................................................................................................... 392

Load from File or Predefined Values ............................................................................................. 392

7.16.2 Interposer to Analyzer Path.............................................................................................................394

Calibration Sequence...................................................................................................................... 396

7.16.3 Analyzer Calibration.........................................................................................................................397

Analyzer Calibration: Auto Option................................................................................................. 398

Analyzer Calibration: Manual Option............................................................................................. 399

7.16.4 Using the Autotune and Probe Calibration Wizard .......................................................................401

7.16.5 Interposer Settings for Bifurcated Multiport Link .........................................................................412

7.16.6 Saving Auto-Tune and Calibration Results....................................................................................414

7.17 Analysis Options .............................................................................................................. 414

7.17.1 Example: Gen5 Trace .......................................................................................................................414

7.18 BitTracer Recording ......................................................................................................... 416

7.18.1 Enabling BitTracer Recording.........................................................................................................416

Teledyne LeCroy

12 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

7.18.2 Triggering in Simple Mode ..............................................................................................................417

7.18.3 Views Available for Captured Data .................................................................................................417

7.18.4 De-skewing Data...............................................................................................................................418

7.18.5 Data Display Formats.......................................................................................................................419

7.18.6 Color-Coding of BitTracer Contents...............................................................................................419

7.18.7 Report and Analysis Windows ........................................................................................................420

7.18.8 Timing Measurements Bar...............................................................................................................420

Markers/Speed Bar.......................................................................................................................... 420

Defining a Marker ............................................................................................................................ 421

7.18.9 Errors Bar..........................................................................................................................................423

7.18.10 Symbols Bar....................................................................................................................................425

7.18.11 Events Bar.......................................................................................................................................425

7.18.12 Packets Bar.....................................................................................................................................426

7.18.13 Decoding Bar ..................................................................................................................................427

7.18.14 Search..............................................................................................................................................428

7.18.15 Link Configuration..........................................................................................................................429

7.18.16 Export of BitTracer Capture to CATC Trace Format ...................................................................431

Exports Involving Multiple Logical Links on One Physical Link ................................................ 431

Export To CSV Text......................................................................................................................... 431

Exporting Data from Bit Tracer to a Trace File............................................................................. 433

7.18.17 Compressing and Expanding the Data View ...............................................................................438

7.18.18 Opening and Saving BitTracer Captures .....................................................................................438

Chapter 8: Jammer Options ...............................................................................439

8.1 Jammer Mode Overview..................................................................................................... 439

8.1.1 Jammer Mode (AJ) .............................................................................................................................439

8.1.2 Jammer Mode (AJA)...........................................................................................................................439

8.1.3 PCIe Protocol Analysis Software ......................................................................................................439

8.1.4 Recording Options .............................................................................................................................440

8.1.5 Recording Options: Recording Rules (AJ) ......................................................................................442

8.1.6 Recording Rules AJ: New Events .....................................................................................................443

8.2 Converting Recording Rules and Jammer Actions from GUI to Script File (AJ).......... 444

8.2.1 Complex Recording Rules.................................................................................................................444

8.2.2 Jammer Options .................................................................................................................................446

8.3 Script Mode ......................................................................................................................... 447

8.3.1 Script Parsing .....................................................................................................................................451

8.4 Commands ......................................................................................................................... 452

8.5 Events.................................................................................................................................. 453

8.6 Jammer Actions.................................................................................................................. 453

8.7 Scripting Jammer Functionality........................................................................................ 454

8.7.1 Example: Select Jammer Action: Delete ..........................................................................................455

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 13

Teledyne LeCroy

8.8 Recording Options and Jammer Action Script................................................................ 459

8.9 Updating Jammer Action Script........................................................................................ 461

8.10 Warning Message if Mistake in Jammer Script.............................................................. 466

8.11 Updated GUI After Scripting Mistake Corrected............................................................ 468

8.12 Saving a Jammer Actions Script File.............................................................................. 468

8.13 Loading a Jammer Script File.......................................................................................... 470

8.14 Examples of Scripting for Common Events with Jammer Actions.............................. 474

8.14.1 Link State: Speed Change ...............................................................................................................475

8.14.2 Ordered Set: TS2 ..............................................................................................................................479

8.14.3 Framing Token: EDS ........................................................................................................................483

8.14.4 Errors: Symbol Error........................................................................................................................485

8.14.5 DLLP: Any ........................................................................................................................................487

8.14.6 TLP: Any...........................................................................................................................................489

8.14.7 NVMe..................................................................................................................................................491

NVMe Register ................................................................................................................................. 491

NVMe Command Submission: Any................................................................................................ 493

NVMe Command Completion: Any ................................................................................................ 495

8.15 Jammer Mode Overview (AJA)........................................................................................ 497

8.15.1 Examples of AJA Traces (Jammer Actions and Results).............................................................499

Delete: UpdateFC_P DLLP Packet ................................................................................................. 499

Insert Error: DROP_STP_SDP for UpdateFC_P Packet ............................................................... 502

Insert TLP After UpdateFC_NP Packet.......................................................................................... 505

Modify: UpdateFC_P Packet to UpdateFC_NP Packet................................................................. 508

Replace: UpdateFC_CP with TS1_PAD_PAD................................................................................ 511

Chapter 9: Reading CATC Traces......................................................................515

9.1 Viewing PCI Express CATC Traces................................................................................... 515

9.2 Expand and Collapse Data Fields ..................................................................................... 515

9.3 Resizing Cells ..................................................................................................................... 516

9.4 Pop-up Menus..................................................................................................................... 516

9.5 View Data Block.................................................................................................................. 516

9.5.1 Save Data Block..................................................................................................................................517

9.6 Show Raw 10b Codes......................................................................................................... 518

9.7 Show Header Fields............................................................................................................ 519

9.8 Packet Cell Popup Menus.................................................................................................. 520

9.8.1 Show/Hide Link Tracker.....................................................................................................................521

9.8.2 Show Raw 10b Codes ........................................................................................................................522

9.8.3 Time From Trigger..............................................................................................................................523

Teledyne LeCroy

14 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

9.8.4 Time From Marker ..............................................................................................................................524

9.8.5 Copy for PETrainer ‘packet’ command ............................................................................................525

9.8.6 Set Start Quick Timing Marker ..........................................................................................................526

9.8.7 Set End Quick Timing Marker............................................................................................................526

9.8.8 Tag Pop Up Menu ...............................................................................................................................527

Quick Timing Bar............................................................................................................................. 529

9.8.9 Delete All Quick Timing Markers.......................................................................................................529

9.8.10 Set Marker .........................................................................................................................................529

9.8.11 Edit or Clear Marker .........................................................................................................................531

9.8.12 Format ...............................................................................................................................................532

9.8.13 Color ..................................................................................................................................................533

9.8.14 Other Packet Cell Popup Menus .....................................................................................................534

Packet Header R-> Cell Popup Menu............................................................................................. 534

Packet Header Speed Cell Popup Menu........................................................................................ 534

9.9 Compressed CATC Trace View ......................................................................................... 535

9.10 Spreadsheet View............................................................................................................. 536

9.10.1 Columns ............................................................................................................................................538

9.10.2 Detail View and Spreadsheet View .................................................................................................542

9.11 Decoding Traffic ............................................................................................................... 542

9.11.1 Packet ................................................................................................................................................542

9.11.2 Link ....................................................................................................................................................545

9.11.3 Split....................................................................................................................................................545

9.11.4 Lane Margining Decoding................................................................................................................546

Typical Lane Margining Commands and Responses .................................................................. 546

Lane Margining Command: Step Margin to Timing Offset.......................................................... 548

Lane Margining Errors .................................................................................................................... 549

9.11.5 NVMe Decoding ................................................................................................................................550

NVMe: Device ID and Model Name Decoded ................................................................................ 552

NVMe: Data Field on Packets ......................................................................................................... 553

NVMe: Trusted Computing Group Decode ................................................................................... 555

The Opal Storage Specification ..................................................................................................... 556

Opalite Version 0.1: Decoded......................................................................................................... 558

NVMe: Command IOPS and Doorbell Statistical Information ..................................................... 560

NVMe: Decode for Doorbells.......................................................................................................... 564

Time Stamp from Implicit Start ...................................................................................................... 566

NVMe Commands and Transactions: Data Throughput .............................................................. 567

NVMe Decoding vs. NVMe Specification....................................................................................... 568

NVMe Controller Register............................................................................................................... 571

Decoding Multiple NVMe Commands for a Single MemRead or MemWrite............................... 575

9.11.6 NVMe 1.2 Specification Decoding...................................................................................................578

9.11.7 Support for Physical Region Page (PRP) and Scatter Getter List (SGL) in Controller Memory Buf-

fer (CMB) ......................................................................................................................................................582

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 15

Teledyne LeCroy

9.11.8 NVMe Decoding for Host Memory Buffer FID ................................................................................585

9.11.9 AHCI...................................................................................................................................................586

9.11.10 ATA ..................................................................................................................................................586

ATA IO: Pending Transactions Statistical Report ........................................................................ 587

9.11.11 PQI ...................................................................................................................................................590

9.11.12 SOP ..................................................................................................................................................590

9.11.13 SCSI .................................................................................................................................................591

9.11.14 Decoding MCTP (Management Component Transport Protocol) ..............................................592

MCTP Levels in Floating Transactions Bar Window.................................................................... 592

Decoding MCTP Commands .......................................................................................................... 593

Expanding MCTP Commands ........................................................................................................ 597

Decoding MCTP Messages............................................................................................................. 598

MCTP Commands with SMBus Traffic .......................................................................................... 599

MCTP Commands: Request from Host, Response from Device................................................. 600

Decoding MCTP Messages and Transactions.............................................................................. 601

MCTP Messages .............................................................................................................................. 602

MCTP Transactions......................................................................................................................... 602

MCTP Errors Reported.................................................................................................................... 603

MCTP Trace In Spreadsheet View.................................................................................................. 604

Decoding MCTP Messages with PLDM Message Types.............................................................. 605

Decoding MCTP Messages with NC-SI Message Types .............................................................. 606

MCTP Command with NVMe-MI Errors Decoded ......................................................................... 607

MCTP Message Type and IC Cells ................................................................................................. 608

9.11.15 Decoding MCTP Messages with SMBus Traffic ..........................................................................610

Sideband Traffic: Displayed or Hidden ......................................................................................... 612

SMBus Errors................................................................................................................................... 614

SMBus Error Tooltip........................................................................................................................ 615

Traffic Summary Report: SMBus Errors ....................................................................................... 616

9.11.16 Decoding SMBus with Address Resolution Protocol (ARP) ......................................................618

9.11.17 Decoding MCTP Traffic with Vendor Defined Messages (VDM).................................................619

9.11.18 Decoding Side Band Signals.........................................................................................................620

9.11.19 PMUX Channel ID Found and PMUX Packet Error Decoded in Trace .......................................621

9.11.20 Decoding Traces with Different Class Codes ..............................................................................622

Example: Loading an NVMe Trace and Decoding for ATA.......................................................... 622

Example: Loading a PQI Trace and Decoding for NVMe ............................................................. 623

9.11.21 Data Link Features .........................................................................................................................624

9.11.22 Decode for NVMe 1.3c Specification ............................................................................................625

9.11.23 NVMe Warning Messages ..............................................................................................................629

Trace View........................................................................................................................................ 629

Traffic Summary View..................................................................................................................... 631

Find NVMe Commands and Transactions..................................................................................... 634

Hiding NVMe Warning Messages................................................................................................... 636

9.11.24 Decoding Lightweight Notification (LN) Protocol .......................................................................637

Teledyne LeCroy

16 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

Lightweight Notification Protocol Errors ...................................................................................... 638

Lightweight Notification Protocol in Trace Expert....................................................................... 639

Lightweight Notification Transaction Analysis Errors: Trace Expert......................................... 641

Find: Lightweight Notification Transactions ................................................................................ 642

9.11.25 Decoding CCIX Protocol ................................................................................................................643

9.11.26 Decoding TCG Support of Pyrite ..................................................................................................644

9.11.27 MCTP: Simple Hiding .....................................................................................................................645

MCTP: Hide VDM Traffic ................................................................................................................. 645

MCTP: Hide SMBus Traffic ............................................................................................................. 647

MCTP Message Type and IC Cells ................................................................................................. 649

9.11.28 Decoding NVME-MI Version 1.1 ....................................................................................................651

9.11.29 Swapping Direction of Recorded Traffic Data .............................................................................652

9.11.30 Decoding Traces Exported from USB4 Traces with Tunneled PCIe Traffic..............................655

9.11.31 Decoding CXL Traffic .....................................................................................................................657

Chapter 10: Searching CATC Traces ................................................................659

10.1 CATC Trace Search Overview ......................................................................................... 659

10.2 Go to Trigger..................................................................................................................... 660

10.3 Go to Selected Packet......................................................................................................660

10.4 Go to Packet...................................................................................................................... 660

10.5 Go to Time......................................................................................................................... 661

10.6 Go To Marker..................................................................................................................... 661

10.6.1 Markers..............................................................................................................................................662

Markers Overview............................................................................................................................ 662

Functionality of Markers................................................................................................................. 663

Set New Marker................................................................................................................................ 663

10.6.2 Attaching Markers ............................................................................................................................664

10.6.3 Adding an Attachment .....................................................................................................................665

10.6.4 Recording an Audio File ..................................................................................................................665

10.6.5 Video Files Supported......................................................................................................................666

10.6.6 Attachment Types and Visualization ..............................................................................................666

10.6.7 Embedded Attachments to a Marker ..............................................................................................666

10.6.8 Viewing Attachments of a Marker ...................................................................................................667

Text ................................................................................................................................................... 667

Audio ................................................................................................................................................ 668

Video................................................................................................................................................. 669

File Attachment................................................................................................................................ 669

URL Link........................................................................................................................................... 669

YouTube Video ................................................................................................................................ 671

Images .............................................................................................................................................. 671

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 17

Teledyne LeCroy

Other Attachments .......................................................................................................................... 672

10.6.9 Edit Marker........................................................................................................................................673

10.6.10 All Markers Dialog ..........................................................................................................................674

10.6.11 CATC Walk Playlist.........................................................................................................................676

10.6.12 Playlist Functionality......................................................................................................................676

10.6.13 Playback Window ...........................................................................................................................677

Playlist Playback Controls.............................................................................................................. 678

10.7 Go to NVMe Transactions and Commands.................................................................... 679

10.7.1 NVMe Transaction ............................................................................................................................679

10.7.2 NVMe Command ...............................................................................................................................680

10.8 Go To SCSI Menu.............................................................................................................. 681

10.9 Go To Menu....................................................................................................................... 682

10.9.1 Example: Search -> Go to -> Link Event -> Link Up/Link Down...................................................683

10.9.2 Example: Go To CXL ........................................................................................................................684

10.10 Find .................................................................................................................................. 685

10.10.1 Event Groups for Packets..............................................................................................................689

Example: TS1 and TS2 Event Groups ........................................................................................... 690

Example: Search for PMUX Channel ID......................................................................................... 699

10.10.2 Find Function and CXL Packets....................................................................................................701

10.10.3 Event Groups for Link Transactions: ...........................................................................................702

10.10.4 Event Groups for Split Transactions:...........................................................................................702

10.10.5 Event Groups for LM Commands .................................................................................................702

10.10.6 Event Groups for NVMe transactions:..........................................................................................703

10.10.7 Event Groups for PQI Transactions: ............................................................................................704

10.10.8 Event Groups for AHCI Transactions:..........................................................................................704

10.10.9 Event Groups for ATA transactions: ............................................................................................704

10.10.10 Event Groups for SOP Transactions: ........................................................................................704

10.10.11 Event Groups for SCSI Transactions: .......................................................................................704

10.10.12 Event Groups for NVMe Commands: ........................................................................................705

Example: Search for NVMe Command .......................................................................................... 705

Example: Search for NVMe Command: NVM Payload Portion.................................................... 708

10.10.13 Example: Search for DLLP Header -> Flow Control Feature....................................................710

10.11 Find Next Packet Type ................................................................................................... 712

10.11.1 Quick Search Feature.....................................................................................................................712

10.12 Toggle Search Direction ................................................................................................ 715

Chapter 11: Display Options ..............................................................................717

11.1 Setting Display Options ................................................................................................... 717

11.2 Specifying General Display Options............................................................................... 718

11.2.1 Collapsing Data Fields .....................................................................................................................718

11.2.2 Fonts..................................................................................................................................................719

Teledyne LeCroy

18 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

11.2.3 Configuration Name .........................................................................................................................719

11.2.4 Color, Format, and Hiding Options.................................................................................................719

11.2.5 Setting Field Colors..........................................................................................................................720

11.2.6 Changing Field Formats ..................................................................................................................722

11.2.7 Hiding Fields .....................................................................................................................................724

11.2.8 Hiding Levels ....................................................................................................................................724

11.2.9 Error Hiding.......................................................................................................................................728

Transaction Types........................................................................................................................... 729

11.3 Load a Previously Saved Display Options File.............................................................. 732

11.4 Saving Display Options.................................................................................................... 732

Chapter 12: Reports and Tools..........................................................................733

12.1 Trace Expert...................................................................................................................... 736

12.1.1 Performance Analysis......................................................................................................................739

12.1.2 Trace Analysis Statistics .................................................................................................................740

12.1.3 Error Reports ....................................................................................................................................741

12.1.4 Trace Information .............................................................................................................................742

12.2 Trace Information ............................................................................................................. 743

12.3 Error Summary.................................................................................................................. 746

12.3.1 Error Summary for Storage Protocols............................................................................................746

12.3.2 Error Summary for Storage Protocols -- NVMe .............................................................................749

Types of NVMe Errors:.................................................................................................................... 749

12.3.3 NVMe Queue Errors..........................................................................................................................749

Types of NVMe Queue Errors......................................................................................................... 750

12.3.4 NVMe CMD Errors.............................................................................................................................751

Types of NVMe CMD Errors............................................................................................................ 751

12.4 Traffic Summary ............................................................................................................... 754

12.4.1 Traffic Summary for Storage Protocols .........................................................................................754

12.4.2 Using the Traffic Summary Window to Search the CATC Trace..................................................755

12.4.3 NVMe Queue Time Metrics ..............................................................................................................755

NVMe Queue Time Metrics Defined (Commands/Transactions)................................................. 757

NVME Command Example.............................................................................................................. 757

NVME Transaction Example........................................................................................................... 758

12.4.4 Traffic Summary Buttons.................................................................................................................758

12.4.5 Traffic Summary for Flow Control ..................................................................................................759

12.4.6 Example: CXL in Traffic Summary..................................................................................................760

12.4.7 Example: CXL Errors Shown in Traffic Summary Report.............................................................761

12.4.8 CXL Flit Data View ............................................................................................................................762

12.5 Bus Utilization................................................................................................................... 767

12.5.1 Bus Utilization Pop-up Menu...........................................................................................................768

12.5.2 Bus Utilization Buttons ....................................................................................................................769

Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual 19

Teledyne LeCroy

Graph Area Options ........................................................................................................................ 771

Example: NVMe Queue Load Graph Feature ................................................................................ 773

Graph Legend .................................................................................................................................. 774

Graph Properties ............................................................................................................................. 774

12.6 Link Tracker ...................................................................................................................... 775

12.6.1 Using the Link Tracker Window ......................................................................................................775

12.6.2 Zooming In and Out..........................................................................................................................776

12.6.3 Collapsing Idle Time, Enabling Tool tips, and Resetting Column Widths ..................................776

12.6.4 Docking and Undocking the Window .............................................................................................777

12.6.5 Setting Markers.................................................................................................................................777

12.6.6 Calculating Time between DWORDs ..............................................................................................777

12.6.7 Hiding Traffic ....................................................................................................................................778

12.6.8 Link Tracker Buttons........................................................................................................................778

Exporting to CSV File...................................................................................................................... 780

12.7 Data Flow Window............................................................................................................ 781

12.8 Flow Control Tracking......................................................................................................783

12.9 Using the CATC Trace Navigator .................................................................................... 784

12.9.1 Displaying the Navigator .................................................................................................................784

12.9.2 Navigator Toolbar.............................................................................................................................784

12.9.3 Navigator Ranges .............................................................................................................................785

12.9.4 To Determine Current Position .......................................................................................................785

12.9.5 To Reset Navigator Range...............................................................................................................786

12.9.6 Navigator Panes ...............................................................................................................................786

12.9.7 To Show/Hide Nav55igator Panes...................................................................................................787

12.9.8 Navigator Slider ................................................................................................................................787

12.9.9 CATC Trace Navigator Legend........................................................................................................787

12.9.10 Using the Legend to Show/Hide Navigator Panes ......................................................................788

12.9.11 Using the Legend to Set the Priority of Information Display .....................................................788

12.10 Detail View....................................................................................................................... 790

12.11 LTSSM Flow Graph......................................................................................................... 791

12.11.1 LTSSM Dynamic Equalization .......................................................................................................792

Teledyne LeCroy

20 Summit M5x PCI Express Multi-Lane Protocol Analyzer/Jammer User Manual

12.12 TCG Security View.......................................................................................................... 795

12.13 Get Log Page View .........................................................................................................797

12.14 Lane Margining: Eye Diagram ....................................................................................... 798

12.15 Packet Header Bar.......................................................................................................... 801

12.16 Packet Data Window....................................................................................................... 802

12.17 Configuration Space View ............................................................................................. 803

12.18 Using Unit Metrics .......................................................................................................... 808

12.19 Metrics Defined for Link Transactions ......................................................................... 808

12.19.1 Metrics Defined for Split Transactions.........................................................................................808

12.20 Show Metrics in the CATC Trace Display..................................................................... 809

12.20.1 Collapsed Metrics Header Display................................................................................................809

12.20.2 Metrics Tool Tip Display ................................................................................................................809

12.20.3 Expanded Metrics Header Display................................................................................................809

12.21 Show Metrics in the Traffic Summary Window............................................................ 811

12.21.1 Reports at Split Transaction Level ...............................................................................................811

12.21.2 Reports at the Link Transaction Level .........................................................................................811

12.22 Show Metrics in the Bus Utilization Window ............................................................... 813

12.22.1 Unit-Based Averaging ....................................................................................................................813

12.22.2 Bus Utilization Window Features..................................................................................................814

12.22.3 Split Transaction Level Graphs.....................................................................................................814

12.22.4 Link Transaction Level Graphs .....................................................................................................815

12.23 Real-Time Statistics Window......................................................................................... 817

12.23.1 Real-Time Statistics Buttons.........................................................................................................818

12.23.2 Real-Time Statistical Monitor Pop-up Menu ................................................................................819

12.23.3 Real-Time Statistics Graph Areas.................................................................................................820

Data Packet Count........................................................................................................................... 820

12.24 Tools -> Import Configuration Space File .................................................................... 823

12.25 Tools -> Configuration Space Editor ............................................................................ 825

12.26 Tools -> Memory I/O Space Editor ................................................................................ 827

12.27 Tools -> Interposer Programmer................................................................................... 828

12.27.1 Installing the FTDI Serial Cable.....................................................................................................828

12.27.2 Installing USB Type-C Serial Cable ..............................................................................................829

12.27.3 Running the PCIe Interposer ASIC Programmer Utility ..............................................................831

12.27.4 PCIe Interposer ASIC Programmer Utility Functionality.............................................................833

Equalization Settings ...................................................................................................................... 834

Write to Flash................................................................................................................................... 834

Write to Interposer........................................................................................................................... 834

Read from Interposer ...................................................................................................................... 834

Set All Lanes.................................................................................................................................... 834

Page is loading ...

LeCroy PCIe Gen4 Summit M5x User manual

LeCroy PCIe Gen4 Summit M5x User manual

Related papers

Other documents