カスタムリファレンス設計のためのカスタムパラメーターおよびコールバック関数の定義

カスタムリファレンス設計を定義する場合、オプションでhdlcoder.ReferenceDesignオブジェクトのプロパティを使用してカスタムパラメーターおよびコールバック関数を定義します。

カスタムパラメーターの定義およびコールバック関数ハンドルの登録

この MATLAB^®コードは、カスタムパラメーターの登録方法およびリファレンス設計定義関数内にあるカスタムコールバック関数の関数ハンドルの登録方法を示します。

functionhRD = plugin_rd()% Reference design definition% Construct reference design objecthRD = hdlcoder.ReferenceDesign('SynthesisTool','Xilinx Vivado'); hRD.ReferenceDesignName ='My Reference Design'; hRD.BoardName ='ZedBoard';% Tool informationhRD.SupportedToolVersion = {'2018.3'};%% Add custom design files% ...% ...%% Add optional custom parameters by using addParameter property.% Specify custom 'DUT path' and 'Channel Mapping' parameters.% The parameters get populated in the 'Set Target Reference Design'% task of the HDL Workflow Advisor.hRD.addParameter(...'ParameterID','DutPath',...'DisplayName','Dut Path',...'DefaultValue','Rx',...'ParameterType', hdlcoder.ParameterType.Dropdown,...'Choice', {'Rx','Tx'}); hRD.addParameter(...'ParameterID','ChannelMapping',...'DisplayName','Channel Mapping',...'DefaultValue','1');%% Enable JTAG MATLAB as AXI Master IP Insertion. The IP% insertion setting is visible in the 'Set Target Reference Design'% task of the HDL Workflow Advisor. By default, the% AddJTAGMATLABasAXIMasterParameter property is set to 'true'.hRD.AddJTAGMATLABasAXIMasterParameter ='true'; hRD.JTAGMATLABasAXIMasterDefaultValue ='on';%% Add custom callback functions. These are optional.% With the callback functions, you can enable custom% validations, customize the project creation, software% interface model generation, and the bistream build.% Register the function handle of these callback functions.% Specify an optional callback for 'Set Target Reference Design'% task in Workflow Advisor. Use property name% 'PostTargetReferenceDesignFcn'.hRD.PostTargetReferenceDesignFcn =...@my_reference_design.callback_PostTargetReferenceDesign;% Specify an optional callback for 'Set Target Interface' task in Workflow Advisor.%使用道具erty name 'PostTargetInterfaceFcn'.hRD.PostTargetInterfaceFcn =...@my_reference_design.callback_PostTargetInterface;% Specify an optional callback for 'Create Project' task%使用道具erty name 'PostCreateProjectFcn' for the ref design object.hRD.PostCreateProjectFcn =...@my_reference_design.callback_PostCreateProject;% Specify an optional callback for 'Generate Software Interface Model' task%使用道具erty name 'PostSWInterfaceFcn' for the ref design object.hRD.PostSWInterfaceFcn =...@my_reference_design.callback_PostSWInterface;% Specify an optional callback for 'Build FPGA Bitstream' task%使用道具erty name 'PostBuildBitstreamFcn' for the ref design object.hRD.PostBuildBitstreamFcn =...@my_reference_design.callback_PostBuildBitstream;% Specify an optional callback for 'Program Target Device'% task to use a custom programming method.hRD.CallbackCustomProgrammingMethod =...@my_reference_design.callback_CustomProgrammingMethod;%% Add interfaces% ...% ...

カスタムパラメーターの定義

hdlcoder.ReferenceDesignクラスのaddParameterメソッドを使用して、カスタムパラメーターを定義できます。前述のコード例では、リファレンス設計は 2 つのカスタムパラメーターDUT PathおよびChannel Mappingを定義します。addParameterメソッドの詳細については、addParameterを参照してください。

AXI Master IP としての JTAG MATLAB の挿入の指定

既定では、HDL Coder™ によりパラメーター[Insert JTAG MATLAB as AXI Master (HDL Verifier Required)]がすべてのリファレンス設計に追加されます。このパラメーターをonに設定すると、コードジェネレーターによって自動的に JTAG MATLAB AXI Master IP がリファレンス設計に挿入されます。JTAG MATLAB AXI Master IP を使用すると、FPGA ボードで生成された DUT IP コアの AXI レジスタに MATLAB JTAG 接続を通じて簡単にアクセスできます。Set Up for AXI Manager(HDL Verifier)も参照してください。

この機能を使用するには、HDL Verifier™ ハードウェアのサポートパッケージがインストールされ、ダウンロードされていなければなりません。Download FPGA Board Support Package(HDL Verifier)を参照してください。

コードジェネレーターは、AXI Master IP 接続として MATLAB に対応するように[AXI4 スレーブ ID の幅]を調整します。HDL IP コアを生成してリファレンス設計プロジェクトを作成すると、Vivado^®ブロック設計を開いてリファレンス設計に挿入されている JTAG MATLAB AXI Master IP を表示できます。

前述のコード例では、リファレンス設計によりhdlcoder.ReferenceDesignクラスのAddJTAGMATLABasAXIMasterParameterプロパティとJTAGMATLABasAXIMasterDefaultValueプロパティが定義されます。これらのプロパティは、HDL ワークフローアドバイザーの[ターゲットのリファレンス設計を設定]タスクで[Insert JTAG MATLAB as AXI Master (HDL Verifier Required)]設定の既定の動作を制御します。hdlcoder.ReferenceDesignクラスでこれらのプロパティのいずれも指定しない場合、[Insert JTAG MATLAB as AXI Master (HDL Verifier Required)]パラメーターは[ターゲットのリファレンス設計を設定]タスクに表示され、値はoffに設定されます。このコード例は、既定の動作を説明しています。

%% Default behavior of Insert JTAG as AXI Master option% This parameter controls visibility of the option in% 'Set Target Reference Design Task' of HDL Workflow Advisor% By default, the parameter value is set to 'true',% which means that the option is displayed in the UI. If% you do not want the parameter to be displayed, set this% value to 'false'.hRD.AddJTAGMATLABasAXIMasterParameter ='true';% This parameter controls the value of the option in the% the 'Set Target Reference Design Task' task. By default,% the value is 'off', which means that the parameter is% displayed in the task and the value is off. To enable% automatic insertion of JTAG AXI Master IP in the reference% design, set this value to 'on'. In that case, the% AddJTAGMATLABasAXIMasterParameter must be set to 'true'.hRD.JTAGMATLABasAXIMasterDefaultValue ='off';

以下の例を参照してください。

IP コアの生成ワークフローの実行

HDL ワークフローアドバイザーを開くと、HDL Coder により[ターゲットのリファレンス設計を設定]タスクにリファレンス設計名、ツールバージョン、指定したカスタムパラメーターが入力され、[Insert JTAG MATLAB as AXI Master (HDL Verifier Required)]オプションがonに設定されます。

HDL Coder は次に、これらのパラメーター値をコールバック関数の入力構造体に渡します。

合成ツールが Xilinx^®Vivado である場合、HDL Coder はリファレンス設計のパラメーター値を変数に設定します。変数は、ブロック設計の Tcl ファイルの入力となります。このコードの抜粋は、リファレンス設計プロジェクト作成の Tcl ファイルの例です。

update_ip_catalog设置DutPath ChannelMapp {Rx}ing {1} source vivado_custom_block_design.tcl

コードは、HDL Coder がカスタムブロック設計の Tcl ファイルに値を設定する前に、リファレンス設計パラメーターを設定する方法を示します。

コールバック関数ハンドルの登録

リファレンス設計定義では、カスタムコールバック関数を参照するために関数ハンドルを登録できます。次を行うことができます。

カスタム検証を有効にする。
リファレンス設計を動的にカスタマイズします。
リファレンス設計プロジェクト作成の設定をカスタマイズ。
生成されたソフトウェアインターフェイスモデルを変更。
FPGA ビットストリームのビルドプロセスをカスタマイズ。
カスタム FPGA プログラミング方法を指定。

hdlcoder.ReferenceDesignクラスを使用して、コールバックのプロパティ名を定義できます。コールバックプロパティには命名規則があります。コールバック関数には任意の名前を指定できます。HDL ワークフローアドバイザーでは、コールバック関数を定義して次のタスクをカスタマイズできます。

ワークフローアドバイザーのタスク	コールバックのプロパティ名	機能
ターゲットのリファレンス設計を設定	`CustomizeReferenceDesignFcn` `PostTargetReferenceDesignFcn`	`CustomizeReferenceDesignFcn`は、リファレンス設計のカスタマイズを動的に有効にします。このコールバック関数を使用して、ブロック設計 Tcl ファイル、リファレンス設計インターフェイス、リファレンス設計インターフェイスプロパティ、およびリファレンス設計の IP リポジトリをカスタマイズできます。リファレンス設計のパラメーターに基づいたリファレンス設計の動的なカスタマイズを参照してください。 `PostTargetReferenceDesignFcn`はカスタム検証を有効にします。[リセットタイプ]が`[同期]`であることを確認する方法を示す例については、`PostTargetReferenceDesignFcn`を参照してください。
ターゲットインターフェイスを設定	`PostTargetInterfaceFcn`	カスタム検証を有効にする。特定のカスタムパラメーター設定向けに特定のインターフェイスを選択していないことを確認する方法を示す例については、`PostTargetInterfaceFcn`を参照してください。
プロジェクトを作成	`PostCreateProjectFcn`	HDL Coder がプロジェクトを作成するときにカスタム設定を指定します。例については、`PostCreateProjectFcn`を参照してください。
ソフトウェアインターフェイスの生成	`PostSWInterfaceFcn`	生成されたソフトウェアインターフェイスモデルを変更。例については,`PostSWInterfaceFcn`を参照してください。
FPGA ビットストリームのビルド	`PostBuildBitstreamFcn`	FPGA ビットストリームを作成するときにカスタム設定を指定します。この関数を使用する場合、ビルドプロセスを外部で実行することはできません。[FPGA ビットストリームのビルド]タスクの[ビルドプロセスを外部で実行]チェックボックスをオフにして、ビルドプロセスを HDL ワークフローアドバイザー内で実行しなければなりません。例については、`PostBuildBitstreamFcn`を参照してください。
ターゲットデバイスをプログラム	`CallbackCustomProgrammingMethod`	カスタムの FPGA プログラミングメソッドを指定します。例については、`CallbackCustomProgrammingMethod`を参照してください。