Get a list of IPs in the current design
Syntax
get_ips [‑regexp] [‑nocase] [‑all] [‑filter <arg>] [‑gt_sources]
[‑gt_targets] [‑exclude_bd_ips] [‑of_objects <args>] [‑quiet]
[‑verbose] [<patterns>...]
Returns
List of IP objects.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching |
[-all]
|
Include subcore IP in search |
[-filter]
|
Filter list with expression |
[-gt_sources]
|
Return gt wizard peer IPs |
[-gt_targets]
|
Return gt wizard IPs |
[-exclude_bd_ips]
|
Exclude all IP owned by a block design. |
[-of_objects]
|
Get 'ip' objects of these types: 'ip file'. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match IP names against patterns Default: * Values: The default search pattern is the wildcard *, or .* when -regexp is specified. |
Description
Get a list of IP cores in the current project based on the specified search pattern. The default command returns a list of all IPs in the project.
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.
-all
- (Optional) Returns submodules of IP objects. Submodules are IP instances that are created as part of the generation of the parent IP core. By default, only parent IP objects used in the current project or design are returned, any IP cores used within those parent IP objects are not returned.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_ips
based on property values on the IP cores. You can find the properties on an object with the report_property
or list_property
commands. In the case of the "IP" object, "NAME" and "DELIVERED_TARGETS" 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}
-exclude_bd_ips
- (Optional) Do not include IPs from the current design that belong to a block design object.
-of_objects <arg>
- (Optional) Get a list of the IP cores of the specified IP or file objects.
-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 IP cores in the design against the specified search patterns. The default pattern is the wildcard '*' which gets a list of all IP cores in the project. More than one pattern can be specified to find multiple cores based on different search criteria.
Examples
The following example returns a list of IP cores with names beginning with the string "EDK":
get_ips EDK*