export_ip_user_files - 2020.2 English

(User-written application) Generate and export IP/IPI 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

Name	Description
`[-of_objects]`	IP,IPI or a fileset object 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 IP static 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/IPI dynamic and simulation script files
`[-reset]`	Delete all IP/IPI 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 initializaton files.

Arguments

-of_objects <arg> - (Optional) Specify the target object, IP, block design (.bd) or a fileset, for which the IP static and dynamic files need to be exported.

-ip_user_files_dir <arg> - (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 then this command will use the path specified with the "IP.USER_FILES_DIR" project property value.

-ipstatic_source_dir <arg> - (Optional) Directory path to the static IP files. By default, if this switch is not specified then this command will use the path specified with the "SIM.IPSTATIC_SOURCE_DIR" project property value.

Note: If the -ip_user_files_dir option is specified, by default the IP static files will be exported under the sub-directory with the name "ipstatic". However, if this option is also specified, then the IP static files will be exported in the path specified with this option.

-lib_map_path <arg> - (Optional) Compiled simulation library directory path.

-no_script - (Optional) Do not export simulation scripts.

-sync - (Optional) Delete IP/IPI dynamic and simulation script files.

-reset - (Optional) Delete all IP/IPI static, dynamic and simulation script files.

-force - (Optional) Overwrite existing files.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.

Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.

-verbose - (Optional) Temporarily override any message limits and return all messages from this command.

Note: Message limits can be defined with the set_msg_config command.

Examples

The following command will export the dynamic files for the char_fifo IP to <project>/<project>.ip_user_files/ip/char_fifo directory, and IP static files to <project>/<project>.ip_user_files/ipstatic directory:

export_ip_user_files -of_objects [get_ips char_fifo]