コード ガイドライン - 2023.2 日本語

Vivado Design Suite ユーザー ガイド: Tcl スクリプト機能の使用 (UG894)

Document ID
UG894
Release Date
2023-11-17
Version
2023.2 日本語

Vivado Tcl Store はオープンソースのリポジトリであり、内部および外部ユーザーが Tcl スクリプトを投稿し、AMD コミュニティ内で共有できるようにします。スクリプトが重複していないことを確実にし、一貫性を保持するため、ゲートキーピング コミティにより投稿が評価されます。このプロセスの詳細は、Wiki ページ (https://github.com/Xilinx/XilinxTclStore/wiki/Xilinx-Tcl-Store-Home) を参照してください。

このセクションでは、Vivado Tcl Store にアプリを投稿する際に従う必要のあるコード記述ガイドラインを示します。これらのガイドラインにより、スクリプトがVivado Tcl Store の機構に準拠していること、すべてのアプリおよび Tcl スクリプトでプロシージャおよび変数の間に名前の競合がないことなどが確実になります。ただし、Tcl Store に投稿する際のプロセスについては説明しません。投稿プロセスについては、Wiki を参照してください。

Vivado Tcl Store には、参考となるコード例として使用可能な Tcl スクリプトが多数あります。また、次のディレクトリにテンプレート アプリがあります。

<VIVADO_INSTALL>/data/XilinxTclStore/tclapp/mycompany/template/*

このテンプレートは、サンプル スクリプトと、新しいアプリで使用する必要のあるディレクトリ構造を示します。このセクションでは、次のスクリプトを例として使用します。

<VIVADO_INSTALL>/data/XilinxTclStore/tclapp/mycompany/template/myscript1.tcl

このセクションのコード例では、アプリ名が template、アプリを提供および管理する企業の名前が mycompany であるとします。

用語

  • ユーザー プロシージャ: ユーザーが実行するプロシージャ。
  • ヘルパー プロシージャ: ユーザー プロシージャでタスクを実行するためにバックグラウンドで使用されるプロシージャ。ヘルパー プロシージャは、ユーザーによって直接実行されることはなく、ヘルプ システムには含まれません。