WdfUsbTargetDeviceFormatRequestForUrb 函式 (wdfusb.h)

[僅適用于 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,驅動程式必須使用 WdfUsbTargetDeviceCreateUrbWdfUsbTargetDeviceCreateIsochUrb 來建立此記憶體物件中包含的 URB。 否則,會發生錯誤檢查。

[in, optional] UrbMemoryOffset

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

傳回值

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

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

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

如果驅動程式提供不正確物件控制碼,就會發生錯誤檢查。

備註

使用 WdfUsbTargetDeviceFormatRequestForUrb,後面接著 WdfRequestSend,以同步或非同步方式傳送 USB 控制項傳輸要求。 或者,使用 WdfUsbTargetDeviceSendUrbSynchronously 方法來同步傳送要求。

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

若要轉送驅動程式在 I/O 佇列中收到的 I/O 要求,請針對 WdfUsbTargetDeviceFormatRequestForUrb方法的要求參數 指定收到的要求控制碼。

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

呼叫 WdfUsbTargetDeviceFormatRequestForUrb 以格式化 I/O 要求之後,驅動程式必須呼叫 WdfRequestSend ,以同步或) 非同步方式將要求傳送至 I/O 目標 (。 請勿使用 send and forget 選項 來傳送要求。

對使用相同要求 之 WdfUsbTargetDeviceFormatRequestForUrb 的多個呼叫不會造成額外的資源配置。 因此,為了減少 WdfRequestCreate 將傳回STATUS_INSUFFICIENT_RESOURCES的機會,驅動程式的 EvtDriverDeviceAdd 回呼函式可以呼叫 WdfRequestCreate 來預先配置裝置的一或多個要求物件。 驅動程式後續可以重複使用 (呼叫 WdfRequestReuse) 、重新格式化 (呼叫 WdfUsbTargetDeviceFormatRequestForUrb) ,然後重新傳送 (呼叫 WdfRequestSend) 每個要求物件,而不會有STATUS_INSUFFICIENT_RESOURCES從稍後呼叫 WdfRequestCreate傳回值的風險。 如果參數值未變更,則針對重複使用的要求物件,對 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);
}

規格需求

   
目標平臺 環球
最小 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)

另請參閱

EvtDriverDeviceAdd

WDFMEMORY_OFFSET

WdfRequestReuse

WdfRequestSend

WdfUsbTargetDeviceCreateWithParameters

WdfUsbTargetDeviceSendUrbSynchronously