スクリプトを使用した HDL ワークフローの実行

HDL ワークフローアドバイザーは、次のような Simulink^® サブシステムの HDL コードを生成する各段階と、FPGA 設計プロセスをサポートします。

モデルに HDL コード生成との互換性があるか確認し、非互換設定を自動的に修正。
HDL コード、テストベンチ、コードとテストベンチをビルドして実行するスクリプトの生成。
コシミュレーションまたは SystemVerilog DPI テストベンチ、コードカバレッジの生成 (HDL Verifier™ が必要)。
サードパーティ製の合成ツールとの統合による合成とタイミング解析。
合成時に取得したクリティカルパスなどの情報によるモデルのバックアノテーション。
FPGA インザループシミュレーション (HDL Verifier が必要) を含む、選択した FPGA 開発ターゲットデバイスと Simulink Real-Time™ FPGA I/O ワークフローに対する完全な自動ワークフロー。

HDL ワークフローアドバイザーは Simulink Online™ では使用できません。

HDL ワークフローをコマンドラインスクリプトとして実行するには、Simulink 設計により HDL ワークフローアドバイザーを構成し、実行してからスクリプトをエクスポートします。このスクリプトは HDL ワークフロー CLI コマンドを使用して、FPGA ビットストリームまたは合成プロジェクトの生成を含む、HDL ワークフローアドバイザーと同じタスクを実行します。

次のターゲットワークフロー向けの HDL ワークフロースクリプトをエクスポートできます。

Generic ASIC/FPGA
[FPGA-in-the-Loop] (HDL Verifier ライセンスが必要)
IP コアの生成
[Simulink Real-Time FPGA I/O] (Simulink Real-Time が必要)

既存のスクリプトを更新するには、それを HDL ワークフローアドバイザーにインポートして、タスクを変更してから更新したスクリプトをエクスポートします。あるいは、スクリプトを手動で編集できます。

HDL ワークフロースクリプトのエクスポート

HDL ワークフローアドバイザーで、すべてのタスクを設定して実行します。
[ファイル] 、 [スクリプトにエクスポート] を選択します。
[Export Workflow Configuration] ダイアログボックスで、ファイル名を入力してスクリプトを保存します。
スクリプトは、コマンドラインから実行できる MATLAB^® ファイルです。

メモ

スクリプトにエクスポートする場合、[リセットタイプ] の Asynchronous など、既定値はエクスポートされません。スクリプトからインポートする場合、モデルに変更がなければ、スクリプトの既定の設定は表示されません。

ワークフロースクリプトの詳細の指定

関数 hdlcoder.runWorkflow の Verbosity プロパティを使用して、コード生成および展開処理の進行に合わせて生成される進捗メッセージの詳細レベルを指定できます。hdlcoder.WorkflowConfig ワークフロー構成オブジェクトの hWC および Simulink 設定の model/DUTname のワークフローを実行中に詳細メッセージを生成するには、Verbosity を on に設定します。

hdlcoder.runWorkflow('model/DUTname', hWC, 'Verbosity', 'on');

HDL ワークフロースクリプトでのタスクの有効化または無効化

すべてのワークフロータスクを無効にするには、clearAllTasks メソッドを使用してワークフロー構成オブジェクトを更新します。

すべてのワークフロータスクを再度有効にするには、setAllTasks メソッドを使用してワークフロー構成オブジェクトを更新します。

1 つのワークフロータスクを実行

他のワークフロータスクを再実行せずに 1 つのワークフロータスクを実行するには、次の手順に従います。

clearAllTasks メソッドを実行して、ワークフロー構成オブジェクトのすべてのタスクを無効にします。
ワークフロー構成オブジェクトで、実行するタスクを有効にします。

たとえば、以前に HDL ワークフロースクリプトを実行して、ビットストリームを生成していた場合、他のワークフロータスクを再実行せずにターゲットハードウェアをプログラムできます。hdlcoder.WorkflowConfig ワークフロー構成オブジェクトの hWC および Simulink 設計の model/DUTname に対してターゲットデバイスのプログラミングタスクを実行するには、次を行います。

