コード生成レポートの作成と使用

レポートコンフィギュレーションパラメーターの少なくとも 1 つが有効になっている Simulink^® モデルから HDL コードを生成すると、HDL Coder™ によって HTML コード生成レポートが生成および表示されます。レポートには、生成されたコードに関する次のような情報が含まれます。

リソース使用量の推定
タイミング推定
HDL Coder 最適化の影響
コードを Simulink ブロックまでトレースするリンク

[コンフィギュレーションパラメーター] ダイアログボックスの [HDL コード生成] 、 [レポート] 設定のモデルコンフィギュレーションパラメーターを使用して、コード生成レポートをカスタマイズします。

レポートの生成

下表では、コード生成レポートに追加できるセクションをリストします。既定では、HDL Coder により、[概要]、[クロック概要]、および [コードインターフェイスレポート] の各セクションが生成されます。

レポートのセクション	説明	コンフィギュレーションパラメーター	依存関係
概要	モデル、テスト対象設計 (DUT)、コード生成日、および既定以外の HDL Coder 設定に関する情報が含まれます。	[コンフィギュレーションパラメーター] ダイアログボックスの [HDL コード生成] 、 [レポート] セクションのパラメーターの少なくとも 1 つを有効にします。	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。
クロック概要	以下に関する情報が含まれます。モデルの基本レート DUT の基本レート出力のサンプル時間出力のレイテンシレポートには、モデル内のクロック数に基づいた次のような情報も表示されます。シングルレートモデルのクロックイネーブル信号マルチレートモデルのクロックテーブル詳細については、HDL Coder での複数のクロックの使用を参照してください。
コードインターフェイスレポート	DUT への入力端子と出力端子の名前、データ型、ビット長がリストされます。レポートには、Simulink モデル内の各入力端子および出力端子へのリンクが表示されます。

レポートのセクション

説明

コンフィギュレーションパラメーター

依存関係

概要

モデル、テスト対象設計 (DUT)、コード生成日、および既定以外の HDL Coder 設定に関する情報が含まれます。

[コンフィギュレーションパラメーター] ダイアログボックスの [HDL コード生成] 、 [レポート] セクションのパラメーターの少なくとも 1 つを有効にします。

