WdfUsbTargetPipeFormatRequestForRead 函数 (wdfusb.h)

项目
08/08/2023

[适用于 KMDF 和 UMDF]

WdfUsbTargetPipeFormatRequestForRead 方法为 USB 输入管道生成读取请求，但不会发送请求。

语法

NTSTATUS WdfUsbTargetPipeFormatRequestForRead(
  [in]           WDFUSBPIPE        Pipe,
  [in]           WDFREQUEST        Request,
  [in, optional] WDFMEMORY         ReadMemory,
  [in, optional] PWDFMEMORY_OFFSET ReadOffset
);

参数

[in] Pipe

通过调用 WdfUsbInterfaceGetConfiguredPipe 获取的框架管道对象的句柄。

[in] Request

框架请求对象的句柄。有关更多信息，请参见下面的“备注”部分。

[in, optional] ReadMemory

框架内存对象的句柄。此对象表示将从管道接收数据的缓冲区。缓冲区大小必须是管道最大数据包大小的倍数，除非驱动程序已调用 WdfUsbTargetPipeSetNoMaximumPacketSizeCheck。有关此缓冲区的详细信息，请参阅以下“备注”部分。

[in, optional] ReadOffset

指向调用方分配的WDFMEMORY_OFFSET 结构的指针，该结构提供可选的字节偏移量和长度值。框架使用这些值来确定读取缓冲区内数据传输的起始地址和长度。如果此指针为 NULL，则数据传输从缓冲区的开头开始，传输大小为缓冲区大小。

返回值

如果操作成功，WdfUsbTargetPipeFormatRequestForRead 将返回STATUS_SUCCESS。否则，此方法可返回以下值之一：

返回代码	说明
STATUS_INVALID_PARAMETER	检测到无效的参数。
STATUS_INSUFFICIENT_RESOURCES	可用内存不足。
STATUS_INVALID_DEVICE_REQUEST	指定了无效的内存描述符、管道的类型无效、传输方向无效，或者指定的 I/O 请求已排队到 I/O 目标。
STATUS_INTEGER_OVERFLOW	Offset 参数指定的偏移量无效。
STATUS_INVALID_BUFFER_SIZE	缓冲区大小不是管道最大数据包大小的倍数。缓冲区大小必须是管道最大数据包大小的倍数，除非驱动程序已调用 WdfUsbTargetPipeSetNoMaximumPacketSizeCheck。
STATUS_REQUEST_NOT_ACCEPTED	请求参数表示的 I/O 请求数据包 (IRP) 不提供足够的IO_STACK_LOCATION结构来允许驱动程序转发请求。

此方法还可能返回其他 NTSTATUS 值。

如果驱动程序提供无效的对象句柄，则会发生 bug 检查。

注解

使用 WdfUsbTargetPipeFormatRequestForRead（后跟 WdfRequestSend）以同步或异步方式发送读取请求。或者，使用 WdfUsbTargetPipeReadSynchronously 方法以同步方式发送读取请求。

Pipe 参数指定的管道必须是输入管道，管道的类型必须是 WdfUsbPipeTypeBulk 或 WdfUsbPipeTypeInterrupt。

可以转发驱动程序在 I/O 队列中收到的 I/O 请求，也可以创建并发送新请求。在任一情况下，框架都需要请求对象和一些缓冲区空间。

转发驱动程序在 I/O 队列中收到的 I/O 请求：

为 WdfUsbTargetPipeFormatRequestForRead 方法的 Request 参数指定接收的请求句柄。
将收到的请求的输出缓冲区用于 WdfUsbTargetPipeFormatRequestForRead 方法的 ReadMemory 参数。
驱动程序必须调用 WdfRequestRetrieveOutputMemory 以获取表示请求输出缓冲区的框架内存对象的句柄，并使用该句柄作为 ReadMemory 参数的值。

有关转发 I/O 请求的详细信息，请参阅转发 I/O 请求。

驱动程序通常将收到的 I/O 请求划分为发送到 I/O 目标的较小请求，因此驱动程序可能会创建新请求。

创建新的 I/O 请求：

创建新的请求对象，并为 WdfUsbTargetPipeFormatRequestForRead 方法的 Request 参数提供其句柄。
调用 WdfRequestCreate 以预分配一个或多个请求对象。可以通过调用 WdfRequestReuse 重用这些请求对象。驱动程序的 EvtDriverDeviceAdd 回调函数可以预分配设备的请求对象。
提供缓冲区空间，并为 WdfUsbTargetPipeFormatRequestForRead 方法的 ReadMemory 参数提供缓冲区的句柄。
驱动程序必须将此缓冲区空间指定为框架托管内存的 WDFMEMORY 句柄。驱动程序可以执行以下任一操作：
- 如果希望驱动程序将新缓冲区传递到 I/O 目标，请调用 WdfMemoryCreateCreate 或 WdfMemoryCreatePreallocated 创建新的内存缓冲区。
- 如果希望驱动程序将该缓冲区的内容传递到 I/O 目标，请调用 WdfRequestRetrieveOutputMemory 以获取内存对象的句柄，该对象表示接收的 I/O 请求的缓冲区。
请注意，如果驱动程序调用 WdfRequestRetrieveOutputMemory 并将内存句柄传递给 WdfUsbTargetPipeFormatRequestForRead，则在驱动程序删除、重用或重新格式化新的驱动程序创建的请求对象之前，驱动程序不得完成收到的 I/O 请求。 (WdfUsbTargetPipeFormatRequestForRead 递增内存对象的引用计数。删除、重用或重新格式化请求对象会递减内存对象的引用 count.)

