LeCroy Advisor User manual

For Software Version 2.6
April 2008
PROTOCOL SOLUTIONS GROUP
3385 SCOTT BLVD
SANTA CLARA, CA 95054
LeCroy Advisor™
USB 2.0 Bus and Protocol Analyzer
User Manual
Manual Version 2.61

USBAdvisor User Manual
LeCroy Corporation
Document Disclaimer
The information in this document has been carefully checked and is believed to be
reliable. However, no responsibility can be assumed for inaccuracies that may not have
been detected. LeCroy reserves the right to revise the information in this document
without notice or penalty.
Changes or Modifications
Any change or modification not expressly approved by LeCroy voids the user’s authority
to operate this equipment.
Trademarks and Servicemarks
CATC, USBAdvisor, USBTracer, USBTrainer, USBMobile, USBMobileHS, and
BusEngine are trademarks of LeCroy.
Microsoft and Windows are registered trademarks and Windows Vista is a trademark of
Microsoft Inc.
All other trademarks are property of their respective companies.
Copyright
Copyright © 2008, LeCroy Corporation. All Rights Reserved. This document may be
printed and reproduced without additional permission, but all copies should contain this
copyright notice.
FCC Conformance Statement
This equipment has been tested and found to comply with the limits for a Class A digital
device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide
reasonable protection against harmful interference when the equipment is operated in a
commercial environment. This equipment generates, uses, and can radiate radio
frequency energy and, if not installed and used in accordance with the instruction manual,
may cause harmful interference to radio communications. Operation of this equipment in
a residential area is likely to cause harmful interference in which case the user is required
to correct the interference at his own expense. The end user of this product should be
aware that any changes or modifications made to this equipment without the approval of
LeCroy could result in the product not meeting the Class A limits, in which case the FCC
could void the user's authority to operate the equipment.
EU Conformance Statement
This equipment complies with the EMC Directive 89/336/EEC and the Low Voltage
Directive 73/23/EEC, and their associated amendments for Class A Information
Technology Equipment. It has been tested and found to comply with EN55022:1998
Class A (EN61000-3-2:1998, EN61000-3-3:1995) and EN55024:1998
(EN61000-4-2:1998, EN61000-4-3:1996, EN61000-4-4:1996, EN61000-4-5:1996,
EN61000-4-6:1997, EN61000-4-11:1998), and EN60950:1999. In a domestic
environment this product may cause radio interference in which case the user may be
required to take adequate measures.

USBAdvisor User Manual
LeCroy Corporation
WEEE Program
This electronic product is subject to
disposal and recycling regulations that
vary by country and region. Many
countries prohibit the disposal of
waste electronic equipment in
standard waste receptacles.
For more information about proper
disposal and recycling of your LeCroy
product, please visit
www.lecroy.com/recycle.

USBAdvisor User Manual
LeCroy Corporation

USBAdvisor User Manual
LeCroy Corporation v
TABLE OF CONTENTS
Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Graphical Bus Traffic Display. . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 Accurate Time Management . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.4 Comprehensive Error Detection and Analysis . . . . . . . . . . . . . 5
1.5 Real-Time Event Triggering and Capture Filtering. . . . . . . . . . 5
1.6 Advanced Event Counting and Sequencing . . . . . . . . . . . . . . 6
1.7 BusEngine Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2 General Description . . . . . . . . . . . . . . . . . . . . 7
2.1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Analyzer PC Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3 System Components/Packing List . . . . . . . . . . . . . . . . . . . . . . 8
2.4 Stand-Alone Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.5 Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6 External Interface Breakout Board. . . . . . . . . . . . . . . . . . . . . 12
Pin-Outs for the Data In/Out Connector . . . . . . . . . . . . . . . . 13
Prototype Rework Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
PC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 3 Quick Installation . . . . . . . . . . . . . . . . . . . . . 15
3.1 Your First USB Recording . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Capturing Your First CATC Trace . . . . . . . . . . . . . . . . . . . . . 18
Trace View Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 4 Detailed Installation. . . . . . . . . . . . . . . . . . . . 21
4.1 Advisor System Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.2 USB Test Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.3 AC Power Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.4 Advisor Program Installation . . . . . . . . . . . . . . . . . . . . . . . . . 24
Loading the Advisor USB Drivers . . . . . . . . . . . . . . . . . . . . . 24
Installing the Advisor Application Program . . . . . . . . . . . . . . 24
4.5 Advisor Program Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.6 Making a Recording. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Chapter 5 Software Overview . . . . . . . . . . . . . . . . . . . . 27
5.1 Starting the Advisor Program. . . . . . . . . . . . . . . . . . . . . . . . . 27
5.2 Tool Tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3 The Main Display Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.4 View Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Resetting the Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.5 Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Recording Progress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Recording Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Recording Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Search Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

