Power and Thermal Analyzer User Guide

Download PDF
ID 865226
Date 9/29/2025
Public
Document Table of Contents
Document Table of Contents x
1. Overview of the Power and Thermal Analyzer 2. Estimating Power Consumption with the Power and Thermal Analyzer 3. Power and Thermal Analyzer (PTA) Graphical User Interface 4. Power and Thermal Analyzer Resource Types 5. Command Line Options and Scripting 6. Factors Affecting the Accuracy of the Power and Thermal Analyzer 7. Document Revision History for the Power and Thermal Analyzer User Guide A. Measuring Static Power B. Tcl Command Reference
1. Overview of the Power and Thermal Analyzer x
1.1. Accessing the Power and Thermal Analyzer 1.2. PTA Power Model Status 1.3. Definitions of Power Terms Used in this Document
2. Estimating Power Consumption with the Power and Thermal Analyzer x
2.1. Estimating Power Before Starting the FPGA Design 2.2. Estimating Power While Creating the FPGA Design 2.3. Estimating Power After Completing the FPGA Design 2.4. Estimating Power for Dual-Core Devices
3. Power and Thermal Analyzer (PTA) Graphical User Interface x
3.1. PTA - Device Selector Dialog Box 3.2. PTA - Primary GUI Components 3.3. PTA - Hierarchical Design Editor 3.4. PTA - Using Design Hierarchies in the Power and Thermal Analyzer 3.5. PTA - Entering Hierarchy Information Into the PTA 3.6. PTA - Current Drawn per Supply Tab 3.7. PTA - Temperature and Cooling Tab 3.8. PTA - Resource Utilization Panel 3.9. PTA - Register Dynamic Power in Agilex Devices 3.10. PTA - Input Fields 3.11. PTA - Data Entry Error Messages 3.12. PTA - Search Features 3.13. PTA - Filtered Searches 3.14. PTA - Using the Tcl Console to Perform Searches
4. Power and Thermal Analyzer Resource Types x
4.1. PTA - Power Summary 4.2. PTA - Root Entry 4.3. PTA - Instance 4.4. PTA - Logic Resource Type 4.5. PTA - RAM Resource Type 4.6. PTA - DSP Resource Type 4.7. PTA - Clock Resource Type 4.8. PTA - PLL Resource Type 4.9. PTA - I/O Resource Type 4.10. PTA - Transceiver Resource Type 4.11. PTA - Crypto Resource Type 4.12. PTA - NOC Resource Type 4.13. PTA - HBM Resource Type
4.10. PTA - Transceiver Resource Type x
4.10.1. PTA - Estimating E-Tile Channel PLL Power
5. Command Line Options and Scripting x
5.1. Invoking the Power and Thermal Analyzer from the Command Line 5.2. Running Scripts with the Power and Thermal Analyzer
6. Factors Affecting the Accuracy of the Power and Thermal Analyzer x
6.1. Toggle Rate 6.2. I/O Bank Allocation
B. Tcl Command Reference x
B.1. add B.2. copy B.3. delete B.4. edit B.5. export_design_file B.6. find_instances B.7. get_available_ips B.8. get_available_resource_types B.9. get_available_values B.10. get_first_error B.11. get_properties B.12. get_report B.13. get_report_names B.14. get_results B.15. get_value B.16. import_design_file B.17. move B.18. open_design_file B.19. pta::get_active_design B.20. pta::get_defaults B.21. pta::get_designs B.22. pta::locate B.23. pta::set_active_design B.24. pta::set_family B.25. recalculate_power B.26. redo B.27. save B.28. set_device B.29. set_view B.30. undo
1. Overview of the Power and Thermal Analyzer
2. Estimating Power Consumption with the Power and Thermal Analyzer
3. Power and Thermal Analyzer (PTA) Graphical User Interface
4. Power and Thermal Analyzer Resource Types
5. Command Line Options and Scripting
6. Factors Affecting the Accuracy of the Power and Thermal Analyzer
7. Document Revision History for the Power and Thermal Analyzer User Guide
A. Measuring Static Power
B. Tcl Command Reference

B.4. edit

Usage

edit [-h] [-help] [-long_help] [-property <new property-setting pair>] [-property_reset <Tcl property (or IP parameter) key>] [-target <target to modify>]
Arguments
-h: Quick usage.
-help: Short help.
-long_help: Long help with examples and possible return values.
-property <new property-setting pair>: The key value pairs (space delimited) to apply to the target. Property keys must be lower case.
-property_reset <Tcl property (or IP parameter) key>: The Tcl key(s) to clear inputs to empty string. Keys must be lowercase.
-target <target to modify>: The target to modify.

Tcl Package and Version

Belongs to ::quartus::pta 1.0 .

Description

This command modifies the target based on the targeted properties and their new settings.

Example Usage

edit -property {device} {MY_NEW_DEVICE}
edit -target {|a|b|logic} -property {logicuserinput_num_ff} {5}
edit -target {|a|b|logic} -property {logicuserinput_num_ff} {5} {logicuserinput_clock_freq} {600}
edit -target {|a|b|logic} -property_reset {logicuserinput_user_comments}
edit -target {|a|b|logic} -property_reset {logicuserinput_user_comments} {logicuserinput_module}
edit -target {|a|b|logic} -property {logicuserinput_num_ff} {5} -property_reset {logicuserinput_user_comments}

Return Value

Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: The requested operation expects that properties are provided as key-value pairs. Ensure that each argument has both a key and a value.
TCL_ERROR 1 ERROR: The requested operation expects that the Tcl keys are unique, but key "<string>" appears multiple times.
Level Two Title