生成されたコードへの外部 C/C++ コードの配置

Custom Code ブロックまたはモデルコンフィギュレーションパラメーターで外部コードを指定して、コードジェネレーターがモデルに対して生成したコードをカスタマイズできます。

ルートモデル用に生成されたコードの開始および終了部分にコードを配置します。
ルートモデルまたは非バーチャルサブシステムのブロックに対して生成された関数コードに宣言、本体、および終了コードおよび終了コードを配置します。

外部コードで拡張可能な関数は、コードジェネレーターがモデル内のブロックに対して生成する関数によって異なります。たとえば、モデルまたは Atomic Subsystem に状態をもつブロックが含まれている場合、関数 disable のコードを指定できます。同様に、ブロックでデータの保存、メモリの解放、ターゲットハードウェアのリセットを実行するためのコードが必要な場合は、関数 terminate のコードを指定します。詳細については、ブロックターゲットファイルのメソッドを参照してください。

ワークフロー

コードジェネレーターがルートモデルとサブシステムに対して生成するコード内の特定の場所に外部 C または C++ コードを配置するには、次の表に示すタスクを反復します。

タスク	アクション	詳細
1	外部 C コードを生成した C++ コードに統合するまたはその逆を行うには、生成コード用に選択した言語に合わせて外部コードの言語を変更します。	生成コードに合わせるための外部コードのプログラミング言語の変更
2	外部コードの特性と統合要件の評価を確認します。	外部コード統合ワークフローの選択
3	必要に応じて、コードを C または C++ で書き換えます。
4	外部コードを Simulink モデルに追加する統合方法を選択します。	統合方法の選択
5	コード生成用のモデルデータの表示を定義します。	外部 C/C++ コードと Simulink モデルまたは生成コード間のデータ交換
6	コードを生成するためにモデルを設定します。	外部コードの外観に一致するコードの生成モデルコンフィギュレーションセットのカスタマイズ
7	コードとコード生成レポートを生成します。	コード生成
8	生成コードインターフェイスを確認します。	Analyze Generated Data Code Interface Report
9	モデルから実行可能なプログラムをビルドします。	Simulink 環境内での統合コードのビルド
10	実行可能なプログラムが予測どおり実行されるか確認します。	検証およびテスト

統合方法の選択

Simulink^® モデリング環境内では、2 つの方法を使用して、外部 C または C++ コードを、コードジェネレーターが生成するコードのセクションに配置できます。

カスタムコードライブラリからルートモデルまたは Atomic Subsystem にブロックを追加します。
[コード生成] 、 [カスタムコード] ペインでモデルコンフィギュレーションパラメーターを設定します。

以下の表で、2 つの方法を比較します。統合要件に最適な方法を選択してください。各アプローチの適用方法の詳細については、Custom Code ブロックを使用した外部コードの統合 (Embedded Coder)およびモデルコンフィギュレーションパラメーターを使用した外部コードの統合 (Embedded Coder)を参照してください。

要件	ブロック	モデルコンフィギュレーションパラメーター
モデリングキャンバスに外部コードの表現を含める	✓
ルートモデル用に生成された関数にコードを配置する	✓	✓
Atomic Subsystem 用に生成された関数にコードを配置する	✓
モデルコンフィギュレーションセットにコード配置を保存する		✓
モデル用に生成されたヘッダーファイルとソースファイルの上部と下部にコードを配置する	✓	✓
コードジェネレーターが作成した関数 `SystemInitialize` および `SystemTerminate` の宣言、実行および終了セクション内にコードを配置する	✓	✓
コードジェネレーターが生成した関数 `SystemStart`、`SystemEnable`、`SystemDisable`、`SystemOutputs`、`SystemUpdate`、`SystemDerivatives` の宣言、実行および終了セクション内にコードを配置する	✓
生成コードにプリプロセッサマクロ定義を追加する		✓
シミュレーションターゲットに対して指定されているカスタムコード設定を使用する		✓
ライブラリがリンクしている親モデルの一意のカスタムコード設定を使用するようライブラリモデルを構成する		✓

