Get a list of block diagram cells
Syntax
get_bd_cells [‑regexp] [‑hierarchical] [‑filter <arg>] [‑of_objects <args>]
[‑quiet] [‑verbose] [<patterns>]
Returns
List of block diagram cell objects, "" if failed.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-hierarchical]
|
Hierarchical cells included |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get cells of these pins or nets |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match engine names against patterns Default: * |
Categories
Description
Get a list of cells in the current IP integrator subsystem design, or current subsystem instance. IP integrator subsystem cells are either IP cores drawn from the IP integrator catalog, or hierarchical modules created in the subsystem design with the create_bd_cell
command.
get_*
commands return a container list of a single type of objects (e.g. cells, nets, pins, 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.
Arguments
-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 http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-hierarchical
- (Optional) Get cells from all levels of the IP integrator subsystem design hierarchy, or current instance. Without this argument, the command will only get cells from the top of the design hierarchy. When using -hierarchical
, the search pattern should not contain a hierarchy separator because the search pattern is applied at each level of the hierarchy, not to the full hierarchical cell name. For instance, searching for U1/* searches each level of the hierarchy for instances with U1/ in the name. This may not return the intended results.
-regexp
, the specified search string is matched against the full hierarchical name, and the U1/* search pattern will work as intended.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_bd_cells
based on property values on the block design cells. You can find the properties on an object with the report_property
or list_property
commands. In the case of the IP integrator cell object, "VLNV", "TYPE" and "LOCATION" are some of the properties that can be used to filter results.
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
bool
) type properties can be directly evaluated in filter expressions as true or not true: -filter {IS_PRIMITIVE && !IS_LOC_FIXED}
-of_objects <arg>
- (Optional) Get the subsystem cells that are connected to the specified pin or net objects, as returned by the get_bd_nets
and get_bd_pins
, or get_bd_intf_pins
commands.
-of_objects
option requires objects to be specified using the get_*
commands, such as get_cells
or get_pins
, rather than specifying objects by name. In addition, -of_objects
cannot be used with a search <pattern>
.
-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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match subsystem cells against the specified patterns. The default pattern is the wildcard '*' which gets a list of all cells in the current IP subsystem design. More than one pattern can be specified to find multiple cells based on different search criteria.
Examples
The following example gets a list of cells that include the specified IP integrator subsystem pin, and sorts the list to remove duplicate entries:
lsort -unique [get_bd_cells -of_objects [get_bd_pins -hierarchical *aclk*]]
The following example gets a list of all cells in all levels of the subsystem design hierarchy, and then filters the list to include only those cells whose name includes the specified text, or hierarchy:
get_bd_cells -hierarchical -filter {NAME=~"/newMod1/*"}