Page 11
Table of Contents 5.6.2 Resistor Detect ............210 5.6.3 Connect Status .
Page 12
Table of Contents Filter Out Pane ..............239 Individual Lane Triggering .
Page 13
Table of Contents 6.6.1 Using the Expand/Collapse Data Field Arrows ........267 6.6.2 Double-Click to Expand/Collapse Data Fields .
Page 14
Table of Contents 6.25 Port Alias ............298 6.26 Field Highlighting.
Page 15
Table of Contents 9.3.1 Decoding USB Device Requests ..........350 9.3.2 Decoding Standard Requests .
Page 16
Table of Contents 10.9 Link Tracker ............388 10.9.1 Time Overlap Indicator.
Page 17
Table of Contents 10.16.4 Configuration Channel (CC) Power Tracker........423 Configuration Channel (CC) Pins .
Page 18
Table of Contents 11.11 Repeating a Generation Session......... 451 11.12 Stop Traffic Generation .
Page 19
Table of Contents 12.11.8 Options Menu ............487 12.11.9 Outlining .
Page 20
13.5 Registering Online ........... . . 512 Appendix A: How to Contact Teledyne LeCroy ..... . 513 Appendix B: China Restriction of Hazardous Substances Table .
Page 21
Chapter 1 Overview 1.1 About USB Protocol analyzers Teledyne LeCroy USB protocol analyzers connect to portable or desktop host machines. analyzers are configured and controlled by USB Protocol Suite software, which installs onto ® ® host machines running 64-bit versions of Microsoft...
Portland, OR 97221 1.2 Common Features While there are some differences between the range of Teledyne LeCroy analyzers, there are also many shared features. 1.2.1 Graphical Bus Traffic Display In the Trace Viewer, bus traffic displays use color and graphics to show captured transactions (Figure 1.1).
The CrossSync Control Panel allows you to select analyzers for synchronization and manage the recording process. It supports a wide combination of Teledyne LeCroy analyzers, including PCI Express, USB, DDR, Serial ATA (SATA), Serial Attached SCSI (SAS), Fibre Channel (FC), and Ethernet.
Page 24
Navigating the traffic in either direction will scroll to the same timestamp in a synchronized window. When using the CrossSync option, users can access the full complement of analysis capabilities available within the individual Teledyne LeCroy software. Search, reporting, and decoding all operate normally (see 4.12.4 CrossSync Control...
Page 25
1.2.6 BusEngine Technology The analyzer uses Teledyne LeCroy BusEngine Technology. The BusEngine core uses Electrically Programmable Logic Device (EPLD) technology and incorporates both a real-time recording engine and configurable building blocks that implement data/state/error detection, triggering, capture filtering, external signal monitoring, and event counting and sequencing.
Page 26
USB 3.2 Super-Speed connection to desktop or portable host machine (M4x, M310e, M310P, M310C, M310, M3x) 1.2.9 Recording Options Teledyne LeCroy USB analyzers share recording options: Versatile triggering: bit-wise value and mask data patterns up to sixteen bytes ...
Page 27
Overview Common Features Groups numerous packets and transactions under a single transfer while quickly decoding all essential information Decodes split transactions upstream and downstream of a transaction translator with a special hierarchical view Has reports summarizing key statistics and conditions of interest, with the ability ...
Page 28
1.2.12.2 USB 3.2 Exerciser ReadyLink™ Emulation The Teledyne LeCroy Voyager USB 3.2 Exerciser features ReadyLink Emulation Mode. The ReadyLink feature handles all USB 3.2 link training and link flow control, allowing the emulator to operate at full line rate and respond to the DUT as defined by the specification.
Page 29
default Voltage and Current states. The Teledyne LeCroy Voyager™ M4x Analyzer and Exerciser system is a multifunction verification system for USB4, USB 3.2, SS and SS+, Power Delivery 2.0 and 3.0, and USB 2.0 development and testing. It uses the USB Type-C™ connectors to monitor both USB and Configuration Channel (CC) traffic and events.
Page 30
(Figure 1.3). Analysis of 40 Gbps traffic requires the use of short, low-loss, high quality cables, as provided by Teledyne LeCroy with your M4x product. Use of other cables may compromise the signal quality and prevent capturing of the traffic.
default Voltage and Current states. The Teledyne LeCroy Voyager M310e™ Protocol Analyzer/Exerciser is a multifunction verification system for USB development and testing. It supports USB 3.2 Gen 1 (5 Gbps) and Gen 2 (10 Gbps), as well as USB 2.0, Power Delivery (PD) 2.0 and 3.1 (with EPR) and USB Type- C™...
Page 32
10 Gbps Super Speed Plus traffic requires the use of short, low-loss, high quality cables, as provided by Teledyne LeCroy with your M310e product. Use of other cables may compromise the signal quality and prevent capturing of the traffic. Electronically Marked cables may be used in either of the connectors marked “Left”...
Page 33
10 Gbps Super Speed Plus traffic requires the use of short, low-loss, high quality cables, as provided by Teledyne LeCroy with your M310P product. Use of other cables may compromise the signal quality and prevent capturing of the traffic. Electronically Marked cables may be used in either of the connectors marked “Left”...
Page 34
default Voltage and Current states. The Teledyne LeCroy Voyager™ M310C Analyzer and Exerciser system is a multifunction verification system for USB 3.2, SS and SS+, Power Delivery 2.0 and 3.0, and USB 2.0 development and testing. It uses the USB Type-C™ connectors to monitor both USB and...
10 Gbps Super Speed Plus traffic requires the use of short, low-loss, high quality cables, as provided by Teledyne LeCroy with your M310C product. Use of other cables may compromise the signal quality and prevent capturing of the traffic. The use of 2 Electronically Marked cables is not permitted.
1.7 Voyager M310 Analyzer The Teledyne LeCroy Voyager™ M310 Analyzer and Exerciser system is a multifunction verification system for USB 3.2 and 2.0 development and testing. It can record traffic and graphically present logical USB transactions and events. It can also generate USB traffic. The system connects to a laptop or desktop via its USB or Gigabit Ethernet port.
Overview Voyager M310 Analyzer Figure 1.10: Voyager M310 Analyzer Exerciser System See the ReadMe file from the software installation site for the latest on host machine requirements and supported operating systems: https://teledynelecroy.com/sw/usb/ 1.7.1 USB 3.2 and USB 2.0 Features The system can monitor traffic between USB 2.0 links using standard high-speed compliant cables.
1.8 Voyager M3x Analyzer The Teledyne LeCroy Voyager™ M3x Analyzer and Exerciser system is a multifunction verification system for USB 2.0 and USB 3.2 development and testing. It can record traffic and graphically present logical USB transactions and events. It can also generate USB traffic. The system connects to a laptop or desktop via its USB or Gigabit Ethernet port.
Overview Voyager M3x Analyzer Figure 1.12: Voyager M3x Analyzer Exerciser System See the ReadMe file from the software installation site for the latest on host machine requirements and supported operating systems: https://teledynelecroy.com/sw/usb/ 1.8.1 USB 3.2 and USB 2.0 Features The system can monitor traffic between USB 2.0 links using standard high-speed compliant cables.
1.9 Advisor T3 The Teledyne LeCroy USB Advisor T3™ USB 3.2 Protocol Analyzer is a verification system for USB development and testing. It supports both USB 2.0 and USB 3.2. It can record USB traffic and graphically present the logical transactions and events. It connects to a laptop or desktop host machine through its USB port.
1.10 Mercury T2C The Teledyne LeCroy Mercury T2C™ USB 2.0 and Power Delivery Protocol Analyzer is a verification system for USB development and testing. It supports USB 2.0. It is designed to record USB traffic and graphically present the logical transactions and events. It connects to a laptop or desktop host machine via USB 2.0.
1.11 Mercury T2P The Teledyne LeCroy Mercury T2P™ USB 2.0 and Power Delivery Protocol Analyzer is a verification system for USB development and testing. It supports USB 2.0, Power Delivery, Type-C, and Side Band traffic for Thunderbolt 3, USB4, or Display Port Aux channel packets. It is designed to record USB traffic and graphically present the logical transactions, events, and Power Usage.
Overview Mercury T2P Figure 1.16: Mercury T2P The system can monitor traffic between USB 2.0 links using standard high-speed compliant Type-C cables and adapters. The total length of the cables between the Host Under Test and the Device Under Test should be kept to less than 4 feet.
It supports USB 2.0. It is designed to record USB traffic and graphically present the logical transactions and events. It connects to a laptop or desktop host machine via USB 2.0. The Mercury T2 is powered by the USB cable, so no additional power cord is needed.
To use these older analyzers, you will have to uninstall the newer software and install an older release from the Teledyne LeCroy website. Earlier versions of the software include the documentation related to these units in their respective User Manuals.
Chapter 2 General Description This chapter describes the general features of Teledyne LeCroy USB protocol analyzers and the requirements for their use. 2.1 Voyager M4x Analyzer 2.1.1 System Components and Packing List The Teledyne LeCroy Voyager M4x analyzer package includes the following: Voyager M4x protocol analyzer/exerciser system ...
General Description Voyager M4x Analyzer Figure 2.2: Voyager M4x Analyzer Rear 2.1.3.1 M4x Features The features of the analyzer are listed in the following table. Table 2.1: M4x Analyzer Features (Sheet 1 of 2) Feature Function Front Panel Power LED Green: If plugged in and powered on ...
Page 48
AC IN 100-250V AC, 250 Watts. Power Switch (0/1) Off/On WARNING: Do not open the Voyager M4x enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy Customer Care. USB Protocol Suite User Manual, January 2025...
General Description Voyager M4x Analyzer 2.1.4 Specifications The analyzer specifications are shown in Table 2.2, below. Table 2.2: Voyager M4x Analyzer Specification Tool/Utility Specification Power Requirements 100-250V AC, 225 Watts Environmental Conditions Operating Temperature 0 to 50 °C (32 to 122 °F) ...
NOTE: Analysis of traffic requires the use of short, low-loss, high quality cables. The cables provided by Teledyne LeCroy, which have the Teledyne LeCroy label on them, have been verified to provide excellent signal quality. Using other cables may compromise the signal quality and prevent capturing of clean traffic.
General Description Voyager M310e Analyzer 2.2.3.1 M310e Features The features of the analyzer are listed in the following table. Table 2.3: M310e Analyzer Features (Sheet 1 of 2) Feature Function Front Panel Power LED Green if plugged in and powered on Status LED Blue if system successfully initializes ...
Page 52
Time Statistics (RTS) is running. USB 3.2 LEDs always operate, unless USB 3.2 has been disabled in the Recording Options General Tab. WARNING: Do not open the Voyager M310e enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy Customer Care. USB Protocol Suite User Manual, January 2025...
General Description Voyager M310e Analyzer 2.2.4 Specifications The analyzer specifications are shown in Table 2.4. below. Table 2.4: Voyager M310e Analyzer Specification Tool/Utility Specification Power Requirements 24V DC, 6.67 Amps Environmental Conditions Operating Temperature 0 to 50 °C (32 to 122 °F) ...
NOTE: Analysis of USB SS+ (10Gbps) traffic requires the use of short, low-loss, high quality cables. The cables provided by Teledyne LeCroy, which have the Teledyne LeCroy label on them, have been verified to provide excellent signal quality. Using other cables may compromise the signal quality and prevent capturing of clean traffic.
General Description Voyager M310P Analyzer Quick Start Guide 2.3.2 Host Machine Requirements Refer to the USBProtocolSuite_Readme.html file from the software installation site for the current host machine and operating system requirements. 2.3.3 Analyzer The analyzer is shown in the figures below. Figure 2.6: Voyager M310P Analyzer Front Figure 2.7: Voyager M310P Analyzer Rear 2.3.3.1 M310P Features...
Page 56
General Description Voyager M310P Analyzer Table 2.5: M310P Analyzer Features (Sheet 2 of 3) Feature Function Solid Green Plug is correctly oriented Solid Yellow Special Condition Additional LEDs Generating Green if generating enabled Recording Green if 3.2 recording enabled in Analyzer mode Trig Yellow when triggered ...
USB 3.2 has been disabled in the Recording Options General Tab. WARNING: Do not open the Voyager M310P enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy customer care. 2.3.4 Specifications The analyzer has the following specifications. Table 2.6: Voyager M310P Analyzer Specification...
General Description Voyager M310P Analyzer Table 2.6: Voyager M310P Analyzer Specification Tool/Utility Specification Connection SuperSpeed Plus USB Type-C connectors—The Voy- ager SuperSpeed (3.2) analyzer and exerciser port differ- ential input impedance is between 80 and 120 ohms. USB 3.2 USB Type-C connector cables ...
NOTE: Analysis of USB SS+ (10Gbps) traffic requires the use of short, low-loss, high quality cables. The cables provided by Teledyne LeCroy, which have the Teledyne LeCroy label on them, have been verified to provide excellent signal quality. Using other cables may compromise the signal quality and prevent capturing of clean traffic.
General Description Voyager M310C Analyzer 2.0: C-B, C-uB Quick Start Guide 2.4.2 Host Machine Requirements Refer to the USBProtocolSuite_Readme.html file from the software installation site for the current host machine and operating system requirements. 2.4.3 Analyzer The analyzer is shown in figures 2.9 and 2.10.
General Description Voyager M310C Analyzer 2.4.3.1 M310C Features The features of the analyzer are listed in the following table. Table 2.7: M310C Analyzer Features (Sheet 1 of 2) Feature Function Front Panel Power LED Green if plugged in and powered on Status LED Blue if system successfully initializes ...
Page 62
USB 3.2 has been disabled in the Recording Options General tab. WARNING: Do not open the Voyager M310C enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy Customer Care. USB Protocol Suite User Manual, January 2025...
Note that the connection can be reversed (Host on Left, Device on Right), but it is preferred to connect as indicated so that the default setup is similar to Teledyne LeCroy’s previous 10 USB analyzers, which used an “A” connector on left and a “B” connector on the right. This makes the traces easier to understand and support by the Support Team, and reduces the number of setup diagrams to follow.
NOTE: Analysis of USB SS+ (10Gbps) traffic requires the use of short, low-loss, high quality cables. The cables provided by Teledyne LeCroy, which have the Teledyne LeCroy label on them, have been verified to provide excellent signal quality. Using other cables may compromise the signal quality and prevent capturing of clean traffic.
General Description Voyager M310 Analyzer 2.5.2 Host Machine Requirements Refer to the USBProtocolSuite_Readme.html file from the software installation site for the current host machine and operating system requirements. 2.5.3 Analyzer The analyzer is shown in figures 2.12 and 2.13, below. Figure 2.12: Voyager M310 Analyzer Front Figure 2.13: Voyager M310 Analyzer Rear 2.5.3.1 M310 Features...
Page 66
General Description Voyager M310 Analyzer Table 2.9: M310 Analyzer Features (Sheet 2 of 3) Features Function Recording Green if 3.2 recording enabled in Analyzer mode Trig Yellow when triggered USB 2.0 Solid Yellow FS SOFs, LS EOPs, or control endpoint traffic Slow Flashing Yellow LS Traffic on endpoints other than 0 (resets activity timer as in 3.2)
Page 67
Time Statistics (RTS) is running. USB 3.2 LEDs always operate, unless USB 3.2 has been disabled in the Recording Options General Tab. WARNING: Do not open the Voyager M310 enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy customer care. USB Protocol Suite User Manual, January 2025...
8 GB or 16 GB for traffic data capture, timing, state and other data 2.6 Voyager M3x Analyzer 2.6.1 System Components and Packing List The Teledyne LeCroy Voyager M3x analyzer package includes the following: Voyager M3x analyzer/exerciser system AC power cable ...
General Description Voyager M3x Analyzer 2.6.2 Host Machine Requirements Refer to the USBProtocolSuite_Readme.html file from the software installation site for the current host machine and operating system requirements. 2.6.3 Analyzer The analyzer is shown in the figures 2.14 and 2.15, below. Figure 2.14: Voyager M3x Analyzer Front Figure 2.15: Voyager M3x Analyzer Rear 2.6.3.1 M3x Features...
Page 70
General Description Voyager M3x Analyzer Table 2.11: M3x Analyzer Features (Sheet 2 of 2) Feature Function Solid Yellow FS SOFs, LS EOPs, or control endpoint traffic Slow Flashing Yellow LS Traffic on endpoints other than 0 (resets activity timer as in 3.2) Fast Flashing Yellow FS Traffic on endpoints other than 0 (resets activity timer as in 3.2)
2.7 Advisor T3 The Teledyne LeCroy USB Advisor T3™ USB 3.2 protocol analyzer is a verification system for USB development and testing. It supports both USB 2.0 and USB 3.2. It can record USB traffic and graphically present the logical transactions and events. It connects to a laptop or desktop host machine via USB 2.0.
If configured for USB 3.2 testing, the system supports monitoring between SuperSpeed links using USB 3.2 cables. 2.7.1 Components The Teledyne LeCroy Advisor T3 analyzer package includes the following: One Teledyne LeCroy USB Advisor T3 analyzer DC power adapter ...
General Description Advisor T3 2.7.3 Rear Panel Figure 2.17: Advisor T3 Rear Panel Table 2.14: Advisor T3 Rear Panel (Sheet 1 of 2) Indicator/Connector Description Type B connector for connection to host machine Sync/Data Sync Only Cable Micro DB-25 to Micro DB-25 external interface cable for ...
(0/1) Power Switch WARNING: Do not open the enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy customer care. 2.7.4 Specifications Specifications for the Advisor T3 are shown in the table below. Table 2.15: Advisor T3 Specification...
General Description Advisor T3 Table 2.15: Advisor T3 Specification (Sheet 2 of 2) Tool/Utility Specification Probing Characteristics Connection SuperSpeed connectors: The Voyager SuperSpeed (3.2) ana- lyzer and exerciser port differential input impedance is between 80 and 120 ohms. USB 3.2 SS cables ...
USB 2.0. The Mercury T2C is powered by the USB Type-C cable, so no additional power cord is needed. 2.8.1 Components The Teledyne LeCroy Mercury T2C analyzer package includes the following: One Teledyne LeCroy USB Mercury T2C analyzer ...
General Description Mercury T2C The front panel has the following indicators and connectors: Table 2.16: Mercury T2C Front Panel Indicator/Connector Description Connector 1 LED Green – Good Red – Flip it over! Solid Yellow – Special Condition. Connects to Device under test (UFP) Analyzer Connector 1 (downstream)
MegOhms. Pulse Voltage = 2.7 Volts into 50 Ohms. Pulse is positive going. WARNING: Do not open the enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy Customer Care. 2.8.4 Specifications The analyzer has the following specifications. Table 2.18: Mercury T2C Analyzer Specification...
General Description Mercury T2C Table 2.18: Mercury T2C Analyzer Specification Tool/Utility Specification Probing Characteristics Connection USB 2.0 USB Type-C™ connector cables High Speed USB Connectors Standard cables Power On/Off Switches 256 MB for traffic data capture, timing, state and other Recording Memory Size data 2.8.5 Mercury T2C System Setup...
USB 2.0. The Mercury T2P is powered by the USB Type-C cable, so no additional power cord is needed. 2.9.1 Components The Teledyne LeCroy Mercury T2P analyzer package includes the following: One Teledyne LeCroy USB Mercury T2P analyzer ...
General Description Mercury T2P The front panel has the following indicators and connectors: Table 2.19: Mercury T2P Front Panel Indicator/Connector Description Green – Good Connector 1 LED Red – Flip it over! Solid Yellow – Special Condition Connects to Device under test (UFP) Analyzer Connector 1 (downstream)
MegOhms. Pulse Voltage = 2.7 Volts into 50 Ohms. Pulse is positive going WARNING: Do not open the enclosure. No operator serviceable parts are inside. Refer servicing to Teledyne LeCroy Customer Care. 2.9.4 Specifications The analyzer has the following specifications. Table 2.21: Mercury T2P PD Analyzer Specification...
General Description Mercury T2P Table 2.21: Mercury T2P PD Analyzer Specification Tool/Utility Specification Connection USB 2.0 USB Type-CTM connector cables High Speed USB Connectors Standard cables Recording Memory Size 512 MB for traffic data capture, timing, state and other data.
It supports USB 2.0. It is designed to record USB traffic and graphically present the logical transactions and events. It connects to a laptop or desktop host machine via USB 2.0. The Mercury T2 is powered by the USB cable, so no additional power cord is needed.
General Description Mercury T2 Table 2.22: Mercury T2 Front Panel Indicator/Connector Description Connects to Device under test Analyzer Port A (downstream) Connects to Host under test Analyzer Port B (upstream) Analyzer LEDs Recording (red if recording enabled Trig Trigger (green if triggering) ...
Power On/Off Recording Memory Size 256 MB for traffic data capture, timing, state, and other data. 2.10.5 Mercury T2 System Setup Mercury T2 is configured and controlled through a host machine USB port. USB Protocol Suite User Manual, January 2025...
General Description Yellow LED Connector Indications Figure 2.29: Mercury T2 Setup 2.11 Yellow LED Connector Indications 2.11.1 M310P/M310e /M4x If one connector shows a Yellow LED: The orientation is indeterminate. This may occur when the “V thru” cable (926762-00 or CONN 930705-00) is used, as the analyzer will detect both Rp/Rp or Rd/Rd on the two CC pins.
General Description Yellow LED Connector Indications 3. The orientation on both connectors is indeterminate. This may occur when two pass-through cables are used, which is not a valid configuration. 2.11.2 M310C, Mercury T2C, Mercury T2P If one connector shows a Yellow LED: The orientation is indeterminate.
You’ll need to register as a user the first time you access the site. 3.1.2 Windows Server 2016/2019 If you are using Windows Server 2016/2019, the Teledyne LeCroy USB Protocol Suite Software needs to be added to the firewall exceptions to ensure that the application can find the analyzers over your Ethernet network.
Page 90
Installation Installing the Analyzer Software on the Host Machine Figure 3.1: Allowed Apps and Features Window 4. Click Allow another app. The Add an app window opens (Figure 3.2). Figure 3.2: Add an App Window 5. Enter the path for the USB Protocol Suite or click Browse to locate the application file.
Installation Installing the Analyzer Software on the Host Machine The default installation location for the Teledyne LeCroy USB Protocol Suite is C:\Program Files\LeCroy\USB Protocol Suite. 6. Select the USB Protocol Suite executable (.exe extension) and click Open. The application is added to “Allowed apps and features”...
8. If necessary, select USB Protocol Suite\UsbSuite.exe, then click Add. The Teledyne LeCroy USB Protocol Suite is added to the Apps allowed through the firewall. 9. After the Application has been added, you can see it in the Allow apps to communicate through Windows Firewall screen.
At power-on, the analyzer initializes itself in approximately ten seconds and performs a self-diagnostic that can last a few minutes. If the diagnostics fail, contact Teledyne LeCroy Customer Support for assistance. 4. When Add New Hardware Wizard opens on the host machine, click Next.
Installation Setting Up the Analyzer: Ethernet Connection TCP Ports: 3999 – 4003 UDP Ports: 4018 – 4020 NOTE: If your PC and the analyzer are not on the same subnet, you might have to set appropriate subnet and gateway settings. Also, it is best if TCP ports 4000 to 4003 and UDP ports 4018 to 4020 are available on the network, but even if they are not you might be able to force a connection by selecting the “Force add/connect attempt”...
Page 95
Installation Setting Up the Analyzer: Ethernet Connection Figure 3.5: Pv4: Properties 4. Highlight Internet Protocol Version 4 (TCP/IPv4), then click Properties. The dialog box for TCP/IPv4 properties opens (Figure 3.6). USB Protocol Suite User Manual, January 2025...
Page 96
Installation Setting Up the Analyzer: Ethernet Connection Typical Static IP Settings Figure 3.6: Setting Static IP Address 5. Enter your local static IP settings in the appropriate fields, then click OK. These are the settings that will be used by the host computer. 6.
Installation Setting Up the Analyzer: Ethernet Connection Static IP Address Figure 3.7: Command Prompt Window for ipconfig 3.4.1.2 Setting a Static IP Address on Your USB analyzer 1. Connect your PC to the analyzer with a USB cable. 2. Power on your analyzer (with the USB cable attached). 3.
Page 98
Installation Setting Up the Analyzer: Ethernet Connection Figure 3.8: Command Prompt Window for ipconfig 4. Select All Connected Devices. The analyzer Devices window opens and shows the connected USB analyzer and its status (Figure 3.9). Figure 3.9: All Connected Devices: analyzer Selected 5.
Installation Setting Up the Analyzer: Ethernet Connection Figure 3.10: Setting Static IP Address for analyzer 6. Click Apply. A confirmation message appears telling you that the new IP Settings have been applied. 3.4.1.3 Ethernet Direct Connection 1. Ensure the USB cable is NOT attached the USB analyzer, then attach an Ethernet cable from the host PC to the analyzer.
Page 100
Installation Setting Up the Analyzer: Ethernet Connection Figure 3.11: USB analyzer with New IP Address Connected Over an Ethernet Bus The USB analyzer Devices window shows the analyzer has been connected. 5. Close the window and begin recording (Figure 3.12). Figure 3.12: analyzer Connected to Host PC over Ethernet Bus USB Protocol Suite User Manual, January 2025...
2. Turn on the power switch. NOTE: At power-on, the analyzer initializes itself in approximately ten seconds and performs a self-diagnostic that can last a few minutes. If the diagnostics fail, call Teledyne LeCroy. 3. Complete analyzer setup described in 3.6 Application Startup.
In cases of CATC-Syncing with USB analyzers capturing 3.2 traffic, all boxes will have the correct synchronized timestamps. 3.5.2 Removing Expansion Cards You can remove expansion cards using two tools: Standard (flat blade) 3/16” screwdriver Teledyne LeCroy Extraction Tool (part number 230-0160-00) USB Protocol Suite User Manual, January 2025...
Page 103
Installation Cascading with CATC SYNC Expansion Card Figure 3.13: Required Tools for Removing Expansion Card To remove an expansion card, follow these steps: 1. Unplug the system from AC power and turn the system so the expansion port is facing you. Note the two retaining screws and the holes for the extraction tool (Figure 3.14),...
Page 104
Installation Cascading with CATC SYNC Expansion Card Figure 3.15: Insert Extraction Tool 3. Rotate the extraction tool to a horizontal position (Figure 3.16) to lock the prongs into place and make a handle. Figure 3.16: Rotate Extraction Tool 4. Using the screwdriver, turn both retaining screws counter-clockwise approximately two full turns, until you feel a slight resistance (Figure 3.17).
Installation Application Startup 5. Using the extraction tool as a handle, gently wriggle the expansion card forward about 1/8”. Figure 3.18: Gently Wriggle Handle Forward 6. Repeat steps 4 and 5 approximately three times, until the card is free from the retaining screws and you can remove the card from the system.
Installation Application Startup Figure 3.20: Main Window You can use the software with or without the system connected to the host machine. Without the analyzer, the program functions as a trace viewer to view, analyze, and print trace files. 3.6.1 Confirm Proper Hardware Installation & USB or Ethernet Connection 3.6.1.1 USB Connection To confirm proper installation and USB connection:...
Installation Application Startup 3.6.1.2 Ethernet Connection (Voyager only) For Ethernet connection, after you open the USB Protocol Suite application, confirm proper installation and Ethernet connection using the analyzer Devices and the About windows. 3.6.2 Analyzer Devices 1. To show the available analyzer Devices, select Setup > All Connected Devices. The Analyzer Devices window appears (Figure 3.21).
Installation Application Startup IP Settings to use a DHCP or Static IP address 3. To refresh the list of devices, click Refresh Device List. 4. Before starting a recording, select the analyzer you want to use. 3.6.3 IP Settings (Voyager only) If connected to a device, you can change the IP settings: DHCP automatically assigns an IP address.
Page 109
Installation Application Startup Figure 3.23: Device IP Settings Dialog Box Two radio buttons are available: Obtain IP address automatically (DHCP) [default] Use the following IP Address (Static IP) 3. To change to Static IP, click the Static IP radio button, then: a.
Installation Application Startup 4. Click Apply. A success message appears and you are returned to the analyzer Devices window. 5. Click Close to close the window and use the device with a Static IP address. 3.6.4 Signal Parameters The methods and interfaces for setting signal parameters vary based on the particular analyzer you’re using.
Page 111
Installation Application Startup DC Gain Values: From 0.0 dB to 6.0 dB in 0.2 dB increments SigDet Values: From 30 mV to 410 mV in varying increments To Right Connector CTLE Values: From 0.0 dB to 6.0 dB in 0.2 dB increments ...
Page 112
Installation Application Startup Figure 3.27: M4x Initial Test Signal Settings You can also Save and Apply, Reset, or Save the set of Rx Equalizer Settings values you have chosen. If you have more than one set of values you can Add that set or Delete it as well.
Page 113
Installation Application Startup To Right Connector and To Left Connector settings are designated to tune settings for pass-through the path (between two DUTs), highlighted purple in Figure 3.28. If the link between DUTs is getting broken by putting the M4x analyzer in the middle of traffic, you need to adjust these parameters to create a successful link between the DUTs attached to both sides of analyzer.
Installation Application Startup Figure 3.29: Add and Save and Apply Buttons in Equalization Settings Dialog 3.6.4.2 Using .csv Files (USB 3.2) You can add, remove, edit, load (from a comma-delimited .csv file), or save (as a comma-delimited .csv file) USB 3.2 devices and to calibrate USB 3.2 connections: 1.
Page 115
Installation Application Startup Figure 3.30: Signal Parameters 2. Select the USB 3.2 device you want to modify and/or for which to calibrate USB 3.2 connections. The Host Signal Profiles window appears for the selected device (Figure 3.31). USB Protocol Suite User Manual, January 2025...
Page 116
Installation Application Startup Figure 3.31: USB 3.2 Analyzer Host Signal Profiles Window 3. Choose Load Profiles, then select the .csv file for the profile you want to use. USB Protocol Suite User Manual, January 2025...
Installation Application Startup 3.6.4.3 Voyager M310 and M310C 1. To edit the Host Signal Parameters Profile of a specific profile entry, double click on the entry. The Host Signal Parameters Profile window appears (Figure 3.32). Figure 3.32: Example Host Signal Parameters Profile for Voyager M310 and M310C This window allows you to do the following: Read from [analyzer] ...
Page 118
Installation Application Startup Device Name Device Cable ID Host Name Host Cable ID Transmit Parameters Amplitude (0 to 1260mv) Pre-Tap (-15 to +15) Post 1st-Tap (0 to 31) Post 2nd-Tap (-15 to 15) ...
Installation Application Startup 3.6.4.4 Voyager M3x 1. To edit the Host Signal Parameters of a specific Profile entry, double click the entry. The Host Signal Parameters Profile window opens (Figure 3.33). Figure 3.33: USB 3.2 Device analyzer Host Signal Parameters Profile for M3x Read from [analyzer] ...
Installation Application Startup RX DC Gain in db (0, 3, 6, 9, 12) EQ Control in db (0 to 16) 2. You can also Load the default settings or Load the last applied settings. 3.6.4.5 Voyager M310P To edit the Host Signal Parameters Profile of a specific entry, double click on the entry.
Page 121
Installation Application Startup EQ Control (0 - 15 db) DFE Settings Mode: Auto, Off, Manual, Triggered Adaptation, Continuous Adaptation If in Manual Mode you can set the different tap values: Tap 1 0 to 15 db ...
Installation Application Startup 3.6.4.6 Voyager M310e To edit the Host Signal Parameters Profile of a specific profile, double click on the entry. The Host Signal Parameters Profile window appears (Figure 3.35). Figure 3.35: USB 3.2 Device analyzer Host Signal Parameters Profile Dialog M310e Use this window to: Read from [analyzer] ...
Installation Application Startup If in Manual Mode you can set the different tap values: Tap 1 0 to 15 db Tap 2 -7 to 7 db Tap 3 -7 to 7 db Tap 4 -7 to 7 db ...
Page 124
Installation Application Startup Figure 3.36: Advisor T3: Warning Message 2. To set the Recording Options to Always presented, Open the USB Protocol Suite and select Recording Options. a. Select General > Advisor T3. b. Select the USB 3.2 tab. c. Click the Always presented radio button (Figure 3.37).
Page 125
Installation Application Startup This allows you to bring up the Host Signal Profiles for the Advisor T3 (Figure 3.38). Figure 3.38: Host Signal Profiles: Advisor T3 4. Double click on an existing profile to update its parameters (Figure 3.39). USB Protocol Suite User Manual, January 2025...
Page 126
Installation Application Startup Figure 3.39: Host Signal Profiles: Advisor T3 From this window, you can: Read from analyzer and Apply to analyzer Enter Device to analyzer Signal Settings and Host to analyzer Signal Set- tings: Device Name Device Cable ID ...
Installation Your First USB Recording Input Signal Equalization (ISE) Settings short time constant: Maximum, Moderate, Minimum, Off or Cur- rent medium time constant: Maximum, Moderate, Minimum, Off or Current long time constant: Maximum, Moderate, Minimum, Off or Cur- ...
Page 128
Installation Your First USB Recording 3. Select the General tab to display a window showing factory default settings, such as Snapshot and 4 MB buffer size (Figure 3.40). For the first recording, you can leave these settings unchanged. Under Recording Channels, select 2.0 to record USB 2.0 traffic. ...
Installation Your First USB Recording 9. When the recording session finishes, the traffic uploads from the analyzer to the hard drive on your host machine as a file named data.usb or the name you assigned as the default filename. While the file is uploading, you should see a brown progress bar at the bottom of the screen.
Installation Trace File Structure Figure 3.41: Trace View Display You can start the application from the Desktop or from the installed directory. The display software can operate independently of the analyzer. When used without the analyzer, the program functions in a Trace Viewer mode to view, analyze, and print captured protocol traffic.
Installation Notes on Windows Sleep and Hibernation Features If the additional files ever become out of date (newer software structures from a new release, etc.) or if any of the files are lost or damaged, the software will rebuild a fresh version of the information.
Page 132
Installation Connecting EPR Mode-Enabled Devices to Analyzer Ports Figure 3.42: Breaking the EPR Link in analyzer Platforms without EPR Mode NOTE: For EPR testing, consider the Voyager M310e. It provides full support of PD 3.1 and the expanded voltage range, up to 51 V. WARNING: Any downgrade of software to a version lower than 8.60 is not recommended.
Chapter 4 Software Overview The USB Protocol Suite application can function with or without the analyzer. When used without an analyzer, the program functions in a Trace Viewer mode to view, analyze, and print captured protocol traffic. When used with the analyzer attached to the host machine, you can monitor and analyze the activity of your USB branch from USB ports on the analyzer front.
Page 134
Software Overview USB Protocol Suite Menus Table 4.1: File Menu Options & Functions (Sheet 1 of 2) Option Function New .utg file. Creates a new, empty traffic generation file. Available only if a trace file (.usb) is open. To edit a .utg file, click Edit as Text in the toolbar. Open Opens a file.
Software Overview USB Protocol Suite Menus Table 4.1: File Menu Options & Functions (Sheet 2 of 2) Option Function Data Exports Transfer data as a text or binary file. Merge Trace Files Merges two simultaneously recorded files into a single file. (This command does not work if the files were recorded at different times).
Software Overview USB Protocol Suite Menus Table 4.2: Setup Menu Options & Functions (Sheet 2 of 2) Option Function Update Device Updates the BusEngine™ and Firmware manually. See 13.3.4 Manual Updates to Firmware, BusEngine, and Serdes BusEngine. Launch CrossSync Opens the CrossSync multiple-analyzer traffic synchronization software Control Panel (see 4.12.4 CrossSync Control...
Software Overview USB Protocol Suite Menus 4.2.2.1 Record Menu Figure 4.4: Record Menu Table 4.4: Record Menu Options & Functions Option Function (See 4.10.2 Recording Status.) Start Causes the analyzer to begin recording USB activity. Stop Causes the analyzer to stop recording. Disconnect See V Disconnect under...
Software Overview USB Protocol Suite Menus 4.2.3 Report Menu Figure 4.5: Report Menu Options Table 4.5: Report Menu Options & Functions (Sheet 1 of 2) Option Function File Information Displays information about the recording, such as the number of pack- ets and triggering setup.
Software Overview USB Protocol Suite Menus Table 4.5: Report Menu Options & Functions (Sheet 2 of 2) Option Function Spec View Shows packet header information and other items, in a view that matches the USB 3.2 specification. See 10.12 Spec View.
Page 140
Software Overview USB Protocol Suite Menus Table 4.6: Search Menu Functions & Options Option Function (See Chapter 7, Searching Traces.) Go to Trigger Positions the display to show the first packet that follows the trigger event. Go to Selected Positions the display to show the selected packet. packet Go to Packet/ Positions the display to the packet/transaction/transfer number...
Software Overview USB Protocol Suite Menus 4.2.5 View Menu Top Half Bottom Half Figure 4.7: View Menu Table 4.7: View Menu Options & Functions (Sheet 1 of 3) Option Function Toolbars Displays list of available toolbars. See 4.9.1 Resetting the Toolbar.
Page 142
Software Overview USB Protocol Suite Menus Table 4.7: View Menu Options & Functions (Sheet 2 of 3) Option Function USB3 Electrical Test Mode Initiate Loopback Mode and send Pings from the Exerciser. Note: This functionality is unsupported and for informational use only. There is no guarantee that it will work correctly Trace Views Displays CATC Trace, Compressed CATC Trace, Spreadsheet (Color), or...
Software Overview USB Protocol Suite Menus Packets 9060 to 9065 are not displayed Figure 4.10: Hide Update: FC Traffic 4.2.5.2 Hide/Show Tunneled USB3 traffic You can Show or Hide different types of Tunneled USB3 traffic. One of the options is to Show or Hide LFPS Packets as shown in figures 4.11, 4.12 and 4.13.
Software Overview USB Protocol Suite Menus LFPS Packets Hidden Packet 1 – 9 Hidden Figure 4.13: Trace with LFPS Packets Hidden 4.2.6 Window Menu Figure 4.14: Window Menu USB Protocol Suite User Manual, January 2025...
Option Function Tell Teledyne LeCroy Report a problem to Teledyne LeCroy Support via e-mail. This requires that an e-mail client be installed and configured on the host machine. Guide to Manuals Invokes a web page which guides you to the correct documentation for the analyzer you are using.
Check for Updates Use the Internet to analyze your system for licensed updates. You can set the system to automatically check for updates at application startup in the Teledyne LeCroy USB Protocol Suite Software Update window. 13.2 Software Updates. Shortcut List Displays the Shortcuts List of navigation, common, search, decode lev- els, and miscellaneous mouse and keyboard shortcuts.
Software Overview Exports to .CSV 4.3.2 Export Transactions to .CSV When viewing 2.0 Packets in either the CATC Trace view or the CATC Trace Compressed view, selecting Export > Transactions to .CSV exports the 2.0 transactions to a .csv file in a pre- configured format.
Software Overview Exports to .CSV Figure 4.17: Save to New File 4. On the new file, you can now click File > Export and select Packets to USB 2.0 Host Traffic Generator Text File (.utg)... The following dialog appears: If the captured file was Hi Speed and was recorded in Auto-Speed Detect mode, you must add a chirp = here statement before the first SOF packets in the .utg file.
Page 152
Software Overview Exports to .CSV Figure 4.18: Export to Generator Text 1. Accept all default selections—unless you have good reason not to do so. This will create the simplest, fastest file: Frame Numbering: Letting the frame numbers be generated by the hard- ...
Page 153
Software Overview Exports to .CSV Figure 4.19: USB4 Traffic with Tunneled PCIe Traffic: Shown in CrossSync Tool 2. To ensure the traces are time synchronized, select the Traces synced icon in the CrossSync Toolbar (Figure 4.20). Figure 4.20: Select Traces Synced from Toolbar The Trace with USB4 tunneled PCIe traffic will be time synchronized with the Exported trace with PCIe traffic.
Software Overview Exports to .CSV 4.3.6 Export USB4 Tunneled USB Traffic to USB 3.2 Native Trace If you load a USB4 trace with “Tunneled” USB3.2 traffic, you can Export only the USB 3.2 tunneled traffic to a new trace. Figure 4.22 (below) shows two traces.
Page 155
Software Overview Exports to .CSV Figure 4.23: Export USB4 Tunneled DP Traffic to DP Native Trace 1. Select the Export > USB4 Tunneled DP Traffic to DP Native Trace File. A window pops up showing the path to the exported trace file. Figure 4.24: Enter a Trace File Name 2.
Page 156
Software Overview Exports to .CSV 3. Click Save to store the newly name DP Trace file. You now have the ability to open the DP Trace file using the quantumdata ATP Manager. NOTE: This tool must be downloaded and installed separately. See Figure 4.25.
Page 157
Software Overview Exports to .CSV Figure 4.26: Select File to Import 3. Select Open. The quantumdata Import Tunneled DP Trace dialog box appears (Figure 4.27). Figure 4.27: quantumdata Import Tunneled DP Trace Dialog Box 4. Click OK. The quantumdata USB4 DP Import Status window displays the Processing Events as the trace is imported (Figure 4.28).
Software Overview Recording Bus Data Figure 4.28: quantumdata USB4 DP Import Status Window When the Trace Import has finished, the DP Capture Viewer pops up as shown in Figure 4.29 below. Figure 4.29: quantumdata DP Capture Viewer For more details about quantumdata products click on the following link: https://www.quantumdata.com 4.4 Recording Bus Data To start recording USB traffic once the appropriate Recording Options have been set, perform...
Software Overview Merging Trace Files 1. Select Start under Record on the Menu Bar, or click on the toolbar. Your recording session will continue until it has finished naturally. 2. To stop manually, click on the toolbar, or select Stop under Record on the Menu Bar.
Software Overview Toolbar Figure 4.30: Select First File for Merging Dialog NOTE: Merge Trace Files can be run with or without a trace file open on the screen. The merge process ignores the open file. 2. Select the first trace file to be merged, then click Save. NOTE: It does not matter which of the two trace files is first selected so long as both were recorded in the same session.
Software Overview Toolbar Button Description Button Description Link Tracker Bus Utilization 10.9 Link Tracker. 10.8 Bus Utilization. Open the Navigator Bar Spec View 10.10 Using the Navigator. 10.12 Spec View. Decoded Fields View Detail View 9.3.8 Decoded Fields View. 10.11 Detail View.
Software Overview Toolbar 4.6.10.1 PCIe Tunneling If you load a USB4 trace with PCIe tunneled traffic (Figure 4.32) and select “Tunneled PCIe” from the drop down menu, you can quickly export the PCIe tunneled traffic to a new PCIe trace. Figure 4.32: USB Trace with PCIe Tunneled Traffic When you perform a Quick Export, an information message about using the CrossSync Control Panel appears.
Page 165
Software Overview Toolbar Figure 4.33: Using the CrossSync Control Panel Message After exporting the tunneled PCIe traffic, the new exported trace will be named as [original_trace_name]_PCIe_Export. This trace is located in same folder as original trace and opened automatically by the PCIe Protocol Analysis software after the export completes. See Figure 4.34, below.
Software Overview Toolbar 4.6.10.2 Tunneled USB3 traffic If you load a USB4 trace with USB3 tunneled traffic as shown in the figure below (Figure 4.35) you can quickly export the Tunneled USB3 traffic by selecting the “Tunneled USB3” drop down tab. Figure 4.35: Original USB4 Trace with Tunneled USB3 Traffic Before Export After exporting the tunneled USB3 traffic, the new exported trace will be named as .
Software Overview Toolbar Figure 4.36: Exported USB3 Traffic 4.6.10.3 DP Tunneling If you load a USB4 trace with Tunneled DP traffic (see Figure 4.37) and you select “Tunneled DP” from the drop down tab you can quickly export the DP tunneled traffic to a new trace.
Software Overview Toolbar Figure 4.37: USB4 Trace with Tunneled DP Traffic To open the trace after Exporting Tunneled DP traffic, see 4.3.7 Export USB4 Tunneled DP Traffic to DP Native Trace. 4.6.11 Hide Traffic Toolbar The Hide toolbar allows you to selectively hide data traffic you do not wish to see (Figure 4.38).
Software Overview Toolbar 4.6.11.4 Hide All Power Delivery Traffic Click the button to hide all Power Delivery Traffic. 4.6.11.5 Hide Configuration Channel Traffic Click the button to hide all the Configuration Channel (CC) Traffic. 4.6.11.6 Hide All DisplayPort Traffic Click on the button to hide all Display Port Traffic.
Software Overview Toolbar 4.6.11.13 Hide SOF Packets (2.0) You can hide Start-of-Frame (SOF) packets that may be uninteresting in a given context from a Trace View by clicking the Hide SOF Packets button on the toolbar: Click to show/hide all SOF packets. NOTE: This also hides low-speed EOPs.
Software Overview Toolbar 4.6.11.21 Hide USB4 HS Ordered Sets Click the icon to hide USB4 HS Ordered Sets. 4.6.11.22 Hide USB4 HS Training Sequences Click the icon to hide different types of USB4 HS Training Sequences. 4.6.11.23 Hide USB4 HS Transport Layer Packets Click the icon to hide different types of USB4 HS TLPs.
Page 172
Software Overview Toolbar Figure 4.39: Right-clicking on the Stream Id field of a USB 3.2 Data Packet 1. To display the Hide Packets dialog box (Figure 4.40), right-click on the Stream ID field of a USB 3.2 Data Packet and select Hide all Trans except StreamID Numbers..
Software Overview Tooltips 4.6.11.29 Show/Hide Packets: SuperSpeed+ PHY Transaction With SuperSpeed+, PHY Transactions are made up of pulse width modulated LFSR signals. By selecting the PHY Transaction level, these are displayed as SCDx, PHY Capability and PHY Ready LBPM Messages. This eliminates showing large numbers of LFSRs and electrical Idle periods which would need to be interpreted as portions of these messages.
Software Overview Status Bar 1. Select View > toolbars from the menu bar. 2. Select Customize from the submenu to display the Customize dialog box. Figure 4.42: Customize Dialog 3. Select the Toolbars tab to display the Toolbars page of the Customize dialog box (see the following figure).
Software Overview Status Bar Depending on the current activity, the right side of the bar has segments that indicate the status, size, activity, and buffer. The left side of the bar has segments that indicate port and link status. 4.10.1 Recording Progress When you begin recording, the Status Bar displays an indicator.
Page 176
Software Overview Status Bar Figure 4.44: Status Bar – Waiting For Trigger The status bar displays Uploading when recording is complete and is being uploaded. Figure 4.45: Status Bar – Uploading The status bar displays Rec/Uploading when recording and uploading is done simultaneously. Figure 4.46: Status Bar –...
Software Overview Status Bar Figure 4.48: Partial Upload Options Dialog When the data is saved, the Recorded Data file appears in the main display window, and the Recording Status window clears. If the recording resulted from a Trigger Event, the first packet following the ...
If the cable is inserted incorrectly, unplug it, turn it over and reconnect it. The status of the LEDs is mimicked by the Teledyne LeCroy USB Protocol Suite software display, in the status field at the bottom of the display as shown in Figure 4.50, below.
Status Bar (Figure 4.51) at the bottom of the Main Menu. NOTE: This window is not available when using Mercury T2. Figure 4.51: Device Status Details Button This will bring up the following Device Status Details Window (Figure 4.52).
Software Overview Device Status Solid Yellow: Only Polling LFPS Slow Flashing Yellow: Low Power States Fast Flashing Yellow: Symbol Traffic, Training (TS1/TS2/TSEQ) Solid Green: Link Traffic (U0) LUP, LDN Blinking Green: TPs and DPs (actual traffic) ...
Software Overview Device Status Polling occurs when the Application CPU is not busy. The polling interval is reflected in a small dot (.) at the end of the string in the Status Bar. NOTE: Terminations reflect what the analyzer is presenting to the device or host. The analyzer changes these terminations while attempting to connect the Host DUT and Device DUT together using the SuperSpeed connection protocol.
Software Overview Navigation Tools Exerciser USB 3.2 SS+ Off: No traffic or LFPS Solid Yellow: Only Polling LFPS Slow Flashing Yellow: Low Power States Fast Flashing Yellow: Symbol Traffic, Training (TS1/TS2/TSEQ) Solid Green: Link Traffic (U0) LUP, LDN Blinking Green: TPs and DPs (actual traffic) USB 3.2 SS Off:...
Software Overview Navigation Tools 4.12.2 Zoom Out Zoom Out decreases the size of the displayed elements, allowing more (but smaller) packet fields per screen. Click on the toolbar. 4.12.3 Wrap Select Wrap to adjust the Trace View so that packets fit onto one line. If a packet is longer than the size of the window, the horizontal scroll bar can be used to see the hidden part of the packet.
Software Overview Analyzer Keyboard Shortcuts For more information, refer to the CrossSync Control Panel User Manual. NOTE: If you are using CrossSync, USB Compliance Suite, or any application that uses the Automation Interface to the USB Protocol Suite, and the system prompts you that it cannot write a trace file to disk: Make sure that the trace-file destination folder has write/create ...
Page 185
Software Overview Analyzer Keyboard Shortcuts Figure 4.55: Shortcuts List: Common USB Protocol Suite User Manual, January 2025...
Page 186
Software Overview Analyzer Keyboard Shortcuts Figure 4.56: Shortcuts List: Search 1 USB Protocol Suite User Manual, January 2025...
Page 187
Software Overview Analyzer Keyboard Shortcuts Figure 4.57: Shortcuts List: Search 2 USB Protocol Suite User Manual, January 2025...
Page 188
Software Overview Analyzer Keyboard Shortcuts Figure 4.58: Shortcuts List: Decode Levels and Miscellaneous USB Protocol Suite User Manual, January 2025...
Chapter 5 Recording Options Use Recording Options to create and change various features that control the way information is recorded by the analyzer. To open the Recording Options dialog box: Go to Setup > Recording Options. Click on the Toolbar. ...
Recording Options Summary 5.1 Summary Click the vertical triple greater-than (>) symbols on the right side of the General tab to display the Recording Options Summary (Figure 5.2). Figure 5.2: Recording Options Summary The tab provides an easy-to-read summary of the currently selected options. Close the tab by clicking the three less-than symbols (<).
Recording Options General Voyager M310 Voyager M3i * Advisor T3 Mercury T2 Mercury T2C Mercury T2P * No longer supported. See 1.13 Deprecated Products for more information. 5.2.2 Analyzer vs. Exerciser vs. DP Alt Mode Analyzer This selects the overall mode of operation of the Voyager product.
Recording Options General Recording ends when is clicked on the Toolbar or after post-trigger memory has been filled following depression of the trigger button on the front panel. 5.2.3.3 Event Trigger Recording begins when you click on the Toolbar. Recording continues in a circular manner within the limits set by the buffer size until an event is detected that meets the Trigger conditions specified in the Triggering Options and the defined amount of data has been recorded after the Trigger Event.
Advisor T3 (Gen 1x1) Mercury T2P (DP and USB4) Mercury T2C Mercury T2 Analyzers may capture initial state events such as V NOTE: state, Term states, and the states of CC signals when Type-C Cables are used. Because of this, it is possible for the Recording session to capture a trace even if no cables are attached to the box;...
Recording Options General analyzer memory is used to buffer data while simultaneously uploading the trace file to an attached storage device. Set Recording Size Limits. If you use Snapshot, you can optionally use Record for an elapsed time or Record a number of megabytes. If you use Manual Trigger or Event Trigger, you can optionally use the Until Triggered, plus options to enter post-trigger limits by megabytes or elapsed time.
Recording Options General As an example, if the buffer size is set to 16 MB, then for the following Trigger Position settings, the amount of pre-trigger and post-trigger data is: 95% post-triggering: 0.8 MB pre-trigger, 15.2 MB post-trigger 75% post-triggering: 4 MB pre-trigger, 12 MB post-trigger ...
Recording Options General with the extension .tmp). If you are recording on both channels, then the system creates two files: data_0.usb for Channel 0, and data_1.usb for Channel 1. 1. Click Trace File Name & Path. 2. Click Change Default Location to display a Specify Trace File Name dialog in which to enter the recording file name *.usb for all subsequent recordings.
Page 197
Recording Options General Figure 5.4: Additional Trace File Settings The following options are available: Enable Trace Limit settings for current recording Opened Trace Files & Auto-Delete Limit (1 to 10): Option to set the num- ber of opened files limit from 1 to 10. Close Oldest Files or Delete Oldest Files: Option to either close or delete ...
Check this box to save raw data from the capture in the form of a .usbraw file that will be created in the same folder as your trace. If you are having any problems with your captures, this file is necessary for allowing Teledyne LeCroy support personnel to debug the issue. 5.2.13 CATC Sync (Voyager and Advisor T3 only) These allow you to override the normal CATC Sync behavior when two or more voyagers are connected by a CATC Sync cable.
Recording Options General 5.2.14 External Trigger Settings 5.2.14.1 Repeated Trigger Out In some circumstances, you will want to issue a pulse on the external trigger connection(s) whenever you see an event. By checking this box, this pulse will occur every time the event is seen, as long as it is set up as a trigger in the trigger definition dialogs.
Teledyne LeCroy to investigate issues with the Type-C Termination detection. This should only be checked at the direction of Teledyne LeCroy Technical Support, as it alters the normal contents of the trace data. If directed to use this, the trace should be captured, then this checkbox cleared for normal trace acquisitions.
Recording Options USB 2.0 5.3 USB 2.0 The USB 2.0 page presents options for setting (see Figure 5.6): Analyzer Trace Speed: Select Auto-Detect, Low, Full, or High. USB On-the-Go: Check On-the-Go SRP. Optionally select Dual Role Devices as 2 ...
Recording Options USB 2.0 of the trace. If traffic speed changes, it will not be seen by the analyzer. If you are having problems with your recordings, you might try setting the traffic speed to one of the fixed values—Low, Full, or Hi Speed. These settings are used when you want to manually set the traffic speed.
Recording Options USB 3.2 5.3.2 USB On-The-Go USB On-The-Go option sets the Analyzer to record the USB On-The-Go traffic. This protocol lets you run two devices, specify one of them as the host, one of them as the device, and to assign each device a name.
Page 204
Recording Options USB 3.2 Figure 5.7: M4x: USB 3.2 Recording Options: Analyzer Mode Figure 5.7 shows the USB 3.2 tab with Common Simple Triggers for USB 3.2 recording. See 5.4.8 Simple Triggers for more on triggers. USB Protocol Suite User Manual, January 2025...
Recording Options USB 3.2 Figure 5.8: Simple Triggers: Gen 2 Specific, Gen 1 Specific, BUS Levels 5.4.2 Descrambling In Analyzer Mode, Select Auto to have the analyzer determine the Scrambling state of the incoming data stream on the connector examining the TS1 Packets. You can force the analyzer to either Descramble or not regardless of what is seen in the TS1 packets by selecting On or Off, respectively.
Recording Options USB 3.2 For Simple Filters, you can Filter-Out Logical Idles, Filter-Out SKPs, Filter-Out LUP/LDN, Filter- Out ITP or Filter-Out Bus Events (LFPS, EIdle, Term). Simple Triggers: For Downstream and Upstream triggers, you can select Logical Idle, SHP, SDP, SLC, EPF, END, EDB, COM, SKP, K-Code, Symbol Error, RD Error, DP Length Error, Term On, Term Off and BCNT.
Recording Options USB 3.2 Enable RxDetect: Designed to recognize USB 3 hosts and devices and present a SS termination to them when they are plugged in. LTSSM Controlled Termination: If Enabled, the Exerciser will automatically present SuperSpeed receiver termination is accordance with the Type-C specification and the USB 3 Link Training Status State Machine.
Page 208
Recording Options USB 3.2 Figure 5.9: USB 3.2: Simple Triggers: Gen1 Specific Figure 5.10: USB 3.2: Simple Triggers: Gen 2 Specific Figure 5.11: USB3.2: Simple Triggers, BUS Levels You can specify V(min) and V(max) or I(min) and I(max) with the following conditions: Disable ...
Recording Options USB 3.2 5.4.8.1 Absolute Value (V Levels) If you don’t know which direction the power is coming from (whether it’s being sourced or sinked) you can select the Abs. Value and then set the voltage and current (min) and (max) and the select conditions will trigger the analyzer. See Figure 5.12.
Recording Options Power Delivery 5.5 Power Delivery Figure 5.13: Power Delivery Recording Options The Power Delivery options are the same for Analyzer Mode and Exerciser Mode. NOTE: Selecting Extern Trigger Out via Simple Triggers causes a Trigger Pulse on the external Trigger Out Cable when the External Trigger Cable AC032XXA-X is attached.
The LED reporting will not work as expected, and the ability to distinguish between the Left and Right port traffic is eliminated. Choose this at your own risk, normally under the guidance of Teledyne LeCroy representative. 5.6.2 Resistor Detect Select a Resistor Detect checkbox (Left or Right) to trigger recording.
Recording Options USB Type-C 1.5A Disconnect 5.6.4 Power Measurement Select one of the following Power Measurement checkboxes to trigger the analyzer: CC1 L: Set V(min) and V(max) values CC2 L: Set V(min) and V(max) values CC1 R: Set V(min) and V(max) values ...
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Connected Through: Connects the V signal directly between the two CONN connectors. 5.7 USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) The Recording Rules page is a workspace for creating recording rules, which determine how the analyzer records traces.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) 5.7.1 Navigating the Recording Rules Page Config Toolbar Status Indicator Main Display Area Available Events Area Figure 5.14: Recording Rules USB 2.0 Dialog The page has the following areas: Toolbar: Contains buttons that control the Recording Rules page.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.15: Pop-Up Menu Example Properties Dialogs: When you click the Show/Hide Properties Dialog button for an event, action, or state, a dialog allows you to perform the same operations as in the pop-up menus.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) 5.7.3 Creating Event Buttons To create a rule, first create one or more Event buttons. They appear in the Available Events area. You then can drag-and-drop them into the Main Display area. To create event buttons: 1.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.18: Available Events Area 5.7.4 Dragging a Button to the Main Display Area After you create an Event button in the Available Events area, you can drag the button to the Main Display area and drop it in the appropriate cell (a cell is a grayed-out rectangle with a dashed line around it).
Page 218
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.19: Sequence and State Cells If there currently are no events in the Main Display area, a single sequence cell appears at the top of the area. To drag-and-drop the Event button: 1.
Page 219
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Two new cells appear under the first cell. The first of these new cells is a state cell that allows you to create another state in rule Sequence 0 (to make Sequence 0 a multi-state sequence: Sequence 0 State 1 and Sequence 0 State 2).
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) You can define up to 8 sequences. 5.7.5 Assigning an Action After you have dropped the Event button in a cell in the Main Display area, you can assign an action to the event.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.24: Action Assigned 5.7.6 Actions and Action Properties Actions are context-sensitive (they depend on the type of Event selected). For the Action Properties, you can set Internal Triggering and External Triggering. Recording Rules for USB 3.2 currently do not support more than two independent states.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Table 5.2: Recording Rules Actions & Action Properties Action Description Trigger Indicates Trigger event in the captured trace file. Stop Recording Stops further recording once the trigger condition has been met. (USB 3.2 only) This action is active in any of the three Trigger Modes (Snapshot, Event Trig- ger, Manual Trigger).
Page 223
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.25: Recording Options: Transactions: FILTER-IN After you make a recording, the traffic shown in the Trace view will look something like Figure 5.26, depending on the type of data traffic occurring on the bus. USB Protocol Suite User Manual, January 2025...
Page 224
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.26: Transactions: FILTER-IN: Data Traffic with Transactions You can set the Recording Options to FILTER-OUT Any Transactions. See Figure 5.27. USB Protocol Suite User Manual, January 2025...
Page 225
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Figure 5.27: Recording Options: Transactions: FILTER-OUT After you make a recording, the traffic shown in the Trace view will look like Figure 5.28, depending on the type of data traffic. You will see many Start of Frame (SOF) packets but no Transactions because they have been filtered out.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) 5.7.6.2 Trigger Trigger position in the resulting trace cannot always be determined precisely, due to hardware limitations. In >95% of the cases, the trigger packet shown in the trace file is the one which caused the trigger.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) 5.7.7 Events and Event Properties 5.7.7.1 USB 3.2 Recording rules are associations between events and actions. These associations determine how trace recording occurs. The supported events for USB 3.2 are: Packet Type ...
Page 228
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) TS1B All TS1s TSEQ Header Pattern Link Management Packet Set Link Function U2 Inact Tmt Vndr Dev Test Port Capability ...
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) Input threshold values for USB Tracer/Trainer are between 0.8 V and 2 V (TTL Levels). The minimum value of the external input signal which can be input to Voyager, Advisor T3, and USB Tracer/Trainer is 0 V.
Recording Options USB 2.0 Rec Rules/USB 3.2 Rec Rules (Advanced Mode) 7. If capturing Hi Speed, verify that the default value for Babble trigger is 7435. 8. If capturing Full or Low Speed, verify that the default value for Babble trigger is 59840.
Recording Options USB4 5.8 USB4 The Link Settings, Spread Spectrum Clock, and Polarity Inversion recording options for the M4x in Analyzer Mode USB4 appear in the USB4 > General pane (Figure 5.31). From the USB4 tab, you can also access various Triggers and Filters. Figure 5.31: Voyager M4x: General Recording Options: USB4 5.8.1 General Pane 5.8.1.1 Protocol...
Recording Options USB4 5.8.1.9 Polarity Inversion 5.8.1.9.1 Same for All Links: Used to force a polarity regardless of that indicated in the training. NOTE: This is seldom needed, so it is normally set to Auto. Lane 0 Left – Auto Off/On ...
Page 235
Recording Options USB4 Figure 5.32: TLP Pattern Trigger 5.8.2.2.1 Edit TLP Mask Match Pattern Options When you select the Edit button in the Pattern Trigger (Figure 5.32), it launches a dialog box for editing the TLP. See Figure 5.33. Figure 5.33: Edit TLP Mask Match Pattern Dialog Box You can select the Packet Category you want to trigger from the drop-down list.
Page 236
Recording Options USB4 Supplemental ID HopID Length Figure 5.34: Tunneled PCIe Packet Options: PDF For PDF you can choose from the following options: Ordered Set Electrical Idle State TLP/DLLP PERST Active PERST Inactive ...
Page 237
Recording Options USB4 Figure 5.35: Tunneled PCIe Packet Options Selected Once you click OK, the Trigger Pattern you selected is shown in the Recording Options dialog box In Figure 5.36 (below), the PCIe text in the Pattern Trigger pane is displayed. Figure 5.36: Recording Options: Pattern Trigger Set 5.8.2.2.2 Tunneled PCIe Packet Check this option if you are trying to trigger on a PCIe TLP.
Recording Options USB4 5.8.2.3 TLP Range Trigger This allows you to trigger on TLPs that match specific ranges of PDF, Supplemental ID, HopID, and Length. You can choose to trigger if one or all of the defined conditions occurs. Figure 5.37: TLP Range Trigger 5.8.2.4 CL_WAKE Trigger Allows triggering on CL_WAKE packets with specific re-timer indexes.
Page 239
Recording Options USB4 Figure 5.39: Edit SB Packets in Quick Mode Choose the Detailed mode to define the desired pattern based on sequence of DWORD match/mask. This option allows you to define any customized pattern that not possible through standard field definitions. Figure 5.40 shows editing SB patterns in Detailed mode.
Recording Options USB4 Figure 5.41: Side Band Edited 5.8.3 Filters Pane 5.8.3.1 Filter Out Pane Select the items you do not want captured in the trace file. This reduces the size of the trace file and/or reduces the amount of capture memory used. NOTE: Partial SLOS/WAKE/TS (Rec Buffer Save) is a useful filtering option for users who need to capture some critical OSs that cause LSSM state...
Page 241
Recording Options USB4 Figure 5.43: Filter Out Pane When you select the TLP Filtering button from the Filter Out tab, the following options dialog window appears (Figure 5.44). Figure 5.44: TLP filtering Options Using this window, you can define Filter IN (capture only TLP traffic with associated HOP ID(s)) criteria or Filter Out (do not capture TLP traffic with associated HOP ID(s)) criteria separately for left/right port.
Recording Options USB4 You can also use the Copy from Right and Copy from Left buttons to simplify editing the options. In Filter Out mode, when Do not filter packets with header gap error is checked, it keeps TLP packets in trace with a header GAP violation. Figure 5.45: Do Not Filter Packets with Header Gap ErroTLP Range Pane This allows you to filter out TLPs that match specific ranges of PDF, Supplemental ID, and HopID.
Chapter 6 Reading Trace 6.1 Trace View Features The Trace View comprises the following features: Packet view display uses color and graphics to document captured traffic. Selected packets, transactions, and so on, are highlighted with a blue background and black border (Figure 6.1).
Reading Trace Trace View Features Microframes Figure 6.2: High Speed SOFs Display Microframes 6.1.1 Anchor Points—Synchronized Views Anchors are provided to indicate the synchronization points between views when scrolling. These are indicated by a gold trapezoid . When views are synchronized, the time denoted by these anchor points in the different views should be the same.
Page 245
Reading Trace Trace View Features Figure 6.5: Anchor Point in the Spreadsheet View In the Link Tracker view, it is normally on the third row of the display (see the following screen capture). Figure 6.6: Anchor Point in the Link Tracker View On time-based views, (Link State Timing View, Power Tracker View, Bus Utilization View, etc.), it is normally in the center.
Reading Trace Trace View Features 6.1.2 USB 3.2 Packets USB 3.2 has the following packet types: Link Training Sequences TSeq TS1A TS1B LFPS Packets Electrical Idles Link Commands Header Packets ...
Reading Trace Trace View Features USS (Unidentified Symbol Sequence): These often occur during the transition into and out of U0. Since they are found during this transition period and normally do not interfere with the link coming up or going down, they are classified as a “Warning”.
Reading Trace Trace View Features 6.1.3.1 Hiding/Showing HopID Packets Click Hide Packets icon to selectively Show or Hide HopIDs. See Figure 6.11. Figure 6.11: Toolbar Showing HopID Icon Figures 6.12 6.13 show the effect of clicking on the HopID Hiding icon. The first figure has several instances of upstream (US) HopID of 8 from Packet 196485 to Packet 196496 (Figure...
Reading Trace Trace View Features Figure 6.13: Packets Defined as Upstream with HopID = 8 are Hidden 6.1.4 Packet Direction The Packet Direction field displays the direction the packet or signal was traveling on the bus: Downstream from a Host or Upstream from a Device In most cases, direction can be determined unambiguously.
Reading Trace Markers 6.1.5 Power Delivery Packet Direction Power Delivery Packets occur on a multi-drop connection. For the Consumers and Providers of Power Delivery, the direction is indicated by the Sink and Source directions cell, and the message is indicated as an SOP type (Figure 6.14).
Page 251
Reading Trace Markers You can add attachments to markers (Figure 6.16). 1. Right-click on any cell of a packet and select Set Marker from the menu as shown below or click Ctrl +K. Figure 6.16: Time Dialog The Create Marker window appears. Adding a new line Figure 6.17: Create Marker for Packet Dialog 2.
Reading Trace Markers As previously described, you can: Add icon. Click on this icon to add Export icon. Click on this icon to any file. See 6.2.4 Adding an Attach- export an attachment. ment. Record icon. Click on this icon to Delete icon.
Reading Trace Markers Figure 6.18: Create Marker for Transfer Dialog 6.2.5 Recording an Audio File The audio quality supports voice attachment and is not designed for high-quality audio. Playback of audio content is not limited and depends on the formats supported by the installed playback engine.
Reading Trace Markers 6.2.8 Embedded Attachments to a Marker Embedded files are attached to the item marked and transported with the trace. You can embed the following types of files to a marker: Audio Files Video Files Image Files ...
Reading Trace Markers Figure 6.20: Pop-up Displaying Marker Contents 6.2.9.1 Text The text attachment is displayed in the icon bar and in the main pop-up window. Text attachments are always shown at the top. The attachment file name is displayed in the field as shown below.
Reading Trace Markers 6.2.9.2 Audio Audio snippets that are recorded and attached to a certain point of interest in a trace can be played. The basic Play, Start, Stop, and Pause buttons are displayed to listen to the audio file. 6.2.9.3 Video Video clips that are recorded and attached to certain point of interest in a trace can be played.
Reading Trace Markers 6.2.9.5.1 Web Link Due to the small size, the web page is not embedded in the callout. You can use the Open button to open the web link in the default web browser. 6.2.9.6 YouTube Video The YouTube video player is embedded for YouTube Video playback. USB Protocol Suite User Manual, January 2025...
Reading Trace Markers 6.2.9.7 Images The image is embedded in the trace. 6.2.9.8 Other Attachments Click Open to open the attachment with the system’s default application for that file type. 6.2.10 Edit Marker To edit a marker, right-click on the marked item and select Edit marker from the menu or Ctrl + L.
Reading Trace Markers Add a file attachment. Click on File and click the Open button or drag and drop the file. Preview audio/video/image/URL/YouTube attachment or open other files with system default application. Save an attachment to a file. ...
Reading Trace Markers You can edit Playlists from this window You can edit, delete a marker or delete all markers from this location You can filter attachments within the marker You can select a range of markers by clicking Shift and selecting a range ...
Reading Trace Markers Figure 6.23: Search on Idle Marker 6.2.11.2 Delete Markers When you click delete to remove markers with attachments, the Delete Marker(s) prompt appears. If you do not wish to see this prompt in the future, seelct “Don't ask again”...
Reading Trace CATC Walk Playlist Figure 6.25: Filter Dialog 6.3 CATC Walk Playlist This feature allows users to configure sequences of attachments into playlists. Any arbitrary order of attachments are allowed, and there are no limits on the number of playlists supported.
Reading Trace CATC Walk Playlist 6.3.1 Playlist Functionality You can do the following to manage playlists: Remove or edit current playlists Edit the playlist name Edit the playlist description List the sequence of attachments in current playlist ...
Reading Trace CATC Walk Playlist 6.3.2 Playback Window To playback a playlist: 1. Click the View tab at the top of the application. 2. Select CATC Walk. 3. Select Play > Playlist 1 as shown in Figure 6.28. Figure 6.28: View Menu The select playlist starts in the playback window (Figure 6.29).
Reading Trace Time Stamp Play/Pause Stop Jump to Next attachment Jump to Previous attachment Seek slider for seeking to positions in media streams Volume slider Playback speed slider (for text attachments) As a playlist is played back, the playback window is displayed in close proximity to the marked area, just like a regular tooltip window (Figure 6.30).
Page 266
Reading Trace Time Stamp Place the Zero Time Stamp at this packet. Show the recorded Time Stamp. Place the Zero Time Stamp at the first packet. Place the Zero Time Stamp at the trigger packet. You can also select Set marker to create a new marker. ...
Reading Trace Show Raw Bits (2.0) 6.5 Show Raw Bits (2.0) You can expand a specific packet to view the raw bits in detail. To view raw bits: 1. Right-click Packet # for the packet to view, to display the Packet menu. Figure 6.32: Packet Menu 2.
Reading Trace Expanding and Collapsing Data Fields Figure 6.33: Raw Bits Display for a Packet 6.6 Expanding and Collapsing Data Fields You can expand a Data field to view it in greater detail or collapse it when you want a more compact view.
Reading Trace Expanding and Collapsing Data Fields 6.6.4 Using the Data Field Pop-up Menus You can expand or collapse data fields by clicking a data field and selecting Expand Data or Collapse Data from the pop-up menu. To expand and collapse data using the menu: 1.
Reading Trace Format/Color/Hide Fields 6.7 Format/Color/Hide Fields From the field context menu, you can find Format, Color, and Hide menu selections. You can change the Format of the cell value to Hex, Decimal, Binary or ASCII. You can change the Color of the field header. ...
Reading Trace View Data Block 6.8 View Data Block The data field pop-up menu has an option for viewing the raw bits in a data field. Figure 6.37: View Data Block Pop-Up Menu To view raw bits: 1. Click the data field to open its pop-up menu. 2.
Reading Trace Stacking Figure 6.39: Pop-Up Tool-Tips 6.10 Stacking This feature puts a group of packets in one row to shorten the display. Stacking conserves space in the Trace View by displaying repeating items (or item groups) as one item, along with the number of repeats.
Page 273
Reading Trace Stacking Figure 6.41: Stacked View Stacking Icon (Events Unstacked) Figure 6.42: Unstacked CC Events USB Protocol Suite User Manual, January 2025...
Reading Trace Switch to Transactions View Stacking Icon (Events Stacked) Figure 6.43: Stacked CC Events NOTE: Items are grouped regardless of any intervening Skip Sequence, Electrical Idle, or Logical Idle symbols. If any of these occur during a stream of the repeating stacking item, they are not displayed. NOTE: Unexpected 3.2 Idle times in traces that include Logical Idle and/or SKPs: There will occasionally be “Idle”...
Reading Trace Switch to Transactions View 6.11.1 Transaction View from Toolbar To select Transactions View, click the icon on the toolbar. The Trace View screen is re- drawn to display Transactions. Figure 6.44: Transactions View NOTE: This menu selection displays a check next to Transaction Level when you ...
Reading Trace Switch to Transactions View 2. Check Transaction, then click OK. 6.11.3 Power Delivery Transactions Power Delivery Transactions are also viewable at this level (Figure 6.46). Figure 6.46: Power Delivery Transactions 6.11.4 Power Delivery Packets 1. Right-click on a Power Delivery Packet to view its drop-down menu (Figure 6.47).
Reading Trace View Decoded Transactions Figure 6.47: Power Delivery Packet: Right Click 2. To view the Raw PD data, click Show Raw PD Packet (Figure 6.48). Figure 6.48: Show Raw PD Packet: 5b vs. 4b Encoding 6.12 View Decoded Transactions After you set Display Options, the Trace View screen is re-drawn to display decoded transactions in the colors and format you selected (Figure...
Reading Trace View Decoded Transactions Figure 6.49: Decoded Transactions When you instruct the analyzer to display USB transactions, the components of each transaction are collected from the current recording and are grouped and indented below each decoded transaction. Each row shows a transaction with a unique numeration, a label, and color-coded decoding of important data.
Reading Trace Switch to Split Transaction View The screen displays the selected transaction in expanded format. NOTE: The Expand/Collapse transaction feature operates as a toggle: when one format is active, the other appears as an option on the Expand/Collapse drop-down menu. To collapse a transaction, perform the same operation and select Collapse This Transaction.
Reading Trace Switch to Transfer View The system can display all four types. The default display mode is Packet View. Before you can view decoded transfers, you must switch from Packet View (or Transaction View) to Transfer View. To select Transfer View: Click on the toolbar.
Reading Trace Switch to Transfer View When you instruct the analyzer to display USB transfers, the components of each transfer are collected from the current recording and are grouped below each decoded transfer. Each transfer row shows a transfer with a unique numeration, a label, and color-coded decoding of important data.
Reading Trace Switch to Transfer View NOTE: The Expand/Collapse transfer feature operates as a toggle: when one format is active, the other appears as an option on the Expand/Collapse drop-down menu. To collapse a transfer, perform the same operation and select Collapse This USB Transfer. Note that you can choose to expand or collapse: Only the selected Transfer ...
Page 283
Reading Trace Switch to Transfer View Figure 6.55: USB4 Transfer View of Trace USB Protocol Suite software is able to automatically assign correct configuration space type of transfers, however if required information for this is not available, software will provide a feature that user can assign CS type to transfer to see fields decoded base on assigned type.
Reading Trace Switch to Transfer View Figure 6.56: USB4 Configuration Space: Options 6.14.5 Decoding Power Delivery Transfers You can also use the Transfer button on the toolbar to find Power Delivery Transfers. Figure 6.47. USB Protocol Suite User Manual, January 2025...
Reading Trace Switch to PTP Transactions Figure 6.57: Power Delivery Transfers 6.15 Switch to PTP Transactions The analyzer supports the Picture Transfer Protocol (PTP) and also supports the Media Transfer Protocol (MTP), which is an extension of PTP. The analyzer can track PTP transactions, object transfers, and sessions.
Reading Trace Switch to PTP Object Transfers Click on the toolbar. Select View PTP Group PTP Transaction Level. Select Setup Display Options to display the Display Options window, check PTP Transaction, and then click OK. 6.16 Switch to PTP Object Transfers A logical object on a device has a unique 32-bit identifier (object handle).
Page 287
Reading Trace Switch to PTP Sessions The PTP Session trace viewing level is the highest PTP level. To view PTP sessions, you can do one of the following: From the toolbar, click the down arrow ( ) for the PTP button, then select PTP ...
Reading Trace Switch to USB4 Operations 6.18.1 SCSI Metrics The SCSI Metrics are: Address Number Of Transfers: Total number of transfers that compose the SCSI operation Response Time: Time to transmit on the USB link, from the beginning of the first ...
Reading Trace Compressed CATC Trace View Figure 6.60: USB4 Operations: DROM Read 6.20 Compressed CATC Trace View The Compressed CATC Trace view shows fields in the format “Attribute: Value”, whereas the normal CATC View shows the attribute name on top and the value below. The Compressed CATC Trace view has almost all the information of the normal CATC View and behaves mostly the same way, while displaying more information on each window (Figure...
Reading Trace Spreadsheet View Figure 6.61: Compressed CATC Trace Click on the toolbar to return to the normal CATC Trace View. Select View Trace Views CATC Trace. 6.21 Spreadsheet View You can view the CATC Trace as a spreadsheet in color or black and white (Figure 6.62).
Reading Trace Spreadsheet View Figure 6.62: Spreadsheet View (Color) Figure 6.63: Spreadsheet View (Black And White) 6.21.1 Columns To add a column, right-click a column header, select Add Column, and then select the column name. You can also add a column by dragging the attribute field (in the left column) from the Detail View into the Spreadsheet View.
Reading Trace Spreadsheet View To delete a column, right-click a column header and then select Remove Column. To reposition a column, drag the column header to the new position. To resize columns, select the column divider and drag the divider to the right or ...
Page 294
Reading Trace Spreadsheet View Table 6.1: Rows (Sheet 2 of 3) Option Description Hiding USB 2.0 Traffic Hides: SOFs: Start of Frames Chirps: Chirp-K and Chirp-J Bus conditions (these are recorded only) Hiding USB 3.2 Traffic Hides: Training Sequence Packets – TSEQ, TS1/TS2 Hide Link Commands –...
Reading Trace Enable Sync Traces (used with Hub Compliance) Figure 6.64: Detail View in Spreadsheet View To put a Detail View header in the Spreadsheet View, drag the header to a column divider in the Spreadsheet View. 6.22 Enable Sync Traces (used with Hub Compliance) This button causes the upstream and downstream traces to be time synchronized for scrolling, etc.
Page 297
Reading Trace Enable Sync Traces (used with Hub Compliance) Time: 0.171876430 Time: 0.000491406 Figure 6.65: Two Traces Loaded “Enable Sync Traces” is not turned on Now select the button on the View Menu (4.2.5 View Menu). The result can be seen below in Figure 6.66.
Reading Trace Edit Comment 6.23 Edit Comment You can create, view, or edit the 100-character comment field associated with each Trace file. ® These comments are visible in the Windows Explorer if the Comments attribute is included in the Details view. 1.
Reading Trace Port Alias Figure 6.69: Quick Timing Bars Once markers are placed, you can drag-and-drop them between Start of Packet and End of Packet, or even onto different packets. (See Figure 6.70). Figure 6.70: Dragging and Dropping Quick Timing Bars 6.25 Port Alias The Port Alias is a label applied to all traffic from one of the two port partners throughout the trace.
Reading Trace Field Highlighting Figure 6.72: The Port Alias Right-click Menu 6.26 Field Highlighting Packet fields are synchronized across various reports. Select a field in Trace View, Spec View, or Detail View to see it highlighted in the other views. See Figure 6.73.
Chapter 7 Searching Traces The Search feature provides several options for searching through recorded traffic, which allows you to find specific packets based on triggering status, packet number, marking, or content. 7.1 Search Menu To view the Search options, click the Search tab in the Menu bar (Figure 7.1).
Page 302
Searching Traces Search Menu Search options are described in Table 7.1. Table 7.1: Search Menu Options (Sheet 1 of 6) Option Description Go to Trigger NOTE: Go to Trigger is enabled only when a trigger has created the traffic file. The Trace View is repositioned to the first packet following the Trigger ...
Page 303
Searching Traces Search Menu Table 7.1: Search Menu Options (Sheet 2 of 6) Option Description Go To USB 2.0 The Go To USB 2.0 feature takes you directly to an event in a Trace. 1. From the menu bar, select Search > Go To USB 2.0. The Go To USB 2.0 drop-down menu becomes available (Figure 7.4).
Page 304
Searching Traces Search Menu Table 7.1: Search Menu Options (Sheet 3 of 6) Option Description Transfer Standard Request Allows you to go to a split hub address and port. Type Transfer Hub Class Request Allows you to search for Transfer Hub Class Request Type attributes. ...
Page 305
Searching Traces Search Menu Table 7.1: Search Menu Options (Sheet 4 of 6) Option Description LGO Transaction Type Select the LGO Transaction Type to which you want to go. Transfer Standard Request Allows you to search for Transfer Standard Request Type attributes. ...
Page 306
Searching Traces Search Menu Table 7.1: Search Menu Options (Sheet 5 of 6) Option Description Error Search for: SCSI Op Status SCSI Op Invalid OpCode SCSI Logical Unit Number Use this search option to search for unit number 0x0. ...
Searching Traces Find Table 7.1: Search Menu Options (Sheet 6 of 6) Option Description Go to USB4 Rx/Tx The USB Protocol Suite software allows you to search for a variety of packet types. Ordered set Control Packets Link Management Packets ...
Page 308
Searching Traces Find Searches can combine criteria using the options Intersection and Union. Intersection creates AND statements such as “Find all packets with x and y.” Union creates OR statements such as “Find all packets with x OR y.” ...
Searching Traces Find 5. Select one of the following options: Union: Find all packets matching ANY of the specified events. Intersection: Find packets matching ALL of the specified events. Exclusion: Exclude packets matching any of the specified events. Exclusion works with the other two options: Select Union AND Exclusion (=Exclude packets with ANY of the ...
Searching Traces Find Figure 7.9: Data Pattern Mask and Match Dialog Bitmask and Match always correlate. When you set Bitmask or Match. the other changes to maintain their correlation. NOTE: If you set Bitmask/Match before setting Mask, the Mask changes to the default mask.
Page 311
Searching Traces Find Figure 7.10: Transfer Level Traffic Displayed 2. Select the Find icon to bring up the Find dialog window (Figure 7.11). Example below illustrates a search for Transfers. USB Protocol Suite User Manual, January 2025...
Page 312
Searching Traces Find Figure 7.11: Find Dialog Box 7.2.3.0.1 Example 1. Select the following: Transfers Event Groups Adapter and Register Type Host Int, Read: 7: Host Int, Read USB4 (or TBT3) Rx/Tx 2. Click OK. Transfer #784 with READ, TopologyId, AdapterNum and Configuration Space will be highlighted.
Searching Traces Find Figure 7.12: Transfer #784 Highlighted: Configuration Space, Host Interface 7.2.4 Find USB4 Operations 1. Select the Find icon . This brings up the Find dialog window, which allows you to search for USB4 Operations (Figure 7.13). USB Protocol Suite User Manual, January 2025...
Page 314
Searching Traces Find Figure 7.13: Find USB4 Operations 2. Click OK. The operation with the DROM Read & ASCII Vendor Name is highlighted in the loaded trace (Figure 7.14). USB Protocol Suite User Manual, January 2025...
Searching Traces Find Next Figure 7.14: Trace with DROM Read 7.3 Find Next To apply the previous Find parameters to the next search, select Find Next under Search on the Menu Bar, or click on the Tool Bar. 7.4 Search Direction Toggles the search forward or backwards.
Chapter 8 Display Options You can select what information to display in Trace Views using the Display Options window. To open the Display Options window, do one of the following: Select Display Options under Setup on the Menu Bar. Click on the Tool Bar: ...
Display Options General Display Options 8.1 General Display Options You specify the main Trace View information types and settings using General Display Options (see figure on previous page): Zoom Level: Zooms out from 100% (default) to 10% or zooms in from 100% to ...
Page 318
Display Options General Display Options default to Bulk endpoint, typically when you know that captured traffic is Bulk, not Interrupt. NOTE: To change the Transfer Type in Trace view, right-click the INT or BULK field and select the appropriate option. Hide USB Protocol: Use USB 2.0, USB 3.2 or Power Delivery.
Display Options Color/Format/Hiding Display Options 8.2 Color/Format/Hiding Display Options To modify the colors, formats, and hiding options, select the Color/Format/Hiding tab. Figure 8.4: Display Options Color/Format/Hiding Dialog 8.2.1 Color Display Options The program uses a default set of colors for each type of data in each group of data. The colors and color combinations are appropriate for most graphic systems.
Page 320
Display Options Color/Format/Hiding Display Options Figure 8.5: Display Options Color/Format/Hiding Dialog Group and Color Pane To customize colors, use the Custom tab. USB Protocol Suite User Manual, January 2025...
Display Options Color/Format/Hiding Display Options NOTE: You cannot change the color of an Invalid Data (packet error) field. It is permanently set to red. 8.2.2 Format Display Options For each type of data in each group of data, the program has a default data format. Examples of number data formats are Bin (binary), Dec (decimal), and Hex (hexadecimal).
Display Options USB2 Packet Hiding Options Figure 8.7: Available Formats for PID Types 8.2.3 Hiding Display Options By default, no data is hidden. You can hide any group of data and any type of data. You can hide transactions; SOFs, NAKs, High, Full, or Low Speed packets; traffic from one or both recording channels;...
Display Options USB3 Packet Hiding Options Figure 8.8: Display Options USB2 Packet Hiding Dialog 8.4 USB3 Packet Hiding Options By default, no data packets, transactions, Start-Of-Frame packets, PIDS or bus conditions are hidden. You can hide: Link Commands (Flow Control) ...
Display Options PD Packet Hiding 8.6 PD Packet Hiding Figure 8.11: PD Packet Hiding 8.7 Level Hiding Options By default, no levels of transaction items, transfer items or upper layer items are hidden. You can select from the dialog what you want hidden. Select the Level Hiding tab, then select the level types to hide (see Figure 8.12.)
Display Options Saving/Loading Display Options Figure 8.12: Level Hiding Dialog 8.8 Saving/Loading Display Options You can save a set of Display Options values, make a set the default settings, or use a saved set of values with the commands at the bottom of the Display Options window: To save the current Display Options values in an options file for use in future ...
Display Options Restore Factory Settings To apply the current Display Options values, click Apply. The Display Options window remains open. To apply the current Display Options values and close the Display Options window, click OK. To cancel unsaved changes to display values and exit the Display Options ...
Decode Requests 9.1 Class and Vendor Definition Files Teledyne LeCroy analyzers use script files to decode class and vendor requests. The script files are read when the application is initialized. After reading, the analyzer decodes class and vendor requests as instructed by the files.
Page 331
Decode Requests Class and Vendor Definition Files Table 9.1: Decoder Files (Sheet 2 of 6) USB-IF Codes USB Decoder Protoco USB Decode Name Base l ID Class Class Communications and CDC* Control Direct Line Control Model Communication 0x02 0x01 Abstract Control Model Communication 0x02 0x02...
Page 332
Decode Requests Class and Vendor Definition Files Table 9.1: Decoder Files (Sheet 3 of 6) USB-IF Codes USB Decoder Protoco USB Decode Name Base l ID Class Class Mass Storage Mass Storage 0x08 SCSI/Bulk Protocol 0x08 0x06 0x50 MassStorageClass\MS_BulkOnly_Requests.dec Mass Storage MassStorageClass\MS_BulkOnlySCSIInEndpoint.dec SCSI Bulk MassStorageClass\MS_BulkOnlySCSIOutEndpoint.dec...
Page 333
Decode Requests Class and Vendor Definition Files Table 9.1: Decoder Files (Sheet 4 of 6) USB-IF Codes USB Decoder Protoco USB Decode Name Base l ID Class Class Smart Card (CCID) CCID and ICCD 0x0B 0x00 SmartCard\CCIDBulkIn.dec SmartCard\CCIDBulkOut.dec SmartCard\CCIDInterrupt.dec SmartCard\CCID_req.dec SmartCard\ICCDBulkIn.dec SmartCard\ICCDBulkOut.dec SmartCard\ICCDInterrupt.dec...
Page 334
Decode Requests Class and Vendor Definition Files Table 9.1: Decoder Files (Sheet 5 of 6) USB-IF Codes USB Decoder Protoco USB Decode Name Base l ID Class Class Wireless Controller Bluetooth 0xE0 0x01 0x01 Bluetooth_HCI\hci_command.dec Bluetooth_HCI\hci_data_in.dec Bluetooth_HCI\hci_data_out.dec Bluetooth_HCI\hci_event.dec Bluetooth_HCI\hci_sco_in.dec Bluetooth_HCI\hci_sco_out.dec USB Type-C Bridge USB Type-C TypeC_BridgeRequests.dec...
Decode Requests Class and Vendor Definition Files Table 9.1: Decoder Files (Sheet 6 of 6) USB-IF Codes USB Decoder Protoco USB Decode Name Base l ID Class Class Personal Healthcare Devices Personal 0x0F Healthcare PersonalHealthcare\PersonalHealthcareRequest.dec PersonalHealthcare\PersonalHealthcareDescriptors.inc PersonalHealthcare\PersonalHealthcareDataBulkIn.dec PersonalHealthcare\PersonalHealthcareDataBulkOut.d PersonalHealthcare\PersonalHealthcareDataBulk.inc 9.1.1 Audio Decoders Due to Entity ID mapping issues with this class, it works best if the descriptors are captured in the trace file.
Decode Requests Class/Vendor Decoding Options 2. To be able to use report layout defined in this file, you must set the variable in UseHIDReportDescriptorItems to 1. NOTE: If this flag is 0, software will try to find a report from descriptor in Trace.
Page 337
Decode Requests Class/Vendor Decoding Options Figure 9.1: Request Recipients and Endpoints The Recipient field shows all Class and Vendor Request Recipients found in the trace file. The display shows the Host, Address, and Type (Class or Vendor) for the recipient. On the right are the names of Class/Vendor Decoding groups currently assigned to recipients.
Page 338
Decode Requests Class/Vendor Decoding Options Figure 9.2: Class/Vendor Decoding Groups Drop-Down Menu No Decoding Audio 1.0 Class Requests Audio 2.0 Class Requests Audio 3.0 Class Requests CCID Requests Communication Class Requests Content Security Requests ...
Decode Requests Class/Vendor Decoding Options RNDIS Requests RNDIS Requests – Microsoft Standard Requests Still Image/PTP/MTP/PictBridge Class Requests USB DeviceFirmwareUpdate USB Test and Measurement USB Type-C Bridge Requests Video 1.0 Class Requests Video 1.1 Class Requests ...
Page 340
Decode Requests Class/Vendor Decoding Options Figure 9.3: Request Recipients and Endpoints: Class/Vendor Decoding The Endpoint field (Endp) shows all Endpoints found in the trace file. The display shows the Host, Address, and Direction for the recipient. On the right are the names of Class/Vendor Endpoint Decoding groups currently assigned to endpoints.
Page 341
Decode Requests Class/Vendor Decoding Options Figure 9.4: Transfer Type Drop-down Menu The Transfer Type options for both IN and OUT endpoint are: Isochronous Bulk Interrupt NOTE: Choosing “1 Tran 1 Xfer” speeds up decoding. 5. Select the transfer Type. The selections displayed in the Class/Vendor Endpoint Decoding drop-down menu depend on the transfer Type selected.
Page 342
Decode Requests Class/Vendor Decoding Options Figure 9.5: Endpoint Decoding Options: IN or OUT Isochronous Transfer Type The Isochronous Transfer Type Class/Vendor Endpoint Decoding options for an IN or OUT transfer are: No Decoding CDC Data Isoch Out w/CMD Wrapper ...
Page 343
Decode Requests Class/Vendor Decoding Options Figure 9.6: Endpoint Decoding Options: IN or OUT Bulk Transfer Type The Class/ Vendor Endpoint Decoding options for an IN or OUT transfer for Bulk Transfer Type (as shown in above) are: No Decoding ATAPI MMC4 Out Endp ...
Page 344
Decode Requests Class/Vendor Decoding Options HTTP Out Endp ICCD Bulk Out Message IP_ET0800 (Internet Protocol) Out Endp IPv6_ET86DD (Internet Protocol) Out Endp IrDA Bridge Out Endp Mass Strg Bulk-Only SCSI Out Endp Mass Strg UASP Command Endp ...
Page 345
Decode Requests Class/Vendor Decoding Options Figure 9.7: 1 Tran 1 Xfer Column: HID Interrupt IN Endpoint Decoding The IN Interrupt Transfer Type options for a Class/Vendor Endpoint Decoding (as shown above) are: No Decoding Audio 1.0 Status Interrupt Endpoint ...
Page 346
Decode Requests Class/Vendor Decoding Options USB Type-C Bridge Notifications USBTMC Interrupt-IN USBTMC Interrupt-IN_USB488 Video Interrupt 11. Display the Class/Vendor Endpoint Decoding drop-down menu for Interrupt OUT Transfers (Figure 9.8). Figure 9.8: 1 Tran 1 Xfer column: HID Interrupt OUT Endpoint Decoding The OUT Interrupt Transfer Type options for a Class/Vendor Endpoint Decoding (as shown above) are: No Decoding...
Decode Requests Class/Vendor Decoding Options When this option is set as “yes”, any transaction at the selected endpoint will make a transfer level packet that could be decoded by transfer level scripts. In particular, streams of Isochronous data can be decoded much more quickly if this rule is selected.
Page 348
Decode Requests Class/Vendor Decoding Options Figure 9.10: Example of One Transaction per Transfer Figure 9.11: Example of Several Transactions per Transfer USB Protocol Suite User Manual, January 2025...
Decode Requests Class/Vendor Decoding Options Figure 9.12: Trace View: One Transaction per One Transfer 9.2.3.2 NAK Separated Transfer If you select NAK Separate Transfer (Figure 9.13), the Trace Data Traffic will be converted from several (e.g., 3) Transactions per Transfer (Figure 9.14) to NAK Separate Transfer...
Page 350
Decode Requests Class/Vendor Decoding Options Figure 9.13: Decoding Settings: NAK Separated Transfer Figure 9.14: Trace View: Several Transactions per Transfer USB Protocol Suite User Manual, January 2025...
Decode Requests General Options Figure 9.15: Trace View: NAK Separated Transfers 9.3 General Options Commands are transferred on USB using special control transfers called USB Device Requests. The analyzer can decode Device Requests as they are defined in the USB specifications and various Device Class and Vendor specifications.
Decode Requests General Options Figure 9.16: USB Device Request Menu NOTE: The menus shown in this section are context-sensitive. You may see slightly different menus. 2. To refresh decoding, click Refresh Decoding for this Trace File. Use this option to reanalyze all transactions. 3.
Page 353
Decode Requests General Options Figure 9.17: View Fields for Standard Requests Window 2. To find a word in the text box, click Find, then enter the word in the Find What field. To use a case-sensitive search, check Match Case. ...
Decode Requests General Options 9.3.3 Decoding Class Requests Examples of a class request are: Mass-Strg Class UFI CBI Requests PTP Still Image Class Requests Video Class Requests Wire Adapter Class Requests To decode a class request, from the USB Device Request menu, select Decode ... Request. The View Fields for ...
Decode Requests General Options 9.3.6 Decoding using Endpoint Information To decode using the endpoint information: 1. Right-click in the Bulk/Int Transfer field. The Bulk/Int Transfer (IN/OUT transaction with data) menu appears. 2. Select Decode as ... Endp. The View Fields for ... Endp window opens. Figure 9.19 shows a Mass Strg Bulk-Only SCSI IN Endp decoding.
Decode Requests General Options 9.3.7 Changing the Layout of Decode Requests In the View... Fields windows, the Decoding Information and the Descriptor information blocks (following the Request Summary information) have the following columns: Field: such as bRequest, wValue, wIndex, bLength, bDescriptorType, ...
Decode Requests General Options Figure 9.21: Decoded Fields View Button Function Button Function Save decoded Fields in .html format. Find text in the View Fields page. Displays View Transfer Fields Dialog Layout (Figure 9.22) allowing you to Show previous decoded fields. specify different kinds of presentation formats for the View Fields dialog.
Decode Requests USB4 Decoding Settings Dialog 9.4 USB4 Decoding Settings Dialog 9.4.1 General Information USB4 Decoding Settings Dialog helps the user set decoding parameters manually when automatic decoding is insufficient or incomplete. There are three groups of decoding parameters which can be set manually: Tunneled Hop ID Protocols ...
Page 359
Decode Requests USB4 Decoding Settings Dialog Figure 9.24: Automatically Detected Adapter Types Figure 9.25: Automatically Detected Display Port Adapter Parameters USB Protocol Suite User Manual, January 2025...
Page 360
Decode Requests USB4 Decoding Settings Dialog Figure 9.26: Automatically Detected Host Interface Adapter Parameters You can do the following with USB4 Decoding Settings Dialog: Use the Pen icon in a header to manually change any value in the most right ...
Decode Requests USB4 Decoding Settings Dialog 9.4.2 Tunneled Hop ID Protocols If tunneled protocols are auto detected successfully, the Hop IDs assigned to one of the corresponding protocols, “PCIe/USB3/DP/DPAUX/HI” in USB4 Decoding Settings Dialog, will appear here. If some tunneled protocols are not auto detected, the corresponding Hop IDs are assigned to “None”.
Chapter 10 Reports The Report menu provides access to several reports recorded by the analyzer. Figure 10.1: Report Menu Reports assist with analyzing traffic recorded by the analyzer. The available reports are: Trace Information: To view general information about the trace file. ...
Reports View Docking and Floating Windows Bus Utilization: To display information on bandwidth usage for the transmit and receive channels. Link Tracker (3.2): Displays a detailed chronological view of events. Navigator: Navigates within the trace to view the location of errors and triggers, ...
Reports Trace Information Drag and drop the report at one of the four targets Figure 10.3: Drag and Drop Report in Target NOTE: When you open a report view, the software attempts to apply the user preferences used when you most recently viewed the report. If you have any trouble with your view windows, and want to set it ...
Page 365
Reports Trace Information Figure 10.4: Trace Information Report: File Information and Hardware Information Tab USB Protocol Suite User Manual, January 2025...
Page 366
Reports Trace Information Figure 10.5: Trace Information Report: Recording Options Tab The Trace Information report provides information about how the recording was made, what the buffer settings were, what the trigger options were, and what version of all the analyzer hardware was used to make the recording.
Reports Error Summary The Trace Information dialog provides a link, Open Recording Options in a dialog, so you can load a copy of the recording options that existed when the file was recorded. To see the Device Signal Parameters that were used for your 3.2 captures, click on the hyperlink Show/Hide details to expand the information.
Frame number not sequential, or not exactly 8 repetitions of a frame number in a High Speed frame sequence. Analyzer Internal Error Teledyne LeCroy hardware capture problem (not a USB error). Last Byte Incomplete The packet length in bytes was not modulo 8.
Page 369
Reports Error Summary Table 10.2: USB 3.2 Error Type & Description Error Type Error Description Bad CRC5 The CRC5 field has an incorrect value. The packet is corrupt (either the data or the CRC itself). Bad CRC16 The CRC16 field has an incorrect value. The packet is corrupt (either the data or the CRC itself).
Reports Error Summary 10.3.3 USB4 Sideband Errors Figure 10.7 shows USB4 Sideband errors traffic, and Table 10.3 lists and describes the USB4 Sideband errors. Figure 10.7: USB4 Traffic Summary Report The following table lists each USB4 Sideband error type and its description. Table 10.3: USB4 Sideband Error Type &...
Reports Error Summary 10.3.4 USB4 Rx/Tx Errors The figure below shows USB4 Rx/Tx errors traffic and the table following it lists and describes the USB4 Rx/Tx errors. Figure 10.8: Traffic Summary: USB Rx/Tx Errors Table 10.4 lists each USB4 Rx/Tx error type and its description. Table 10.4: USB4 Rx/Tx Error Type &...
Reports Timing Calculations Table 10.4: USB4 Rx/Tx Error Type & Description (Continued) Error Type Error Description Payload length is invalid Actual TLP Packet length doesn't match expected one (from TLP Header) 10.4 Timing Calculations The Timing Calculator is used to measure timing between any two packets. Select Timing Calculations under Report in the Menu Bar ...
Page 373
Reports Timing Calculations calculations, leaving only the “effective” data transfer that the higher layers will see. (No re-tries, etc.) Figure 10.10: Formulas Window 6. Click Calculate in the left side to display the Bus Utilization, Time Usage, and Bandwidth. Bus Utilization is: Global USB 3.2 ...
Page 374
Reports Timing Calculations Full Speed Low Speed Transactions (High Speed with Idle) Transactions (Classic Speed with Idle) Transactions (High Speed without Idle) Transactions (Classic Speed without Idle) Figure 10.11: Timing Calculator Report Total Time is in the Total Time field. 7.
Reports Data View You can also click the Acknowledged checkbox. NOTE: The larger the range, the more accurate bandwidth and other calculations will be. You should choose a range that includes at least a few USB frames or Microframes so that the measurements give realistic values. 10.4.1 USB4 For USB4, there are two calculation methods: Bus Utilization (the left side of the window) includes all HS packets except Idle...
Reports Raw Data View (Including Power Delivery and USB4 Sideband Packets) Use MSB Format or LSB Format Use Big Endian or Little Endian Figure 10.13: Data View Toolbar The Format field allows you to enter the number of BYTEs, WORDs, or DWORDs ...
Page 377
Reports Raw Data View (Including Power Delivery and USB4 Sideband Packets) Figure 10.14: Report: Raw Data View The Raw Data View toolbar buttons allow you to: Save Go to Previous or Next packet in the trace Display Hexadecimal, Binary, or Ternary ...
Reports Raw Data View (Including Power Delivery and USB4 Sideband Packets) Figure 10.16 shows an example of Raw Data from a packet in a trace: Figure 10.16: Raw Data View: Ternary, Hex, and Binary Formats 10.6.1 Hide Escape Symbols If you have a transaction with multiple Escape Symbols, you can Show or Hide the Escape Symbols by clicking .
Reports Traffic Summary Report Figure 10.18: Raw Data: Escape Symbols Hidden 10.7 Traffic Summary Report Traffic Summary Report summarizes the numbers and types of packets, transactions etc. that occurred in the open trace. To run a Traffic Summary Report: 1. Select Report > Traffic Summary Report or click the button marked Specify a range of packets, then the following window appears: USB Protocol Suite User Manual, January 2025...
Page 380
Reports Traffic Summary Report Figure 10.19: Traffic Summary Report 2. Click the Options button (see red arrow above) to display the Options menu (see Figure 10.20), which allows you to show Grid lines, Row selection, and Tight columns. Figure 10.20: Options Menu 3.
Reports Traffic Summary Report Figure 10.21: Select Range Dialog 4. Enter a number From and a number To. You can also Reset Range to Whole Trace. 10.7.1 SCSI Metrics The SCSI Metrics are: Address Number Of Transfers (Min., Avrg., Max.): Total number of transfers that ...
Reports Bus Utilization Figure 10.22: SCSI Metrics Report 10.7.2 Power Delivery (PD) Traffic Summary Report Power Delivery Traffic, Errors, and Warnings are also available on Power Delivery equipped analyzers in the Traffic Summary Report. See Figure 10.23. Figure 10.23: Power Delivery Traffic Summary 10.8 Bus Utilization The Bus Utilization window displays information on bandwidth use for the three recording channels.
Page 383
Reports Bus Utilization A window opens with graph areas. For USB 2.0, the display is similar to Figure 10.24: Figure 10.24: Bus Utilization Window For USB 3.2, the display is similar to the following: Figure 10.25: Bus Utilization Window USB Protocol Suite User Manual, January 2025...
Reports Bus Utilization For USB4 the display is similar to the following: Figure 10.26: Bus Utilization Window 10.8.1 Bus Utilization Buttons The Bus Utilization window has a row of buttons for changing the format of the displayed data and for exporting data: The buttons have the following functions: Table 10.5: Bus Utilization Buttons Save As - Saves the graphs as a bitmap...
Reports Bus Utilization Table 10.5: Bus Utilization Buttons (Continued) View Settings - opens a sub-menu Sync and Graph areas - If two or more with options for formatting the dis- graphs are displayed, this button syn- play. See 10.8.2 View Settings Menu chronizes the graphs to one another.
Reports Bus Utilization Y Axis: Display Y axis grid lines None: Turns off grid lines Grid on Top: Moves the grid lines above the graph. Fonts and Colors: Opens a dialog box for setting the colors and fonts used in the ...
Reports Bus Utilization For USB 3.2. the display is similar to the following: Figure 10.30: Graph Areas Menu USB 3.2 For USB4, the display is similar to the following: Figure 10.31: Graph Areas Menu USB4 2. Select the data you want to appear in the Graph Areas window. 10.8.3.1 Change the Properties in the Bus Utilization Graph To change the properties in the Bus Utilization graph, in the Graph Area properties dialog box (see...
Reports Bus Utilization Figure 10.32: Graph Area Properties Dialog 10.8.3.3 USB4 Graph Areas USB4 Packet Length: This graph shows the length of all USB4 HS packets over time. USB4 Tunneled TLP Length: This graph shows the length of Tunneled payload ...
Reports Link Tracker 10.9 Link Tracker The Link Tracker window displays a detailed chronological view of events. Events are shown on a channel-by-channel basis in columns within the window. Figure 10.33: Link Tracker Window Select the number of columns to view more or less data at one time. ...
Reports Link Tracker 10.9.1 Time Overlap Indicator Due to the sampling error of the nominal symbol time vs the granularity of our precision (~3ppm) timestamps, it can sometimes occur that 2 or more symbols seem to belong in the same time location of this view. This is denoted by the yellow circle next to the symbol (Figure 10.34).
Reports Link Tracker The top one occurred first, followed by the bottom one, etc. This artifact can occur occasionally throughout the LinkTracker view. 10.9.2 Using the Link Tracker Window The Link Tracker window can be reformatted in several ways. 10.9.2.1 Zooming In and Out Zooming out can give you a quick, high-level view of a trace.
Reports Link Tracker Collapsible Idle Time: Opens a dialog box for setting the Idle time value. Setting a value tells the analyzer when to collapse Idle times and display them as grayed out strips within the Bus View window. Time Format: Seconds or Clock.
Reports Link Tracker 10.9.3 Link Tracker Buttons The Link Tracker window has a row of buttons for changing the format of the displayed data and for exporting data: The buttons have the following functions: Table 10.6: Link Tracker Buttons (Sheet 1 of 2) Full Screen.
Reports Using the Navigator Table 10.6: Link Tracker Buttons (Sheet 2 of 2) Show packet Fields Show USB 3.2 Super Speed 5Gbps Gen 1 packets. Link tracker cannot simultaneously display SS and SS+ traffic. Show USB 3.2 Super Speed + 10Gbps Gen 2 packets. Link tracker cannot simultaneously display SS and SS+ traffic.
Page 395
Reports Using the Navigator Figure 10.37: Navigator Window The Navigator appears on the right side of the Main window. It has a two-button toolbar and a vertical slider bar. It also has colored panes for navigating the trace in different ways. You set which panes are displayed through Navigator pop-up menus.
Reports Using the Navigator The blue caret indicates the current packet position in the trace view. 10.10.2 Navigator Toolbar The Navigator toolbar has two buttons that let you quickly set Navigator features: Navigator Ranges: This button brings up a pop-up menu that lets you reset the Navigator range.
Reports Using the Navigator For example, suppose you set viewing range to packet 0 through packet 500 (the top range delimiter is at packet 0, and the bottom range delimiter is at packet 500). If you then move the current-position indicator on the slider to midway between the top and bottom delimiters, then packet 250 appears in the middle of the trace display.
Page 398
Reports Using the Navigator Figure 10.40: Navigator Panes From left to right, the panes are: Pre/Post Trigger, Errors, Traffic Types, and Protocols of Traffic. Each pane represents the entire trace with respect to different types of information. The top of each pane represents the start of the trace file, and the bottom represents the end of the trace file.
Page 399
Reports Using the Navigator the lowest packet number in the viewing range. You can scroll the display down to the highest packet number in the viewing range. Navigator Legend The Navigator legend lets you control the display of content in Navigator panes. You bring up the legend through the Navigator Panes drop-down menu.
Page 400
Reports Using the Navigator 10.10.2.2.3 Using the Legend to Show/Hide Navigator Panes To use the legend to show/hide an entire pane, use the checkbox next to the name of each pane in the legend. In the case of the Pre/Post Trigger and Errors areas, the action of show/hide in the legend is identical to that provided by Trace Navigator pop-up menus.
Reports Detail View 10.11 Detail View The Detail View window shows packet details. To obtain the Detail View window, select Report > Detail View or click the toolbar icon. Figure 10.42: Detail View Window The Data View toolbar buttons allow you to Go to Previous or Next. Expanding a data field displays the Data View.
Reports USB4 Configuration Space View Figure 10.43: Spec View The toolbar allows you to Save, go to Previous or Next and display Binary or Hexadecimal. See Figure 10.44. Figure 10.44: Spec View Toolbar NOTE: Selecting a field in Spec View highlights the corresponding field in Trace View and Detail View.
Reports USB4 Configuration Space View 10.13.1 Open USB4 Configuration Space View To open USB4 Configuration Space View, from the Report menu click USB4 Configuration Space. Select the specific device by selecting the Topology ID and Adapter Number. NOTE: USB4 Configuration Space may not be available if there are no Control Packets for USB4 traffic in trace.
Reports USB4 Configuration Space View Figure 10.47: Configuration Space View Reports 10.13.2 USB4 Configuration Space View Structure USB4 Configuration Space View consists of four main components: Caption Bar: Contains useful information about the USB4 Configuration Space View state. Navigation Bar: Contains buttons for selecting devices, navigating through ...
Reports USB4 Configuration Space View Caption Bar Navigation Bar Capability View Headers View Figure 10.48: USB4 Configuration Space View Layout 10.13.2.1 Caption Bar The Caption Bar displays information about the current USB4 Configuration Space View state. Figure 10.49: Caption Bar The Caption Bar shows the selected device (TopologyID and AdapterNumber) and adapter type.
Reports USB4 Configuration Space View 10.13.2.3 Headers View Headers View displays a list of Configuration Spaces and available capabilities with their start addresses. NOTE: Headers View shows capabilities as packets get access to the Configuration Spaces. For example, Headers View contains only one capability at the first packet, and all the capabilities accessed in trace through the very last packet.
Reports USB4 LLSM View Figure 10.51: Capability Appears in Router Configuration Space 10.13.4 Truncation of USB4 Capability Layout Some capabilities may be truncated because of next capability. If Next Cap Ptr points at the address before the end of a capability, layout of this capability is truncated. For example, in Figure 10.52 below, Router Basic Configuration Registers has Next Cap Ptr =...
Reports USB4 LLSM View Show/Hide Figure 10.53: Select LLSM View from the Report Menu Figure 10.54: USB4 LLSM View 10.14.1 Navigation Between LLSM & CATC Trace Views Click to synchronize navigation between the LLSM View and CATC Trace View. USB Protocol Suite User Manual, January 2025...
Reports USB 3.2 Link State Timing View Click the left arrow to go to previous link state. Details are displayed based on the selected navigation mode. Click the right arrow to go to next link state. Details are displayed based on ...
Page 410
Reports USB 3.2 Link State Timing View Title Axis Legend Figure 10.55: USB 3.2 Link State Timing View The States are: Compliance Loopback Rx.Detect SS.Inactive SS.Disabled Hot Reset Recovery Polling U3, U2, U1,U0, and Unknown ...
Reports USB 3.2 Link State Timing View 10.15.1 USB 3.2 Link State Timing View Toolbar The buttons have the following functions: Table 10.8: Link State Timing Buttons Insert Time markers. After clicking, click in the display Vertical zoom in to make a red vertical line. Select and drag the line to indicate a time interval between two lines.
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.56: USB 3.2 LTSSM View Click the down arrow to show Downstream port link states. Click the up arrow to show Upstream port link states. Click to show number of transitions. ...
Page 413
Reports Power Tracker—V & Configuration Channel (CC) there are many situations where current can flow in either direction, so we just use this orientation as our standard. For the Exerciser port, we use the Voyager supplying current as the Positive value, and the Voyager sinking current as the Negative value. NOTE: Current direction or direction of current flow can be used to search for this section.
Page 414
Reports Power Tracker—V & Configuration Channel (CC) If you right click withing the display, the following window appears (Figure 10.59). Figure 10.59: Right Click in Display Menus If you select Switch Color Scheme the Power, Voltage and Current background colors will change to black, blue, and red (Figure 10.60).
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.61: Show Legend, Show Min/Max Values 10.16.1.1 Power Tracker Options If you select Power Tracker from the Report menu, you can select Hide, Full Screen, Sync by Time, or Real Time Monitor (see 10.16.1.2 Power Tracker Toolbar).
Reports Power Tracker—V & Configuration Channel (CC) You can go to the time at which Minimum or Maximum values of Power, Voltage, or Current occur by right-clicking and choosing Go To from the popup menu and then choosing a submenu item. The Power Tracker samples are acquired from the start of the recording to the ...
Page 417
Reports Power Tracker—V & Configuration Channel (CC) Table 10.9: Power Tracker Buttons (Continued) Zoom out Hand Panning Insert Time markers. After clicking, click in the display to Zoom by Selection make a red vertical line. Select and drag the line to indicate a time interval between two lines.
Page 418
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.63: Power Tracker Button: Zoom to Visible Part of Trace Figure 10.64: Power Tracker Button: Insert Time Markers USB Protocol Suite User Manual, January 2025...
Reports Power Tracker—V & Configuration Channel (CC) Select Bar, Line or Points for Display of Power Tracker Data Figure 10.65: Power Tracker Button: Change Power Tracker Graph Type 10.16.2 Power Tracker—CC Power Tracker/V Power Tracker Synced (Beta) To display both the CC Power Tracker view synchronized with the V Power Tracker, open an appropriate trace.
Page 420
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.66: Trace Opened: PR_Swap_VDM Ensure both V Power Tracker and CC Power Tracker are enabled. See Figure 10.67. Figure 10.67: BUS Power Tracker and CC Power Tracker are Enabled To use this feature, you must dock the two views so they lie above and below each other, as shown in Figure 10.68.
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.68: CC Power Tracker/ BUS Power Tracker View: Time and Zoom Synchronized 10.16.3 V Power Tracker Export to CSV File If you select the CSV icon on the toolbar (Figure 10.69), a window appears in the directory path where the USB Protocol Suite Software was installed: C:\Users\Public\Documents\LeCroy\USB Protocol Suite\Examples\Power Delivery Traces.
Page 422
Reports Power Tracker—V & Configuration Channel (CC) You can chose an appropriate file title for the CSV file. In this case, VBus_Power_Tracker_Info_from_Trace.csv is selected. See Figure 10.70. Figure 10.70: Popup Dialog Box with Path to Save CSV File Select Save and the CSV file will be saved to the chosen directory. You can then open the file with Excel.
Page 423
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.71: CSV File for BUS Power Tracker Info From Trace USB Protocol Suite User Manual, January 2025...
Reports Power Tracker—V & Configuration Channel (CC) 10.16.4 Configuration Channel (CC) Power Tracker The USB Type C cable supports two Configuration Channel (CC) pins: CC1 and CC2. The Voyager M310C/M310P/M310e/M4x have two Type C connections: one on the left of the front panel (Connector 1) and one to the right (Connector 2).
Reports Power Tracker—V & Configuration Channel (CC) 10.16.4.1 Configuration Channel (CC) Pins Voyager also provides the voltages of the Configuration Channel (CC) pins in a separate window (CC Power Tracker View). Left “Adapter” is for Connector 1 (CC1L, CC2L) and Right “MacBook” is for Connector 2 (CC1R, CC2R). See Figure 10.74.
Page 426
Reports Power Tracker—V & Configuration Channel (CC) The voltages values can be read in the colored tabs (Figure 10.75) or in the gray window that pops up. See Figure 10.76. Figure 10.75: Configuration Channel (CC) 1 and 2 Voltages Shown in Colored Tabs Figure 10.76: Configuration Channel Voltage Values in Gray Box Packet 107 is highlighted below, which shows that the Left cable is attached and is a Source.
Reports Power Tracker—V & Configuration Channel (CC) 10.16.4.2 CC Icon and Voltage Captions In the CC Power Tracker View you can selectively turn-on or turn-off each of the voltages: CC1L, CC1R, CC2L or CC2R by selecting the icon in the toolbar and selecting or deselecting the CC voltages you are interested in.
Page 428
Reports Power Tracker—V & Configuration Channel (CC) Figure 10.81: CC Power Tracker: CSV Icon A dialog box will pop up in the directory path where the USB Protocol Suite Software was installed: C:\Users\Public\Documents\LeCroy\USB Protocol Suite\Examples\Power Delivery Traces. You can chose an appropriate file title for the CSV file. In this case we have chosen “CC_Power_Tracker_Info_from_Trace.csv”.
Reports Decoded Fields View Figure 10.83: CSV File for CC_Power_Tracker_Info_From_Trace 10.17 Decoded Fields View 9.3.8 Decoded Fields View for information. 10.18 Eye Diagram View An eye diagram is a display in which a digital signal from a receiver is repetitively sampled and applied to the vertical input, while the data rate is used to trigger the horizontal sweep.
Reports Eye Diagram View capture this Eye is to run the USB PD Compliance test, which requires a License Key. A trace, captured as a result of an eye test, will contain the data displayed below. See Figure 10.84. Figure 10.84: Eye Diagram View 10.18.1 Eye Diagram Information/Options Filter: (None/LPF - 100ns) Limits the bandwidth shown in the report to the ...
Reports Eye Diagram View Passed Crossing Point Offset (mV): 0.0 User can change the crossing offset by changing this millivolt value. Limits: +100 (mV) to -100 (mV) 10.18.2 Effect of Offset If you change the Crossing Offset you can see the effect on Violated Points. Set the Crossing Offset to 100 mV and this will produce 1023870 violated points, which show up as purple.
A verification script instructs the application to send trace and analysis information to the script. A verification script also contains script code (written using Teledyne LeCroy Script Language) used to process trace data and output that data in different formats.
Page 433
Reports Running Verification Scripts To expand the log, click the Expand Log button To find a view related to the verified trace, and place the window under it, click To find a view related to the verified trace, and place the window to the ...
Page 434
Reports Running Verification Scripts Show Description window: Show/hide the script description window (Shortcut F2). Show Output: Show/hide the script output windows (Shortcut F3). Settings: Specify different settings for VSE. 5. After choosing Settings from the drop-down list or the button, the Settings dialog appears (Figure 10.89).
Reports Real-Time Monitoring Display Settings: Show full trace-file path, restore dialog at start, load last output from save log files, activate dialog after scripts have run, remember dialog layout, and ignore errors and warnings. Saving Settings: Save log files to relative file folder, indicate output log file ...
Reports Real-Time Monitoring Refer to 10.3 Error Summary for further explanation. To see a graph of traffic, you must start recording: 1. Press to start the Real-Time statistics monitor. As traffic is recorded, data is streamed in real time to this window and presented in a format of your choice.
Reports Real-Time Monitoring To clear the counters in the “Statistics Accumulation” area, click the Restart button. To save a snapshot Microsoft Excel .csv file of the data before clearing the values, click the Save and Restart button. The file is in the same folder where Trace files are saved. The file naming convention: “RTS_Capture_YYYY-MM-DD_HH-MM-SS.csv”.
Page 438
Reports Real-Time Monitoring To view two or three graphs simultaneously, click the Graph Areas button. The following menu opens: Figure 10.93: Graph Areas Menu Options Selecting a checkbox displays the selected graph type: Statistics Accumulation: Plots the percentage of Link utilization by non- ...
Chapter 11 Traffic Generation 2.0 USB 2.0 Traffic Generation allows you to generate USB 2.0 traffic and test designs under realistic conditions. Traffic Generation can also transmit known bad packets, providing an opportunity for engineers to observe how a device handles specific adverse conditions. The 2.0 Generation scripts can create almost arbitrary streams of packets, but the responsibility for creating a sequence that performs in an expected way is left to the user.
Traffic Generation 2.0 Connecting to Voyager M310 Figure 11.1: Connections to Voyager 11.1.2 Hi/Full/Low Speed Device Emulation For Device Emulation Hi, Full, or Low Speed, connect to the Voyager according to the following diagram. Figure 11.2: Connections to Voyager 11.2 Connecting to Voyager M310 The connections differ for Host Emulation and Device Emulation.
Traffic Generation 2.0 Connecting to Voyager M310 11.2.1 Hi/Full/Low Speed Host Emulation For Host Emulation Hi, Full, or Low Speed, connect to the Voyager according to the following diagram (Figures 11.3 and 11.4). Figure 11.3: Connections to Voyager M310 11.2.2 Hi/Full/Low Speed Device Emulation For Device Emulation Hi, Full, or Low Speed, connect to the Voyager according to the following diagram.
Traffic Generation 2.0 Connecting to Voyager M310C 11.3 Connecting to Voyager M310C In all cases (Low Speed, Full Speed, Hi Speed) you attach to the left USB Type-C connector (the one with “Exerciser” written below it.) Selection between Host and Device emulation is done in the Recording Options dialog.
Traffic Generation 2.0 Connecting to Voyager M310e Figure 11.7: Connecting a Cable from Device under Test to Exerciser Port Figure 11.8: Connecting a Cable from Host under Test to Exerciser Port 11.5 Connecting to Voyager M310e In all cases you attach to the USB Type-C connector (the one with “Exerciser”...
Traffic Generation 2.0 Traffic Generation Files Figure 11.9: Connecting a Cable from Host under Test to Exerciser Port 11.6 Traffic Generation Files The system generates USB 2.0 traffic from traffic generation files (*.utg) which are text-based script files that instruct the Generator how to generate USB 2.0 traffic. These script files can be edited with either a simple text editor such as Notepad or with the Script Editor utility provided by the application.
Traffic Generation 2.0 Creating Traffic Generation Files 11.7 Creating Traffic Generation Files If you choose to write a script with a text editor, a good way to start is to edit an example generation file. For Windows 10 and 11, see FS_Enum_Break_Wrap_Sample.utg, HS_Hub_Sample.utg, or SampleDeviceEmulationThumbDriveFS.utg, in the examples directory (see Examples) under \2.0 Host Emulation and \2.0 Device Emulation, respectively.
Traffic Generation 2.0 Editing a Generation File Figure 11.12: Export to Generator Dialog Box 2. Enter the numbers of the first and last packets in the series. NOTE: The device packets are removed from the exported generator text. This is essential in creating a generator text file that can be used to handshake with your device.
Traffic Generation 2.0 Editing a Generation File functions such as select, cut, copy, and paste but also adds tool-tips, colored keywords, drop- down parameter values, and expandable/collapsible packet data fields. To launch the Script Editor, click the Script Editor button on the toolbar or right-click the trace window and choose Edit as Text.
Traffic Generation 2.0 Editing a Generation File The buttons have the following functions: Button Function Button Function Save. Saves your edits and immediately Add/Remove bookmark. Allows updates the setting bars and Frames markers to be set or removed to aid in shown in the trace window.
Traffic Generation 2.0 Loading the Generation File Figure 11.15: Pop-up Menu Copy Paste Position Trace View on Packet xxx List Values Toggle Outlining The List Values option displays the types of values that can be entered for a parameter in a line.
Page 450
Traffic Generation 2.0 Loading the Generation File to 2.0 Host Traffic Generator Text File (.utg), menu selection when viewing a Trace File. There are several examples of Traffic Generation files included with the installation of the software. To load a generation file: 1.
Traffic Generation 2.0 Loading the Generation File Figure 11.18: Traffic Generation File 5. Select a value from the Repeat drop-down menu for the number of times you want the traffic pattern to be generated. The Repeat mode allows for a single pass through the generation file, looping forever, or looping 1 to 65,534 times, as desired by the user.
Traffic Generation 2.0 Starting Traffic Generation the device to finish, and then issues an ACK. This way, the data length can vary and does not need to be pre-calculated. Also, using the idle = TO_EOF statement allows the generator to calculate where the end of the frame occurs, so that a subsequent frame = AUTO statement creates a Start of Frame at the correct time.
11.13.1 Creating a Generation File Generation files can be created one of two ways: Write a generation script file using either Teledyne LeCroy's context-sensitive script editor or any text editor that you choose. Use a pre-recorded trace file that has the type of traffic that you want to ...
Traffic Generation 2.0 Device Emulation This option causes the system to read the .utg file and assign a Device Address based on the device traffic that it sees in the file. NOTE: The Device Emulator does not look at the Set Address in the script, so if your host controller is running more than one device, it may enumerate your device emulator incorrectly when you begin to generate traffic.
Traffic Generation 2.0 Device Emulation Figure 11.21: Change the Display Format of an Idle Field Figure 11.22: Bit Time Display for an Idle Field Therefore, instead of ending the packet declaration as “ ” you can change idle=to_eof “ ” to a number of bit times. to_eof If you want to extend or shorten a frame, use a number of idle bits after the last ...
Traffic Generation 2.0 Voyager M3x/M310/M310C/M310P/M310e USB 2.0 Script Limitations of command X and Y for the Endpoint 1, the commands are extracted in this order and placed in the Endpoint 1 memory segment. When the host calls for a particular device endpoint response, the first ...
Traffic Generation 2.0 Format of Traffic Generation Files There are no restrictions on dividing packet definition to lines nor is it necessary to define each packet in a separate line, although it is recommended. The maximum number of characters in a line is 250. ...
Traffic Generation 2.0 Format of Traffic Generation Files 11.15.2 Sample Syntax ; Start of Frames (SOF's) chirp = HERE ; This is necessary for Hi Speed scenarios to establish running at Hi Speed frame=auto idle=TO_EOF ; 1 empty frame, frame number generated automatically frame=23 idle=TO_EOF ;...
Page 459
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 2 of 14) Key Code Format Description file_version integer This must be included after the file_type= key to deter- mine the version of this file. Value is currently 4. Usage: file_version=4 file_mode HOST...
Page 460
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 3 of 14) Key Code Format Description break HERE Host Generation Only. Enables you to generate up to a point in the .utg file, then wait for input before continuing in the file. During the breakpoint time, the traffic signal icon in the toolbar flashes yellow, indicating that a breakpoint was hit.
Page 461
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 4 of 14) Key Code Format Description end_config HERE Terminates the region in the file used for configuring the endpoints. See begin_config. Syntax example: end_config=HERE config_endpoint CONTROL Begins a statement that defines a particular endpoint’s type, default retry behavior (Host Generation only), and INTERRUPT...
Page 462
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 5 of 14) Key Code Format Description retry TRUE Host Generation Only FALSE Defines whether an automatic retry should be performed on packets to/from this endpoint in the case that they are NAKed (or in some cases NYETed), or if a timeout on device response occurs.
Page 463
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 6 of 14) Key Code Format Description retry_next_frame TRUE Host Generation Only FALSE Determines when a retry will be attempted after a failed match of an expected_pid. This statement only applies if a retry=TRUE statement also exists.
Page 464
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 7 of 14) Key Code Format Description Packet Starting Keys 8 bits (0-0xFF) Host Generation Only Use this as the first key of most packets sent by the Host (Exception: Use frame= for SOF packets).
Page 465
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 8 of 14) Key Code Format Description frame 11 bits Creates a start of frame packet and generates a SOF PID as expected. AUTO The key should be assigned a value of the frame number, AUTONUMBER AUTO, AUTONUMBER, or KEEP_ALIVE.
Page 466
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 9 of 14) Key Code Format Description empty_frame integer Host Generation Only This key creates a sequence of start of frame packets with idle=TO_EOF values for the idle time. This results in N empty frames, where N is the integer value specified.
Page 467
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 10 of 14) Key Code Format Description Bus Condition Keys reset positive Host Generation Only integer Indicates the number of microseconds that single-ended zeros (SE0) are driven onto the bus. LS_EOP Assign a positive integer to this key.
Page 468
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 11 of 14) Key Code Format Description wait_termination HERE Host Emulation Only Only for Voyager. Wait until Device Speed terminations are seen before pro- ceeding. Keys for Packet Fields speed Used to cause a low speed packet on a full speed branch.
Page 469
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 12 of 14) Key Code Format Description hird 4 bits (0-15) Host Generation Only Assign the Host Initiated Resume Duration. Default value is 0. For a description of the values 1 through 15, see the Link Power Management Specification.
Page 470
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 13 of 14) Key Code Format Description raw_data (aa bb) Use to send a non-modulo 8 number of bits in a classic speed raw_data packet. Supported in Hi Speed Mode only on It is only valid in conjunction with the raw_data statement.
Page 471
Traffic Generation 2.0 Format of Traffic Generation Files Table 11.1: Key Codes (Sheet 14 of 14) Key Code Format Description Keys for Class Decoding These keys are populated into the .utg. script file automatically whenever the menu command File Export to .utg file is run. These keys do not need to be edited. sd_prod sd_vend sd_bm_req_type...
Chapter 12 Traffic Generation USB 3.2, USB4, & PD Exerciser The USB 3.2 Exerciser allows you to generate USB 3.2 traffic and test designs under realistic conditions. Traffic Generation can also transmit known bad packets, providing an opportunity for engineers to observe how a device handles specific adverse conditions. The PD Exerciser is supported in Voyager M310C/M310P/M4x.
Traffic Generation USB 3.2, USB4, & PD Exerciser Connecting to Voyager M3x Figure 12.2: Cable Connected from HUT to Exerciser Port 12.2 Connecting to Voyager M3x The connections differ for Host Emulation and Device Emulation. Full Speed, Low Speed, Hi Speed, and SuperSpeed connections are the same.
Traffic Generation USB 3.2, USB4, & PD Exerciser Connecting to Voyager M310 Figure 12.4: Connecting a Cable from HUT to “B” Port. 12.3 Connecting to Voyager M310 The connections differ for Host Emulation and Device Emulation. Full Speed, Low Speed, Hi Speed, and SuperSpeed connections are the same.
Traffic Generation USB 3.2, USB4, & PD Exerciser Connecting to Voyager M310C 12.3.2 Device Emulation For Device Emulation, connect a cable from Host under Test to Exerciser “B” port. Host Under Test Figure 12.6: Cable Connected from HUT to Exerciser “B” Port 12.4 Connecting to Voyager M310C In all cases (SS, SS+) you attach to the left USB Type-C connector (labeled “Exerciser”).
Traffic Generation USB 3.2, USB4, & PD Exerciser Connecting to Voyager M310e Figure 12.8: Cable Connected from HUT to Exerciser “A” Port 12.5 Connecting to Voyager M310e In all cases you attach to the USB Type-C connector (the one with “Exerciser” written above it).
Traffic Generation USB 3.2, USB4, & PD Exerciser Connecting to Voyager M310P Host Under Test Figure 12.10: Cable Connected from HUT to Exerciser Port 12.6 Connecting to Voyager M310P In all cases you attach to the USB Type-C connector (the one with “Exerciser” written above it).
Traffic Generation USB 3.2, USB4, & PD Exerciser USB 3.2 Transaction Engine Figure 12.12: Cable Connected from HUT to Exerciser Port 12.7 USB 3.2 Transaction Engine The Transaction Engine allows Voyager hardware to automatically handle low-level protocol elements, for quicker response and higher data throughput. Some Transaction Engine features are: Retry Upon RX NRDY TP: Exerciser automatically waits for ERDY and then retries ...
Traffic Generation USB 3.2, USB4, & PD Exerciser Creating Exerciser Files The system generates USB 3.2/USB4/PD traffic from traffic generation files, which are text- based script files that instruct the Exerciser how to generate USB 3.2/USB4/PD traffic. These script files can be edited with either a simple text editor such as Notepad or with the Script Editor utility provided by the application.
Page 480
Traffic Generation USB 3.2, USB4, & PD Exerciser Exerciser Window Table 12.1: USB/PD Exerciser Menus (Sheet 2 of 3) Menu Sub Topic Function Edit Undo Undoes previous command. Redo Redoes undone command. Deletes selected text. Copy Copies selected text Pastes copied text. Paste Toggle Bookmark Moves back and forth between bookmarks (scripts only).
Traffic Generation USB 3.2, USB4, & PD Exerciser Exerciser Window Table 12.1: USB/PD Exerciser Menus (Sheet 3 of 3) Menu Sub Topic Function Cascade Displays all open windows in an overlapping arrangement. Tile Displays all open windows in a above-below arrangement. Arrange Icons Arranges minimized windows at the bottom of the display.
Page 482
Traffic Generation USB 3.2, USB4, & PD Exerciser Exerciser Window Button Function Button Function Lists all connected units About and allows user to choose target unit for running the Exerciser Start recording and exerciser Stop recording and exerciser generation with one click generation with one click Run Scenario Stop Scenario...
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor 12.11 Script Editor After you open an existing generation script file or create a new text scenario in the Script Editor, use the following steps to edit or build a script. The Script Editor utility has several aids to simplify the process of writing and editing scripts: tool-tips, drop-down menus, and colored fields.
Page 484
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor ™ For details on the generation of a USB 3.2 Script, see the Voyager USB 3.2 Exerciser SS (5Gbps) and SS+ (10Gbps) Generation Script Language Reference Manual. To find this and other manuals, select Help > Other Manuals > USB 3.2 Exerciser Manual as shown in Figure 12.15, below.
Page 485
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor Figure 12.16: New PD Text Generation Scenario For details on the generation of a Power Delivery (PD) Script, consult the Voyager™ Power Delivery Generation Script Language Reference Manual. To find this and other manuals, select Help > Other Manuals > Power Delivery Exerciser Manual as shown in Figure 12.15.
Page 486
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor Figure 12.17: Power Delivery Exerciser Manual Figure 12.18: New USB4 Text Generation Scenario For details on the generation of a USB4 Script, consult the Voyager™ USB4 Exerciser Generation Script Language Reference Manual. To find this and other manuals, select Help >...
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor Figure 12.19: USB4 Exerciser Manual 12.11.1 Highlighting All known commands and parameters are highlighted in blue. All predefined values and command modifiers are highlighted in brown. Comments are in green. ...
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor 12.11.5 File Tabs At the top of the Script Editor window is a tab with the name of the open generation file. If there are Include statements in the generation file that link it to other generation files, these files automatically open and display as tabs at the top of the window.
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor 12.11.10 Line Numbers If you enable line numbers at the Options button, each line has a line number. 12.11.11 Tooltips If you show tooltips at the Options button, tooltips appear when you place the cursor over a button or command.
Page 490
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor Set: After the set command, enter a setting and its value. Trace_B: Enter a message. Trace: Enter a message. StartDeviceFrameworkHandler: Starts or stops the Device Framework Handler ...
Traffic Generation USB 3.2, USB4, & PD Exerciser Script Editor 12.11.13 Views Toolbar The Views toolbar contains buttons for viewing text snippets, Output window, and Error Output window. Figure 12.21: Views Toolbar The buttons have the following functions: Button Function Button Function View Toolbox Text Snippets.
Traffic Generation USB 3.2, USB4, & PD Exerciser Creating a Script using the Script Editor 12.11.15 Pop-up Menu Right-click anywhere in the script window to open a pop-up menu with the following options: Copy Paste Toggle Outlining ...
Page 493
Traffic Generation USB 3.2, USB4, & PD Exerciser Creating a Script using the Script Editor Figure 12.23: Select USB/PD Exerciser: Type of Scenario 1. To display a blank script, click New USB3 Graphic Scenario or select File > New USB3 Text Scenario ...
Page 494
Traffic Generation USB 3.2, USB4, & PD Exerciser Creating a Script using the Script Editor Figure 12.24: Script Scenario The file name appears on the tab for the file. USB Protocol Suite User Manual, January 2025...
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor Figure 12.25: Script Scenario 2. (Optional) You can use the Text Snippets on the left Text Snippets panel to add commands and their parameters. 3. Click the Compile button or select Build > Compile to check the file for errors. The application lists any errors in the Errors tab.
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor High-Level Task Management Functions Bus Enumeration / Control Requests Settings Mass Storage Transfer Packets Instructions (Start Loop, End Loop, Delay, Stop Exerciser) After you create a new graphical scenario, use the following steps to edit or build the scenario. Figure 12.26: Graphical Scenario Editor 12.13.1 Graphical Scenario Window The Graphical Scenario window contains SCSI, TASK, REQ, SET, Insert Instructions, and Delete...
Page 497
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor Abort Task Set Clear Task Set LUN Reset Clear ACA Query Task Query Task Set I T Nexus Reset Query Asynchronous Event ...
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor Figure 12.27: Initiator Setting Dialog 12.13.2.1 Device Information The left pane shows Device Information, as expected from enumeration, so this pane shows general device information from a pre-configure file. The Device Information DeviceInfo.cfg file is in the Generation directory under the users directory.
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor Max Burst Size PipeUsageId Endpoint Type (only for UAS protocol) NOTE: You can only select one device from the Device List as the active device. Required information for the project is defined by the active device.
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor You can select a Custom Flow Control, such as Automatic Link Flow Control, No LGOOD Detect, No LCRD Detect, No LGOOD Generation, No LCRD Generation, or No Flow Control. NOTE: A value of 4294967295 (0xFFFFFFFF) indicates that a default value will be used (Infinite or Auto).
Traffic Generation USB 3.2, USB4, & PD Exerciser Graphical Scenario Editor Task Attribute section has Sample, Head of Queue, Ordered, and ACA. 12.13.3.1 Script Scenarios For some special purposes in which graphical scenario features are limited, you can convert a graphical scenario to a script scenario, which you can then modify. NOTE: The software does not support converting a text scenario to a graphic scenario.
Traffic Generation USB 3.2, USB4, & PD Exerciser Loading and Running the Generation File 12.13.5 Graphical Toolbar The Graphical toolbar contains buttons for zooming, wrapping, and converting from graphic scenario to text scenario. The buttons have the following functions: Button Function Button Function...
Chapter 13 Updates From time to time as modifications are made to the Analyzer, it is necessary to update for optimal performance. Updates can be performed two ways: either automatically or manually. This chapter describes both procedures. 13.1 Software, Firmware, and BusEngine Revisions The Readme.txt file on the first installation disk and in the installed directory gives last-minute updates about the current release.
PHY Board ID NOTE: When contacting Teledyne LeCroy for technical support, please have available the revisions reported in the About window. 13.2 Software Updates You can check for software updates manually, or the application can automatically check for updates at startup.
Software Updates Figure 13.3: Update is Available Message 2. To install an available update, click Go to Download Page Now. This takes you to the Teledyne LeCroy web site. 3. Follow the on-screen instructions to download and install the software update.
Updates Software Updates 13.2.2.1 During Software Installation During software installation, a window asks if you would like to receive automatic notification when software updates are available. Select the check box to enable automatic checking for software updates. Figure 13.4: Enable Automatic Updates When you enable automatic notification of software updates, you accept the Teledyne LeCroy Privacy Policy Agreement.
Failure to do so may result in an inoperable unit which would need to be shipped back to Teledyne LeCroy for repair. USB Protocol Suite User Manual, January 2025...
Updates BusEngine and Firmware Updates 13.3.1 Updating the BusEngines The BusEngine core is the heart of the Analyzer. Using state-of-the-art Electronically Programmable Logic Device (EPLD) technology, it incorporates both the high speed recording engine and the configurable building blocks that implement data/state/error detections, triggering, capture filtering, external signal monitoring, and event counting and sequencing.
Purchased features are permanent (or optionally subject to SW maintenance if any). Trial features expire on a set date which is programmed at Teledyne LeCroy. It is valid till the end of the expiration date. Both features may co-exist on an analyzer. The union of selected features will be ...
Otherwise user can contact Teledyne LeCroy for help. 13.4.2 Downloading Trial Features The same way as purchased features. Teledyne LeCroy will provide a file with trial features which user needs to download into the analyzer. Then activate it if needed. SW will indicate the status of trial features.
No in the Purchased column. To use the feature, you must purchase a license. 13.4.5 Updating the Software License A current license agreement with Teledyne LeCroy entitles the Analyzer owner to continued technical support and access to software updates as they are published on the Teledyne LeCroy website.
Updates Registering Online If your license expires, you must obtain a license key from Teledyne LeCroy (refer to the contact information at the back of this manual.) After you obtain a license key, follow these steps to install it: 1. From the Help menu, select Display License Information to display the...
Visit Teledyne LeCroy’s web site teledynelecroy.com Tell Teledyne LeCroy Report a problem to Teledyne LeCroy Support via e-mail by selecting Help > Tell Teledyne LeCroy from the application toolbar. This requires that an e-mail client be installed and configured on the host machine.
Appendix B China Restriction of Hazardous Substances Table The following tables are supplied in compliance with China’s Restriction of Hazardous Substances (China RoHS) requirements: USB Protocol Suite User Manual, January 2025...
Need help?
Do you have a question about the Mercury T2 and is the answer not in the manual?
Questions and answers