Upgrading Custom IP - 2024.1 English

Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118)

Document ID
Release Date
2024.1 English

A custom IP upgrades as every other IP in the Vivado IP catalog. The difference is how the custom IP is edited to create a new version or revision to which to upgrade. For more information on the process of upgrading IP, see the Vivado Design Suite User Guide: Designing with IP (UG896).

For custom IP, you do not have to upgrade when a newer version is available in the IP catalog. All versions, if accessible in the IP catalog, are available for customization and use; however, when using AMD IP in your custom IP, moving to a new Vivado release could cause the custom IP to become locked.

This IP lock is because the IP used in the custom IP must be upgraded. If you do not want to update any information for the custom IP, you must ensure all the output products are fully generated from the previously supported release.

Important: For AMD IP, only one version of an IP is delivered in each release of the Vivado Design Suite.

In the report IP status example, shown in the following figure, the status reports the IP definition has missing subcores.

Because Vivado only supports the latest version of an AMD IP, the previous version of IP used when creating a custom IP no longer exists and appears as missing in Vivado.

Figure 1. Locked Custom IP in Report IP Status Window

To create a new version of the custom IP:

  1. Edit the IP in an Editing IP project or in the original project from which the IP was packaged. For more information on creating and using an Editing IP project, see the Editing an Existing Custom IP section.
  2. In the Vivado project used to edit the custom IP, upgrade the AMD IP. After the upgrade of the IP is complete, ensure that the custom IP operates as expected and make any additional modifications to keep functionality.
  3. Ensure the Package IP window has fully merged the changes and repackage the IP. For more information on the Package IP window, see Packaging a Specified Directory.

Referencing the previous report IP status example, in the following figure, with the updated custom IP, the report IP status view now reflects the new available version.

Figure 2. Custom IP with Minor Version Change

The custom IP can now be upgraded to the latest version supported with the current Vivado release.