xmcImportFunction コマンドの使用 - 2021.2 日本語

xmcImportFunction('libName',{'funcNames'},'hdrFile',{'srcFiles'},
{'srchPaths'},'options')

• libName: 新しいブロックを追加する Model Composer HLS ライブラリの名前を指定します。新しく作成するライブラリの名前または既存のライブラリ名を指定できます。
• funcNames: ソースまたはヘッダー ファイルで定義されている関数で、Model Composer ブロックとしてインポートするものをリスト (セル配列) で指定します。{} のように空にすると、指定したヘッダー ファイル (hdrFile) で定義されているすべての関数がインポートされます。名前空間内の関数には、完全な名前空間接頭辞を指定する必要があります。たとえば、hls_math 内の 'sinf' 関数をインポートするには、完全な関数名 'hls::sinf' を指定する必要があります。
• hdrFile: 関数宣言または定義を含むヘッダー ファイル (.h) を指定します。現在の作業ディレクトリに含まれていない場合は、ヘッダー ファイルへの完全パスを指定する必要があります。たとえば、hls_math.h から関数をインポートするには、完全な関数名 '$XILINX_VIVADO/include/hls_math.h' を指定する必要があります。
  重要: 関数シグネチャはヘッダー ファイルで定義する必要があり、Model Composer (XMC) プラグマはヘッダー ファイルの関数シグネチャの一部として指定する必要があります。
• srcFiles: 関数定義を検索する 1 つまたは複数のソース ファイルのリストを指定します。モデルで使用すると、ヘッダーおよびソース ファイルはモデルのメイン ヘッダー ファイル (headerFile) と共にシミュレーション用の共有ライブラリにコンパイルされ、Model Composer Hub ブロックの追加 に説明するように、Model Composer Hub ブロックで出力を生成するのに指定したターゲット ディレクトリにコピーされます。
• srchPaths: ヘッダーおよびソース ファイルの検索パスを 1 つまたは複数指定します。{} のように空にすると、検索パスがないことを示し、MATLAB の現在のフォルダーが検索されます。HLS ヘッダー ファイルを含めるには、'$XILINX_VIVADO/include' を使用します。

たとえば、次の simple.h ヘッダー ファイルでは、2 つの倍精度浮動小数点の入力とポインター出力を含む simple_add 関数が定義されています。この関数は、2 つの入力を加算し、その合計を出力として返します。

void simple_add(const double in1, const double in2, double *out) {
   *out = in1 + in2;
}

xmcImportFunction('SimpleLib',{'simple_add'},'simple.h',{},{})

• SimpleLib: ブロックを追加する Model Composer HLS ライブラリの名前を指定します。
• simple_add: インポートする関数の名前を指定します。
• simple.h: 検索するヘッダー ファイルを指定します。
• C ソース ファイルおよび検索パスは指定されていません。この場合、関数定義が指定したヘッダー ファイルに含まれている必要があり、指定したファイルは MATLAB の現在のフォルダーのみで検索されます。
  ヒント: インポートするブロックと同じ関数名のブロックが指定したライブラリに既に存在する場合は、Model Composer で警告メッセージが表示されます。

xmcImportFunction が完了すると、作成された simple_add ブロックを含む SimpleLib ライブラリ モデルが開きます。

図 1. simple_add ブロック

シミュレーションでは、ライブラリ ブロックの C/C++ コードがコンパイルされ、ライブラリ ファイルが作成されて読み込まれます。ライブラリ ファイルは、その後の実行でシミュレーションの初期化にかかる時間を短縮するためにキャッシュされます。ライブラリ ブロックに含まれるソース コードは、ブロックをインポートし直したりライブラリを作成し直さなくても変更できますが、キャッシュされたライブラリ ファイルは C/C++ ソース コードを変更するとアップデートされます。

ただし、関数シグネチャまたは関数へのパラメーターを変更した場合は、xmcImportFunction を再実行してブロックを作成し直す必要があります。この場合、override オプションを使用して、ライブラリ内の既存のブロック定義を上書きする必要があります。

ブロック シンボルが作成されたら、そのシンボルをダブルクリックすると、インポートしたブロックのパラメーターを確認できます。パラメーターを表示すると、関数ポートが正しく定義されたかどうかを確認できます。

図 2. simple_add の [Block Parameters] ダイアログ ボックス