Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 6/20/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.32.4. get_fitter_resource_usage (::quartus::report)

The following table displays information for the get_fitter_resource_usage Tcl command:

Tcl Package and Version

Belongs to ::quartus::report

Syntax get_fitter_resource_usage [-h | -help] [-long_help] [-alm] [-alut] [-available] [-io_pin] [-lab] [-le] [-mem_bit] [-percentage] [-reg] [-used] [-utilization]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-alm Get total adaptive logic modules
-alut Get total Combinational ALUTs
-available Get available resource summary
-io_pin Get total I/O pins
-lab Get total logic array blocks
-le Get total logic elements
-mem_bit Get total memory bits
-percentage Get used resource summary in percentage
-reg Get total registers
-used Get used resource summary
-utilization Get total logic utilization
Description
Gets the Fitter resource usage results.

You must use one of the following options: "-alut", "-reg", "-le",
"-alm", "-lab", "-io_pin", "-mem_bit" or "-resource".

If the above option is not "-resource", you may also optionally use
one of the following options: "-used", "-available" or "-percentage".

Option "-resource" takes resource name as parameter, which supports wildcards.
Example Usage
load_package report
project_open chiptrip
load_report

# Shortcut of get_fitter_resource_usage command
set cmd     get_fitter_resource_usage

# Get total registers, logic elements, and DSP block 9-bit elements.
set registers [$cmd -reg]
set alms      [$cmd -alm]
set io_pin    [$cmd -io_pin -available]
set mem_bit   [$cmd -mem_bit -percentage]
set dsp       [$cmd -resource "DSP block 9*"]
puts "Registers usage: $registers"
puts "Total used ALMs: $alms"
puts "Total available I/O pins: $io_pin"
puts "Total used memory bits in percentage: ${mem_bit}%"
puts "DSP block 9-bit elements: $dsp"

unload_report
project_close
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Command requires one of the following options: -alut, -reg, -le, -alm, -lab, -io_pin, mem_bit or -resource. Specify one of the options.
TCL_ERROR 1 ERROR: Options -used, -available and -percentage can't be used together. Specify either one or none of the options.
TCL_ERROR 1 ERROR: Option -resource was used with option -used, -available or -percentage. Use option -resource only.
TCL_ERROR 1 ERROR: Can't find panel: <string>. Make sure the project was compiled by quartus_fit and the panel was not deleted.