get_ip_upgrade_results - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Get a list of results for IP upgrades during the current project


get_ip_upgrade_results [‑srcset <arg>] [‑quiet] [‑verbose] [<objects>...]


List of IP upgrade results.


Name Description
[-srcset] (Optional) Specifies the source file set containing the upgraded IP Default: The current source fileset Values: Source set name
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<objects>] IP to be upgraded Values: IP instance(s) within the design, as returned by 'get_ips <instance name>' or 'get_bd_cells <cell name>'


Object, Project, IPFlow


Returns the names of the upgrade_log files for the specified IPs.

This command is used by the Vivado™ IDE to populate the IP Status Report window with information from the upgrade_log file. You can use the command to quickly obtain the upgrade_log file name, and then use the appropriate file commands, to read or display the contents.

This command returns the upgrade_log file names of the specified IP objects, or returns an error if it fails.


-srcset <arg> - (Optional) Specify an alternate source file set to examine for the specified IPs. This lets you change from the default, which is the sources_1 fileset.

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

<objects> - (Optional) Specify the IP objects to report the upgrade results for. IP objects are returned by the get_ips command.


The following example returns the upgrade_log filenames for all IPs in the current fileset:

get_ip_upgrade_results [get_ips]

The following example prints the upgrade logs for the upgraded IP to the Tcl console:

set ipDefs [get_ip_upgrade_results [get_ips]]
for {set x 0} {$x<[llength $ipDefs]} {incr x} {
   set ipRoot [file rootname [lindex $ipDefs $x]]
   puts "Upgrade Log for $ipRoot"
   set ipDir [get_property IP_DIR [get_ips $ipRoot]]
   set ipLog [lindex $ipDefs $x]
   set catLog [concat $ipDir/$ipLog]
   # Check for file existence, and read file contents
   if {[file isfile $catLog]} {
      # Open the file for read, save the File Handle
      set FH [open $catLog r]
      #puts "Open $FH"
      set content [read $FH]
      foreach line [split $content \n] {
         # The current line is saved inside $line variable
         puts $line
      close $FH
      #puts "Close $FH"