RTOSについての真実。 記事＃17。 イベントフラググループ：紹介と基本サービス

イベントフラグのグループは、以前の記事のいずれかで既に言及されています（＃5）。 Nucleus SEでは、これらはシグナルに似ていますが、より柔軟です。 これらは、タスク間で簡単なメッセージを転送するための低コストで柔軟な方法を提供します。


シリーズの以前の記事：
記事＃16。 信号
記事＃15。 メモリパーティション：サービスとデータ構造
記事＃14。 メモリのセクション：紹介と基本サービス
記事＃13。 タスクデータ構造とサポートされていないAPI呼び出し
記事＃12。 タスクを操作するためのサービス
記事＃11。 タスク：APIの構成と紹介
記事＃10。 スケジューラ：高度な機能とコンテキストの保存
記事＃9。 スケジューラ：実装
記事＃8。 Nucleus SE：内部設計と展開
記事＃7。 Nucleus SE：はじめに
記事＃6。 その他のRTOSサービス
記事5。 タスクの相互作用と同期
記事4。 タスク、コンテキストの切り替え、および割り込み
記事＃3。 タスクと計画
記事＃2。 RTOS：構造とリアルタイム
記事＃1。 RTOS：はじめに。

イベントフラグの使用

Nucleus SEでは、ビルドフェーズ中にイベントフラグが定義されます。 アプリケーションのイベントフラググループの最大数は16です。イベントフラググループが定義されていない場合、イベントフラググループのデータ構造とサービスコールに関連するコードはアプリケーションに含まれません。

イベントフラグのグループは8ビットフラグのセットであり、複数のタスクが1つのフラグを安全に使用できるようにアクセスが制限されています。 1つのタスクで、イベントフラグの任意の組み合わせを設定またはクリアできます。 別のタスクは、いつでもフラグのグループを読み取ることであり、特定の一連のフラグを待機することもできます（ポーリングまたは一時停止を使用）。

イベントフラググループの構成

イベントフラググループの数

ほとんどのNucleus SEオブジェクトと同様に、イベントフラググループの設定はnuse_config.hの #defineディレクティブで指定されます。 メインパラメータはNUSE_EVENT_GROUP_NUMBERで、アプリケーションで定義されるイベントフラグのグループ数を決定します。 デフォルトでは、このパラメーターは0に設定され（つまり、イベントフラググループは使用されません）、最大16までの値を設定できます。不正な値はコンパイルエラーにつながります。 、つまり、このモジュールでコンパイルすることを意味します）、その結果、 ＃errorディレクティブが機能します。 ゼロ以外の値を選択することは、イベントフラググループの主なアクティベーターです。 このパラメーターはデータ構造を定義するときに使用され、そのサイズはその値に依存します（これについては、以下の記事で詳しく説明します）。 さらに、ゼロ以外の値はAPI設定をアクティブにします。

API呼び出しをアクティブにする

Nucleus SEの各API関数（ユーティリティ呼び出し）は、 nuse_config.hの #defineディレクティブによってアクティブにされます 。 イベントフラグのグループの場合、次のものが含まれます。
NUSE_EVENT_GROUP_SET
NUSE_EVENT_GROUP_RETRIEVE
NUSE_EVENT_GROUP_INFORMATION
NUSE_EVENT_GROUP_COUNT

デフォルトでは、これらはFALSEに設定されているため、各サービス呼び出しを無効にし、それらを実装するコードの組み込みをブロックします。 イベントフラグのグループを構成するには、必要なAPI呼び出しを選択し、対応するディレクティブをTRUEに設定する必要があります。

以下は、デフォルトのnuse_config.hファイルからの抜粋です。

 #define NUSE_EVENT_GROUP_NUMBER 0 /* Number of event groups in the system - 0-16 */ #define NUSE_EVENT_GROUP_SET FALSE /* Service call enabler */ #define NUSE_EVENT_GROUP_RETRIEVE FALSE /* Service call enabler */ #define NUSE_EVENT_GROUP_INFORMATION FALSE /* Service call enabler */ #define NUSE_EVENT_GROUP_COUNT FALSE /* Service call enabler */ 

アプリケーションにイベントフラググループがない場合にアクティブ化されたAPI関数は、コンパイルエラーになります（常に有効になっているNUSE_Event_Group_Count（）を除く）。 アクティブ化されていないAPI呼び出しをコードが使用する場合、実装コードがアプリケーションに含まれていなかったため、レイアウトエラーが発生します。

イベント呼び出しユーティリティ呼び出し

Nucleus RTOSは、次の機能を提供する7つのユーティリティコールをサポートしています。

• イベントフラグを設定します。 Nucleus SEはNUSE_Event_Group_Set（）関数で実装されます。
• イベントフラグの読み取り。 Nucleus SEはNUSE_Event_Group_Retrieve（）で実装されています。
• イベントフラグの特定のグループに関する情報を提供します。 Nucleus SEでは、 NUSE_Event_Group_Information（）で実装されます。
• アプリケーションで現在構成されているイベントフラググループの数を返します。 Nucleus SEでは、 NUSE_Event_Group_Count（）で実装されています。
• イベントフラグの新しいグループをアプリケーションに追加します。 Nucleus SEは実装されていません。
• イベントフラグのグループをアプリケーションから削除します。 Nucleus SEは実装されていません。
• アプリケーション内のイベントフラグのすべてのグループへのポインターを返します。 Nucleus SEは実装されていません。

これらの各オーバーヘッドコールの実装については、以下で詳しく説明します。

Nucleus RTOSまたはNucleus SEにはリセット機能がないことに注意してください。 これは意図的に行われます。 リセット機能は、フラグの特別な状態の普及を意味します。 イベントフラグのグループの場合、唯一の「特別な」状態はすべてのフラグをリセットすることです。これはNUSE_Event_Group_Set（）を使用して実行できます。

イベントフラググループを設定および読み取るためのサービス呼び出し

イベントフラグのグループに対して実行できる基本的な操作は、1つ以上のフラグの値を設定することと、フラグの現在の値を読み取ることです。 Nucleus RTOSおよびNucleus SEは、これらの操作に対して4つの基本的なAPI呼び出しを提供します。

イベントフラグはビットであるため、2進数として視覚化するのが最適です。 歴史的に標準Cはバイナリ定数（8進および16 進のみ ）の表現をサポートしていないため、Nucleus SEには便利なヘッダーファイルnuse_binary.hがあり 、256個の8ビット値すべてにb01010101のような#define文字が含まれています。

イベントフラグを設定する

フラグ設定用のNucleus RTOS API呼び出し関数は非常に柔軟であり、 ANDおよびOR演算を使用してフラグ値を設定およびクリアできます。 Nucleus SEは同様の機能を提供しますが、タスクの一時停止はオプションです。

Nucleus RTOSでフラグを設定するための呼び出し
サービスコールのプロトタイプ：

STATUS NU_Set_Events（NU_EVENT_GROUP * group、UNSIGNED event_flags、OPTION操作）;

パラメータ：

group-イベントフラグのグループに対してユーザーが提供する制御ブロックへのポインター。
event_flags-フラググループのビットマスクの値。
operation-実行される操作 、 NU_OR （フラグの設定用）またはNU_AND （フラグのクリア用）。

戻り値：

NU_SUCCESS-呼び出しは正常に完了しました。
NU_INVALID_GROUP-イベントフラグのグループへの無効なポインター。
NU_INVALID_OPERATION-指定された操作はNU_ORおよびNU_ANDとは異なります。

Nucleus SEでフラグを設定するための呼び出し
このAPIコールは、Nucleus RTOS APIのコア機能をサポートしています。

サービスコールのプロトタイプ：

STATUS NUSE_Event_Group_Set（NUSE_EVENT_GROUPグループ、U8 event_flags、OPTION操作）;

パラメータ：

group-フラグが設定/クリアされているイベントグループのインデックス（ID）。
event_flags-フラググループのビットマキシ値。
operation-実行される操作 、 NUSE_OR （フラグの設定用）またはNUSE_AND （フラグのクリア用）。

戻り値：

NUSE_SUCCESS-呼び出しは正常に完了しました。
NUSE_INVALID_GROUP-無効なイベントフラググループインデックス。
NUSE_INVALID_OPERATION-指定された操作はNUSE_ORおよびNUSE_ANDとは異なります。

Nucleus SEでのイベントフラグのインストールの実装
NUSE_Event_Group_Set（） API関数の初期コードは一般的です（パラメーターをチェックした後）。ブロックするAPI呼び出し（タスクの中断）のサポートがアクティブかどうかに関係ありません。 ロジックは非常に簡単です。

 NUSE_CS_Enter(); if (operation == NUSE_OR) { NUSE_Event_Group_Data[group] |= event_flags; } else /* NUSE_AND */ { NUSE_Event_Group_Data[group] &= event_flags; } 

event_flagsビットマスクは 、選択したイベントフラグのグループの値に（ ANDまたはOR演算を使用して）重ねられます。

残りのコードは、タスクのロックが有効になっている場合にのみ有効になります。

 #if NUSE_BLOCKING_ENABLE while (NUSE_Event_Group_Blocking_Count[group] != 0) { U8 index; /* check whether any tasks are blocked */ /* on this event group */ for (index=0; index<NUSE_TASK_NUMBER; index++) { if ((LONIB(NUSE_Task_Status[index]) == NUSE_EVENT_SUSPEND) && (HINIB(NUSE_Task_Status[index]) == group)) { NUSE_Task_Blocking_Return[index] = NUSE_SUCCESS; NUSE_Task_Status[index] = NUSE_READY; break; } } NUSE_Event_Group_Blocking_Count[group]--; } #if NUSE_SCHEDULER_TYPE == NUSE_PRIORITY_SCHEDULER NUSE_Reschedule(NUSE_NO_TASK); #endif #endif NUSE_CS_Exit(); return NUSE_SUCCESS; 

このフラグのグループからタスクが（読み取りのために）一時停止されている場合、再開されます。 実行を継続する機会が与えられると（スケジューラに依存）、再開の条件が満たされているかどうかを判断できます（イベントフラグの読み取りを参照）。

イベントフラグの読み取り

Nucleus RTOS APIユーティリティの読み取り呼び出しは非常に柔軟であり、操作をすぐに実行できない場合（たとえば、現在の状態を表さないイベントフラグの特定のシーケンスを読み取ろうとする場合）、タスクを無期限にまたは特定のタイムアウトで一時停止できます。 Nucleus SEは同じ機能を提供します。タスクの一時停止のみがオプションであり、タイムアウトは実装されていません。

Nucleus RTOSのフラグチャレンジ
サービスコールのプロトタイプ：

STATUS NU_Retrieve_Events（NU_EVENT_GROUP *グループ、UNSIGNED requested_events、OPTION操作、UNSIGNED * retrieved_events、UNSIGNEDサスペンド）;

パラメータ：

group-イベントフラグのグループに対してユーザーが提供する制御ブロックへのポインター。
requested_events-読み取るフラグを定義するビットマスク。
操作 -NU_AND 、 NU_AND_CONSUME 、 NU_ORおよびNU_OR_CONSUMEの 4つの操作が使用可能です。 NU_ANDおよびNU_AND_CONSUME操作は、要求されたすべてのフラグが必要であることを示します。 操作NU_ORおよびNU_OR_CONSUMEは、要求されたフラグの1つ以上が十分であることを示します。 CONSUMEパラメーターは、要求が成功した後に既存のフラグを自動的にクリアします。
retrieve_events-読み取りイベントフラグの値のストアへのポインタ。
suspend-タスクを一時停止するための仕様。 NU_NO_SUSPENDまたはNU_SUSPENDの値、またはシステムタイマーのティック単位のタイムアウト値（ 1〜4,294,967,293）を取ることができます。

戻り値：

NU_SUCCESS-呼び出しは正常に完了しました。
NU_NOT_PRESENT-指定された操作はイベントを返しませんでした（NU_ORの場合は単一のイベントではなく、NU_ANDの場合はすべてのイベントではありません）。
NU_INVALID_GROUP-イベントフラグのグループへの無効なポインター。
NU_INVALID_OPERATION-指定された操作は正しくありませんでした。
NU_INVALID_POINTER-イベントフラグのストアへのNULLポインター（NULL）。
NU_INVALID_SUSPEND-非タスク関連スレッドから一時停止を試みます。
NU_TIMEOUT-イベントフラグの必要な組み合わせは、指定されたタイムアウトの後でも設定されませんでした。
NU_GROUP_DELETED-タスクの中断中にイベントフラグのグループが削除されました。

Nucleus SEのフラグチャレンジ
このAPIコールは、Nucleus RTOS APIのコア機能をサポートしています。

サービスコールのプロトタイプ：

STATUS NUSE_Event_Group_Retrieve（NUSE_EVENT_GROUPグループ、U8 requested_events、OPTION操作、U8 * retrieved_events、U8サスペンド）;

パラメータ：

group-イベントフラグの読み取りグループのインデックス（ID）。
requested_events-読み取るフラグを定義するビットマスク。
operation-必要なフラグの数を示す仕様： NUSE OR （一部のフラグ）またはNUSE AND （すべてのフラグ）;
retrieve_events-読み取りイベントフラグの実際の値のストアへのポインタ（ NUSE_ANDオペレーションでは、これはrequested_eventsパラメーターで渡されるものと同じです）。
suspend-タスクを一時停止するための指定;値はNUSE_NO_SUSPENDまたはNUSE_SUSPENDを取ることができます。

戻り値：

NUSE_SUCCESS-呼び出しは正常に完了しました。
NUSE_NOT_PRESENT-指定された操作はイベントを返しませんでした（ NUSE_ORの場合は単一のイベントではなく、 NUSE_ANDの場合はすべてのイベントではありません）。
NUSE_INVALID_GROUP-無効なイベントフラググループインデックス。
NUSE_INVALID_OPERATION-指定された操作はNUSE_ORまたはNUSE_ANDとは異なります。
NUSE_INVALID_POINTER-読み取りイベントフラグのストアへのNULLポインター（ NULL ）。
NUSE_INVALID_SUSPEND-非タスクフローからの一時停止の試行、またはAPI呼び出しのブロックのサポートが無効になっている場合。

Nucleus SEでイベントフラグの読み取りを実装する
API関数コードNUSE_Event_Group_Retrieve（） （パラメーターのチェック後）のバージョンは、ブロック（サスペンド）タスクへのAPI呼び出しのサポートがアクティブかどうかに応じて、条件付きコンパイル中に選択されます。 これら2つのオプションを別々に考えてみましょう。

ロックが無効になっている場合、このAPI呼び出しの完全なコードは次のようになります。

 temp_events = NUSE_Event_Group_Data[group] & requested_events; if (operation == NUSE_OR) { if (temp_events != 0) { return_value = NUSE_SUCCESS; } else { return_value = NUSE_NOT_PRESENT; } } else /* operation == NUSE_AND */ { if (temp_events == requested_events) { return_value = NUSE_SUCCESS; } else { return_value = NUSE_NOT_PRESENT; } } 

必要なイベントフラグは、指定されたイベントフラグのグループから選択されます。 値は、要求されたフラグの戻り値と即値とともに、 AND / OR演算を考慮して、必要なイベントと比較されます。

タスクのロックが有効になっている場合、コードはより複雑になります。

 do { temp_events = NUSE_Event_Group_Data[group] & requested_events; if (operation == NUSE_OR) { if (temp_events != 0) { return_value = NUSE_SUCCESS; } else { return_value = NUSE_NOT_PRESENT; } } else /* operation == NUSE_AND */ { if (temp_events == requested_events) { return_value = NUSE_SUCCESS; } else { return_value = NUSE_NOT_PRESENT; } } if (return_value == NUSE_SUCCESS) { suspend = NUSE_NO_SUSPEND; } else { if (suspend == NUSE_SUSPEND) /* block task */ { NUSE_Event_Group_Blocking_Count[group]++; NUSE_Suspend_Task(NUSE_Task_Active, (group << 4) | NUSE_EVENT_SUSPEND); return_value = NUSE_Task_Blocking_Return[NUSE_Task_Active]; if (return_value != NUSE_SUCCESS) { suspend = NUSE_NO_SUSPEND; } } } } while (suspend == NUSE_SUSPEND); 

コードはdo ... whileループに配置されます 。このループは、 suspendパラメーターがNUSE_SUSPENDの間に実行されます。

要求されたイベントフラグは、ブロックせずに呼び出されたかのように読み取られます。 読み取りが成功せず、 サスペンドパラメータがNUSE_NO_SUSPENDの場合、API呼び出しはNUSE_NOT_PRESENTに設定されます 。 suspendパラメーターがNUSE_SUSPENDに設定されている場合、タスクは一時停止します。 戻るとき（タスクが再開するとき）、戻り値がNUSE_SUCCESSの場合、このグループのイベントフラグが設定またはクリアされたためにタスクが再開されたことを示し、サイクルが最初から開始され、フラグが読み取られてチェックされます。 イベントフラグのグループをリセットするAPI関数がないため、これがタスクを再開する唯一の理由ですが、 NUSE_Task_Blocking_Return []チェックプロセスは、ロック制御と他のタイプのオブジェクトとの互換性のためにシステムに残されています。

次の記事では、イベントフラググループに関連付けられた追加のAPI呼び出しとそのデータ構造について説明します。

著者について： Colin Wallsは電子業界で30年以上働いており、ほとんどの時間をファームウェアに費やしています。 現在、Mentor Embedded（Mentor Graphicsの一部門）のファームウェアエンジニアです。 Colin Wallsは、カンファレンスやセミナー、多くの技術記事の著者、ファームウェアに関する2冊の本でよく話します。 英国に住んでいます。 Colinのプロフェッショナルブログ 、電子メール：colin_walls@mentor.com。