#include <usbiodef.h>

Include dependency graph for hubucx.h:

Classes
union	_UCXHUB_RESET_FLAGS

struct	_UCXHUB_DEVICE_CREATE_INFO

struct	_UCXHUB_ROOTHUB_INFO

struct	_UCXHUB_CONTROLLER_INFO

struct	_UCXHUB_CONTROLLER_INFO_V2

struct	_UCXHUB_STOP_IDLE_CONTEXT

struct	_UCXHUB_QUERY_CAPABILITY

struct	_UCXHUB_FUNCTION_DATA

struct	_UCXHUB_DUMP_DEVICE_INFO

struct	_UCXHUB_FORWARD_PROGRESS_PIPE

struct	_UCXHUB_FORWARD_PROGRESS_INFO

struct	_UCXHUB_STACK_INTERFACE

struct	_UCXHUB_PARENT_INTERFACE

struct	_UCXHUB_PARENT_INTERFACE_ORIGINAL

struct	_UCXHUB_UPDATE_TUNNEL_ANSWER

Macros
#define	UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE 0x401

#define	UCXHUB_FN_ROOTHUB_GET_INFO 0x402

#define	UCXHUB_FN_ROOTHUB_GET_20PORT_INFO 0x403

#define	UCXHUB_FN_ROOTHUB_GET_30PORT_INFO 0x404

#define	UCXHUB_FN_DEVICE_ENABLE 0x405

#define	UCXHUB_FN_DEVICE_RESET 0x406

#define	UCXHUB_FN_DEVICE_ADDRESS 0x407

#define	UCXHUB_FN_DEVICE_UPDATE 0x408

#define	UCXHUB_FN_DEVICE_HUB_INFO 0x409

#define	UCXHUB_FN_DEVICE_DISABLE 0x40A

#define	UCXHUB_FN_DEVICE_PURGE_IO 0x40B

#define	UCXHUB_FN_DEVICE_START_IO 0x40C

#define	UCXHUB_FN_ENDPOINTS_CONFIGURE 0x40D

#define	UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE 0x40E

#define	UCXHUB_FN_ENDPOINT_RESET 0x40F

#define	UCXHUB_FN_GET_HUB_INFO 0x410

#define	UCXHUB_FN_QUERY_USB_CAPABILITY 0x412

#define	UCXHUB_FN_SET_FUNCTION_HANDLE_DATA 0x413

#define	UCXHUB_FN_DEVICE_TREE_PURGE_IO 0x414

#define	UCXHUB_FN_DEVICE_ABORT_IO 0x415

#define	UCXHUB_FN_GET_DUMP_DATA 0x501

#define	UCXHUB_FN_FREE_DUMP_DATA 0x502

#define	UCXHUB_FN_NOTIFY_FORWARD_PROGRESS 0x503

#define	UCXHUB_IOCTL(Function) CTL_CODE(FILE_DEVICE_USBEX, (Function), METHOD_NEITHER, FILE_ANY_ACCESS)

#define	IOCTL_UCXHUB_ADDRESS0_OWNERSHIP_ACQUIRE UCXHUB_IOCTL(UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE)

#define	IOCTL_UCXHUB_ROOTHUB_GET_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_INFO)

#define	IOCTL_UCXHUB_ROOTHUB_GET_20PORT_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_20PORT_INFO)

#define	IOCTL_UCXHUB_ROOTHUB_GET_30PORT_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_30PORT_INFO)

#define	IOCTL_UCXHUB_DEVICE_ENABLE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ENABLE)

#define	IOCTL_UCXHUB_DEVICE_RESET UCXHUB_IOCTL(UCXHUB_FN_DEVICE_RESET)

#define	IOCTL_UCXHUB_DEVICE_ADDRESS UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ADDRESS)

#define	IOCTL_UCXHUB_DEVICE_UPDATE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_UPDATE)

#define	IOCTL_UCXHUB_DEVICE_HUB_INFO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_HUB_INFO)

#define	IOCTL_UCXHUB_DEVICE_DISABLE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_DISABLE)

#define	IOCTL_UCXHUB_DEVICE_PURGE_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_PURGE_IO)

#define	IOCTL_UCXHUB_DEVICE_START_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_START_IO)

#define	IOCTL_UCXHUB_ENDPOINTS_CONFIGURE UCXHUB_IOCTL(UCXHUB_FN_ENDPOINTS_CONFIGURE)

#define	IOCTL_UCXHUB_DEFAULT_ENDPOINT_UPDATE UCXHUB_IOCTL(UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE)

#define	IOCTL_UCXHUB_ENDPOINT_RESET UCXHUB_IOCTL(UCXHUB_FN_ENDPOINT_RESET)

#define	IOCTL_UCXHUB_GET_HUB_INFO UCXHUB_IOCTL(UCXHUB_FN_GET_HUB_INFO)

#define	IOCTL_UCXHUB_QUERY_USB_CAPABILITY UCXHUB_IOCTL(UCXHUB_FN_QUERY_USB_CAPABILITY)

#define	IOCTL_UCXHUB_SET_FUNCTION_HANDLE_DATA UCXHUB_IOCTL(UCXHUB_FN_SET_FUNCTION_HANDLE_DATA)

#define	IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_TREE_PURGE_IO)

#define	IOCTL_UCXHUB_DEVICE_ABORT_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ABORT_IO)

#define	IOCTL_UCXHUB_NOTIFY_FORWARD_PROGRESS UCXHUB_IOCTL(UCXHUB_FN_NOTIFY_FORWARD_PROGRESS)

#define	IOCTL_UCXHUB_GET_DUMP_DATA CTL_CODE(FILE_DEVICE_USBEX, UCXHUB_FN_GET_DUMP_DATA, METHOD_BUFFERED, FILE_ANY_ACCESS)

#define	IOCTL_UCXHUB_FREE_DUMP_DATA CTL_CODE(FILE_DEVICE_USBEX, UCXHUB_FN_FREE_DUMP_DATA, METHOD_BUFFERED, FILE_ANY_ACCESS)

#define	IOCTL_UCXHUB_RESET_PORT_ASYNC CTL_CODE(FILE_DEVICE_UNKNOWN, 1004, METHOD_NEITHER, FILE_ANY_ACCESS)

#define	UCXHUB_URB_FLAGS_UCX_MASK 0x00FFFFFF

#define	UCXHUB_URB_FLAGS_HUB_MASK 0xFF000000

#define	UCXHUB_URB_FLAG_PEND_INTERRUPT_TX 0x80000000

#define	UCXHUB_URB_FLAG_ALLOW_LARGE_TRANSFER 0x40000000

#define	UCXHUB_QUERY_CAPABILITY_VERSION 1

#define	UCXHUB_WORKITEM_NO_FLAGS 0

#define	UCXHUB_WORKITEM_FLAG_NEEDS_FLUSH 1

#define	UCXHUB_STACK_INTERFACE_VERSION_1 1000

#define	UCXHUB_STACK_INTERFACE_VERSION_2 2000

#define	UCXHUB_STACK_INTERFACE_VERSION_3 3000

#define	UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL FIELD_OFFSET(UCXHUB_STACK_INTERFACE, DeviceGetTimestamp)

#define	UCXHUB_PARENT_INTERFACE_VERSION 1013

#define	UCXHUB_TUNNEL_STATE_NOT_ANSWERED 0

#define	UCXHUB_TUNNEL_STATE_NO_INFORMATION 1

#define	UCXHUB_TUNNEL_STATE_TUNNELED 2

#define	UCXHUB_TUNNEL_STATE_NATIVE 3

#define	UCXHUB_TUNNEL_STATE_UNKNOWN 4

Typedefs
typedef union _UCXHUB_RESET_FLAGS	UCXHUB_RESET_FLAGS