Custom Code ブロックライブラリ

Custom Code ブロックライブラリには、外部 C または C++ コードを、コードジェネレーターが生成したコード内の特定の場所および関数に配置するために使用できるブロックが含まれています。このライブラリは、コードジェネレーターが生成するモデルヘッダー (model.h) およびソース (model.c または model.cpp) ファイルにコードを追加する 10 のブロックで構成されています。

Model Header ブロックと Model Source ブロックは、コードジェネレーターがルートモデルに対して生成するヘッダーおよびソースファイルの上部と下部に外部コードを追加します。これらのブロックには、コードを入力または貼り付けることができる 2 つのテキストフィールドが表示されます。1 つ目のフィールドでは、生成されたヘッダーまたはソースファイルの上部に配置するコードを指定します。2 つ目のフィールドでは、ファイルの下部に配置するコードを指定します。

残りのブロックでは、コードジェネレーターがブロックを含むルートモデルまたは Atomic Subsystem に対して生成する関数に外部コードを追加します。これらのブロックには、コードジェネレーターが生成する関数をカスタマイズするコードを入力または貼り付けることができるテキストフィールドが表示されます。テキストフィールドは、特定の関数のコードの宣言、実行、および終了セクションに対応しています。

カスタマイズするコードの内容	使用目的
連続状態の計算	System Derivatives
状態の無効化	System Disable
状態の有効化	System Enable
状態のリセット	System Initialize
出力の生成	System Outputs
1 回実行	System Start
データの保存、メモリの解放、ターゲットハードウェアのリセット	System Terminate
各メジャータイムステップで更新が必要	System Update

ブロックとモデル内でのその場所によって、コードジェネレーターが外部コードを配置する場所が決まります。たとえば、System Outputs ブロックがルートモデルレベルにある場合、コードジェネレーターはモデルの関数 Outputs にコードを配置します。ブロックが Triggered Subsystem または Enabled Subsystem 内にある場合、コードはそのサブシステムの関数 Outputs 内に置かれます。

コードジェネレーターで、モデルに含める Custom Code ブロックに対応する関数を生成する必要がない場合、コードジェネレーターは次のいずれかを実行します。

Custom Code ブロックで指定した外部コードを省略する。
モデルに関連ブロックが含まれていないことを示すエラーを返す。この場合、モデルから Custom Code ブロックを削除します。

詳細については、ブロックターゲットファイルのメソッドを参照してください。

メモ

シミュレーションとコード生成の結果の間の不一致の可能性を回避するには、グローバル Simulink データ (信号、状態およびブロックパラメーター) の読み取りと書き込みにカスタムコードブロックを使用しないでください。代わりに、適切なモデル化パターン (たとえば、Data Store Read、Data Store Write、State Reader および State Writer ブロック) を使用します。

モデリングキャンバスへの Custom Code ブロックの追加

Custom Code ライブラリブロックをモデルに追加するには、次を行います。

Simulink ライブラリブラウザーで Simulink Coder ノードを展開してから、Custom Code ブロックライブラリを選択します。
必要なブロックをモデルまたは Subsystem にドラッグします。Model Header ブロックと Model Source ブロックをルートモデルのみにドラッグします。関数ベースの Custom Code ブロックをルートモデルまたは Atomic Subsystem にドラッグします。

Custom Code ブロックを含むモデルを参照モデルとして使用できます。コードジェネレーターは、シミュレーションターゲットのコードを生成するときにこれらのブロックを無視します。コード生成ターゲットのコードを生成するときに、コードジェネレーターにカスタムコードが含まれ、コンパイルされます。

生成された関数 Start への外部コードの追加

この例では、System Start ブロックを使用して、離散フィルターを含むモデルに対してコードジェネレーターが生成するコードに外部 C コードを配置する方法を示します。