clearAllTasks メソッドを実行します。
```
hWC.clearAllTasks;
```
ターゲットデバイスのプログラミングタスクを有効にします。
```
hWC.RunTaskProgramTargetDevice = true;
```

ワークフローを実行します。

hdlcoder.runWorkflow('model/DUTname', hWC);

HDL ワークフロースクリプトのインポート

HDL ワークフローアドバイザーで、[ファイル] 、 [スクリプトからインポート] を選択します。
[ワークフローコンフィギュレーションのインポート] ダイアログボックスで、スクリプトファイルを選択して [開く] をクリックします。
HDL ワークフローアドバイザーは、インポートされたスクリプト設定を使用してタスクを更新します。

メモ

HDL ワークフローアドバイザースクリプトをインポートするときは、HDL ワークフローアドバイザー UI からエクスポートしたのと同じスクリプトを使用してください。

汎用 ASIC/FPGA ワークフロースクリプトの例

この例では、エクスポートされた HDL ワークフロースクリプトを構成して実行する方法を説明します。

このスクリプトは、Xilinx^® Virtex^® 7 デバイスをターゲットとする汎用 ASIC/FPGA ワークフロースクリプトです。Xilinx Vivado^® 合成ツールを使用します。

エクスポートされた HDL ワークフロースクリプトを開いて表示します。

% Export Workflow Configuration Script
% Generated with MATLAB 9.5 (R2018b Prerelease) at 14:42:37 on 29/03/2018
% This script was generated using the following parameter values:
%     Filename  : 'S:\generic_workflow_example.m'
%     Overwrite : true
%     Comments  : true
%     Headers   : true
%     DUT       : 'sfir_fixed/symmetric_fir'
% To view changes after modifying the workflow, run the following command:
% >> hWC.export('DUT','sfir_fixed/symmetric_fir');
%--------------------------------------------------------------------------

%% Load the Model
load_system('sfir_fixed');

%% Restore the Model to default HDL parameters
%hdlrestoreparams('sfir_fixed/symmetric_fir');

%% Model HDL Parameters
%% Set Model 'sfir_fixed' HDL parameters
hdlset_param('sfir_fixed', 'GenerateCoSimModel', 'ModelSim');
hdlset_param('sfir_fixed', 'GenerateHDLTestBench', 'off');
hdlset_param('sfir_fixed', 'HDLSubsystem', 'sfir_fixed/symmetric_fir');
hdlset_param('sfir_fixed', 'SynthesisTool', 'Xilinx Vivado');
hdlset_param('sfir_fixed', 'SynthesisToolChipFamily', 'Virtex7');
hdlset_param('sfir_fixed', 'SynthesisToolDeviceName', 'xc7vx485t');
hdlset_param('sfir_fixed', 'SynthesisToolPackageName', 'ffg1761');
hdlset_param('sfir_fixed', 'SynthesisToolSpeedValue', '-2');
hdlset_param('sfir_fixed', 'TargetDirectory', 'hdl_prj\hdlsrc');


%% Workflow Configuration Settings
% Construct the Workflow Configuration Object with default settings
hWC = hdlcoder.WorkflowConfig('SynthesisTool','Xilinx Vivado','TargetWorkflow','Generic ASIC/FPGA');

% Specify the top level project directory
hWC.ProjectFolder = 'hdl_prj';

%Set Properties related to synthesis tool version
hWC.AllowUnsupportedToolVersion  = true;

% Set Workflow tasks to run
hWC.RunTaskGenerateRTLCodeAndTestbench = true;
hWC.RunTaskVerifyWithHDLCosimulation = true;
hWC.RunTaskCreateProject = true;
hWC.RunTaskRunSynthesis = true;
hWC.RunTaskRunImplementation = false;
hWC.RunTaskAnnotateModelWithSynthesisResult = true;