USBAdvisor User Manual
vi LeCroy Corporation
5.6 Navigation Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Zoom In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Zoom Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.7 Advisor Analyzer Keyboard Shortcuts . . . . . . . . . . . . . . . . . . 38
Chapter 6 Reading a Trace. . . . . . . . . . . . . . . . . . . . . . . 41
6.1 Trace View Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.2 Set Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.3 Edit or Clear Marker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.4 View Raw Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Using the Packet Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Using the Stuff Bit Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Using the Zoom Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.5 Expanding and Collapsing Data Fields . . . . . . . . . . . . . . . . . 46
Using the Expand/Collapse Data Field Arrows . . . . . . . . . . . 46
Double-Clicking to Expand/Collapse Data Fields . . . . . . . . . 46
Expanding or Collapsing All Data Fields . . . . . . . . . . . . . . . . 46
Using the Data Field Pop-up Menus . . . . . . . . . . . . . . . . . . . 47
6.6 View Data Block. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.7 Pop-up Tool-tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.8 Hide SOF Packets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.9 Hide NAKs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.10 Hide Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.11 Hide Chirps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6.12 Switch to Transactions View . . . . . . . . . . . . . . . . . . . . . . . . 50
6.13 View Decoded Transactions . . . . . . . . . . . . . . . . . . . . . . . . 52
Expanded and Collapsed Transactions. . . . . . . . . . . . . . . . . 53
6.14 Switch to Split Transaction View . . . . . . . . . . . . . . . . . . . . . 54
6.15 Switch to Transfer View . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.16 View Decoded Transfers . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Expanded and Collapsed Transfers . . . . . . . . . . . . . . . . . . . 55
6.17 Decoding Protocol-Specific Fields in
Transactions and Transfers. . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.18 Switch to Host Wire Adapter Segment View . . . . . . . . . . . . 57
6.19 Switch to Host Wire Adapter Transfer View. . . . . . . . . . . . . 58
6.20 Switch to Device Wire Adapter Segment View . . . . . . . . . . 58
6.21 Switch to Device Wire Adapter Transfer View . . . . . . . . . . . 58
6.22 Switch to PTP Transactions. . . . . . . . . . . . . . . . . . . . . . . . . 59
6.23 Switch to PTP Object Transfers. . . . . . . . . . . . . . . . . . . . . . 59
6.24 Switch to PTP Sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
6.25 Using the Trace Navigator . . . . . . . . . . . . . . . . . . . . . . . . . . 61
6.26 Edit Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Chapter 7 Searching Traces. . . . . . . . . . . . . . . . . . . . . . 65
7.1 Go to Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
7.2 Go to Packet/Transaction/Transfer . . . . . . . . . . . . . . . . . . . . 66
7.3 Go to Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
7.4 Go To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
7.5 Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.6 Find Next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

USBAdvisor User Manual
LeCroy Corporation vii
7.7 Search Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chapter 8 Display Options. . . . . . . . . . . . . . . . . . . . . . . 75
8.1 General Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
8.2 Color/Format/Hiding Display Options. . . . . . . . . . . . . . . . . . . 78
Color Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Formats Display Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Hiding Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
8.3 Level Hiding Display Options. . . . . . . . . . . . . . . . . . . . . . . . . 82
8.4 Saving Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Chapter 9 Decode Requests . . . . . . . . . . . . . . . . . . . . . 85
9.1 Class and Vendor Definition Files . . . . . . . . . . . . . . . . . . . . . 85
9.2 Class/Vendor Decoding Options . . . . . . . . . . . . . . . . . . . . . . 89
Mapping Request Recipient to Class/Vendor Decoding . . . . 89
Mapping Endpoint to Class/Vendor Decoding. . . . . . . . . . . . 92
Mapping Request RPipe to Class/Vendor Decoding. . . . . . . 96
Mapping Endpoint RPipe to Class/Vendor Decoding . . . . . . 97
Mapping Request DWA RPipe to Class/Vendor Decoding . . 98
Mapping Endpoint DWA RPipes to Class/Vendor Decoding. 99
9.3 General Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Decoding USB Device Requests. . . . . . . . . . . . . . . . . . . . . 100
Decoding Standard Requests . . . . . . . . . . . . . . . . . . . . . . . 101
Decoding Class Requests. . . . . . . . . . . . . . . . . . . . . . . . . . 102
Decoding Vendor Requests. . . . . . . . . . . . . . . . . . . . . . . . . 102
Decoding Undefined USB/WUSB Device Requests . . . . . . 102
Decoding using Endpoint Information . . . . . . . . . . . . . . . . . 103
Changing the Layout of Decode Requests . . . . . . . . . . . . . 103
Chapter 10 Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
10.1 File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
10.2 Error Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
10.3 Timing Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
10.4 Traffic Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
10.5 Bus Utilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Bus Utilization Buttons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Chapter 11 Recording Options . . . . . . . . . . . . . . . . . . . .115
11.1 General Recording Options . . . . . . . . . . . . . . . . . . . . . . . . 116
Recording Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Buffer Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Trigger Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Options Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Trace File Name & Path . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

