get_qor_checks - 2022.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2022-10-19

Version

2022.2 English

Get a list of available QoR suggestions

Syntax

get_qor_checks [‑family <arg>] [‑filter <arg>] [‑quiet] [‑verbose] [<IDs>]

Returns

List of available qor suggestions.

Usage

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

Description

Get all available QoR suggestion objects. This command returns a list of all available QoR suggestion objects.

Arguments

-filter <arg> -(Optional) Filter the returned available 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 available_suggestion object, CATEGORY, AUTO and INCR_FRIENDLY are a few of properties you might use to filter the list of available suggestions.

-family <arg> - (Optional) Filter the returned available suggestion objects with the specified family name. Some valid device family names are zynquplus, kintexu, and versalpremium.

<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_checks RQS_CLOCK-5_1

To get available suggestion objects based on the device family (Ultrascale, Ultrascale+, or Versal)

get_qor_checks -family Versal

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

get_qor_checks -filter {CATEGORY==Timing}

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