hubdriver.h File Reference

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

Go to the source code of this file.

Classes
struct	HubDriverState

Macros
#define	HUB_LIVEDUMP_HUB_RESET_OK   0x3000
#define	HUB_LIVEDUMP_HUB_RESET_FAILED   0x3001
#define	HUB_LIVEDUMP_SUPERSPEED_DISABLED   0x3002
#define	HUB_LIVEDUMP_ENUMERATION_FAILED   0x3003
#define	HUB_BUGCHECK_USB3   0x144
#define	HUB_USB3_BOOT_DEVICE_FAILED   2
#define	HUB_BOOT_DEVICE_IS_STORAGE   1
#define	HUB_BOOT_DEVICE_IS_HUB   2

Typedefs
typedef NTSTATUS(NTAPI *	PFN_HUB_KSE_QUERY_DEVICE_FLAGS) (_In_ PCWSTR DeviceKey, _In_ PCWSTR DeviceClass, _Out_ PULONG64 DeviceFlags)
typedef NTSTATUS(NTAPI *	PFN_HUB_REGISTER_BOOT_DEVICE) (_In_ PVOID Registration, _Out_ PVOID *Handle)
typedef VOID(NTAPI *	PFN_HUB_NOTIFY_BOOT_DEVICE_REMOVAL) (_In_ PVOID Handle)
typedef NTSTATUS(NTAPI *	PFN_HUB_REGISTER_POWER_SETTING) (_In_opt_ PDEVICE_OBJECT DeviceObject, _In_ LPCGUID SettingGuid, _In_ PPOWER_SETTING_CALLBACK Callback, _In_opt_ PVOID Context, _Outptr_opt_ PVOID *Handle)
typedef NTSTATUS(NTAPI *	PFN_HUB_UNREGISTER_POWER_SETTING) (_Inout_ PVOID Handle)
typedef _Must_inspect_result_ NTSTATUS(NTAPI *	PFN_HUB_GET_INTERFACE_PROPERTY) (_In_ PUNICODE_STRING SymbolicLinkName, _In_ CONST DEVPROPKEY *PropertyKey, _In_ LCID Lcid, _Reserved_ ULONG Flags, _In_ ULONG Size, _Out_writes_bytes_to_(Size, *RequiredSize) PVOID Data, _Out_ PULONG RequiredSize, _Out_ PDEVPROPTYPE Type)

Enumerations
enum class	HubGlobal : ULONG {   DisableSelectiveSuspendUI = 0x00000002 , EnableDiagnosticMode = 0x00000008 , DisableUxdSupport = 0x00000010 , EnableExtendedValidation = 0x00000020 ,   WakeOnConnectUI = 0x00000040 , DisableOnSoftRemove = 0x00000080 , UxdDeleteOnShutdown = 0x00000100 , UxdDeleteOnReload = 0x00000200 ,   UxdDeleteOnDisconnect = 0x00000400 , UxdEnable = 0x00000800 , EtwEnabled = 0x00001000 , CheckReservedFields = 0x00002000 ,   StrictDescriptorChecks = 0x00004000 , EnableUsb20HardwareLpm = 0x00008000 , PreventSuperSpeedDebounce = 0x00010000 , AlwaysSecondReset = 0x00020000 ,   EnableUsbLtm = 0x00040000 }
enum class	HubMsOsMode : ULONG { QueryOnce = 0 , ForceQuery = 1 , NeverQuery = 2 }
enum class	HubReport : ULONG { HubResetSucceeded = 0 , HubResetFailed = 1 , DeviceEnumerationFailed = 2 }

