hsi::get_dt_nodes - 2021.2 English

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

Document ID
UG1400
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

Description

Get a list of DT node objects.

Syntax

get_dt_nodes [-hier] [-regexp] [-filter <arg>] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...] 

Returns

Node objects. Returns nothing if the command fails.

Usage

Name Description
[-hier] List of nodes in the current tree.
[-regexp] Patterns are full regular expressions
[-filter] Filter list with expression
[-of_objects] Get '' objects of these types: 'dtsNode dtsTree'.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match cell names against patterns Default: *

Categories

DeviceTree

Description

Gets a list of DT nodes created under a DT tree in the current HSI session that match a specified search pattern. The default command gets a list of all root DT nodes in the current DT tree.

Arguments

-of_objects <arg> - (optional) Gets all nodes of DTSNode and DTSTree

Note: The -of_objects option requires objects to be specified using the get_* commands, such as get_dt_nodes or get_dt_trees, rather than specifying objects by name. In addition, -of_objects cannot be used with a search <pattern>.
-regexp – (optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx regular expression Tcl commands are always anchored to the start of the search string. You can add .* to the beginning or end of a search string to widen the search to include a substring. See this web page for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information, refer to this web page.

-filter <args> – (optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned based on property values on the objects. You can find the properties on an object with the report_property or list_property commands.

-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.

<patterns> - (optional) Match nodes against the specified patterns. The default pattern is the wildcard `*` which gets a list of all root nodes in the current DT tree. More than one pattern can be specified to find multiple nodes based on different search criteria.

Note: You must enclose multiple search patterns in braces, {}, or quotes, "", to present the list as a single element.

Examples

The following example gets a list of root nodes attached to the specified DT tree:

hsi::get_dt_nodes -of_objects [lindex [get_dt_trees] 1]
Note: If there are no nodes matching the pattern, the tool will return empty.

The following example gets a list of all nodes in the current DT tree:

hsi::get_dt_nodes -hier
Note: If there are no nodes matching the pattern, the tool will return empty.

The following example gets a list of nodes created under a root node:

hsi::get_dt_nodes -of_objects [current_dt_tree]
Note: If there are no nodes matching the pattern, the tool will return empty.