WdfUsbTargetDeviceFormatRequestForUrb 函式 (wdfusb.h)

發行項
02/27/2024

[僅適用於 KMDF]

WdfUsbTargetDeviceFormatRequestForUrb 方法會使用 URB 所描述的要求參數來建置指定的 USB 裝置的 USB 要求，但不會傳送要求。

語法

NTSTATUS WdfUsbTargetDeviceFormatRequestForUrb(
  [in]           WDFUSBDEVICE      UsbDevice,
  [in]           WDFREQUEST        Request,
  [in]           WDFMEMORY         UrbMemory,
  [in, optional] PWDFMEMORY_OFFSET UrbMemoryOffset
);

參數

[in] UsbDevice

從先前呼叫 WdfUsbTargetDeviceCreateWithParameters 取得的 USB 裝置物件的句柄。

[in] Request

架構要求物件的句柄。如需詳細資訊，請參閱接下來的＜備註＞一節。

[in] UrbMemory

架構記憶體物件的句柄，其中包含 URB 結構或其中一個結構的等位成員。 (所有 URB 結構的等位成員都包含 _URB_HEADER structure.)

如果驅動程式先前稱為 WdfUsbTargetDeviceCreateWithParameters 來建立 UsbDevice，驅動程式必須使用 WdfUsbTargetDeviceCreateUrb 或 WdfUsbTargetDeviceCreateIsochUrb 來建立此記憶體物件中包含的 URB。否則，就會發生錯誤檢查。

[in, optional] UrbMemoryOffset

呼叫端配置的 WDFMEMORY_OFFSET 結構的指標，可提供選擇性位元移和長度值。架構會使用這些值來判斷 UrbMemory 所指定記憶體中 URB 的開頭位址。如果此指標為 NULL，則 URB 位於 UrbMemory 記憶體的開頭。

傳回值

如果作業成功，WdfUsbTargetDeviceFormatRequestForUrb 會傳回STATUS_SUCCESS。否則，這個方法可以傳回下列其中一個值：

傳回碼	Description
STATUS_INVALID_PARAMETER	偵測到無效的參數。
STATUS_INSUFFICIENT_RESOURCES	記憶體不足。
STATUS_INTEGER_OVERFLOW	指定的 UsbMemoryOffset 參數無效的位移。

這個方法也可能傳回其他 NTSTATUS值。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

使用 WdfUsbTargetDeviceFormatRequestForUrb，後面接著 WdfRequestSend，以同步或異步方式傳送 USB 控件傳輸要求。或者，使用 WdfUsbTargetDeviceSendUrbSynchronously 方法來同步傳送要求。

您可以轉送驅動程式在 I/O 佇列中收到的 I/O 要求，也可以建立並傳送新的要求。

若要轉送驅動程式在 I/O 佇列中收到的 I/O 要求，請為 WdfUsbTargetDeviceFormatRequestForUrb 方法的 Request 參數指定收到的要求句柄。

若要建立新的 I/O 要求，請呼叫 WdfRequestCreate 以預先配置要求物件。提供 WdfUsbTargetDeviceFormatRequestForUrb 方法 的 Request 參數的要求 句柄。您可以呼叫 WdfRequestReuse 來重複使用要求物件。驅動程式的 EvtDriverDeviceAdd 回呼函式可以預先配置裝置的要求物件。

呼叫 WdfUsbTargetDeviceFormatRequestForUrb 格式化 I/O 要求之後，驅動程式必須呼叫 WdfRequestSend 以同步或異步方式) 將要求傳送至 I/O 目標 (。請勿使用 [傳送並忘記] 選項來傳送要求。

對使用相同要求 之 WdfUsbTargetDeviceFormatRequestForUrb 的多個呼叫並不會造成額外的資源配置。因此，為了降低 WdfRequestCreate 將傳回STATUS_INSUFFICIENT_RESOURCES的機會，驅動程式的 EvtDriverDeviceAdd 回呼函式可以呼叫 WdfRequestCreate 來預先配置裝置的一或多個要求物件。驅動程式後續可以重複使用 (呼叫 WdfRequestReuse) 、重新格式化 (呼叫 WdfUsbTargetDeviceFormatRequestForUrb) ，然後重新傳送 (呼叫 WdfRequestSend) 每個要求物件，而不需在稍後呼叫 WdfRequestCreate 時產生STATUS_INSUFFICIENT_RESOURCES傳回值的風險。如果參數值未變更，則針對重複使用的要求物件對 WdfUsbTargetDeviceFormatRequestForUrb 的所有後續呼叫都會傳回STATUS_SUCCESS。 (如果驅動程式每次都未呼叫相同的要求格式方法，可能會配置其他資源。)

如需在 I/O 要求完成之後取得狀態資訊的相關信息，請參閱取得完成資訊。

如需 WdfUsbTargetDeviceFormatRequestForUrb 方法和 USB I/O 目標的詳細資訊，請參閱 USB I/O 目標。

範例

下列程式代碼範例會建立記憶體物件來保存 URB 結構、初始化 URB 結構，以及呼叫 WdfUsbTargetDeviceFormatRequestForUrb 來格式化使用 URB 結構內容的要求。然後，此範例會註冊 CompletionRoutine 回呼函式，並將要求傳送至 I/O 目標。

WDFMEMORY urbMemory;
URB *urbBuffer;

status = WdfMemoryCreate(
                         WDF_NO_OBJECT_ATTRIBUTES,
                         NonPagedPool,
                         0,
                         sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST),
                         &urbMemory,
                         NULL
                         );

if (!NT_SUCCESS(status)){
    return status;
}
urbBuffer = (PURB) WdfMemoryGetBuffer(
                                      urbMemory,
                                      NULL
                                      );
urbBuffer->UrbHeader.Function =  URB_FUNCTION_GET_CONFIGURATION;
urbBuffer->UrbHeader.Length = sizeof(struct _URB_CONTROL_GET_CONFIGURATION_REQUEST);
urbBuffer->UrbControlGetConfigurationRequest.TransferBufferLength = 1 ;
urbBuffer->UrbControlGetConfigurationRequest.TransferBufferMDL = NULL;
urbBuffer->UrbControlGetConfigurationRequest.TransferBuffer = outBuffer;
urbBuffer->UrbControlGetConfigurationRequest.UrbLink = NULL;

status = WdfUsbTargetDeviceFormatRequestForUrb(
                                               deviceContext->WdfUsbTargetDevice,
                                               request,
                                               urbMemory,
                                               NULL
                                               );
WdfRequestSetCompletionRoutine(
                              request,
                              MyCompletionRoutine,
                              NULL);

if (WdfRequestSend(
                   request,
                   WdfUsbTargetDeviceGetIoTarget(UsbDevice),
                   NULL
                   ) == FALSE) {
    status = WdfRequestGetStatus(request);
}

規格需求

需求	值
目標平台	Universal
最低 KMDF 版本	1.0
標頭	wdfusb.h (包含 Wdfusb.h)
程式庫	Wdf01000.sys (請參閱 Framework Library Versioning.)
IRQL	<=DISPATCH_LEVEL
DDI 合規性規則	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) ， RequestFormattedValid (kmdf) 、 RequestSendAndForgetNoFormatting (kmdf) 、 RequestSendAndForgetNoFormatting2 (kmdf) 、 UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf)