Launching Vitis HLS

To launch Vitis™ HLS, you must first configure the environment to run the tool as described in Setting up the Environment. This requires setting the environment variables and paths needed for the tool.

To launch Vitis HLS on a Linux platform, or from the command prompt on Windows, execute the following:
$ vitis_hls
TIP: You can also launch Vitis HLS by double-clicking the application from the Windows desktop.

The Vitis HLS GUI opens as shown in the following figure.

Figure 1: Vitis HLS GUI Welcome Page

Under Project, you have the following options.

Create Project
Launch the project setup wizard to create a new project. Refer to Creating a New Vitis HLS Project for more information.
Open Project
Navigate to an existing project.
Clone Examples
Clone Example projects from GitHub repository to create a local copy for your use. See Tutorials and Examples.
Recent Projects
If you have already created a project, this option is enabled, which enables you to quickly view the most recently modified existing projects.

Under Resources, you will find documentation and tutorials to help you work with the tool.

If you have previously launched Vitis HLS to create a project, you can also select from a list of recent projects under Open Recent.

Setting up the Environment

Vitis HLS is delivered as part of the Vitis unified software platform. For instructions on installing the tool, refer to Vitis Development Environment Installation and Licensing in the Vitis Unified Software Platform Documentation (UG1416).

After you have installed the elements of the Vitis software platform, you need to setup the operating environment to run Vitis HLS in a specific command shell by running the settings64.sh bash script, or settings64.csh script:
 #setup XILINX_VITIS and XILINX_VIVADO variables
 source <Vitis_install_path>/settings64.sh
 
TIP: While the Vitis unified software platform also requires the installation and setup of the Xilinx runtime (XRT) and hardware platforms, these elements are not required for the use of Vitis HLS.

Overview of the GUI

The primary controls for using Vitis HLS are shown in the toolbar in the following figure. Project control ensures only commands that can be currently executed are highlighted. For example, synthesis must be performed before C/RTL co-simulation can be executed. The C/RTL co-simulation toolbar buttons remain gray until synthesis completes.

Figure 2: Vitis HLS Controls


In the Project Management section, the buttons are (from left to right):

  • Create New Project opens the new project wizard.
  • Project Settings allows the current project settings to be modified.
  • New Solution opens the new solution dialog box.
  • Solution Settings allows the current solution settings to be modified.

The next group of toolbar buttons control the tool operation (from left to right):

  • Index C Source refreshes the annotations in the C source.
  • Run C Simulation opens the C Simulation dialog box.
  • C Synthesis starts C source code to RTL synthesis in Vitis HLS.
  • Run C/RTL Cosimulation verifies the RTL output.
  • Export RTL packages the RTL into the desired IP output format.

The final group of toolbar buttons are for design analysis (from left to right):

  • Open Report opens the C synthesis report or drops down to open other reports.
  • Compare Reports allows the reports from different solutions to be compared.

Each of the buttons on the toolbar has an equivalent command in the menus. In addition, Vitis HLS GUI provides three perspectives. When you select a perspective, the windows automatically adjust to a more suitable layout for the selected task.

  • The Debug perspective opens the C debugger.
  • The Synthesis perspective is the default perspective and arranges the windows for performing synthesis.
  • The Analysis perspective is used after synthesis completes to analyze the design in detail. This perspective provides considerable more detail than the synthesis report.

Changing between perspectives can be done at any time by selecting the desired perspective button.

Customizing the GUI Behavior

In some cases the default setting of the Vitis HLS GUI prevents certain information from being shown, or some of the defaults are not suitable for you. This section explains how the following features can be customized:

  • Console view buffer size.
  • Default key behaviors.

Customizing the Console view

The Console view displays the messages issued during operations such as synthesize and verification.

The default buffer size for this windows is 80,000 characters and can be changed, or the limit can be removed, to ensure all messages can be reviewed, by using menu Window > Preferences > Run/Debug > Console.

Customizing the Key Behavior

The behavior of the GUI can be customized using the menu Windows > Preferences and new user-defined tool settings saved.

The default setting for the key combination Ctrl + Tab, is to make the active tab in the Information Pane toggle between the source code and the header file. This is changed to make the Ctrl + Tab combination make each tab in turn the active tab.

  • In Preferences, sub-menu General > Keys allows Toggle Source/Header in the Command column to be selected and the Ctrl + Tab combination removed by using the Unbind Command key.
  • Selecting Next Tab in the Command column, placing the cursor in the Binding dialog box and pressing the Ctrl key and then the Tab key, that causes the operation Ctrl + Tab to be associated with making the next tab active.

A find-next hot key can be implemented by using the Microsoft Visual Studio scheme. This can be performed using the menu Window > Preference > General > Keys and replace the Default scheme with the Microsoft Visual Studio scheme.

Reviewing the sub-menus in the Preferences dialog box allows every aspect of the GUI environment to be customized to ensure the highest levels of productivity.