RTL IP Definition - 2021.2 English

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
UG1399
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English
Figure 1. RTL Blackbox Wizard

The RTL Wizard page lets you define the RTL source for the IP. The fields to define include:

RTL Files
This option is used to add or remove the pre existing RTL IP files.
RTL Module Name
Specify the top level RTL IP module name in this field.
Performance
Specify performance targets for the IP.
Latency
Latency is the time required for the design to complete. Specify the Latency information in this field.
II
Define the target II (Initiation Interval). This is the number of clocks cycles before new input can be applied.
Resource
Specify the device resource utilization for the RTL IP. The resource information provided here will be combined with utilization from synthesis to report the overall design resource utilization. You should be able to extract this information from the Vivado Design Suite

Click Next to proceed to the RTL Common Signal page, as shown below.

Figure 2. RTL Common Signals
module_clock
Specify the name the of the clock used in the RTL IP.
module_reset
Specify the name of the reset signal used in the IP.
module_clock_enable
Specify the name of the clock enable signal in the IP.
ap_ctrl_chain_protocol_start
Specify the name of the block control start signal used in the IP.
ap_ctrl_chain_protocol_ready
Specify the name of the block control ready signal used in the IP.
ap_ctrl_chain_protocol_done
Specify the name of the block control done signal used in the IP.
ap_ctrl_chain_protocol_continue
Specify the name of the block control continue signal used in the RTL IP.

Click Finish to automatically generate a JSON file for the specified IP. This can be confirmed through the log message as shown below.

Log Message:
"[2019-08-29 16:51:10] RTL Blackbox Wizard Information: the "foo.json" file has been created in the rtl_blackbox/Source folder."

The JSON file can be accessed through the Source file folder, and will be generated as described in the next section.