Functions
NTSTATUS NTAPI	HubCreateReport (_In_ WDFDEVICE HubFdo, _In_ HubReport Type, _In_ ULONG SubReason)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS NTAPI HubSubmitLiveDump(_In_ WDFDEVICE Device
	Sends a synchronous IOCTL to the specified device object.
VOID NTAPI	HubNotifyBootDeviceRemoval (_In_opt_ PVOID Handle)

Variables
HubDriverState	HubDriver
_In_ ULONG	Code
_In_ ULONG _In_ ULONG	SubReason

Macro Definition Documentation

HUB_BOOT_DEVICE_IS_HUB

#define HUB_BOOT_DEVICE_IS_HUB   2

Definition at line 160 of file hubdriver.h.

HUB_BOOT_DEVICE_IS_STORAGE

#define HUB_BOOT_DEVICE_IS_STORAGE   1

Definition at line 159 of file hubdriver.h.

HUB_BUGCHECK_USB3

#define HUB_BUGCHECK_USB3   0x144

Definition at line 157 of file hubdriver.h.

HUB_LIVEDUMP_ENUMERATION_FAILED

#define HUB_LIVEDUMP_ENUMERATION_FAILED   0x3003

Definition at line 154 of file hubdriver.h.

HUB_LIVEDUMP_HUB_RESET_FAILED

#define HUB_LIVEDUMP_HUB_RESET_FAILED   0x3001

Definition at line 152 of file hubdriver.h.

HUB_LIVEDUMP_HUB_RESET_OK

#define HUB_LIVEDUMP_HUB_RESET_OK   0x3000

Definition at line 151 of file hubdriver.h.

HUB_LIVEDUMP_SUPERSPEED_DISABLED

#define HUB_LIVEDUMP_SUPERSPEED_DISABLED   0x3002

Definition at line 153 of file hubdriver.h.

HUB_USB3_BOOT_DEVICE_FAILED

#define HUB_USB3_BOOT_DEVICE_FAILED   2

Definition at line 158 of file hubdriver.h.

Typedef Documentation

PFN_HUB_GET_INTERFACE_PROPERTY

typedef _Must_inspect_result_ NTSTATUS(NTAPI * PFN_HUB_GET_INTERFACE_PROPERTY) (_In_ PUNICODE_STRING SymbolicLinkName, _In_ CONST DEVPROPKEY *PropertyKey, _In_ LCID Lcid, _Reserved_ ULONG Flags, _In_ ULONG Size, _Out_writes_bytes_to_(Size, *RequiredSize) PVOID Data, _Out_ PULONG RequiredSize, _Out_ PDEVPROPTYPE Type)

Definition at line 74 of file hubdriver.h.

PFN_HUB_KSE_QUERY_DEVICE_FLAGS

typedef NTSTATUS(NTAPI * PFN_HUB_KSE_QUERY_DEVICE_FLAGS) (_In_ PCWSTR DeviceKey, _In_ PCWSTR DeviceClass, _Out_ PULONG64 DeviceFlags)

Definition at line 41 of file hubdriver.h.

PFN_HUB_NOTIFY_BOOT_DEVICE_REMOVAL

typedef VOID(NTAPI * PFN_HUB_NOTIFY_BOOT_DEVICE_REMOVAL) (_In_ PVOID Handle)

Definition at line 54 of file hubdriver.h.

PFN_HUB_REGISTER_BOOT_DEVICE

typedef NTSTATUS(NTAPI * PFN_HUB_REGISTER_BOOT_DEVICE) (_In_ PVOID Registration, _Out_ PVOID *Handle)

Definition at line 48 of file hubdriver.h.

PFN_HUB_REGISTER_POWER_SETTING

typedef NTSTATUS(NTAPI * PFN_HUB_REGISTER_POWER_SETTING) (_In_opt_ PDEVICE_OBJECT DeviceObject, _In_ LPCGUID SettingGuid, _In_ PPOWER_SETTING_CALLBACK Callback, _In_opt_ PVOID Context, _Outptr_opt_ PVOID *Handle)

Definition at line 59 of file hubdriver.h.

PFN_HUB_UNREGISTER_POWER_SETTING

typedef NTSTATUS(NTAPI * PFN_HUB_UNREGISTER_POWER_SETTING) (_Inout_ PVOID Handle)

Definition at line 68 of file hubdriver.h.

Enumeration Type Documentation

HubGlobal

enum class HubGlobal : ULONG

strong

Enumerator
DisableSelectiveSuspendUI
EnableDiagnosticMode
DisableUxdSupport
EnableExtendedValidation
WakeOnConnectUI
DisableOnSoftRemove
UxdDeleteOnShutdown
UxdDeleteOnReload
UxdDeleteOnDisconnect
UxdEnable
EtwEnabled
CheckReservedFields
StrictDescriptorChecks
EnableUsb20HardwareLpm
PreventSuperSpeedDebounce
AlwaysSecondReset
EnableUsbLtm

Definition at line 11 of file hubdriver.h.

{
    DisableSelectiveSuspendUI          = 0x00000002,
    EnableDiagnosticMode               = 0x00000008,
    DisableUxdSupport                  = 0x00000010,
    EnableExtendedValidation           = 0x00000020,
    WakeOnConnectUI                    = 0x00000040,
    DisableOnSoftRemove                = 0x00000080,
    UxdDeleteOnShutdown                = 0x00000100,
    UxdDeleteOnReload                  = 0x00000200,
    UxdDeleteOnDisconnect              = 0x00000400,
    UxdEnable                          = 0x00000800,
    EtwEnabled                         = 0x00001000,
    CheckReservedFields                = 0x00002000,
    StrictDescriptorChecks             = 0x00004000,
    EnableUsb20HardwareLpm             = 0x00008000,
    PreventSuperSpeedDebounce          = 0x00010000,
    AlwaysSecondReset                  = 0x00020000,
    EnableUsbLtm                       = 0x00040000
};

HubMsOsMode

enum class HubMsOsMode : ULONG

strong

Enumerator
QueryOnce
ForceQuery
NeverQuery

Definition at line 33 of file hubdriver.h.

{
    QueryOnce = 0,
    ForceQuery = 1,
    NeverQuery = 2
};

HubReport

enum class HubReport : ULONG

strong

Enumerator
HubResetSucceeded
HubResetFailed
DeviceEnumerationFailed

Definition at line 143 of file hubdriver.h.

{
    HubResetSucceeded = 0,
    HubResetFailed = 1,
    DeviceEnumerationFailed = 2
};

Function Documentation

_IRQL_requires_()

_IRQL_requires_

(

PASSIVE_LEVEL

)

Sends a synchronous IOCTL to the specified device object.

Parameters

[in]	IoControlCode	The IOCTL to send to the device.
[in]	DeviceObject	Pointer to the device object that will handle the IOCTL.
[in]	InputBuffer	Optional pointer to a buffer containing input data for the IOCTL. When specified, the buffer should be at least of InputBufferLength size.
[in]	InputBufferLength	Size in bytes, of the buffer pointed by InputBuffer.
[out]	OutputBuffer	Optional pointer to a buffer that will receive output data from the IOCTL. When specified, the buffer should be at least of OutputBufferLength size.
[in]	OutputBufferLength	Size in bytes, of the buffer pointed by OutputBuffer.
[in]	FileObject	Optional pointer to a file object that may be necessary for the IOCTL.

Returns

An NTSTATUS code indicating success or failure of this function.

Note

Must be called at PASSIVE_LEVEL with all APCs enabled.

Nothing is found unless the PCI bus driver publishes the properties.

The root hub name without its prefix; NULL when the PDO has no name.

Grows a private buffer to what the helper asks for.

Lets KMDF handle the IRP, then hands it back here still uncompleted.

Waits for the device machine to answer a PnP or power event; returns the PnP status.

Deletes the UCX endpoints of the disabled pipes, then the interface record.

One 4 byte value; the registry type is not checked.

Reread whenever user experience settings change; the open status is returned.

Sends a synchronous IOCTL to the specified device object.

Definition at line 2121 of file class.c.

{
    NTSTATUS status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Entering function.\n",
                DeviceObject));
 
    //
    // Send down Inquiry for VPD_THIRD_PARTY_COPY_PAGE and cache away the device parameters
    // from WINDOWS_BLOCK_DEVICE_TOKEN_LIMITS_DESCRIPTOR.
    //
    status = ClasspGetBlockDeviceTokenLimitsInfo(DeviceObject);
 
    if (NT_SUCCESS(status)) {
 
        ULONG maxListIdentifier = MaxTokenOperationListIdentifier;
 
        //
        // Query the maximum list identifier to use for TokenOperation commands.
        //
        if (NT_SUCCESS(ClasspGetMaximumTokenListIdentifier(DeviceObject, REG_DISK_CLASS_CONTROL, &maxListIdentifier))) {
            if (maxListIdentifier >= MIN_TOKEN_LIST_IDENTIFIERS) {
 
                NT_ASSERT(maxListIdentifier <= MAX_TOKEN_LIST_IDENTIFIERS);
                MaxTokenOperationListIdentifier = maxListIdentifier;
            }
        }
 
    }
 
    TracePrint((TRACE_LEVEL_VERBOSE,
                TRACE_FLAG_PNP,
                "ClassDetermineTokenOperationCommandSupport (%p): Exiting function with status %x.\n",
                DeviceObject,
                status));
 
    return status;
}

