Packaging Your Current Project - 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 Package your current project option lets you package the files associated with your current Vivado project. The IP packager attempts to gather the necessary information about your IP and create a basic IP package in a specified location.

  1. Select the Package your current project option and click Next. The wizard page updates with the available options for packaging the current project as shown in the following figure.

  2. In the Package Your Current Project page, provide theIP location information:

    The directory in which the IP packager creates the IP Definition. Generally, the IP location is the /sources directory of the project, which is the default. This location, if all the files are copied into the project, is relative to all the project files.

    If files are stored remotely from the project source directory, the IP location is determined based upon where the majority of project files are relatively located.

    If a location is selected outside of the hierarchical file paths of the project files, the Vivado IDE prompts you to copy the project source files into that IP location directory. This process copies all the remote files to the IP location into a directory based on their category (for example, src/, sim/).

    The IP packager heuristic always copies remote files based on the file category regardless of IP location name.

    The Vivado IDE creates a new, temporary editing project in the IP location for editing and modifying the newly created and packaged project.

    Note: If the project you are packaging includes IP, packager includes only the IP customization (.xci) file for the IPs. The Vivado IDE generates the IP output products with the newly created parent IP.

    When including the XCI files in the packaged IP, this creates an association between the parent IP and enables the packaged XCI files to be managed by the Vivado IDE. This allows the Vivado IDE to upgrade IP to the latest release by using the IP upgrade instructions as described in the Vivado Design Suite User Guide: Designing with IP (UG896).

  3. Click Next.

    You are prompted to confirm the copy of the source files, as shown in the following figure:



    The New IP Creation page summarizes the information that the Create and Package New IP wizard heuristically gathers about the design.

  4. Click Finish to open the IP packager.

When this step completes, review the packaging steps shown in the Package IP window in Packaging IP.