Edit

EVT_UCX_CONTROLLER_GET_TRANSPORT_CHARACTERISTICS callback function (ucxcontroller.h)

  • Article

UCX invokes this callback to retrieve the host controller characteristics.

Syntax

EVT_UCX_CONTROLLER_GET_TRANSPORT_CHARACTERISTICS EvtUcxControllerGetTransportCharacteristics;

NTSTATUS EvtUcxControllerGetTransportCharacteristics(
  [in]  UCXCONTROLLER UcxController,
  [out] PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS UcxControllerTransportCharacteristics
)
{...}

Parameters

[in] UcxController

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

[out] UcxControllerTransportCharacteristics

A pointer to a UCX_CONTROLLER_TRANSPORT_CHARACTERISTICS structure that the client driver for the host controller fills with transport characteristics.

Return value

If the operation is successful, the callback function must return STATUS_SUCCESS, or another status value for which NT_SUCCESS(status) equals TRUE. Otherwise it must return a status value for which NT_SUCCESS(status) equals FALSE.

Remarks

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

This callback function is optional. Whenever transport characteristics change, the client driver is responsible for notifying UCX that one of the characteristics have changed using a new function UcxControllerNotifyTransportCharacteristicsChange.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1709
Minimum supported server Windows Server 2016
Target Platform Windows
Minimum KMDF version 1.0
Minimum UMDF version 2.0
Header ucxcontroller.h (include Ucxclass.h)
IRQL PASSIVE_LEVEL

See also

UcxControllerCreate