MINIPORT_SHUTDOWN コールバック関数 (ndis.h)

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

NDIS は、システムがシャットダウンするときにミニポートドライバーの ミニポートShutdownEx 関数を呼び出します。この関数は、他のコールバック ( MiniportHaltEx を含む) が発生しないシャットダウン状態にミニポートを配置します。ミニポートドライバーの状態の詳細については、「ミニポートアダプターの状態と操作」を参照してください。

メモMINIPORT_SHUTDOWN型を使用して関数を宣言する必要があります。詳細については、次の例に関するセクションを参照してください。

構文

MINIPORT_SHUTDOWN MiniportShutdown;

void MiniportShutdown(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] NDIS_SHUTDOWN_ACTION ShutdownAction
)
{...}

パラメーター

[in] MiniportAdapterContext

ミニポートドライバーがそのミニポート初期化Ex 関数で割り当てたコンテキスト領域へのハンドル。ドライバーは、ミニポートアダプターの状態情報を維持するために、このコンテキスト領域を使用します。

[in] ShutdownAction

NDIS がシャットダウン関数を呼び出した理由。有効な値は、次のとおりです。

NdisShutdownPowerOff

システムがシャットダウンしているため 、NDIS が MiniportShutdownEx を呼び出したことを示します。

NdisShutdownBugCheck

システムエラーが原因 で NDIS が MiniportShutdownEx を呼び出したことを示します。

戻り値

なし

解説

ドライバーは、を呼び出すとき にミニポートShutdownEx エントリポイントを指定します。 NdisMRegisterMiniportDriver 関数。

MiniportShutdownEx は 、ミニポートアダプターを既知の初期状態 (NDIS がミニポートアダプターのミニポートドライバーの MiniportInitializeEx 関数を呼び出す前の状態) に復元します。これにより、ミニポートアダプターが既知の状態であり、回復不可能なシステムエラーなど、何らかの理由でシステムのシャットダウンが発生した後にコンピューターが再起動されたときに再初期化する準備ができていることを確認します。

MiniportShutdownEx は、NDISMGetBusData または NdisMSetBusData 関数を呼び出して、DMA エンジンを無効にするか、割り込みを無効にするか、ハードウェアを既知の状態にリセットして、ハードウェアを安全に再起動できるようにすることで、I/O ポート、メモリマップデバイスの I/O 領域、またはバス固有の構成領域を読み取りまたは書き込むことができます。

ユーザーが開始したシャットダウンのために NDIS が MiniportShutdownEx を呼び出す場合、 MiniportShutdownEx は IRQL = PASSIVE_LEVEL で実行され、ミニポートドライバーは他の NdisXxx 関数を 呼び出すことができます。

回復できないエラーが原因 で NDIS が MiniportShutdownEx を呼び出す場合、 ShutdownAction パラメーターは NdisShutdownBugCheck に設定され、 ミニポートShutdownEx は高 IRQL で実行されています。この場合、ミニポートドライバーは、任意の IRQL で呼び出すことができる関数を除き、 NdisXxx 関数を呼び出す必要があります。 NDIS 6.30 ミニポート以降、NDIS は、アダプター登録属性にNDIS_MINIPORT_ATTRIBUTES_REGISTER_BUGCHECK_CALLBACK フラグを提供しない限り、BugCheck 中にミニポートShutdownEx を呼び出しません。

ShutdownAction の値が NdisShutdownPowerOff の場合、ミニポートドライバーは必要に応じてそのリソースを解放できます。ただし、システムのシャットダウンによって不要になるため、これは必須でも推奨もされません。

ShutdownAction の値が NdisShutdownBugCheck の場合、ミニポートドライバーはリソースを解放できません。

大事なMiniportHaltEx によってシステムエラーが発生した場合、ミニポートドライバーには、ShutdownActionNdisShutdownBugCheck を使用した MiniportShutdownEx への入れ子になった呼び出しが表示されます。この場合、 MiniportShutdownEx は 作業を行わずに直ちにを返す必要があります。

例

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

たとえば、" MyShutdownEx" という名前の MiniportShutdownEx 関数を定義するには、次のコード例に示すように 、MINIPORT_SHUTDOWN 型を使用します。

MINIPORT_SHUTDOWN MyShutdownEx;

次に、次のように関数を実装します。

_Use_decl_annotations_
VOID
 MyShutdownEx(
    NDIS_HANDLE  MiniportAdapterContext,
    NDIS_SHUTDOWN_ACTION  ShutdownAction
    )
  {...}

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

Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	NDIS 6.0 以降でサポートされています。
対象プラットフォーム	Windows
ヘッダー	ndis.h (Ndis.h を含む)
IRQL	「解説」セクションを参照してください