RTL IP Definition - RTL IP Definition - 2026.1 English - UG1702

Vitis Reference Guide (UG1702)

Document ID
UG1702
Release Date
2026-06-23
Version
2026.1 English
Figure 1. RTL Blackbox Wizard

The RTL Wizard lets you define the RTL source for the IP.

  1. In the RTL Blackbox wizard, go to RTL IP Definition.
  2. Add the RTL source files by using RTL Files to add or remove existing RTL IP files.
  3. Specify the top-level RTL module by entering the RTL Module Name for the IP.
  4. (Optional) Specify performance targets:
    • Enter Latency, which defines the number of clock cycles required for the design to complete.
    • Enter II (Initiation Interval), which defines the number of clock cycles before new input can be applied.
    • Specify the Resource Utilization for the RTL IP. Use resource estimates extracted from the Vivado Design Suite. Combine the specified values with synthesis results to report overall resource utilization..
  5. Click Next to proceed to RTL Common Signal.

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

Figure 2. RTL Common Signals
  1. Specify the RTL clock signal by entering the signal name for module_clock.
  2. Specify the RTL reset signal by entering the signal name for module_reset.
  3. Specify the clock enable signal by entering the signal name for module_clock_enable.
  4. Specify block control signals for ap_ctrl_chain:
    • Enter the signal name for ap_ctrl_chain_protocol_start.
    • Enter the signal name for ap_ctrl_chain_protocol_ready.
    • Enter the signal name for ap_ctrl_chain_protocol_done.
    • Enter the signal name for ap_ctrl_chain_protocol_continue.
  5. Click Finish to generate the RTL blackbox JSON file.

Click Finish to automatically generate a JSON file for the specified IP. Confirm the action through the log message 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."
Generate the JSON file as described in the next section, then access it in the Source folder.