ucxendpoint.h File Reference

#include "ucxusbdevice.h"

Include dependency graph for ucxendpoint.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_ENDPOINTS_CONFIGURE_FAILURE_FLAGS
struct	_ENDPOINTS_CONFIGURE
struct	_ENDPOINT_RESET
struct	_DEFAULT_ENDPOINT_UPDATE
struct	_UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS
struct	_UCX_ENDPOINT_CHARACTERISTIC
struct	_UCX_ENDPOINT_EVENT_CALLBACKS
struct	_UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS

Typedefs
typedef WDF_EXTERN_C_START enum _ENDPOINT_RESET_FLAGS	ENDPOINT_RESET_FLAGS
typedef struct _ENDPOINTS_CONFIGURE_FAILURE_FLAGS	ENDPOINTS_CONFIGURE_FAILURE_FLAGS
typedef struct _ENDPOINTS_CONFIGURE	ENDPOINTS_CONFIGURE
typedef struct _ENDPOINTS_CONFIGURE *	PENDPOINTS_CONFIGURE
typedef struct _ENDPOINT_RESET	ENDPOINT_RESET
typedef struct _ENDPOINT_RESET *	PENDPOINT_RESET
typedef struct _DEFAULT_ENDPOINT_UPDATE	DEFAULT_ENDPOINT_UPDATE
typedef struct _DEFAULT_ENDPOINT_UPDATE *	PDEFAULT_ENDPOINT_UPDATE
typedef struct _UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS	UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS
typedef struct _UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS *	PUCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS
typedef enum _UCX_ENDPOINT_CHARACTERISTIC_TYPE	UCX_ENDPOINT_CHARACTERISTIC_TYPE
typedef enum _UCX_ENDPOINT_CHARACTERISTIC_PRIORITY	UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY
typedef struct _UCX_ENDPOINT_CHARACTERISTIC	UCX_ENDPOINT_CHARACTERISTIC
typedef struct _UCX_ENDPOINT_CHARACTERISTIC *	PUCX_ENDPOINT_CHARACTERISTIC
typedef _In_ UCXENDPOINT	UcxEndpoint
typedef _In_ UCXENDPOINT _In_ WDFREQUEST	Request
typedef EVT_UCX_ENDPOINT_RESET *	PFN_UCX_ENDPOINT_RESET
typedef EVT_UCX_ENDPOINT_PURGE *	PFN_UCX_ENDPOINT_PURGE
typedef EVT_UCX_ENDPOINT_START *	PFN_UCX_ENDPOINT_START
typedef EVT_UCX_ENDPOINT_ABORT *	PFN_UCX_ENDPOINT_ABORT
typedef EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS *	PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS
typedef EVT_UCX_DEFAULT_ENDPOINT_UPDATE *	PFN_UCX_DEFAULT_ENDPOINT_UPDATE
typedef _In_ ULONG	NumberOfStreams
typedef _In_ ULONG _In_ PUCXSSTREAMS_INIT	UcxStaticStreamsInit
typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD *	PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD
typedef _In_ UCXSSTREAMS	UcxStaticStreams
typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE *	PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE
typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE *	PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE
typedef _Inout_ PUCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS	UcxEndpointTransferPathDelays
typedef EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS *	PFN_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS
typedef _In_ PUCX_ENDPOINT_CHARACTERISTIC	UcxEndpointCharacteristic
typedef EVT_UCX_ENDPOINT_SET_CHARACTERISTIC *	PFN_UCX_ENDPOINT_SET_CHARACTERISTIC
typedef struct _UCX_ENDPOINT_EVENT_CALLBACKS	UCX_ENDPOINT_EVENT_CALLBACKS
typedef struct _UCX_ENDPOINT_EVENT_CALLBACKS *	PUCX_ENDPOINT_EVENT_CALLBACKS
typedef struct _UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS	UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS
typedef struct _UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS *	PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS
typedef PFN_UCX_ENDPOINT_RESET	PEVT_UCX_ENDPOINT_RESET
typedef PFN_UCX_ENDPOINT_PURGE	PEVT_UCX_ENDPOINT_PURGE
typedef PFN_UCX_ENDPOINT_START	PEVT_UCX_ENDPOINT_START
typedef PFN_UCX_ENDPOINT_ABORT	PEVT_UCX_ENDPOINT_ABORT
typedef PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS	PEVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS
typedef PFN_UCX_DEFAULT_ENDPOINT_UPDATE	PEVT_UCX_DEFAULT_ENDPOINT_UPDATE
typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD	PEVT_UCX_ENDPOINT_STATIC_STREAMS_ADD
typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE	PEVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE
typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE	PEVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE
typedef _Must_inspect_result_	_IRQL_requires_(PASSIVE_LEVEL) NTSTATUS(NTAPI *PFN_UCXENDPOINTCREATE) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ UCXUSBDEVICE	UsbDevice = NULL
typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _Inout_ PUCXENDPOINT_INIT *	EndpointInit
typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes
typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXENDPOINT *	Endpoint
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL) UCXSSTREAMS(NTAPI *PFN_UCXENDPOINTGETSTATICSTREAMSREFERENCED) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ UCXENDPOINT _In_ PVOID	Tag
typedef VOID(NTAPI *	PFN_UCXENDPOINTINITSETEVENTCALLBACKS) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_ENDPOINT_EVENT_CALLBACKS EventCallbacks)
typedef VOID(NTAPI *	PFN_UCXDEFAULTENDPOINTINITSETEVENTCALLBACKS) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS EventCallbacks)
typedef VOID(NTAPI *	PFN_UCXENDPOINTSETWDFIOQUEUE) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _In_ WDFQUEUE WdfQueue)

