Get the clock regions for the current device.
Syntax
get_clock_regions [‑regexp] [‑nocase] [‑filter <arg>] [‑of_objects <args>]
[‑quiet] [‑verbose] [<patterns>]
Returns
Clock_regions
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions. |
[-nocase]
|
Perform case-insensitive matching. (valid only when -regexp specified). |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get the clock_regions of these tiles, sites, slrs, cells, or package bank |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match objects' name against patterns. Default: * |
Description
Gets a list of clock regions on the target part that match a specified search pattern. The default command gets a list of all clock regions on the device in an open design.
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.
-nocase
- (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp
only.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_clock_regions
based on property values on the clock regions. You can find the properties on an object with the report_property
or list_property
commands. Any property/value pair can be used as a filter. In the case of the clock region object, "COLUMN_INDEX", "HIGH_X", and "LOW_X" 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
<args> - (Optional) Get the clock regions of the SLRs that the clock region is part of using the get_slrs
command. Or get the clock_regions that the specified tiles, device sites, I/O banks, or cells are assigned to.
-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 clock regions against the specified patterns. The default pattern is the wildcard '*' which gets a list of all clock regions on the device. More than one search pattern can be specified to find clock regions based on different search criteria.
Examples
The following example returns the clock regions matching the search pattern:
get_clock_regions X0*
The following example returns the clock regions filtered by the specified property:
get_clock_regions -filter {LOW_X==0}
The following example returns the clock regions that the specified ILA debug core trigger is assigned to, or placed in:
get_clock_regions -of_objects [get_cells -hierarchical basic_trigger*]