hsi::current_hw_instance - 2020.2 English

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

Document ID
UG1400
Release Date
2020-12-15
Version
2020.2 English

Description

Set or reset current hardware instance.

Syntax

current_hw_instance [-quiet] [-verbose] [<instance>] 

Returns

Current cell instance object, "" if failed.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<instance>] hardware cell instance to be set

Categories

Hardware

Description

Sets or resets the current hardware instance to the given hierarchial instance, for scoping the hardware data access commands in a hierarchial design. Default is top design.

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.

<instance> - (optional) Hardware cell instance (hierarchial instance) to be set.

Examples

The following example sets the current hardware instance to axi_ethernet_0:
hsi::current_hw_instance [get_cells axi_ethernet_0]
hsi::get_cells

Returns the hardware cell instances inside current hierarchial instance axi_ethernet_0.