WdfUsbTargetPipeWriteSynchronously 関数 (wdfusb.h)

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

[KMDF と UMDF に適用]

WdfUsbTargetPipeWriteSynchronously メソッドは、書き込み要求をビルドし、指定された USB 出力パイプに同期的に送信します。

構文

NTSTATUS WdfUsbTargetPipeWriteSynchronously(
  [in]            WDFUSBPIPE                Pipe,
  [in, optional]  WDFREQUEST                Request,
  [in, optional]  PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [in, optional]  PWDF_MEMORY_DESCRIPTOR    MemoryDescriptor,
  [out, optional] PULONG                    BytesWritten
);

パラメーター

[in] Pipe

WdfUsbInterfaceGetConfiguredPipe を呼び出して取得したフレームワークパイプオブジェクトへのハンドル。

[in, optional] Request

フレームワーク要求オブジェクトへのハンドル。このパラメーターは省略可能であり、 NULL にすることができます。詳細については、「解説」を参照してください。

[in, optional] RequestOptions

要求のオプションを指定する呼び出し元によって割り当てられた WDF_REQUEST_SEND_OPTIONS 構造体へのポインター。このポインターは省略可能であり、 NULL にすることができます。詳細については、「解説」を参照してください。

[in, optional] MemoryDescriptor

デバイスに書き込まれるデータを含むバッファーを記述する呼び出し元によって割り当てられた WDF_MEMORY_DESCRIPTOR 構造体へのポインター。このバッファーの詳細については、次の「解説」セクションを参照してください。

[out, optional] BytesWritten

操作が成功した場合に書き込まれたバイト数を受け取る場所へのポインター。このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

操作が成功した場合、WdfUsbTargetPipeWriteSynchronously は I/O ターゲットの完了状態値を返します。それ以外の場合、このメソッドは次のいずれかの値を返す可能性があります。

リターンコード	説明
STATUS_INFO_LENGTH_MISMATCH	RequestOptions パラメーターが指すWDF_REQUEST_SEND_OPTIONS構造体のサイズが正しくありません。
STATUS_INVALID_PARAMETER	無効なパラメーターが検出されました。
STATUS_INSUFFICIENT_RESOURCES	メモリが不足していました。
STATUS_INVALID_DEVICE_REQUEST	呼び出し元の IRQL がPASSIVE_LEVELされていない、無効なメモリ記述子が指定された、パイプの種類が無効、転送方向が無効、または指定された I/O 要求が既に I/O ターゲットにキューに登録されている。
STATUS_IO_TIMEOUT	ドライバーがタイムアウト値を指定し、割り当てられた時間内に要求が完了しませんでした。
STATUS_REQUEST_NOT_ACCEPTED	要求パラメーターが表す I/O 要求パケット (IRP) は、ドライバーが要求を転送できるようにするための十分なIO_STACK_LOCATION構造体を提供しません。

このメソッドは、他の NTSTATUS 値を返す場合もあります。

ドライバーが無効なオブジェクトハンドルを提供すると、バグチェックが発生します。

注釈

書き込み要求を同期的に送信するには 、WdfUsbTargetPipeWriteSynchronously メソッドを使用します。書き込み要求を非同期的に送信するには、 WdfUsbTargetPipeFormatRequestForWrite を使用し、その後に WdfRequestSend を使用します。

指定したパイプは出力パイプである必要があり、パイプの種類は WdfUsbPipeTypeBulk または WdfUsbPipeTypeInterrupt である必要があります。

WdfUsbTargetPipeWriteSynchronously メソッドは、要求が完了するまで戻りません。ただし、ドライバーが RequestOptions パラメーターのWDF_REQUEST_SEND_OPTIONS構造体にタイムアウト値を指定しない限り、またはエラーが検出されない限り返されません。

ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。どちらの場合も、フレームワークには要求オブジェクトとバッファー領域が必要です。

ドライバーが I/O キューで受信した I/O 要求を転送するには:

Request パラメーターに対して、受信した要求のハンドルを指定します。
MemoryDescriptor パラメーターには、受信した要求の入力バッファーを使用します。
ドライバーは WdfRequestRetrieveInputMemory を呼び出して、要求の入力バッファーを表すフレームワークメモリオブジェクトへのハンドルを取得し、そのハンドルを MemoryDescriptor が指すWDF_MEMORY_DESCRIPTOR構造体に配置する必要があります。

I/O 要求の転送の詳細については、「I /O 要求の転送」を参照してください。

ドライバーは、多くの場合、受信した I/O 要求を、I/O ターゲットに送信する小さな要求に分割するため、ドライバーは新しい要求を作成する可能性があります。

新しい I/O 要求を作成するには:

