WdfUsbTargetDeviceFormatRequestForCyclePort 函式 (wdfusb.h)

發行項
02/27/2024

[僅適用於 KMDF]

WdfUsbTargetDeviceFormatRequestForCyclePort 方法會為連接指定裝置的埠建置電源週期要求，但不會傳送要求。

語法

NTSTATUS WdfUsbTargetDeviceFormatRequestForCyclePort(
  [in] WDFUSBDEVICE UsbDevice,
  [in] WDFREQUEST   Request
);

參數

[in] UsbDevice

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

[in] Request

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

傳回值

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

傳回碼	Description
STATUS_INVALID_DEVICE_STATE	裝置的 USB 裝置無法使用。
STATUS_INSUFFICIENT_RESOURCES	記憶體不足。

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

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

備註

使用 WdfUsbTargetDeviceFormatRequestForCyclePort，後面接著 WdfRequestSend，以同步或異步方式傳送電源週期要求。或者，使用 WdfUsbTargetDeviceCyclePortSynchronously 方法來同步傳送要求。

在驅動程式呼叫 WdfRequestSend 之前，它必須呼叫 WdfIoTargetStop ，而且它必須完成或取消它已傳送至 I/O 目標的所有 I/O 要求。在迴圈要求完成之前，驅動程式不得將其他 I/O 要求傳送至 I/O 目標。

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

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

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

呼叫 WdfUsbTargetDeviceFormatRequestForCyclePort 格式化 I/O 要求之後，驅動程式必須呼叫 WdfRequestSend 以同步或異步方式) 將要求傳送至 I/O 目標 (。呼叫 WdfRequestSend 必須在 IRQL = PASSIVE_LEVEL。

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

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

範例

下列程式代碼範例會格式化 Power-cycle 要求、註冊 CompletionRoutine 回呼函式，並將要求傳送至 I/O 目標。

status = WdfUsbTargetDeviceFormatRequestForCyclePort(
                                            UsbDevice,
                                            request
                                            );
if (!NT_SUCCESS(status)){
    return status;
}
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)