setup_ip_static_library - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2022-05-05

Version

2022.1 English

(User-written application) Extract IP static files from the project or repository and prepare it for compile_simlib

Syntax

setup_ip_static_library [‑directory <arg>] [‑ip_repo_path <arg>]
    [‑ips <arg>] [‑library <arg>] [‑project] [‑install]
    [‑no_update_catalog] [‑force] [‑quiet] [‑verbose]

Returns

None

Usage

Name	Description
`[-directory]`	Extract static files in the specified directory Default: None
`[-ip_repo_path]`	Extract static files from the specified IP repository path Default: None
`[-ips]`	Extract static files for the specified IPs only Default: Empty
`[-library]`	Extract static files for the specified IP library Default: Empty
`[-project]`	Extract static files for the current project
`[-install]`	Extract static files for the IP catalog
`[-no_update_catalog]`	Do no update IP catalog Default: 1
`[-force]`	Overwrite static files
`[-quiet]`	Ignore command errors
`[-verbose]`	Suspend message limits during command execution

Description

Retrieve static simulation files for IP cores used in the current project, or from the Xilinx® IP catalog, and create a source library for the compile_simlib command to use for compiling the IP files for a specified simulator.

Arguments

-directory <arg> - (Optional) Directory path to the static library. By default, if this option is not specified, then the library will be written to a directory named static_compiled_lib in the current working directory.

-ip_repo_path args <args> - (Optional) Extract static files from the specified IP repository paths.

-ips <args> - (Optional) Extract static files for the specified IP objects only. IP can be specified by the get_ips command.

-library <args> - (Optional) Extract static files for the specified IP library. IP libraries can be specified by name.

-project - (Optional) Extract and prepare static source library for the current project.

-install <arg> - (Optional) Extract and prepare static source library for the IP catalog.

-no_update_catalog - (Optional) Do no update IP catalog.

-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 build static library for all the IPs in the current project in ./static_compiled_lib:

setup_ip_static_library -project

The following command will build static library for the current project in /work/simlib. The command will create the specified directory if it does not exist:

setup_ip_static_library -directory /work/simlib -project