% Set properties related to 'RunTaskGenerateRTLCodeAndTestbench' Task
hWC.GenerateRTLCode = true;
hWC.GenerateTestbench = false;
hWC.GenerateValidationModel = false;

% Set properties related to 'RunTaskCreateProject' Task
hWC.Objective = hdlcoder.Objective.None;
hWC.AdditionalProjectCreationTclFiles = '';

% Set properties related to 'RunTaskRunSynthesis' Task
hWC.SkipPreRouteTimingAnalysis = false;

% Set properties related to 'RunTaskRunImplementation' Task
hWC.IgnorePlaceAndRouteErrors = false;

% Set properties related to 'RunTaskAnnotateModelWithSynthesisResult' Task
hWC.CriticalPathSource = 'pre-route';
hWC.CriticalPathNumber =  1;
hWC.AnnotateModel = 'original';
hWC.ShowAllPaths = false;
hWC.ShowDelayData = true;
hWC.ShowUniquePaths = false;
hWC.ShowEndsOnly = false;

% Validate the Workflow Configuration Object
hWC.validate;

%% Run the workflow
hdlcoder.runWorkflow('sfir_fixed/symmetric_fir', hWC);

必要に応じて、スクリプトを編集します。

たとえば、hdlcoder.WorkflowConfig オブジェクト hWC 内のタスクを有効または無効にします。

HDL ワークフロースクリプトを実行します。

たとえば、スクリプトファイル名が generic_workflow_example.m である場合、コマンドラインで以下のように入力します。

generic_workflow_example

FPGA インザループスクリプトの例

この例では、エクスポートされた HDL ワークフロースクリプトを構成して実行する方法を説明します。

HDL ワークフロースクリプトを生成するには、Simulink 設計で HDL ワークフローアドバイザーを設定および実行してから、スクリプトをエクスポートします。

このスクリプトは Xilinx Virtex 5 開発ボードをターゲットとする FPGA インザループワークフロースクリプトで、Xilinx ISE 合成ツールを使用します。

エクスポートされた HDL ワークフロースクリプトを開いて表示します。

%--------------------------------------------------------------------------
% HDL Workflow Script
% Generated with MATLAB 9.5 (R2018b Prerelease) at 15:11:23 on 04/05/2018
% This script was generated using the following parameter values:
%     Filename  : 'C:\Users\ggnanase\Desktop\R2018b\18b_models\ipcore_timing_failure\hdlworkflow_FIL.m'
%     Overwrite : true
%     Comments  : true
%     Headers   : true
%     DUT       : 'sfir_fixed/symmetric_fir'
% To view changes after modifying the workflow, run the following command:
% >> hWC.export('DUT','sfir_fixed/symmetric_fir');
%--------------------------------------------------------------------------

%% Load the Model
load_system('sfir_fixed');

%% Restore the Model to default HDL parameters
%hdlrestoreparams('sfir_fixed/symmetric_fir');

%% Model HDL Parameters
%% Set Model 'sfir_fixed' HDL parameters
hdlset_param('sfir_fixed', 'HDLSubsystem', 'sfir_fixed/symmetric_fir');
hdlset_param('sfir_fixed', 'SynthesisTool', 'Xilinx Vivado');
hdlset_param('sfir_fixed', 'SynthesisToolChipFamily', 'Kintex7');
hdlset_param('sfir_fixed', 'SynthesisToolDeviceName', 'xc7k325t');
hdlset_param('sfir_fixed', 'SynthesisToolPackageName', 'ffg900');
hdlset_param('sfir_fixed', 'SynthesisToolSpeedValue', '-2');
hdlset_param('sfir_fixed', 'TargetDirectory', 'hdl_prj\hdlsrc');
hdlset_param('sfir_fixed', 'TargetFrequency', 25);
hdlset_param('sfir_fixed', 'TargetPlatform', 'Xilinx Kintex-7 KC705 development board');
hdlset_param('sfir_fixed', 'Workflow', 'FPGA-in-the-Loop');


