Intel® Quartus® Prime Standard Edition User Guide: Debug Tools

ID 683552
Date 9/24/2018
Document Table of Contents

2.9.2. Creating a Toolkit Description File

A toolkit description file (.toolkit) is a XML file which provides the registration data for a toolkit.
Include the following attributes in your toolkit description file:
Table 13.  Attributes in Toolkit Description File

Attribute name



Internal toolkit file name.


Toolkit display name to appear in the GUI.


Whether the System Console Tools > Toolkits menu displays the toolkit.

Table 14.  Toolkit child elements

Attribute name



Description of the purpose of the toolkit.


Path to .tcl file containing the toolkit implementation.

Path to icon to display as the toolkit launcher button in System Console
Note: The .png 64x64 format is preferred. If the icon does not take up the whole space, ensure that the background is transparent.

If the toolkit works with a particular type of hardware, this attribute specifies the debug type name of the hardware. This attribute enables automatic discovery of the toolkit.

The syntax of a toolkit's debug type name is:
  • Name of the hw.tcl component.
  • dot.
  • Name of the interface within that component which the toolkit uses.
For example: <hw.tcl name>.<interface name>.

.toolkit Description File

<?xml version="1.0" encoding="UTF-8"?>
        <toolkit name="toolkit_example" displayName="Toolkit Example" addMenuItem="true">
        <file> toolkit_example.tcl </file>