Packaging Custom IP and IP Subsystems - 2024.1 English

Vivado Design Suite User Guide: Design Flows Overview (UG892)

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

The Vivado Design Suite lets you package custom IP or block designs into IP to list in the Vivado IP catalog for use in designs or in the Vivado IP integrator. You can package IP from a variety of sources, such as from a collection of RTL source files, a Vivado IP integrator block design, or an entire Vivado Design Suite project.

The location of the packaged IP can be added to the IP Repository section of the Settings dialog box which can be accessed through the Tools > Settings menu in the Vivado IDE. After a repository of one or more IP has been added, the IP core(s) from the repository will be shown in the IP catalog.

Tip: Before packaging your IP HDL, ensure its correctness by simulating and synthesizing to validate the design.

There are multiple ways to configure the IP and make it available for use within the Vivado IP catalog and IP integrator. For example, the Create and Package IP wizard takes you step-by-step through IP packaging and lets you package IP from a project, a block design, or a specified directory. You can also create and package a new template AXI4 peripheral for use in embedded processor designs.

Important: Ensure that the desired list of supported device families is defined properly while creating the custom IP definition. This is especially important if you want your IP to be used with multiple device families.

For more information, see the Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118) and Vivado Design Suite Tutorial: Creating, Packaging Custom IP (UG1119).