report_hw_softmc - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Formatted report on Versal soft Memory Controller cores' (Soft MCs) memory configurations, calibration status, stages, and window margins data.


report_hw_softmc [‑file <arg>] [‑append] [‑return_string] [‑quiet]
    [‑verbose] <hw_objects>


Name Description
[-file] File name (including full path) to output the report results to
[-append] Set this option to append the report results to a file
[-return_string] Set this option to have report results returned as a string
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<hw_objects> Hardware Soft MC objects


Report, Hardware


Report formatted information on memory IP hardware configuration, calibration, and margin. It does not include the graphical margin scan plots that are available within the Vivado™ logic analyzer or Vivado Lab Edition.

In the Vivado tools, Versal soft memory controllers implemented into a design are associated with hw_softmc objects. These hw_softmc objects let you verify the calibration, read, and write window margins in your memory interface design. You can use the hardware manager GUI to check the calibration status, verify the read margin for both rising and falling edges of the clock, and write margin for both simple and complex patterns. You can also use an ILA and VIO core to verify the data integrity for the read and write operations.

Important: This command returns the reported data, or returns an error if it fails.


-file <arg> - (Optional) Write the report into the specified file.

Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.

-append - (Optional) Append the output of the command to the specified file rather than overwriting it.

Note: The -append option can only be used with the -file option.

-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. The Tcl string can be captured by a variable definition and parsed or otherwise processed.

Note: This argument cannot be used with the -file 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.

<hw_objects> - (Required) Inputs can only be hw_softmc objects, as returned by the get_hw_softmcs command.


The following example generates the report on the hw_softmc objects and outputs them to the text file specified:

report_hw_softmc -file C:/Data/softmc_report.txt [get_hw_softmcs]