Instantiating an IP - 2024.1 English

Vivado Design Suite User Guide: Designing with IP (UG896)

Document ID
UG896
Release Date
2024-05-30
Version
2024.1 English

The Vivado tools create instantiation templates after IP customization, regardless of whether you generated the output products. The instantiation templates are displayed under the Instantiation Template directory on the IP Sources view of the Sources window.

After you create an IP customization, open the IP instantiation template and copy the relevant code from the template into your code. The Vivado tool generates both a VHDL and a Verilog instantiation template that you select from and copy and paste into your RTL design.

To use the instantiation template in your design, do the following steps:

  1. Open the instantiation template file for the IP customization by double-clicking the file in the Sources view, or by selecting the file using the Open Files command.
  2. Highlight the instantiation template between the comments as indicated in the text of the instantiation template, and copy the section.
  3. Open the design HDL file in which you want to instantiate the IP either at the top-level or in the hierarchy of the design.
  4. Paste the copied template to the location of your choice.
  5. Edit the HDL to integrate the template into your design as needed; for example, change the port connections, and give the instantiation a unique name.

After the IP is instantiated into a design, the IP is listed correctly in the design hierarchy. With the IP customization properly instantiated into your design, you are ready to synthesize the IP along with the rest of your design, either as a black box if the OOC flow is used, or with the top-level of the design, if you are using global synthesis. See Synthesis Options for IP for more details.

Tip: When you expand the IP hierarchy by right-clicking the IP, you can see the Encrypted IP source icon . The content of this source cannot be viewed. See the Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118) for information on Encypting IP in Vivado.
Important: It is possible to create duplicate IP. See Resolving Duplicate IP if you have duplicates.