typedef union _UCXHUB_RESET_FLAGS *	PUCXHUB_RESET_FLAGS

typedef struct _UCXHUB_DEVICE_CREATE_INFO	UCXHUB_DEVICE_CREATE_INFO

typedef struct _UCXHUB_DEVICE_CREATE_INFO *	PUCXHUB_DEVICE_CREATE_INFO

typedef struct _UCXHUB_ROOTHUB_INFO	UCXHUB_ROOTHUB_INFO

typedef struct _UCXHUB_ROOTHUB_INFO *	PUCXHUB_ROOTHUB_INFO

typedef struct _UCXHUB_CONTROLLER_INFO	UCXHUB_CONTROLLER_INFO

typedef struct _UCXHUB_CONTROLLER_INFO *	PUCXHUB_CONTROLLER_INFO

typedef struct _UCXHUB_CONTROLLER_INFO_V2	UCXHUB_CONTROLLER_INFO_V2

typedef struct _UCXHUB_CONTROLLER_INFO_V2 *	PUCXHUB_CONTROLLER_INFO_V2

typedef struct _UCXHUB_STOP_IDLE_CONTEXT	UCXHUB_STOP_IDLE_CONTEXT

typedef struct _UCXHUB_STOP_IDLE_CONTEXT *	PUCXHUB_STOP_IDLE_CONTEXT

typedef struct _UCXHUB_QUERY_CAPABILITY	UCXHUB_QUERY_CAPABILITY

typedef struct _UCXHUB_QUERY_CAPABILITY *	PUCXHUB_QUERY_CAPABILITY

typedef struct _UCXHUB_FUNCTION_DATA	UCXHUB_FUNCTION_DATA

typedef struct _UCXHUB_FUNCTION_DATA *	PUCXHUB_FUNCTION_DATA

typedef struct _UCXHUB_DUMP_DEVICE_INFO	UCXHUB_DUMP_DEVICE_INFO

typedef struct _UCXHUB_DUMP_DEVICE_INFO *	PUCXHUB_DUMP_DEVICE_INFO

typedef struct _UCXHUB_FORWARD_PROGRESS_PIPE	UCXHUB_FORWARD_PROGRESS_PIPE

typedef struct _UCXHUB_FORWARD_PROGRESS_PIPE *	PUCXHUB_FORWARD_PROGRESS_PIPE

typedef struct _UCXHUB_FORWARD_PROGRESS_INFO	UCXHUB_FORWARD_PROGRESS_INFO

typedef struct _UCXHUB_FORWARD_PROGRESS_INFO *	PUCXHUB_FORWARD_PROGRESS_INFO

typedef struct _UCXHUB_WORKITEM *	PUCXHUB_WORKITEM

typedef enum _UCXHUB_WORKITEM_ENQUEUE_OPTIONS	UCXHUB_WORKITEM_ENQUEUE_OPTIONS

typedef _In_opt_ PVOID	Context

typedef _In_opt_ PVOID _In_ PUCXHUB_WORKITEM	WorkItem

typedef UCXHUB_WORKITEM_ROUTINE *	PUCXHUB_WORKITEM_ROUTINE

typedef _In_ UCXHUB_DEVICE_CONTEXT	DeviceContext

typedef _In_ UCXHUB_DEVICE_CONTEXT _In_ UCXENDPOINT	Endpoint = NULL

typedef _In_ UCXHUB_DEVICE_CONTEXT _In_ UCXENDPOINT _In_ ULONG	EndpointNumber

typedef _In_ UCXHUB_DEVICE_CONTEXT _In_ UCXENDPOINT _In_ ULONG _In_ ULONG	TtPortNumber