%% Workflow Configuration Settings
% Construct the Workflow Configuration Object with default settings
hWC = hdlcoder.WorkflowConfig('SynthesisTool','Xilinx Vivado','TargetWorkflow','FPGA-in-the-Loop');

% Specify the top level project directory
hWC.ProjectFolder = 'hdl_prj';

% Set Workflow tasks to run
hWC.RunTaskGenerateRTLCodeAndTestbench = true;
hWC.RunTaskVerifyWithHDLCosimulation = false;
hWC.RunTaskBuildFPGAInTheLoop = true;

% Set properties related to 'RunTaskGenerateRTLCodeAndTestbench' Task
hWC.GenerateRTLCode = true;
hWC.GenerateTestbench = false;
hWC.GenerateValidationModel = false;

% Set properties related to 'RunTaskBuildFPGAInTheLoop' Task
hWC.IPAddress = '192.168.0.2';
hWC.MACAddress = '00-0A-35-02-21-8A';
hWC.SourceFiles = '';
hWC.Connection = 'Ethernet';
hWC.RunExternalBuild = true;

% Validate the Workflow Configuration Object
hWC.validate;

%% Run the workflow
hdlcoder.runWorkflow('sfir_fixed/symmetric_fir', hWC);
hdlcoder.runWorkflow('hdlcoderUARTServoControllerExample/UART_Servo_on_FPGA', hWC);

必要に応じて、スクリプトを編集します。

たとえば、hdlcoder.WorkflowConfig オブジェクト hWC 内のタスクを有効または無効にします。

HDL ワークフロースクリプトを実行します。

たとえば、スクリプトファイル名が FIL_workflow_example.m である場合、コマンドラインで以下のように入力します。

fil_workflow_example.m

IP コアの生成ワークフロースクリプトの例

この例では、エクスポートされた HDL ワークフロースクリプトを構成して実行する方法を説明します。

このスクリプトは、Altera^® Cyclone V SoC 開発キットをターゲットとする IP コアの生成ワークフロースクリプトです。Altera Quartus^® II 合成ツールを使用します。

エクスポートされた HDL ワークフロースクリプトを開いて表示します。

% Export Workflow Configuration Script
% Generated with MATLAB 8.6 (R2015b) at 14:42:16 on 08/07/2015
% Parameter Values:
%     Filename  : 'S:\ip_core_gen_workflow_example.m'
%     Overwrite : true
%     Comments  : true
%     Headers   : true
%     DUT       : 'hdlcoder_led_blinking/led_counter'

%% Load the Model
load_system('hdlcoder_led_blinking');

%% Model HDL Parameters
% Set Model HDL parameters
hdlset_param('hdlcoder_led_blinking', ...
    'HDLSubsystem', 'hdlcoder_led_blinking/led_counter');
hdlset_param('hdlcoder_led_blinking', 'OptimizationReport', 'on');
hdlset_param('hdlcoder_led_blinking', ...
    'ReferenceDesign', 'Default system (Qsys 14.0)');
hdlset_param('hdlcoder_led_blinking', 'ResetType', 'Synchronous');
hdlset_param('hdlcoder_led_blinking', 'ResourceReport', 'on');
hdlset_param('hdlcoder_led_blinking', 'SynthesisTool', 'Altera QUARTUS II');
hdlset_param('hdlcoder_led_blinking', 'SynthesisToolChipFamily', 'Cyclone V');
hdlset_param('hdlcoder_led_blinking', 'SynthesisToolDeviceName', '5CSXFC6D6F31C6');
hdlset_param('hdlcoder_led_blinking', 'TargetDirectory', 'hdl_prj\hdlsrc');
hdlset_param('hdlcoder_led_blinking', ...
    'TargetPlatform', 'Altera Cyclone V SoC development kit - Rev.D');
