EVT_UCX_DEFAULT_ENDPOINT_UPDATE callback function (ucxendpoint.h)

Article
02/22/2024

The client driver's implementation that UCX calls with information about the default endpoint.

Syntax

EVT_UCX_DEFAULT_ENDPOINT_UPDATE EvtUcxDefaultEndpointUpdate;

void EvtUcxDefaultEndpointUpdate(
  [in] UCXCONTROLLER UcxController,
  [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] Request

A DEFAULT_ENDPOINT_UPDATE structure that contains the handle to the default endpoint to be updated.

Return value

None

Remarks

The UCX client driver registers its EVT_UCX_DEFAULT_ENDPOINT_UPDATE implementation with the USB host controller extension (UCX) by calling the UcxEndpointCreate method.

UCX typically calls this routine to update the default endpoint's maximum packet size. The client driver returns completion status in the WDFREQUEST, which it can complete asynchronously.

Examples

VOID
Endpoint_EvtUcxDefaultEndpointUpdate(
    UCXCONTROLLER   UcxController,
    WDFREQUEST      Request
)

{
    UNREFERENCED_PARAMETER(UcxController);

    DbgTrace(TL_INFO, Endpoint, "Endpoint_EvtUcxDefaultEndpointUpdate");

    WDF_REQUEST_PARAMETERS_INIT(&wdfRequestParams);
    WdfRequestGetParameters(WdfRequest, &wdfRequestParams);

    defaultEndpointUpdate = (PDEFAULT_ENDPOINT_UPDATE)wdfRequestParams.Parameters.Others.Arg1;
    ...

    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