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

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

NDIS は、ミニポートドライバーの MiniportOidRequest 関数を呼び出して、ドライバーの情報を照会または設定するための OID 要求を処理します。

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

構文

MINIPORT_OID_REQUEST MiniportOidRequest;

NDIS_STATUS MiniportOidRequest(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] PNDIS_OID_REQUEST OidRequest
)
{...}

パラメーター

[in] MiniportAdapterContext

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

[in] OidRequest

バッファーとミニポートドライバーが処理する要求パケットの両方を含む NDIS_OID_REQUEST構造体へのポインター。要求に応じて、ドライバーは、指定された構造体で要求された情報を返します。

戻り値

MiniportOidRequest は、次のいずれかの状態値を返すことができます。

リターンコード	説明
NDIS_STATUS_SUCCESS	ミニポートドライバーは、要求に応じてデータを設定または取得します。
NDIS_STATUS_PENDING	ミニポートドライバーは、非同期的に要求を完了します。ミニポートドライバーがすべての処理を完了した後、を呼び出す必要があります。要求が完了したことを NDIS に通知する NdisMOidRequestComplete 関数。
NDIS_STATUS_INVALID_OID	OidRequest で指定された要求が無効であるか、認識されません。
NDIS_STATUS_NOT_SUPPORTED	OidRequest で指定された要求は認識されますが、ミニポートドライバーではサポートされていません。
NDIS_STATUS_BUFFER_TOO_SHORT	OidRequest で提供されるバッファーが小さすぎて、要求されたデータを保持できません。
NDIS_STATUS_INVALID_LENGTH	OidRequest のNDIS_OID_REQUEST構造体の InformationBufferLength メンバーで指定された値が、指定したOID_ XXX コードに対して正しくありません。
NDIS_STATUS_INVALID_DATA	OidRequest で要求に指定された 1 つ以上のパラメーターが無効です。
NDIS_STATUS_NOT_ACCEPTED	を呼び出した後、ミニポートDevicePnPEventNotify 関数は、突然の削除を示すために、ドライバーの MiniportHaltEx 関数を呼び出します。ドライバーは、NDIS が MiniportHaltEx を呼び出す前に OID 要求を受信する場合は、状態の値NDIS_STATUS_NOT_ACCEPTEDを使用して、このような要求をすぐに完了する必要があります。
NDIS_STATUS_REQUEST_ABORTED	ミニポートドライバーが要求の処理を停止しました。たとえば、NDIS は MiniportResetEx 関数を呼び出しました。
NDIS_STATUS_INDICATION_REQUIRED	ミニポートドライバーは、後続の状態を示す OID 完了状態を提供します。ミニポートドライバーは、特定の OID がそれを許可しない限り、NDIS_STATUS_INDICATION_REQUIREDを返すことができません。この状態が許可されているかどうかを確認するには、OID リファレンスページを参照してください。 NDIS_STATUS_INDICATION_REQUIREDの詳細については、「 NDIS_OID_REQUEST と NDIS_STATUS_INDICATION」を参照してください。

注釈

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

NDIS は、独自の代わりに 、または NdisOidRequest 関数を呼び出したバインドされたプロトコルドライバーの代わりに、 MiniportOidRequest 関数を呼び出します。ミニポートドライバーは 、OidRequest で指定された要求を調べて、要求されたアクションを実行する必要があります。ミニポートドライバーが処理する OID の詳細については、「 NDIS OID」を参照してください。

NDIS は OidRequest で OID 固有のコンテンツを検証しないことに注意してください。したがって、ドライバー自体は、これらの内容を検証する必要があります。ドライバーは、設定する値が範囲外であると判断した場合は、要求を失敗し、NDIS_STATUS_INVALID_DATAを返す必要があります。

MiniportOidRequest がNDIS_STATUS_PENDINGを返す場合、NDIS は、保留中の要求が完了するまで、MiniportAdapterContext で指定されたミニポートアダプターに対して、別の要求で MiniportOidRequest を呼び出しません。

メモNDIS チェック-for-hang ロジックは、ミニポートドライバーが MiniportOidRequest 呼び出しのコンテキストで待機している場合に応答しないミニポートドライバーをリセットしません。したがって、ミニポートドライバーは、 ミニポートOidRequest 呼び出しのコンテキスト内からハードウェア操作が完了するまで待機しないでください。代わりに、ドライバーはNDIS_STATUS_PENDINGを返し、作業項目をキューに入れます。

NDIS は、IRQL == PASSIVE_LEVEL で MiniportOidRequest を呼び出します。

例

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

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

MINIPORT_OID_REQUEST MyOidRequest;

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

_Use_decl_annotations_
NDIS_STATUS
 MyOidRequest(
    NDIS_HANDLE  MiniportAdapterContext,
    PNDIS_OID_REQUEST  OidRequest
    )
  {...}

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

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

要件

要件	値
サポートされている最小のクライアント	NDIS 6.0 以降でサポートされています。
対象プラットフォーム	Windows
ヘッダー	ndis.h (Ndis.h を含む)
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	NdisOidComplete、NdisOidDoubleComplete、NdisOidDoubleRequest、NdisTimedOidComplete、WlanAssociation、WlanDisassociation、WlanTimedAssociation、WlanTimedConnectionRoaming、WlanTimedConnectRequest、WlanTimedLinkQuality、WlanTimedScan