Upgrading - 1.0 English

The DFX Decoupler IP core supersedes the Partial Reconfiguration Decoupler IP core. This section identifies any required migration changes.

Upgrading from the Partial Reconfiguration Decoupler to the DFX Decoupler

The DFX Decoupler IP core is a direct replacement for the Partial Reconfiguration Decoupler IP core and is functionally equivalent. When adding a Partial Reconfiguration Decoupler IP core to a project in Vivado® 2020.1 or newer, or when calling create_ip to generate a Partial Reconfiguration Decoupler IP core, you will see a message like this:

WARNING: [IP_Flow 19-2162] IP 'my_decoupler' is locked:
* IP definition 'Partial Reconfiguration Decoupler (1.0)' for IP 'my_decoupler' has been replaced in the IP Catalog by 'DFX Decoupler (1.0)'. * IP definition 'Partial Reconfiguration Decoupler (1.0)' for IP 'my_decoupler' (customized with software release 2019.2) has a different revision in the IP Catalog.

You can perform a direct upgrade from an existing Partial Reconfiguration Decoupler IP instance to the DFX Decoupler core through the standard upgrade process. With a DFX project or a Managed IP project open, select Reports > Report IP Status to identify any IP in need of upgrading. This IP will appear as locked in its current state.

Figure 1. Locked Status

Check any Partial Reconfiguration Decoupler IP and select Upgrade Selected. You will be given a choice of which IP to upgrade to; select the DFX version.

Figure 2. Upgrade IP

The conversion replaces the Partial Reconfiguration Decoupler IP with the equivalent DFX Decoupler IP, with the same set of options and settings. The feature set is identical if upgrading from Partial Reconfiguration Decoupler 1.0 to DFX Decoupler 1.0.

When using the Partial Reconfiguration Decoupler Tcl API capabilities, simply replace any references to pr_decoupler_v_1_0 with dfx_decoupler_v_1_0 in scripts or interactive Tcl use and see the following section for the upgrade code.

Upgrade Code

The following code can be used to make it easier to upgrade the core between versions.

if {[dfx_decoupler_v1_0::is_api_compatible dfx_decoupler_v0_0]}
{dfx_decoupler_v1_0::alias_api dfxd
}

is_api_compatible takes the name of the previous version of the core and returns 1 if the API from the new version is compatible with the API for the old version.

alias_api <name> imports all the API commands into a namespace called <name>.

Use the following code to migrate from the Partial Reconfiguration Decoupler to the DFX Decoupler.

if {[dfx_decoupler_v1_0::is_api_compatible pr_decoupler_v1_0]}
{dfx_decoupler_v1_0::alias_api dfxd
}

and follow this with dfxd::set_property ... to set the properties for the core.