report_place_status - 2024.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-11-13
Version
2024.2 English

Report on status of the placement.

Syntax

report_place_status [‑return_sites] [‑return_string] [‑file <arg>]
    [‑append] [‑of_objects <args>] [‑site_type <arg>] [‑list_all_sites]
    [‑dump_placement] [‑placement_type <arg>] [‑quiet] [‑verbose]

Usage

Name Description
[-return_sites] Return a list of sites that match the given -site_type type
[-return_string] Set the result of running the report in the Tcl interpreter's result variable
[-file] Filename to output results to. (send output to console if -file is not used)
[-append] Append the results to file, don't overwrite the results file
[-of_objects] Report detailed placement status for these sites
[-site_type] Only show sites with the given status: ROUTE_THRU_SITE|INVALID_RS|TIE_OFF_SITE|ILLEGAL_PL|PLACE D|HAS_ROUTE_THRUS|HAS_TIE_OFFS|HAS_INVERTED_IN|FIXED_CEL LS (ignored if -of_objects is used)
[-list_all_sites] List full placement information for every site in the design (ignored if -of_objects is used)
[-dump_placement] Show the full placement information for every used site in the design. This is VERY VERBOSE.
[-placement_type] Routed site type : PLACEDB|PREROUTE|WITH_ROUTING
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Report

Description

Reports the state of placement in the current design.

Arguments

-return_sites - (Optional) Return a list of sites that match the given -site_type type. When the -return_sites argument is used, it is required to also use the -site_type argument.
Note: This argument cannot be used with -return_string, -of_objects, or -dump_placement arguments. This argument does not generate the report_place_status output.

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

-file <arg> - (Optional) Write the report into the specified file. Specify the -append option to avoid overwriting the file. If the path is not specified as part of the file name, the file is written into the current working directory, or the directory from which the Vivado is launched.

-of_objects <args> - (Optional) Report detailed placement status for these sites.
Note: This argument option requires objects to be specified using the get_sites command. In addition, this option cannot be used with the -return_sites option.
-site_type <arg> - (Optional) Only show sites with the specified placement status. Valid place states are:
  • FIXED_CELLS - Sites with a fixed-cell(s)
  • HAS_INVERTED_IN - Sites with Inverted Inputs
  • HAS_ROUTE_THRUS - Sites has route thrus
  • HAS_TIE_OFFS - Site ties some pins off
  • ILLEGAL_PL - Illegal Placement Sites
  • INVALID_RS - Invalid Routed Sites
  • PLACED - Sites has no errors
  • ROUTE_THRU_SITE - Sites with route thrus
  • TIE_OFF_SITE - Sites with tie-off
Note: The -site_type option is ignored if -of_objects is also specified.
-dump_placement - (Optional) Report the full placement information for every used site in the design.
Note: This a very long report and takes time to generate. Do not use this option with the -return_sites option.

-placement_type - (Optional) Design attributes to check include: PLACEDB, PREROUTE, WITH_ROUTING.

-list_all_sites - (Optional) Report summary placement status for every site in the design.
Note: This option is ignored if -of_objects is also specified.
-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 reports the place status for the specified sites:
 report_place_status -of_objects [ get_sites AIE* ]

See Also

place_design