How it Works
Teledyne
Loading...
Inspector
User Manual
64 pgs274.22 Kb0

Teledyne Inspector 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™ Inspector
™
Advanced USB Bus & Protocol Analyzer
User’s Manual
Copyright 1997, 1998, Computer Access Technology Corporation (CATC)
CATC, Inspector, Detective,
and
Traffic Generator
Version 2.31
are trademarks of Computer Access Technology Corporation
CATC CATC Inspector User’s Manual Version 2.31
TABLE OF CONTENTS
1. INTRODUCTION....................................................................................................................................................1
1.1 USB O
VERVIEW.......................................................................................................................................................2
2. CATC INSPECTOR ADVANCED USB BUS & PROTOCOL ANALYZER....................................................2
2.1 G
ENERAL..................................................................................................................................................................2
2.2 CATC I
2.3 T
NSPECTOR SYSTEM COMPONENTS................................................................................................................3
HE INSPECTOR USB BOX .......................................................................................................................................4
2.3.1 Front Panel Description ..................................................................................................................................4
2.3.2 Back Panel Description ...................................................................................................................................4
2.3.3 External Triggers .............................................................................................................................................5
2.3.3.1 The Manual Trigger Push-Button ...............................................................................................................................5
2.3.3.2 EXT TRG Signal Generation......................................................................................................................................5
2.4 THE EXTERNAL INTERFACE BREAKOUT BOARD.......................................................................................................7
2.5 S
YSTEM SETUP..........................................................................................................................................................7
2.5.1 Parallel Port Connection .................................................................................................................................8
2.5.2 USB Connection...............................................................................................................................................9
2.5.3 Power Connection............................................................................................................................................9
3. SOFTWARE INSTALLATION (ALL VERSIONS) ............................................................................................9
3.1 G
ENERAL..................................................................................................................................................................9
3.1.1 Standard Version (Win 3.1 & Win 95) ...........................................................................................................10
3.1.2 Standard Version (Win NT)............................................................................................................................11
3.1.3 “CATC USB Trace Viewer” Version (Win 3.1, Win 95, & Win NT)..............................................................11
3.2 R
UNNING THE SOFTWARE.......................................................................................................................................12
4. THE CATC INSPECTOR SOFTWARE.............................................................................................................12
4.1 G
ETTING STARTED..................................................................................................................................................12
4.2 T
HE MAIN DISPLAY WINDOW.................................................................................................................................12
4.2.1 The Status Bar................................................................................................................................................13
4.2.1.1 Device Class Status...................................................................................................................................................14
4.2.1.2 Recording Options Status .........................................................................................................................................14
4.2.1.3 Search Status.............................................................................................................................................................14
4.2.1.4 Recording Status .......................................................................................................................................................14
4.2.2 USB Packet Error Displays ...........................................................................................................................15
4.3 T
HE FILE MENU......................................................................................................................................................15
4.3.1 Open...............................................................................................................................................................16
4.3.2 Close ..............................................................................................................................................................16
4.3.3 Save As...........................................................................................................................................................16
4.3.4 Save As Text... ................................................................................................................................................16
4.3.5 Edit Comment.................................................................................................................................................16
4.3.6 Printer Setup... ...............................................................................................................................................17
4.3.7 Print... ............................................................................................................................................................17
4.3.8 Exit.................................................................................................................................................................17
4.4 T
HE SETUP MENU...................................................................................................................................................18
4.4.1 Recording Options... ......................................................................................................................................18
4.4.1.1 Trigger Selection.......................................................................................................................................................19
4.4.1.1.1 Manual Trigger .................................................................................................................................................19
4.4.1.1.2 External Start Trigger .......................................................................................................................................19
4.4.1.1.3 External Stop Trigger........................................................................................................................................19
4.4.1.1.4 Event Trigger....................................................................................................................................................19
4.4.1.1.4.1 Packet Events ...........................................................................................................................................20
4.4.1.1.4.2 Error Events..............................................................................................................................................22
4.4.1.1.4.3 Static Events.............................................................................................................................................23
4.4.1.1.4.4 Post-Trigger Recording ............................................................................................................................23
4.4.1.1.4.5 External Event Trigger .............................................................................................................................23
i
CATC CATC Inspector User’s Manual Version 2.31
4.4.1.2 Idle State Recording Selection..................................................................................................................................24
4.4.1.2.1 User Input Data Recording ...............................................................................................................................24
4.4.1.3 Connection Speed Selection .....................................................................................................................................25
4.4.1.4 File Name..................................................................................................................................................................25
4.4.1.5 Save... (Recording Options)......................................................................................................................................25
4.4.1.6 Load... (Recording Options) .....................................................................................................................................25
4.4.1.7 Save As Default (Recording Options).......................................................................................................................25
4.4.1.8 Buffer Size ................................................................................................................................................................25
4.4.2 Display Options..............................................................................................................................................26
4.4.2.1 View Type.................................................................................................................................................................27
4.4.2.2 Data Presentation ......................................................................................................................................................27
4.4.2.3 Field Formats ............................................................................................................................................................28
4.4.2.4 Hidden Elements.......................................................................................................................................................28
4.4.2.5 Field Colors ..............................................................................................................................................................29
4.4.2.6 User Input Data.........................................................................................................................................................30
4.4.2.7 Save... (Display Options) ..........................................................................................................................................30
4.4.2.8 Load... (Display Options)..........................................................................................................................................30
4.4.2.9 Save As Default (Display Options)...........................................................................................................................31
4.4.2.10 Display Configuration Name ..................................................................................................................................31
4.5 THE RECORD MENU ...............................................................................................................................................31
4.5.1 Start................................................................................................................................................................31
4.5.2 Stop ................................................................................................................................................................31
4.6 T
HE REPORT MENU................................................................................................................................................32
4.6.1 File Information .............................................................................................................................................32
4.6.2 Timing Calculations.......................................................................................................................................33
4.6.3 Packet Error Summary...................................................................................................................................35
4.6.4 Transaction Error Summary ..........................................................................................................................35
4.6.5 Traffic Summary.............................................................................................................................................36
4.6.6 Saving Summaries as Text Files.....................................................................................................................37
4.7 T
HE VIEW MENU....................................................................................................................................................38
4.7.1 Add View ........................................................................................................................................................38
4.7.2 Hide SOF .......................................................................................................................................................38
4.7.3 Hide NAKed Transactions..............................................................................................................................39
4.7.4 Zoom In..........................................................................................................................................................39
4.7.5 Zoom Out .......................................................................................................................................................39
4.7.6 Set Current Zoom Value as Default ...............................................................................................................39
4.8 T
HE DECODE MENU ...............................................................................................................................................39
4.8.1 Select Device Class... .....................................................................................................................................39
4.8.2 Decode Device Request..................................................................................................................................40
4.8.2.1 Decoded Standard Requests......................................................................................................................................42
4.8.2.2 Decoded Hub Class Requests....................................................................................................................................47
4.8.2.3 Decoded Requests for Other Device Classes ............................................................................................................49
4.9 THE SEARCH MENU................................................................................................................................................50
4.9.1 Go to Packet...................................................................................................................................................50
4.9.2 Go to Trigger .................................................................................................................................................50
4.9.3 Go To Marker.................................................................................................................................................50
4.9.4 Find................................................................................................................................................................50
4.9.4.1 Find PID ...................................................................................................................................................................52
4.9.4.2 Find Error Condition.................................................................................................................................................53
4.9.4.3 Find Frame................................................................................................................................................................53
4.9.4.4 Find ADDR and ENDP.............................................................................................................................................54
4.9.4.5 Find Static Bus Event................................................................................................................................................54
4.9.4.6 Find Data String........................................................................................................................................................55
4.9.5 Next ................................................................................................................................................................55
4.10 T
HE WINDOW MENU............................................................................................................................................55
4.11 T
HE HELP MENU ..................................................................................................................................................55
4.12 T
HE DATA FIELD VIEW POP-UP MENU.................................................................................................................56
4.13 T
HE PACKET MARKER & TIMING POP-UP MENUS................................................................................................56
4.14 T
HE DEVICE DECODING POP-UP MENUS..............................................................................................................57
ii
CATC CATC Inspector User’s Manual Version 2.31
4.15 THE I/O OPERATION POP-UP MENU.....................................................................................................................58
5. TRIGGERING LOGIC ANALYZERS AND OSCILLOSCOPES BASED ON USB TRAFFIC ...................59
6. HOW TO CONTACT CATC ...............................................................................................................................60
7. WARRANTY AND LICENSE..............................................................................................................................60
iii
CATC CATC Inspector User’s Manual Version 2.31
1. INTRODUCTION
The CATC INSPECTOR Advanced 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 Inspector USB analyzer, like the CATC Detective 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.
Inspector Features:
• advanced USB bus & protocol analyzer, compatible with the CATC Detective USB analyzer
and the CATC Traffic Generator
• operates with portable and desktop PCs, controlled through the parallel port
• enhanced triggering—data recording can be triggered by real-time USB events:
• any possible data field error (PID, CRC, stuff bits)
• any user defined PID or PID combination
• any data pattern (DATA0, DATA1, or DATA0/DATA1)
• any address and endpoint combination with any PID combination
• any frame number
• any static bus event (Reset, Suspend, Resume)
• user defined trigger position allows specification of the pre/post-trigger recording ratio
• provides real time USB event decoding signals on an external interface connector
• records four external signals along with the USB traffic, enabling recording of user-provided
data or timing information along with USB bus traffic
• built-in, 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 & 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 Inspector hardware and software in your PC. It also explains how to connect and activate the analyzer in a USB system environment.
1
CATC CATC Inspector User’s Manual Version 2.31
1.1 USB Overview
The Universal Serial Bus (USB) is an open industry standard, providing a simple and inex­pensive 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.
The 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 soft­ware 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/
2. CATC INSPECTOR ADVANCED USB BUS & PROTOCOL ANALYZER
2.1 General
The CATC Inspector Advanced USB Bus & Protocol Analyzer builds on the success of the CATC Detective USB Bus & Protocol Analyzer; it incorporates the functionality of this earlier product, and adds four major features:
• operation with both portable and desktop PCs
• enhanced triggering—data recording can be triggered by real-time USB events
• provision of real time USB event decoding signals
• recording of four user-provided external signals along with the USB traffic
The Inspector USB analyzer is a stand-alone unit configured and controlled through the PC bi­directional parallel port. It can be used with portable PCs for field service and maintenance, as well as with desktop units in a development lab environment. The analyzer is easily installed, without opening up the PC, by connecting a cable to the parallel port.
The Inspector analyzer includes provisions for on-the-fly detection of, and triggering on, numerous USB events. Such events include specific user-defined PIDs or PID combinations, data patterns, address + endpoint, special USB signaling, and many USB abnormal (error) bus conditions. The Inspector analyzer continuously records the USB data in a wrap-around mode. Upon detection of a triggering event, the analyzer continues to record data (post-trigger) up to a point specified by the user. Real-time event detectors can be individually enabled or disabled to allow triggering on USB events as they happen. This includes pre-defined exception or error
2
CATC CATC Inspector User’s Manual Version 2.31
conditions, and a user-defined set of search conditions. The unit can also be triggered by an externally supplied signal. On-board memory provides a path for externally supplied data or timing information to be recorded along with bus traffic.
Real-time USB event detection information is available via an external DB37 connector, making many control, timing, and recovered signals available externally. These signals can be probed and used by other circuitry.
The Inspector USB analyzer is designed to turn any 386/486 or Pentium class PC (including laptop and notebook as well as desktop PCs) into a USB test station. The PC itself does not need to have a USB interface. The Inspector package includes the stand-alone Inspector box, an External Interface Breakout Board with a 37-pin ribbon cable, USB and parallel port cables, an AC to DC power converter, a sophisticated software program running under Microsoft Windows (3.1, 95, and NT versions), and comprehensive product documentation (including on-line help).
The Inspector analyzer has a built-in high impedance USB probe and several status LEDs. The analyzer monitors the two USB wires (D+ and D-) and translates the raw differential data into a single NRZI bit stream. It 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.
The Inspector 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 Inspector 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 Inspector USB analyzer comes with a one year warranty and hot-line customer support.
2.2 CATC Inspector System Components
The CATC Inspector package includes the following components:
• the stand-alone Inspector USB box
• an External Interface Breakout Board with a 37 pin ribbon cable
• USB and parallel port cables
• an AC to DC power converter
• 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
3
CATC CATC Inspector User’s Manual Version 2.31
t
2.3 The Inspector USB Box
The Inspector USB box has several user-accessible controls on its front and back panels.
2.3.1 Front Panel Description
Manual
Power
The front panel, viewed above, has two USB connectors, three LEDs, and two switches:
• The four-pin A-type and four-pin B-type USB connectors are marked “USB In/Out”.
• The red “ON” LED lights when the box is powered by an external 12V DC @ 1A power
source and the power switch is turned on.
• The yellow “Trigger Event” LED lights when a trigger event has occurred.
• The green “Recording” LED lights when the Inspector analyzer is recording USB traffic.
• The “Manual Trigger” push button can be used to manually start and/or end recording
sessions (when enabled in the Recording Options dialog box).
ON
Trigger
Trigger
Event
Recording
USB In / Out
2.3.2 Back Panel Description
The back panel has three connectors:
Enhanced Parallel Por
• The +12V DC @ 1A input power connector, marked “9–15V DC” (Earlier versions of this
product are marked “9V DC”, but are equivalent in capability).
• A 25-pin parallel port connector, marked “Enhanced Parallel Port”.
• A 37-pin external interface connector, marked “Data In/Out”.
Data In / Out 9–15V
4
CATC CATC Inspector User’s Manual Version 2.31
2.3.3 External Triggers
The CATC Inspector box offers two ways to generate an external trigger to control a recording
session: the “Manual Trigger” push-button, and the “EXT TRG” pin on the External Interface Breakout Board.
2.3.3.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 the front panel of the Inspector box.
2.3.3.2 EXT 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 Inspector 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 Inspector 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 Inspector 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 EXT 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 EXT TRG pin of the External Interface Breakout Board.
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;
5
CATC CATC Inspector User’s Manual Version 2.31
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;
The CATC Inspector analyzer has two basic recording modes, timed and event driven. Both may be used with external triggering. With timed recording, the analyzer can be set to start or stop recording based on its EXT TRG (input) signal. This mode of operation is the same as the CATC Detective USB Bus & Protocol Analyzer.
With the event driven mode of operation, it is possible to combine other triggering events with the EXT TRG signal. For example, if some external device (such as a logic analyzer) is set up to trigger the CATC Inspector tool, it is still possible to enable USB error checks or PID checks as well. In this situation the first detected event, internal or external, will trigger the analyzer.
6
CATC CATC Inspector User’s Manual Version 2.31
2.4 The External Interface Breakout Board
The breakout board is an Inspector accessory that allows convenient access to twelve potentially useful output signals. It also provides a means to supply up to five inputs: one to act as an (externally supplied) trigger, and four to sample user signals for display purposes. All signals use
TTL levels (0–5V). The following diagram illustrates the breakout board connector:
GND Signal Ground GND Signal Ground –SUSPEND Suspend condition—Active Low Output –RESUME Resume condition—Active Low Output –RESET Reset condition—Active Low Output –BAD CRC Bad CRC condition—Active Low Output –BAD PID Bad PID condition—Active Low Output –STUFF ERR Stuff Error condition—Active Low Output –TRIGGER Trigger event detected—Active Low Output –TRIGGERED Inspector triggered and saved data—Active Low Output DRCLK Recovered USB clock [output] RDATA Recovered USB data [binary output] RSE0 Recovered SE0 signal [output] –IDLE Bus Idle condition—Active Low Output SPARE (unused) SPARE (unused) –EXT TRG External Trigger—Active Low Input DX0 User Signal Data input #0—Normally Pulled High DX1 User Signal Data input #1—Normally Pulled High DX2 User Signal Data input #2—Normally Pulled High DX3 User Signal Data input #3—Normally Pulled High GND Signal Ground GND Signal Ground
2.5 System setup
The Inspector is designed to work with either desktop or portable PCs. The PC does not have to be equipped with a USB interface in order to work with the Inspector analyzer. Three steps are involved in the setup of the system hardware: connecting to the parallel port, connecting to the USB system under test, and connecting to electrical power.
7
CATC CATC Inspector User’s Manual Version 2.31
2.5.1 Parallel Port Connection
Turn off the PC power, and connect the 25-pin cable between the CATC Inspector “Parallel
Port” connector and the PC parallel port. It is suggested that the length of the interface cable be kept as short as possible and a high quality cable be used. PC power may then be restored.
A PC’s parallel port can be configured for up to four different operational modes:
1) Standard mode (sometimes called Compatible mode or Compatibility mode)
2) Bi-directional mode (sometimes called Standard/Bi-directional mode)
3) Enhanced Parallel Port mode, or EPP (sometimes called simply Enhanced mode)
4) Extended Capabilities Port mode, or ECP
The parallel port mode is selected using one of the following approaches:
1) BIOS settings (for most computers having a parallel port I/O controller on the motherboard)
2) PC manufacturer-provided hardware setup utility (on some laptop and desktop PCs)
3) jumper settings (for most add-on I/O cards with a parallel port)
CATC Inspector analyzer models that have “Enhanced Parallel Port” written by the parallel port connector are capable of operating in both EPP and bi-directional modes; Earlier Inspector models that have simply “Parallel Port” written by the connector are designed for bi-directional mode only. The current parallel port connection mode is shown in the program’s “About” display, available via the Help menu.
Whenever EPP mode is available, it should be used, as the data transfers using this mode are at least twice as fast as bi-directional mode.
ECP mode is supposed to implement the bi-directional mode as a subset. If it does so correctly, the Inspector will function properly (in bi-directional mode). Note, however, that it is fairly common (especially in portable systems, concerned with power-saving shortcuts) to implement non-standard versions of ECP, which can cause the Inspector analyzer to malfunction.
If, at startup, the software finds that the PC has ports running only in standard mode, it displays an information box with the following message:
The CATC Inspector software could not detect the Inspector USB box. The Inspector box must be
powered and connected to the system’s Parallel Port (configured to support bi-directional data transfers) to enable the capture and recording of USB traffic. The software found that none of the parallel ports in this system currently supports a bi-directional mode. Use the BIOS setting to set the parallel port to EPP (preferred, for enhanced performance), ECP, or bi-directional mode. If EPP mode has been attempted and the Inspector box still can’t be found, try using ECP or bi­directional mode.
If, at startup, the application finds that the PC has ports running in a mode other than standard, but it still cannot communicate with the Inspector USB box, it displays an information box with the following message:
The CATC Inspector software could not detect the Inspector USB box. The Inspector box must be powered and connected to the system’s Parallel Port (configured to support bi-directional data transfers) to enable the capture and recording of USB traffic. The software found that this system has parallel ports capable of bi-directional data transfers. Ensure that the Inspector USB box is
8
CATC CATC Inspector User’s Manual Version 2.31
both connected properly and powered, then select the OK button. If this message appears again, select the Help button for more information, or the Cancel button to quit the Inspector application.
2.5.2 USB Connection
Locate the CATC Inspector Box 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 Inspector box as follows:
• Connect a USB cable between one side of the open connection and one of the two
USB receptacles on the front panel of the CATC Inspector box (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 Inspector box.
Note: CATC recommends the use of USB cables shorter than 2 meters (6 feet) for all
connections to the Inspector USB box.
Note: The B-type USB connector on the Inspector box is normally connected to the upstream
USB port, while the A-type connector is connected to the downstream port.
To use the external interface signals provided by the Inspector hardware, connect the 37-pin
ribbon cable between the External Interface Breakout Board and the “Data In/Out” connector at the back of the Inspector box. To enable external triggering, connect the trigger signal to the EXT TRG pin on the breakout board. To record user input data, connect the user data signals to the DX0–3 pins on the breakout board.
2.5.3 Power Connection
Connect the DC plug of the AC to +12V DC @ 1A converter to the “9–15V DC” receptacle on the CATC Inspector back panel.
To activate the Inspector, plug the AC to DC converter into a 110V or 220V power outlet and turn on the “Power” switch on the front panel.
The CATC Inspector Bus & Protocol Analyzer hardware is now ready for operation.
3. SOFTWARE INSTALLATION (ALL VERSIONS)
3.1 General
The CATC Inspector software is available in three different versions:
• standard version for Windows 3.1 and Windows 95
• standard version for Windows NT
9
CATC CATC Inspector User’s Manual Version 2.31
• view-only version (the “CATC USB Trace Viewer”) for Windows 3.1, Windows 95, and
Windows NT (This version does not require the Inspector USB hardware; it is used only for viewing and analyzing previously created USB traffic files. It also serves as a product demonstration vehicle.)
The software diskette label identifies the program version. To install the CATC Inspector software, run the installation program from the Inspector software diskette, and follow the instructions on the screen.
• For the standard version on Windows NT systems, run the ‘setup.exe’ installation program.
Note that correct installation requires logging in as administrator.
• For all other versions/systems, run the ‘install.exe’ installation program. The installation program creates a program group for the Inspector 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 Inspector software from the system.
To run the software, double-click on the Inspector icon in the program group created during installation. Section 4 describes the software in detail.
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 \USBINSPR directory (or that otherwise specified by the user):
• USBINSPR.EXE executable code of the CATC Inspector program
• USBINSPR.DLL DLL for the CATC Inspector program
• CLS_HID.DLL DLL for HID Class device decoding
• USBINSPR.HLP CATC Inspector help file
• DEFAULT.OPT default DISPLAY function settings
• DEMO.USB sample USB traffic file
to the \WINDOWS\SYSTEM directory:
• USBINSPR.386 Windows CATC Inspector 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
Inspector driver in the [386Enh] section.
device=usbinspr.386
10
CATC CATC Inspector User’s Manual Version 2.31
3.1.2 Standard Version (Win NT)
The installation program copies the following files to the PC’s hard drive. To \Program Files\CATC\Inspector directory (or that otherwise specified by the user):
• USBINSPR.EXE executable code of the CATC Inspector program
• USBINSPR.DLL DLL for the CATC Inspector program
• CLS_HID.DLL DLL for HID Class device decoding
• USBINSPR.HLP CATC Inspector 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:
• USBINSPR.SYS Windows NT CATC Inspector device driver The installation program modifies the system registry to install the CATC Inspector driver. Thus,
in order to install this version on Windows NT systems, it is necessary to log in as administrator.
3.1.3 “CATC USB Trace Viewer” Version (Win 3.1, Win 95, & Win NT)
The installation program copies the following files to the PC’s hard drive. To the \CATCVIEW directory (or that otherwise specified by the user):
• CATCVIEW.EXE executable code of the CATC USB Trace Viewer program
• CLS_HID.DLL DLL for HID Class device decoding
• USBINSPR.HLP CATC Inspector help file
• DEFAULT.OPT default DISPLAY function settings
• TRIGUSER.USB full-speed USB trace file (illustrates event trigger, user data)
• HID.USB low-speed USB trace file (illustrates HID class decoding)
• SOF.USB full-speed USB trace file (illustrates many SOF packets)
• ISO.USB full-speed USB trace file (illustrates isochronous traffic)
• NAK.USB full-speed USB trace file (illustrates many NAKed transactions)
• REPORT.USB full-speed USB trace file (illustrates statistics report, view by device)
• ERROR.USB full-speed USB trace file (illustrates field & transaction errors)
to the \WINDOWS\SYSTEM directory:
• CTL3D.DLL Windows 3D Control Library
• CTL3DV2.DLL Windows 3D Control Library
11
CATC CATC Inspector User’s Manual Version 2.31
to the \WINDOWS directory:
• CLSDECOD.INI USB Device Class decoding initialization
3.2 Running The Software
The CATC Inspector 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 Inspector icon created during the software installation.
The program will start with the main window active.
4. THE CATC INSPECTOR SOFTWARE
4.1 Getting Started
The CATC Inspector 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 then display the information on the screen. Once the information is captured and 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 Inspector software. A view-only version of the software permits subsequent viewing without the need for any Inspector hardware.
4.2 The Main Display Window
The CATC Inspector analyzer’s main display incorporates the following set of Windows pull­down 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
12
CATC CATC Inspector User’s Manual Version 2.31
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 Inspector 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:
13
CATC CATC Inspector User’s Manual Version 2.31
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 (“Event”, “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... Recording... awaiting event Recording... event occurred
After the Inspector 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). If user input data has been recorded, it will also be copied to disk (as part of the same file); the display will flash “Saving user data...” during this third phase.
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. If the recording was the result of an Event Trigger, the first packet following the trigger (or the packet that caused the trigger) will initially be positioned second from the top of the display; otherwise, the display will begin with the first packet in the traffic file.
14
CATC CATC Inspector User’s Manual Version 2.31
4.2.2 USB Packet Error Displays
The analyzer detects a variety of USB packet 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 Inspector 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.
15
CATC CATC Inspector User’s Manual Version 2.31
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.
16
Loading...
+ 44 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use