ザイリンクス Tcl Store へのアクセス
ザイリンクス Tcl Store では、ストアに関する情報をユーザーの $HOME/.Xilinx (Linux) または %APPDATA%/
Xilinx (Windows) に保存します。この保存された情報により、Vivado リリースごとにユーザーがインストールした アプリのリストが管理されます。これらのディレクトリは、オンラインのザイリンクス Tcl Store リポジトリから更新 およびアップデートされたアプリをキャッシュするためにも使用されます。
図 12: ザイリンクス Tcl Store の使用条件
[Xilinx Tcl Store] ダイアログ ボックスには、2 つのパネルがあります。
図 13: ザイリンクス Tcl Store の GUI
左側のパネルには使用可能なアプリがリストされ、右側のパネルには左側のパネルで選択したアプリに関する情報が 表示されます。各アプリに関して、次の情報が示されます。
• Name: アプリの名前。
• 説明: アプリの簡単な説明。
• 改訂内容: アプリのリビジョン番号。
• 必須: アプリを使用するのに最低限必要な Vivado リリース バージョン ([Xilinx Tcl Store] ダイアログ ボックスを開 く では Vivado 2014.1)。
• Company: アプリを提供および管理する企業の名前。
• URL: GitHub のアプリ ページへのハイパーリンク。ここからさまざまなプロシージャのコードにアクセスできま す。
• Tcl Procs: アプリに含まれる Tcl プロシージャのリスト。各プロシージャの簡単な説明。
アプリのインストール
アプリをインストールするには、アプリ名の右側にある [Install] ボタンをクリックします。アプリをインストールす ると、そのアプリで定義されているプロシージャが使用できるようになります。プロシージャは、アプリ名と企業名 から構成される特定の名前空間に取り込まれ、Vivado のネイティブ ビルトイン コマンドと同様に使用できます。新 しい Tcl コマンドは、自動的にヘルプ構造に登録されます。
アプリのインストール に手順を示します。ザイリンクスでは、アプリをインストールする前に [Refresh] ボタンをク リックしてカタログを更新し、アプリの最新バージョンがインストールされるようにすることをお勧めします (1)。
[Install] をクリックしてアプリをインストールします。
図 14: [Install] ボタン
アプリをインストールすると、プロシージャの名前がハイパーリンクになり、[Install] ボタンが淡色表示されます。ア プリのインストール では、designutils アプリがインストールされています。
図 15: インストールされた DesignUtils アプリ
インストールされたアプリに関するヘルプの表示
アプリがインストールされると、各プロシージャに関するヘルプ情報を表示できるようになります。プロシージャの 詳細なヘルプは、2 つの方法で表示できます。ハイパーリンクの付いたプロシージャ名をクリックすると、詳細なヘ ルプを表示するダイアログ ボックスが開きます。プロシージャ名を右クリックしても、ヘルプ メニュー項目を含む コンテキスト ウィンドウが開きます。[Help] をクリックすると、選択したプロシージャに対する埋め込み型ヘルプが 開きます。また、Tcl コンソールに完全名前空間を含むプロシージャ名と -help コマンド ライン オプションを入力し ても、詳細ヘルプを表示できます。
次の図は、xilinx::designutils::write_template の詳細なヘルプを示しています。
図 16: write_template のヘルプ
同じ詳細ヘルプは、Tcl コンソールに次のように入力しても表示できます。
vivado% xilinx::designutils::write_template -help
注記: このプロシージャの完全修飾子は xilinx::designutils::write_template で、write_template のみ ではありません。
インストールされたアプリに含まれる Tcl プロシージャへのアクセス
アプリをインストールしたら、そのアプリに含まれるすべてのプロシージャにコマンド ラインから次の 2 つの方法で アクセスできます。
• ::<company>::<app> 名前空間から。Vivado IDE を起動すると、インストールされた各アプリに含まれるすべ てのプロシージャに対してラッパーが自動的に作成されます。
• アプリの完全名前空間修飾子 ::tclapp::<company>::<app> から (プロシージャが定義されている名前空 間)。
たとえば、designutils アプリをインストールすると、ユーザー プロシージャ write_template には次のコマンドで アクセスできます。
vivado% ::xilinx::designutils::write_template
vivado% ::tclapp::xilinx::designutils::write_template
::tclapp::xilinx 名前空間ではなく ::xilinx 名前空間からプロシージャーを呼び出す利点は、Vivado で作成 されるラッパーでは、すべてのビルトイン Vivado コマンドに共通の -help、-verbose、-quiet などの多数のデ フォルト コマンド ライン オプションがサポートされることにあります。
次に例を示します。
Vivado% xilinx::designutils::write_template -help xilinx::designutils::write_template
Description:
(User-written application)
Generates a Verilog/VHDL stub or instantiation template for the current design in
memory (current_instance) Syntax:
xilinx::designutils::write_template [-type <arg>] [-stub] [-template]
[-language <arg>] [-verilog] [-vhdl]
[-cell <arg>] [-file <arg>] [-append]
[-return_string] [-usage] [-quiet]
[-verbose]
Returns:
template in the case of -return_string, otherwise 0 TCL_ERROR if error Usage:
Name Description
[-type] Type of template to create: stub or template Default: stub
[-stub] Generate a stub (same as -type stub)
[-template] Generate a template (same as -type template) [-language] Output language of the template: verilog or vhdl Default: verilog
[-verilog] Verilog language (same as -language verilog) [-vhdl] VHDL language (same as -language vhdl)
[-cell] Cell to generate template on. If not specified, runs on current_instance
Default: current_instance [-file] Output file name
Default: <module>.v or <module>.vhd [-append] Append to file
[-return_string] Return template as string [-usage] Usage information
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution Categories:
Description:
Generates a Verilog/VHDL stub or instanciation template for the current design
in memory (current_instance).
This command must be run on a synthesized or implemented design.
Example:
::xilinx::designutils::write_template -verilog -return_string
ソース コードへのアクセス
アプリまたは特定のプロシージャのソース コードにアクセスするには、次の 2 つの方法があります。[Details] ペイン には、GitHub への URL リンクが含まれます。このリンクをクリックすると、デフォルト ブラウザーで GitHub 内の アプリ ページが開きます。このページから、各プロシージャのソース コードにアクセスできます。
図 17: GitHub アプリ ページへのハイパーリンク
アプリをインストールすると、プロシージャ名がハイパーリンクに変わります。ソースコードを表示するには、プロ シージャ名をクリックし、[View Source Code] をクリックします。
注記: Tcl Store では、プロシージャの依存性は認識されません。[Source] ウィンドウには選択したプロシージャの内容 のみが表示され、依存するプロシージャは表示されません。完全なアプリ コードは、GitHub のアプリの URL から参 照できます。
図 18: 変更後のソース コード