WdfUsbTargetPipeFormatRequestForWrite 函数 (wdfusb.h)
[适用于 KMDF 和 UMDF]
WdfUsbTargetPipeFormatRequestForWrite 方法生成 USB 输出管道的写入请求,但它不会发送请求。
语法
NTSTATUS WdfUsbTargetPipeFormatRequestForWrite(
[in] WDFUSBPIPE Pipe,
[in] WDFREQUEST Request,
[in, optional] WDFMEMORY WriteMemory,
[in, optional] PWDFMEMORY_OFFSET WriteOffset
);
参数
[in] Pipe
通过调用 WdfUsbInterfaceGetConfiguredPipe 获取的框架管道对象的句柄。
[in] Request
框架请求对象的句柄。 有关更多信息,请参见下面的“备注”部分。
[in, optional] WriteMemory
框架内存对象的句柄。 此对象表示包含将发送到管道的数据的缓冲区。 有关此缓冲区的详细信息,请参阅以下“备注”部分。
[in, optional] WriteOffset
指向调用方分配 的WDFMEMORY_OFFSET 结构的指针,该结构提供可选的字节偏移量和长度值。 框架使用这些值来确定写入缓冲区内数据传输的起始地址和长度。 如果此指针为 NULL,则数据传输从缓冲区的开头开始,传输大小为缓冲区大小。
返回值
如果操作成功,WdfUsbTargetPipeFormatRequestForWrite 将返回STATUS_SUCCESS。 否则,此方法可能会返回以下值之一:
返回代码 | 说明 |
---|---|
|
检测到参数无效。 |
|
可用内存不足。 |
|
指定了无效的内存描述符、管道的类型无效、传输方向无效,或者指定的 I/O 请求已排队到 I/O 目标。 |
|
指定的 Offset 参数无效的偏移量。 |
|
Request 参数表示的 I/O 请求数据包 (IRP) 不提供足够的IO_STACK_LOCATION结构来允许驱动程序转发请求。 |
此方法还可能返回其他 NTSTATUS 值。
如果驱动程序提供无效的对象句柄,则会发生 bug 检查。
注解
使用 WdfUsbTargetPipeFormatRequestForWrite,后跟 WdfRequestSend 以同步或异步方式发送写入请求。 或者,使用 WdfUsbTargetPipeWriteSynchronously 方法以同步方式发送写入请求。
指定的管道必须是输出管道,管道 的类型 必须是 WdfUsbPipeTypeBulk 或 WdfUsbPipeTypeInterrupt。
可以转发驱动程序在 I/O 队列中收到的 I/O 请求,也可以创建并发送新请求。 在任一情况下,框架都需要请求对象和一些缓冲区空间。
转发驱动程序在 I/O 队列中收到的 I/O 请求:
- 为 WdfUsbTargetPipeFormatRequestForWrite 方法的 Request 参数指定接收的请求句柄。
-
将接收的请求的输入缓冲区用于 WdfUsbTargetPipeFormatRequestForWrite 方法的 WriteMemory 参数。
驱动程序必须调用 WdfRequestRetrieveInputMemory 以获取表示请求输入缓冲区的框架内存对象的句柄,并将该句柄用作 WriteMemory 的值。
驱动程序通常将收到的 I/O 请求划分为发送到 I/O 目标的较小请求,因此驱动程序可能会创建新请求。
创建新的 I/O 请求:
-
创建新的请求对象,并为 WdfUsbTargetPipeFormatRequestForWrite 方法的 Request 参数提供其 句 柄。
调用 WdfRequestCreate 以预分配一个或多个请求对象。 可以通过调用 WdfRequestReuse 来重复使用这些请求对象。 驱动程序的 EvtDriverDeviceAdd 回调函数可以为设备预分配请求对象。
-
提供缓冲区空间,并为 WdfUsbTargetPipeFormatRequestForWrite 方法的 WriteMemory 参数提供缓冲区的句柄。
驱动程序必须将此缓冲区空间指定为框架托管内存的 WDFMEMORY 句柄。 驱动程序可以执行以下任一操作:
- 如果希望驱动程序将新缓冲区传递到 I/O 目标,请调用 WdfMemoryCreateCreate 或 WdfMemoryCreatePreallocated 创建新的内存缓冲区。
- 如果希望驱动程序将该缓冲区的内容传递给 I/O 目标,请调用 WdfRequestRetrieveInputMemory 以获取内存对象的句柄,该句柄表示收到的 I/O 请求的缓冲区。
对使用同一请求的 WdfUsbTargetPipeFormatRequestForWrite 的多次调用不会导致额外的资源分配。 因此,为了降低 WdfRequestCreate 返回STATUS_INSUFFICIENT_RESOURCES的可能性,驱动程序的 EvtDriverDeviceAdd 回调函数可以调用 WdfRequestCreate 来预分配设备的一个或多个请求对象。 随后,驱动程序可以重复使用 (调用 WdfRequestReuse) 、重新设置格式 (调用 WdfUsbTargetPipeFormatRequestForWrite) ,并重新发送 (调用 WdfRequestSend) 每个请求对象,而不会冒着以后调用 WdfRequestCreate STATUS_INSUFFICIENT_RESOURCES返回值的风险。 如果参数值不更改,则对重用请求对象的 WdfUsbTargetPipeFormatRequestForWrite 的所有后续调用都将返回STATUS_SUCCESS。 (如果驱动程序每次都不调用相同的请求格式设置方法,可能会分配其他资源。)
有关在 I/O 请求完成后获取状态信息的信息,请参阅 获取完成信息。
有关 WdfUsbTargetPipeFormatRequestForWrite 方法和 USB I/O 目标的详细信息,请参阅 USB I/O 目标。
示例
下面的代码示例来自 kmdf_fx2 示例驱动程序。 此示例是将写入请求转发到 USB 管道的 EvtIoWrite 回调函数。 该示例调用 WdfRequestRetrieveInputMemory 以获取请求的输入缓冲区,然后格式化写入请求,以便可以将请求发送到 USB 管道。 接下来,该示例注册一个 CompletionRoutine 回调函数。 最后,它将请求发送到 USB 管道。
VOID
OsrFxEvtIoWrite(
IN WDFQUEUE Queue,
IN WDFREQUEST Request,
IN size_t Length
)
{
NTSTATUS status;
WDFUSBPIPE pipe;
WDFMEMORY reqMemory;
PDEVICE_CONTEXT pDeviceContext;
if (Length > TEST_BOARD_TRANSFER_BUFFER_SIZE) {
status = STATUS_INVALID_PARAMETER;
goto Exit;
}
pDeviceContext = GetDeviceContext(WdfIoQueueGetDevice(Queue));
pipe = pDeviceContext->BulkWritePipe;
status = WdfRequestRetrieveInputMemory(
Request,
&reqMemory
);
if (!NT_SUCCESS(status)){
goto Exit;
}
status = WdfUsbTargetPipeFormatRequestForWrite(
pipe,
Request,
reqMemory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
EvtRequestWriteCompletionRoutine,
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) |