Enabling raw dump debugging for the Beagle USB 5000 SuperSpeed Protocol Analyzer – Total Phase
Enabling raw dump debugging for the Beagle USB 5000 SuperSpeed Protocol Analyzer

Contents

Overview

In order to facilitate easier communication between Total Phase technical support representatives and our customers, Data Center can output raw stream dumps of Beagle USB 5000 SuperSpeed Protocol Analyzer captures.

Two environment variables are used to set paths to USB2 and USB3 raw stream dump output files. The two variables operate independently, so it is possible to enable one raw dump at a time, or both simultaneously. The variables are as follows:

  • TP_BG5000_USB2_RAW_DUMP
  • TP_BG5000_USB3_RAW_DUMP

The value of each environment variable is a path to the raw dump output file. The path can be either local, or absolute. If a local path is used, the output file will be written to the folder in which the Data Center executable resides. Different output file paths should be used for USB2 and USB3.

Each time a capture is started, raw dump output files are created at the locations specified in the environment variables (if defined). Existing files at those locations will be overwritten. The files are updated as traffic is captured by Data Center. Once the capture stops, the files are closed.

Note: Make sure your user account has proper permissions to write to the specified file path(s). In the event of write-access problems, the raw dump output file will not be written.

Note: It is important to unset these environment variables after debugging. The raw dump files can grow extremely large, and will act as a drain on CPU and disk resources when these variables are set.

Operating System Instructions

The following sections describe the basic process by which environment variables are set in the various operating systems supported by Data Center.

For more specific information, please consult your operating system documentation.

Windows

The process for setting environment variables in Windows XP, Vista and 7 is fairly similar. The steps below will work on any of these operating systems, but the images show only the process in Windows 7. For more detailed instructions, refer to your operating system documentation.

To set an environment variable:

  1. Open the Start Menu.
  2. Right click on Computer or My Computer.
  3. Click the Advanced tab or Advanced system settings button.
  4. Click the Environment Variables button.
  5. In the environment variables dialog, click New under user variables.

    Windows 7 Environment Variales Dialog

  6. Enter TP_BG5000_USB2_RAW_DUMP or TP_BG5000_USB3_RAW_DUMP as the variable name, and the path to the desired output file as the variable value.

    Windows 7 Edit User Variable

To clear an environment variable after use:

  1. Perform steps 1-4 above to launch the environment variables dialog.
  2. Select TP_BG5000_USB2_RAW_DUMP or TP_BG5000_USB3_RAW_DUMP in user variables and click Delete.

Linux

To set an environment variable within a single terminal session, enter the following into the terminal:

> export TP_BG5000_USB2_RAW_DUMP=path_to_usb2_file
> export TP_BG5000_USB3_RAW_DUMP=path_to_usb3_file

To clear the variable, either close the terminal, or enter the following into the terminal:

> unset TP_BG5000_USB2_RAW_DUMP
> unset TP_BG5000_USB3_RAW_DUMP

Mac OS

The simplest way to use a temporary environment variable in Mac OS is to do so via a terminal. Use the instructions in the Linux section to set and unset environment variables in a terminal.

You must launch Data Center in the same terminal, e.g:

> ~/Desktop/data-center-macosx/Data\ Center.app/bin/datacenter
Have more questions? Submit a request