The following commands are available in the menus of the Hardware Debugger's graphical user interface.
The File menu displays up to four of the most recently opened documents, including projects, macros, or waveforms. To open any one of these documents, click on the desired document in the menu.
The Window menu lists the names of all windows you opened during a program session. These windows can be waveform windows, macro windows, or the Console window. To open one of these windows, click on the desired window in the menu.
Select this command to display the version number of the Hardware Debugger and the copyright notice.
Select this command to apply a specified number of clock cycles to the CLKO pin on the XChecker cable during synchronous debugging. Each time you select this command, the number of clocks you specified with the Debug Settings
Number of CLKO Clocks to Apply command is applied. This option is available only after you have defined the clock settings.
You can also use the Apply button in the Clock Control group box of the Debug Control Panel to execute this command.
Select this command to arrange the iconized windows as non-overlapping tiles at the bottom of the Hardware Debugger main window.
Select this command to set the debug mode to asynchronous debugging. In asynchronous mode, neither the Hardware Debugger nor the XChecker cable controls the clock for the target FPGA. Debugging is performed asynchronously with respect to the clock.
Debugging is available only if the cable selected is an XChecker cable and if the current file is a BIT file. Make sure you prepare your design for debugging as specified in the Design Preparation chapter. Make sure you configure the XChecker cable as specified for asynchronous mode in the Connecting Your Cable chapter.
After you select the asynchronous debug mode, the Settings submenu commands and the options in the Debug Control Panel are activated for the appropriate mode.
You can also click the following toolbar button to execute this command.
Use this command to modify the background color of the current waveform window. This command invokes the Color dialog box. Select the appropriate color in the Color dialog box and click OK to apply the change to the waveform window.
Select this command to display each new window on top of the preceding window in a cascading arrangement. The active window processes the commands you invoke.
Use this command to close the selected project, macro, or waveform. This command is active only if there is an active window. If the active window has been modified, a confirmation dialog box appears, prompting you to save the changes.
You can also click the following toolbar button to execute this command.
Use this command to modify the color of the current waveform signals. Select the signal that you want to modify and use this command. This command invokes the Color dialog box. Select the appropriate color in the Color dialog box and click OK to apply the change to the waveform.
Select this command to invoke the Communications Setup dialog box, displayed in the Communication Setup Dialog Box figure. You can set the following cable options for downloading and debugging: cable type, baud rate, and port. Once defined, these settings are saved for the next program session.
Figure 8.1 Communication Setup Dialog Box |
The Communication Setup dialog box includes the following options.
The parallel cable is supported on the PC only.
Use this command to show or hide the Console window. By default, the Console window is closed.
The Console window, displayed in the Console Window figure, consists of a display and an option used to specify the status mode. Use the Console window to view the command history. You can also execute commands from the Console window command bar.
To exit the Console window, select View Console.
Figure 8.2 Console Window |
The Console window includes the following areas and options.
Click the right mouse button while positioned over the Console window to bring up a popup command menu. You can access the following commands from within the Console window.
Select this command to show or hide the Debug Control Panel. The Control Panel allows you to execute various debugging commands. In synchronous mode, the clocking features are enabled on the Control Panel. In asynchronous mode, they are disabled.
To use the Debug Control Panel you must load a BIT file configured for device verification and debugging as described in the Design Preparation chapter.
In synchronous mode, the Debug Control Panel displays the debugging options listed in the following tables. Each option is also available as a menu option from the Debug menu.
To set up the readback options, use the buttons in the Setup group box of the Debug Control Panel. See the Setup Options (Synchronous Mode) table for a list of each option.
Control Panel Button | Setup Group Box Function |
---|---|
Clocks | Invokes the CLKO Clock Settings dialog box in which you can specify the type and frequency of the clock Equivalent to Debug ![]() ![]() |
Triggers | Invokes the Synchronous Trigger Settings dialog box in which you can select the type of trigger that initiates a snapshot capture and the number of clock cycles before and between snapshots Equivalent to Debug ![]() ![]() |
Groups | Invokes the Signal Groups dialog box in which you can define signal groups for debugging and waveform displays Equivalent to Debug ![]() ![]() |
Display | Invokes the Display Signals dialog box in which you can specify signals, signal groups, and RAM bits to include in the display list for debugging Equivalent to Debug ![]() ![]() |
To read back a device, use the buttons in the Readback Control group box of the Debug Control Panel. See the Readback Control Options (Synchronous Mode) table for a list of each option.
Control Panel Button | Readback Control Group Box Function |
Number of Snapshots | Allows you to enter the number of snapshots to read and display in the debugging window Equivalent to Debug ![]() ![]() |
Read | Reads back the target device and captures snapshots for the states of the signals selected for debugging Equivalent to Debug ![]() |
Pulse /RESET | Initializes the flip-flops in the target device that are connected to the RESET pin of the XChecker cable; generates an active-Low pulse Equivalent to Debug ![]() |
To control the clock, use the buttons in the Clock Control group box of the Debug Control Panel. See the Clock Control Options (Synchronous Mode) table for a list of each option.
Control Panel Button | Clock Control Group Box Function |
Number of Clocks | Allows you to enter the number of clock cycles to apply to your device Equivalent to Debug ![]() ![]() |
Apply | Applies the clock cycles specified in the Number of Clock field to the XChecker CLKO pin Equivalent to Debug ![]() |
Start | Allows the CLKO pin on the XChecker cable to oscillate freely Equivalent to Debug ![]() |
Stop | Interrupts the system clock being applied to the target device Equivalent to Debug ![]() |
In the asynchronous mode, the Debug Control Panel displays the debugging options listed in the following tables. Each button is also available as a menu option from the Debug menu.
To set up the readback options, use the buttons in the Setup group box of the Debug Control Panel. See the Setup Options (Asynchronous Mode) table for a list of each option.
Control Panel Button | Readback Setup Group Box Function |
---|---|
Triggers | Invokes the Asynchronous Trigger Settings dialog box in which you can select the type of trigger that initiates a snapshot capture Equivalent to Debug ![]() ![]() |
Groups | Invokes the Signal Groups dialog box in which you can define signal groups for debugging and waveform display Equivalent to Debug ![]() ![]() |
Display | Invokes the Display Signals dialog box in which you can specify signals, signal groups, and RAM bits to include in the display list for debugging Equivalent to Debug ![]() ![]() |
To read back a device, use the buttons in the Readback Control group box of the Debug Control Panel. See the Readback Control Options (Asynchronous Mode) table for a list of each option.
Control Panel Button | Readback Control Group Box Function |
Number of Snapshots | Allows you to enter the number of snapshots to read and display in the debugging window Equivalent to Debug ![]() ![]() |
Read | Reads back the target device and captures snapshots for the states of the signals selected for debugging Equivalent to Debug ![]() |
Pulse /RESET | Initializes the flip-flops in the target device that are connected to the RESET pin of the XChecker cable; generates an active-Low pulse Equivalent to Debug ![]() |
Select this command to copy highlighted text from the macro or Console window. You can paste this text to a different window using the Paste command.
Select this command to cut highlighted text from the macro window. You can paste this text to a different window using the Paste command.
Select this command to delete command text from the macro window.
Select this command to download a configuration bitstream and verify it immediately after downloading. The output of the verification is displayed in a dialog box. This command is active only if you are using an XChecker cable and if the current file is a BIT file configured for readback. See the Downloading and Verifying a Design section of the Programming a Device or a Daisy Chain chapter for information on how to use this command.
You can also click the following toolbar button to execute this command.
Select this command to download the current configuration data to a device or device chain. When you download a design, you program a device or daisy chain of devices, with the functions described by that design. See the Downloading a Design to a Target Board section of the Programming a Device or a Daisy Chain chapter for information on how to use this command.
This command is active only if you have opened a project.
You can also click the following toolbar button to execute this command.
Select this command to end the current Hardware Debugger session. If you have not saved your data, you are asked if the unsaved information should be saved before exiting.
Select this command to change the base or radix used by the signals groups in the waveform display. There are four possible radices: binary, octal, decimal, and hexadecimal. Select the radix you want to use for your signal groups. The radix is applied to all groups.
Select this command to display the opening screen of Hardware Debugger help. From the opening screen, you can jump to step-by-step instructions for using the Hardware Debugger and to various types of reference information.
After you open help, you can click the Help Topics button in the Help window to return to the opening screen of Help.
For more information about online help, see the Obtaining Online Help section of the Getting Started chapter.
Do not connect the XChecker TTL leads to signals of different voltage levels than required because you might damage the XChecker internal hardware. Do not connect the control signals to XChecker before VCC and ground. The input/output pins of their internal FPGA should always be at a lower or equal potential than the rail voltage to avoid internal damage.
Select this command to display the logic levels of the cable pins and to probe static logic values on your board. This information appears in the Cable Logic Level dialog box, as shown in the Cable Logic Level Dialog Box figure. This command is only available when using the XChecker cable.
In logic scan mode, the pins function as probes scanning for TTL level logic, not as configurations or boundary scan pins.
Figure 8.3 Cable Logic Level Dialog Box |
The Cable Logic Level dialog box includes the following options.
Select this command to open a new macro or waveform. The New command brings up a submenu with the following commands.
A macro is a sequence of commands that you can execute much like a batch file.
Unlike the Console window, a macro window includes an editable text area in which you can type the commands you want to use in the macro, as shown in the New Macro Window figure.
Figure 8.4 New Macro Window |
The macro window contains a display area. You can select commands using the mouse by double-clicking the left mouse button to select a word. You can also select an entire block of text by pressing the right mouse button, dragging the mouse to the end of the region you want to copy, then releasing the mouse button.
Click the right mouse button while positioned over the macro window to bring up a popup command menu. You can access all of the commands from the Edit menu in this popup menu. See the Edit Menu section for more information.
Select this command to open the New Project dialog box, shown in the New Project Dialog Box figure. Use this dialog box to choose a bitstream file to open. Select this command to open a BIT file (.bit extension), which is a binary representation of your design, or a PROM file (.mcs, .tek, or .exo extensions). You can also open a Rawbits file, called an RBT file (.rbt extension), which is the ASCII version of the BIT file. You must open the bitstream before downloading or debugging your design.
Figure 8.5 New Project Dialog Box |
If you open a BIT file, you can download and debug your design. To verify, read back, and debug a BIT file, you must have a logic allocation file (design_name.ll) in the design directory. If you open a PROM file, you can program several FPGA devices at once. You cannot use PROM or RBT files for verification and debugging.
After you choose a file to open, a project window appears that shows the hierarchical structure of files for each project. Each project contains bitstream, macro, and waveform data. The device name is only included in this hierarchy when you open a BIT file.
You can also use the following toolbar button to execute this command.
The New Project dialog box includes the following options.
Click Cancel to exit the current dialog box without creating a project.
Select this command to open a new graphical waveform window. If you select this option, the next time you use Debug Read Snapshots, the readback signal values will be displayed in the new waveform instead of the existing waveform.
Select this command to open an existing project, macro, or waveform. The Open command brings up a submenu with the following commands.
Select this command to open the Open Macro dialog box, shown in the Open Macro Dialog Box figure. Use this dialog box to specify a macro to open. The macro runs Hardware Debugger commands, which can range from a single step, such as setting the baud rate, to a full downloading and debugging session.
Figure 8.6 Open Macro Dialog Box |
The Open Macro dialog box includes the following options.
Click Cancel to exit the current dialog box without opening a macro.
After you make settings in the Open Macro dialog box, a macro window appears. Click the right mouse button while positioned over the macro window to bring up a popup command menu. You can access all of the commands from the Edit menu in this popup menu. See the Edit Menu section for more information.
Select this command to print the data from the selected waveform window. This command brings up the Print dialog box, which allows you to indicate how many copies to print, to send the file to a print other than the default, or to change printer options.
Print dialog boxes vary between workstations and PCs. Six basic options in this dialog box follow.
Select this command to bring up the Open Project dialog box from which you can choose a project file (.xck file extension) to open. The XCK file contains design dependent information, such as the design file name, the waveform and macro name, and the dialog box settings. The design file can be a BIT file (.bit extension), which is a binary representation of your design, or a PROM file (.mcs, .tek, or .exo extensions). It can also be an RBT file (.rbt extension) which is the ASCII version of the BIT file. You must open the bitstream file before downloading or debugging your design.
After you choose a file to open, a project window appears that shows the hierarchical structure of files for each project. Each project contains bitstream, macro, and waveform data. You can use the popup menu commands within this window.
The part number appears in the project hierarchy only when you have chosen a BIT file to open.
Use the Open Project dialog box, displayed in the Open Project Dialog Box figure, to specify which project to open.
Figure 8.7 Open Project Dialog Box |
You can also use the following toolbar button to execute this command.
The Open Project dialog box includes the following options.
Click Cancel to exit the current dialog box without opening a project.
Click the right mouse button while positioned over the project window to bring up a popup list of commands. Each command is run on the selected project. The following commands are available.
This command is not available as a menu command.
Select this command to view previously saved waveform data. When the file is first opened, the data is displayed graphically. To view the data textually, use the View Text Data command.
Use the Open Waveform dialog box, displayed in the Open Waveform Dialog Box figure, to specify which waveform file to open.
Figure 8.8 Open Waveform Dialog Box |
To open the file, specify the file name and click Open. A waveform is displayed as a waveform window within the Hardware Debugger main window.
The Open Waveform dialog box includes the following options.
Click Cancel to exit the dialog box without opening a waveform.
After you make settings in the Open Waveform dialog box, a waveform window appears. Click the right mouse button while positioned over the waveform window to bring up a popup command menu. You can access the following commands from within the waveform window.
Select this command to paste cut or copied text to the macro window.
Select this command to print the data from the selected waveform window. This command brings up the Print dialog box, which allows you to indicate how many copies to print, to send the file to a print other than the default, or to change printer options.
Print dialog boxes vary between workstations and PCs. Six basic options in this dialog box follow.
Select this command to preview the waveform window to be printed. This command brings up a waveform image based upon the font and size selections you make with the View Text Font command.
Select this command to read back the signals that you selected for viewing. The software generates a readback of all the configuration data, extracts the signals you selected for viewing, and displays the signal values in the current waveform. The software takes the number of snapshots specified in the Debug Settings
Number of Snapshots to Read command.
You can also click the Read button in the Readback Control group box of the Debug Control Panel to execute this command.
The readback data stream is linked to the active waveform window only. After you close the connection, the waveform window is not updated with new information.
Select this command to perform readback on a device and store the data into a binary file. The data consists of configuration and signal data.
You can also click the following toolbar button to execute this command.
Select this command to refresh and update the waveform display.
Select this command to reset the internal logic of the cable. After the cable is reinitialized and the baud rate is set.
After a power glitch, you should first reset the cable to reconfigure the XChecker internal FPGA device and then reconfigure the target device.
Select this command to initialize the target FPGA internal flip-flops that are connected to the XChecker RESET pin. This option generates an active-Low pulse. If you have not set the Pulse RESET at First Snapshot option in the Trigger Settings dialog box, you can use this command to reset the target device's internal flip-flops.
You can also click the Pulse /RESET button in the Readback Control group box of the Debug Control Panel to execute this command.
If you do not open a new waveform window when you use this command, the reset point appears in the current waveform window. Each Reset state appears as a blue diamond with a vertical line.
Select this command to run the commands in the selected macro window. If a macro window is not selected, a dialog box appears, prompting you for a macro file name.
You can also click the following toolbar button to execute this command.
Use the Save command to save an existing project, macro, or waveform. The file in the active window is saved.
You can also click the following toolbar button to execute this command.
Use the Save As command to save an existing project, macro, or waveform with a new name. The file in the active window is saved. The Save As dialog box, shown in the Save As Dialog Box figure, is displayed, allowing you to specify the name under which to save the document.
Figure 8.9 Save As Dialog Box |
The Save As dialog box includes the following options.
Click Cancel to exit the current dialog box without saving the data.
Select this command to select all of the text in the macro window. You can then cut or copy this text and paste it to a different window.
Select this command to perform a diagnostic of the XChecker cable hardware. The tests ensure that data can be transmitted and received at the different baud rates and that the internal FPGA and RAM are operational. See the Testing the XChecker Cable section of the Connecting Your Cable chapter for information on how to set up the hardware for testing.
Make settings in the Cable Self Check dialog box, as shown in the Cable Self Check Dialog Box figure, to specify which tests you want to perform and how these tests are conducted. After the tests are complete, the overall results are displayed in the Cable Self Check (Results) dialog box, as shown in the Cable Self Check (Results) Dialog Box figure.
Figure 8.10 Cable Self Check Dialog Box |
Figure 8.11 Cable Self Check (Results) Dialog Box |
The Self Check dialog box includes the following options.
The Self Check (Results) dialog box includes the following fields.
Each time a test is completed, you are informed whether the test was successful. If the test was successful, the Cable Self Check dialog box displays PASSED under the test name. If the test was unsuccessful, the dialog box displays FAILED and a description of the test failure under the test name. Failures indicate the following.
If Test 2: Header I/O Pins or Test 3: Cable Memory fails, replace the XChecker cable.
The Settings command brings up a submenu with commands that are enabled only if you have selected a debugging mode, Synchronous Mode or Asynchronous Mode. Refer to the listings of these submenu commands for an explanation of their functions.
The following options are available if you select Debug Synchronous Mode.
The following options are available if you select Debug Asynchronous Mode.
Select this Debug Settings menu command to invoke the CLKO Clock Settings dialog box, shown in the CLKO Clock Settings Dialog Box figure. This dialog box allows you to select the clock you want to use, Internal Clock or External Clock. Click on the appropriate radio button.
Figure 8.12 CLKO Clock Settings Dialog Box |
You can also click the Clocks button in the Setup group box of the Debug Control panel to execute this command.
Use the CLKO Clock Settings dialog box to define the clock options.
Select this Debug Settings menu command to invoke the Display Signals dialog box, which enables you to select the signals, groups, and RAM bits you wish to view.
Use the Display Signals dialog box displayed in the Display Signals Dialog Box figure to specify which signals you wish to probe.
Figure 8.13 Display Signals Dialog Box |
You can also click the Display button in the Clock Control group box of the Debug Control Panel to execute this command.
The Display Signals dialog box includes the following options.
Select this Debug Settings menu command to open the Setting CLKO Clocks dialog box, shown in the Setting CLKO Clocks Dialog Box figure. This dialog box allows you to specify the number of clocks to apply. When you specify the number of clocks, you specify the number of clock pulses to apply to the CLKO pin of the XChecker cable to the target system.
Select the Apply CLKO Clock(s) command to apply the specified number of clocks.
Figure 8.14 Setting CLKO Clocks Dialog Box |
You can also type in the number you want in the Number of Clocks text box of the Debug Control Panel to execute this command.
Select this Debug Settings menu command to invoke the Snapshots Count dialog box, displayed in the Snapshots Count Dialog Box figure. This dialog box allows you to specify the number of snapshots to read and display in the current waveform. When you specify the number of snapshots, you specify the number of signal states you wish to display and probe. This number is used when you select the Debug
Read Snapshots command.
Figure 8.15 Snapshots Count Dialog Box |
A snapshot is the reading of the logical states of a device for one clock cycle. You can specify the number of clocks to apply between snapshots in the Trigger Settings dialog box for synchronous mode debugging.
You can also type in the number you want in the Number of Snapshots text box of the Debug Control Panel to execute this command.
Select this Debug Settings menu command to invoke the Signal Groups dialog box, which contains a list of signal groups and a list of signals. The dialog box enables you to add or remove signals from a group.
Signal groups are useful for probing nodes that are related. For example, the signals a0, a1, a2, and a3 of a bus can be grouped as a signal address group.
Use the Signal Groups dialog box, displayed in the Signal Groups Dialog Box figure, to define signal groups.
Figure 8.16 Signal Groups Dialog Box |
You can also click the Groups button in the Setup group box of the Debug Control Panel to execute this command.
The Signal Groups dialog box includes the following options.
Depending on which debugging mode you chose, Asynchronous Mode or Synchronous Mode, the Asynchronous or Synchronous Trigger Settings dialog box appears.
The Trigger Settings dialog box enables you to select the type of trigger you wish to initiate the readback. The trigger is an external signal connected to the XChecker TRIG pin that prompts the XChecker to start the readback operation.
Use the Asynchronous Trigger Settings dialog box, shown in the Asynchronous Trigger Settings Dialog Box figure, to specify the type of trigger to use for debugging in asynchronous mode.
Figure 8.17 Asynchronous Trigger Settings Dialog Box |
Use the Synchronous Trigger Settings dialog box, shown in the Synchronous Trigger Settings Dialog Box figure, to specify the trigger type and clock cycles to use for debugging in synchronous mode.
Figure 8.18 Synchronous Trigger Settings Dialog Box |
You can also click the Triggers button in the Setup group box of the Debug Control Panel to execute this command.
The Asynchronous Trigger Settings dialog box includes the following options.
The Synchronous Trigger Settings dialog box includes the following options.
Select this command to allow the system clock to freely oscillate. This option is available only if you have selected the synchronous debugging mode.
You can also click the Start button in the Clock Control group box of the Debug Control Panel to execute this command.
Select this command to show or hide the Hardware Debugger status bar. The status bar, located at the bottom of the Hardware Debugger window, provides information about the commands being processed. It also provides a description of menu commands or the toolbar buttons that are in focus.
Select this command to interrupt the system clock being applied to the target device through the CLKO pin of the XChecker cable. This option is available only if you have selected the synchronous debugging mode.
You can also click the Stop button in the Clock Control group box of the Debug Control Panel to execute this command.
Select this command to set the debug mode to synchronous debugging. In synchronous mode, you control the FPGA system clock through the Hardware Debugger and the XChecker cable.
Debugging is available only if the cable selected is an XChecker cable and if the current file is a BIT file. Make sure you prepare your design for debugging as specified in the Design Preparation chapter. Make sure you configure the XChecker cable as specified for synchronous mode in the Connecting Your Cable chapter.
After you select a debug mode, the Settings submenu commands and the options in the Debug Control Panel are activated for the appropriate mode.
You can also click the following toolbar button to execute this command.
Select this command to display the readback data textually rather than graphically.
In the text mode, the waveform window displays a textual representation of the device states you specified for debugging. The text window, displayed in the Text Data Waveform Window figure, is a tabular display of the readback information. See the Description of the Text Window section of the Customizing the Interface chapter for a detailed description of the text data waveform window.
Figure 8.19 Text Data Waveform Window |
You can also click the following toolbar button to execute this command.
Select this command to open a dialog box that allows you to specify the text font, font style, and font size for text in the selected waveform window.
Select this command to arrange open windows next to one another in a horizontal arrangement within the main window so that all windows are visible. The active window processes the commands you invoke.
Select this command to arrange open windows next to one another in a vertical arrangement within the main window so that all windows are visible. The active window processes the commands you invoke.
Select this command to show or hide the Hardware Debugger toolbar. The toolbar, located below the menu bar, displays several buttons that you can use to execute certain menu commands. The toolbar offers an alternative to the menu commands. See the Toolbar Buttons section for a description of the toolbar buttons.
Select this command to undo the most recent Edit menu command.
Select this command to initiate a readback of the downloaded design and compare the readback data to the original bitstream that was downloaded. The status of the verification is displayed in a dialog box. This command is active only if you are using an XChecker cable and if the current file is a BIT file configured for verification. See the Verifying Design Logic section of the Programming a Device or a Daisy Chain chapter for information on how to use this command.
You can also click the following toolbar button to execute this command.
Select this command to display the readback signal values graphically rather than textually.
The waveform window, shown in the Waveform Window figure, displays a graphical representation of the device states you specified for debugging. See the Description of the Graphical Window section of the Customizing the Interface chapter for a detailed description of the graphical waveform window.
Figure 8.20 Waveform Window |
You can also click the following button to execute this command.
Select this command to zoom in on the current waveform.
You can also click the following toolbar button to execute this command.
Select this command to zoom out on the current waveform.
You can also click the following toolbar button to execute this command.
Select this command to reset the waveform view to the default settings.
You can also click the following toolbar button to execute this command.
Select this command to fit the selected waveform to the current size of the screen. This command operates when a graphical waveform window is the active window.
You can also click the following toolbar button to execute this command.