调用 WdfUsbTargetPipeFormatRequestForRead 以格式化 I/O 请求后，驱动程序必须调用 WdfRequestSend 以同步或异步方式将请求 () 发送到 I/O 目标。

对使用同一请求的 WdfUsbTargetPipeFormatRequestForRead 的多次调用不会导致额外的资源分配。因此，为了降低 WdfRequestCreate 返回STATUS_INSUFFICIENT_RESOURCES的可能性，驱动程序的 EvtDriverDeviceAdd 回调函数可以调用 WdfRequestCreate 来预分配设备的一个或多个请求对象。驱动程序随后可以重复使用 (调用 WdfRequestReuse) 、重新设置格式 (调用 WdfUsbTargetPipeFormatRequestForRead) ，并重新发送 (调用 WdfRequestSend) 每个请求对象，而不会STATUS_INSUFFICIENT_RESOURCES WdfRequestCreate 的后续调用返回值。如果参数值不更改，对 WdfUsbTargetPipeFormatRequestForRead 的所有后续调用都将返回STATUS_SUCCESS。 (如果驱动程序不每次调用相同的请求格式设置方法，则可能会分配其他资源。)

框架在其内部 URB 中设置USBD_SHORT_TRANSFER_OK标志。设置此标志允许数据传输的最后一个数据包小于最大数据包大小。

有关在 I/O 请求完成后获取状态信息的信息，请参阅获取完成信息。

有关 WdfUsbTargetPipeFormatRequestForRead 方法和 USB I/O 目标的详细信息，请参阅 USB I/O 目标。

示例

以下代码示例来自 kmdf_fx2 示例驱动程序。此示例是将读取请求转发到 USB 管道的 EvtIoRead 回调函数。该示例调用 WdfRequestRetrieveOutputMemory 来获取请求的输出缓冲区，然后格式化读取请求，以便可以将请求发送到 USB 管道。接下来，该示例注册一个 CompletionRoutine 回调函数。最后，它将请求发送到 USB 管道。

VOID 
OsrFxEvtIoRead(
    IN WDFQUEUE  Queue,
    IN WDFREQUEST  Request,
    IN size_t  Length
    )
{
    WDFUSBPIPE  pipe;
    NTSTATUS  status;
    WDFMEMORY  reqMemory;
    PDEVICE_CONTEXT  pDeviceContext;

    //
    // First, validate input parameters.
    //
    if (Length > TEST_BOARD_TRANSFER_BUFFER_SIZE) {
        status = STATUS_INVALID_PARAMETER;
        goto Exit;
    }

    pDeviceContext = GetDeviceContext(WdfIoQueueGetDevice(Queue));
 
    pipe = pDeviceContext->BulkReadPipe;
 
    status = WdfRequestRetrieveOutputMemory(
                                            Request,
                                            &reqMemory
                                            );
    if (!NT_SUCCESS(status)){
        goto Exit;
    }
 
    status = WdfUsbTargetPipeFormatRequestForRead(
                                                  pipe,
                                                  Request,
                                                  reqMemory,
                                                  NULL
                                                  ); 
    if (!NT_SUCCESS(status)) {
        goto Exit;
    }

    WdfRequestSetCompletionRoutine(
                                   Request,
                                   EvtRequestReadCompletionRoutine,
                                   pipe
                                   );
    if (WdfRequestSend(
                       Request,
                       WdfUsbTargetPipeGetIoTarget(pipe),
                       WDF_NO_SEND_OPTIONS
                       ) == FALSE) {
        status = WdfRequestGetStatus(Request);
        goto Exit;
    }

 
Exit:
    if (!NT_SUCCESS(status)) {
        WdfRequestCompleteWithInformation(
                                          Request,
                                          status,
                                          0
                                          );
    }
    return;
}

要求

要求	值
目标平台	通用
最低 KMDF 版本	1.0
最低 UMDF 版本	2.0
标头	wdfusb.h (包括 Wdfusb.h)
Library	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	<=DISPATCH_LEVEL
DDI 符合性规则	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) ， RequestFormattedValid (kmdf) 、 RequestSendAndForgetNoFormatting (kmdf) 、 RequestSendAndForgetNoFormatting2 (kmdf) 、 UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf)