HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINEコールバック関数 (storport.h)

[アーティクル]
08/07/2023

HwMSInterruptRoutine ルーチンは、メッセージシグナル割り込み (MSI) を処理します。

構文

HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE HwMessageSignaledInterruptRoutine;

BOOLEAN HwMessageSignaledInterruptRoutine(
  IN PVOID HwDeviceExtension,
  IN ULONG MessageId
)
{...}

パラメーター

HwDeviceExtension

ホストバスアダプター (HBA) のハードウェアデバイス拡張機能へのポインター。

MessageId

メッセージの識別子。

戻り値

HBA によって MSI が生成されたと判断された場合、HwMSInterruptRoutine は TRUE を返します。 HBA で MSI が生成されなかった場合、 HwMSInterruptRoutine は FALSE を返します。

注釈

ミニポートドライバーの HwMSInterruptRoutine ルーチンは、HBA によって生成されるメッセージシグナル割り込み (MSI) を処理します。ミニポートドライバーは、HBA が HwMSInterruptRoutine ルーチンを指すように PORT_CONFIGURATION_INFORMATION 構造体の HwMSInterruptRoutine メンバーを設定することによって、MSI を生成することを示します。 HBA で MSI が生成されない場合、ミニポートドライバーは HwMSInterruptRoutine を NULL に設定する必要があります。

PORT_CONFIGURATION_INFORMATION構造体の InterruptSynchronizationMode メンバーが InterruptSynchronizeAll に設定されている場合、Storport ドライバーは、管理するアダプターまたはアダプターに接続されているデバイスからのすべての MSI を同期します。割り込みが発生すると、Storport ドライバーは、割り込みスピンロックを取得した後、DIRQL でミニポートドライバーの HwMSInterruptRoutine ルーチンを呼び出します。

PORT_CONFIGURATION_INFORMATION構造体の InterruptSynchronizationMode メンバーが InterruptSynchronizePerMessage に設定されている場合、Storport ドライバーは、ミニポートドライバーの HwMSInterruptRoutine ルーチンを IRQL = DIRQL で呼び出し、MessageID パラメーターに示されているメッセージ識別子 (ID) に対応する割り込みスピンロックを保持します。 HBA は、他のメッセージ ID の割り込みに対して HwMSInterruptRoutine ルーチンを中断できるため、Storport ドライバーは HwMSInterruptRoutine に対して入れ子になった呼び出しを行うか、異なるプロセッサで 同時に HwMSInterruptRoutine の異なるインスタンスを実行する可能性があります。 HwMSInterruptRoutine のさまざまなインスタンスによって機密データへのアクセスを同期するには、ミニポートは StorPortAcquireMSISpinLock ルーチンと StorPortReleaseMSISpinLock ルーチンを呼び出して、MessageID の ID 以外のメッセージ ID のスピンロックを取得および解放する必要があります。

ミニポートドライバーは、 StorPortGetMSIInfo ルーチンを呼び出すことによって、メッセージに関する追加情報を取得できます。

HwMSInterruptRoutine ルーチン内から StorPortGetMSIInfo ルーチンを呼び出さないでください。

HwMSInterruptRoutine という名前は、単なるプレースホルダーです。このルーチンの実際のプロトタイプは、 Storport.h で次のように定義されています。

typedef
BOOLEAN
  HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE (
    _In_ PVOID  HwDeviceExtension,
    _In_ ULONG  MessageId
    );

例

HwMSInterruptRoutine コールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。コールバック関数の種類を使用して関数を宣言すると、ドライバー、静的ドライバー検証ツール (SDV)、およびその他の検証ツールのコード分析でエラーが検出され、Windows オペレーティングシステム用のドライバーを記述するための要件になります。

たとえば、MyHwMSIRoutine という名前の HwMSInterruptRoutine コールバックルーチンを定義するには、次のコード例に示すように、HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE型を使用します。

HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE MyHwMSIRoutine;

次に、コールバックルーチンを次のように実装します。

_Use_decl_annotations_
BOOLEAN
MyHwMSIRoutine (
  _In_ PVOID  DeviceExtension,
  _In_ ULONG  MessageId
  );
  {
      ...
  }

HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE関数型は、Storport.h ヘッダーファイルで定義されています。コード分析ツールを実行するときにエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダーファイル内のHW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE関数型に適用される注釈が確実に使用されます。関数宣言の要件の詳細については、「 Storport ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。