ucxendpoint.h header
This header is used by usbref. For more information, see:
ucxendpoint.h contains the following programming interfaces:
Functions
UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS_INIT Initializes a UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS structure with client driver's callback functions. The client driver calls this function before calling UcxEndpointCreate method to create an endpoint and register its callback functions with UCX. |
UCX_ENDPOINT_EVENT_CALLBACKS_INIT Initializes a UCX_ENDPOINT_EVENT_CALLBACKS structure with client driver's callback functions. The client driver calls this function before calling UcxEndpointCreate method to create an endpoint and register its callback functions with UCX. |
UcxDefaultEndpointInitSetEventCallbacks Initializes a UCXENDPOINT_INIT structure with client driver's event callback functions related to the default endpoint. |
UcxEndpointAbortComplete Notifies UCX that a transfer abort operation has been completed on the specified endpoint object. |
UcxEndpointCreate Creates an endpoint on the specified USB device object. |
UcxEndpointGetStaticStreamsReferenced Returns a referenced static streams object for the specified endpoint. |
UcxEndpointInitSetEventCallbacks Initializes a UCXENDPOINT_INIT structure with client driver's event callback functions related to endpoints on the device. |
UcxEndpointNeedToCancelTransfers The client driver calls this method before it cancels transfers on the wire. |
UcxEndpointNoPingResponseError Notifies UCX about a "No Ping Response" error for a transfer on the specified endpoint object. |
UcxEndpointPurgeComplete Notifies UCX that a purge operation has been completed on the specified endpoint object. |
UcxEndpointSetWdfIoQueue Sets a framework queue on the specified endpoint object. |
Callback functions
EVT_UCX_DEFAULT_ENDPOINT_UPDATE The client driver's implementation that UCX calls with information about the default endpoint. |
EVT_UCX_ENDPOINT_ABORT The client driver's implementation that UCX calls to abort the queue associated with the endpoint. |
EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS UCX invokes this callback function to get information about transfer path delays for an isochronous endpoint. |
EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS The client driver's implementation that UCX calls to notify the controller driver that it can complete cancelled transfers on the endpoint. |
EVT_UCX_ENDPOINT_PURGE The client driver's implementation that completes all outstanding I/O requests on the endpoint. |
EVT_UCX_ENDPOINT_RESET The client driver's implementation that UCX calls to reset the controller's programming for an endpoint. |
EVT_UCX_ENDPOINT_SET_CHARACTERISTIC UCX invokes this callback function to set the priority on an endpoint. |
EVT_UCX_ENDPOINT_START The client driver's implementation that UCX calls to start the queue associated with the endpoint. |
EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD The client driver's implementation that UCX calls to create static streams. |
EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE The client driver's implementation that UCX calls to release controller resources for all streams for an endpoint. |
EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE The client driver's implementation that UCX calls to enable the static streams. |
Structures
DEFAULT_ENDPOINT_UPDATE Contains the handle to the default endpoint to update in a framework request that is passed by UCX when it invokes EVT_UCX_DEFAULT_ENDPOINT_UPDATE callback function. |
ENDPOINT_RESET Describes information required to reset an endpoint. This structure is passed by UCX in the EVT_UCX_ENDPOINT_RESET callback function. |
ENDPOINTS_CONFIGURE Describes endpoints to enable or disable endpoints. This structure is passed by UCX in the EVT_UCX_USBDEVICE_ENDPOINTS_CONFIGURE callback function. |
ENDPOINTS_CONFIGURE_FAILURE_FLAGS This structure provides failure flags to indicate errors, if any, that might have occurred during a request to an EVT_UCX_USBDEVICE_ENDPOINTS_CONFIGURE callback function. |
UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS This structure provides a list of UCX default endpoint event callback functions. |
UCX_ENDPOINT_CHARACTERISTIC Stores the characteristics of an endpoint. |
UCX_ENDPOINT_EVENT_CALLBACKS This structure provides a list of pointers to UCX endpoint event callback functions. |
UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS Stores the isochronous transfer path delay values. |
Enumerations
ENDPOINT_RESET_FLAGS Defines parameters for a request to reset an endpoint. |
UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY Indicates the priority of endpoints. |
UCX_ENDPOINT_CHARACTERISTIC_TYPE Defines values that indicates the type of endpoint characteristic. |