get_qor_suggestions - 2020.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2020-11-18

Version

2020.2 English

Get a list of available QoR suggestions

Syntax

get_qor_suggestions [‑filter <arg>] [‑quiet] [‑verbose] [<IDs>]

Returns

list of qor suggestion objects

Usage

Name	Description
`[-filter]`	Filter list with expression
`[-quiet]`	Ignore command errors
`[-verbose]`	Suspend message limits during command execution
`[<IDs>]`	Match suggestion names against given names

Description

Get existing QoR suggestion objects created by the report_qor_suggestions command, or read into the design using read_qor_suggestions. The selected QoR objects can be written to a file using the write_qor_suggestions command. The suggestions created by the report command remain in memory until delete_qor_suggestions is run, or until it is overwritten by another report.

This command returns a list of existing QoR suggestion objects from the open design, or returns an error if it fails.

Arguments

-filter <arg> - (Optional) Filter the returned suggestion objects with the specified expression. The -filter argument filters the list of objects returned by the command 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 qor_suggestion object, ENABLED, CATEGORY, and AUTO are a few of properties you might use to filter the list of suggestions.

-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.

Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.

-verbose - (Optional) Temporarily override any message limits and return all messages from this command.

Note: Message limits can be defined with the set_msg_config command.

<IDs> - (Optional) Specify a list of QoR suggestion IDs to select the specified objects.

Examples

To return an individual suggestion, you can supply the full ID:

get_qor_suggestions RQS_CLOCK-5_1-1

Due to the naming style of suggestions, wildcard searches do NOT work directly. However you can use the filter command with -regexp to use wildcards as follows:

filter -regexp [get_qor_suggestions] {NAME =~ RQS_CLOCK.*}

You can also filter suggestions objects within a given category. Available categories include: Timing, Congestion, Utilization, XDC, Clocking, and Strategy. For example, the following returns suggestions related to the Timing category:

get_qor_suggestions -filter {CATEGORY==Timing}