Vivado设计套件TCL命令参考指南

需积分: 10 111 浏览量更新于2024-07-14 收藏 13.28MB PDF 举报

"Vivado Design Suite Tcl Command Reference Guide UG835(v2017.4) 是一份关于Vivado工具中的Tcl命令的手册，包含了2017.4版本新增和修改的命令列表。" 在Vivado设计环境中，Tcl (Tool Command Language) 是一种强大的脚本语言，用于自动化设计流程、管理项目以及执行各种设计任务。通过Tcl，用户可以创建自定义的工作流，提高设计效率和一致性。这份指南详细列出了Vivado支持的所有Tcl命令，涵盖了设计综合、实现、布局布线、调试等多个阶段。 2017.4版本中新增的Tcl命令包括： 1. `connect_debug_cores`：用于连接调试核心，便于硬件调试。 2. `generate_base_platform`：生成基础平台，是构建嵌入式系统的基础步骤。 3. `generate_pblock`：创建物理块（PBlock），这是一种对设计中特定区域进行保护或优化的手段。 4. `generate_rl_platform` 和 `generate_shx_platform`：可能与生成特定类型的硬件平台有关，如实时（Real-time）或系统硬件扩展（SHX）平台。修改的命令有： 1. `auto_detect_xpm`：自动检测XPM（可编程逻辑模块）元件，可能涉及到自动配置和验证过程。 2. `config_hw_sio_gts`：配置硬件串行输入/输出（SIO）和通用时钟信号（GTS）设置，用于接口的定制化。 3. `config_webtalk`：可能涉及WebTalk服务的配置，WebTalk是Xilinx用于收集匿名使用数据的服务。 4. `current_frame`：获取当前仿真帧的信息，用于调试和分析目的。 5. `export_as_example_design`：将设计导出为示例设计，方便他人理解和复用。 6. `get_pplocs`、`get_stacks` 和 `get_waves`：获取设计中特定位置、堆栈或波形数据，用于报告和分析。 7. `make_bd_intf_pins_external` 和 `make_bd_pins_external`：将Block Diagram中的接口引脚或引脚设为外部，以便与其他系统连接。 8. `move_wave`、`remove_wave`：在波形视图中移动或移除波形，优化调试界面。 9. `report_frames`、`report_sdx_utilization` 和 `report_sim_device`：生成关于帧、SDx（Software Defined eXtensions）利用率和模拟设备的报告，用于性能评估。 10. `report_stacks`：提供关于设计堆栈的详细信息。 11. `save_bd_design_as`：将Block Diagram设计另存为新的文件。 12. `update_hw_firmware`：更新硬件固件，确保与设计同步。 13. `update_hw_gpio`：更新GPIO（General Purpose Input/Output）设置，适应设计变化。 14. `write_dsa_rom`：可能用于编写DSA（Device Support Archive）引导ROM，与硬件平台的初始化有关。这些命令的详细使用方法和参数在完整的参考指南中会有详尽的解释，包括每个命令的语法、输入参数、返回值以及可能的错误情况。通过熟练掌握这些Tcl命令，用户可以高效地进行Vivado设计工作，实现自动化工作流程，从而提升设计质量和效率。对于大型项目和团队协作来说，Tcl脚本的使用尤为关键。

This command searches for a cell named inst_1 within the rst level of hierarchy under the top-

level of hierarchy. To recursively search for a paern at every level of hierarchy, use the following

syntax:

• get_cells -hierarchical inst_1

This command searches every level of hierarchy for any instances that match inst_1.

For complete coverage of the command syntax, see the specic online help for the individual

command:

• help get_cells

• get_cells -help

Object Properties

Objects have properes that can be queried. Property names are unique for any given object

type. To query a specic property for an object, the following command is provided:

• get_property

property_name object

For example, the lib_cell property on cell objects tells you what UniSim component a given

instance is mapped to:

• get_property lib_cell [get_cell inst_1]

To discover all of the available properes for a given object type, use the report_property

command:

• report_property [get_cells inst_1]

The following table shows the pr

operes returned for a specic object.

Key Value Type

bel OLOGICE1.OUTFF string

class cell string

iob TRUE string

is_blackbox 0 bool

is_fixed 0 bool

is_partition 0 bool

is_primitive 1 bool

is_reconfigurable 0 bool

is_sequential 1 bool

lib_cell FD string

loc OLOGIC_X1Y27 string

name error string

primitive_group FD_LD string

Chapter 1: T

cl and Batch Scripting

Tcl Command Reference Guide 16

UG835 (v2017.4) December 20, 2017 www.xilinx.com [placeholder text]

Send Feedback

Key Value Type

primitive_subgroup flop string

site OLOGIC_X1Y27 string

type FD & LD string

XSTLIB 1 bool

Some properes are read-only and some are user-seable. Properes that map to aributes that

can be annotated in UCF or in HDL are generally user-seable through Tcl with the set_property

command:

• set_property loc OLOGIC_X1Y27 [get_cell inst_1]

Filtering Based on Properties

The object query get_* commands have a common opon to lter the query based on any

property value aached to the object. This is a powerful capability for the object query

commands. For example, to query all cells of primive type FD do the following:

• get_cells * -hierarchical -filter “lib_cell == FD”

To do more elaborate string ltering, ulize the =~ operator to do string paern matching. For

example, to query all ip-op types in the design, do the following:

• get_cells * -hierarchical -filter “lib_cell =~ FD*”

Mulple lter properes can be combined with other property lters with logical OR (||) and

AND (&&) operators to make very powerful searches. To query every cell in the design that if of

any op type and has a placed locaon constraint:

• get_cells * -hierarchical -filter {lib_cell =~ FD* && loc != “”}

Note: In the example, the lter opon value was wrapped with curly braces {} instead of double quotes.

This is normal Tcl syntax that prevents command substuon by the interpreter and allows users to pass

the empty string (“”) to the loc property.

Handling Lists of Objects

Commands that return more than one object, such as get_cells or get_sites, return a

collecon in the Vivado tool that looks and behaves like a nave Tcl list. This feature allows

performance gains when handling large lists of Tcl objects without the need to use special

commands like the foreach_in_collecon command. In the Vivado Design Suite collecons can be

processed like Tcl lists using built-in commands such as lsort, lsearch, and foreach.

Chapter 1: T

cl and Batch Scripting

Tcl Command Reference Guide 17

UG835 (v2017.4) December 20, 2017 www.xilinx.com [placeholder text]

Send Feedback

Typically, when you run a get_* command, the returned results are echoed to the console and

to the log le as a Tcl string, rather than as a list due to a feature of Tcl called "shimmering".

Internally, Tcl can store a variable or value both as a string and as a faster nave object such as a

oat or a list object. In Tcl, shimmering occurs when the representaon of the object or value

changes from the list object to the string object, or from string to list. A list of Vivado objects is

returned by the get_* command, but the shimmered string representaon is wrien to the log

le and Tcl console.

However, to improve performance and prevent overloading memory buers, the Vivado Design

Suite limits and truncates the shimmered string to a default character length dened by the

tcl.collectionResultDisplayLimit parameter, which has a default value of 500.

Commands that can return a signicant number of objects, such as get_cells or get_sites,

will truncate the returned string, ending it with an ellipsis ('...'). You can use the set_param

command to change the tcl.collectionResultDisplayLimit parameter value to return

more or fewer results.

CAUTION!: T

he combinaon of shimmering and the

tcl.collectionResultDisplayLimit

parameter prevents the use of

and

list operators in the Vivado Design Suite. Since a string

shimmered from the list may be truncated, the

and

operators cannot eecvely determine if a

specied object is in, or not-in, a list of objects. You should use list commands such as

lsearch

and

lsort

instead of

if {[lsearch -exact [get_cells *] $cellName] != -1} {...}

You can capture the complete list returned by the get_* c

ommand by assigning the results to a

Tcl variable:

set allSites [get_sites]

he actual list in the variable assignment includes the complete result set, and is not truncated by

the tcl.collectionResultDisplayLimit parameter. An example of this is seen in

hierarchically querying all the cells in a design:

%set allCells [get_cells -hierarchical]

DataIn_pad_0_i_IBUF[0]_inst DataIn_pad_0_i_IBUF[1]_inst \

DataIn_pad_0_i_IBUF[2]_inst DataIn_pad_0_i_IBUF[3]_inst \

DataIn_pad_0_i_IBUF[4]_inst ...

%llength $allCells

42244

%lindex $allCells end

wbArbEngine/s4/next_reg

n the preceding example, the result of the hierarchical get_cells command was assigned to

the $allCells variable. In appearance, the results are truncated. However, a check of the

length of the list reports more than forty thousand cell objects, and the last index in the list

returns an actual object, and not an ellipsis.

Chapter 1: T

cl and Batch Scripting

Tcl Command Reference Guide 18

UG835 (v2017.4) December 20, 2017 www.xilinx.com [placeholder text]

Send Feedback

剩余1801页未读，继续阅读

糖葫芦光

粉丝: 1
资源: 7

Vivado设计套件TCL命令参考指南

Arduino-Vivado-SDK实现与C++集成的Microblaze和Cortex A9库

Vivado-RISC-V FPGA设计教程与实践

Xilinx MPSOC vcu-modules-xilinx_v2021.1 开发指南

ug835-vivado-tcl-commands.pdf

ug835-vivado-tcl-commands.pdf UG835 (v2022.2) October 19, 2022

ug835-vivado-tcl-commands_2018.pdf

ug835-vivado-tcl-commands.rar_Xilinx Zynq-7000_Xilinx tcl UG_tcl

ug835-vivado-tcl-commands，TCL脚本语言教程

ug894-vivado-tcl-scripting.pdf

ug953-vivado-7series-libraries.pdf

最新资源