Introduction - Introduction - 2026.1 English - UG896

Vivado Design Suite User Guide: Designing with IP (UG896)
Document ID
UG896
Release Date
2026-07-15
Version
2026.1 English

AMD Vivado™ IP cores become locked for several reasons. The Vivado integrated design environment (IDE) provides an IP status report that provides the reason and a recommendation.

The following table lists the locked IP messages and recommendations. See Reporting IP Status for information on the IP Status Report.

Important: When working with AMD-delivered patches, you might notice IP locking due to changes in the IP definitions from the patch.
Table 1. IP Locked Reasons and Recommendations
Brief Reason Verbose Reason Brief Description Verbose Recommendation
IP file read-only

<ip_name> has a read-only file <IPXMLFILE>.

IP is write-protected.

 Check file and project permissions Review your project and file system permissions causing the IP to be read-only. See Editing IP Sources for more information.
<ip_name> has a read-only file <IPXCIFILE> with restricted functionality. Commands to change the configuration of this IP are disallowed.
Shared output directory <ip_name> shares a common output directory with other IP. AMD recommends that you place each IP in its own directory. Move IP

Manually remove the IP from the project with the remove_files command (see the Vivado Design Suite Tcl Command Reference Guide (UG835)).

Import it back into the project with a unique directory using the import_files command.
IP definition not found IP definition <CURRENT_IPDEF> for <ip_name> (customized with software release <SW_VERSION>) was not found in the IP catalog. Add IP definition to catalog Consult the IP catalog for the replacement IP. See Using the IP Catalog for more information.
IP major version change IP definition <CURRENT_IPDEF> for <ip_name> (customized with software release <SW_VERSION>) has a newer major version in the IP catalog. Upgrade IP Target IP definition <TARGET_IPDEF> requires a major version change. Review the impact on the design before upgrading the IP. See Upgrading IP for more information.
IP minor version change IP definition <CURRENT_IPDEF> for <ip_name> (customized with software release <SWVERSION>) has a newer minor version in the IP catalog. Upgrade IP Target IP definition <TARGET_IPDEF> requires a minor version change. Review the change log before upgrading the IP. See Upgrading IP for more information.
IP revision change IP definition <CURRENT_IPDEF> for <ip_name> (customized with software release <SW_VERSION>) has a different revision in the IP catalog. Upgrade IP Target IP definition <TARGET_IPDEF> requires a revision change. Review the change log before upgrading the IP. See Upgrading IP for more information.
Incompatible IP data detected The IP Data in the repository is not compatible with the current instance (despite having identical Version and Revision). This typically occurs if you are using IP that is currently under development. You are not able to view the customization or generate outputs until it is updated. Upgrade IP Upgrade the IP. See Upgrading IP for more information.
IP unsupported part IP <ip_name> does not support the current project part <CURRENT_PART>. However part differences can result in undefined behavior.

Unsupported

Upgrade IP

 Target IP definition <TARGET_IPDEF> does not support the current project part <CURRENT_PART>. Select a supported project part before upgrading the IP. See Using the Platform Board Flow for IP for more information.
IP license not found IP <ip_name> requires one or more mandatory licenses but no valid licenses were found. However license checkpoints could prevent the use of this IP in some tool flows. Unlicensed Upgrade IP Target IP definition <TARGET_IPDEF> requires a valid license. Obtain a valid license before upgrading the IP. See Using Fee-Based Licensed IP for more information.
Check IP license IP <ip_name> requires a valid license. Obtain a valid license or review your licensing environment. See Using Fee-Based Licensed IP for more information.
IP board change (1) This IP has board specific outputs. Current project board <CURRENT_BOARD> and the board <ORIGINAL_BOARD> used to customize the IP <ip_name> do not match. Re-target IP Change the project part or re-target this IP using the upgrade flow to the current project part or board. See Upgrading IP for more information.
IP part change Current project part <CURRENT_PART> and the part <ORIGINAL_PART> used to customize the IP <ip_name> do not match. Change the project part or re-target this IP using the upgrade flow to the current project part or board. See Upgrading IP for more information.
IP contains locked subcore IP <ip_name> contains one or more locked subcores. Upgrade parent IP Upgrade the parent IP <PARENTNAME>. See Editing IP Sources for more information.
Other IP Def not found The IP definition was not found in the IP catalog Add the IP definition to the catalog or consult the IP catalog for the replacement IP. See Using the IP Catalog for more information.
Read-only XCI/BOM/Project The XCI, XML, or XPR file is read-only, so the IP is write-protected. Review your project and file system permissions causing the IP to be read-only. See Editing IP Sources for more information.
User-managed IP The IP is configured as a user-managed IP. In this mode it is your responsibility to manage all IP files. Reconfigure to be a system managed IP (see is_managed property described in Editing IP Sources) if this is unexpected.
USER_LOCKED property The IP is locked by the user. In this mode, it is the responsibility of the user to manage all IP files. Remove the USER_LOCKED property on the IP. See Editing IP Sources for more information.
Disabled component Unsupported Upgrade IP. Target IP definition <TARGET_IPDEF> does not support the current project part <CURRENT_PART>. Select a supported project part before upgrading the IP. See Using the Platform Board Flow for IP for more information.
Incompatible license The IP instance requires one or more mandatory licenses but no valid licenses were found. Obtain a valid license before upgrading the IP. See Using Fee-Based Licensed IP.
Other Incompatible XCI/BOM Upgrade the IP

The IP Data in the catalog is incompatible with the current IP instance (despite having identical Version and Revision).

You need to update the IP before viewing the customization and generating outputs. See Upgrading IP for more information.
Deprecated flow Upgrade the IP The IP instance supports Vivado generation but is currently generated using the CORE Generator tool. See Upgrading IP for more information.
Locked due to child IP being locked The IP instance contains one or more locked subcores. Either run upgrade on the IP or repackage the component using a newer version of the child IP that is currently locked. See Editing or Overriding IP Sources for more information.
  1. When an IP core is locked due to a part or board change and is upgraded, you need to review the ports. Some IP have port differences based upon the part selected. For example, debug ports names and functions change when you update from 7 series FPGAs to an UltraScale platform for the QSGMII IP. You must make RTL changes to avoid encountering errors during synthesis and or implementation. See the appropriate IP product guide for more details.