hsi::get_cells - 2023.2 English

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

Document ID
Release Date
2023.2 English


Get a list of cells.


get_cells [-regexp] [-filter <arg>] [-hierarchical] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...] 


Cell objects. Returns nothing if the command fails.


Name Description
[-regexp] Patterns are full regular expressions
[-filter] Filter list with expression
[-hierarchical] Get cells from all levels of hierarchical cells
[-of_objects] Get 'cell' objects of these types: 'hw_design port bus_intf net intf_net'.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match cell names against patterns Default: *




Gets a list of IP instance objects in the current design that match a specified search pattern. The default command returns a list of all IP instances in the design.

Note: To improve memory and performance, the commands return a container list of a single type of objects (e.g. cells, nets, or ports). You can add new objects to the list (using lappend for instance), but you can only add the same type of object that is currently in the list. Adding a different type of object, or string, to the list is not permitted and will result in a Tcl error.


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

Quote the filter search pattern to avoid having to escape special characters that might be found in net, pin, or cell names, or other properties. String matching is case sensitive and is always anchored to the start and to the end of the search string. The wildcard * character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the * wildcard character, this matches a property with a defined value of "".

For string comparison, the specific operators that can be used in filter expressions are equal (==), not-equal (!=), match (=~), and not-match (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||).

For cell objects, "IP_TYPE", and "IP_NAME" are some of the properties you can use to filter results. The following gets cells with an IP_TYPE of "PROCESSOR" and with names containing "ps7":
get_cells * -filter {IP_TYPE == PROCESSOR && NAME !~ "*ps7*"}

-hierarchical - (optional) Get cells from all levels of hierarchical cells .

-of_objects <arg> - (optional) Get the cells connected to the specified pins, timing paths, nets, bels, clock regions, sites or DRC violation objects.

-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 cells against the specified patterns. The default pattern is the wildcard `*` which gets a list of all cells in the project. More than one pattern can be specified to find multiple cells based on different search criteria.

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


The following example returns list of processor instances :

hsi::get_cells -filter { IP_TYPE == "PROCESSOR" }

This example gets a list of properties and property values attached to the second object of the list returned by get_cells:

common::report_property [lindex [get_cells] 1]
Note: If there are no cells matching the pattern you will get a warning.