以下のモデルを作成します。
コードを生成するためにモデルを設定します。
System Start ブロックをダブルクリックします。
[ブロックパラメーター] ダイアログボックスで、[System Start Function 宣言コード] フィールドに次のコードを入力します。
```
unsigned int *ptr = 0xFFEE;
```
[System Start Function 実行コード] フィールドに、次のコードを入力します。
```
/* Initialize hardware */
*ptr = 0;
```
[OK] をクリックします。
コードとコード生成レポートを生成します。

生成された model.c ファイルを表示します。文字列 start function を検索します。手順 4 と 5 で入力した外部コードを含む次のコードを見つけます。

  {
    {
      /* user code (Start function Header) */
      /* System '<Root>' */
      unsigned int *ptr = 0xFFEE;
  
      /* user code (Start function Body) */
      /* System '<Root>' */
      /* Initialize hardware */
      *ptr = 0;
    }
  }

他の例については、カスタムコードブロックとモデルコンフィギュレーションパラメーターを使用した外部 C コードの生成コードへの統合を参照してください。

モデルコンフィギュレーションパラメーターを使用した外部コードの統合

モデルコンフィギュレーションパラメーターを使用して、外部 C または C++ コードを、コードジェネレーターが生成したコード内の特定の場所および関数に配置できます。

目的	選択
生成された `model.c` または `model.cpp` ファイルの最上部付近に外部コードを挿入します。	[追加コード] を選択し、挿入する外部コードを入力します。サブシステムコードを別のファイルに生成すると、そのコードは [追加コード] パラメーターで指定した外部コードにアクセスできません。たとえば、インクルードファイルを [追加コード] 設定として指定すると、コードジェネレーターでは `model.c` または `model.cpp` ファイルの最上部付近に `#include` が挿入されます。コードジェネレーターが別のファイルに配置するサブシステムコードは、インクルードファイル内の宣言にアクセスできません。この場合は、外部コードを [インクルードヘッダー] パラメーターで指定することを検討してください。
生成された `model.h` ファイルの最上部付近に外部コードを挿入する	[インクルードヘッダー] を選択し、挿入する外部コードを入力します。
`model.c` または `model.cpp` ファイルでモデルの初期化関数内に外部コードを挿入する	[初期化コード] を選択し、挿入する外部コードを入力します。
`model.c` または `model.cpp` ファイルでモデルの終了関数内に外部コードを挿入する	[終了コード] を選択し、挿入する外部コードを入力します。また、[インターフェイス] ペインの [終了関数が必要] パラメーターも選択します。
プリプロセッサマクロ定義の追加	[定義] を選択し、生成コードに追加するプリプロセッサマクロ定義のリストをスペースで区切って入力します。リストには単純な定義 (`-DEF1` など) と値をもつ定義 (`-DDEF2=1` など) を含めることができます。定義では `-D` を省略できます (たとえば `-DFOO=1` と `FOO=1` は同じです)。定義に `-D` が含まれる場合、ツールチェーンは、定義に別のフラグを使用している場合、フラグをオーバーライドできます。
MATLAB Function ブロック、Stateflow^® チャートおよび Truth Table ブロックのシミュレーションに指定された設定と同じカスタムコードパラメーター設定を使用する	[シミュレーションターゲットと同じカスタムコードの設定を使用] を選択します。このパラメーターは、[コンフィギュレーションパラメーター] ダイアログボックスの [シミュレーションターゲット] ペインを参照します。
ライブラリがリンクしている親モデルから一意のカスタムコード設定をライブラリモデルで使用できるようにする	ローカルなカスタムコード設定を使用 (メインモデルから継承しません) このパラメーターは、MATLAB Function ブロック、Stateflow チャートまたは Truth Table ブロックを含むライブラリモデルに対してのみ使用可能です。

外部ヘッダーファイルにヘッダーファイルを含めるには、#ifndef コードを追加します。このコードを使用すると、複数回のインクルードを防止できます。たとえば、rtwtypes.h の場合には、次の #include の追加によって防止しています。

#ifndef RTW_HEADER_rtwtypes_h_ 
#define RTW_HEADER_rtwtypes_h_ 
... 
#endif /* RTW_HEADER_rtwtypes_h_ */

ヘッダーファイル、ソースファイルおよび共有ライブラリファイルの名前と場所をビルドプロセスに追加する方法の詳細については、Simulink 環境内での統合コードのビルドを参照してください。

メモ

コードジェネレーターは、ソフトウェアインザループ (SIL) およびプロセッサインザループ (PIL) シミュレーション用にコードを生成するときに、コンフィギュレーションセットに含める外部コードを含めます。ただし、コードジェネレーターは、S-Function、ラピッドシミュレーションまたはシミュレーションシステムターゲットファイルでコードを生成するときは、コンフィギュレーションセットに含める外部コードを無視します。

[カスタムコード] パラメーターの詳細については、モデルコンフィギュレーションパラメーター: コード生成のカスタムコードを参照してください。例については、カスタムコードブロックとモデルコンフィギュレーションパラメーターを使用した外部 C コードの生成コードへの統合を参照してください。

カスタムコードブロックとモデルコンフィギュレーションパラメーターを使用した外部 C コードの生成コードへの統合

スクリプトを開く

この例では、カスタムコードブロックとモデルコンフィギュレーションパラメーターを使用して生成コードに外部コードを配置する方法を示します。

1. モデル CustomCode を開きます。

open_system('CustomCode')

2. Simulink Coder アプリまたは Embedded Coder アプリを開きます。

3. [モデルコンフィギュレーションパラメーター] ダイアログボックスを開いて [カスタムコード] ペインに移動します。

4. [追加のソースコード] タブで、モデルコンフィギュレーションパラメーター [追加コード] と [初期化コード] の設定を確認します。

[追加コード] にはコメントを指定し、変数 GLOBAL_INT2 を -1 に設定します。
[初期化コード] は変数 GLOBAL_INT2 を 1 に初期化します。

5. ダイアログボックスを閉じます。

6. Model Source ブロックをダブルクリックします。ブロックパラメーター [Model Source の最上位] では、コードジェネレーターが変数 GLOBAL_INT1 を宣言して生成ファイル CustomCode.c の先頭でその変数を 0 に設定することを指定します。

7. Triggered Subsystem Amplifier を開きます。サブシステムには System Outputs ブロックが含まれます。そのブロックで指定したコードを、コードジェネレーターが、最も近い親 Atomic サブシステムの生成コード内に配置します。この場合、コードジェネレーターは Amplifier サブシステム用の生成コード内に外部コードを配置します。外部コードは次のようになります。

ポインター変数 *intPtr を宣言し、変数 GLOBAL_INT1 の値で初期化する。
実行中はポインター変数を -1 に設定する。
終了前にポインター変数を 0 にリセットする。

8. コードとコード生成レポートを生成します。

9. 生成されたソースファイル CustomCode.c のコードを調べます。ファイルの先頭、#include ステートメントの後に、次の宣言コードがあります。この例では、[追加コード] コンフィギュレーションパラメーターによる最初の宣言と Model Source ブロックによる 2 番目の宣言が指定されています。

int_T GLOBAL_INT2 = -1;

int_T GLOBAL_INT1 = 0;

サブシステム Amplifier の出力関数には次のコードが含まれています。外部コードが、ゲインを適用する生成コードと統合されているのがわかります。この例では、サブシステム Amplifier 内に System Output ブロックによるポインター変数の 3 行のコードが指定されています。

int_T *intPtr = &GLOBAL_INT1;

*intPtr = -1;

CustomCode_Y.Output = CustomCode_U.Input << 1;

*intPtr = 0;

次の代入がモデルの初期化エントリポイント関数に表示されます。この例では、[初期化コード] コンフィギュレーションパラメーターによるこの代入が指定されています。

GLOBAL_INT2 = 1;