create_qor_ruledeck - create_qor_ruledeck - 2026.1 English - UG835

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2026-06-23
Version
2026.1 English

Description

Create one or more user-defined QoR rule decks which are used for grouping QoR checks use when running report_qor_suggestions or report_qor_assessment.

A QoR rule deck object is a vehicle to create a group of QoR rule checks. The rule decks only contain QoR checks with the same TYPE property. When grouped for convenience, it allows a single point of reference for multiple checks. The tool provides a set of factory predefined rule decks.

Use the get_qor_ruledecks command to return a list of the currently defined rule decks. If the rule decks created by this command are empty and does not contain any checks, add QoR checks to the rule deck using the add_qor_checks command.

For any mistake, you can delete the existing rule deck using delete_qor_ruledeck command. You cannot remove QoR checks from a ruledeck. To get a list of design rule checks that are available to include in the ruledeck, use the get_qor_checks command. In a rule deck, use the following command to generate the suggestions and assessments:

report_qor_suggestions -ruledecks [list <suggestion_rule_deck_name>]
report_qor_assessment -ruledecks [list <assessment_rule_deck_name>]

Arguments

<ruledecks> - Specifies a list containing the names of the rule decks to create.

-type - (Optional) Specifies the type of ruledecks to create. Valid values are either "suggestion" or "assessment." The default value is "suggestion", and the command only returns rule decks of the suggestion type.

Note: You can assign the same name to both assessment and suggestion rule decks. To retrieve any assessment type ruledecks, use the -type assessment switch.

Examples

The following shows an example of registering a new suggestion called RQS_NETLIST_AMD-1. It takes proc called unroll_srl_to_input which is inside file unroll_srl_to_input.tcl. It sets the applicable for value to opt_design, adds a description, and a summary and adds the suggestion to the Netlist category.

source unroll_srl_to_input.tcl
set af [list opt_design]
set cat Netlist
set desc "Unroll SRL inputs when driving by a LUT"
create_qor_check -name RQS_NETLIST_AMD-1 -rule_body unroll_srl_to_input -property_values [list APPLICABLE_FOR $af CATEGORY $cat DESCRIPTION $desc]

The following example shows that with check created, it is ready to add to the rule deck. First a rule deck named AMD_Netlist_OptDesign is created, then the check named RQS_NETLIST_AMD-1 is added.

create_qor_ruledeck -type suggestion AMD_Netlist_OptDesign
add_qor_check -ruledeck AMD_Netlist_OptDesign RQS_NETLIST_AMD-1

The following example verifies the inclusion of the check in the rule deck:

get_qor_checks -of [get_qor_ruledecks AMD_Netlist_OptDesign]