hdlset_param('hdlcoder_led_blinking', 'Traceability', 'on');
hdlset_param('hdlcoder_led_blinking', 'Workflow', 'IP Core Generation');

% Set SubSystem HDL parameters
hdlset_param('hdlcoder_led_blinking/led_counter', ...
    'ProcessorFPGASynchronization', 'Free running');

% Set Inport HDL parameters
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_frequency', ...
    'IOInterface', 'AXI4');
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_frequency', ...
    'IOInterfaceMapping', 'x"100"');
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_frequency', ...
    'IOInterfaceOptions', {'RegisterInitialValue', 5});

% Set Inport HDL parameters
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_direction', ...
    'IOInterface', 'AXI4');
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_direction', ...
    'IOInterfaceMapping', 'x"104"');
hdlset_param('hdlcoder_led_blinking/led_counter/Blink_direction, ...
    'IOInterfaceOptions', {'RegisterInitialValue', 1});

% Set Outport HDL parameters
hdlset_param('hdlcoder_led_blinking/led_counter/LED', 'IOInterface', 'External Port');

% Set Outport HDL parameters
hdlset_param('hdlcoder_led_blinking/led_counter/Read_back', 'IOInterface', 'AXI4');
hdlset_param('hdlcoder_led_blinking/led_counter/Read_back', ...
    'IOInterfaceMapping', 'x"108"');
hdlset_param('hdlcoder_led_blinking/led_counter/Read_back, ...
    'IOInterfaceOptions', {'RegisterInitialValue', 3});

%% Workflow Configuration Settings
% Construct the Workflow Configuration Object with default settings
hWC = hdlcoder.WorkflowConfig('SynthesisTool','Altera QUARTUS II', ...
    'TargetWorkflow','IP Core Generation');

% Specify the top level project directory
hWC.ProjectFolder = 'hdl_prj';

%Set Properties related to synthesis tool version
hWC.AllowUnsupportedToolVersion  = true;

% Set Workflow tasks to run
hWC.RunTaskGenerateRTLCodeAndIPCore = true;
hWC.RunTaskCreateProject = true;
hWC.RunTaskGenerateSoftwareInterface = false;
hWC.RunTaskBuildFPGABitstream = true;
hWC.RunTaskProgramTargetDevice = false;

% Set Properties related to Generate RTL Code And IP Core Task
hWC.IPCoreRepository = '';
hWC.GenerateIPCoreReport = true;

% Set Properties related to Create Project Task
hWC.Objective = hdlcoder.Objective.AreaOptimized;

% Set Properties related to Generate Software Interface Model Task
hWC.OperatingSystem = '';
hWC.AddLinuxDeviceDriver = false;

% Set Properties related to Build FPGA Bitstream Task
hWC.RunExternalBuild = true;
hWC.TclFileForSynthesisBuild = hdlcoder.BuildOption.Default;

% Validate the Workflow Configuration Object
hWC.validate;

%% Run the workflow
hdlcoder.runWorkflow('hdlcoder_led_blinking/led_counter', hWC);

必要に応じて、スクリプトを編集します。

たとえば、hdlcoder.WorkflowConfig オブジェクト hWC 内のタスクを有効または無効にします。

HDL ワークフロースクリプトを実行します。

たとえば、スクリプトファイル名が ip_core_workflow_example.m である場合、コマンドラインで以下のように入力します。

ip_core_gen_workflow_example

Simulink Real-Time FPGA I/O ワークフローの例

この例では、エクスポートされた HDL ワークフロースクリプトを構成して実行する方法を説明します。

このスクリプトは、Xilinx Vivado 合成ツールを使用する Speedgoat IO333-325K ボードをターゲットとする Simulink Real-Time FPGA I/O ワークフロースクリプトです。

エクスポートされた HDL ワークフロースクリプトを開いて表示します。