WdfUsbTargetPipeWriteSynchronously メソッドの Request パラメーターに NULL 要求ハンドルを指定するか、新しい要求オブジェクトを作成してそのハンドルを指定します。
- NULL 要求ハンドルを指定すると、フレームワークは内部要求オブジェクトを使用します。この手法は簡単に使用できますが、ドライバーは要求を取り消すことができません。
- WdfRequestCreate を呼び出して 1 つ以上の要求オブジェクトを作成する場合は、WdfRequestReuse を呼び出してこれらの要求オブジェクトを再利用できます。この手法を使用すると、ドライバーの EvtDriverDeviceAdd コールバック関数を使用して、デバイスの要求オブジェクトを事前に割り当てることができます。さらに、別のドライバースレッドは WdfRequestCancelSentRequest を呼び出して、必要に応じて要求を取り消すことができます。
ドライバーは、NULL 以外の RequestOptions パラメーターを指定できます。ドライバーが NULL 以外の要求パラメーターと NULL要求パラメーターのどちらを提供しているか。たとえば、 RequestOptions パラメーターを使用してタイムアウト値を指定できます。
WdfUsbTargetPipeWriteSynchronously メソッドの MemoryDescriptor パラメーターのバッファー領域を指定します。
ドライバーは、ローカルに割り当てられたバッファー、WDFMEMORY ハンドル、または MDL として、このバッファー領域を指定できます。最も便利な方法を使用できます。

必要に応じて、フレームワークはバッファーの説明を、データバッファーにアクセスするための I/O ターゲットのメソッドに適した記述に変換します。

次の手法を使用できます。
- ローカルバッファーを指定する
  WdfUsbTargetPipeWriteSynchronously は I/O 要求を同期的に処理するため、次のコード例に示すように、ドライバーは呼び出し元ルーチンにローカルな要求バッファーを作成できます。
```
WDF_MEMORY_DESCRIPTOR  memoryDescriptor;
MY_BUFFER_TYPE  myBuffer;
WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(&memoryDescriptor,
                                  (PVOID) &myBuffer,
                                  sizeof(myBuffer));
```
- WDFMEMORY ハンドルを指定する
  次のコード例に示すように、 WdfMemoryCreate または WdfMemoryCreatePreallocated を呼び出して、フレームワークマネージドメモリへのハンドルを取得します。
```
WDF_MEMORY_DESCRIPTOR  memoryDescriptor;
WDFMEMORY  memoryHandle = NULL;
status = WdfMemoryCreate(NULL,
                         NonPagedPool,
                         POOL_TAG,
                         MY_BUFFER_SIZE,
                         &memoryHandle,
                         NULL);
WDF_MEMORY_DESCRIPTOR_INIT_HANDLE(&memoryDescriptor,
                                  memoryHandle,
                                  NULL);
```
  または、ドライバーは WdfRequestRetrieveInputMemory を呼び出して、受信した I/O 要求の入力バッファーを表すフレームワークメモリオブジェクトへのハンドルを取得できます (ドライバーがそのバッファーの内容を I/O ターゲットに渡す場合)。ドライバーは、 WdfUsbTargetPipeWriteSynchronously が I/O ターゲットに送信する新しい要求が削除、再利用、または再フォーマットされるまで、受信した I/O 要求を完了することはできません。 (WdfUsbTargetPipeWriteSynchronously は、メモリオブジェクトの参照カウントをインクリメントします。要求オブジェクトを削除、再利用、または再フォーマットすると、メモリオブジェクトの参照カウントがデクリメントされます)。
- MDL を指定する
  ドライバーは、 WdfRequestRetrieveInputWdmMdl を呼び出すことによって、受信した I/O 要求に関連付けられている MDL を取得できます。

I/O 要求の完了後に状態情報を取得する方法については、「完了情報の取得」を参照してください。

WdfUsbTargetPipeWriteSynchronously メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲット」を参照してください。

例

次のコード例では、メモリオブジェクトを作成し、オブジェクトのバッファーへのポインターを取得し、バッファーを埋め、 バッファーを WdfUsbTargetPipeWriteSynchronously への入力として使用します。

WDF_MEMORY_DESCRIPTOR  writeBufDesc;
WDFMEMORY  wdfMemory;
ULONG  writeSize, bytesWritten;
size_t  bufferSize;
NTSTATUS status;

writeSize = SMALL_BUF_LEN;
status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         writeSize,
                         &wdfMemory,
                         NULL
                         );
if (!NT_SUCCESS(status)){
    return status;
}

writeBuffer = WdfMemoryGetBuffer(
                                 wdfMemory,
                                 &bufferSize
                                 );

FillMyBuffer(
             writeBuffer,
             writeSize
             );

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER(
                                  &writeBufDesc,
                                  writeBuffer,
                                  writeSize
                                  );

status = WdfUsbTargetPipeWriteSynchronously(
                                            pipeHandle,
                                            NULL,
                                            NULL,
                                            &writeBufDesc,
                                            &bytesWritten
                                            );

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
最小 UMDF バージョン	2.0
Header	wdfusb.h (Wdfusb.h を含む)
Library	Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、InternalIoctlReqs(kmdf)、IoctlReqs(kmdf)、KmdfIrql(kmdf)、KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、ReadReqs(kmdf)、SyncReqSend(kmdf)、UsbKmdfIrql(kmdf)、UsbKmdfIrql2 (kmdf)、UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf)