export_ip_user_files - 2024.1 English

Vivado Design Suite User Guide: Logic Simulation (UG900)

Document ID

UG900

Release Date

2024-05-30

Version

2024.1 English

Generate and export IP/IP integrator user files from a project. This can be scoped to work on one or more IPs.

Syntax

export_ip_user_files [-of_objects <arg>] [-ip_user_files_dir <arg>]
                      [-ipstatic_source_dir <arg>] [-lib_map_path <arg>]
                      [-no_script] [-sync] [-reset] [-force] [-quiet]
                      [-verbose]

Returns: List of files that were exported.

Usage

Table 1. export_ip_user_files
Name	Description
`[-of_objects]`	IP, IP integrator or a fileset. Default: None
`[-ip_user_files_dir]`	Directory path to simulation base directory (for static, dynamic, wrapper, netlist, script, and MEM files). Default: None
`[-ipstatic_source_dir]`	Directory path to the static IP files. Default: None
`[-lib_map_path]`	Compiled simulation library directory path. Default: Empty
`[-no_script]`	Do not export simulation scripts. Default: 1
`[-sync]`	Delete IP/IP integrator dynamic and simulation script files.
`[-reset]`	Delete all IP/IP integrator static, dynamic and simulation script files.
`[-force]`	Overwrite files.
`[-quiet]`	Ignore command errors.
`[-verbose]`	Suspend message limits during command execution.

Description

Export IP user files repository with static, dynamic, netlist, Verilog/VHDL stubs, and memory initialization files.

Arguments

-of_objects: (Optional) Specify the target object for which the IP static and dynamic files need to be exported.
-ip_user_files_dir: (Optional) Directory path to IP user files base directory (for dynamic and other IP non-static files). By default, if this switch is not specified, this command uses the path specified with the IP.USER_FILES_DIR project property value.
-ipstatic_source_dir: (Optional) Directory path to the static IP files. By default, if this switch is not specified, this command uses the path specified with the SIM.IPSTATIC_SOURCE_DIR project property value.
Note: If the -ip_user_files_dir switch is specified, by default, the IP static files are exported under the sub-directory with the name ipstatic. If this switch is specified with -ipstatic_source_dir, the IP static files are exported in the path specified with the -ipstatic_source_dir switch.

Examples

The following command exports char_fifo IP dynamic files to <project>/<project>.ip_user_files/ip/char_fifo directory and char_fifo IP static files to <project>/<project>.ip_user_files/ipstatic directory:

% export_ip_user_files -of_objects [get_ips char_fifo]