Gets the list of ip preference objects
Syntax
get_board_ip_preferences [‑regexp] [‑nocase] [‑filter <arg>]
‑of_objects <args> [‑quiet] [‑verbose] [<patterns>...]
Returns
List of ip preferences for the component.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching |
[-filter]
|
Filter list with expression |
-of_objects
|
Get 'ip_preference' objects of these types: 'board_component_mode board_component_interface'. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
match ip preferences against patterns Default: * Values: The default search pattern is the wildcard *, or .* when -regexp is specified. |
Description
Gets a list of IP preferences defined on the current board, as defined in the Board Interface file.
The board file, board.xml located in the data/boards folder of the Vivado™ Design Suite installation area, stores information regarding board attributes. The board provides a representation of the overall system that the device is a part of, and can help define key aspects of the design, such as clock constraints, I/O port assignments, and supported interfaces. You can create custom boards by defining a custom Board Interface file, as described in the Vivado Design Suite User Guide: System-Level Design Entry (UG895).
IP preferences define the preferred IP to connect a component interface to in the Board Interface file.
This command returns a list of preferred IP for specified component interfaces, or component modes, or returns an error if it fails.
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
- (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_board_ip_preferences
based on property values on the ip_preference objects. 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 ip_preference object, "IP_NAME" and "IP_VENDOR" are two 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> - (Required) Get the preferred IP of the specified board_component_mode or board_component_interface 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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match preferred IP against the specified search patterns. The default pattern is the wildcard '*' which gets a list of all IP preferences defined for the specified component mode or component interface.
Examples
The following example gets the IP preferences of the specified component interfaces:
get_board_ip_preferences -of_objects \
[get_board_component_interfaces *clock*]