create_report_config - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Create Configurable Report objects.

Syntax

create_report_config [‑report_name <arg>] [‑report_type <arg>]
    ‑steps <args> ‑runs <args> [‑options <arg>] [‑copy_of <args>] [‑quiet]
    [‑verbose]

Returns

List of configurable report objects.

Usage

Name Description
[-report_name] Name of configurable report object created. Can not be used when creating multiple objects
[-report_type] Type of configurable report object(s) created. Not required with '-copy_of'
-steps List of run step(s) for object(s) created
-runs List of run(s) for object(s) created
[-options] options for report command to be set at creation of configurable report object, except with '-copy_of'
[-copy_of] configurable report object to be copied
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Object, Report

Description

This command lets you create configurable report objects to add to synthesis and implementation runs, or to add to Report Strategies. A report object defines the report type and options that are run every time a specified step of a synthesis or implementation design run is completed. A Report Strategy lets you define a collection of report objects to associate with many synthesis and implementation runs, and reuse at different stages of the design flow. See the Vivado Design Suite User Guide: Implementation (UG904) for more information.

Each report object has the 'OPTIONS.MORE_OPTIONS' property, which lets you specify command line options of the Tcl report_* command associated with the report object. These command line options are used when the report is generated during the synthesis or implementation run. You can specify the command line options using the -options argument as described below, or by manually setting the 'OPTIONS.MORE_OPTIONS' property of an existing report object using the set_property command. Refer to the specific report_* command for information on the available command line options.

Arguments

-report_name <arg> - (Optional) Specifies the name to assign to the report when it is generated. When the name is not specified, the name will be automatically defined as a combination of the -runs, -steps, and -report_type options.

Tip: The -report_name option cannot be specified when creating multiple report objects. In this case the report name will be automatically defined.

-report_type <arg> - (Optional) Specifies the report command to be run by the report object. Most of the report_* Tcl commands can be specified as the report type to create.

Tip: The -report_type cannot be specified when using the -copy_of option to create a copy of an existing report object.

-steps <args> - (Required) Specifies the synthesis or implementation process steps to associate the report object with. The object can be specified for use with multiple steps to have the report rerun at each step, in which case the name of the report will be automatically defined. Accepted values include all of the available process steps for synthesis or implementation: synth_design, opt_design, place_design, route_design...

-runs <args> - (Required) Specifies the synthesis or implementation design run to associate the report object with. The object can be specified for use with multiple design runs, in which case the name of the report will be automatically defined.

-options <arg> - (Optional) Specifies various command line options for the specific report_* command being run. See the specific report command for the available options. This option can not be specified when using the -copy_of option to create a copy of an existing report object.

Important: There is no checking provided of the -options to ensure the options are correct and applicable to the report type specified. If you indicate options that are incorrect the report will return an error when it is run.

-copy_of <arg> - (Optional) Specifies a report object to use as a template for the new report object. The new report object can be associated with new -steps and -runs.

Tip: The -report_type and -options cannot be specified when using the -copy_of option.
-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.

Examples

The following example defines a new report object with the specified name and type and associates it with the route_design step of the impl_1 run:

create_report_config -report_name post_route_datasheet -report_type report_datasheet \
-steps route_design -runs impl_1

This example is the same as the prior example, except it does not specify the name, and so the report object is named automatically as shown in the return value:

create_report_config -report_type report_datasheet -steps route_design -runs impl_1
impl_1_route_report_datasheet_0

The following example creates a new report object for the timing summary report, with the specified command-line options, and associates the object with multiple steps of an implementation run:

create_report_config -report_type report_timing_summary \
-steps {opt_design place_design route_design} -runs {impl_2}\
-options {-no_detailed_paths -report_unconstrained}