%--------------------------------------------------------------------------
% HDL Workflow Script
% Generated with MATLAB 9.5 (R2018b Prerelease) at 18:14:33 on 08/05/2018
% This script was generated using the following parameter values:
%     Filename  : 'C:\Users\ggnanase\Desktop\R2018b\18b_models\ipcore_timing_failure\hdlworkflow_IO333.m'
%     Overwrite : true
%     Comments  : true
%     Headers   : true
%     DUT       : 'sfir_fixed/symmetric_fir'
% To view changes after modifying the workflow, run the following command:
% >> hWC.export('DUT','sfir_fixed/symmetric_fir');
%--------------------------------------------------------------------------

%% Load the Model
load_system('sfir_fixed');

%% Restore the Model to default HDL parameters
%hdlrestoreparams('sfir_fixed/symmetric_fir');

%% Model HDL Parameters
%% Set Model 'sfir_fixed' HDL parameters
hdlset_param('sfir_fixed', 'HDLSubsystem', 'sfir_fixed/symmetric_fir');
hdlset_param('sfir_fixed', 'SynthesisTool', 'Xilinx Vivado');
hdlset_param('sfir_fixed', 'SynthesisToolChipFamily', 'Kintex7');
hdlset_param('sfir_fixed', 'SynthesisToolDeviceName', 'xc7k325t');
hdlset_param('sfir_fixed', 'SynthesisToolPackageName', 'ffg900');
hdlset_param('sfir_fixed', 'SynthesisToolSpeedValue', '-2');
hdlset_param('sfir_fixed', 'TargetDirectory', 'hdl_prj\hdlsrc');
hdlset_param('sfir_fixed', 'TargetFrequency', 100);
hdlset_param('sfir_fixed', 'TargetPlatform', 'Speedgoat IO333-325K');
hdlset_param('sfir_fixed', 'Workflow', 'Simulink Real-Time FPGA I/O');


%% Workflow Configuration Settings
% Construct the Workflow Configuration Object with default settings
hWC = hdlcoder.WorkflowConfig('SynthesisTool','Xilinx Vivado','TargetWorkflow','Simulink Real-Time FPGA I/O');

% Specify the top level project directory
hWC.ProjectFolder = 'hdl_prj';
hWC.ReferenceDesignToolVersion = '2017.4';
hWC.IgnoreToolVersionMismatch = false;

% Set Workflow tasks to run
hWC.RunTaskGenerateRTLCodeAndIPCore = true;
hWC.RunTaskCreateProject = true;
hWC.RunTaskBuildFPGABitstream = true;
hWC.RunTaskGenerateSimulinkRealTimeInterface = true;

% Set properties related to 'RunTaskGenerateRTLCodeAndIPCore' Task
hWC.IPCoreRepository = '';
hWC.GenerateIPCoreReport = true;
hWC.GenerateIPCoreTestbench = false;
hWC.CustomIPTopHDLFile = '';
hWC.AXI4RegisterReadback = false;
hWC.IPDataCaptureBufferSize = '128';

% Set properties related to 'RunTaskCreateProject' Task
hWC.Objective = hdlcoder.Objective.None;
hWC.AdditionalProjectCreationTclFiles = '';
hWC.EnableIPCaching = true;

% Set properties related to 'RunTaskBuildFPGABitstream' Task
hWC.RunExternalBuild = false;
hWC.TclFileForSynthesisBuild = hdlcoder.BuildOption.Default;
hWC.CustomBuildTclFile = '';
hWC.ReportTimingFailure = hdlcoder.ReportTiming.Error;

% Validate the Workflow Configuration Object
hWC.validate;

%% Run the workflow
hdlcoder.runWorkflow('sfir_fixed/symmetric_fir', hWC);

必要に応じて、スクリプトを編集します。

たとえば、hdlcoder.WorkflowConfig オブジェクト hWC 内のタスクを有効または無効にします。

HDL ワークフロースクリプトを実行します。

たとえば、スクリプトファイル名が slrt_workflow_example.m である場合、コマンドラインで以下のように入力します。

slrt_workflow_example.m