hubbusif.h File Reference

#include "usbdi.h"
#include <pshpack1.h>
#include <poppack.h>

Go to the source code of this file.

Data Structures
struct	PROOTHUB_PDO_EXTENSION
struct	PUSB_CD_ERROR_INFORMATION
struct	PUSB_PORT_PATH
struct	PUSB_ID_ERROR_INFORMATION
struct	PUSB_BUS_INTERFACE_HUB_V0
struct	PUSB_BUS_INTERFACE_HUB_V1
struct	PUSB_BUS_INTERFACE_HUB_V2
struct	PUSB_BUS_INTERFACE_HUB_V3
struct	PUSB_BUS_INTERFACE_HUB_V4
struct	PUSB_BUS_INTERFACE_HUB_V5
struct	PUSB_BUS_INTERFACE_HUB_V6
struct	PUSB_BUS_INTERFACE_HUB_V7
struct	PUSB_BUS_INTERFACE_HUB_MINIDUMP
struct	PUSB_BUS_INTERFACE_HUB_SELECTIVE_SUSPEND
struct	PUSB_PIPE_INFORMATION_0
struct	PUSB_LEVEL_INFORMATION
struct	PUSB_DEVICE_INFORMATION_0
struct	PUSB_CONTROLLER_INFORMATION_0
struct	PUSB_CONTROLLER_INFORMATION_1
struct	PUSB_EXTPORT_INFORMATION
struct	PUSB_EXTHUB_INFORMATION_0
struct	PUSB_DEVICE_PERFORMANCE_INFO_0
Defines
#define	_HUBBUSIF_
#define	USBD_DEVHACK_SLOW_ENUMERATION   0x00000001
#define	USBD_DEVHACK_DISABLE_SN   0x00000002
#define	USBD_DEVHACK_SET_DIAG_ID   0x00000004
#define	USB_BUSIFFN   __stdcall
#define	CD_ERR_V1   0x00000001
#define	ID_ERR_V1   0x00000001
#define	USBD_KEEP_DEVICE_DATA   0x00000001
#define	USBD_MARK_DEVICE_BUSY   0x00000002
#define	USB_IDLE_NOT_READY   0
#define	USB_IDLE_READY   1
#define	ERRATA_FLAG_RESET_TT_ON_CANCEL   1
#define	ERRATA_FLAG_NO_CLEAR_TT_BUFFER_ON_CANCEL   2
#define	USB_BUSIF_HUB_VERSION_0   0x0000
#define	USB_BUSIF_HUB_VERSION_1   0x0001
#define	USB_BUSIF_HUB_VERSION_2   0x0002
#define	USB_BUSIF_HUB_VERSION_3   0x0003
#define	USB_BUSIF_HUB_VERSION_4   0x0004
#define	USB_BUSIF_HUB_VERSION_5   0x0005
#define	USB_BUSIF_HUB_VERSION_6   0x0006
#define	USB_BUSIF_HUB_VERSION_7   0x0007
#define	USB_BUSIF_HUB_MIDUMP_VERSION_0   0x0000
#define	USB_BUSIF_HUB_SS_VERSION_0   0x0000
Typedefs
typedef PVOID	PUSB_DEVICE_HANDLE
typedef USB_BUSIFFN_CREATE_USB_DEVICE *	PUSB_BUSIFFN_CREATE_USB_DEVICE
typedef USB_BUSIFFN_CREATE_USB_DEVICE_EX *	PUSB_BUSIFFN_CREATE_USB_DEVICE_EX
typedef USB_BUSIFFN_CREATE_USB_DEVICE_V7 *	PUSB_BUSIFFN_CREATE_USB_DEVICE_V7
typedef USB_BUSIFFN_INITIALIZE_USB_DEVICE *	PUSB_BUSIFFN_INITIALIZE_USB_DEVICE
typedef USB_BUSIFFN_INITIALIZE_USB_DEVICE_EX *	PUSB_BUSIFFN_INITIALIZE_USB_DEVICE_EX
typedef USB_BUSIFFN_REMOVE_USB_DEVICE *	PUSB_BUSIFFN_REMOVE_USB_DEVICE
typedef USB_BUSIFFN_GET_USB_DESCRIPTORS *	PUSB_BUSIFFN_GET_USB_DESCRIPTORS
typedef USB_BUSIFFN_RESTORE_DEVICE *	PUSB_BUSIFFN_RESTORE_DEVICE
typedef USB_BUSIFFN_GET_POTRTHACK_FLAGS *	PUSB_BUSIFFN_GET_POTRTHACK_FLAGS
typedef USB_BUSIFFN_GET_DEVICE_INFORMATION *	PUSB_BUSIFFN_GET_DEVICE_INFORMATION
typedef USB_BUSIFFN_GET_CONTROLLER_INFORMATION *	PUSB_BUSIFFN_GET_CONTROLLER_INFORMATION
typedef USB_BUSIFFN_CONTROLLER_SELECTIVE_SUSPEND *	PUSB_BUSIFFN_CONTROLLER_SELECTIVE_SUSPEND
typedef USB_BUSIFFN_GET_EXTENDED_HUB_INFO *	PUSB_BUSIFFN_GET_EXTENDED_HUB_INFO
typedef USB_BUSIFFN_GET_ROOTHUB_SYM_NAME *	PUSB_BUSIFFN_GET_ROOTHUB_SYM_NAME
typedef USB_BUSIFFN_GET_DEVICE_BUSCONTEXT *	PUSB_BUSIFFN_GET_DEVICE_BUSCONTEXT
typedef USB_BUSIFFN_INITIALIZE_20HUB *	PUSB_BUSIFFN_INITIALIZE_20HUB
typedef USB_BUSIFFN_IS_ROOT *	PUSB_BUSIFFN_IS_ROOT
typedef USB_BUSIFFN_ACQUIRE_SEMAPHORE *	PUSB_BUSIFFN_ACQUIRE_SEMAPHORE
typedef USB_BUSIFFN_RELEASE_SEMAPHORE *	PUSB_BUSIFFN_RELEASE_SEMAPHORE
typedef RH_INIT_CALLBACK *	PRH_INIT_CALLBACK
typedef USB_BUSIFFN_ROOTHUB_INIT_NOTIFY *	PUSB_BUSIFFN_ROOTHUB_INIT_NOTIFY
typedef USB_BUSIFFN_FLUSH_TRANSFERS *	PUSB_BUSIFFN_FLUSH_TRANSFERS
typedef USB_BUSIFFN_CALC_PIPE_BANDWIDTH *	PUSB_BUSIFFN_CALC_PIPE_BANDWIDTH
typedef USB_BUSIFFN_SET_BUS_WAKE_MODE *	PUSB_BUSIFFN_SET_BUS_WAKE_MODE
typedef USB_BUSIFFN_SET_DEVICE_FLAG *	PUSB_BUSIFFN_SET_DEVICE_FLAG
typedef USB_BUSIFFN_SET_DEVHANDLE_DATA *	PUSB_BUSIFFN_SET_DEVHANDLE_DATA
typedef USB_BUSIFFN_TEST_POINT *	PUSB_BUSIFFN_TEST_POINT
typedef USB_BUSIFFN_GET_DEVICE_PERFORMANCE_INFO *	PUSB_BUSIFFN_GET_DEVICE_PERFORMANCE_INFO
typedef USB_BUSIFFN_WAIT_ASYNC_POWERUP *	PUSB_BUSIFFN_WAIT_ASYNC_POWERUP
typedef USB_BUSIFFN_GET_DEVICE_ADDRESS *	PUSB_BUSIFFN_GET_DEVICE_ADDRESS
typedef USB_BUSIFFN_DEREF_DEVICE_HANDLE *	PUSB_BUSIFFN_DEREF_DEVICE_HANDLE
typedef USB_BUSIFFN_REF_DEVICE_HANDLE *	PUSB_BUSIFFN_REF_DEVICE_HANDLE
typedef USB_BUSIFFN_SET_DEVICE_HANDLE_IDLE_READY_STATE *	PUSB_BUSIFFN_SET_DEVICE_HANDLE_IDLE_READY_STATE
typedef USB_BUSIFFN_GET_CONTAINER_ID_FOR_PORT *	PUSB_BUSIFFN_GET_CONTAINER_ID_FOR_PORT
typedef USB_BUSIFFN_SET_CONTAINER_ID_FOR_PORT *	PUSB_BUSIFFN_SET_CONTAINER_ID_FOR_PORT
typedef USB_BUSIFFN_ABORT_ALL_DEVICE_PIPES *	PUSB_BUSIFFN_ABORT_ALL_DEVICE_PIPES
typedef USB_BUSIFFN_SET_DEVICE_ERRATA_FLAG *	PUSB_BUSIFFN_SET_DEVICE_ERRATA_FLAG
Enumerations
enum	USBPORT_CREATEDEV_ERROR {   CreateDevErrNotSet = 0, CreateDevBadHubDevHandle, CreateDevFailedAllocDevHandle, CreateDevFailedOpenEndpoint,   CreateDevFailedAllocDsBuff, CreateDevFailedGetDs, CreateDevTtNotFound, CreateDevBadDevHandlePtr }
enum	USBPORT_INITDEV_ERROR { InitDevErrNotSet = 0, InitDevFailedSetAddress, InitDevFailedPokeEndpoint, InitDevBadDeviceDescriptor }
Functions
	_Function_class_ (USB_BUSIFFN_CREATE_USB_DEVICE) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_CREATE_USB_DEVICE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_CREATE_USB_DEVICE_EX) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_CREATE_USB_DEVICE_EX(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_CREATE_USB_DEVICE_V7) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_CREATE_USB_DEVICE_V7(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_INITIALIZE_USB_DEVICE) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_INITIALIZE_USB_DEVICE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_INITIALIZE_USB_DEVICE_EX) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_INITIALIZE_USB_DEVICE_EX(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_REMOVE_USB_DEVICE) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_REMOVE_USB_DEVICE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_USB_DESCRIPTORS) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_USB_DESCRIPTORS(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_RESTORE_DEVICE) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_RESTORE_DEVICE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_POTRTHACK_FLAGS) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_POTRTHACK_FLAGS(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_DEVICE_INFORMATION) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_DEVICE_INFORMATION(_In_ PVOID BusContext
_In_ PUSB_DEVICE_HANDLE	_Out_writes_bytes_to_ (DeviceInformationBufferLength,*LengthOfDataCopied) PVOID DeviceInformationBuffer
	_Function_class_ (USB_BUSIFFN_GET_CONTROLLER_INFORMATION) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_CONTROLLER_INFORMATION(_In_ PVOID BusContext
	_Inout_updates_bytes_to_ (ControllerInformationBufferLength,*LengthOfDataCopied) PVOID ControllerInformationBuffer
	_Function_class_ (USB_BUSIFFN_CONTROLLER_SELECTIVE_SUSPEND) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_CONTROLLER_SELECTIVE_SUSPEND(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_EXTENDED_HUB_INFO) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_EXTENDED_HUB_INFO(_In_ PVOID BusContext
_In_ PDEVICE_OBJECT	_Inout_updates_bytes_to_ (HubInformationBufferLength,*LengthOfDataCopied) PVOID HubInformationBuffer
	_Function_class_ (USB_BUSIFFN_GET_ROOTHUB_SYM_NAME) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_ROOTHUB_SYM_NAME(_In_ PVOID BusContext
	_Inout_updates_bytes_to_ (HubSymNameBufferLength,*HubSymNameActualLength) PVOID HubSymNameBuffer
	_Function_class_ (USB_BUSIFFN_GET_DEVICE_BUSCONTEXT) typedef PVOID USB_BUSIFFN USB_BUSIFFN_GET_DEVICE_BUSCONTEXT(_In_ PVOID HubBusContext
	_Function_class_ (USB_BUSIFFN_INITIALIZE_20HUB) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_INITIALIZE_20HUB(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_IS_ROOT) typedef BOOLEAN USB_BUSIFFN USB_BUSIFFN_IS_ROOT(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_ACQUIRE_SEMAPHORE) typedef VOID USB_BUSIFFN USB_BUSIFFN_ACQUIRE_SEMAPHORE(_In_ PVOID BusContext)
	_Function_class_ (USB_BUSIFFN_RELEASE_SEMAPHORE) typedef VOID USB_BUSIFFN USB_BUSIFFN_RELEASE_SEMAPHORE(_In_ PVOID BusContext)
	_Function_class_ (RH_INIT_CALLBACK) typedef VOID __stdcall RH_INIT_CALLBACK(_In_ PVOID CallBackContext)
	_Function_class_ (USB_BUSIFFN_ROOTHUB_INIT_NOTIFY) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_ROOTHUB_INIT_NOTIFY(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_FLUSH_TRANSFERS) typedef VOID USB_BUSIFFN USB_BUSIFFN_FLUSH_TRANSFERS(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_CALC_PIPE_BANDWIDTH) typedef ULONG USB_BUSIFFN USB_BUSIFFN_CALC_PIPE_BANDWIDTH(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_BUS_WAKE_MODE) typedef VOID USB_BUSIFFN USB_BUSIFFN_SET_BUS_WAKE_MODE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_DEVICE_FLAG) typedef VOID USB_BUSIFFN USB_BUSIFFN_SET_DEVICE_FLAG(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_DEVHANDLE_DATA) typedef VOID USB_BUSIFFN USB_BUSIFFN_SET_DEVHANDLE_DATA(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_TEST_POINT) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_TEST_POINT(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_DEVICE_PERFORMANCE_INFO) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_DEVICE_PERFORMANCE_INFO(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_WAIT_ASYNC_POWERUP) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_WAIT_ASYNC_POWERUP(_In_ PVOID BusContext)
	_Function_class_ (USB_BUSIFFN_GET_DEVICE_ADDRESS) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_DEVICE_ADDRESS(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_DEREF_DEVICE_HANDLE) typedef VOID USB_BUSIFFN USB_BUSIFFN_DEREF_DEVICE_HANDLE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_REF_DEVICE_HANDLE) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_REF_DEVICE_HANDLE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_DEVICE_HANDLE_IDLE_READY_STATE) typedef ULONG USB_BUSIFFN USB_BUSIFFN_SET_DEVICE_HANDLE_IDLE_READY_STATE(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_GET_CONTAINER_ID_FOR_PORT) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_GET_CONTAINER_ID_FOR_PORT(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_CONTAINER_ID_FOR_PORT) typedef VOID USB_BUSIFFN USB_BUSIFFN_SET_CONTAINER_ID_FOR_PORT(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_ABORT_ALL_DEVICE_PIPES) typedef NTSTATUS USB_BUSIFFN USB_BUSIFFN_ABORT_ALL_DEVICE_PIPES(_In_ PVOID BusContext
	_Function_class_ (USB_BUSIFFN_SET_DEVICE_ERRATA_FLAG) typedef VOID USB_BUSIFFN USB_BUSIFFN_SET_DEVICE_ERRATA_FLAG(_In_ PVOID BusContext
	DEFINE_GUID (USB_BUS_INTERFACE_HUB_GUID, 0xb2bb8c0a, 0x5ab4, 0x11d3, 0xa8, 0xcd, 0x0, 0xc0, 0x4f, 0x68, 0x74, 0x7a)
	DEFINE_GUID (USB_BUS_INTERFACE_HUB_MINIDUMP_GUID, 0xc5485f21, 0x4e81, 0x4a23, 0xa8, 0xf9, 0xd8, 0x51, 0x8a, 0xf4, 0x5c, 0x38)
typedef	VOID (USB_BUSIFFN *PUSB_BUSIFFN_SET_MINIDUMP_FLAGS)(IN PVOID)
	DEFINE_GUID (USB_BUS_INTERFACE_HUB_SS_GUID, 0xbfc3f363, 0x8ba1, 0x4c7b, 0x97, 0xba, 0x9b, 0x12, 0xb1, 0xca, 0x13, 0x2f)
typedef	NTSTATUS (USB_BUSIFFN *PUSB_BUSIFFN_SUSPEND_HUB)(PDEVICE_OBJECT Pdo)
Variables
_Outptr_ PUSB_DEVICE_HANDLE *	NewDeviceHandle
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE	HubDeviceHandle
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT	PortStatus
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ USHORT	PortNumber
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE	HsHubDeviceHandle
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ USHORT _Out_ PUSB_CD_ERROR_INFORMATION	CdErrorInfo
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ USHORT _Out_ PUSB_CD_ERROR_INFORMATION _In_ USHORT	TtPortNumber
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ PUSB_PORT_PATH	PortPath
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ PUSB_PORT_PATH _Out_ PUSB_CD_ERROR_INFORMATION _In_ USHORT _In_ PDEVICE_OBJECT	PdoDeviceObject
_Outptr_ PUSB_DEVICE_HANDLE _In_ PUSB_DEVICE_HANDLE _In_ USHORT _In_ PUSB_PORT_PATH _Out_ PUSB_CD_ERROR_INFORMATION _In_ USHORT _In_ PDEVICE_OBJECT _In_ PUNICODE_STRING	PhysicalDeviceObjectName
_Inout_ PUSB_DEVICE_HANDLE	DeviceHandle
_Inout_ PUSB_DEVICE_HANDLE _Out_ PUSB_ID_ERROR_INFORMATION	IdErrInfo
_Inout_ PUSB_DEVICE_HANDLE _In_ ULONG	Flags
_Inout_ PUSB_DEVICE_HANDLE _Out_writes_bytes_to_ DeviceDescriptorBufferLength PUCHAR	DeviceDescriptorBuffer
_Inout_ PUSB_DEVICE_HANDLE _Out_writes_bytes_to_ DeviceDescriptorBufferLength PUCHAR _Inout_ PULONG	DeviceDescriptorBufferLength
_Inout_ PUSB_DEVICE_HANDLE _Out_writes_bytes_to_ DeviceDescriptorBufferLength PUCHAR _Inout_ PULONG _Out_writes_bytes_to_ ConfigDescriptorBufferLength PUCHAR	ConfigDescriptorBuffer
_Inout_ PUSB_DEVICE_HANDLE _Out_writes_bytes_to_ DeviceDescriptorBufferLength PUCHAR _Inout_ PULONG _Out_writes_bytes_to_ ConfigDescriptorBufferLength PUCHAR _Inout_ PULONG	ConfigDescriptorBufferLength
_Inout_ PUSB_DEVICE_HANDLE	OldDeviceHandle
_In_ PUSB_DEVICE_HANDLE _In_ ULONG	DeviceInformationBufferLength
_In_ PUSB_DEVICE_HANDLE _In_ ULONG _Inout_ PULONG	LengthOfDataCopied
_In_ ULONG	ControllerInformationBufferLength
_In_ BOOLEAN	Enable
_In_ PDEVICE_OBJECT	HubPhysicalDeviceObject
_In_ PDEVICE_OBJECT _In_ ULONG	HubInformationBufferLength
_In_ ULONG	HubSymNameBufferLength
_In_ ULONG _Out_ PULONG	HubSymNameActualLength
_In_ PUSB_DEVICE_HANDLE _In_ ULONG	TtCount
_In_ PVOID	DeviceObject
_In_ PVOID	CallbackContext
_In_ PVOID _In_ PRH_INIT_CALLBACK	CallbackRoutine
_In_ PUSBD_PIPE_INFORMATION	PipeInfo
_In_ PUSBD_PIPE_INFORMATION _In_ USB_DEVICE_SPEED	DeviceSpeed
_In_ ULONG	Mode
_In_ GUID *	DeviceFlagGuid
_In_ GUID _In_ PVOID	ValueData
_In_ GUID _In_ PVOID _In_ ULONG	ValueLength
_In_ PVOID _In_ PDEVICE_OBJECT	UsbDevicePdo
_In_ PVOID _In_ ULONG	Opcode
_In_ PVOID _In_ ULONG _In_ PVOID	TestData
_In_ PUSB_DEVICE_HANDLE _Out_ PUSHORT	DeviceAddress
_In_ PUSB_DEVICE_HANDLE _In_ PVOID	Object
_In_ PUSB_DEVICE_HANDLE _In_ PVOID _In_ ULONG	Tag
_In_ PUSB_DEVICE_HANDLE _In_ ULONG	NewIdleReadyState
_In_ USHORT _Out_ LPGUID	ContainerId
_In_ PUSB_DEVICE_HANDLE _In_ ULONG	DeviceErrataFlag