Get a list of IP from the current IP Catalog
Syntax
get_ipdefs [‑name] [‑regexp] [‑nocase] [‑filter <arg>] [‑of_objects <args>]
[‑all] [‑quiet] [‑verbose] [<patterns>...]Returns
List of Catalog IP objects
Usage
| Name | Description |
|---|---|
[-name]
|
Match the pattern against IP display name instead of VLNV |
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get the IPDefs of the objects specified: IP inst or XCI file. |
[-all]
|
Return hidden IP |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
The patterns to match against Default: * Values: The default search pattern is the wildcard *, or .* when -regexp is specified. |
Description
Get a list of IP cores defined in the IP catalog of the current project, based on the specified search pattern. The default is to return all IP cores defined in the Vivado tools IP catalog.
By default, the search is based on the VLNV property of the IP cores in the catalog. You can specify the -name option to search on the display name of IP cores instead.
Arguments
-name - (Optional) Indicates that the specified <pattern> refers to the DISPLAY_NAME property of the IP instead of the VLNV property.
-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> - Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_ipdefs based on property values on the objects. You can find the properties on an object with the report_property or list_property commands. In the case of the "ipdefs" object, "VLNV", "NAME" and "IS_AXI" 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 IP definitions for the specified IP instances or IP file (.xci) objects. Objects must be specified by the get_ips or get_files command.
-all - (Optional) Get the IP definitions from all defined IP catalogs and repositories. By default, the get_ipdefs command will return the IP cores from the standalone IP catalog. This option returns IP from both the standard Vivado tool IP catalog, and the IP integrator IP catalog.
-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.Examples
get_ipdefs -filter {NAME=~*agilent*}get_ipdefs -filter {IS_AXI==1}get_ipdefs -all *axi_interconnect*get_ipdefs -all *axi_interconnect* -filter {DESIGN_TOOL_CONTEXTS =~*IPI*}get_ipdefs -all *axi_interconnect* -filter {UPGRADE_VERSIONS == ""}