EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS callback function (ucxendpoint.h)

The client driver's implementation that UCX calls to notify the controller driver that it can complete cancelled transfers on the endpoint.

Syntax

EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS EvtUcxEndpointOkToCancelTransfers;

void EvtUcxEndpointOkToCancelTransfers(
  [in] UCXENDPOINT UcxEndpoint
)
{...}

Parameters

[in] UcxEndpoint

A handle to a UCXENDPOINT object that represents the endpoint.

Return value

None

Remarks

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

Before completing the URB associated with the transfer, the client driver calls UcxEndpointNeedToCancelTransfers and then waits for UCX to call this function. Then the client driver can complete the URB with STATUS_CANCELLED.

Note

If GUID_USB_CAPABILITY_CLEAR_TT_BUFFER_ON_ASYNC_TRANSFER_CANCEL capability is supported, the hub driver may send a control transfer to clear the TT (Transaction Translator) buffer before UCX calls this function.

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