UPGRADE YOUR BROWSER

We have detected your current browser version is not the latest one. Xilinx.com uses the latest web technologies to bring you the best online experience possible. Please upgrade to a Xilinx.com supported browser:Chrome, Firefox, Internet Explorer 11, Safari. Thank you!

AR# 60700

2014.1 - Vivado IP Integrator - How can I add an Xilinx IP into my packaged IP to use in my Block Design

Description

I want to create a custom IP that uses a Xilinx IP and package this, then use it in my Vivado IPI Block Design.

 

Solution

First choose any IP from the Xilinx IP catalog. 

For example, here we will choose the Clocking Wizard:

AR60700_IP_Catalog.png
AR60700_IP_Catalog.png

Customize the IP to meet your design needs, and select OK.

 

In the Generate Output Products GUI, click the "Out-of-Contest Settings" button:

AR60700_OOC.png
AR60700_OOC.png

Deselect the "<IP Name>_0.xci" box as shown below, click OK, then Generate.

AR60700_untick.png
AR60700_untick.png


Once the IP is generated, a HDL wrapper will need to be created. Each IP has an Instantiation template, so this can be used here.

Note: the Instantiation template HDL language will be created based upon the Target language in the Vivado Project Settings.

The template can be found under the  IP Sources tab, as shown below:

AR60700_inst_tem.png
AR60700_inst_tem.png

 

Below is an example wrapper using the template information to instantiate the IP:

AR60700_wrapper.png
AR60700_wrapper.png


Next, the project can be packaged using the Tools > Create and Package IP wizard:

AR60700_package_gui.png
AR60700_package_gui.png

 

Select "Include .xci files", this will ensure that the IP is generated whenever the Generate Output Products tool is run:

AR60700_include_xci.png
AR60700_include_xci.png

Note: The IP catalog populates the IP based on the supported devices. 

Because of this, the IP Compatibility section will need to be updated to support all target devices.

For example, if the IP is to be used across all devices, this will need to populated here:

AR60700_Compat.png
AR60700_Compat.png

Note: To add a device, right click and use the GUI to add a device to the list.

To package the IP, select Review and Package > Package IP.


When the IP is generated, this can now be added to an IPI Block Design. If this is a new project, then the IP catalog will need to updated to point to this project.

 

For example, below is a separate project that is using the IP generated above. Here, the IP repository is updated to point to this project:

AR60700_repos.png
AR60700_repos.png

 

Now the IP will be available in the IP catalog.

 

AR# 60700
Date Created 05/16/2014
Last Updated 06/19/2014
Status Active
Type General Article
Tools
  • Vivado Design Suite - 2014.1