WdfUsbTargetDeviceSendUrbSynchronously 函数 (wdfusb.h)

项目
02/29/2024

[仅适用于 KMDF]

WdfUsbTargetDeviceSendUrbSynchronously 方法使用 URB 描述的请求参数将 USB 请求同步发送到指定的 USB 设备。

语法

NTSTATUS WdfUsbTargetDeviceSendUrbSynchronously(
  [in]           WDFUSBDEVICE              UsbDevice,
  [in, optional] WDFREQUEST                Request,
  [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions,
  [in]           PURB                      Urb
);

参数

[in] UsbDevice

USB 设备对象的句柄，该对象是从上一次调用 WdfUsbTargetDeviceCreateWithParameters 获取的。

[in, optional] Request

框架请求对象的句柄。此参数是可选的，可以为 NULL。有关更多信息，请参见下面的“备注”部分。

[in, optional] RequestOptions

指向调用方分配 WDF_REQUEST_SEND_OPTIONS 结构的指针，该结构指定请求的选项。此指针是可选的，可以为 NULL。有关更多信息，请参见下面的“备注”部分。

[in] Urb

指向调用方初始化的 URB 结构的指针。

如果驱动程序以前调用 WdfUsbTargetDeviceCreateWithParameters 来创建 UsbDevice，则驱动程序必须使用 WdfUsbTargetDeviceCreateUrb 或 WdfUsbTargetDeviceCreateIsochUrb 来创建此 URB。

返回值

如果操作成功，WdfUsbTargetDeviceSendUrbSynchronously 将返回 I/O 目标的完成状态值。否则，此方法可以返回以下值之一：

返回代码	说明
STATUS_INVALID_PARAMETER	检测到参数无效。
STATUS_INVALID_DEVICE_REQUEST	调用方 IRQL 无效。
STATUS_INSUFFICIENT_RESOURCES	可用内存不足。
STATUS_IO_TIMEOUT	驱动程序提供了超时值，请求未在分配的时间内完成。

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

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

注解

使用 WdfUsbTargetDeviceSendUrbSynchronously 方法以同步方式发送 USB 控制传输请求。若要异步发送此类请求，请使用 WdfUsbTargetDeviceFormatRequestForUrb，后跟 WdfRequestSend。

WdfUsbTargetDeviceSendUrbSynchronously 方法在请求完成之前不会返回，除非驱动程序在 RequestOptions 参数的WDF_REQUEST_SEND_OPTIONS结构中提供超时值，或者除非检测到错误。

可以转发驱动程序在 I/O 队列中收到的 I/O 请求，也可以创建并发送新请求。

若要转发驱动程序在 I/O 队列中收到的 I/O 请求，请为 WdfUsbTargetDeviceSendUrbSynchronously 方法的 Request 参数指定接收的请求句柄。

若要创建和发送新请求，请为 Request 参数提供 NULL请求句柄，或创建新的请求对象并提供其句柄：

如果提供 NULL 请求句柄，框架将使用内部请求对象。此方法易于使用，但驱动程序无法取消请求。
如果调用 WdfRequestCreate 来创建一个或多个请求对象，可以通过调用 WdfRequestReuse 重用这些请求对象。此技术使驱动程序的 EvtDriverDeviceAdd 回调函数能够预分配设备的请求对象。此外，另一个驱动程序线程可以调用 WdfRequestCancelSentRequest 来取消请求（如有必要）。

驱动程序可以指定非 NULLRequestOptions 参数，无论驱动程序提供非 NULL 还是 NULLRequest 参数。例如，可以使用 RequestOptions 参数指定超时值。

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

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

示例

下面的代码示例初始化 URB 结构并调用 WdfUsbTargetDeviceSendUrbSynchronously。

URB Urb;
NTSTATUS status;

Urb.UrbHeader.Function =  URB_FUNCTION_GET_CONFIGURATION;
Urb.UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST);
Urb.UrbControlGetConfigurationRequest.TransferBufferLength = 1 ; // Must be 1
Urb.UrbControlGetConfigurationRequest.TransferBufferMDL = NULL;
Urb.UrbControlGetConfigurationRequest.TransferBuffer = outBuffer;
Urb.UrbControlGetConfigurationRequest.UrbLink = NULL;

status = WdfUsbTargetDeviceSendUrbSynchronously(
                                                UsbDevice,
                                                NULL,
                                                NULL,
                                                &Urb
                                                );

要求

要求	值
目标平台	通用
最低 KMDF 版本	1.0
标头	wdfusb.h (包括 Wdfusb.h)
Library	Wdf01000.sys (请参阅框架库 Versioning.)
IRQL	PASSIVE_LEVEL
DDI 符合性规则	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) ， SyncReqSend (kmdf) 、 UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf)