package_xo 命令 - 2023.2 简体中文

Vitis 统一软件平台文档 应用加速开发 (UG1393)

Document ID
UG1393
Release Date
2023-12-13
Version
2023.2 简体中文

语法

package_xo  -kernel_name <arg> [-force] [-kernel_xml <arg>]
            [-output_kernel_xml <arg>] [-design_xml <arg>]
            [-ip_directory <arg>] [-parent_ip_directory <arg>]
            [-kernel_files <args>] [-kernel_xml_args <args>]
            [-kernel_xml_pipes <args>] [-kernel_xml_connections <args>]
            [-ctrl_protocol <arg>] -xo_path <arg> [-quiet] [-verbose]

描述

package_xo 命令是 AMD Vivado™ Design Suite 中的 Tcl 命令。在 Vivado 工具内使用 package_xo 命令行实用工具来编译以 RTL 编写的内核,以生成赛灵思对象 (XO) 文件,随后供 v++ 命令在链接阶段中使用。

表 1. 实参
实参 描述
-kernel_name <arg> (必需)指定 RTL 内核的名称。
-force (可选)覆盖现有 XO 文件(如果存在)。
-kernel_xml <arg> (可选)指定到现有内核 XML 文件的路径。Vivado 工具将为 XO 文件创建 kernel.xml 文件。
-output_kernel_xml (可选)指定写入内核 XML 文件的路径。Vivado 工具将创建 kernel.xml 文件,将其包含在 XO 文件内,并写入指定的输出文件。
提示: 您可以使用该选项来生成 kernel.xml 文件,以供您对其进行编辑并在 package_xo 命令中用作为输入。
-design_xml <arg> (可选)指定到现有设计 XML 文件的路径
-ip_directory <arg> (可选)指定到已封装的 IP 目录的路径。
-parent_ip_directory (可选)如果指定的内核 IP 目录包含多个 IP,则指定到父 IP 的目录路径,该内核 IP 目录的 component.xml 即直接位于目录路径下。
-kernel_files (可选)内核文件名。可用于将 C 语言模型添加到您的内核 XO 以便为您的内核启用软件仿真。
-kernel_xml_args <args> (可选)生成含指定函数实参的 kernel.xml。每个实参值都应使用以下格式:
{name:addressQualifier:id:port:size:offset:type:memSize} 
注释: memSize 为可选。
-kernel_xml_pipes <args> (可选)生成含指定的一个或多个管道的 kernel.xml。每个管道值均使用以下格式:
{name:width:depth}
-kernel_xml_connections <args> (可选)生成含指定连接的 kernel.xml 文件。每个连接值都应使用以下格式:
{srcInst:srcPort:dstInst:dstPort}
-ctrl_protocol 内核控制协议,如 PL 内核属性 中所述。有效值包括:ap_ctrl_hsap_ctrl_chainap_ctrl_noneuser_managed
提示: 如果未指定 -ctrl_protocol,那么默认 ap_ctrl_hs 将写入 kernel.xml 文件。
-xo_path <arg> (必需)指定已编译的对象 (XO) 文件的路径和文件名。
-quiet (可选)以静默方式执行命令,不返回来自该命令的任何消息。此命令还会返回 TCL_OK,忽略执行期间遇到的所有错误。
注释: 启动该命令时,将返回命令行上遇到的任何错误。仅捕获该命令内部发生的错误。
-verbose (可选)暂时覆盖所有消息限制,并返回来自该命令的所有消息。
注释: 可使用 set_msg_config 命令定义消息限制。

示例

以下示例使用 ap_ctrl_chain 控制协议创建指定 XO 文件,其中包含指定名称的 RTL 内核,并创建 kernel.xml 文件,因为尚未指定此文件:

package_xo -xo_path Vadd_A_B.xo -kernel_name Vadd_A_B -ctrl_protocol ap_ctrl_chain -ip_directory ./ip
以下示例使用指定 kernel.xml 文件创建 XO 文件:
package_xo -xo_path Vadd_A_B.xo -kernel_name Vadd_A_B -kernel_xml kernel.xml -ip_directory ./ip
提示: 控制协议将在指定的 kernel.xml 文件内定义。