Teledyne IBTracer 4X User Manual Ver.2.20
3385 Scott Blvd., Santa Clara, CA 95051-3115 Tel: +1/408.727.6600 Fax: +1/408.727.6622
CATC IBTracer 4X
™
InfiniBand Protocol Analyzer
User’s Manual
Manual Version 1.2
For Software SW Version 2.2
1 November, 2002
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Document Disclaimer
The information in this document has been carefully checked and is
believed to be reliable. However, no responsibility can be assumed for
inaccuracies that may not have been detected.
CATC reserves the right to revise the information in this document without
notice or penalty.
Trademarks and Servicemarks
CATC, Merlin, Advisor, Chief, FireInspector, IBTracer, USBTracer,
SATrace r, Traffic Generator, BusEngine, UPT, HPT, and UHT are
trademarks of Computer Access Technology Corporation.
Microsoft, Windows, Windows NT, Windows 98SE, Windows ME, and
Windows XP are registered trademarks of Microsoft Inc.
All other trademarks are property of their respective companies.
Copyright
Copyright © 2002, Computer Access Technology Corporation (CATC); All
Rights Reserved.
This document may be printed and reproduced without additional
permission, but all copies should contain this copyright notice.
FCC CONFORMANCE STATEMENT
This equipment has been tested and found to comply with the limits for a
Class A digital device, pursuant to Part 15 of the FCC Rules. These limits
are designed to provide reasonable protection against harmful interference
when the equipment is operated in a commercial environment. This
equipment generates, uses, and can radiate radio frequency energy and, if
not installed and used in accordance with the instruction manual, may cause
harmful interference to radio communications. Operation of this equipment
in a residential area is likely to cause harmful interference in which case the
user will be required to correct the interference at his own expense. The end
user of this product should be aware that any changes or modifications made
to this equipment without the approval of CATC could result in the product
not meeting the Class A limits, in which case the FCC could void the user's
authority to operate the equipment.
ii
IBTracer Protocol Analyzer User’s ManualCATC SW Version 2.2
EU CONFORMANCE STATEMENT
This equipment complies with the EMC Directive 89/336/EEC and the Low
Voltage Directive 73/23/EEC, and their associated amendments for Class A
Information Technology Equipment. It has been tested and found to comply
with EN55022 and EN55024 (EN61000-4-2, EN61000-4-3, EN61000-4-4,
EN61000-4-5, EN61000-4-6, EN61000-4-11, EN61000-3-2,
EN61000-3-3), and EN605950.
Part number: 730-0031-00
iii
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
iv
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
CONTENTS
Chapter1 Overview.....................................1
GeneralDescription ...............................................1
Features .........................................................3
General ...................................................3
DisplayOptions ............................................4
IBTracerBusEngine.........................................4
Specifications.....................................................5
Package...................................................5
PowerRequirements.........................................5
Environmental Conditions . ...................................5
Switches ..................................................5
LEDs ....................................................5
ProbingCharacteristics.......................................5
RecordingMemorySize .....................................5
BasicTriggerEvents.........................................6
Certification ...............................................6
Chapter2 QuickInstallation..............................7
PCRequirements..................................................7
SettingUptheAnalyzer.............................................7
InstallingtheSoftware..............................................8
YourFirstInfiniBandRecording......................................8
CapturingYourFirstCATCTrace .............................10
TraceViewFeatures........................................10
Chapter3 DetailedInstallation...........................11
System Components/Packing List . . ..................................11
TheInstalledIBTracer4XUnit......................................11
LEDandButtonDescriptions.................................11
IBTracer4XSystemSetup..........................................13
ACPowerSource.................................................13
PCConnection...................................................14
InfiniBandCableConnection........................................14
ExternalInterfaceBreakoutBoard....................................14
Pin-OutsfortheDataIn/OutConnector.........................14
PrototypeReworkArea......................................16
IBTracerProgramInstallation.......................................16
Loading the USBTracer USBDrivers ..........................16
Installing the USBTracer ApplicationProgram ..................17
IBTracerProgramStartup ..........................................17
MakingaRecording...............................................18
Chapter4 Updates.....................................19
Software,Firmware,andBusEngineRevisions..........................19
SoftwareUpdates.................................................20
iii
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
LicenseInformation...............................................20
UpdatingtheSoftwareLicense................................20
BusEngineandFirmwareUpdates....................................21
UpdatingtheBusEngine.....................................21
UpdatingtheFirmware......................................21
AutomaticUpdates.........................................22
ManualUpdates ...........................................23
ManuallyUpdatingtheFirmware..............................25
ResettingtheAnalyzer.............................................25
Chapter5 SoftwareOverview............................27
TheMainDisplayMenus...........................................27
ViewOptions....................................................29
ResettingtheToolbar .......................................29
ToolBar..................................................31
StatusBar.......................................................32
RecordingProgress.........................................32
RecordingStatus...........................................33
AnalyzerStatus............................................34
SearchStatus..............................................34
ZoomIn..................................................34
ZoomOut................................................34
ToolTips........................................................34
IBTracerAnalyzerKeyboardShortcuts................................35
Chapter6 RecordingOptions............................37
OpeningtheRecordingOptionsDialogBox............................37
RecordingOptions-General........................................38
Recordingtype ............................................38
Options ..................................................39
BufferSize ...............................................39
TriggerPosition............................................39
RecordingOptions-Miscellaneous...................................40
1x/4xMode...............................................40
PhysicalLaneOrder........................................41
Resolve Reliable Connections . . ..............................42
RecordingOptions-Events.........................................42
EventsOptions ............................................42
RecordingOptions-Actions........................................53
EventSequences...........................................54
EventCounts..............................................54
ActionsWindowLayout.....................................55
ConnectingEventstoActions.......................................56
TriggeringfromanEventinaSet ....................................59
CreatinganEventSequence.........................................59
CountingEvents..................................................60
TriggeringExternalOutput .........................................62
iv
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Cabling ..................................................62
SettingExternalOutputOptions...............................63
SpecifyingPulseSignalOutputs...............................64
SettingMultipleConditionswithCounters.............................64
SequencingwithCounters ...................................65
Linking Two Events to Two or More Counters . . . ................66
FilteringTraffic ..................................................66
RestartingSequencesandCounters...................................67
RestartingaSequence.......................................67
RestartingaCount..........................................67
SavingRecordingOptions..........................................68
RecordingInfiniBandTraffic........................................68
TrainingRetry ...................................................69
Chapter7 DisplayOptions ..............................71
GeneralDisplayOptions ...........................................71
SavingandLoadingDisplayOptions .................................72
ColorDisplayOptions.............................................73
FormatsDisplayOptions...........................................75
Hiding..........................................................76
CompoundHiding ................................................77
Headers.........................................................79
Chapter8 ReadingaCATCTrace........................81
TraceViewFeatures...............................................81
SetMarker......................................................81
EditorClearMarker ..............................................82
ExpandedandCollapsedFieldFormats................................84
Chapter9 DecodingTraffic..............................87
DecodingandDisplayingTraffic.....................................87
DecodingViatheToolbar....................................87
DecodingViatheDisplayOptionsDialogBox ...................88
DecodingAssignments.............................................89
ToolTips........................................................89
Expanding&CollapsingTraffic .....................................90
MADFormats ...................................................90
MAD,SAandSRPDecoderScriptFiles...............................90
Hiding/DisplayingFieldsviaDecoderScriptFiles ................91
DecodingAssignments.............................................91
Viewing Details about MAD, Subnet Administration and SRP Fields . .......92
ViewingMADorSRPFields.................................92
ViewingSubnetAdministrationfields..........................94
ViewingSAAttributes......................................97
Chapter10 OtherFeatures..............................99
Search..........................................................99
GotoTrigger..............................................99
v
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
GotoPacket..............................................99
GotoMarker.............................................100
Goto...................................................100
Find....................................................106
FindNext ...............................................107
DisplayingRaw10bCodes ........................................108
EditComment ..................................................110
FileInformation.................................................110
ErrorSummary..................................................111
TimingCalculations..............................................112
TrafficSummary ................................................114
BusUtilization..................................................114
RealTimeStatistics..............................................118
ExportingPacketsandData........................................120
ResolvingReliableConnections ....................................122
Breaking a Connection .....................................123
CreatingaConnection......................................123
VerificationScripts...............................................123
EditingandCreatingScripts.................................125
Chapter11 HowtoContactCATC.......................127
vi
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
1. Overview
The CATC IBTracer™ 4X Protocol Analyzer is the ideal tool for analyzing
InfiniBand link data. Development Engineers will rely on IBTracer 4X
Analyzer to resolve software, firmware, and hardware problems
encountered in the development of InfiniBand host channel adapters,
switches, and other devices. Test and Quality Assurance Engineers will use
IBTracer to verify the correct operation of InfiniBand products and
compliance to the standard. Anyone involved with InfiniBand can use
IBTracer software as a stand-alone viewer to understand the InfiniBand
protocol and to facilitate system level discussions and problem resolution of
applications employing InfiniBand technology.
Please refer to the InfiniBand Specification, version 1.0 for details on the
InfiniBand protocol. The InfiniBand specification is available from the
InfiniBand TA at its web site http://www.infinibandta.org/
1.1 General Description
IBTracer 4X hardware module installs into the CATC Universal Protocol
Analyzer System (UPAS) 10000. The UPAS 10000 is a base system
designed to accommodate different protocol modules.
Together, IBTracer and the UPAS connect to a portable or desktop PC. This
PC runs the user interface for administering the Analyzer and displaying
traces.
1
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
IBTracer 4X is a non-intrusive testing tool for the InfiniBand architecture
providing traffic capture and analysis. Hardware triggering allows real-time
events to be captured. Hardware filtering allows the different types of
packets to be filtered in or out of the recording. Filtering allows users to
focus recordings on events of interest and to preserve recording memory so
that the recording time can be extended.
Recorded data is presented in colored graphics in a trace viewer application.
This application has advanced search and viewing capabilities that allow the
user to quickly locate specific data, errors, and other desired conditions,
thereby focussing the user’s attention on events of interest.
IBTracer 4X Protocol Analyzer functions with any personal computer using
the Windows 98SE, Window 2000, Windows ME, or Windows XP
operating systems and equipped with a functional USB interface.
IBTracer 4X provides on-the-fly detection of and triggering on such events
as Packet Headers and Errors. Whether recording manually or with a
specified trigger condition, IBTracer continuously records the link data in a
wrap-around fashion until manually stopped or until the Trigger Event is
detected and a specified amount of post-Trigger link data is recorded.
Upon detection of a triggering event, the analyzer continues to record data
up to a point specified by the user. Real-time detection of events can be
individually enabled or disabled to allow triggering on events as they
happen. This includes predefined exception or error conditions and a
user-defined set of trigger events. The unit can also be triggered by an
externally supplied signal. An external DB-25 connector provides a path for
externally supplied data or timing data to be recorded along with traffic.
This DB-25 connector also provides a path for IBTracer 4X to transmit
externally two control, timing, or recovered signals for purposes of probing
and use by other circuitry.
The IBTracer software provides powerful search functions that enable
investigation of particular events and allow the software to identify and
highlight specific events. In addition to immediate analysis, you can print
any part of the data. Use the Save As feature to save the data on disk for later
viewing. The program also provides a variety of timing information and
data analysis reports.
2
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
1.2 Features
General
• Upgradeable firmware and recording engine
• Software operates stand-alone on any Microsoft Windows 98SE or later
computer as a "Trace Viewer"
• Link and data packets are displayed and fully decoded
• Training sequences are displayed
• Transport level functions are fully decoded with a graphical illustration
of the comprised packets and messages
• Errors at the physical, link, and transport levels are highlighted in red
• Online help
Physical Components
•IBTracer 4X plug-in module
•UPAS/IBTracer 4X can be administered by any desktop or portable
Microsoft Windows-based computer with USB capability
• Convenient Plug-and-Play USB installation
• Taps non-intrusively between two 10 Gbit/sec InfiniBand ports using
two standard cables
• External interface for probing and monitoring auxiliary digital signals
and for cross triggering between other test instruments
Recording Options
• Record up to 2 Gbyte of InfiniBand data, timing and control information
• Three recording modes: Snapshot, Manual Trigger, and Event Trigger
• Selectable recording buffer size and trigger position
• Record the full data rate of a single 4X, 10 Gbit/sec InfiniBand link
• Trigger on InfiniBand conditions like link training sequences or power
off disconnect events
• Trigger on a comprehensive list of error conditions, such as running
disparity, bad packets, or bad variant or invariant CRCs
• Trigger on a sequence of packets to capture messages and transport level
events
• Optionally filter captured data
• Breakout board data
• Counters
3
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Display Options
• Extensive use of color and graphics within the trace
• Packet errors and protocol violations are highlighted in red
• Packet color clearly indicates position before or after the trigger point
• Packets can be marked with text annotations that become tool-tips for
future reference
• Tool-tips with complete definitions of most fields
• Search, show, or hide only the data of interest using InfiniBand-specific
criteria
• Packets are accurately time-stamped (1 symbol time or 4 ns resolution)
• Measure time, throughput, or responsiveness between packet markers or
relative to the trigger position
IBTracer BusEngine
CATC’s BusEngine™ Technology is at the heart of the new IBTracer 4X
Analyzer. The revolutionary BusEngine core uses state-of-the-art Field
Programmable Gate Array (FPGA) technology and incorporates both the
real-time recording engine and the configurable building blocks that
implement data/state/error detection, triggering, capture filtering, external
signal monitoring and event counting and sequencing. Like the
flash-memory-based firmware that controls its operation, all BusEngine
logic is fully field upgradeable, using configuration files that can be
downloaded from the CATC website.
4
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
1.3 Specifications
IBTracer is a hardware module that installs into the Universal Protocol
Analyzer System. The following specifications describe a combined
IBTracer 4X Universal Protocol Analyzer System.
Package
Connectors: AC power connection
Host connection (USB2.0, type "B")
Recording Channel
Power Requirements
90-254 VAC, 47-63 Hz, 165W maximum (universal input)
Environmental Conditions
Operating Range: 0 to 40 °C (32 to 104 °F)
Storage Range: -20 to 80 °C (-4 to 176 °F)
Humidity: 10 to 90%, non-condensing
Switches
Power: On/off
Manual Trigger: When pressed forces a trigger event
LEDs
Status: Illuminated when the analyzer is powered on.
Probing Characteristics
Connection: receptacles
Standard cables
Recording Memory Size
2 GBytes for trace capture, timing, and control information.
5
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Basic Trigger Events
Conditions: Training sequences, Link Packets, Data Packets
Cable disconnect/connect
PacketPatterns: VLT,LID,Opcode,QP,AETH,LRM,BTM,Data,
Immediate data, Sixteen aligned data bytes, MAD types
Errors: Invalid 10b codes
Wrong running disparity of 10b codes
End of bad packet
Packet delimiters violations
Certification
FCC (Class A), CE Mark
6
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
2. Quick Installation
IBTracer 4X is a factory-installed hardware module that is sold as part of
the CATC Universal Protocol Analyzer System 10000 (UPAS).
The UPAS 10000 together with the IBTracer 4X module and associated
software are easily installed on most Windows-based personal computer
systems. You can begin making InfiniBand™ recordings after following
these initial steps. However, if you are unsure about what to do after reading
the Quick Installation instructions, or if your analyzer does not work after
you follow these instructions, read through the sections in this manual.
2.1 PC Requirements
IBTracer 4X is administered by a PC. This PC needs to have the following
features in order to be able to communicate with the Analyzer:
• A USB port (USB 2.0 recommended). All communications between the
PC and the analyzer pass across a USB cable. If the PC is being used only
as a trace viewer, then the USB port is not necessary.
• Microsoft Windows 98SE, Windows ME, Windows 2000, or
Windows XP for recording and viewing traffic.
• Physical RAM should be a minimum of 128 MB. The amount you use
should be at least equal to the amount of your largest recording. For
example, if you plan to make 2-Gbyte recordings, then your PC should
have 2048 MB of RAM.
2.2 Setting Up the Analyzer
Step 1 Remove the IBTracer 4X/UPAS from its shipping container.
The IBTracer 4X module will already be installed in the UPAS.
Step 2 Connect the AC power cable to the rear of the UPAS.
Step 3 Connect the USB cable between the USB port on the back of the
Analyzer and a USB port on the PC.
Step 4 Turn on the power switch located on the rear of the Analyzer.
Step 5 Insert the IBTracer 4X CD into the PC that will be controlling the
analyzer.
Step 6 Follow on-screen Plug-and-Play instructions for the automatic
installation of the IBTracer Analyzer as a USB device on your PC
(the IBTracer CD includes the required USB files).
7
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
2.3 Installing the Software
Step 1 Run the setup program (for example,Start>Run>d:\setup)and
follow the on-screen instructions to install the IBTracer application
on the analyzing PC hard disk.
Step 2 To start the application, launch the CATC IBTracer 4X program
from the Start Menu: Start>Programs>CATC>IBTracer.
2.4 Your First InfiniBand Recording
After installing and launching the software, you can test IBTrace r 4X by
following these steps:
Step 1 Plug in a InfiniBand cable to each of the two ports on the IBTracer
4X module, and then connect the other ends to the device under test.
Step 2 Select Recording Options under Setup on the Menu Bar.
Step 3 Select the General tab.
The following dialog box will open showing factory default settings
such as “Snapshot” and 16 Mbytes buffer size. For your first
recording, you can leave these settings unchanged.
Step 4 Click OK to activate the recording options you selected.
Step 5 Turn on the InfiniBand devices that are to be tested and cause them
to generate InfiniBand traffic.
8
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Step 6 Click on the Tool Bar.
IBTracer 4X starts to record the InfiniBand traffic immediately.
After 4 Mbytes of traffic is recorded, the analyzer will upload the
data and display the packets in the trace window.
Step 7 If you wish to terminate the recording before the snapshot
automatically completes, click on the Tool Bar.
When the recording session is finished, the traffic is uploaded from
the Analyzer to the hard drive on your PC as a file named data.ibt
or whatever name you assigned as the default filename. While the
file is being uploaded, you should see a white progress bar at the
bottom of the screen. When the bar disappears, it indicates that the
data has been uploaded to disk.
Step 8 To save a current recording for future reference, select File > Save
As on the Menu Bar.
OR
Click on the Tool Bar.
You see the standard Save As screen.
Step 9 Give the recording a name and save it to the appropriate directory.
9
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Capturing Your First CATC Trace
After a few moments, the recording will end and the results will display.
Trace View Features
•TheIBTracer packet view display uses color and graphics
extensively to fully document the captured traffic.
• Packets are shown on separate rows, with their individual fields
both labeled and color coded.
• Packets are numbered sequentially, as recorded and time-stamped
with a resolution of 1 symbol time or 4 ns.
• Display formats can be named and saved for later use.
• Pop-up Tool Tips annotate packet fields with detailed
information about their contents.
• Data fields can be collapsed to occupy minimal space in the
display (which can in turn be zoomed in and out to optimize
screen utilization).
• The display software can operate independent of the hardware
and thus can function as a stand-alone Trace Viewer that can be
freely distributed.
10
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
3. Detailed Installation
3.1 System Components/Packing List
• One stand-alone IBTracer 4X Analyzer module
• One Universal Protocol Analyzer System 10000 Chassis
• One USB cable
• One 6-foot (2-meter) 4x to 4x cable
• Two 6-foot (2-meter) Infiniband 4x to 1x cables
• One DB-25 parallel cable
• One UPAS External Breakout Board
•IBTracer 4X software program installation CD-ROM
• Product documentation
3.2 The Installed IBTracer 4X Unit
If you purchased an IBTracer 4X module with a UPAS, the IBTracer 4X
module will arrive inserted into the UPAS. Upon power up, the installed
IBTracer 4X Analyzer will activate the user-accessible controls and LEDs
on the front and rear panels of the UPAS.
Figure 1: Front Panel
LED and Button Descriptions
If you look at the front panel, you will see LEDs, buttons, and connectors.
Left-most LEDs
•GreenPWR (power) indicator LED for UPAS (lights when the unit
power is switched on).
•RedStatus indicator LED for UPAS (lights during the boot up).
11
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Center-most LEDs and Button
The LEDs and button on the UPAS enclosure function in conjunction with
the IBTracer 4X module inserted above it.
•GreenREC (recording) LED (lights when the unit is recording).
• Orange TRG (triggered) LED (lights when the unit triggers an event).
•GreenUPLD (Upload) (lights when unit is uploading data to PC).
• MANUAL TRG (Manual Trigger) push-button (allows a manual Trace
capture).
Right-most LEDs and Button
The LEDs and button under the right module slot are reserved for future
releases of hardware modules.
•GreenREC (recording) LED (lights when the unit is recording).
• Orange TRG (triggered) LED (lights when the unit triggers an event
TRG also lights during power-on testing and will be turned off at the end
of the power on cycle. If the LED blinks at the end of this cycle, the
hardware is faulty).
•GreenUPLD (Upload) LED (lights when unit is uploading data to PC).
• MANUAL TRG push-button (allows a manual Trace capture).
Figure 2: Universal Protocol Analyzer Rear Panel and its connectors
• Wide range AC connector module
— Power socket
— Enclosed 5x20 mm 2.0A 250 V fast acting glass fuse
Warning: For continued protection against fire, replace fuse only with the
type and rating specified above.
— Power on/off switch
• Two External Ports marked Ext. In and Ext. Out
• USB 2.0 type B host computer connector
• Data In/Out DB-25 (25-pin) external interface connector
12
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Warning: Do not open the UPAS enclosure. There are no
user-serviceable parts inside. Refer servicing to CATC.
3.3 IBTracer 4X System Setup
IBTracer 4X and UPAS are connected via USB to a desktop or laptop PC.
The PC, in turn, is used to administer the Analyzer and display traces.
To set up the Analyzer and PC,
Step 1 If needed, insert the IBTracer 4X module into the UPAS.
Step 2 Connect the UPAS to an AC power source.
Step 3 Connect the Analyzer to the analyzing PC via USB.
Step 4 Connect InfiniBand cables to the devices under test.
Step 5 Install IBTracer software.
Step 6 Create a recording.
3.4 AC Power Source
Step 1 Connect the Analyzer box to a 100-volt to 240-volt, 50 Hz to 60 Hz,
165 W power outlet using the provided power cord.
Note The Analyzer is capable of supporting supply voltages between
100-volt and 240-volt, 50 Hz or 60 Hz, thus supporting all
known supply voltages around the world.
Step 2 Use the power switch located on the rear panel to turn the analyzer
unit on and off.
Note At power-on, the Analyzer initializes itself in a few seconds and
then performs an exhaustive self-diagnostic that lasts about 20
seconds. The Status LED illuminates during the power-on
testing and turns off when testing is finished. If the diagnostics
fail, the Status LED blinks, indicating a hardware failure. If this
occurs, call CATC Customer Support for assistance.
13
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
3.5 PC Connection
Use the USB cable provided to connect the host computer to the UPAS.
• At least 20 MB hard disk space is required, plus additional memory for
recordings (as much as 2 Gbytes or more when recording a full buffer
size).
• Monitor resolution is at least 800x600 with thousands of colors.
3.6 InfiniBand Cable Connection
CATC provides two 1x-to-4x InfiniBand cables and one 4x InfiniBand
cable. The 1x-to-4x cables are actually 1x cables with 4x connectors. These
cables allow you to connect 1x devices to IBTracer 4x.
3.7 External Interface Breakout Board
The External Interface Breakout Board is an accessory that allows
convenient access to several potentially useful standard, LVTTL output and
input signals. It also offers a simple way to connect logic analyzers or other
tools to the IBTracer 4X Analyzer unit. Six ground pins and one 5-volt pin
are provided.
The Breakout Board connects via a cable to the Data In/Out connector
located on the rear of the analyzer box. Each signaling pin on the breakout
board is isolated by a 100Ω series resistor.
Figure 3: Data In/Out Cable Connector
Pin-Outs for the Data In/Out Connector
The following table lists the pin-out and signal descriptions for the Data
In/Out connector. This pin-out is for a cable connector that connects to the
breakout board.
14
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Data In/Out Connector – Pin-Out
Pin Signal Name Signal Description
1RSV Reserved
2 GND Ground
3 GP OUT General Purpose Output
4 TRG IN 1 Trigger In 1
5 GND Ground
6DATA6 Data6
7DATA4 Data4
8DATA3 Data3
9DATA1 Data1
10 GND Ground
11 RSV Reserved
12 RSV Reserved
13 +5V +5 Volts, 250 mA DC Source
14 RSV Reserved
15 GND Ground
16 TRG OUT Trigger Out
17 TRGIN0 TriggerIn0
18 DATA 7 Data 7
19 DATA 5 Data 5
20 GND Ground
21 DATA 2 Data 2
22 DATA 0 Data 0
23 GND Ground
24 RSV Reserved
25 RSV Reserved
Note (*) Pins 4 and 17 have the same function: they allow external
signals to be used to cause triggering or recording. Pins 3 and 16
are used to transmit output signals.
15
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Figure 4: External Interface Breakout Board
Prototype Rework Area
The Breakout Board contains a prototype rework area for making custom
circuits for rapid development. The area consists of plated-through holes, 20
columns wide by 27 rows long. The top row of holes is connected to GND
and the bottom row is connected to +5V. The remaining holes are not
connected. Use the rework area to insert custom components and wire-wrap
their respective signal, power, and ground pins.
3.8 IBTracer Program Installation
The CATC IBTracer software is provided on CD-ROM and requires a
Windows 98SE, Windows 2000, Windows ME, or Windows XP operating
system.
Note The USBTracer program can be installed on any Windows 98SE
or later operating system (including NT 4.0) as a "Trace
Viewer." That is, it may be used to view, analyze, and print data
that was collected and saved on another system even if it does
not have an Analyzer attached.
Loading the USBTracer USB Drivers
Step 1 Insert the USBTracer program CD-ROM into your PC.
16
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Step 2 Power-on the USBTracer Analyzer.
Step 3 Connect the USB cable to the rear of the analyzer and to the personal
computer.
The host operating system detects the Analyzer and begins to install
the USB driver.
Note When Windows prompts you for a file, browse to the CATC CD.
If this is a first time installation, the ctcupa10.sys (UPAS) and
ib4trcer.sys (USB) drivers must also be installed.
Installing the USBTracer Application Program
Run setup.exe from the USBTracer CD-ROM.
The CATC USBTracer Install Wizard automatically installs the necessary
files to the computer’s hard drive. USBTracer software is installed in the
C:\Program Files\CATC\IBTracer directory unless you specify otherwise.
Follow the installation instructions on your screen.
3.9 IBTracer Program Startup
You can start the IBTracer program from the desktop or from the installed
directory. The program always begins with its main screen active:
17
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
When the program is used with the USBTracer Protocol Analyzer attached
to the computer, you can set trigger conditions, record, monitor, and analyze
the activity of your InfiniBand device or fabric. When used without the
Analyzer, the software serves as a Trace Viewer for viewing traces made on
other systems.
3.10 Making a Recording
After installation, the software is configured to make a Snapshot recording
of InfiniBand traffic.
To make your first recording of this traffic,
Step 1 Connect InfiniBand cables to both InfiniBand connectors on the
front panel of the IBTracer 4X module and plug the other ends into
the device under test.
Step 2 Cause the device under test to generate InfiniBand traffic.
Step 3 Click on the Tool Bar.
After 16 Mbytes of traffic is recorded, the analyzer will upload the
data and display the packets.
To terminate the recording before Inquiry timeout occurs,
Step 4 Click on the Tool Bar at any time before recording
automatically terminates.
When the recording session is finished, the traffic is saved to the
hard drive as a file named data.ibt or whatever name you assign as
the default filename.
To save a current recording for future reference,
Step 5 Select Save As under File on the Menu Bar.
OR
Click on the Tool Bar.
You see the standard Save As screen.
Step 6 Give the recording a unique name and save it to the appropriate
directory.
18
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
4. Updates
As modifications are made to the IBTracer Analyzer, it is necessary to
update the IBTracer software, firmware, and/or BusEngine optimal
performance. Updates can be performed either automatically or manually.
This chapter describes both procedures.
4.1 Software, Firmware, and BusEngine Revisions
The Readme.txt file on the first installation disk or CD-ROM and in the
installed directory gives last-minute updates about the current release.
Included with each release are the most recent downloadable images of the
Firmware and the BusEngine. The Readme.txt file lists the latest versions
and informs you if new Firmware or a new BusEngine needs to be updated
in your hardware.
Once the Analyzer has completed the self diagnostics and is connected to
the PC, you can check the latest revision of the software and BusEngine by
selecting About IBTracer from the Help menu:
About IBTracer details revisions of the following software and hardware:
•IBTracer Software Version
•IBTracer Firmware & ROM Versions
• BusEngine Version
• Unit Serial Number
Note When contacting CATC for technical support, please have available
all the revisions reported in the About IBTracer... window.
19
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
4.2 Software Updates
When a new IBTracer software release is available, it is posted on the
Support page of the CATC website at www.catc.com/support.html.
To update the IBTracer software,
Step 1 In the About IBTracer screen,verifywhichversionofIBTracer
Software you are currently running.
Step 2 Find the latest released software version on the CATC website under
www.catc.com/support.
If you are running the latest version of the software, no further
action is needed.
If you are not running the latest version, continue to Step 3.
Step 3 Click on the first link to download the zipped Disk 1 files for your
operating system.
Step 4 Unzip the files into your choice of directory.
Step 5 Click Start, then Run, and browse to where you unzipped the files.
Step 6 Select the program named Setup and click Open.
Step 7 Click OK to run the Setup and begin the installation.
Step 8 Follow the on-screen instructions to complete the installation.
Step 9 Read the Readme file for important information on changes in the
release.
4.3 License Information
Licensing information for IBTracer canbeviewedbyselectingDisplay
License Information from the Help menu. The License window provides
maintenance expiration and features data for IBTracer.
Updating the Software License
License keys are necessary to enable software maintenance and SDP and
SRP decoding. If they are not enabled, a message appears if an attempt is
made to access these features, stating that a license key is necessary to in
order to use the features.
20
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
To access these tools, a License Key must be obtained by CATC. Once the
License Key is obtained, follow these steps to install it:
Step 1 From the Help menu, select Update License. The Update License
dialog appears.
Step 2 Enter the path and filename for the License key or use the Browse
button to navigate to the directory that contains the License Key.
Step 3 Select the *.lic file, and then click Update Device.
4.4 BusEngine and Firmware Updates
BusEngine and Firmware updates often need to be performed when you
update the IBTracer software. These updates can be performed
automatically or manually. Both processes are described.
Updating the BusEngine
The BusEngine core is the heart of the IBTracer Analyzer. Using FPGA
technology, the BusEngine incorporates both the high speed recording
engine and the configurable building blocks that implement data/state/error
detections, triggering, capture filtering, external signal monitoring, and
event counting and sequencing. Both the BusEngine program and the
Firmware that manages the internal microcontroller are fully field
updateable.
Within a new software release, it may be necessary to update the Analyzer’s
BusEngine hardware for proper operation. The Readme file lets you know
if this is necessary.
Updating the Firmware
Within a new software release, it may also be necessary to update the
Analyzer’s firmware for proper operation. The Readme file informs you if
this is necessary.
21
Automatic Updates
When the IBTracer software is updated, the software may become
incompatible with the BusEngine and Firmware. If a recording is attempted,
IBTracer displays a warning message and then automatically begins an
update process for the BusEngine and Firmware. If preferred, you can abort
this update and do the steps manually, as described later in this chapter.
To automatically update the BusEngine and Firmware,
Step 1 If needed, update the IBTracer software using the steps outlined in
"Software Updates" described above.
Step 2 Turn on the Analyzer.
Step 3 On the toolbar, click the button.
Because the BusEngine and/or the Firmware are incompatible with
the current IBTracer software version, an error message will appear
displaying your current versions and indicating what versions you
need to install.
IBTracer 4X Protocol Analyzer User’s ManualCATC SW Version 2.2
Step 4 Click Yes.
The above window closes and the Analyzer Setup window opens.
Step 5 Click Update BusEngine or Update Firmware on the Analyzer
Setup screen.
22
Loading...