EVT_UCX_ENDPOINT_RESET callback function (ucxendpoint.h)

Article
02/22/2024

The client driver's implementation that UCX calls to reset the controller's programming for an endpoint.

Syntax

EVT_UCX_ENDPOINT_RESET EvtUcxEndpointReset;

void EvtUcxEndpointReset(
  [in] UCXCONTROLLER UcxController,
  [in] UCXENDPOINT UcxEndpoint,
  [in] WDFREQUEST Request
)
{...}

Parameters

[in] UcxController

A handle to the UCX controller that the client driver received in a previous call to the UcxControllerCreate method.

[in] UcxEndpoint

A handle to a UCXENDPOINT object that represents the endpoint.

[in] Request

A handle to a framework request object that the client driver completes when the reset operation is finished.

Return value

None

Remarks

The UCX client driver registers this callback function with the USB host controller extension (UCX) by calling the UcxEndpointCreate method.

The client driver returns completion status in the WDFREQUEST, which it might complete asynchronously.

Examples

VOID
Endpoint_EvtUcxEndpointReset(
    UCXCONTROLLER   UcxController,
    UCXENDPOINT     UcxEndpoint,
    WDFREQUEST      Request
)

{
    UNREFERENCED_PARAMETER(UcxController);
    UNREFERENCED_PARAMETER(UcxEndpoint);

    DbgTrace(TL_INFO, Endpoint, "Endpoint_EvtUcxEndpointReset");

    WdfRequestComplete(Request, STATUS_SUCCESS);
}

Requirements

Requirement	Value
Target Platform	Windows
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	ucxendpoint.h (include Ucxclass.h, Ucxendpoint.h)
IRQL	DISPATCH_LEVEL

Share via