UfxEndpointCreate 函数 (ufxclient.h)

  • 项目

创建终结点对象。

语法

NTSTATUS UfxEndpointCreate(
  [in]           UFXDEVICE              UfxDevice,
  [in, out]      PUFXENDPOINT_INIT      EndpointInit,
  [in, optional] PWDF_OBJECT_ATTRIBUTES Attributes,
  [in]           PWDF_IO_QUEUE_CONFIG   TransferQueueConfig,
  [in, optional] PWDF_OBJECT_ATTRIBUTES TransferQueueAttributes,
  [in]           PWDF_IO_QUEUE_CONFIG   CommandQueueConfig,
  [in, optional] PWDF_OBJECT_ATTRIBUTES CommandQueueAttributes,
  [out]          UFXENDPOINT            *UfxEndpoint
);

参数

[in] UfxDevice

驱动程序通过调用 UfxDeviceCreate 创建的 UFX 设备对象的句柄。

[in, out] EndpointInit

UFX 在调用 EVT_UFX_DEVICE_ENDPOINT_ADD 或 EVT_UFX_DEVICE_DEFAULT_ENDPOINT_ADD 时传递 的不透明结构。

[in, optional] Attributes

指向调用方分配 的WDF_OBJECT_ATTRIBUTES 结构的指针。 必须使用 WDF_OBJECT_ATTRIBUTES_INIT 或 WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE 初始化此结构。 此参数是可选的，可以 WDF_NO_OBJECT_ATTRIBUTES。

[in] TransferQueueConfig

指向分配 WDF_IO_QUEUE_CONFIG 结构的调用方指针。 必须使用 WDF_IO_QUEUE_CONFIG_INIT 初始化此结构。

[in, optional] TransferQueueAttributes

指向调用方分配 的WDF_OBJECT_ATTRIBUTES 结构的指针。 必须使用 WDF_OBJECT_ATTRIBUTES_INIT 或 WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE 初始化此结构。 此参数是可选的，可以 WDF_NO_OBJECT_ATTRIBUTES。

[in] CommandQueueConfig

指向分配 WDF_IO_QUEUE_CONFIG 结构的调用方指针。 必须使用 WDF_IO_QUEUE_CONFIG_INIT 初始化此结构。

[in, optional] CommandQueueAttributes

指向调用方分配 的WDF_OBJECT_ATTRIBUTES 结构的指针。 必须使用 WDF_OBJECT_ATTRIBUTES_INIT 或 WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE 初始化此结构。 此参数是可选的，可以 WDF_NO_OBJECT_ATTRIBUTES。

[out] UfxEndpoint

指向接收 UFXENDPOINT 对象的句柄的位置的指针。

返回值

如果操作成功，该方法将返回STATUS_SUCCESS或NT_SUCCESS (状态) 等于 TRUE 的另一个状态值。 否则，它将返回一个状态值，NT_SUCCESS (状态) 等于 FALSE。

注解

传输队列处理与终结点传输相关的以下 IOCTL：

命令队列将处理以下 IOCTL：

以下示例演示如何创建 UFXENDPOINT 对象并初始化其上下文。 
NTSTATUS
UfxEndpointAdd (
    _In_ UFXDEVICE Device,
    _In_ PUSB_ENDPOINT_DESCRIPTOR Descriptor,
    _Inout_ PUFXENDPOINT_INIT EndpointInit
    )
/*++
Routine Description:

    Creates a UFXENDPOINT object, and initializes its contexts.

Parameters Description:

    Device - UFXDEVICE associated with the endpoint.

    Descriptor - Endpoint descriptor for this endpoint.

    EndpointInit - Opaque structure from UFX.

Return Value:

    STATUS_SUCCESS if successful, appropriate NTSTATUS message otherwise.
--*/
{
    NTSTATUS Status;
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDF_IO_QUEUE_CONFIG TransferQueueConfig;
    WDF_OBJECT_ATTRIBUTES TransferQueueAttributes;
    WDF_IO_QUEUE_CONFIG CommandQueueConfig;
    WDF_OBJECT_ATTRIBUTES CommandQueueAttributes;
    UFXENDPOINT Endpoint;
    PUFXENDPOINT_CONTEXT EpContext;
    PUFXDEVICE_CONTEXT DeviceContext;
    UFX_ENDPOINT_CALLBACKS Callbacks;
    PENDPOINT_QUEUE_CONTEXT QueueContext;
    WDFQUEUE Queue;

    TraceEntry();

    DeviceContext = UfxDeviceGetContext(Device);

    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, UFXENDPOINT_CONTEXT);
    Attributes.ExecutionLevel = WdfExecutionLevelPassive;
    Attributes.EvtCleanupCallback = UfxEndpoint_Cleanup;

    //
    // Note: Execution level needs to be passive to avoid deadlocks with WdfRequestComplete.
    //
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&TransferQueueAttributes, ENDPOINT_QUEUE_CONTEXT);
    TransferQueueAttributes.ExecutionLevel = WdfExecutionLevelPassive;
    
    WDF_IO_QUEUE_CONFIG_INIT(&TransferQueueConfig, WdfIoQueueDispatchManual);
    TransferQueueConfig.AllowZeroLengthRequests = TRUE;
    TransferQueueConfig.EvtIoStop = EndpointQueue_EvtIoStop;

    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&CommandQueueAttributes, ENDPOINT_QUEUE_CONTEXT);
    CommandQueueAttributes.ExecutionLevel = WdfExecutionLevelPassive;

    WDF_IO_QUEUE_CONFIG_INIT(&CommandQueueConfig, WdfIoQueueDispatchSequential);
    CommandQueueConfig.EvtIoInternalDeviceControl = EvtEndpointCommandQueue;

    UFX_ENDPOINT_CALLBACKS_INIT(&Callbacks);
    UfxEndpointInitSetEventCallbacks(EndpointInit, &Callbacks);

    Status = UfxEndpointCreate(
                 Device,
                 EndpointInit,
                 &Attributes,
                 &TransferQueueConfig,
                 &TransferQueueAttributes,
                 &CommandQueueConfig,
                 &CommandQueueAttributes,
                 &Endpoint);
    CHK_NT_MSG(Status, "Failed to create ufxendpoint!");

    Status = WdfCollectionAdd(DeviceContext->Endpoints, Endpoint);
    CHK_NT_MSG(Status, "Failed to add endpoint to collection!");

    EpContext = UfxEndpointGetContext(Endpoint);
    EpContext->UfxDevice = Device;
    EpContext->WdfDevice = DeviceContext->FdoWdfDevice;
    RtlCopyMemory(&EpContext->Descriptor, Descriptor, sizeof(*Descriptor));

    Queue = UfxEndpointGetTransferQueue(Endpoint);
    QueueContext = EndpointQueueGetContext(Queue);
    QueueContext->Endpoint = Endpoint;

    Queue = UfxEndpointGetCommandQueue(Endpoint);
    QueueContext = EndpointQueueGetContext(Queue);
    QueueContext->Endpoint = Endpoint;

    Status = TransferInitialize(Endpoint);
    CHK_NT_MSG(Status, "Failed to initialize endpoint transfers");
    
    //
    // This can happen if we're handling a SetInterface command.
    //
    if (DeviceContext->UsbState == UsbfnDeviceStateConfigured) {
        UfxEndpointConfigure(Endpoint);
    }

    Status = WdfIoQueueReadyNotify(
                 UfxEndpointGetTransferQueue(Endpoint),
                 TransferReadyNotify,
                 Endpoint);
    CHK_NT_MSG(Status, "Failed to register ready notify");

End:
    TraceExit();
    return Status;
}

要求

要求 值
最低受支持的客户端 Windows 10
目标平台 Windows
标头 ufxclient.h
Library ufxstub.lib
IRQL PASSIVE_LEVEL