Fonction UfxEndpointCreate (ufxclient.h)

  • Article

Crée un objet de point de terminaison.

Syntaxe

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
);

Paramètres

[in] UfxDevice

Handle vers un objet de périphérique UFX que le pilote a créé en appelant UfxDeviceCreate.

[in, out] EndpointInit

Structure opaque transmise par UFX dans l’appel à EVT_UFX_DEVICE_ENDPOINT_ADD ou EVT_UFX_DEVICE_DEFAULT_ENDPOINT_ADD.

[in, optional] Attributes

Pointeur vers la structure WDF_OBJECT_ATTRIBUTES allouée par l’appelant. Cette structure doit être initialisée avec WDF_OBJECT_ATTRIBUTES_INIT ou WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE. Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[in] TransferQueueConfig

Pointeur vers un appelant alloué WDF_IO_QUEUE_CONFIG structure. Cette structure doit être initialisée avec WDF_IO_QUEUE_CONFIG_INIT.

[in, optional] TransferQueueAttributes

Pointeur vers la structure WDF_OBJECT_ATTRIBUTES allouée par l’appelant. Cette structure doit être initialisée avec WDF_OBJECT_ATTRIBUTES_INIT ou WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE. Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[in] CommandQueueConfig

Pointeur vers un appelant alloué WDF_IO_QUEUE_CONFIG structure. Cette structure doit être initialisée avec WDF_IO_QUEUE_CONFIG_INIT.

[in, optional] CommandQueueAttributes

Pointeur vers la structure WDF_OBJECT_ATTRIBUTES allouée par l’appelant. Cette structure doit être initialisée avec WDF_OBJECT_ATTRIBUTES_INIT ou WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE. Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[out] UfxEndpoint

Pointeur vers un emplacement qui reçoit un handle vers un objet UFXENDPOINT.

Valeur retournée

Si l’opération réussit, la méthode retourne STATUS_SUCCESS, ou une autre valeur de status pour laquelle NT_SUCCESS(status) est égal à TRUE. Sinon, elle retourne une valeur status pour laquelle NT_SUCCESS(status) est false.

Remarques

La file d’attente de transfert gère les IOCTL suivants liés aux transferts de point de terminaison :

La file d’attente de commandes gère les IOCTL suivants :

L’exemple suivant montre comment créer un objet UFXENDPOINT et initialiser son contexte. 
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;
}

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 10
Plateforme cible Windows
En-tête ufxclient.h
Bibliothèque ufxstub.lib
IRQL PASSIVE_LEVEL