package_xo コマンド - 2021.1 Japanese

Vitis 統合ソフトウェア プラットフォームの資料: アプリケーション アクセラレーション開発 (UG1393)

Document ID
UG1393
Release Date
2022-03-29
Version
2021.1 Japanese

構文

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 コマンドは、Vivado Design Suite 内の Tcl コマンドです。RTL で記述されたカーネルは、Vivado ツールで package_xo コマンド ライン ユーティリティを使用してコンパイルされ、ザイリンクス オブジェクト ファイル (XO) が生成されます。このオブジェクト ファイルは、v++ コマンドでのリンク段階で使用されます。

表 1. 引数
引数 説明
-kernel_name <arg> (必須) RTL カーネルの名前を指定します。
-force (オプション) 同じ名前の XO ファイルが存在する場合にそれを上書きします。
-kernel_xml <arg> (オプション) 既存のカーネル XML ファイルへのパスを指定します。Vivado ツールでは、何も指定されていない場合、XO ファイルに対して kernel.xml ファイルが作成されます。
-output_kernel_xml (オプション) カーネル XML ファイルを書き込むパスを指定します。Vivado ツールは XO ファイルに含める kernel.xml ファイルを作成し、指定された出力ファイルにも書き込みます。
ヒント: このオプションを使用すると、package_xo コマンドの入力として編集および使用できる kernel.xml ファイルを生成できます。
-design_xml <arg> (オプション) 既存のデザイン XML ファイルへのパスを指定します。
-ip_directory <arg> (オプション) パッケージ IP のディレクトリへのパスを指定します。
-parent_ip_directory (オプション) 指定したカーネル IP ディレクトリに複数の IP が含まれる場合、その component.xml がすぐ下に含まれる親 IP へのディレクトリ パスを指定します。
-kernel_files (オプション) カーネル ファイル名。カーネル XO に C モデルを追加して、カーネルのソフトウェア エミュレーションをイネーブルにできます。
-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 カーネル プロパティ で説明されるカーネル制御プロトコルで、有効な値は、ap_ctrl_hsap_ctrl_chainap_ctrl_noneuser_managed です。
ヒント: -ctrl_protocol を指定しない場合は、デフォルトで ap_ctrl_hskernel.xml ファイルに書き込まれます。
-xo_path <arg> (必須) コンパイル オブジェクト (XO) ファイルのパスおよびファイル名を指定します。
-quiet (オプション) コマンドをメッセージを表示せずに実行します。実行中にエラーが発生してもしなくても、TCL_OK が返されます。
注記: コマンドの実行中にコマンド ラインで発生したエラーは返されます。コマンド内で発生したエラーのみが非表示になります。
-verbose (オプション) メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。
注記: メッセージの非表示設定は、set_msg_config コマンドで定義できます。

次の例では、ap_ctrl_chain 制御プロトコルを使用して指定した名前の RTL カーネルを含む指定した XO ファイルが作成されてから、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 ファイルで定義されます。