Teledyne Detective User Manual
Computer Access Technology
Corporation
2403 Walsh Avenue, Santa Clara, CA 95051-1302 Tel: +1/408.727.6600 Fax: +1/408.727.6622
CATC™ Detective
™
USB Bus & Protocol Analyzer
User’s Manual
Copyright 1996–1998, Computer Access Technology Corporation (CATC)
CATC, Inspector, Detective,
and
Traffic Generator
Version 2.21
1 October 1998
are trademarks of Computer Access Technology Corporation
CATC CATC Detective User’s Manual Version 2.21
TABLE OF CONTENTS
1. INTRODUCTION....................................................................................................................................................1
1.1 USB O
VERVIEW.......................................................................................................................................................1
2. CATC DETECTIVE USB BUS & PROTOCOL ANALYZER ...........................................................................2
2.1 G
ENERAL..................................................................................................................................................................2
2.2 CATC D
2.3 T
2.4 T
ETECTIVE SYSTEM COMPONENTS...............................................................................................................2
HE CATC DETECTIVE ISA CARD CONFIGURATION................................................................................................3
HE DETECTIVE USB PROBE ...................................................................................................................................4
2.4.1 External Triggers .............................................................................................................................................5
2.4.1.1 The Manual Trigger Push-Button ...............................................................................................................................5
2.4.1.2 TRG Signal Generation...............................................................................................................................................5
2.5 SYSTEM SETUP..........................................................................................................................................................6
2.5.1 PC Connection .................................................................................................................................................6
2.5.2 USB Connection...............................................................................................................................................7
3. SOFTWARE INSTALLATION (ALL VERSIONS) ............................................................................................8
3.1 G
ENERAL..................................................................................................................................................................8
3.1.1 Standard Version (Win 3.1 & Win 95) .............................................................................................................9
3.1.2 Standard Version (Win NT)..............................................................................................................................9
3.2 R
UNNING THE SOFTWARE.......................................................................................................................................10
4. THE CATC DETECTIVE SOFTWARE.............................................................................................................10
4.1 G
ETTING STARTED..................................................................................................................................................10
4.2 T
HE MAIN DISPLAY WINDOW.................................................................................................................................10
4.2.1 The Status Bar................................................................................................................................................11
4.2.1.1 Device Class Status...................................................................................................................................................12
4.2.1.2 Recording Options Status .........................................................................................................................................12
4.2.1.3 Search Status.............................................................................................................................................................12
4.2.1.4 Recording Status .......................................................................................................................................................12
4.2.2 USB Traffic Error Displays............................................................................................................................13
4.3 T
HE FILE MENU......................................................................................................................................................13
4.3.1 Open...............................................................................................................................................................14
4.3.2 Close ..............................................................................................................................................................14
4.3.3 Save As...........................................................................................................................................................14
4.3.4 Save As Text... ................................................................................................................................................14
4.3.5 Edit Comment.................................................................................................................................................14
4.3.6 Printer Setup... ...............................................................................................................................................15
4.3.7 Print... ............................................................................................................................................................15
4.3.8 Exit.................................................................................................................................................................15
4.4 T
HE SETUP MENU...................................................................................................................................................15
4.4.1 Recording Options... ......................................................................................................................................16
4.4.1.1 Trigger Selection.......................................................................................................................................................16
4.4.1.1.1 Manual Trigger .................................................................................................................................................17
4.4.1.1.2 External Start Trigger .......................................................................................................................................17
4.4.1.1.3 External Stop Trigger........................................................................................................................................17
4.4.1.2 Idle State Recording Selection..................................................................................................................................17
4.4.1.3 Connection Speed Selection .....................................................................................................................................18
4.4.1.4 File Name..................................................................................................................................................................18
4.4.1.5 Save... (Recording Options)......................................................................................................................................18
4.4.1.6 Load... (Recording Options) .....................................................................................................................................18
4.4.1.7 Save As Default (Recording Options).......................................................................................................................18
4.4.1.8 Buffer Size ................................................................................................................................................................19
4.4.2 Display Options..............................................................................................................................................19
4.4.2.1 View Type.................................................................................................................................................................20
4.4.2.2 Data Presentation ......................................................................................................................................................20
Page i
CATC CATC Detective User’s Manual Version 2.21
4.4.2.3 Field Formats ............................................................................................................................................................21
4.4.2.4 Hidden Elements.......................................................................................................................................................22
4.4.2.5 Field Colors ..............................................................................................................................................................23
4.4.2.6 Save... (Display Options) ..........................................................................................................................................23
4.4.2.7 Load... (Display Options)..........................................................................................................................................23
4.4.2.8 Save As Default (Display Options)...........................................................................................................................23
4.4.2.9 Display Configuration Name ....................................................................................................................................24
4.5 THE RECORD MENU ...............................................................................................................................................24
4.5.1 Start................................................................................................................................................................24
4.5.2 Stop ................................................................................................................................................................24
4.6 T
HE REPORT MENU................................................................................................................................................25
4.6.1 File Information .............................................................................................................................................25
4.6.2 Timing Calculations.......................................................................................................................................26
4.6.3 Packet Error Summary...................................................................................................................................28
4.6.4 Transaction Error Summary ..........................................................................................................................28
4.6.5 Traffic Summary.............................................................................................................................................29
4.6.6 Saving Summaries as Text Files.....................................................................................................................30
4.7 T
HE VIEW MENU....................................................................................................................................................31
4.7.1 Add View ........................................................................................................................................................31
4.7.2 Hide SOF .......................................................................................................................................................31
4.7.3 Hide NAKed Transactions..............................................................................................................................32
4.7.4 Zoom In..........................................................................................................................................................32
4.7.5 Zoom Out .......................................................................................................................................................32
4.7.6 Set Current Zoom Value as Default ...............................................................................................................32
4.8 T
HE DECODE MENU ...............................................................................................................................................32
4.8.1 Select Device Class... .....................................................................................................................................32
4.8.2 Decode Device Request..................................................................................................................................33
4.8.2.1 Decoded Standard Requests......................................................................................................................................35
4.8.2.2 Decoded Hub Class Requests....................................................................................................................................40
4.8.2.3 Decoded Requests for Other Device Classes ............................................................................................................42
4.9 THE SEARCH MENU................................................................................................................................................42
4.9.1 Go to Packet...................................................................................................................................................43
4.9.2 Go To Marker.................................................................................................................................................43
4.9.3 Find................................................................................................................................................................43
4.9.3.1 Find PID ...................................................................................................................................................................45
4.9.3.2 Find Error Condition.................................................................................................................................................46
4.9.3.3 Find Frame................................................................................................................................................................46
4.9.3.4 Find ADDR and ENDP.............................................................................................................................................47
4.9.3.5 Find Static Bus Event................................................................................................................................................47
4.9.3.6 Find Data String........................................................................................................................................................48
4.9.4 Next ................................................................................................................................................................48
4.10 T
HE WINDOW MENU............................................................................................................................................48
4.11 T
HE HELP MENU ..................................................................................................................................................48
4.12 T
HE DATA FIELD VIEW POP-UP MENU.................................................................................................................49
4.13 T
HE PACKET MARKER & TIMING POP-UP MENUS................................................................................................49
4.14 T
HE DEVICE DECODING POP-UP MENUS..............................................................................................................50
4.15 T
HE I/O OPERATION POP-UP MENU.....................................................................................................................51
5. HOW TO CONTACT CATC ...............................................................................................................................53
6. WARRANTY AND LICENSE..............................................................................................................................53
Page ii
CATC CATC Detective User’s Manual Version 2.21
1. INTRODUCTION
The CATC DETECTIVE USB Bus & Protocol Analyzer is an invaluable development and test
tool for Universal Serial Bus designers. When connected to any point in a USB network, the
Detective USB analyzer, like the CATC Inspector advanced USB analyzer, continuously
monitors all bus activities and alerts the user to any abnormal bus conditions in an easy to use,
menu driven, Windows software environment.
Detective Features:
• USB bus & protocol analyzer, compatible with the CATC Inspector advanced USB analyzer
and the CATC Traffic Generator
• external, high impedance probe connects non-intrusively to any branch of a USB system
• captures both full- and low-speed USB traffic
• sophisticated software analyzes all bus transactions, identifies and highlights abnormal bus
conditions, and decodes generic device class, hub class, and other standard device class
messages
• easy to use Windows environment (Win 3.1, Win 95, and Win NT)
• tested for compliance with the USB specification
• one year warranty and hot-line customer support
• non-recording, view-only version of software available (no hardware required)
This document explains how to install the CATC Detective hardware and software in your PC. It
also explains how to connect and activate the analyzer in a USB system environment.
1.1 USB Overview
USB is an open industry standard, providing a simple and inexpensive way to connect up to 127
devices to a single computer port. Keyboards, mice, tablets, digitizers, scanners, bar-code
readers, modems, printers, and more can all run at the same time. USB devices plug into any
platform that supports the standard, from notebooks to desktop PCs to workstations.
USB is a dynamically reconfigurable serial bus with an elementary data rate of 12,000,000
bits/sec, based on off the shelf, low cost micro-controller technology. Its modular layered
software protocol supports sophisticated device drivers and application programs.
Please refer to the USB Specifications for details on the USB protocol. The USB specifications
are available from the USB Implementers Forum at:
USB IF
M/S JF2-51 Tel: +1/ 503 264 0590
2111 NE 25th Avenue Fax: +1/ 503 693 7975
Hillsboro, OR 97124 Web: http://www.usb.org/
Page 1
CATC CATC Detective User’s Manual Version 2.21
2. CATC DETECTIVE USB BUS & PROTOCOL ANALYZER
2.1 General
The CATC Detective USB Bus & Protocol Analyzer captures, analyzes, and saves USB traffic
data, based on a user-specified trigger signal, which can be supplied manually, programmatically,
or via external hardware.
The Detective USB analyzer is designed
USB System
Under Test
USB Test
Probe
CATC
Detective
USB Analyzer
System
D-); it translates the raw differential data into a single NRZI bit stream, samples the data with the
recovered synchronized clock, and stores the resulting bit stream on disk. The analyzer also
detects and reports the static bus conditions Suspend, Resume, Reset, and Idle.
to turn a 386/486 or Pentium class PC
into a USB test station. The PC itself does
not need to have a USB interface. The
Detective package includes an add-in ISA
card, an external Detective Probe, USB
and Probe cables, an external trigger cable
set, a sophisticated software program
running under Microsoft Windows (3.1,
95, and NT versions), and comprehensive
product documentation (including on-line
help).
The Detective analyzer uses an external
high impedance USB Probe to connect to
and monitor the two USB wires (D+ and
The Detective software scans the collected data and displays it in several meaningful formats.
The user can view the data as a continuous stream, or as complete transactions. In continuous
mode, the analyzer fills the entire display line with data; in transaction mode, each line is
dedicated to one bus transaction, such as token, data, or handshake.
The Detective software provides a powerful search function that enables investigation of
particular bus events, with the software identifying and highlighting specific events such as Bad
PID, Undefined PID, Bad CRC, Bad Stuffing Bits, Missing Frames, etc.
In addition to immediate analysis, the user can print any part of the data and save all or selected
portions of the data on disk for later viewing. The program also provides a variety of timing
information.
The Detective USB analyzer comes with a one year warranty and hot-line customer support.
2.2 CATC Detective System Components
The CATC Detective package includes the following components:
• a CATC Detective ISA add-in card for the PC (approximately 4.2×7-inch printed circuit
board with a DB15 connector in a mounting bracket on the side)
• an external, non-intrusive USB Detective Probe (approximately 4.5×2.5×1.5-inch box with a
DB15 connector and two USB connectors)
Page 2
CATC CATC Detective User’s Manual Version 2.21
• a six foot, male-to-male DB15 (15-pin) cable to connect the Probe to the ISA card
• a USB cable
• an external trigger cable-set to connect the Probe to a PC parallel port; this is comprised of
two cables:
• a one foot, 10-pin ribbon cable with a 2×5 header connector on one end and a 25-pin
DB25 connector on the other
• a three foot 25-pin cable with DB25 connectors on each end (one male, one female)
• two diskettes with the associated application software program, for operation under Microsoft
Windows 95, Windows 3.1, or Windows NT
• comprehensive product documentation, including on-line help
2.3 The CATC Detective ISA Card Configuration
The CATC Detective ISA card uses one of four user defined PC I/O address ranges to
communicate with the Detective software. The 2×2 header jumper block, JP1, located at the top
of the board next to the 48MHz crystal oscillator, allows selection of one of the four designated
I/O address ranges. To select a specific I/O address range, position the two jumpers between pin
pairs 1/2 and 3/4 as follows:
JP1
2
1
0x250 to 0x25F
4
3
JP1
2
1
0x260 to 0x26F
JP1
4
3
2
1
0x350 to 0x35F
4
3
JP1
2
1
0x360 to 0x36F
4
3
I/O Address selection jumpers
The card is shipped pre-configured with both jumpers installed for addresses 0x250 to 0x25F.
After system installation and startup, the CATC Detective software will attempt to communicate
with the board. If required, the software may request changing of the jumpers to a different
setting. Any of the other three settings above can be tried by removing one or both of the JP1
jumpers. After changing the jumper settings, restarting the Detective software will retry
communication with the board. The software will configure itself automatically to the selected
jumper settings.
The CATC Detective card uses no interrupt request (IRQ) lines on the ISA bus; no IRQ setting is
required.
Note: If none of the four I/O address range settings works properly, please contact CATC.
Page 3
CATC CATC Detective User’s Manual Version 2.21
TRIG
C
US
G
2.4 The Detective USB Probe
The Detective USB probe is an external box, about 4.5×2.5×1.5 inches, with a female DB15
connector on one side and two USB connectors (one A-type and one B-type) on the other. The
probe is designed to connect to any point in the USB system as a passive listening device,
without interfering with bus traffic. See the System Setup section for details on connecting the
Probe to a system.
DB15 connector
P
TRI
i
USB
Type “A” Type “B”
USB connectors
B
In addition to physically connecting the analyzer to the USB system, the Probe includes special
circuitry to assist in generating an external trigger signal. Two components are associated with
this external trigger mechanism:
• The 10 pin trigger header
• The TRIG push button
Inside the CATC Detective Probe box is a 10-pin external triggering header, arranged in 5 rows
of 2 pins each, and easily accessed through an opening in the protective cover of the Probe. The
triggering header signal pin assignment is detailed below:
GND
TRIG
GND
TRIG is an external trigger input to the CATC Detective system, and is duplicated on 2 of the
pins as marked. This signal is tied through a 4.7kΩ pull-up resistor to Vcc on the Detective ISA
card, and is connected to the input of a FAST logic circuit. To activate the external trigger signal,
it must be pulled to a TTL-low level for at least 8 USB bit times (0.67 microseconds for a full
speed branch and 5.33 microseconds for a low speed branch). When the Detective software is set
to record using an external trigger mode (External Start or External Stop), the low level on this
pin will activate either the start or the end of the recording session.
The TRIG push button is located on top of the Detective Probe box, and can be used to manually
generate the external trigger signal. To activate this feature, the analyzer must be in either the
Page 4
CATC CATC Detective User’s Manual Version 2.21
TRIG
“External Start” or the “External Stop” recording mode. Once one of these recording modes has
begun, the analyzer waits for an external trigger signal to either start or end the recording session.
Manually pushing the TRIG button will assert the external trigger signal and thus affect the
operation.
Note: Early versions of the Detective USB Probe have either two A-type USB connectors or two
A-type USB connectors and one B-type USB connector.
Note: Early versions of the USB Detective Probe have a 2×2 pin header instead of the 5×2 pin
header. This header carries the same TRIG signal described above. The 2×2 triggering
header signals pin assignment is illustrated below:
GND
TRIG
GND
2.4.1 External Triggers
The CATC Detective Probe offers two ways to generate an external trigger to control a recording
session: the “Manual Trigger” push-button, and the “TRG” pin in the Probe Triggering Header.
2.4.1.1 The Manual Trigger Push-Button
The simplest way to generate an external trigger (when enabled in the Recording Options dialog
box) is by manually activating the Manual Trigger push button located on top of the Probe.
2.4.1.2 TRG Signal Generation
In order to view a particular USB event (to determine—for example—how a particular device
behaves during the initialization phase), it is necessary to activate the CATC Detective analyzer
to record the bus activities during a specific time period. If the USB host allows manual control
of the bus traffic, then in theory the CATC Detective recording could be started manually at the
same time. Because of USB speed, correspondingly slow human reaction time, and buffer
memory limitations (1 Mbytes), however, manually coordinating the host actions with the
Detective recording is generally impractical.
A simple solution is to generate a signal in the USB host PC, or in the USB hub or device under
observation, that will be synchronized to the particular event to be recorded. Such a signal can be
generated on the PC by calling a small software routine (see sample code below) that uses a
standard I/O Write command to a specific pin on an available serial or parallel port.
Alternatively, the TRG signal might be generated by programming one of the general I/O ports
on the USB controller in the hub or device.
A short cable connects this (active low) signal to the TRG pin of the Probe Triggering Header.
Page 5
CATC CATC Detective User’s Manual Version 2.21
TRIG Signal Sample software Routine
case IOCTL_START_TRIGGER_RTS:
switch (gTriggerDongle) {
case SERIAL_PORT_TRIGGER_DONGLE:
outp (0x3fc, 00);
break;
case PARALLEL_PORT_TRIGGER_DONGLE:
outp (0x378, 00);
break;
}//switch
break;
case IOCTL_STOP_TRIGGER_RTS:
switch (gTriggerDongle) {
case SERIAL_PORT_TRIGGER_DONGLE:
outp (0x3fc, 02);
break;
case PARALLEL_PORT_TRIGGER_DONGLE:
outp (0x378, 0xFF);
break;
}//switch
break;
2.5 System setup
The Detective is designed to work on any PC with a (16-bit) ISA slot. The PC does not have to
be equipped with a USB interface in order to work with the Detective analyzer. Two steps are
involved in the setup of the system hardware: connecting to the PC and connecting to the USB
system under test.
2.5.1 PC Connection
Turn off the PC power, and plug the Detective ISA card into any (16-bit) ISA slot in the PC’s
motherboard.
Connect the 15-pin cable between the CATC Detective Probe connector and the ISA card. Note
that both the USB Detective Probe and the USB Detective card use the same DB15 female
connector, which is similar to the standard PC graphic display VGA connector.
When external triggering initiation from the USB host software is desired, connect the external
trigger cable set between the USB Detective Probe header and the PC parallel port as follows
(see diagrams below):
• Plug the 10-pin ribbon cable connector (included with the USB Detective package) into the
2×5 header of the USB Detective Probe.
Page 6
CATC CATC Detective User’s Manual Version 2.21
C
US
G
• Connect the DB25 male connector on the other side of the ribbon cable to the DB25 female
connector of the 25-pin cable (included with the USB Detective package).
• Connect the DB25 male connector on the other side of the 25-pin cable to the parallel port of
the PC running the USB host software.
P
TRI
USB
To Parallel
Port
B
Once the Probe trigger pin is connected to the parallel port, a simple write command to the
parallel port will trigger the USB Detective recording process (see sample software routine
above).
The two trigger pins on the Probe header are shorted together. The external trigger kit cables
connect one of the trigger pins to the parallel port D2 signal, and the other pin to the parallel port
D3 signal (pins 4 and 5 of the DB25 connector). The Detective trigger is activated by generating
a negative pulse simultaneously on both D2 and D3 for at least 8 USB bit times (0.67
microseconds for a full- branch and 5.33 microseconds for a low-speed branch).
DB25/NC
D2 and D3
DB25/Pin 5 - D3
DB25/Pin 22 - GND
DB25/Pin 4 - D2
PC power may then be restored.
2.5.2 USB Connection
Locate the CATC Detective Probe near the USB system under test.
In the USB system, at a point where USB bus traffic is to be analyzed, open a connection and
reconnect the open link through the CATC Detective Probe as follows:
• Connect a USB cable between one side of the open connection and one of the two
USB receptacles on the CATC Detective Probe (the two receptacles are functionally
identical).
• Connect another USB cable between the other side of the open USB connection and
the other USB receptacle of the CATC Detective Probe.
Note: CATC recommends the use of USB cables shorter than 2 meters (6 feet) for all
connections to the USB Detective Probe.
Page 7
CATC CATC Detective User’s Manual Version 2.21
Note: The B-type USB connector on the Detective Probe is normally connected to the upstream
USB port, while the A-type connector is connected to the downstream port.
Note: Early versions of the USB Detective Probe do not contain the B-type USB receptacle.
These Probes have only the two A-type USB connectors..
The CATC Detective Bus & Protocol Analyzer hardware is now ready for operation.
3. SOFTWARE INSTALLATION (ALL VERSIONS)
3.1 General
The CATC Detective software is available in four different versions:
• standard version for Windows 3.1 and Windows 95
• standard version for Windows NT
• view-only version for Windows 3.1, Windows 95, and Windows NT (This version does not
require the USB Detective hardware; it is used only for viewing and analyzing previously
created USB traffic files. Information on installing and using this version can be found in the
CATC Inspector Advanced USB Bus & Protocol Analyzer User’s Manual.)
• demo version for Windows 3.1, Windows 95, and Windows NT (This version also does not
require the Detective USB hardware; it is made available for product demonstration purposes,
and can be used only for viewing and analyzing a specific set of USB traffic files.
Information on installing and using this version can be found in the CATC Inspector
Advanced USB Bus & Protocol Analyzer User’s Manual.)
The software diskette label identifies the program version. To install the CATC Detective
software, run the installation program from the Detective software diskette, and follow the
instructions on the screen. Note that to install the standard version on Windows NT systems, it is
necessary to log in as administrator.
• For Windows 3.1 and 95 run the ‘install.exe’ installation program.
• For Windows NT run the ‘setup.exe’ installation program.
The installation program creates a program group for the Detective application once it has
finished copying all the files. The icon for an Uninstall program is also placed in the program
group. This Uninstall program can be run later, if desired, to remove the CATC Detective
software from the system.
To run the software, double-click on the Detective icon in the program group created during
installation. Section 4 describes the software in detail.
Page 8
CATC CATC Detective User’s Manual Version 2.21
3.1.1 Standard Version (Win 3.1 & Win 95)
The installation program copies the following files to the PC’s hard drive.
To the \USBDTCTV directory (or that otherwise specified by the user):
• USBDTCTV.EXE executable code of the CATC Detective program
• USBDTCTV.DLL DLL for the CATC Detective program
• CLS_HID.DLL DLL for HID Class device decoding
• USBDTCTV.HLP CATC Detective help file
• DEFAULT.OPT default DISPLAY function settings
• DEMO.USB sample USB traffic file
to the \WINDOWS\SYSTEM directory:
• USBDTCTV.386 Windows CATC Detective virtual device driver
• CTL3D.DLL Windows 3D Control Library
• CTL3DV2.DLL Windows 3D Control Library
to the \WINDOWS directory:
• CLSDECOD.INI USB Device Class decoding initialization
In the \WINDOWS\SYSTEM.INI file, the installation program adds a reference to the CATC
Detective driver in the [386Enh] section.
device=usbdtctv.386
3.1.2 Standard Version (Win NT)
The installation program copies the following files to the PC’s hard drive.
To \Program Files\CATC\Detective directory (or that otherwise specified by the user):
• USBDTCTV.EXE executable code of the CATC Detective program
• USBDTCTV.DLL DLL for the CATC Detective program
• CLS_HID.DLL DLL for HID Class device decoding
• USBDTCTV.HLP CATC Detective help file
• DEFAULT.OPT default DISPLAY function settings
• DEMO.USB sample USB traffic file
to the \WINDOWS\SYSTEM32 directory:
• CTL3D32.DLL Windows 3D Control Library
to the \WINDOWS directory:
• CLSDECOD.INI USB Device Class decoding initialization
to the \WINDOWS\SYSTEM32\DRIVERS directory:
• USBDTCTV.SYS Windows NT CATC Detective device driver
Page 9
CATC CATC Detective User’s Manual Version 2.21
The installation program modifies the system registry to install the CATC Detective driver.
3.2 Running The Software
The CATC Detective software is a Windows application, and can be run under Windows 3.1,
Windows 95, and Windows NT. To start the program, double-click on the file name (located
with the Explorer or equivalent service), or on the CATC Detective icon created during the
software installation.
The program will start with the main window active.
4. THE CATC DETECTIVE SOFTWARE
4.1 Getting Started
The CATC Detective Bus & Protocol Analyzer continuously monitors all USB activity. At the
operator’s discretion, the analyzer will record a snap shot view of the bus traffic. It will store the
data in a file (initially named “data.usb”) on the system hard drive and display the information on
the screen. Once the information is captured and is displayed, it can be viewed and analyzed
using a variety of tools. The data can be stored permanently, and conveniently viewed on any PC
equipped with the CATC Detective software. A view-only version of the software permits
subsequent viewing without the need for any Detective hardware.
4.2 The Main Display Window
The CATC Detective analyzer’s main display incorporates the following set of Windows pulldown menus:
• File
• Setup
• Record
• Report
• View
Clicking on any of these menus will expand it, offering various function selections. Subsequent
sections of this document describe the operation of each menu item.
• Decode
• Search
• Window
• Help
Page 10
CATC CATC Detective User’s Manual Version 2.21
Additionally, several of the most frequently used functions can be activated by specific icons
located on the toolbar immediately below the pull-down menus. Each icon’s functionality is
identified in the left portion of the status bar (at the bottom of the window) when the pointing
device cursor moves over the icon. Finally, several operations can be invoked by clicking directly
on the affected packet fields (using pop-up menus).
4.2.1 The Status Bar
The status bar is located at the bottom of the Detective main display window. The functionality
of each icon and menu item is briefly described in the bar when the pointing device cursor moves
over the icon/item. At other times, the bar is divided into three segments, used to display the
following:
Page 11
CATC CATC Detective User’s Manual Version 2.21
4.2.1.1 Device Class Status
The center segment displays the currently selected USB Device Class, used when displaying
decoded Device Class requests. As described under Recording Status, below, this information
will be temporarily overwritten during recording activity.
4.2.1.2 Recording Options Status
The center segment displays the current Recording Options, consisting of trigger state
(“Manual”, “ExtStart”, or “ExtStop”), idle recording state (“with idle” or “no idle”), and
connection speed (“FS” or “LS”, for full- and low-speed respectively). As described under
Recording Status, below, this information will be temporarily overwritten during data-saving
operations.
4.2.1.3 Search Status
The rightmost segment displays the current search direction (forward or backward) and start
position (from start/end of file, or from last match).
4.2.1.4 Recording Status
During recording activity, the leftmost segment temporarily displays the current recording status.
When the user activates the Record function, this segment will flash one of the following
messages (depending on the selected Recording Options):
Recording...
Awaiting trigger to start recording...
Recording; awaiting trigger to stop...
After the Detective stops recording, the flashing message changes to “Saving data...”, which is a
multiphase operation. In the first phase, the software scans the recorded data stream, computing
the packet boundaries; during this phase, the center segment of the status bar displays the packet
number currently being processed by the software. In the second phase, the traffic data is copied
to disk, using the default file name “data.usb” (overwriting any previous version of this file).
When the software has finished saving the data, the recorded data file appears in the main display
window and the recording status window is cleared. The display will begin with the first packet
in the traffic file.
Page 12
CATC CATC Detective User’s Manual Version 2.21
4.2.2 USB Traffic Error Displays
The analyzer detects a variety of USB traffic errors, and displays them as follows:
Packet #3 above has an invalid PID value; the PID value field is colored red, and the rest of the
packet is marked as “Invalid Data”. Packets #4 and #5 have incorrect CRCs; the CRC value field
is colored red, as are the preceding fields associated with the CRC value. Packet #6 has bit
stuffing errors; the affected field is marked as “Invalid Data”, with any byte containing a bit
stuffing error bracketed with exclamation marks (“!”). When a bit stuffing error occurs, it is no
longer possible to determine the correct data byte boundaries; thus all affected data (through the
end of the packet) are collected into a field labeled “Invalid Data”, displaying the raw data
received, from left to right (regardless of the order specified in the Field Format Display
Options).
A related situation is the special case of Sync fields. Occasionally, the analyzer does not
synchronize with the data stream until part way through the Sync token; such situations are
marked by replacing the missed leading zero bits with underscore (“_”) characters. This situation
is not considered an error, but the analyzer reports only bits it has actually acquired.
In addition to packet errors, the Detective analyzer also detects a wide variety of transaction
errors. Reporting of these and other errors is discussed in section 4.6 (“The Report Menu”).
4.3 The File Menu
The file menu behaves as a standard Windows File menu, allowing the operator to open existing
analyzer traffic data files from previous sessions, save the data file from the current session,
create/edit data file comments, and print all or selected portions of the selected data file.
Page 13
CATC CATC Detective User’s Manual Version 2.21
The File menu includes the following functions:
4.3.1 Open...
Open an existing, previously recorded “*.usb” file (i.e., a CATC Bus & Protocol analyzer USB
traffic file).
4.3.2 Close
Close an open traffic data file.
4.3.3 Save As...
Save the currently displayed USB traffic data file with a newly-specified file name (more
correctly, Rename... the file). If this function is not used following the capture of new data
(which is recorded in the default file “data.usb”), the next recording will overwrite it. Any file
name can be specified, though use of the “.usb” extension is recommended (see “Open”, above);
if no extension is specified, “.usb” will be added by default.
4.3.4 Save As Text...
Save all or a selected range of the current USB traffic data file in a text format for further
viewing, analysis, and/or printing. Activating this function opens up the following selection box:
Data are saved according to the Display Options settings for the current view. The saved file can
be opened with any standard text editor.
4.3.5 Edit Comment
Create, view, and/or edit the 50-character comment field associated with each USB traffic data
file.
Page 14
Loading...