1. Manuals
  2. Brands
  3. LeCroy Manuals
  4. Measuring Instruments
  5. Advisor
  6. User manual

LeCroy Advisor User Manual

Usb 2.0 bus and protocol analyzer
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
P
S
ROTOCOL
OLUTIONS
3385 S
B
COTT
LVD
S
C
, CA 95054
ANTA
LARA
USB 2.0 Bus and Protocol Analyzer
G
ROUP
LeCroy Advisor
User Manual
Manual Version 2.61
For Software Version 2.6
April 2008
™

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Advisor and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for LeCroy Advisor

Summary of Contents for LeCroy Advisor

  • Page 1 ROTOCOL OLUTIONS ROUP 3385 S COTT , CA 95054 ANTA LARA ™ LeCroy Advisor USB 2.0 Bus and Protocol Analyzer User Manual Manual Version 2.61 For Software Version 2.6 April 2008...
  • Page 2 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.
  • Page 3 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. LeCroy Corporation...
  • Page 4 USBAdvisor User Manual LeCroy Corporation...

  • Page 5: Table Of Contents

    Detailed Installation....21 4.1 Advisor System Setup ......21 4.2 USB Test Ports.
  • Page 6 Wrap ......... . . 37 5.7 Advisor Analyzer Keyboard Shortcuts ....38 Chapter 6 Reading a Trace.
  • Page 7 Options Name ........118 Trace File Name & Path ......118 LeCroy Corporation...
  • Page 8 Table ....... 149 How to Contact LeCroy ......151 Limited Hardware Warranty.

  • Page 9: Overview

    Chapter 1: Overview 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.
  • Page 10 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 LeCroy Corporation...
  • Page 11 High resolution, accurate time stamping of bus packets, timing measurement, and analysis functions • Extensive search and packet hiding capabilities • Comprehensive device class decoding plus user defined protocol decoding Note: Refer to Readme.txt on your installation CD for the latest information on features. LeCroy Corporation...

  • Page 12: Graphical Bus Traffic Display

    USBAdvisor User Manual 1.2 Graphical Bus Traffic Display The Advisor USB 2.0 Analyzer transaction displays use color and graphics to present the captured transactions in an immediate, understandable and useful format. Packets are shown on separate rows, with their individual fields both labeled and color-coded.

  • Page 13: Accurate Time Management

    The Advisor USB 2.0 Analyzer offers a unique approach to this challenge. By using a set of recording resources, more than a dozen configurable hardware building blocks can be optimized to perform a particular activity appropriate to the task.

  • Page 14: Advanced Event Counting And Sequencing

    USB2.0 Advisor Analyzer or filter the recording. There are two counters and a restart option that causes the sequencing to start again.

  • Page 15: General Description

    PC and displayed on the CATC Trace graphical user interface as color-coded packets that can be searched for specific data, errors or other desired conditions. The Advisor USB2.0 Bus & Protocol Analyzer is the ideal USB tool used in conjunction ® ®...

  • Page 16: Analyzer Pc Requirements

    800 × 600 with 16-bit color is a minimum). • A USB interface is required to connect to the Advisor Analyzer. This is not a require- ment if the application is going to be used only as a viewer.

  • Page 17: Stand-Alone Unit

    Chapter 2: General Description 2.4 Stand-Alone Unit Figure 2.1 Front Panel Figure 2.2 Rear Panel The Advisor Analyzer has several user-accessible controls on its front and rear panels. • Red PWR (power) indicator LED: Illuminates when the unit power is switched on. •...
  • Page 18 For continued protection against fire, replace fuse only with the type and rating specified above. • USB type B host computer connector • Data In/Out DB-9 (9-pin) external interface connector Warning! Do not open the Advisor Analyzer enclosure. There are no operator serviceable parts inside. Refer servicing to LeCroy. LeCroy Corporation...

  • Page 19: Specifications

    Illuminated during power-on testing and when the Analyzer has detected a valid trigger condition Uploading (UPLD) Illuminated when the Analyzer is uploading its recording memory to the host PC for display Recording Memory Size 128 Megabyte DRAM for traffic data capture, timing, state and other data LeCroy Corporation...

  • Page 20: External Interface Breakout Board

    The External Interface Breakout Board is an accessory that allows convenient access to several potentially useful standard, fast TTL output and input signals. It also offers a simple way to connect logic Analyzers or other tools to the Advisor Analyzer unit. Four ground pins and one 5-volt pin are provided.

  • Page 21: Pin-Outs For The Data In/Out Connector

    The remaining holes are not connected. Use the rework area to insert custom components and wire-wrap their respective signal, power, and ground pins. PC Connection Use the LONGEST (6-foot/2-meter) of the five USB cables provided to connect the host computer to the Advisor Analyzer box. LeCroy Corporation...
  • Page 22 Chapter 2: General Description USBAdvisor User Manual LeCroy Corporation...

  • Page 23: Quick Installation

    Step 8 Click Install Software and follow the on-screen instructions. Step 9 Launch the LeCroy Advisor program from the LeCroy programs group. Step 10From the Help menu, select About Advisor to display the version information. If the information below is present, you can record a trace: •...

  • Page 24: Your First Usb Recording

    After installing and launching the software, you can test Advisor by performing the following steps. Step 1 Connect a USB cable to each of the two connectors on the Advisor module, then connect the other ends to the USB device under test and USB host system.
  • Page 25 Step 6 Click on the Tool Bar. Advisor starts to record the USB traffic immediately. After 1 MB of traffic is recorded, the Analyzer uploads the data and displays the packets in the trace window. Step 7 If you wish to terminate the recording before the snapshot automatically completes, click on the Tool Bar.

  • Page 26: Capturing Your First Catc Trace

    Toolbar. You see the standard Save As screen. Step 9 Give the recording a unique name and save it to the appropriate directory. Capturing Your First CATC Trace After a moment, the recording terminates and the results display. LeCroy Corporation...

  • Page 27: Trace View Features

    Chapter 3: Quick Installation Trace View Features • The Advisor packet view display makes extensive use of color and graphics to fully document the captured traffic. • Packets are shown on separate rows, with their individual fields both labeled and color coded.
  • Page 28 Chapter 3: Quick Installation USBAdvisor User Manual LeCroy Corporation...

  • Page 29: Detailed Installation

    USB port. Figure 4.1 USB Advisor Connection The Advisor Analyzer provides on-the-fly detection of and triggering on such events as specific user-defined bus conditions, packets matching any Packet Identifier (PID), packets matching a Token or Setup transaction, data patterns, and errors and bus...
  • Page 30 The program also provides a variety of timing information and data analysis reports. The Advisor Analyzer is designed to work with either desktop or laptop computers equipped with a functional USB interface.

  • Page 31: Usb Test Ports

    Connect the other cable to the type B connector and join it upstream to your host or hub. Note: The Advisor Bus & Protocol Analyzer is not a hub device; it connects to a USB branch by inserting a non-intrusive, high impedance tap. Because of...

  • Page 32: Advisor Program Installation

    USBAdvisor User Manual 4.4 Advisor Program Installation The LeCroy Advisor software is provided on CD-ROM and requires a Microsoft Windows 2000, Windows XP, Windows Vista 32, or Windows Vista 64 operating system. Note: Support for Windows 2000 will end on January 1, 2008.

  • Page 33: Advisor Program Startup

    Chapter 4: Detailed Installation 4.5 Advisor Program Startup You can start the Advisor program from the Desktop or from the installed directory. The program always begins with its main screen active: The software may be used with or without Advisor. When used without Advisor, the program functions in a Trace Viewer mode to view, analyze, and print captured protocol traffic.
  • Page 34 Chapter 4: Detailed Installation USBAdvisor User Manual LeCroy Corporation...

  • Page 35: Software Overview

    When the program is used with the USB Advisor Analyzer attached to the computer, you can monitor and analyze the activity of your USB branch from either of the USB ports on the front of the Analyzer.

  • Page 36: The Main Display Windows

    IN/OUT from the other endpoint. Used when running echo-types of tests for data integrity. Import Imports data from a .vcd file. Exit Exits the Advisor program. Setup Display Options Provides display options such as color, formats, and filters. Recording Options Provides setup options for recording, triggering events, and filtering events.
  • Page 37 Positions the display to the selected event, condition, value, or type Find Allows complex searches on multiple criteria. Find Next Repeats the previous Find operation. Search Direction Allows the search direction to be changed from Forward to Backward or vice versa. LeCroy Corporation...
  • Page 38 Tile Horizontal Displays all open windows in a side-by-side arrangement. Tile Vertical Displays all open windows in a top-to-bottom arrangement. Arrange Icons Arranges minimized windows at the bottom of the display. Windows... Displays a list of open windows. LeCroy Corporation...

  • Page 39: View Options

    Help Displays online help. Help Topics Displays online help. You can also select F1. Update License Opens a dialog box for updating your LeCroy license. Display License Displays information related to licensing. Information About USB Advisor Displays version information about USB Advisor.
  • Page 40 USBAdvisor User Manual Step 2 Select Customize from the sub-menu to display the Customize dialog box. Step 3 Select the Toolbars tab to list the toolbars. Step 4 Click the Reset All button. The toolbar resets to the factory defaults. LeCroy Corporation...

  • Page 41: Toolbar

    Traffic Summary Zoom In Bus Utilization Zoom Out Display Packets Wrap Display Transactions Hide SOFs Display Split Transactions Starts the Trace Navigator Display Transfers Partial Upload Display Host Wire Adapter Segments Hide NAK’d transactions Display Host Wire Adapter Transfers LeCroy Corporation...

  • Page 42: Status Bar

    • When you click Stop before or after a Trigger Event, the Progress Bar adjusts accordingly to begin uploading the most recently recorded data. LeCroy Corporation...

  • Page 43: Recording Status

    The traffic data is copied to disk (overwriting any previous version of this file) using the default file name data.usb. If two channels of traffic are recorded, Advisor creates two files:data.usb and data_classic.usb. You can specify a file name in the Recording Options dialog box.

  • Page 44: Recording Activity

    During uploading, the percent of the completed upload is displayed. Note: If packets are filtered from the recording or data are truncated, the recording activity is reduced. Search Status The rightmost segment displays the current search direction: Fwd (forward) or Bwd (backward). LeCroy Corporation...

  • Page 45: Navigation Tools

    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. • Click on the Tool Bar or select Wrap under View on the Menu Bar. LeCroy Corporation...

  • Page 46: Advisor Analyzer Keyboard Shortcuts

    Chapter 5: Software Overview USBAdvisor User Manual 5.7 Advisor Analyzer Keyboard Shortcuts Several frequently-used operations are bound to keyboard shortcuts. Operation Key Combination Trace Navigation Find Next Search Backwards Ctrl+B Search Forwards Ctrl+F Jump to First Packet Ctrl+Home Jump to Last Packet...
  • Page 47 Go to OTG Host B Ctrl+Shift+B Misc. Marker Menu Ctrl+M Open File Ctrl+O Print… Ctrl+P Record Ctrl+R Stop Recording Ctrl+T Open Display Options dialog Ctrl+Shift+D Open Recording Options dialog Ctrl+Shift+R Hide SOFs Ctrl+Shift+S Hide NAKs Ctrl+Shift+N Hide Chirps Ctrl+Shift+C LeCroy Corporation...
  • Page 48 Chapter 5: Software Overview USBAdvisor User Manual LeCroy Corporation...

  • Page 49: Reading A Trace

    Chapter 6: Reading a Trace 6.1 Trace View Features • The LeCroy USB Advisor™ packet view display makes extensive use of color and graphics to fully document the captured traffic. • Packets are shown on separate rows, with their individual fields both labeled and color coded.

  • Page 50: Set Marker

    Step 2 Select Set Marker to display the Edit Marker Comment window. Step 3 Enter a comment about the packet. Step 4 Click OK. A marked packet is indicated by a vertical red bar along the left edge of the packet # block: LeCroy Corporation...

  • Page 51: Edit Or Clear Marker

    Step 2 To edit the Marker Comment, select Edit Marker Comment to display the Edit Marker Comment window. Edit the comment, then click OK: Step 3 To clear a Marker, click Clear Marker. The vertical red Marker bar disappears. LeCroy Corporation...

  • Page 52: View Raw Bits

    D+/D- signaling complete with NRZ encoding. A scroll bar assists in navigation of larger packets. Two buttons under the label Packet are used to view previous or next packets. Two buttons under the label Zoom allow you to zoom in or out on packets. LeCroy Corporation...

  • Page 53: Using The Packet Buttons

    Under Stuff Bit Error, click the Prev button to view previous stuff bit errors in a trace, and click Next to view stuff bits forward in a trace. Using the Zoom Buttons Use the buttons to view larger or smaller views of raw bits. LeCroy Corporation...

  • Page 54: Expanding And Collapsing Data Fields

    Double-Clicking to Expand/Collapse Data Fields Data fields can also be expanded or collapsed by double-clicking anywhere in the data field. Expanding or Collapsing All Data Fields Expand or collapse all data fields by holding down the button for more than a second. LeCroy Corporation...

  • Page 55: Using The Data Field Pop-Up Menus

    The Trace View is repositioned with the selected packet(s) adjusted in the format you have specified. Expand or Collapse All Data Fields All data fields can be expanded or collapsed by selecting Expand All Data Fields or Collapse All Data Fields from the data field pop-up menus. LeCroy Corporation...

  • Page 56: View Data Block

    The View Data Block window has options for displaying the raw bits in different formats: • Format: Lets you display data in Hex, Decimal, ASCII, or Binary format. • Show Per Line: Lets you control how many bits are displayed per line. • Bit Order: Most Significant Bit or Least Significant Bit LeCroy Corporation...

  • Page 57: Pop-Up Tool-Tips

    6.11 Hide Chirps Click the to hide any Chirp-J or Chirp-K packets recorded in a USBTracer trace. Advisor does not record these signals. LeCroy Corporation...

  • Page 58: Switch To Transactions View

    When you want to switch back to Packet View mode, right-click anywhere in the trace window and then left-click Show USB transactions. Note: This view also shows Extension Transactions, such as the Link Power Management (LPM) transaction defined by the USB 2.0 LPM specification. LeCroy Corporation...
  • Page 59 USBAdvisor User Manual Chapter 6: Reading a Trace To switch to Transaction View from the Menu Bar: Step 1 Select Display Options under Setup to display the Display Options General window: Step 2 Check Transactions. Step 3 Click OK. LeCroy Corporation...

  • Page 60: View 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. LeCroy Corporation...

  • Page 61: Expanded And Collapsed Transactions

    All Transactions. It is not necessary to use the Expand/Collapse Transactions menu to shift between expanded and collapsed views of a transaction: • Double-click in the Transaction number field to toggle back and forth between collapsed and expanded views. LeCroy Corporation...

  • Page 62: Switch To Split Transaction View

    USB transfers can be one of four kinds: Control, Interrupt, Bulk, and Isochronous. Advisor is capable of displaying 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.

  • Page 63: View Decoded Transfers

    You can expand a specific transfer to view its parts, which are grouped and indented below the transfer. To expand a transfer: Step 1 Left-click the transfer number you wish to view. You see the Expand Transfer menu: LeCroy Corporation...

  • Page 64: Decoding Protocol-Specific Fields In Transactions And Transfers

    In order to show specific decoding for class- and vendor-specific device requests and endpoints, you have to use the decoding association mechanism that is described in Chapter 9 on decoding. When you have performed the association, you see the protocol-specific fields of transfers and transactions decoded in the trace view. LeCroy Corporation...

  • Page 65: Switch To Host Wire Adapter Segment View

    Click on the toolbar. • Select View > Show Host Wire Adapter Segment. • Select Setup > Display Options to display the Display Options window, check HWA Segment, and then click OK. The program redraws the trace view. LeCroy Corporation...

  • Page 66: Switch To Host Wire Adapter Transfer View

    Click on the toolbar. • Select View > Show Device Wire Adapter Transfer. • Select Setup > Display Options to display the Display Options window, check DWA Transfer, and then click OK. The program redraws the trace view. LeCroy Corporation...

  • Page 67: Switch To Ptp Transactions

    To view PTP object transfers, switch to the PTP Object Transfer trace viewing level: • Click on the toolbar. • Select View > Show PTP Object. • Select Setup > Display Options to display the Display Options window, check PTP Object, and then click OK. LeCroy Corporation...

  • Page 68: Switch To Ptp Sessions

    To view PTP sessions, switch to the PTP Session trace viewing level: • Click on the toolbar. • Select View > Show PTP Session. • Select Setup > Display Options to display the Display Options window, check PTP Session, and then click OK. LeCroy Corporation...

  • Page 69: Using The Trace Navigator

    Attributes” on page 63. Drag the yellow caret, at the top or bottom, to set the packet range. When you move the caret, a message shows the packet range. The blue caret indicates the current packet position in the trace view. LeCroy Corporation...
  • Page 70 Set Range to Whole Trace: Sets packet range to the entire trace. • Set range near Packet number: Sets the packet range near the packet where your mouse pointer is positioned in the Navigator bar. • Recent Ranges: Displays a history of ranges that were previously selected. LeCroy Corporation...

  • Page 71: Edit Comment

    Details view. Step 1 Select Edit Comment under File on the Menu Bar to display the Edit comment for Trace file window: Step 2 Create, view, or edit the comment. Step 3 Click OK. LeCroy Corporation...
  • Page 72 Chapter 6: Reading a Trace USBAdvisor User Manual LeCroy Corporation...

  • Page 73: Searching Traces

    To display a Trigger Event: • Select Go to Trigger under Search on the Menu Bar. The Trace View is repositioned to the first packet following the Trigger event. This packet is at the top of the screen. LeCroy Corporation...

  • Page 74: Go To Packet/Transaction/Transfer

    The Go to Marker feature functions in conjunction with the Set Marker feature. The comments within the parentheses following each marked packet are added or edited with the Set Marker feature. Please refer to Set Marker in Reading a Trace. LeCroy Corporation...

  • Page 75: Go To

    The Go To feature takes you directly to an event in a Trace. Step 1 Select Go To under Search on the Menu Bar to display the Go To drop-down menu: Step 2 Select an event and enter the necessary information. LeCroy Corporation...
  • Page 76 Chapter 7: Searching Traces USBAdvisor User Manual Packet IDs (PIDs) Select the type of packet. LeCroy Corporation...
  • Page 77 The Errors menu allows you to search for five different types of error: PID, CRC5, CRC16, Packet Length, and Stuff Bits. Menu items appear in bold if they are present in the trace or grayed out if not present in the trace, as shown in the example below. LeCroy Corporation...
  • Page 78 Addr & Endp The Addr & Endp feature allows you to search for the next packet which contains a particular address and endpoint. All available address endpoint combinations are displayed in the pull down menu. LeCroy Corporation...
  • Page 79 USBAdvisor User Manual Chapter 7: Searching Traces Bus Conditions Allows you to search by bus conditions such as traffic speed, reset, and suspend. All available bus conditions are displayed in the pull down menu. LeCroy Corporation...
  • Page 80 Chapter 7: Searching Traces USBAdvisor User Manual On-The-Go Allows you to search for USB On-The-Go conditions. USB On-The-Go conditions are listed in the drop-down menu. Channel Allows you to search by 0(Hi-Speed) and 1(Classic-Speed). LeCroy Corporation...

  • Page 81: Find

    Segments, HWA Transfers, DWA Segments, DWA Transfers, PTP/MTP Transactions, PTP/MTP Objects, or PTP/MTP Sessions from the top left list box to list that type of event in the Events Group box. Step 3 Select one or more events from the Events Group box. LeCroy Corporation...

  • Page 82: Find Next

    To apply the previous Find parameters to the next search: • Select Find Next under Search on the Menu Bar. • Click on the Tool Bar. 7.7 Search Direction Toggles the search forward or backwards. The current direction is indicated in the menu. LeCroy Corporation...

  • Page 83: Display Options

    To open the Display Options window: • Select Display Options under Setup on the Menu Bar. • Click on the Tool Bar. You can select General, Color/Format/Hiding, and Level Hiding display options. The following sections describe these display options. LeCroy Corporation...

  • Page 84: General Display Options

    SOF button or hide all SOFs with two clicks of the Hide SOF button. • Use new Std Reqs & Descriptors Scripts: Use dynamically loaded .DEC files (rather than .REQ and .DSC files) for decoding Class and Vendor requests or endpoints. LeCroy Corporation...
  • Page 85 Configuration Name: You can name the current set of Display Options values for use with an .opt file. (The options file can have a different name.) • Restore Factory Presets: Sets all Display Options values to the installed values. LeCroy Corporation...

  • Page 86: Color/Format/Hiding Display Options

    Chapter 8: Display Options USBAdvisor User Manual 8.2 Color/Format/Hiding Display Options To modify the colors, formats, and hiding options, select the Color/Format/Hiding tab. LeCroy Corporation...

  • Page 87: Color Display Options

    (such as Data) in the Group and Color column and expand it. Select a data type (such as Data Length) in the Group, then select a color in the Color section, using Standard or Custom colors. Use a bright color for each important field. LeCroy Corporation...

  • Page 88: Formats Display Options

    ASCII. You can alter some data formats. To specify a data format for an information type, in the Color/Format/Hiding tab, select a row (such as Packet Fields) in the Group and Color column and expand it. LeCroy Corporation...

  • Page 89: Hiding Display Options

    To hide one or more fields, select the Group and Data type in the Group and Color column, then click the Hidden checkbox in the display or the Hidden checkbox in the Hidden section of the Format section. LeCroy Corporation...

  • Page 90: Level Hiding Display Options

    Start of Frame packets • NAK’ed transactions • Chirp and SEO Bus conditions • High, Full, or Low Speed packets • Channel 0 or Channel 1 packets Select the Level Hiding tab, then select the data types to hide. LeCroy Corporation...

  • Page 91: Saving Display Options

    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 window, click Cancel. LeCroy Corporation...
  • Page 92 Chapter 8: Display Options USBAdvisor User Manual LeCroy Corporation...

  • Page 93: Decode Requests

    Chapter 9: Decode Requests 9.1 Class and Vendor Definition Files 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 94 Still Image StillImageClass\PTPStillImageBulkOut.dec StillImageClass\PTPStillImageRequests.dec StillImageClass\PTPStillInterrupt.dec Printer Printer Printer\Printer_req.dec Mass Storage Mass Storage SCSI/Bulk Protocol Mass Storage MassStorageClass\MS_BulkOnly_Requests.dec SCSI Bulk MassStorageClass\MS_BulkOnlySCSIInEndpoint.dec MassStorageClass\MS_BulkOnlySCSIOutEndpoint.dec MassStorageClass\MS_BulkOnlySCSIOutEndpoint.dec UFI (floppy)/CBI Protocol MassStrg Class MassStorageClass\MS_UFI_CBI_Requests.dec UFI CBI MassStorageClass\MS_UFI_CBI_BulkInEndp.dec MassStorageClass\MS_UFI_CBI_BulkOutEndp.dec MassStorageClass\MS_UFI_CBI_InterruptEndp.dec Hub support Hub Class HubClass\HubClassRequests.dec HubClass\HubClassStatusEndpoint.dec LeCroy Corporation...
  • Page 95 Smart Card (CCID) CCID and ICCD SmartCard\CCIDBulkIn.dec SmartCard\CCIDBulkOut.dec SmartCard\CCIDInterrupt.dec SmartCard\CCID_req.dec SmartCard\ICCDBulkIn.dec SmartCard\ICCDBulkOut.dec SmartCard\ICCDInterrupt.dec SmartCard\ICCD_req_Ver.A.dec SmartCard\ICCD_req_Ver.B.dec Video Class (UVC) decoding 1.1 (currently at 1.0) VIDEO CONTROL Video VIDEO STREAMING Video VIDEO INTERFACE COLLECTION Video VideoClass\VideoBulkIn.dec VideoClass\VideoBulkOut.dec VideoClass\VideoInterrupt.dec VideoClass\VideoIsochIn.dec VideoClass\VideoIsochOut.dec VideoClass\Video1.0Requests.dec VideoClass\Video1.1Requests.dec LeCroy Corporation...
  • Page 96 Cable Based Association Framework (CBAF) Requests Association Frameworks Standard\StandardRequests.dec IEEE\IEEECompanies.dec Virtual\VirtualDATAIn.dec Virtual\VirtualDATAOut.dec Virtual\VirtualUARTIn.dec Virtual\VirtualUARTOut.dec AssociationFrameworks\ WUSB_CableBasedAssociation.dec IrDA Bridge IrDA Bridge ATAPI ATAPI HTTP HTTP Personal Healthcare Devices Personal Healthcare PersonalHealthcare\PersonalHealthcareRequest.dec PersonalHealthcare\PersonalHealthcareDescriptors.inc PersonalHealthcare\PersonalHealthcareDataBulkIn.dec PersonalHealthcare\PersonalHealthcareDataBulkOut.dec PersonalHealthcare\PersonalHealthcareDataBulk.inc Content Security Content Security Devices ContentSecurity\ContentSecurityRequest.dec ContentSecurity\ContentSecurityDescriptors.inc ContentSecurity\ContentSecurityInterrupt.dec LeCroy Corporation...

  • Page 97: Class/Vendor Decoding Options

    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. If blank, no decoding is assigned for a recipient. Step 3 Select a recipient. LeCroy Corporation...
  • Page 98 RNDIS Communication Class Requests • Standard Requests • Still Image/PTP/MTP/PictBridge Class Requests • Video 1.0 Class Requests • Video 1.1 Class Requests • Video Class Requests • Wire Adapter Radio Control Request • Wire Adapter Class Requests • WUSB CBAF Requests LeCroy Corporation...
  • Page 99 Select No Decoding if you do not want any specific decoding. Step 6 Repeat the previous steps for additional recipients. Step 7 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. Step 8 Click OK. LeCroy Corporation...

  • Page 100: Mapping Endpoint To Class/Vendor Decoding

    Host, Address, and Direction for the recipient. On the right are the names of Class/Vendor Endpoint Decoding groups currently assigned to endpoints. If blank, no decoding is assigned for a recipient. Step 4 Select an endpoint. LeCroy Corporation...
  • Page 101 Mass Strg UFI_CBI Bulk Out Endp • RNDIS_PACKET_MSG Bulk Out • Still Image/PTP/MTP/PictBridge Bulk Out • TCP (Transmission Control Protocol) Out Endp • Video Bulk Out • Video Isoch Out • Virtual UART • Wire Adapter Data Transfer Out Endp LeCroy Corporation...
  • Page 102 TCP (Transmission Control Protocol) In Endp • Video Bulk In • Video Interrupt • Video Isoch In • Virtual UART • Wire Adapter Radio Notif Endp • Wire Adapter Data Transfer In Endp • Wire Adapter Notif Endp LeCroy Corporation...
  • Page 103 Step 7 Repeat the previous steps for any additional endpoints you would like to map. Step 8 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. Step 9 Click OK. LeCroy Corporation...

  • Page 104: Mapping Request Rpipe To Class/Vendor Decoding

    Select No Decoding if you do not want any specific decoding. Step 7 Repeat the previous steps for additional recipients. Step 8 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. Step 9 Click OK. LeCroy Corporation...

  • Page 105: Mapping Endpoint Rpipe To Class/Vendor Decoding

    Step 7 Repeat the previous steps for any additional RPipes you would like to map. Step 8 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. Step 9 Click OK. LeCroy Corporation...

  • Page 106: Mapping Request Dwa Rpipe To Class/Vendor Decoding

    Select No Decoding if you do not want any specific decoding. Step 7 Repeat the previous steps for additional recipients. Step 8 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. LeCroy Corporation...

  • Page 107: Mapping Endpoint Dwa Rpipes To Class/Vendor Decoding

    Step 7 Repeat the previous steps for any additional RPipes you would like to map. Step 8 To retain a mapping from trace to trace DURING an application session, select the Keep Across Recordings checkbox. Step 9 Click OK. LeCroy Corporation...

  • Page 108: General Options

    This new feature simplifies the process when the application has been re-started. Note: You can also change the format, color, and hidden status of fields, using the same methods as in Display Options. (See Chapter 6, Display Options.) LeCroy Corporation...

  • Page 109: Decoding Standard Requests

    Step 4 To view the previous or next Transfer Control field request of the same request type, click Previous or Next. The View Fields for Standard Request dialog box displays field definitions and values of the Standard Request. LeCroy Corporation...

  • Page 110: Decoding Class Requests

    From the USB Device Request menu, select Decode ... Request to display the View Fields for ... Vendor Requests text box. An example of a vendor request is USB Advisor™ Command Set. Decoding Undefined USB/WUSB Device Requests A Decoding Request may not belong to any of the defined decoding groups (Standard, Class, or Vendor).

  • Page 111: Decoding Using Endpoint Information

    Field: such as bRequest, wValue, wIndex, bLength, bDescriptorType, wTotalLength • Length in bits • Offset in bits • Decoded: hex value typically equal to Hex Value • Hex Value: hex value typically equal to Decoded • Description: short description of field LeCroy Corporation...
  • Page 112 Step 3 To show only the fields of Collapsed mode, check Show only fields specified for view in collapsed mode. Step 4 To retain settings for future viewing of Decode Request fields, check Use these settings when View Fields dialog opens. LeCroy Corporation...

  • Page 113: Chapter 10 Reports

    USBAdvisor User Manual Chapter 10: Reports Chapter 10: Reports The Report menu provides several reports to assist you in analyzing USB traffic recorded by the Analyzer. LeCroy Corporation...

  • Page 114: File Information

    Analyzer that created the file, what the trigger options were, the user’s license information, and what version of all the Analyzer hardware was used to make the recording. LeCroy Corporation...

  • Page 115: Error Summary

    Tool Bar to display the Errors pane: Navigate to an error within the recording by clicking the number of the packet containing the error. Use the arrows to cycle though each occurrence of a particular error. LeCroy Corporation...

  • Page 116: Timing Calculations

    10.3 Timing Calculations The Timing Calculator is used to measure timing between any two packets. • Select Timing Calculations under Report in the Menu Bar. • Click in the Tool Bar to display the Timing and Bus Usage Calculator screen: LeCroy Corporation...

  • Page 117: Traffic Summary

    Traffic Summary summarizes the numbers and types of packets, transactions, and so on that occurred in the open trace. To run Traffic Summary, select Report > Traffic Summary, or click the button marked . The program prompts you to specify a range of packets, then displays the following window: LeCroy Corporation...

  • Page 118: Bus Utilization

    USBAdvisor User Manual 10.5 Bus Utilization The Bus Utilization window displays information on bandwidth use for the two recording channels. To open the Bus Utilization window, select Report > Bus Utilization or click the button to display three graphs: LeCroy Corporation...

  • Page 119: Bus Utilization Buttons

    Graph Areas - Presents options for displaying additional graphs of data Horizontal zoom in lengths, packet lengths, and percentage of bus utilized. Horizontal zoom out LeCroy Corporation...
  • Page 120 Both: Displays both X and Y axis gridlines. • X Axis: Displays X axis gridlines. • Y Axis: Display Y axis gridlines. • None: Turns off gridlines. • Grid on Top: Moves the grid lines above the graph. LeCroy Corporation...
  • Page 121 USBAdvisor User Manual Chapter 10: Reports • Fonts and Colors: Opens the View Options dialog box for setting graph fonts and colors: LeCroy Corporation...
  • Page 122 Step 3 To make a new graph, click New. To change properties in the Bus Utilizations graph: Step 1 In the Graph Areas menu, select what you want your graph to display, then click Step 2 To make a new graph, click New. LeCroy Corporation...

  • Page 123: Chapter 11 Recording Options

    Chapter 11: Recording Options Chapter 11: Recording Options Use Recording Options to create and change various features that control the way information is recorded by the LeCroy USB Advisor™ Analyzer. To open the Recording Options menu: • Select Recording Options under Setup on the Menu Bar •...

  • Page 124: General Recording Options

    Recording Type The Recording Type box presents three options that allow you to set how Advisor begins and ends a recording. The options are: Snapshot, Manual Trigger, and Event Trigger.

  • Page 125: Options

    Truncate Data Fields allows data fields to be truncated during recording to save Analyzer memory and allow recording of more packets. Enter a maximum data length value in the Bytes box. Advisor truncates the data to the stated value or slightly larger. Note: Truncation of data may cause incorrect transaction or transfer decoding.

  • Page 126: Options Name

    Trace File Name & Path opens a Save As dialog box for saving your trace file. The default recording file name is data.usb for Low, Full, and High Speed recordings. If you are recording on both channels, then Advisor creates two files: data.usb for Classic Channel, and data_classic.usb for High-Speed Channel.

  • Page 127: Events Recording Options

    Group details. When a detail is grayed out, it is inactive and cannot be selected. If an Event Group remains inactive, the current version of the application or BusEngine™ does not support it. Click the Events tab on the Recording Options screen to display the Event Groups window: LeCroy Corporation...

  • Page 128: Packet Identifiers

    Recording Trigger. Token Patterns Select Token Patterns under Event Groups to display the Token Patterns window: Specify up to three combinations of Address/Endpoint with any of the token PIDs. They can be triggered on or filtered in/out. LeCroy Corporation...

  • Page 129: Frame Patterns

    The software depends on the existence of SOF packets when it analyzes these (and other) sequences in the USB packet stream. Device Requests Select Device Requests under Event Groups to display the Device Requests window: You can select one or two Device Requests for triggering or filtering. LeCroy Corporation...

  • Page 130: Data Pattern

    Step 2 Press the Edit button to display a Bit-by-Bit window: Step 3 Click the bits within each byte that you wish to edit and enter appropriate text. The Mask and Match fields change. LeCroy Corporation...

  • Page 131: Bus Conditions

    USBAdvisor User Manual Chapter 11: Recording Options Bus Conditions Select Bus Conditions under Event Groups to display the Bus Conditions window: Use any combination of the listed errors as a Trigger. LeCroy Corporation...

  • Page 132: Errors

    Check Incl. Reset if you want the first toggle value after a reset to be considered “good” regardless of the value prior to that reset. If Unchecked, toggle state is assumed to be preserved through the reset. • Select Addr and/or Endp to select Token Addresses and/or Endpoints. LeCroy Corporation...

  • Page 133: External Input Signals

    This window has two checkboxes: Input 1 (TRIG IN) and Input 2 (G.P. IN). Use any combination of the inputs as a Trigger. Transactions Select Transactions under Event Groups to display the Transactions window: Use any combination of the listed errors as a Trigger. LeCroy Corporation...

  • Page 134: Data Length

    To trigger on data length, enter a value between 0 and 1024 in the box marked Data Length. Splits Select Splits under Event Groups to display the following window. Selecting Splits allows you to trigger on the attributes of a Split Packet. LeCroy Corporation...

  • Page 135: Actions Recording Options

    The lower right corner displays the Trigger, Filter Out, and Restart buttons. Action buttons controls the Advisor response to Event conditions. For example, if an Error button is linked to a Trigger button, the Action button tells Advisor to trigger when the error condition occurs.

  • Page 136: Connecting Events To Actions

    The elastic arrow moves with the mouse pointer. Step 5 With the pointer over an Actions button, click the left mouse button again. The arrow is anchored to the Action button and replaced with a black line connecting the Event button to the Action button. LeCroy Corporation...

  • Page 137: Connecting Counters To Events

    Step 3 Click the Event button. An arrow appears that connects the Event button to your mouse pointer. Step 4 Click one of the two counters. The Event automatically connects to the Counter button and then connects to the Trigger button. LeCroy Corporation...
  • Page 138 "Trigger when Count1 OR Count2 has reached their specified values." In this example, Advisor is set to trigger following an In Packet Identifier, then 25 counts of a token or an In Packet Identifier, then a Token, then an Error.

  • Page 139: Using Action Buttons

    Event, Counter and an Action button. The screenshot below gives an example. The screen below reads "Look for IN and Out packets. When 10 OUT packets, trigger. However, if an IN packet occurs during the count, restart the count." LeCroy Corporation...

  • Page 140: Filter Out/In

    Step 1 Click the blue dot on Filter Out (may say Filter In depending on the last action specified) to display the Filter Polarity menu: Toggle the selection between Filter Out and Filter In. Step 2 Select Filter In. The button changes to read Filter In. LeCroy Corporation...

  • Page 141: Other Actions: External Output Signals

    If you select Enable External Trigger Output, a small arrow appears on the right side of the button to indicate that a condition has been set for creating an external output signal. Choosing Disable External Trigger causes the arrow to disappear. LeCroy Corporation...
  • Page 142 Step 2 Choose External Trigger Form to display a menu with choices for Pulse Low, Pulse High, and Toggle. Step 3 Choose an option not currently selected to close the menu. Step 4 Reopen the menu. Note that the new selection is now checked. LeCroy Corporation...

  • Page 143: Saving Recording Options

    Whenever you start up the Analyzer, it automatically loads the default.rec file if one exists. • Click OK to apply any changes and close this dialog box. • Click Cancel to cancel any immediate changes you have made and exit the Recording Options menu. LeCroy Corporation...

  • Page 144: Recording Bus Data

    Step 3 Select Save As under File on the Menu Bar. Click on the Tool Bar. You see the standard Save As screen. Step 4 Give the recording a unique name and save it to the appropriate directory. LeCroy Corporation...

  • Page 145: Merging Trace Files

    Note: Advisor is capable of merging High Speed and Classic Speeds traffic into a single merged file if the Auto-Merge 2 Channel Trace Files option is checked in the Recording Options dialog box. See page 117 for details.
  • Page 146 Step 4 Click Yes to confirm your choices. The two files are merged into the new file data_merged.usb. Note: If you attempt to merge two files that were recorded in separate recording sessions, the following error message appears: LeCroy Corporation...

  • Page 147: Chapter 12 Updates

    Chapter 12: Updates Chapter 12: Updates From time to time as modifications are made to the Advisor Analyzer, it is necessary to update the Advisor for optimal performance. Updates can be performed two ways: either automatically or manually. This chapter describes both procedures.

  • Page 148: Software Updates

    Chapter 12: Updates USBAdvisor User Manual 12.2 Software Updates When a new software release is available, it is posted on the Support page of the LeCroy website at www.lecroy.com/support.html. To update the software: Step 1 In the About Advisor screen, verify which version of LeCroy USB Advisor™...

  • Page 149: Busengine And Firmware Updates

    BusEngine and Firmware. To perform an automatic BusEngine and Firmware update, follow these steps: Step 1 If needed, update the Advisor software using the steps outlined in “Software Updates” on page 140.
  • Page 150 You can select only one item at this point. If both the BusEngine and the Firmware need to be updated, the update completes the first item and then returns to the above screen so the second update can be performed. If you are running Power cycle Advisor to complete the update. ® ®...

  • Page 151: Manual Updates To Busengine And Firmware

    USBAdvisor User Manual Chapter 12: Updates Manual Updates to BusEngine and Firmware You can manually update the Advisor Firmware and/or BusEngine by completing the following steps: Step 1 Select Analyzer under Setup on the Menu Bar to display the Analyzer Setup...

  • Page 152: Manually Upgrading The Firmware

    Step 3 Unplug the USB cable from the back of the Analyzer box and then reinsert it so the new Firmware update can take effect. Resetting the Analyzer Clicking the Reset Analyzer button is equivalent to power cycling the Advisor Analyzer. LeCroy Corporation...

  • Page 153: License Information

    LeCroy website. If your license expires, you must obtain a license key from LeCroy (refer to the contact information at the back of this manual.) After you obtain a license key, follow these steps to install it: Step 1 From the Help menu, select Update License to display the Update License dialog box.
  • Page 154 Chapter 12: Updates USBAdvisor User Manual LeCroy Corporation...

  • Page 155: Appendix A Legacy Script Decoding

    USBAdvisor User Manual Appendix A: Legacy Script Decoding Appendix A: Legacy Script Decoding Earlier LeCroy USB Analyzers used .REQ and .DSC script files to decode class and vendor requests. • .REQ stands for Requests. • .DSC stands for Descriptors. This method uses fixed definitional structures.
  • Page 156 Appendix A: Legacy Script Decoding USBAdvisor User Manual LeCroy Corporation...

  • Page 157: Appendix B China Restriction Of Hazardous Substances

    USBAdvisor User Manual Appendix B: China Restriction of Hazardous Substances Table Appendix B: China Restriction of Haz- ardous Substances Table The following tables are supplied in compliance with China's Restriction of Hazardous Substances (China RoHS) requirements: LeCroy Corporation...
  • Page 158 Appendix B: China Restriction of Hazardous Substances Table USBAdvisor User Manual LeCroy Corporation...

  • Page 159: How To Contact Lecroy

    (the "Warranty Period"). You may also complete your registration form via the internet by visiting http://www.catc.com/support/register/. The Warranty Period commences on the earlier of the date of delivery by LeCroy of a Product to a common carrier for shipment to you or to LeCroy's authorized representative from whom you purchase the Product.
  • Page 160 LeCroy's then current repair policy. If you chose not to have the Product repaired by LeCroy, you agree to pay LeCroy for the cost to return the Product to you and that LeCroy may require payment in advance of shipment.
  • Page 161 Product and notifies LeCroy of the transfer. You may notify LeCroy of the transfer by writing to Technical Support at LeCroy, 3385 Scott Blvd., Santa Clara, CA 95054 USA or by email at: support@catc.com. Please include the transferring owner's name and address, the name and address of the new owner, the date of transfer, and the Product serial number.
  • Page 162 Limited Hardware Warranty USBAdvisor User Manual LeCroy Corporation...

  • Page 163: Index

    Auto-merge 2 Channel Trace Files option 117 command 15 window 15 About Advisor command 139 About USB Advisor window 139 Babble End Violation error 124 Abstract Control Model .dec file 85 Babble Start Violation error 124 AC connector module 10...
  • Page 164 10, 11, 12 Class request, decode 102 types 23 Class/Vendor decoding 89 contents of package 8 Class/Vendor Decoding field 89 Continue uploading command 136 Class/Vendor Decoding Groups menu 90 Control Transfer 54, 100 Control Transfer field 100 LeCroy Corporation...
  • Page 165 89 diagnosis 23 dimensions 11 Direct Line Control Model .dec file 85 direction search 36, 74 Direction field 92 directory application 24 Disable External Trigger Output command 133 disk space 8 display 8 configuration name 77 trace 4 LeCroy Corporation...
  • Page 166 Expand Data menu 47 dialog box 97, 99 Expand Packet Data Fields by default option 76 tab 97, 99 Expand Script-Based Decoded Info by default op- Endpoints tion 76 tab 92 expand transactions 53 Expand Transfer menu 55 expand transfers 55 LeCroy Corporation...
  • Page 167 77 SOF packets 49 Format option 48 Hierarchy Lines option 76 Format section 81 High Speed port 9 formats host date 80 compatibility 12 Display Options 80 computer requirements 8 number 80 Host field 89 text 80 LeCroy Corporation...
  • Page 168 132 Legend 62 graph areas 114 lengths menu bar 28 cables 23 pop-up 76 letter 151 view settings 112 Level Hiding tab 82 Merge Trace Files command 137 merging trace files 117, 137 Micro Frames 2 Microframes 41 LeCroy Corporation...
  • Page 169 10 Packet Identifiers event group 120 Power .dec file 86 Packet IDs Power LED 11 go to 68 Pre/Post Trigger option 62 Packet menu 42 Printer .dec file 86 packet too late 124 printer.req file 147 processors 8 LeCroy Corporation...
  • Page 170 Restore Factory Presets option 77 Manual Trigger 116 rework area 13 memory 11 Right click cell context menu option 76 progress 34 RPipe field 96, 98 status 35 RPipes 96, 98 type 116 endpoints 97 USB traffic 25 LeCroy Corporation...
  • Page 171 Support page 140 setup switches 11 hardware 22 system system 21 components 8 Setup menu 28 setup 21 shortcut keys 38 shortcuts 38 show markers 112 technical support 151 plumb line 112 Telephone Control Model .dec file 85 LeCroy Corporation...
  • Page 172 143 Traffic Summary report 109 software 140 transactions 50, 59 UPLD indicator 9 decoded 52 upload split 54 abort 35 Transactions event group 125 partial 35 Transactions View 50 upload LED 9 Transfer View 54 Uploading LED 11 LeCroy Corporation...
  • Page 173 View Fields for ... Class Requests text box 102 View Fields for ... Endp text box 103 View Fields for Standard Request text box 101 View menu 30 View Options dialog box 113 View Settings button 112 menu 112 Viewing Level 77 voltages 23 LeCroy Corporation...
  • Page 174 Index USBAdvisor User Manual LeCroy Corporation...

Table of Contents