typedef _Must_inspect_result_	_IRQL_requires_(PASSIVE_LEVEL) NTSTATUS(NTAPI *PFN_UCXHUB_DEVICE_CREATE) (_In_ UCXUSBDEVICE Hub ==NDIS_MEMORY_NONCACHED

typedef _Must_inspect_result_ _In_ PUCXHUB_DEVICE_CREATE_INFO	CreateInfo

typedef _Must_inspect_result_ _In_ PUCXHUB_DEVICE_CREATE_INFO _Out_ UCXUSBDEVICE *	Device

typedef _In_ ULONG	PortNumber

typedef _In_ UCXUSBDEVICE _In_ PDEVICE_OBJECT	Pdo

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_ ULONG	MaxPacketSize

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE	_In_reads_bytes_(DescriptorBufferLength) PUSB_ENDPOINT_DESCRIPTOR Descriptor

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_ ULONG	DescriptorBufferLength = 0

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_ ULONG _In_opt_ PUSB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR	Companion

typedef USBD_PIPE_HANDLE(NTAPI *	PFN_UCXHUB_ENDPOINT_PIPE_HANDLE) (_In_ UCXENDPOINT Endpoint)

typedef ULONG(NTAPI *	PFN_UCXHUB_ENDPOINT_MAX_TRANSFER) (_In_ UCXENDPOINT Endpoint)

typedef PUCXHUB_WORKITEM(NTAPI *	PFN_UCXHUB_WORKITEM_ALLOCATE) (_In_ UCXUSBDEVICE Hub, _In_ PDEVICE_OBJECT DeviceObject, _In_ ULONG Flags)

typedef VOID(NTAPI *	PFN_UCXHUB_WORKITEM_DELETE) (_In_ PUCXHUB_WORKITEM WorkItem)

typedef VOID(NTAPI *	PFN_UCXHUB_WORKITEM_ENQUEUE) (_In_ PUCXHUB_WORKITEM WorkItem, _In_ PUCXHUB_WORKITEM_ROUTINE Routine, _In_opt_ PVOID Context, _In_ UCXHUB_WORKITEM_ENQUEUE_OPTIONS Options)

typedef BOOLEAN(NTAPI *	PFN_UCXHUB_IS_DEVICE_DISCONNECTED) (_In_ UCXUSBDEVICE Device)

typedef _Inout_ PUCXHUB_STOP_IDLE_CONTEXT	StopIdleContext

typedef _Out_ PUCXHUB_CONTROLLER_INFO	ControllerInfo

typedef ULONG64(NTAPI *	PFN_UCXHUB_DEVICE_GET_TIMESTAMP) (_In_ UCXUSBDEVICE Device)

typedef _In_ UCXUSBDEVICE _In_ UCXENDPOINT _In_ ULONG	Priority

typedef struct _UCXHUB_STACK_INTERFACE	UCXHUB_STACK_INTERFACE

typedef struct _UCXHUB_STACK_INTERFACE *	PUCXHUB_STACK_INTERFACE

typedef _In_ PUNICODE_STRING	SymbolicLinkName

typedef struct _UCXHUB_PARENT_INTERFACE	UCXHUB_PARENT_INTERFACE

typedef struct _UCXHUB_PARENT_INTERFACE *	PUCXHUB_PARENT_INTERFACE

typedef struct _UCXHUB_PARENT_INTERFACE_ORIGINAL	UCXHUB_PARENT_INTERFACE_ORIGINAL

typedef struct _UCXHUB_PARENT_INTERFACE_ORIGINAL *	PUCXHUB_PARENT_INTERFACE_ORIGINAL

typedef struct _UCXHUB_UPDATE_TUNNEL_ANSWER	UCXHUB_UPDATE_TUNNEL_ANSWER

typedef struct _UCXHUB_UPDATE_TUNNEL_ANSWER *	PUCXHUB_UPDATE_TUNNEL_ANSWER

Enumerations
enum	_UCXHUB_WORKITEM_ENQUEUE_OPTIONS { UcxHubWorkItemDefault = 0xCAD00000 , UcxHubWorkItemForwardProgressNotRequired }

Functions
	DEFINE_GUID (GUID_UCXHUB_STACK_INTERFACE, 0x4fb2b0e1, 0x5fdd, 0x4dab, 0xa6, 0x00, 0x5e, 0x15, 0x16, 0xbb, 0xd8, 0xa7)

	DEFINE_GUID (GUID_UCXHUB_PARENT_INTERFACE, 0xa9264c93, 0xeccd, 0x4b40, 0x92, 0x9b, 0xb3, 0x54, 0xf1, 0xe9, 0xa2, 0xdc)

	DECLARE_HANDLE (UCXHUB_HUB_CONTEXT)

	DECLARE_HANDLE (UCXHUB_DEVICE_CONTEXT)

typedef	_Function_class_ (UCXHUB_WORKITEM_ROUTINE) VOID NTAPI UCXHUB_WORKITEM_ROUTINE(_In_ PDEVICE_OBJECT DeviceObject

typedef	_IRQL_requires_max_ (DISPATCH_LEVEL) VOID(NTAPI *PFN_UCXHUB_CLEAR_TT_BUFFER)(_In_ UCXHUB_HUB_CONTEXT HubContext

FORCEINLINE PUCXHUB_UPDATE_TUNNEL_ANSWER NTAPI	UcxHubUpdateTunnelAnswer (_In_ PUSBDEVICE_UPDATE Update)

	C_ASSERT (UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL==0x78)

	C_ASSERT (sizeof(UCXHUB_PARENT_INTERFACE_ORIGINAL)==0x58)

	C_ASSERT (sizeof(UCXHUB_QUERY_CAPABILITY)==32)

	C_ASSERT (sizeof(UCXHUB_ROOTHUB_INFO)==20)

	C_ASSERT (sizeof(UCXHUB_DEVICE_CREATE_INFO)==16)

	C_ASSERT (FIELD_OFFSET(USBDEVICE_UPDATE, Reserved)==0x2E)

	C_ASSERT (sizeof(USBDEVICE_UPDATE)==0x30)

	C_ASSERT (FIELD_OFFSET(UCXHUB_UPDATE_TUNNEL_ANSWER, TunnelState)==1)

	C_ASSERT (sizeof(UCXHUB_CONTROLLER_INFO)==28)

	C_ASSERT (sizeof(UCXHUB_CONTROLLER_INFO_V2)==32)

	C_ASSERT (FIELD_OFFSET(UCXHUB_CONTROLLER_INFO_V2, Pci)==8)

Macro Definition Documentation

◆ IOCTL_UCXHUB_ADDRESS0_OWNERSHIP_ACQUIRE

#define IOCTL_UCXHUB_ADDRESS0_OWNERSHIP_ACQUIRE UCXHUB_IOCTL(UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE)

Definition at line 49 of file hubucx.h.

◆ IOCTL_UCXHUB_DEFAULT_ENDPOINT_UPDATE

#define IOCTL_UCXHUB_DEFAULT_ENDPOINT_UPDATE UCXHUB_IOCTL(UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE)

Definition at line 62 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_ABORT_IO

#define IOCTL_UCXHUB_DEVICE_ABORT_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ABORT_IO)

Definition at line 68 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_ADDRESS

#define IOCTL_UCXHUB_DEVICE_ADDRESS UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ADDRESS)

Definition at line 55 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_DISABLE

#define IOCTL_UCXHUB_DEVICE_DISABLE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_DISABLE)

Definition at line 58 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_ENABLE

#define IOCTL_UCXHUB_DEVICE_ENABLE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_ENABLE)

Definition at line 53 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_HUB_INFO

#define IOCTL_UCXHUB_DEVICE_HUB_INFO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_HUB_INFO)

Definition at line 57 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_PURGE_IO

#define IOCTL_UCXHUB_DEVICE_PURGE_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_PURGE_IO)

Definition at line 59 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_RESET

#define IOCTL_UCXHUB_DEVICE_RESET UCXHUB_IOCTL(UCXHUB_FN_DEVICE_RESET)

Definition at line 54 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_START_IO

#define IOCTL_UCXHUB_DEVICE_START_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_START_IO)

Definition at line 60 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO

#define IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO UCXHUB_IOCTL(UCXHUB_FN_DEVICE_TREE_PURGE_IO)

Definition at line 67 of file hubucx.h.

◆ IOCTL_UCXHUB_DEVICE_UPDATE

#define IOCTL_UCXHUB_DEVICE_UPDATE UCXHUB_IOCTL(UCXHUB_FN_DEVICE_UPDATE)

Definition at line 56 of file hubucx.h.

◆ IOCTL_UCXHUB_ENDPOINT_RESET

#define IOCTL_UCXHUB_ENDPOINT_RESET UCXHUB_IOCTL(UCXHUB_FN_ENDPOINT_RESET)

Definition at line 63 of file hubucx.h.

◆ IOCTL_UCXHUB_ENDPOINTS_CONFIGURE

#define IOCTL_UCXHUB_ENDPOINTS_CONFIGURE UCXHUB_IOCTL(UCXHUB_FN_ENDPOINTS_CONFIGURE)

Definition at line 61 of file hubucx.h.

◆ IOCTL_UCXHUB_FREE_DUMP_DATA

#define IOCTL_UCXHUB_FREE_DUMP_DATA CTL_CODE(FILE_DEVICE_USBEX, UCXHUB_FN_FREE_DUMP_DATA, METHOD_BUFFERED, FILE_ANY_ACCESS)

Definition at line 74 of file hubucx.h.

◆ IOCTL_UCXHUB_GET_DUMP_DATA

#define IOCTL_UCXHUB_GET_DUMP_DATA CTL_CODE(FILE_DEVICE_USBEX, UCXHUB_FN_GET_DUMP_DATA, METHOD_BUFFERED, FILE_ANY_ACCESS)

Definition at line 72 of file hubucx.h.

◆ IOCTL_UCXHUB_GET_HUB_INFO

#define IOCTL_UCXHUB_GET_HUB_INFO UCXHUB_IOCTL(UCXHUB_FN_GET_HUB_INFO)

Definition at line 64 of file hubucx.h.

◆ IOCTL_UCXHUB_NOTIFY_FORWARD_PROGRESS

#define IOCTL_UCXHUB_NOTIFY_FORWARD_PROGRESS UCXHUB_IOCTL(UCXHUB_FN_NOTIFY_FORWARD_PROGRESS)

Definition at line 69 of file hubucx.h.

◆ IOCTL_UCXHUB_QUERY_USB_CAPABILITY

#define IOCTL_UCXHUB_QUERY_USB_CAPABILITY UCXHUB_IOCTL(UCXHUB_FN_QUERY_USB_CAPABILITY)

Definition at line 65 of file hubucx.h.

◆ IOCTL_UCXHUB_RESET_PORT_ASYNC

#define IOCTL_UCXHUB_RESET_PORT_ASYNC CTL_CODE(FILE_DEVICE_UNKNOWN, 1004, METHOD_NEITHER, FILE_ANY_ACCESS)

Definition at line 78 of file hubucx.h.

◆ IOCTL_UCXHUB_ROOTHUB_GET_20PORT_INFO

#define IOCTL_UCXHUB_ROOTHUB_GET_20PORT_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_20PORT_INFO)

Definition at line 51 of file hubucx.h.

◆ IOCTL_UCXHUB_ROOTHUB_GET_30PORT_INFO

#define IOCTL_UCXHUB_ROOTHUB_GET_30PORT_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_30PORT_INFO)

Definition at line 52 of file hubucx.h.

◆ IOCTL_UCXHUB_ROOTHUB_GET_INFO

#define IOCTL_UCXHUB_ROOTHUB_GET_INFO UCXHUB_IOCTL(UCXHUB_FN_ROOTHUB_GET_INFO)

Definition at line 50 of file hubucx.h.

◆ IOCTL_UCXHUB_SET_FUNCTION_HANDLE_DATA

#define IOCTL_UCXHUB_SET_FUNCTION_HANDLE_DATA UCXHUB_IOCTL(UCXHUB_FN_SET_FUNCTION_HANDLE_DATA)

Definition at line 66 of file hubucx.h.

◆ UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE

#define UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE 0x401

Definition at line 22 of file hubucx.h.

◆ UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE

#define UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE 0x40E

Definition at line 35 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_ABORT_IO

#define UCXHUB_FN_DEVICE_ABORT_IO 0x415

Definition at line 41 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_ADDRESS

#define UCXHUB_FN_DEVICE_ADDRESS 0x407

Definition at line 28 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_DISABLE

#define UCXHUB_FN_DEVICE_DISABLE 0x40A

Definition at line 31 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_ENABLE

#define UCXHUB_FN_DEVICE_ENABLE 0x405

Definition at line 26 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_HUB_INFO

#define UCXHUB_FN_DEVICE_HUB_INFO 0x409

Definition at line 30 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_PURGE_IO

#define UCXHUB_FN_DEVICE_PURGE_IO 0x40B

Definition at line 32 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_RESET

#define UCXHUB_FN_DEVICE_RESET 0x406

Definition at line 27 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_START_IO

#define UCXHUB_FN_DEVICE_START_IO 0x40C

Definition at line 33 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_TREE_PURGE_IO

#define UCXHUB_FN_DEVICE_TREE_PURGE_IO 0x414

Definition at line 40 of file hubucx.h.

◆ UCXHUB_FN_DEVICE_UPDATE

#define UCXHUB_FN_DEVICE_UPDATE 0x408

Definition at line 29 of file hubucx.h.

◆ UCXHUB_FN_ENDPOINT_RESET

#define UCXHUB_FN_ENDPOINT_RESET 0x40F

Definition at line 36 of file hubucx.h.

◆ UCXHUB_FN_ENDPOINTS_CONFIGURE

#define UCXHUB_FN_ENDPOINTS_CONFIGURE 0x40D

Definition at line 34 of file hubucx.h.

◆ UCXHUB_FN_FREE_DUMP_DATA

#define UCXHUB_FN_FREE_DUMP_DATA 0x502

Definition at line 43 of file hubucx.h.

◆ UCXHUB_FN_GET_DUMP_DATA

#define UCXHUB_FN_GET_DUMP_DATA 0x501

Definition at line 42 of file hubucx.h.

◆ UCXHUB_FN_GET_HUB_INFO

#define UCXHUB_FN_GET_HUB_INFO 0x410

Definition at line 37 of file hubucx.h.

◆ UCXHUB_FN_NOTIFY_FORWARD_PROGRESS

#define UCXHUB_FN_NOTIFY_FORWARD_PROGRESS 0x503

Definition at line 44 of file hubucx.h.

◆ UCXHUB_FN_QUERY_USB_CAPABILITY

#define UCXHUB_FN_QUERY_USB_CAPABILITY 0x412

Definition at line 38 of file hubucx.h.

◆ UCXHUB_FN_ROOTHUB_GET_20PORT_INFO

#define UCXHUB_FN_ROOTHUB_GET_20PORT_INFO 0x403

Definition at line 24 of file hubucx.h.

◆ UCXHUB_FN_ROOTHUB_GET_30PORT_INFO

#define UCXHUB_FN_ROOTHUB_GET_30PORT_INFO 0x404

Definition at line 25 of file hubucx.h.

◆ UCXHUB_FN_ROOTHUB_GET_INFO

#define UCXHUB_FN_ROOTHUB_GET_INFO 0x402

Definition at line 23 of file hubucx.h.

◆ UCXHUB_FN_SET_FUNCTION_HANDLE_DATA

#define UCXHUB_FN_SET_FUNCTION_HANDLE_DATA 0x413

Definition at line 39 of file hubucx.h.

◆ UCXHUB_IOCTL

#define UCXHUB_IOCTL ( Function ) CTL_CODE(FILE_DEVICE_USBEX, (Function), METHOD_NEITHER, FILE_ANY_ACCESS)

Definition at line 46 of file hubucx.h.

◆ UCXHUB_PARENT_INTERFACE_VERSION

#define UCXHUB_PARENT_INTERFACE_VERSION 1013

Definition at line 493 of file hubucx.h.

◆ UCXHUB_QUERY_CAPABILITY_VERSION

#define UCXHUB_QUERY_CAPABILITY_VERSION 1

Definition at line 156 of file hubucx.h.

◆ UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL

#define UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL FIELD_OFFSET(UCXHUB_STACK_INTERFACE, DeviceGetTimestamp)

Definition at line 469 of file hubucx.h.

◆ UCXHUB_STACK_INTERFACE_VERSION_1

#define UCXHUB_STACK_INTERFACE_VERSION_1 1000

Definition at line 417 of file hubucx.h.

◆ UCXHUB_STACK_INTERFACE_VERSION_2

#define UCXHUB_STACK_INTERFACE_VERSION_2 2000

Definition at line 418 of file hubucx.h.

◆ UCXHUB_STACK_INTERFACE_VERSION_3

#define UCXHUB_STACK_INTERFACE_VERSION_3 3000

Definition at line 419 of file hubucx.h.

◆ UCXHUB_TUNNEL_STATE_NATIVE

#define UCXHUB_TUNNEL_STATE_NATIVE 3

Definition at line 540 of file hubucx.h.

◆ UCXHUB_TUNNEL_STATE_NO_INFORMATION

#define UCXHUB_TUNNEL_STATE_NO_INFORMATION 1

Definition at line 538 of file hubucx.h.

◆ UCXHUB_TUNNEL_STATE_NOT_ANSWERED

#define UCXHUB_TUNNEL_STATE_NOT_ANSWERED 0

Definition at line 537 of file hubucx.h.

◆ UCXHUB_TUNNEL_STATE_TUNNELED

#define UCXHUB_TUNNEL_STATE_TUNNELED 2

Definition at line 539 of file hubucx.h.

◆ UCXHUB_TUNNEL_STATE_UNKNOWN

#define UCXHUB_TUNNEL_STATE_UNKNOWN 4

Definition at line 541 of file hubucx.h.

◆ UCXHUB_URB_FLAG_ALLOW_LARGE_TRANSFER

#define UCXHUB_URB_FLAG_ALLOW_LARGE_TRANSFER 0x40000000

Definition at line 101 of file hubucx.h.

◆ UCXHUB_URB_FLAG_PEND_INTERRUPT_TX

#define UCXHUB_URB_FLAG_PEND_INTERRUPT_TX 0x80000000

Definition at line 100 of file hubucx.h.

◆ UCXHUB_URB_FLAGS_HUB_MASK

#define UCXHUB_URB_FLAGS_HUB_MASK 0xFF000000

Definition at line 99 of file hubucx.h.

◆ UCXHUB_URB_FLAGS_UCX_MASK

#define UCXHUB_URB_FLAGS_UCX_MASK 0x00FFFFFF

Definition at line 98 of file hubucx.h.

◆ UCXHUB_WORKITEM_FLAG_NEEDS_FLUSH

#define UCXHUB_WORKITEM_FLAG_NEEDS_FLUSH 1

Definition at line 212 of file hubucx.h.

◆ UCXHUB_WORKITEM_NO_FLAGS

#define UCXHUB_WORKITEM_NO_FLAGS 0

Definition at line 211 of file hubucx.h.

Typedef Documentation

◆ _In_reads_bytes_

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_reads_bytes_(DescriptorBufferLength) PUSB_ENDPOINT_DESCRIPTOR Descriptor

Definition at line 306 of file hubucx.h.

◆ _IRQL_requires_

_IRQL_requires_ ==NDIS_MEMORY_NONCACHED

Lets UCX hook the controller device init. Call before WdfDeviceCreate.

Drops the binding taken by UcxStubBindClass. Safe to call when not bound.

Definition at line 253 of file hubucx.h.

◆ Companion

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_ ULONG _In_opt_ PUSB_SUPERSPEED_ENDPOINT_COMPANION_DESCRIPTOR Companion

Definition at line 308 of file hubucx.h.

◆ Context

typedef _In_opt_ PVOID Context

Definition at line 226 of file hubucx.h.

◆ ControllerInfo

typedef _Out_ PUCXHUB_CONTROLLER_INFO ControllerInfo

Definition at line 398 of file hubucx.h.

◆ CreateInfo

typedef _Must_inspect_result_ _In_ PUCXHUB_DEVICE_CREATE_INFO CreateInfo

Definition at line 257 of file hubucx.h.

◆ DescriptorBufferLength

_In_ UCHAR DescriptorBufferLength = 0

Definition at line 307 of file hubucx.h.

◆ Device

_Must_inspect_result_ _In_ WDFDEVICE Device

Initial value:

{

return ((PFN_WDFDEVICECREATE) WdfFunctions[WdfDeviceCreateTableIndex])(WdfDriverGlobals, DeviceInit, DeviceAttributes, Device)

WdfDriverGlobals

Globals WdfDriverGlobals

Definition: classlib.cpp:132

Device

_Must_inspect_result_ _In_ PUCXHUB_DEVICE_CREATE_INFO _Out_ UCXUSBDEVICE * Device

Definition: hubucx.h:258

DeviceInit

WDF_EXTERN_C_START typedef _Inout_ PWDFDEVICE_INIT DeviceInit

Definition: ucxclass.h:37

WdfFunctions

#define WdfFunctions

Definition: wdf.h:66

DeviceAttributes

_Must_inspect_result_ _Inout_ PWDFDEVICE_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES DeviceAttributes

Definition: wdfdevice.h:3569

WdfDeviceCreateTableIndex

@ WdfDeviceCreateTableIndex

Definition: wdffuncenum.h:100

Definition at line 258 of file hubucx.h.

◆ DeviceContext

typedef _In_ UCXHUB_DEVICE_CONTEXT DeviceContext

Definition at line 237 of file hubucx.h.

◆ Endpoint

_Must_inspect_result_ _Inout_ PUCXENDPOINT_INIT _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ UCXENDPOINT * Endpoint = NULL

Definition at line 238 of file hubucx.h.

◆ EndpointNumber

typedef _In_ UCXHUB_DEVICE_CONTEXT _In_ UCXENDPOINT _In_ ULONG EndpointNumber

Definition at line 239 of file hubucx.h.

◆ MaxPacketSize

typedef _Must_inspect_result_ _In_ UCXUSBDEVICE _In_ ULONG MaxPacketSize

Definition at line 289 of file hubucx.h.

◆ Pdo

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PDEVICE_OBJECT _In_opt_ PDEVICE_OBJECT _In_opt_ PDEVICE_OBJECT Pdo

Definition at line 280 of file hubucx.h.

◆ PFN_UCXHUB_DEVICE_GET_TIMESTAMP

typedef ULONG64(NTAPI * PFN_UCXHUB_DEVICE_GET_TIMESTAMP) (_In_ UCXUSBDEVICE Device)

System time the controller extension last handled an event for the device, or 0.

Definition at line 402 of file hubucx.h.

◆ PFN_UCXHUB_ENDPOINT_MAX_TRANSFER

typedef ULONG(NTAPI * PFN_UCXHUB_ENDPOINT_MAX_TRANSFER) (_In_ UCXENDPOINT Endpoint)

Definition at line 331 of file hubucx.h.

◆ PFN_UCXHUB_ENDPOINT_PIPE_HANDLE

typedef USBD_PIPE_HANDLE(NTAPI * PFN_UCXHUB_ENDPOINT_PIPE_HANDLE) (_In_ UCXENDPOINT Endpoint)

Definition at line 326 of file hubucx.h.

◆ PFN_UCXHUB_IS_DEVICE_DISCONNECTED

typedef BOOLEAN(NTAPI * PFN_UCXHUB_IS_DEVICE_DISCONNECTED) (_In_ UCXUSBDEVICE Device)

Definition at line 369 of file hubucx.h.

◆ PFN_UCXHUB_WORKITEM_ALLOCATE

typedef PUCXHUB_WORKITEM(NTAPI * PFN_UCXHUB_WORKITEM_ALLOCATE) (_In_ UCXUSBDEVICE Hub, _In_ PDEVICE_OBJECT DeviceObject, _In_ ULONG Flags)

Definition at line 336 of file hubucx.h.

◆ PFN_UCXHUB_WORKITEM_DELETE

typedef VOID(NTAPI * PFN_UCXHUB_WORKITEM_DELETE) (_In_ PUCXHUB_WORKITEM WorkItem)

Definition at line 343 of file hubucx.h.

◆ PFN_UCXHUB_WORKITEM_ENQUEUE

typedef VOID(NTAPI * PFN_UCXHUB_WORKITEM_ENQUEUE) (_In_ PUCXHUB_WORKITEM WorkItem, _In_ PUCXHUB_WORKITEM_ROUTINE Routine, _In_opt_ PVOID Context, _In_ UCXHUB_WORKITEM_ENQUEUE_OPTIONS Options)

Definition at line 348 of file hubucx.h.

◆ PortNumber

_In_ USHORT PortNumber

Definition at line 272 of file hubucx.h.

◆ Priority

FORCEINLINE _Post_maybenull_ _Must_inspect_result_ _In_ SIZE_T _In_ ULONG _In_ EX_POOL_PRIORITY Priority

Initial value:

{

return ExAllocatePoolWithTagPriority(PoolType, NumberOfBytes, Tag, Priority)

ExAllocatePoolWithTagPriority

PVOID NTAPI ExAllocatePoolWithTagPriority(IN POOL_TYPE PoolType, IN SIZE_T NumberOfBytes, IN ULONG Tag, IN EX_POOL_PRIORITY Priority)

Definition: expool.c:2963

Priority

_In_ UCXUSBDEVICE _In_ UCXENDPOINT _In_ ULONG Priority

Definition: hubucx.h:414

Tag

_Must_inspect_result_ _In_ UCXENDPOINT _In_ PVOID Tag

Definition: ucxendpoint.h:325

PoolType

_Must_inspect_result_ _In_ WDFDEVICE _In_ DEVICE_REGISTRY_PROPERTY _In_ _Strict_type_match_ POOL_TYPE PoolType

Definition: wdfdevice.h:3821

NumberOfBytes

_Must_inspect_result_ typedef _In_ PHYSICAL_ADDRESS _Inout_ PLARGE_INTEGER NumberOfBytes

Definition: iotypes.h:1036

Definition at line 414 of file hubucx.h.

◆ PUCXHUB_CONTROLLER_INFO

typedef struct _UCXHUB_CONTROLLER_INFO * PUCXHUB_CONTROLLER_INFO

◆ PUCXHUB_CONTROLLER_INFO_V2

typedef struct _UCXHUB_CONTROLLER_INFO_V2 * PUCXHUB_CONTROLLER_INFO_V2

◆ PUCXHUB_DEVICE_CREATE_INFO

typedef struct _UCXHUB_DEVICE_CREATE_INFO * PUCXHUB_DEVICE_CREATE_INFO

◆ PUCXHUB_DUMP_DEVICE_INFO

typedef struct _UCXHUB_DUMP_DEVICE_INFO * PUCXHUB_DUMP_DEVICE_INFO

◆ PUCXHUB_FORWARD_PROGRESS_INFO

typedef struct _UCXHUB_FORWARD_PROGRESS_INFO * PUCXHUB_FORWARD_PROGRESS_INFO

◆ PUCXHUB_FORWARD_PROGRESS_PIPE

typedef struct _UCXHUB_FORWARD_PROGRESS_PIPE * PUCXHUB_FORWARD_PROGRESS_PIPE

◆ PUCXHUB_FUNCTION_DATA

typedef struct _UCXHUB_FUNCTION_DATA * PUCXHUB_FUNCTION_DATA

◆ PUCXHUB_PARENT_INTERFACE

typedef struct _UCXHUB_PARENT_INTERFACE * PUCXHUB_PARENT_INTERFACE

◆ PUCXHUB_PARENT_INTERFACE_ORIGINAL

typedef struct _UCXHUB_PARENT_INTERFACE_ORIGINAL * PUCXHUB_PARENT_INTERFACE_ORIGINAL

◆ PUCXHUB_QUERY_CAPABILITY

typedef struct _UCXHUB_QUERY_CAPABILITY * PUCXHUB_QUERY_CAPABILITY

◆ PUCXHUB_RESET_FLAGS

typedef union _UCXHUB_RESET_FLAGS * PUCXHUB_RESET_FLAGS

◆ PUCXHUB_ROOTHUB_INFO

typedef struct _UCXHUB_ROOTHUB_INFO * PUCXHUB_ROOTHUB_INFO

◆ PUCXHUB_STACK_INTERFACE

typedef struct _UCXHUB_STACK_INTERFACE * PUCXHUB_STACK_INTERFACE

◆ PUCXHUB_STOP_IDLE_CONTEXT

typedef struct _UCXHUB_STOP_IDLE_CONTEXT * PUCXHUB_STOP_IDLE_CONTEXT

◆ PUCXHUB_UPDATE_TUNNEL_ANSWER

typedef struct _UCXHUB_UPDATE_TUNNEL_ANSWER * PUCXHUB_UPDATE_TUNNEL_ANSWER

◆ PUCXHUB_WORKITEM

typedef struct _UCXHUB_WORKITEM* PUCXHUB_WORKITEM

Definition at line 209 of file hubucx.h.

◆ PUCXHUB_WORKITEM_ROUTINE

typedef UCXHUB_WORKITEM_ROUTINE* PUCXHUB_WORKITEM_ROUTINE

Definition at line 228 of file hubucx.h.

◆ StopIdleContext

typedef _Inout_ PUCXHUB_STOP_IDLE_CONTEXT StopIdleContext

Definition at line 384 of file hubucx.h.

◆ SymbolicLinkName

_Must_inspect_result_ _In_ PCUNICODE_STRING SymbolicLinkName

Initial value:

{

return ((PFN_WDFDEVICECREATESYMBOLICLINK) WdfFunctions[WdfDeviceCreateSymbolicLinkTableIndex])(WdfDriverGlobals, Device, SymbolicLinkName)

SymbolicLinkName

_In_ PUNICODE_STRING SymbolicLinkName

Definition: hubucx.h:491

WdfDeviceCreateSymbolicLinkTableIndex

@ WdfDeviceCreateSymbolicLinkTableIndex

Definition: wdffuncenum.h:105

Definition at line 491 of file hubucx.h.

◆ TtPortNumber

_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ PUSB_PORT_PATH _Out_ PUSB_CD_ERROR_INFORMATION _In_ USHORT TtPortNumber

Definition at line 240 of file hubucx.h.

◆ UCXHUB_CONTROLLER_INFO

typedef struct _UCXHUB_CONTROLLER_INFO UCXHUB_CONTROLLER_INFO

QueryControllerBus output: the parent bus identity of the controller.

◆ UCXHUB_CONTROLLER_INFO_V2

typedef struct _UCXHUB_CONTROLLER_INFO_V2 UCXHUB_CONTROLLER_INFO_V2

◆ UCXHUB_DEVICE_CREATE_INFO

typedef struct _UCXHUB_DEVICE_CREATE_INFO UCXHUB_DEVICE_CREATE_INFO

Describes a newly attached device to the stack interface's device create.

◆ UCXHUB_DUMP_DEVICE_INFO

typedef struct _UCXHUB_DUMP_DEVICE_INFO UCXHUB_DUMP_DEVICE_INFO

◆ UCXHUB_FORWARD_PROGRESS_INFO

typedef struct _UCXHUB_FORWARD_PROGRESS_INFO UCXHUB_FORWARD_PROGRESS_INFO

◆ UCXHUB_FORWARD_PROGRESS_PIPE

typedef struct _UCXHUB_FORWARD_PROGRESS_PIPE UCXHUB_FORWARD_PROGRESS_PIPE

◆ UCXHUB_FUNCTION_DATA

typedef struct _UCXHUB_FUNCTION_DATA UCXHUB_FUNCTION_DATA

◆ UCXHUB_PARENT_INTERFACE

typedef struct _UCXHUB_PARENT_INTERFACE UCXHUB_PARENT_INTERFACE

◆ UCXHUB_PARENT_INTERFACE_ORIGINAL

typedef struct _UCXHUB_PARENT_INTERFACE_ORIGINAL UCXHUB_PARENT_INTERFACE_ORIGINAL

◆ UCXHUB_QUERY_CAPABILITY

typedef struct _UCXHUB_QUERY_CAPABILITY UCXHUB_QUERY_CAPABILITY

◆ UCXHUB_RESET_FLAGS

typedef union _UCXHUB_RESET_FLAGS UCXHUB_RESET_FLAGS

◆ UCXHUB_ROOTHUB_INFO

typedef struct _UCXHUB_ROOTHUB_INFO UCXHUB_ROOTHUB_INFO

ROOTHUB_GET_INFO payload; the controller driver sees only the ROOTHUB_INFO part.

◆ UCXHUB_STACK_INTERFACE

typedef struct _UCXHUB_STACK_INTERFACE UCXHUB_STACK_INTERFACE

◆ UCXHUB_STOP_IDLE_CONTEXT

typedef struct _UCXHUB_STOP_IDLE_CONTEXT UCXHUB_STOP_IDLE_CONTEXT

◆ UCXHUB_UPDATE_TUNNEL_ANSWER

typedef struct _UCXHUB_UPDATE_TUNNEL_ANSWER UCXHUB_UPDATE_TUNNEL_ANSWER

◆ UCXHUB_WORKITEM_ENQUEUE_OPTIONS

typedef enum _UCXHUB_WORKITEM_ENQUEUE_OPTIONS UCXHUB_WORKITEM_ENQUEUE_OPTIONS

◆ WorkItem

_In_ WDFWORKITEM WorkItem

Initial value:

{

return ((PFN_WDFWORKITEMCREATE) WdfFunctions[WdfWorkItemCreateTableIndex])(WdfDriverGlobals, Config, Attributes, WorkItem)

Attributes

_In_ ULONG Attributes

Definition: dispmprt.h:1077

WorkItem

_In_opt_ PVOID _In_ PUCXHUB_WORKITEM WorkItem

Definition: hubucx.h:227

Config

_Must_inspect_result_ _In_ WDFDEVICE _In_ PUCX_CONTROLLER_CONFIG Config

Definition: ucxcontroller.h:347

WdfWorkItemCreateTableIndex

@ WdfWorkItemCreateTableIndex

Definition: wdffuncenum.h:404

Definition at line 227 of file hubucx.h.

Enumeration Type Documentation

◆ _UCXHUB_WORKITEM_ENQUEUE_OPTIONS

enum _UCXHUB_WORKITEM_ENQUEUE_OPTIONS

Enumerator
UcxHubWorkItemDefault
UcxHubWorkItemForwardProgressNotRequired

Definition at line 214 of file hubucx.h.

{
    UcxHubWorkItemDefault = 0xCAD00000,
    UcxHubWorkItemForwardProgressNotRequired
} UCXHUB_WORKITEM_ENQUEUE_OPTIONS;

Function Documentation

◆ _Function_class_()

typedef _Function_class_ ( UCXHUB_WORKITEM_ROUTINE )

◆ _IRQL_requires_max_()

typedef _IRQL_requires_max_ ( DISPATCH_LEVEL )

Priority 1 to 3, forwarded to the HCD's EvtEndpointSetCharacteristic.

Definition at line 77 of file common.c.

{
    NTSTATUS                    status;
    BOOLEAN                     requestSent = FALSE;
 
    BOOLEAN                     shouldRetry = TRUE;
    PCDB                        cdb = (PCDB)DeviceExtension->PowerContext.Srb.Cdb;
    ULONG                       timeoutValue = DeviceExtension->TimeOutValue;
    ULONG                       retryCount = 1;
 
    // reset some fields.
    DeviceExtension->PowerContext.RetryIntervalIn100ns = 0;
    status = PowerContextReuseRequest(DeviceExtension);
    RequestClearSendTime(DeviceExtension->PowerContext.PowerRequest);
 
    if (!NT_SUCCESS(status))
    {
        return status;
    }
 
    // set proper timeout value and max retry count.
    switch(DeviceExtension->PowerContext.PowerChangeState.PowerDown)
    {
    case PowerDownDeviceInitial:
    case PowerDownDeviceQuiesced:
    case PowerDownDeviceStopped:
        break;
 
    case PowerDownDeviceLocked:
        // Case of issuing SYNC CACHE command. Do not use power irp timeout remaining time in this case
        // as we want to give best try on SYNC CACHE command.
        retryCount = MAXIMUM_RETRIES;
        timeoutValue = DeviceExtension->TimeOutValue;
        break;
 
    case PowerDownDeviceFlushed:
    {
        // Case of issuing STOP UNIT command
        // As "Imme" bit is set to '1', this command should be completed in short time.
        // This command is at low importance, failure of this command has very small impact.
        ULONG secondsRemaining = 0;
 
#if (WINVER >= 0x0601)
        // this API is introduced in Windows7
        PoQueryWatchdogTime(DeviceExtension->LowerPdo, &secondsRemaining);
#endif
 
        if (secondsRemaining == 0)
        {
            // not able to retrieve remaining time from PoQueryWatchdogTime API, use default values.
            retryCount = MAXIMUM_RETRIES;
            timeoutValue = SCSI_CDROM_TIMEOUT;
        }
        else
        {
            // plan to leave about 30 seconds to lower level drivers if possible.
            if (secondsRemaining >= 32)
            {
                retryCount = (secondsRemaining - 30)/SCSI_CDROM_TIMEOUT + 1;
                timeoutValue = SCSI_CDROM_TIMEOUT;
 
                if (retryCount > MAXIMUM_RETRIES)
                {
                    retryCount = MAXIMUM_RETRIES;
                }
 
                if (retryCount == 1)
                {
                    timeoutValue = secondsRemaining - 30;
                }
            }
            else
            {
                // issue the command with minimal timeout value and do not retry on it.
                retryCount = 1;
                timeoutValue = 2;
            }
        }
    }
        break;
    default:
        NT_ASSERT( FALSE );
        status = STATUS_NOT_IMPLEMENTED;
        return status;
    }
 
    DeviceExtension->PowerContext.RetryCount = retryCount;
 
    // issue command.
    while (shouldRetry)
    {
 
        // set SRB fields.
        DeviceExtension->PowerContext.Srb.SrbFlags = SRB_FLAGS_NO_DATA_TRANSFER |
                                                     SRB_FLAGS_DISABLE_SYNCH_TRANSFER |
                                                     SRB_FLAGS_NO_QUEUE_FREEZE |
                                                     SRB_FLAGS_BYPASS_LOCKED_QUEUE |
                                                     SRB_FLAGS_D3_PROCESSING;
 
        DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_EXECUTE_SCSI;
        DeviceExtension->PowerContext.Srb.TimeOutValue = timeoutValue;
 
        if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceInitial)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_LOCK_QUEUE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceLocked)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_QUIESCE_DEVICE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
        {
            // Case of issuing SYNC CACHE command.
            DeviceExtension->PowerContext.Srb.CdbLength = 10;
            cdb->SYNCHRONIZE_CACHE10.OperationCode = SCSIOP_SYNCHRONIZE_CACHE;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceFlushed)
        {
            // Case of issuing STOP UNIT command.
            DeviceExtension->PowerContext.Srb.CdbLength = 6;
            cdb->START_STOP.OperationCode = SCSIOP_START_STOP_UNIT;
            cdb->START_STOP.Start = 0;
            cdb->START_STOP.Immediate = 1;
        }
        else if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceStopped)
        {
            DeviceExtension->PowerContext.Srb.Function = SRB_FUNCTION_UNLOCK_QUEUE;
        }
 
        // Set up completion routine and context if requested
        if (CompletionRoutine)
        {
            WdfRequestSetCompletionRoutine(DeviceExtension->PowerContext.PowerRequest,
                                           CompletionRoutine,
                                           Context);
        }
 
        status = RequestSend(DeviceExtension,
                             DeviceExtension->PowerContext.PowerRequest,
                             DeviceExtension->IoTarget,
                             CompletionRoutine ? 0 : WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
                             &requestSent);
 
        if (requestSent)
        {
            if ((CompletionRoutine == NULL) &&
                (SRB_STATUS(DeviceExtension->PowerContext.Srb.SrbStatus) != SRB_STATUS_SUCCESS))
            {
                TracePrint((TRACE_LEVEL_ERROR,
                            TRACE_FLAG_POWER,
                            "%p\tError occured when issuing %s command to device. Srb %p, Status %x\n",
                            DeviceExtension->PowerContext.PowerRequest,
                            (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced) ? "SYNC CACHE" : "STOP UNIT",
                            &DeviceExtension->PowerContext.Srb,
                            DeviceExtension->PowerContext.Srb.SrbStatus));
 
                NT_ASSERT(!(TEST_FLAG(DeviceExtension->PowerContext.Srb.SrbStatus, SRB_STATUS_QUEUE_FROZEN)));
 
                shouldRetry = RequestSenseInfoInterpret(DeviceExtension,
                                                        DeviceExtension->PowerContext.PowerRequest,
                                                        &(DeviceExtension->PowerContext.Srb),
                                                        retryCount - DeviceExtension->PowerContext.RetryCount,
                                                        &status,
                                                        &(DeviceExtension->PowerContext.RetryIntervalIn100ns));
 
                if (shouldRetry && (DeviceExtension->PowerContext.RetryCount-- == 0))
                {
                    shouldRetry = FALSE;
                }
            }
            else
            {
                // succeeded, do not need to retry.
                shouldRetry = FALSE;
            }
 
        }
        else
        {
            // request failed to be sent
            shouldRetry = FALSE;
        }
 
        if (shouldRetry)
        {
            LARGE_INTEGER t;
            t.QuadPart = -DeviceExtension->PowerContext.RetryIntervalIn100ns;
            KeDelayExecutionThread(KernelMode, FALSE, &t);
 
            status = PowerContextReuseRequest(DeviceExtension);
            if (!NT_SUCCESS(status))
            {
                shouldRetry = FALSE;
            }
        }
    }
 
    if (DeviceExtension->PowerContext.PowerChangeState.PowerDown == PowerDownDeviceQuiesced)
    {
        // record SYNC CACHE command completion time stamp.
        KeQueryTickCount(&DeviceExtension->PowerContext.Step1CompleteTime);
    }
 
    return status;
}

◆ C_ASSERT() [1/11]

C_ASSERT ( FIELD_OFFSET(UCXHUB_CONTROLLER_INFO_V2, Pci) = =8 )

◆ C_ASSERT() [2/11]

C_ASSERT ( FIELD_OFFSET(UCXHUB_UPDATE_TUNNEL_ANSWER, TunnelState) = =1 )

◆ C_ASSERT() [3/11]

C_ASSERT ( FIELD_OFFSET(USBDEVICE_UPDATE, Reserved) = =0x2E )

◆ C_ASSERT() [4/11]

C_ASSERT ( sizeof(UCXHUB_CONTROLLER_INFO) = =28 )

◆ C_ASSERT() [5/11]

C_ASSERT ( sizeof(UCXHUB_CONTROLLER_INFO_V2) = =32 )

◆ C_ASSERT() [6/11]

C_ASSERT ( sizeof(UCXHUB_DEVICE_CREATE_INFO) = =16 )

◆ C_ASSERT() [7/11]

C_ASSERT ( sizeof(UCXHUB_PARENT_INTERFACE_ORIGINAL) = =0x58 )

◆ C_ASSERT() [8/11]

C_ASSERT ( sizeof(UCXHUB_QUERY_CAPABILITY) = =32 )

◆ C_ASSERT() [9/11]

C_ASSERT ( sizeof(UCXHUB_ROOTHUB_INFO) = =20 )

◆ C_ASSERT() [10/11]

C_ASSERT ( sizeof(USBDEVICE_UPDATE) = =0x30 )

◆ C_ASSERT() [11/11]

C_ASSERT ( UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL = =0x78 )

◆ DECLARE_HANDLE() [1/2]

DECLARE_HANDLE ( UCXHUB_DEVICE_CONTEXT )

◆ DECLARE_HANDLE() [2/2]

DECLARE_HANDLE ( UCXHUB_HUB_CONTEXT )

◆ DEFINE_GUID() [1/2]

DEFINE_GUID	(	GUID_UCXHUB_PARENT_INTERFACE	,
		0xa9264c93	,
		0xeccd	,
		0x4b40	,
		0x92	,
		0x9b	,
		0xb3	,
		0x54	,
		0xf1	,
		0xe9	,
		0xa2	,
		0xdc
	)

◆ DEFINE_GUID() [2/2]

DEFINE_GUID	(	GUID_UCXHUB_STACK_INTERFACE	,
		0x4fb2b0e1	,
		0x5fdd	,
		0x4dab	,
		0xa6	,
		0x00	,
		0x5e	,
		0x15	,
		0x16	,
		0xbb	,
		0xd8	,
		0xa7
	)

◆ UcxHubUpdateTunnelAnswer()

FORCEINLINE PUCXHUB_UPDATE_TUNNEL_ANSWER NTAPI UcxHubUpdateTunnelAnswer ( _In_ PUSBDEVICE_UPDATE Update )

Definition at line 556 of file hubucx.h.

{
    return (PUCXHUB_UPDATE_TUNNEL_ANSWER)&Update->Reserved;
}

Classes

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ IOCTL_UCXHUB_ADDRESS0_OWNERSHIP_ACQUIRE

◆ IOCTL_UCXHUB_DEFAULT_ENDPOINT_UPDATE

◆ IOCTL_UCXHUB_DEVICE_ABORT_IO

◆ IOCTL_UCXHUB_DEVICE_ADDRESS

◆ IOCTL_UCXHUB_DEVICE_DISABLE

◆ IOCTL_UCXHUB_DEVICE_ENABLE

◆ IOCTL_UCXHUB_DEVICE_HUB_INFO

◆ IOCTL_UCXHUB_DEVICE_PURGE_IO

◆ IOCTL_UCXHUB_DEVICE_RESET

◆ IOCTL_UCXHUB_DEVICE_START_IO

◆ IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO

◆ IOCTL_UCXHUB_DEVICE_UPDATE

◆ IOCTL_UCXHUB_ENDPOINT_RESET

◆ IOCTL_UCXHUB_ENDPOINTS_CONFIGURE

◆ IOCTL_UCXHUB_FREE_DUMP_DATA

◆ IOCTL_UCXHUB_GET_DUMP_DATA

◆ IOCTL_UCXHUB_GET_HUB_INFO

◆ IOCTL_UCXHUB_NOTIFY_FORWARD_PROGRESS

◆ IOCTL_UCXHUB_QUERY_USB_CAPABILITY

◆ IOCTL_UCXHUB_RESET_PORT_ASYNC

◆ IOCTL_UCXHUB_ROOTHUB_GET_20PORT_INFO

◆ IOCTL_UCXHUB_ROOTHUB_GET_30PORT_INFO

◆ IOCTL_UCXHUB_ROOTHUB_GET_INFO

◆ IOCTL_UCXHUB_SET_FUNCTION_HANDLE_DATA

◆ UCXHUB_FN_ADDRESS0_OWNERSHIP_ACQUIRE

◆ UCXHUB_FN_DEFAULT_ENDPOINT_UPDATE

◆ UCXHUB_FN_DEVICE_ABORT_IO

◆ UCXHUB_FN_DEVICE_ADDRESS

◆ UCXHUB_FN_DEVICE_DISABLE

◆ UCXHUB_FN_DEVICE_ENABLE

◆ UCXHUB_FN_DEVICE_HUB_INFO

◆ UCXHUB_FN_DEVICE_PURGE_IO

◆ UCXHUB_FN_DEVICE_RESET

◆ UCXHUB_FN_DEVICE_START_IO

◆ UCXHUB_FN_DEVICE_TREE_PURGE_IO

◆ UCXHUB_FN_DEVICE_UPDATE

◆ UCXHUB_FN_ENDPOINT_RESET

◆ UCXHUB_FN_ENDPOINTS_CONFIGURE

◆ UCXHUB_FN_FREE_DUMP_DATA

◆ UCXHUB_FN_GET_DUMP_DATA

◆ UCXHUB_FN_GET_HUB_INFO

◆ UCXHUB_FN_NOTIFY_FORWARD_PROGRESS

◆ UCXHUB_FN_QUERY_USB_CAPABILITY

◆ UCXHUB_FN_ROOTHUB_GET_20PORT_INFO

◆ UCXHUB_FN_ROOTHUB_GET_30PORT_INFO

◆ UCXHUB_FN_ROOTHUB_GET_INFO

◆ UCXHUB_FN_SET_FUNCTION_HANDLE_DATA

◆ UCXHUB_IOCTL

◆ UCXHUB_PARENT_INTERFACE_VERSION

◆ UCXHUB_QUERY_CAPABILITY_VERSION

◆ UCXHUB_STACK_INTERFACE_SIZE_ORIGINAL

◆ UCXHUB_STACK_INTERFACE_VERSION_1

◆ UCXHUB_STACK_INTERFACE_VERSION_2

◆ UCXHUB_STACK_INTERFACE_VERSION_3

◆ UCXHUB_TUNNEL_STATE_NATIVE

◆ UCXHUB_TUNNEL_STATE_NO_INFORMATION

◆ UCXHUB_TUNNEL_STATE_NOT_ANSWERED

◆ UCXHUB_TUNNEL_STATE_TUNNELED

◆ UCXHUB_TUNNEL_STATE_UNKNOWN

◆ UCXHUB_URB_FLAG_ALLOW_LARGE_TRANSFER

◆ UCXHUB_URB_FLAG_PEND_INTERRUPT_TX

◆ UCXHUB_URB_FLAGS_HUB_MASK

◆ UCXHUB_URB_FLAGS_UCX_MASK

◆ UCXHUB_WORKITEM_FLAG_NEEDS_FLUSH

◆ UCXHUB_WORKITEM_NO_FLAGS

Typedef Documentation

◆ _In_reads_bytes_

◆ _IRQL_requires_

◆ Companion

◆ Context

◆ ControllerInfo

◆ CreateInfo

◆ DescriptorBufferLength

◆ Device