USBAdvisor User Manual
viii LeCroy Corporation
11.2 Events Recording Options . . . . . . . . . . . . . . . . . . . . . . . . . 119
Packet Identifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Token Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Frame Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Device Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Data Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Bus Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
External Input Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Data Length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Splits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
11.3 Actions Recording Options. . . . . . . . . . . . . . . . . . . . . . . . . 127
Actions Window Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
11.4 Connecting Events to Actions . . . . . . . . . . . . . . . . . . . . . . 128
11.5 Connecting Counters to Events . . . . . . . . . . . . . . . . . . . . . 129
11.6 Using Action Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Restart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Filter Out/In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
11.7 Other Actions: External Output Signals . . . . . . . . . . . . . . . 133
11.8 Saving Recording Options . . . . . . . . . . . . . . . . . . . . . . . . . 135
11.9 Recording Bus Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
11.10 Merging Trace Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Chapter 12 Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
12.1 Software, Firmware, and BusEngine Revisions. . . . . . . . . 139
12.2 Software Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
12.3 BusEngine and Firmware Updates . . . . . . . . . . . . . . . . . . 141
Updating the Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Automatic Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Manual Updates to BusEngine and Firmware. . . . . . . . . . . 143
Manually Upgrading the Firmware. . . . . . . . . . . . . . . . . . . . 144
Resetting the Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
12.4 License Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
12.5 Updating the Software License . . . . . . . . . . . . . . . . . . . . . 145
Appendix A Legacy Script Decoding. . . . . . . . . . . . . . . 147
Appendix B China Restriction of Hazardous Substances
Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
How to Contact LeCroy . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Limited Hardware Warranty. . . . . . . . . . . . . . . . . . . . . . . 151
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

USBAdvisor User Manual Chapter 1: Overview
LeCroy Corporation 1
Chapter 1: Overview
The LeCroy Advisor™ USB 2.0 Bus & Protocol Analyzer is another in LeCroy's broad
portfolio of analysis tools. As a fourth generation product, it builds upon LeCroy's
experience and knowledge of the needs of the USB development and test communities.
The Advisor interfaces with standard USB cables and connections to capture anddisplay
Hi-Speed and Classic-Speeds USB 2.0 bus traffic.
1.1 Features
General
• Fully compliant with USB 2.0 specification
• Supports Link Power Management Extension to USB 2.0 specification.
• Flexible design - reconfigurable hardware for future enhancements
• Supports all USB speeds (High-Speed, Full-Speed, and Low-Speed)
• User friendly CATC Trace Interface that displays bus traffic using color and graphics
• Trace Viewer available as free non-recording, view-only software
• Power-on self-diagnostics
• 13 Month warranty and hot-line customer support

Chapter 1: Overview USBAdvisor User Manual
2LeCroy Corporation
Physical Components
• High impedance tap inserts non-intrusively in any branch of a USB system
• 128 MB of physical data recording memory
• Two recording channels - one for High-Speed traffic and one for Classic-Speeds
traffic (either Low- or Full-Speed)
• Secondary recording channel aids in the development of multiple speed functions
up-stream and down-stream of a speed-matching hub or transaction translator
• Convenient "Detach Device" switch operates with the Classic recording channel to
save time and reduce USB cable/connector wear for multiple connects and discon-
nects to host
• Full-speed USB connection to desktop or portable host PC
• Internal wide-range AC power supply
• Break-out board (included)
Recording Options
• Triggering of new USB2.0 PIDS and split transaction special tokens (i.e. ERR,
SPLIT, PING, NYET, DATA2, MDATA)
• CATC Trace displays and enumerates new USB2.0 Micro Frames
• Three forms of triggering: Snapshot, Manual and Event
• Automatically detects and captures high-, full-, and low-speed traffic
• Adjustable buffer size from 0.1MB to 128MB
• Versatile triggering-bit-wise value and mask data patterns up to sixteen bytes wide
for Setup transactions and data packets
• Triggering on multiple error conditions - PID bad, bit stuffing bad, CRC bad,
end-of-packet bad, babble, loss of activity, frame length violation, time-out or
turn-around violation, data toggle violation
• A new transaction sequencer allows triggering or filtering on a token qualified by a
data pattern and/or specific handshake, or alternately transactions can be filtered
• Advanced triggering with event counting and sequencing
• Dedicated trigger for recording input and output that is used to interface to external
test equipment
• Real-time traffic capture filtering and data packet truncation variable up to 245 bytes