hsi::open_hw_design - 2021.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2021-12-15
Version
2021.2 English

Description

Open a hardware design from disk file.

Syntax

open_hw_design [-quiet] [-verbose] [<file>]

Returns

Hardware design object. Returns nothing if the command fails.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<file>] Hardware design file to open

Categories

Hardware

Description

Opens a Hardware design in the Hardware Software Interface. The hardware design must be exported previously using the Vivado product. Users can open multiple hardware designs at same time.

If successful, this command returns a hardware design object representing the opened Hardware design. Otherwise it returns an error.

Arguments

-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 are returned. Only errors occurring inside the command are 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.

file - The path and file name of the Hardware design to open in the HSM. The name must include the file extension.

Examples

Open the specified IP subsystem design in the current project:

open_hw_design C:/Data/project1/project1.sdk/SDK/SDK_Export/hw/design_1.xml
OR
open_hw_design  C:/Data/project1/project1.sdk/design_1_wrapper.xsa