Enumerations
enum	_ENDPOINT_RESET_FLAGS { FlagEndpointResetPreserveTransferState = 0x1 }
enum	_UCX_ENDPOINT_CHARACTERISTIC_TYPE { UCX_ENDPOINT_CHARACTERISTIC_TYPE_PRIORITY = 1 }
enum	_UCX_ENDPOINT_CHARACTERISTIC_PRIORITY { UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_NONE = 0 , UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VIDEO = 1 , UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VOICE = 2 , UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_INTERACTIVE = 3 }

Functions
typedef	_Function_class_ (EVT_UCX_ENDPOINT_RESET) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_RESET(_In_ UCXCONTROLLER UcxController
typedef	_Function_class_ (EVT_UCX_ENDPOINT_PURGE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_PURGE(_In_ UCXCONTROLLER UcxController
typedef	_Function_class_ (EVT_UCX_ENDPOINT_START) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_START(_In_ UCXCONTROLLER UcxController
typedef	_Function_class_ (EVT_UCX_ENDPOINT_ABORT) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_ABORT(_In_ UCXCONTROLLER UcxController
typedef	_Function_class_ (EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS(_In_ UCXENDPOINT UcxEndpoint)
typedef	_Function_class_ (EVT_UCX_DEFAULT_ENDPOINT_UPDATE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_DEFAULT_ENDPOINT_UPDATE(_In_ UCXCONTROLLER UcxController
typedef	_Function_class_ (EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD) _IRQL_requires_same_ _IRQL_requires_(PASSIVE_LEVEL) _Must_inspect_result_ NTSTATUS NTAPI EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD(_In_ UCXENDPOINT UcxEndpoint
typedef	_Function_class_ (EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE(_In_ UCXENDPOINT UcxEndpoint
typedef	_Function_class_ (EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE(_In_ UCXENDPOINT UcxEndpoint
typedef	_Function_class_ (EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) _Must_inspect_result_ NTSTATUS NTAPI EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS(_In_ UCXENDPOINT UcxEndpoint
typedef	_Function_class_ (EVT_UCX_ENDPOINT_SET_CHARACTERISTIC) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID NTAPI EVT_UCX_ENDPOINT_SET_CHARACTERISTIC(_In_ UCXENDPOINT UcxEndpoint
FORCEINLINE VOID NTAPI	UCX_ENDPOINT_EVENT_CALLBACKS_INIT (_Out_ PUCX_ENDPOINT_EVENT_CALLBACKS Callbacks, _In_ PFN_UCX_ENDPOINT_PURGE EvtEndpointPurge, _In_ PFN_UCX_ENDPOINT_START EvtEndpointStart, _In_ PFN_UCX_ENDPOINT_ABORT EvtEndpointAbort, _In_ PFN_UCX_ENDPOINT_RESET EvtEndpointReset, _In_ PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS EvtEndpointOkToCancelTransfers, _In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD EvtEndpointStaticStreamsAdd, _In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE EvtEndpointStaticStreamsEnable, _In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE EvtEndpointStaticStreamsDisable)
FORCEINLINE VOID NTAPI	UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS_INIT (_Out_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS Callbacks, _In_ PFN_UCX_ENDPOINT_PURGE EvtEndpointPurge, _In_ PFN_UCX_ENDPOINT_START EvtEndpointStart, _In_ PFN_UCX_ENDPOINT_ABORT EvtEndpointAbort, _In_ PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS EvtEndpointOkToCancelTransfers, _In_ PFN_UCX_DEFAULT_ENDPOINT_UPDATE EvtDefaultEndpointUpdate)
return	Create (UcxDriverGlobals, UsbDevice, EndpointInit, Attributes, Endpoint)
return	GetStreams (UcxDriverGlobals, Endpoint, Tag)
FORCEINLINE VOID NTAPI	UcxEndpointInitSetEventCallbacks (_Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_ENDPOINT_EVENT_CALLBACKS EventCallbacks)
FORCEINLINE VOID NTAPI	UcxDefaultEndpointInitSetEventCallbacks (_Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS EventCallbacks)
FORCEINLINE VOID NTAPI	UcxEndpointSetWdfIoQueue (_In_ UCXENDPOINT Endpoint, _In_ WDFQUEUE WdfQueue)

Variables
	Create = UCX_BOUND_FUNCTION(PFN_UCXENDPOINTCREATE, UcxEndpointCreateTableIndex)
	GetStreams

Typedef Documentation

_IRQL_requires_

typedef _Must_inspect_result_ _IRQL_requires_(PASSIVE_LEVEL) NTSTATUS(NTAPI *PFN_UCXENDPOINTCREATE)(_In_ PUCX_DRIVER_GLOBALS DriverGlobals

Definition at line 309 of file ucxendpoint.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(DISPATCH_LEVEL) UCXSSTREAMS(NTAPI *PFN_UCXENDPOINTGETSTATICSTREAMSREFERENCED)(_In_ PUCX_DRIVER_GLOBALS DriverGlobals

Returns the streams object with a reference held under Tag, or NULL.

Definition at line 320 of file ucxendpoint.h.

Attributes

_Must_inspect_result_ _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 315 of file ucxendpoint.h.

DEFAULT_ENDPOINT_UPDATE

typedef struct _DEFAULT_ENDPOINT_UPDATE DEFAULT_ENDPOINT_UPDATE

Endpoint

_Must_inspect_result_ _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXENDPOINT* Endpoint

Initial value:

{
    PFN_UCXENDPOINTCREATE Create

Definition at line 316 of file ucxendpoint.h.

ENDPOINT_RESET

typedef struct _ENDPOINT_RESET ENDPOINT_RESET

ENDPOINT_RESET_FLAGS

typedef WDF_EXTERN_C_START enum _ENDPOINT_RESET_FLAGS ENDPOINT_RESET_FLAGS

EndpointInit

_Must_inspect_result_ _Inout_ PUCXENDPOINT_INIT * EndpointInit

Definition at line 314 of file ucxendpoint.h.

ENDPOINTS_CONFIGURE

typedef struct _ENDPOINTS_CONFIGURE ENDPOINTS_CONFIGURE

ENDPOINTS_CONFIGURE_FAILURE_FLAGS

typedef struct _ENDPOINTS_CONFIGURE_FAILURE_FLAGS ENDPOINTS_CONFIGURE_FAILURE_FLAGS

NumberOfStreams

typedef _In_ ULONG NumberOfStreams

Definition at line 165 of file ucxendpoint.h.

PDEFAULT_ENDPOINT_UPDATE

typedef struct _DEFAULT_ENDPOINT_UPDATE * PDEFAULT_ENDPOINT_UPDATE

PENDPOINT_RESET

typedef struct _ENDPOINT_RESET * PENDPOINT_RESET

PENDPOINTS_CONFIGURE

typedef struct _ENDPOINTS_CONFIGURE * PENDPOINTS_CONFIGURE

PEVT_UCX_DEFAULT_ENDPOINT_UPDATE

typedef PFN_UCX_DEFAULT_ENDPOINT_UPDATE PEVT_UCX_DEFAULT_ENDPOINT_UPDATE

Definition at line 300 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_ABORT

typedef PFN_UCX_ENDPOINT_ABORT PEVT_UCX_ENDPOINT_ABORT

Definition at line 298 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS

typedef PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS PEVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS

Definition at line 299 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_PURGE

typedef PFN_UCX_ENDPOINT_PURGE PEVT_UCX_ENDPOINT_PURGE

Definition at line 296 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_RESET

typedef PFN_UCX_ENDPOINT_RESET PEVT_UCX_ENDPOINT_RESET

Definition at line 295 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_START

typedef PFN_UCX_ENDPOINT_START PEVT_UCX_ENDPOINT_START

Definition at line 297 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_STATIC_STREAMS_ADD

typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD PEVT_UCX_ENDPOINT_STATIC_STREAMS_ADD

Definition at line 301 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE

typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE PEVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE

Definition at line 303 of file ucxendpoint.h.

PEVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE

typedef PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE PEVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE

Definition at line 302 of file ucxendpoint.h.

PFN_UCX_DEFAULT_ENDPOINT_UPDATE

typedef EVT_UCX_DEFAULT_ENDPOINT_UPDATE* PFN_UCX_DEFAULT_ENDPOINT_UPDATE

Definition at line 152 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_ABORT

typedef EVT_UCX_ENDPOINT_ABORT* PFN_UCX_ENDPOINT_ABORT

Definition at line 131 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS

typedef EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS* PFN_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS

Definition at line 205 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS

typedef EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS* PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS

Definition at line 141 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_PURGE

typedef EVT_UCX_ENDPOINT_PURGE* PFN_UCX_ENDPOINT_PURGE

Definition at line 109 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_RESET

typedef EVT_UCX_ENDPOINT_RESET* PFN_UCX_ENDPOINT_RESET

Definition at line 98 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_SET_CHARACTERISTIC

typedef EVT_UCX_ENDPOINT_SET_CHARACTERISTIC* PFN_UCX_ENDPOINT_SET_CHARACTERISTIC

Definition at line 216 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_START

typedef EVT_UCX_ENDPOINT_START* PFN_UCX_ENDPOINT_START

Definition at line 120 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD

typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD* PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD

Definition at line 167 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE

typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE* PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE

Definition at line 191 of file ucxendpoint.h.

PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE

typedef EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE* PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE

Definition at line 179 of file ucxendpoint.h.

PFN_UCXDEFAULTENDPOINTINITSETEVENTCALLBACKS

typedef VOID(NTAPI * PFN_UCXDEFAULTENDPOINTINITSETEVENTCALLBACKS) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS EventCallbacks)

Definition at line 342 of file ucxendpoint.h.

PFN_UCXENDPOINTINITSETEVENTCALLBACKS

typedef VOID(NTAPI * PFN_UCXENDPOINTINITSETEVENTCALLBACKS) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _Inout_ PUCXENDPOINT_INIT EndpointInit, _In_ PUCX_ENDPOINT_EVENT_CALLBACKS EventCallbacks)

Definition at line 335 of file ucxendpoint.h.

PFN_UCXENDPOINTSETWDFIOQUEUE

typedef VOID(NTAPI * PFN_UCXENDPOINTSETWDFIOQUEUE) (_In_ PUCX_DRIVER_GLOBALS DriverGlobals, _In_ UCXENDPOINT Endpoint, _In_ WDFQUEUE WdfQueue)

Definition at line 349 of file ucxendpoint.h.

PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS

typedef struct _UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS * PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS

PUCX_ENDPOINT_CHARACTERISTIC

typedef struct _UCX_ENDPOINT_CHARACTERISTIC * PUCX_ENDPOINT_CHARACTERISTIC

PUCX_ENDPOINT_EVENT_CALLBACKS

typedef struct _UCX_ENDPOINT_EVENT_CALLBACKS * PUCX_ENDPOINT_EVENT_CALLBACKS

PUCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS

typedef struct _UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS * PUCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS

Request

typedef _In_ UCXSSTREAMS _In_ WDFREQUEST Request

Definition at line 97 of file ucxendpoint.h.

Tag

_In_ WDFDEVICE _In_opt_ PVOID Tag

Initial value:

{
    PFN_UCXENDPOINTGETSTATICSTREAMSREFERENCED GetStreams

Definition at line 325 of file ucxendpoint.h.

UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY

typedef enum _UCX_ENDPOINT_CHARACTERISTIC_PRIORITY UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY

UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS

typedef struct _UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS

UCX_ENDPOINT_CHARACTERISTIC

typedef struct _UCX_ENDPOINT_CHARACTERISTIC UCX_ENDPOINT_CHARACTERISTIC

UCX_ENDPOINT_CHARACTERISTIC_TYPE

typedef enum _UCX_ENDPOINT_CHARACTERISTIC_TYPE UCX_ENDPOINT_CHARACTERISTIC_TYPE

UCX_ENDPOINT_EVENT_CALLBACKS

typedef struct _UCX_ENDPOINT_EVENT_CALLBACKS UCX_ENDPOINT_EVENT_CALLBACKS

UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS

typedef struct _UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS UCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS

UcxEndpoint

typedef _In_ UCXENDPOINT UcxEndpoint

Definition at line 96 of file ucxendpoint.h.

UcxEndpointCharacteristic

typedef _In_ PUCX_ENDPOINT_CHARACTERISTIC UcxEndpointCharacteristic

Definition at line 215 of file ucxendpoint.h.

UcxEndpointTransferPathDelays

typedef _Inout_ PUCX_ENDPOINT_ISOCH_TRANSFER_PATH_DELAYS UcxEndpointTransferPathDelays

Definition at line 204 of file ucxendpoint.h.

UcxStaticStreams

typedef _In_ UCXSSTREAMS UcxStaticStreams

Definition at line 177 of file ucxendpoint.h.

UcxStaticStreamsInit

typedef _In_ ULONG _In_ PUCXSSTREAMS_INIT UcxStaticStreamsInit

Definition at line 166 of file ucxendpoint.h.

UsbDevice

_In_ WDFUSBDEVICE UsbDevice = NULL

Definition at line 313 of file ucxendpoint.h.

Enumeration Type Documentation

_ENDPOINT_RESET_FLAGS

enum _ENDPOINT_RESET_FLAGS

Enumerator
FlagEndpointResetPreserveTransferState

Definition at line 14 of file ucxendpoint.h.

{
    FlagEndpointResetPreserveTransferState = 0x1
} ENDPOINT_RESET_FLAGS;

_UCX_ENDPOINT_CHARACTERISTIC_PRIORITY

enum _UCX_ENDPOINT_CHARACTERISTIC_PRIORITY

Enumerator
UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_NONE
UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VIDEO
UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VOICE
UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_INTERACTIVE

Definition at line 70 of file ucxendpoint.h.

{
    UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_NONE = 0,
    UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VIDEO = 1,
    UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_VOICE = 2,
    UCX_ENDPOINT_CHARACTERISTIC_PRIORITY_BULK_INTERACTIVE = 3
} UCX_CONTROLLER_ENDPOINT_CHARACTERISTIC_PRIORITY;

_UCX_ENDPOINT_CHARACTERISTIC_TYPE

enum _UCX_ENDPOINT_CHARACTERISTIC_TYPE

Enumerator
UCX_ENDPOINT_CHARACTERISTIC_TYPE_PRIORITY

Definition at line 65 of file ucxendpoint.h.

{
    UCX_ENDPOINT_CHARACTERISTIC_TYPE_PRIORITY = 1
} UCX_ENDPOINT_CHARACTERISTIC_TYPE;

Function Documentation

_Function_class_() [1/11]

typedef _Function_class_

(

EVT_UCX_DEFAULT_ENDPOINT_UPDATE

)

_Function_class_() [2/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_ABORT

)

_Function_class_() [3/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_GET_ISOCH_TRANSFER_PATH_DELAYS

)

_Function_class_() [4/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS

)

_Function_class_() [5/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_PURGE

)

_Function_class_() [6/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_RESET

)

_Function_class_() [7/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_SET_CHARACTERISTIC

)

_Function_class_() [8/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_START

)

_Function_class_() [9/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_STATIC_STREAMS_ADD

)

_Function_class_() [10/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_STATIC_STREAMS_DISABLE

)

_Function_class_() [11/11]

typedef _Function_class_

(

EVT_UCX_ENDPOINT_STATIC_STREAMS_ENABLE

)

Create()

return Create	(	UcxDriverGlobals	,
		UsbDevice	,
		EndpointInit	,
		Attributes	,
		Endpoint
	)

GetStreams()

return GetStreams	(	UcxDriverGlobals	,
		Endpoint	,
		Tag
	)

UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS_INIT()

FORCEINLINE VOID NTAPI UCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS_INIT	(	_Out_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS	Callbacks,
		_In_ PFN_UCX_ENDPOINT_PURGE	EvtEndpointPurge,
		_In_ PFN_UCX_ENDPOINT_START	EvtEndpointStart,
		_In_ PFN_UCX_ENDPOINT_ABORT	EvtEndpointAbort,
		_In_ PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS	EvtEndpointOkToCancelTransfers,
		_In_ PFN_UCX_DEFAULT_ENDPOINT_UPDATE	EvtDefaultEndpointUpdate
	)

Definition at line 276 of file ucxendpoint.h.

{
    RtlZeroMemory(Callbacks, sizeof(*Callbacks));
    Callbacks->Size = sizeof(*Callbacks);
 
    Callbacks->EvtEndpointStart = EvtEndpointStart;
    Callbacks->EvtEndpointPurge = EvtEndpointPurge;
    Callbacks->EvtEndpointAbort = EvtEndpointAbort;
    Callbacks->EvtEndpointOkToCancelTransfers = EvtEndpointOkToCancelTransfers;
    Callbacks->EvtDefaultEndpointUpdate = EvtDefaultEndpointUpdate;
}

UCX_ENDPOINT_EVENT_CALLBACKS_INIT()

FORCEINLINE VOID NTAPI UCX_ENDPOINT_EVENT_CALLBACKS_INIT	(	_Out_ PUCX_ENDPOINT_EVENT_CALLBACKS	Callbacks,
		_In_ PFN_UCX_ENDPOINT_PURGE	EvtEndpointPurge,
		_In_ PFN_UCX_ENDPOINT_START	EvtEndpointStart,
		_In_ PFN_UCX_ENDPOINT_ABORT	EvtEndpointAbort,
		_In_ PFN_UCX_ENDPOINT_RESET	EvtEndpointReset,
		_In_ PFN_UCX_ENDPOINT_OK_TO_CANCEL_TRANSFERS	EvtEndpointOkToCancelTransfers,
		_In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_ADD	EvtEndpointStaticStreamsAdd,
		_In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_ENABLE	EvtEndpointStaticStreamsEnable,
		_In_ PFN_UCX_ENDPOINT_STATIC_STREAMS_DISABLE	EvtEndpointStaticStreamsDisable
	)

Definition at line 237 of file ucxendpoint.h.

{
    RtlZeroMemory(Callbacks, sizeof(*Callbacks));
    Callbacks->Size = sizeof(*Callbacks);
 
    Callbacks->EvtEndpointStart = EvtEndpointStart;
    Callbacks->EvtEndpointPurge = EvtEndpointPurge;
    Callbacks->EvtEndpointAbort = EvtEndpointAbort;
    Callbacks->EvtEndpointReset = EvtEndpointReset;
    Callbacks->EvtEndpointOkToCancelTransfers = EvtEndpointOkToCancelTransfers;
 
    Callbacks->EvtEndpointStaticStreamsAdd = EvtEndpointStaticStreamsAdd;
    Callbacks->EvtEndpointStaticStreamsEnable = EvtEndpointStaticStreamsEnable;
    Callbacks->EvtEndpointStaticStreamsDisable = EvtEndpointStaticStreamsDisable;
}

UcxDefaultEndpointInitSetEventCallbacks()

FORCEINLINE VOID NTAPI UcxDefaultEndpointInitSetEventCallbacks	(	_Inout_ PUCXENDPOINT_INIT	EndpointInit,
		_In_ PUCX_DEFAULT_ENDPOINT_EVENT_CALLBACKS	EventCallbacks
	)

Definition at line 441 of file ucxendpoint.h.

{
    PFN_UCXDEFAULTENDPOINTINITSETEVENTCALLBACKS SetCallbacks;
 
    SetCallbacks = UCX_BOUND_FUNCTION(PFN_UCXDEFAULTENDPOINTINITSETEVENTCALLBACKS,
                                      UcxDefaultEndpointInitSetEventCallbacksTableIndex);
    SetCallbacks(UcxDriverGlobals, EndpointInit, EventCallbacks);
}

UcxEndpointInitSetEventCallbacks()

FORCEINLINE VOID NTAPI UcxEndpointInitSetEventCallbacks	(	_Inout_ PUCXENDPOINT_INIT	EndpointInit,
		_In_ PUCX_ENDPOINT_EVENT_CALLBACKS	EventCallbacks
	)

Definition at line 427 of file ucxendpoint.h.

{
    PFN_UCXENDPOINTINITSETEVENTCALLBACKS SetCallbacks;
 
    SetCallbacks = UCX_BOUND_FUNCTION(PFN_UCXENDPOINTINITSETEVENTCALLBACKS,
                                      UcxEndpointInitSetEventCallbacksTableIndex);
    SetCallbacks(UcxDriverGlobals, EndpointInit, EventCallbacks);
}

UcxEndpointSetWdfIoQueue()

FORCEINLINE VOID NTAPI UcxEndpointSetWdfIoQueue	(	_In_ UCXENDPOINT	Endpoint,
		_In_ WDFQUEUE	WdfQueue
	)

Definition at line 455 of file ucxendpoint.h.

{
    PFN_UCXENDPOINTSETWDFIOQUEUE SetQueue;
 
    SetQueue = UCX_BOUND_FUNCTION(PFN_UCXENDPOINTSETWDFIOQUEUE, UcxEndpointSetWdfIoQueueTableIndex);
    SetQueue(UcxDriverGlobals, Endpoint, WdfQueue);
}

Variable Documentation

Create

Create = UCX_BOUND_FUNCTION(PFN_UCXENDPOINTCREATE, UcxEndpointCreateTableIndex)

Definition at line 389 of file ucxendpoint.h.

GetStreams

GetStreams

Initial value:

= UCX_BOUND_FUNCTION(PFN_UCXENDPOINTGETSTATICSTREAMSREFERENCED,
                                    UcxEndpointGetStaticStreamsReferencedTableIndex)

Definition at line 405 of file ucxendpoint.h.