HubCreateReport()

NTSTATUS NTAPI HubCreateReport	(	_In_ WDFDEVICE	HubFdo,
		_In_ HubReport	Type,
		_In_ ULONG	SubReason
	)

Device enumeration failures are throttled per hub, since no device is passed.

Definition at line 151 of file errreport.cpp.

{
    WDF_OBJECT_ATTRIBUTES Attributes;
    WDF_WORKITEM_CONFIG Config;
    WDFWORKITEM WorkItem;
    NTSTATUS Status;
 
    if (KeGetCurrentIrql() < DISPATCH_LEVEL)
        return HubSubmitLiveDump(HubFdo, HubReportCode(Type), SubReason);
 
    WDF_WORKITEM_CONFIG_INIT(&Config, HubEvtReportWorkItem);
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&Attributes, HubReportWork);
    Attributes.ParentObject = HubFdo;
 
    Status = WdfWorkItemCreate(&Config, &Attributes, &WorkItem);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Hub %p report work item create failed 0x%lx\n", HubFdo, Status);
        return Status;
    }
 
    HubGetReportWork(WorkItem)->Type = Type;
    HubGetReportWork(WorkItem)->SubReason = SubReason;
    WdfWorkItemEnqueue(WorkItem);
 
    return STATUS_SUCCESS;
}