[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。

クロック概要

以下に関する情報が含まれます。

モデルの基本レート
DUT の基本レート
出力のサンプル時間
出力のレイテンシ

レポートには、モデル内のクロック数に基づいた次のような情報も表示されます。

シングルレートモデルのクロックイネーブル信号
マルチレートモデルのクロックテーブル

詳細については、HDL Coder での複数のクロックの使用を参照してください。

コードインターフェイスレポート

DUT への入力端子と出力端子の名前、データ型、ビット長がリストされます。レポートには、Simulink モデル内の各入力端子および出力端子へのリンクが表示されます。

タイミングおよび面積レポート

レポートのセクション	説明	コンフィギュレーションパラメーター	依存関係
高水準リソースレポート	DUT が消費する加算器、減算器、乗算器、レジスタ、およびその他のリソースの概要が示されます。	リソース利用レポートを生成	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。
ターゲット固有のレポート	FPGA 浮動小数点ライブラリマッピングを使用してターゲット固有のコードを生成した場合にリソース利用レポートが表示されます。		[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。 [HDL コード生成] 、 [浮動小数点] 設定で、[ベンダー固有の浮動小数点ライブラリ] を `[なし]` 以外の設定にします。
ネイティブ浮動小数点リソースレポート	Simulink ブロックのマッピング先の浮動小数点演算子がリストされます。		[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。 [HDL コード生成] 、 [浮動小数点] 設定で、[浮動小数点の使用] を有効にします。
クリティカルパスの推定	クリティカルパスとそのパスに沿った伝播遅延が推定されます。このセクションでは、DUT が実行可能な最大周波数が推定されます。	高位のタイミングクリティカルパスレポートを生成	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。 [HDL コード生成] 、 [グローバル設定] の [モデルの生成] タブで [生成されたモデル] を有効にします。

最適化レポート

レポートのセクション	説明	コンフィギュレーションパラメーター	依存関係
遅延の均衡化	以下に関する詳細情報が示されます。パイプラインレイテンシ並列パスの遅延を一致させるために出力端子に追加された位相遅延遅延吸収詳細については、遅延の均衡化レポートを参照してください。	最適化レポートを生成	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。 [HDL コード生成] 、 [グローバル設定] の [モデルの生成] タブで [生成されたモデル] を有効にします。
階層のフラット化	階層のフラット化のステータス、[FlattenHierarchy] が `[on]` または `[off]` に設定されているサブシステム、およびインラインの HDL ファイルが表示されます。詳細については、階層のフラット化のレポートを参照してください。
コードの再利用	HDL Coder が生成されたサブシステムコードを再利用した場所の概要が示されます。
ターゲットコード生成	生成されたコードで浮動小数点型が使用されている場合に、ターゲットデバイスの概要とターゲットマッピングステータスが表示されます。
ストリーミングおよび共有	共有またはストリーミングを指定したサブシステムに関する情報の概要が示されます。詳細については、ストリーミングレポートおよびリソース共有レポートを参照してください。
クロックレートパイプライン	モデルでクロックレートパイプラインがどのように実行されたかの詳細が示されます。詳細については、クロックレートパイプラインレポートを参照してください。
分散型パイプライン方式	分散型パイプライン方式の変換を適用する前後のレジスタを比較するリストが表示されます。詳細については、分散型パイプライン方式のレポートを参照してください。
適応パイプライン	適応パイプライン最適化のステータス、パイプラインレジスタが挿入されたブロック、およびパイプラインレジスタの数が表示されます。詳細については、適応パイプラインレポートを参照してください。
フレームからサンプルへ	以下に関する情報が含まれます。フレームからサンプルへの変換のパラメーター HDL Coder によってサンプルに変換された入力端子と出力端子出力レイテンシ大きな遅延を外部メモリにマッピングする入出力端子

トレーサビリティレポートとモデルの Web ビュー

レポートのセクション	説明	コンフィギュレーションパラメーター	依存関係
トレーサビリティレポート	可能な場合、生成されたコードの行から Simulink モデル内の対応するブロックへのリンクが示されます。このレポートでは、Simulink のコードビューを使用してコードとモデルの間をトレースできます。詳細については、トレーサビリティを使用した Simulink モデルと HDL コード間の移動を参照してください。	トレーサビリティレポートの生成	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。
モデルの Web ビュー	HTML コード生成レポートで Simulink モデルが表示されます。モデルの Web ビューには Simulink Report Generator™ が必要です。詳細については、Generate Web View of Model in Code Generation Reportを参照してください。	モデルの Web ビューを生成	[HDL コード生成] 、 [グローバル設定] の設定で [HDL コードを生成] を有効にします。

あるいは、次の表に記載されているプロパティを on または off に設定することで、コード生成レポートをプログラムによってカスタマイズすることもできます。このプロパティを設定するには、hdlset_paramまたはmakehdlを使用します。

レポートのセクション	`makehdl` プロパティ	依存関係
高水準リソースレポート	`ResourceReport`	`GenerateHDLCode` を `on` に設定します。
ターゲット固有のレポート		`GenerateHDLCode` を `on` に設定し、`FloatingPointTargetConfiguration` をベンダー固有の浮動小数点ライブラリに設定します。
ネイティブ浮動小数点リソースレポート		`GenerateHDLCode` および `UseFloatingPoint` を `on` に設定します。
クリティカルパスの推定	`CriticalPathEstimation`	`GenerateHDLCode` および `GenerateModel` を `on` に設定します。
遅延の均衡化	`OptimizationReport`	`GenerateHDLCode` および `GenerateModel` を `on` に設定します。
階層のフラット化
コードの再利用
ターゲットコード生成
ストリーミングおよび共有
クロックレートパイプライン
分散型パイプライン方式
適応パイプライン
フレームからサンプルへ
トレーサビリティレポート	`Traceability`	`GenerateHDLCode` を `on` に設定します。
モデルの Web ビュー	`HDLGenerateWebView`	`GenerateHDLCode` を `on` に設定します。

コード生成レポートのナビゲート

Simulink モデルからコード生成レポートに移動できます。たとえば、モデル hdlcoderFocCurrentFixptHdl.slx のレポートを生成するとします。以下のコマンドを使用してモデルを開きます。

openExample('hdlcoder/ClockRatePipeliningExample','supportingFile','hdlcoderFocCurrentFixptHdl.slx')

このモデルでは、コンフィギュレーションパラメーター [リソース利用レポートを生成] と [最適化レポートを生成] が有効になっています。次のコマンドを使用して、サブシステム FOC_Current_Control から HDL コードをビルドします。

makehdl('hdlcoderFocCurrentFixptHdl/FOC_Current_Control')

コードの生成後に、レポートが自動的に開きます。また、MATLAB^® コマンドウィンドウで hdlcoderFoxCurrentFixptHdl_codegen_rpt.html へのリンクをクリックするか、[HDL Coder] アプリを開いて [レポートを開く] をクリックすることで、レポートを開くこともできます。

Code generation report for the model hdlcoderFocCurrentFixptHdl. The contents pane include the high-level resource and optimization reports.

[コンテンツ] ペインのリンクをクリックして、コード生成レポートの各種セクションを参照します。生成されたレポートには、生成されたコードのリソース使用量を取り込んだ [高水準リソースレポート] セクションが含まれています。また、クロックレートパイプライン、分散型パイプライン方式、およびその他の最適化に関するセクションも含まれており、生成されたコードが HDL Coder によってどのように最適化されたかが示されます。

必要なセクションのみを含めるようにレポートをカスタマイズできます。たとえば、[クリティカルパスの推定] セクションを含むレポートを生成するには、CriticalPathEstimation プロパティを有効にします。

makehdl('hdlcoderFocCurrentFixptHdl/FOC_Current_Control', 'CriticalPathEstimation', 'on')

Code generation report for the model hdlcoderFocCurrentFixptHdl. The updated report includes a critical path estimation section.

コード生成レポートを使用した合成前のコードの評価

[リソース利用レポートを生成] または [高位のタイミングクリティカルパスレポートを生成] パラメーターを選択すると、HDL Coder により、コード生成レポートに [タイミングおよび面積レポート] セクションが追加されます。タイミングおよび面積レポートを使用して、生成されたコードがハードウェアで必要とされる周波数とリソースで実行できるかどうかを評価できます。

生成されたコードの面積の評価

高水準リソースレポートの [概要] セクションでは、次の使用量が推定されます。

乗算器
加算器と減算器
1 ビットレジスタ
RAM
マルチプレクサー
I/O ビット
静的シフト演算子
動的シフト演算子

リソースレポートを使用して、生成された HDL コードのリソース使用量の推定値を追跡して削減します。

[高水準リソースレポート] セクションには、次のセクションも含まれています。

[レジスタ] セクションには、1 ビットレジスタの合計が表示されます。合計は、レジスタのビット幅とその発生頻度の積の和です。
[静的シフト演算子] セクションと [動的シフト演算子] セクション。静的シフトは、マスク定数であるシフト値です。シフトロジックは変わりません。動的シフトは、ブロックへの入力として指定されるシフト値です。動的シフトは静的シフトよりもリソース使用量が大きくなります。

レポート内のリソース使用量がハードウェアで利用可能な量を超えている場合は、DUT にリソース共有やストリーミングなどの面積の最適化を適用することを検討してください。リソース共有とストリーミングは、面積を削減する共有ハードウェアリソースを使用するように生成コードを最適化します。詳細については、面積の最適化を参照してください。

生成されたコードのタイミングの評価

[クリティカルパスの推定] セクションには、モデル内でタイミング遅延が最長の連結パスの推定が含まれます。HDL Coder はターゲット固有のタイミングデータベースを使用して、生成されたコードのクリティカルパスを推定します。HDL Coder にターゲットコンフィギュレーション用のタイミングデータベースがない場合は、関数genhdltdbを使用してターゲット固有のタイミングデータベースを生成します。詳細については、合成実行なしのクリティカルパスの推定を参照してください。

クリティカルパスの伝播遅延により、生成されたコードがターゲット上で実行できる周波数が制限されます。クリティカルパス推定の推定遅延が長すぎて、DUT がターゲット周波数で実行できない場合は、推定クリティカルパスの最適化を検討してください。クリティカルパスの推定では、生成されたモデル内のクリティカルパスを強調表示する criticalPathEstimated スクリプトへのリンクが示されます。このスクリプトを使用して、生成されたモデル内の推定クリティカルパスを特定し、元の Simulink モデルに遅延を追加してクリティカルパスを分割します。

さらに、HDL Coder 最適化により、クリティカルパスのタイミングを最適化し、DUT の最大周波数を高めることができます。詳細については、速度の最適化を参照してください。

最適化の影響の評価

報告されたタイミングまたは面積の使用量が要件を満たしていない場合は、合成前に元のモデルを最適化してそのモデルからコードを再度生成できます。コードを生成した後、最適化レポートを使用して、HDL Coder によって DUT がどのように最適化されたか、また特定の最適化が適用されなかった理由を把握します。最適化レポートを使用して、最適化の障害を特定し、DUT のタイミングと面積を改善します。