Compatibility - 2024.1 English

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

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

The Compatibility page, shown in the following figure, configures the specific AMD parts or device families compatible with your custom IP.

Additionally, this step also provides options for additional checks suitable for packaging IPs that are used in IP integrator or deployed as RTL kernels for the Vitis tool. These checks greatly simplify packaging IPs for these tools by catching issues that can arise from packaging RTL that misses necessary information needed for various aspects such as interfaces, clocks, and more.

For more information, refer to RTL Kernel Development Flow section of the Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393).

Package for Vitis
When selected, IP packager applies additional Design Rule Checks (DRCs) for usage in Vitis as RTL kernels. It enables the process of packaging the RTL IP as an XO for use in the Vitis environment. You can also select the Control Protocol for the RTL Kernel. This determines the control mechanism used to operate the kernel.
Package for IP integrator
When selected, IP packager applies additional Design Rule Checks (DRCs) for usage in IP integrator. Checks include useful information such as association of clocks with AXI interfaces, bus clock frequency value, etc. that can help better integration of the packaged IP used in IP integrator. When packaging IP, the frequency of the clocks are included in the packaged IP. If the frequency of the clocks in the design instances the IP are different than the packaged IP, a warning is issued. Checking the Ignore Freq_Hz box ignores clock frequency differences between the packaged IP and the instance of the IP in the user design.
Figure 1. Package IP Window: Compatibility Page

The list is initially populated with the AMD Kintex™ 7 device family with the with the Life Cycle set to Production. Any AMD device family and/or devices supported by the Vivado IDE can be included within the family support list of the custom IP. Any device family or part that is not listed in the Compatibility list is incompatible for that IP.

The Life Cycle property informs you of the IP compatibility with the selected IP use case. Within the Compatibility list, each device family or part added can have their own Life Cycle property.

The following options describe the Life Cycle for a given part or family, as follows:

  • Beta
  • Discontinued
  • Hidden
  • Pre-Production
  • Production
  • Removed
  • Superseded

Setting the property to Discontinued, Hidden, Removed, or Superseded ensures that the IP does not appear in the IP catalog for the associated device family or part.