Referenced by HubEvtReportWorkItem(), and DeviceMachine::ReportEnumFailure().

HubNotifyBootDeviceRemoval()

VOID NTAPI HubNotifyBootDeviceRemoval

(

_In_opt_ PVOID

Handle

)

Kernel boot device removal notice; nothing when the kernel lacks it or Handle is NULL.

Definition at line 335 of file entry.cpp.

{
    if (Handle != NULL && HubDriver.NotifyBootDeviceRemoval != NULL)
        HubDriver.NotifyBootDeviceRemoval(Handle);
}

Referenced by PortMachine::NotifyBootDeviceRemoval(), and DeviceMachine::NotifyWrongDevice().

Variable Documentation

Code

_In_ ULONG Code

Definition at line 176 of file hubdriver.h.

HubDriver

HubDriverState HubDriver

extern

Definition at line 13 of file entry.cpp.

Referenced by _IRQL_requires_(), DeviceMachine::DisableWhenUnused(), HubApplyDisableOnSoftRemove(), HubApplyDisableSelectiveSuspendUI(), HubApplyDisableUxdSupport(), HubApplyEnableDiagnosticMode(), HubApplyEnableExtendedValidation(), HubApplyMsOsDescriptorMode(), HubApplyPreventSuperSpeedDebounce(), HubApplyWakeOnConnectUI(), HubChildAddressDone(), HubChildComputeLpm20(), HubConnectorFindById(), HubConnectorFindByPort(), HubDescInitDeviceContext(), HubEvtDriverCleanup(), HubNotifyBootDeviceRemoval(), HubUsb4InterfaceChange(), HubWmiEvtSurpriseRemovalCleanup(), DeviceMachine::LtmWanted(), DeviceMachine::MsOsQueryWanted(), PortMachine::NeedsDebounce(), and DeviceMachine::NeedsSecondReset().

SubReason

_In_ ULONG _In_ ULONG SubReason

Definition at line 177 of file hubdriver.h.