vivado tcl 命令手册

Vivado Design Suite Tcl

Command Reference Guide

UG835 (v2018.3) December 5, 2018

Revision History

The following table shows the revision history for this document:

Section

Revision Summary

12/5/2018 v2018.3

add_hw_hbm_pc, create_bd_intf_tlm_port, create_bd_tlm_port,

get_speed_models, get_waivers, group_path, iphys_opt_design, link_design,

open_checkpoint, open_wave_database, opt_design, phys_opt_design,

read_iphys_opt_tcl, report_bus_skew, report_clock_utilization,

report_design_analysis, report_ip_status, report_methodology, report_power,

report_qor_suggestions, report_timing, report_timing_summary, save_project_as,

update_hw_firmware, write_checkpoint, write_iphys_opt_tcl, write_ip_tcl,

write_waivers, xsim

Commands Modified in 2018.3

06/06/2018 v2018.2

create_bd_intf_tlm_port, create_bd_tlm_port, implement_xphy_cores Commands Added in 2018.2

commit_hw_hbm, create_gui_custom_command,

create_gui_custom_command_arg, create_port_on_reconfigurable_module,

create_rqs_run, current_dashboard, generate_platform, get_dashboards,

get_gui_custom_command_args, get_gui_custom_commands, get_hw_hbms,

refresh_hw_hbm, refresh_meminit, remove_gui_custom_command_args,

remove_gui_custom_commands, write_ip_tcl

Commands Added in 2018.1

check_timing, config_ip_cache, create_hw_axi_txn, create_slack_histogram,

create_waiver, delete_waivers, get_files, get_filesets, get_pblocks,

report_timing, report_timing_summary, report_utilization, report_waivers,

route_design, synth_design, upgrade_ip, write_bd_tcl, write_checkpoint,

write_dsa_rom, write_waivers, write_xdc, xsim

Commands Modified in 2018.1

UG835 (v2018.3) December 5, 2018 www.xilinx.com

Tcl Command Reference Guide 2

SDC is the mechanism for communicang ming constraints for FPGA synthesis tools from

Synopsys Synplify as well as other vendors, and is a ming constraint industry standard;

consequently, the Tcl infrastructure is a “Best Pracce” for scripng language.

Tcl lets you perform interacve queries to design tools in addion to execung automated

scripts. Tcl oers the ability to “ask” quesons interacvely of design databases, parcularly

around tool and design sengs and state. Examples are: querying specic ming analysis

reporng commands live, applying incremental constraints, and performing queries immediately

aer to verify expected behavior without re-running any tool steps.

The following secons describe some of the basic capabilies of Tcl with Vivado.

which you manage sources and the design process yourself, also known as Non-Project Mode.

Alternavely, you can use a project-based method to automacally manage your design process

and design data using projects and project states, also known as Project Mode. Either of these

methods can be run using a Tcl scripted batch mode or run interacvely in the Vivado IDE. For

more informaon on the dierent design ow modes, see the Vivado Design Suite User Guide:

Design Flows Overview (UG892).

UG835 (v2018.3) December 5, 2018 www.xilinx.com

Tcl Command Reference Guide 3

If you prefer to work directly with Tcl commands, you can interact with your design using Tcl

commands with one of the following methods:

• Enter individual Tcl commands in the Vivado Design Suite Tcl shell outside of the Vivado IDE.

• Enter individual Tcl commands in the Tcl Console at the boom of the Vivado IDE.

Vivado yyyy.x Tcl Shell, where “yyyy.x” is the installed version of Vivado.

For more informaon about using Tcl and Tcl scripng, see the Vivado Design Suite User Guide:

Using the Tcl Scripng Capabilies (UG894). For a step-by-step tutorial that shows how to use Tcl

in the Vivado tool, see the Vivado Design Suite Tutorial: Design Flows Overview (UG888).

You can use the Vivado tools in batch mode by supplying a Tcl script when invoking the tool. Use

the following command either at the Linux command prompt or within a Windows Command

Prompt window:

Chapter 1: Introduction

UG835 (v2018.3) December 5, 2018 www.xilinx.com

Tcl Command Reference Guide 4

You can launch the Vivado Design Suite and run the tools using dierent methods depending on

your preference. For example, you can choose a Tcl script-based compilaon style method in

and design data using projects and project states, also known as Project Mode. Either of these

methods can be run using a Tcl scripted batch mode or run interacvely in the Vivado IDE. For

more informaon on the dierent design ow modes, see the Vivado Design Suite User Guide:

Design Flows Overview (UG892).

If you prefer to work in a GUI, you can launch the Vivado IDE from Windows or Linux. For more

informaon on the Vivado IDE, see the Vivado Design Suite User Guide: Using the Vivado IDE

(UG893).

Launch the Vivado IDE from your working directory. By default the Vivado journal and log les,

and any generated report les, are wrien to the directory from which the Vivado tool is

launched. This makes it easier to locate the project le, log les, and journal les, which are

If you need help, with the Vivado tool command line executable, type:

If you are running the Vivado tool from the Vivado Design Suite Tcl shell, you can open the

Vivado IDE directly from the Tcl shell by using the start_gui command.

From the Vivado IDE, you can close the Vivado IDE and return to a Vivado Tcl shell by using the

When you invoke the Vivado tool, it writes the vivado.log le to record the various

commands and operaons performed during the design session. The Vivado tool also writes a le

Chapter 1: Introduction

UG835 (v2018.3) December 5, 2018 www.xilinx.com

Tcl Command Reference Guide 5