WdfUsbTargetDeviceFormatRequestForControlTransfer 函式 (wdfusb.h)

發行項
02/27/2024

[適用於 KMDF 和 UMDF]

WdfUsbTargetDeviceFormatRequestForControlTransfer 方法會建置 USB 控件傳輸要求，但不會傳送要求。

語法

NTSTATUS WdfUsbTargetDeviceFormatRequestForControlTransfer(
  [in]           WDFUSBDEVICE                  UsbDevice,
  [in]           WDFREQUEST                    Request,
  [in]           PWDF_USB_CONTROL_SETUP_PACKET SetupPacket,
  [in, optional] WDFMEMORY                     TransferMemory,
  [in, optional] PWDFMEMORY_OFFSET             TransferOffset
);

參數

[in] UsbDevice

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

[in] Request

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

[in] SetupPacket

描述控制項傳輸之呼叫端配置之WDF_USB_CONTROL_SETUP_PACKET 結構的指標。

[in, optional] TransferMemory

架構記憶體物件的句柄，描述輸入或輸出緩衝區，視裝置特定的命令而定。此指標是選擇性的，可以是 NULL。如需詳細資訊，請參閱接下來的＜備註＞一節。

[in, optional] TransferOffset

呼叫端配置的 WDFMEMORY_OFFSET 結構的指標，可提供選擇性的位元移和長度值。架構會使用這些值來判斷 TransferMemory 所指定緩衝區內的起始位址和長度。如果此指標為 NULL，架構會使用整個緩衝區。

傳回值

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

傳回碼	Description
STATUS_INVALID_PARAMETER	偵測到無效的參數。
STATUS_INSUFFICIENT_RESOURCES	記憶體不足。
STATUS_INVALID_DEVICE_REQUEST	指定了無效的記憶體描述元，或指定的 I/O 要求已排入 I/O 目標佇列。

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

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

備註

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

您可以轉送驅動程式在 I/O 佇列中收到的 I/O 要求，也可以建立並傳送新的要求。不論是哪一種情況，架構都需要要求物件，而且視控件傳輸的類型而定，可能是某些緩衝區空間。

若要轉送驅動程式在 I/O 佇列中收到的 I/O 要求：

為 WdfUsbTargetDeviceFormatRequestForControlTransfer方法的要求參數 指定收到的要求句柄。
針對 TransferMemory 參數，使用收到的要求輸入或輸出緩衝區。
驅動程式必須呼叫 WdfRequestRetrieveInputMemory 或 WdfRequestRetrieveOutputMemory ，以取得代表要求的輸入或輸出緩衝區的架構記憶體物件的句柄，並使用該句柄做為 TransferMemory 的值。

若要建立新的 I/O 要求和新的緩衝區：

建立新的要求物件，併為 WdfUsbTargetDeviceFormatRequestForControlTransfer 方法的 Request 參數提供其句柄。
呼叫 WdfRequestCreate 以預先配置一或多個要求物件。您可以呼叫 WdfRequestReuse 來重複使用這些要求物件。驅動程式的 EvtDriverDeviceAdd 回呼函式可以預先配置裝置的要求物件。
提供緩衝區空間，併為 WdfUsbTargetDeviceFormatRequestForControlTransfer 方法的 TransferMemory 參數提供緩衝區的句柄。
您的驅動程式必須將此緩衝區空間指定為架構管理的記憶體的WDFMEMORY句柄。您的驅動程式可以執行下列其中一項：
- 如果您想要驅動程式將新的緩衝區傳遞至 I/O 目標，請呼叫 WdfMemoryCreate 或 WdfMemoryCreatePreallocated 來建立新的記憶體緩衝區。
- 如果您想要讓驅動程式將該緩衝區的內容傳遞至 I/O 目標，請呼叫 WdfRequestRetrieveOutputMemory 來取得記憶體物件的句柄，代表接收的 I/O 要求的緩衝區。
請注意，如果您的驅動程式呼叫 WdfRequestRetrieveInputMemory 或 WdfRequestRetrieveOutputMemory ，並將記憶體句柄傳遞至 WdfUsbTargetDeviceFormatRequestForControlTransfer，在驅動程式刪除、重複使用或重新格式化新的驅動程式建立要求物件之前，驅動程式不得完成收到的 I/O 要求。 (WdfUsbTargetDeviceFormatRequestForControlTransfer 會遞增記憶體對象的參考計數。刪除、重複使用或重新格式化要求物件會遞減記憶體對象的參考計數。)

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

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

架構會在其內部 URB 中設定USBD_SHORT_TRANSFER_OK旗標。設定此旗標可讓數據傳輸的最後一個封包小於封包大小上限。

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

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

範例

下列程式代碼範例會建立要求物件和記憶體物件，然後初始化「取得狀態」控件傳輸的WDF_USB_CONTROL_SETUP_PACKET 結構。接下來，此範例會呼叫 WdfUsbTargetDeviceFormatRequestForControlTransfer 來格式化要求。然後，此範例會設定 CompletionRoutine 回呼函式，並將要求傳送至 I/O 目標。

WDF_USB_CONTROL_SETUP_PACKET packet;
NTSTATUS status;
WDF_OBJECT_ATTRIBUTES attributes;
WDFMEMORY memHandle;

WDF_OBJECT_ATTRIBUTES_INIT(&attributes);

status = WdfRequestCreate(
                          &attributes,
                          WdfUsbTargetDeviceGetIoTarget(
                              UsbTargetDevice,
                              &request
                              )
                          );
if (!NT_SUCCESS(status)){
    return status;
}

WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
attributes.ParentObject = request;
status = WdfMemoryCreate(
                         &attributes,
                         NonPagedPool,
                         0,
                         sizeof(USHORT),
                         &memHandle,
                         NULL
                         );
if (!NT_SUCCESS(status)){
    return status;
}

WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS(
                                             &packet,
                                             BmRequestToDevice,
                                             0
                                             );
status = WdfUsbTargetDeviceFormatRequestForControlTransfer(
                         UsbTargetDevice,
                         request,
                         &packet,
                         memHandle,
                         NULL
                         );
if (!NT_SUCCESS(status)){
    return status;
}
WdfRequestSetCompletionRoutine(
                               request,
                               MyCompletionRoutine,
                               NULL
                               );
if (WdfRequestSend(
                   request,
                   WdfUsbTargetDeviceGetIoTarget(UsbTargetDevice),
                   NULL
                   ) == FALSE) {
    status = WdfRequestGetStatus(request);
}

規格需求

需求	值
目標平台	Universal
最小 KMDF 版本	1.0
最低UMDF版本	2.0
標頭	wdfusb.h (包含 Wdfusb.h)
程式庫	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	<=DISPATCH_LEVEL
DDI 合規性規則	DriverCreate (kmdf) ， KmdfIrql (kmdf) ， KmdfIrql2 (kmdf) ， KmdfIrqlExplicit (kmdf) ， RequestFormattedValid (kmdf) 、 RequestForUrbXrb (kmdf) 、 RequestSendAndForgetNoFormatting (kmdf) 、 RequestSendAndForgetNoFormatting2 (kmdf) 、 UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf)

另請參閱

WDF_USB_CONTROL_SETUP_PACKET

WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS

WdfUsbTargetDeviceSendControlTransferSynchronously

共用方式為

WdfUsbTargetDeviceFormatRequestForControlTransfer 函式 (wdfusb.h)

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源