2403 Walsh Avenue, Santa Clara, CA 95051-1302 Tel: +1/408.727.6600 Fax: +1/408.727.6622 CATC Merlin™ Bluetooth™ Protocol Analyzer User’s Manual Version 1.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Document Disclaimer The information contained 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 presented in this document without notice or penalty.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 TABLE OF CONTENTS Chapter 1 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Bluetooth™ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Software, Firmware, and BusEngine Revisions . . . . . . . . . . . 19 Software Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 BusEngine and Firmware Upgrades . . . . . . . . . . . . . . . . . . . . 20 Automatic Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Manual Upgrades to BusEngine and Firmware . . . . . . . . 22 Upgrading the BusEngine. . . . . . . . . . . . . . . . . . . . . . . . .
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Show Paging Traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Piconet Addresses (MSB -> LSB) . . . . . . . . . . . . . . . . . . 69 Other Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Debug/Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Recording Options - Events . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Events Options . . . . . . . . . . . . . . . . . .
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Viewing L2CAP Channel Connections . . . . . . . . . . . . . . . . 109 Viewing Protocol Messages and Transactions . . . . . . . . . . . 110 Viewing L2CAP Messages in Protocol Messages . . . . . 110 How to Decode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Expanding Protocol Messages . . . . . . . . . . . . . . . . . . . . 111 Changing Protocol Assignments. . . . . . . . . . . . . . . . . . . . . .
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 1. Overview The CATC Merlin™ Protocol Analyzer is the newest member in CATC's industry-leading line of high performance, serial bus protocol analyzers. Preceded by CATC’s USB Chief™ and IEEE 1394 FireInspector™ Analyzers, Merlin has been designed using the same modular software and hardware architecture that made its predecessors highly successful in the serial bus protocol analyzer market worldwide. 1.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 1.2 General Description The Merlin Protocol Analyzer is designed as a stand-alone unit that can be easily configured and controlled by a portable or desktop PC connected via its USB port. Merlin provides customers with the familiar ‘CATC Trace’ user interface that is the de facto industry standard for documenting the performance of high-speed serial protocols.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Sample Bluetooth™ Piconet with Merlin Protocol Analyzer Merlin 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, Merlin continuously records the bus data in a wrap-around fashion until manually stopped or until the Trigger Event is detected and a specified post-Trigger amount of bus data is recorded.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 user-defined set of trigger events. The unit can also be triggered by an externally supplied signal. An external DB-9 connector provides a path for externally supplied data or timing data to be recorded along with bus traffic. This DB-9 connector also provides a path for Merlin to transmit externally two control, timing, or recovered signals for purposes of probing and use by other circuitry.
CATC • Merlin Protocol Analyzer User’s Manual Version 1.6 Recording memory of 128MB - enough to record twenty five minutes of high volume traffic. Display Options • Analyzes and displays a transaction-level view of piconet traffic with accurate time-stamps and frequency hop information. • Software analysis and data presentation at several protocol levels: (Baseband, LMP, L2CAP, SDP, RFCOMM, TCS, OBEX, HDLC, BNEP, PPP, and AT Commands).
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 1.4 Specifications Package Dimensions: 9.2 x 8.4 x 2.5 inches (23.4 x 21.3 x 6.4 cm) Connectors: AC power connection external clock input (EXT CLK, BNC) host connection (USB, type ‘B’) data connector (Data In/Out, 9-pin DB) Weight: 2.8 lbs. (1.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 2. Quick Installation The Merlin Protocol Analyzer components and software are easily installed and quickly ready to run on most Windows-based personal computer systems. You can begin making Bluetooth™ recordings after following these initial steps.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 2.3 Your First Bluetooth™ Recording After installing and launching the software, you can test Merlin by creating a recording of a General Inquiry. In this test, Merlin will issue a General Inquiry that asks local devices to identify themselves. Merlin then records the responses. Step 1 Select Recording Options under Setup on the Menu Bar. Step 2 Select the General tab.
CATC Merlin Protocol Analyzer User’s Manual Step 3 Version 1.6 Select the Modes tab. The following dialog box will open showing factory default settings. Merlin defaults to “General Inquiry.” For this recording, leave most of these settings unchanged. If you are recording a Hop Frequency that is not 79 Hops Standard, you will need to select the appropriate standard from the Hop Frequency menu below. Step 4 Click OK to activate the recording options you selected.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 After a few moments, the recording will terminate and the results will display. The screen should look like the sample recording below which shows the FHS packets generated during the Inquiry process. When the recording session is finished, the bus traffic is saved to the hard drive as a file named data.blt or whatever name you assign as the default filename.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 3. Detailed Installation 3.1 System Components/Packing List • • • • • • One stand-alone Merlin Analyzer module One Antenna One External Interface Breakout Board with a 9-pin ribbon cable One 6-foot (2-meter) USB cable Merlin software program installation diskette(s) Product documentation 3.2 The Installed Merlin Unit The Merlin Analyzer has several user-accessible controls and LEDs on its front and rear panels of the OmniBus.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Figure 2: Rear Panel • 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.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 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 approximately ten seconds and performs an exhaustive self-diagnostic that lasts about five seconds.
CATC Merlin Protocol Analyzer User’s Manual Pin Signal Name Signal Description 6 GND Ground 7 GND Ground 8 GND Ground 9 GND Ground Version 1.6 Table 2: External Interface Breakout Board Breakout Board External Output Signalling Pins The "TRG OUT" and "G.P. OUT" pins found on the Analyzer’s Breakout Board have similar functions. Both pins serve to transmit output signals when a trigger event occurs.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 G.P. OUT G.P. OUT needs to be enabled before it will output signalling. See “Blue Dot Menus for the Event Buttons” on page 84 for details on how to enable output signalling. If enabled, G.P. OUT will provide signalling each time a trigger event is detected by the Analyzer. G.P. OUT’s signalling can be set to three different formats - "Pulse High" provides a 16.66 ns (ground to +5V) signal, "Pulse Low" a 16.
CATC • • • Merlin Protocol Analyzer User’s Manual Version 1.6 Minimum of 16MB physical RAM; 32 MB recommended for viewing transactions At least 10 MB hard disk space, plus additional memory for recordings (as much as 200MB when recording a full buffer size) Monitor resolution at least 800x600 with thousands of colors 3.9 Merlin Program Installation The CATC Merlin software is provided on three 3½ inch diskettes and requires a Windows 98, Windows 98SE, Windows 2000 or Windows ME operating system.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 3.10 Merlin Program Startup You can start the Merlin program from the Desktop or from the installed directory. The program always begins with its main screen active: The software may be used with or without the analyzer box. When used without an analyzer box attached to the computer, the program functions in a Trace Viewer mode to view, analyze, and print captured protocol traffic.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 3.11 Making a Recording After installation, the software is configured to make a manual recording ("Manual Trigger") of General Inquiry traffic. To make your first recording of this traffic, Step 1 Click on the Tool Bar. After 20 seconds, Inquiry timeout occurs and the analyzer will upload the data and display the packets.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 4. Upgrades From time to time as modifications are made to Merlin, it is necessary to update the Firmware and/or BusEngine for optimal performance. Upgrades can be performed two ways: 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 and in the installed directory gives last-minute updates about the current release.
CATC Merlin Bluetooth Analyzer User’s Manual Version 1.6 4.2 Software Upgrades When a new software release is available, it is posted on the Support page of the CATC website at www.catc.com/support.html. To update the software, Step 1 In the About Merlin screen, verify which version of Merlin Software you are currently running. Step 2 Find the latest released software version on the CATC website under Support. If you are running the latest version of the software, no further action is needed.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 begin an upgrade process for the BusEngine and Firmware. If you prefer, you can abort this upgrade and undertake the steps manually as described later in this chapter. To perform an automatic BusEngine and Firmware upgrade, Step 1 If needed, upgrade the Merlin software using the steps outlined in "Software Upgrades" described above. Step 1 Turn on the Analyzer. Step 2 On the toolbar, click the button.
CATC Merlin Bluetooth Analyzer User’s Manual Version 1.6 When the second upgrade has finished, you will see the following message telling you that the upgrade is complete. Step 5 Power cycle Merlin to complete the upgrade. Manual Upgrades to BusEngine and Firmware You can manually upgrade Merlin’s Firmware and/or BusEngine by performing the following steps: Step 1 Select Analyzer under Setup on the Menu Bar.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 monitoring, and event counting and sequencing. Both the BusEngine program and the Firmware that manages the internal microcontroller are fully field upgradeable. 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. To update the BusEngine, Step 1 Click Update BusEngine on the Analyzer Setup screen.
CATC Merlin Bluetooth Analyzer User’s Manual Version 1.6 Upgrading the Firmware Within a new software release, it may also be necessary to upgrade the Analyzer’s firmware for proper operation. The Readme file informs you if this is necessary. To upgrade the firmware, Step 1 Click Upgrade Firmware on the Analyzer Setup screen. You see the Select firmware file window: The program has already automatically searched for the correct file and displays it in the File name field. Step 2 Click Open.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 5. Software Overview 5.1 The Main Display Windows While some of the analyzer’s Main Display window options are familiar, many contain options specific to the analyzer program.
CATC Merlin Protocol Analyzer User’s Manual Menu Version 1.6 Function Piconet » Sync & Record Used when the Bluetooth™ devices under observation have not established connection. Piconet » Passive Sync & Record Used when Bluetooth™ devices under observation are already connected. Piconet » Page Sync & Record This mode causes Merlin to perform a General Inquiry and collect sync data from the specified slave device. "Page Sync & Record" is the recommended method of recording.
CATC Merlin Protocol Analyzer User’s Manual Menu Version 1.6 Function BT Neighborhood Displays Bluetooth™ Address and clock frequency for devices in range. The expected Bluetooth™ clock frequency is 3200 Hz +/- 250 ppm. Decoding Assignments Displays current decoding assignments and provides options for changing them. L2CAP connections Displays current L2CAP connections and provides options for changing them.
CATC Merlin Protocol Analyzer User’s Manual Version 1.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 5.3 Status Bar The Status Bar is located at the bottom of the main display window. Depending on the current activity, the bar can be divided into as many as four segments.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Recording Status During recording activity, the current Recording Status is temporarily displayed in the next segment. When you activate the Record function, this segment flashes one of the following messages (depending on the selected Recording Options): — Trigger? — Triggered! — Uploading After recording stops, — The flashing message changes to Uploading data–x% done (x% indicates the percentage completion of the data uploading process).
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 During uploading, this segment displays the percent of the upload process completed. Note If packets are filtered from the recording or data are truncated, the recording activity is reduced. In addition to showing activity, the third segment of the Status Bar will also display the radio signal strength in dBm received by the analyzer.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 5.5 Merlin Analyzer Keyboard Shortcuts Several frequently-used operations are bound to keyboard shortcuts. Table 4: Keyboard Shortcuts Key Combination Operation Key Combination Operation Ctrl+O Ctrl+P Open file Print...
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 6. Recording Wizard Recording Wizard is an interactive utility that presents a series of user-friendly dialog boxes for setting up a recording session. Recording Wizard serves as an alternative method of configuring the Recording Options dialog box - in fact, when you finish using the Wizard you can see that your settings are . By providing data to the prompts in the Wizard’s dialog boxes, you configure Merlin for a recording session.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 The Wizard advances to the next screen which presents three options: • Establish a new piconet and have Merlin record traffic on that piconet. This option causes Merlin to perform an Inquiry so it can discover local devices and then establish a new piconet and record the piconet traffic. • Record traffic on a piconet that has already been established. This option lets Merlin record traffic from an already established piconet.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 The following screen displays. Step 2 Select the Frequency Hopping Mode for your country, then press Next. The following screen displays. Step 3 Select Perform Inquiry Now, then press Next. Selecting Perform Inquiry Now will cause Merlin to perform a General Inquiry and collect addresses and other details about local Bluetooth devices. If you already have address information for your Bluetooth devices you can choose Skip Inquiry.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 The following screen will display. You will see two options: • I want to search for all Bluetooth devices within range This option will cause Merlin to search for all Bluetooth devices that are in range and ready to transmit and receive data (i.e.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 will display. You will see two options: Step 5 In the text box, enter the length of time you want Merlin to search for nearby devices. The default value is 20. If you do not sure what time value to enter, use the default value. Step 6 Press Next. Before the Inquiry, Merlin tests the hardware connection. In the case of failure, the following screen will display. Clicking OK will close the message box.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 If Merlin passes the hardware test, it will search for devices.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 If devices found, the Recording Wizard will display the following screen: Two buttons will display: • Repeat - This button will cause Merlin to repeat the General Inquiry • Show Devices Found - This button will cause a window to open and display details about the found devices. Step 7 Press the button marked Show Devices Found.
CATC Merlin Protocol Analyzer User’s Manual Step 8 Click OK to close the window. Step 9 Press Next. Version 1.6 The following window will display: Step 10 Select from the drop-down menu the hexadecimal address for your Master device. If you do not see your device’s address, you may type it into the text box yourself. The following window will display: Step 11 Select from the drop-down menu the hexadecimal address for your slave device into the box labeled Piconet Slave Address.
CATC Merlin Protocol Analyzer User’s Manual Step 12 Version 1.6 Press Next. The following screen displays. You will see a checkbox marked Skip the verification and immediately begin the recording process. If you uncheck this box, Merlin will perform a device inquiry on the slave device in Step 10 before it attempts to synchronize to the piconet. Step 13 Press Next. The following screen will display. This screen displays the settings you selected.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 The Advanced button on the right will open the Recording Options dialog box shown below. This screen will show the settings you selected through the Recording Wizard have been applied to the Recording Options dialog. Step 14 Press Next to advance the Recording Wizard to the next screen. The following screen displays: Merlin pages the Master and if specified in Step 8, the Slave devices.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 If Merlin is unable to complete its pages, the following screen will display: If Merlin is able to complete its pages, it will enter into a synchronizing state and then wait for you to create the piconet.
CATC Merlin Protocol Analyzer User’s Manual Version 1.6 Once you have created the piconet, Merlin will synchronize to the piconet and begin recording. During the recording, Merlin will display the following screen: At the completion of the recording, Merlin will display the following screen: You can repeat the recording by pressing the Repeat button. Step 15 To close the wizard, press the Close button.
