Integrating the Block Design into a Top-Level Design - 2022.2 English

Vivado Design Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994)

Document ID
Release Date
2022.2 English

An IP integrator BD can be integrated into a higher-level design or it can be defined as the top-level of the design hierarchy. In either case, begin by generating an HDL wrapper for the BD. Right-click the BD in the Vivado IDE Sources window and select Create HDL Wrapper.

Figure 1. Create HDL Wrapper Command

This command generates a top-level HDL file with an instantiation template for the IP integrator BD.

The Create HDL Wrapper dialog box opens, as shown in the following figure.

Figure 2. Create HDL Wrapper Dialog Box

The Create HDL Wrapper options are as follows:

  • Copy generated wrapper to allow user edits. When a BD is a subset of an overall design hierarchy, you must have the option to manually edit the wrapper file so you can then instantiate other design components within the wrapper file.
Important: You must manually update this file, or regenerate it any time the I/O interface of the block design changes.

The copied wrapper file is written to the <project_name>.srcs/sources_1/imports/hdl directory.

  • Let Vivado tools manage wrapper and auto-update. Use this option if the BD is the top-level of the project, or if you will not be manually editing the wrapper file.

When the Vivado tools manage the wrapper file, the file is updated every time you generate output products. The wrapper file is located in the directory <project_name>.srcs/sources_1/bd/<bd_name>/hdl.