hubchild.h File Reference

#include "desccheck.h"

Include dependency graph for hubchild.h:

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

Go to the source code of this file.

Classes
struct	HubUxdSettings
struct	HubAltSettingFilter
struct	HubPipe
struct	HubInterface
struct	HubConfiguration
union	HubUcxPayload
struct	HubBillboardInfo
class	HubChild

Macros
#define	HUB_TUNNEL_STATE_NONE   UCXHUB_TUNNEL_STATE_NOT_ANSWERED
#define	HUB_TUNNEL_STATE_NOT_USB4   UCXHUB_TUNNEL_STATE_NO_INFORMATION
#define	HUB_TUNNEL_STATE_TUNNELED   UCXHUB_TUNNEL_STATE_TUNNELED
#define	HUB_TUNNEL_STATE_NATIVE   UCXHUB_TUNNEL_STATE_NATIVE
#define	HUB_TUNNEL_STATE_UNKNOWN   UCXHUB_TUNNEL_STATE_UNKNOWN
#define	HUB_BILLBOARD_NO_MODE   0xFF

Enumerations
enum class	ChildMuxFlag : ULONG { Stopped = 0x00000001 , PowerReference = 0x00000002 , PnpOperationPending = 0x00000004 }
enum class	ChildHack : ULONG {   DisableSerialNumber = 0x00000001 , AlwaysQueryMsOs = 0x00000002 , ResetAfterSystemResume = 0x00000004 , DisableOnSoftRemove = 0x00000008 ,   RequestConfigDescOnReset = 0x00000010 , SkipContainerIdQuery = 0x00000020 , IgnoreBosValidationFailure = 0x00000040 , DisableLpm = 0x00000080 ,   NoExitLatencyRequest = 0x00000100 , ResetAfterSuperSpeedResume = 0x00000200 , TolerateStalePipes = 0x00000400 , DisableUasp = 0x00000800 ,   NoIsochDelayRequest = 0x00001000 , ResetAfterIdleResume = 0x00002000 , DisableHotReset = 0x00004000 , SkipBosQuery = 0x00008000 ,   NonFunctional = 0x00010000 , DisableUsb20Lpm = 0x00020000 , DisableRemoteWakeForUsb20Lpm = 0x00040000 , DisableSuperSpeed = 0x00080000 ,   BlockedDevice = 0x00100000 , UseWin8DescriptorValidation = 0x00200000 , AlwaysSecondReset = 0x00400000 }
enum class	ChildProperty : ULONG {   NotRemovable = 0x00000001 , IsHub = 0x00000002 , HighSpeedCapable = 0x00000004 , MsOsNotSupported = 0x00000080 ,   LtmCapable = 0x00000100 , DualRole = 0x00000200 , ChargingPolicySupported = 0x00000400 , AcpiAllowsD3Cold = 0x00000800 ,   ExtPropertiesInstalled = 0x00001000 , IsComposite = 0x00002000 , HasBillboard = 0x00004000 , SupportsStreams = 0x00008000 ,   RemoteWakeCapable = 0x00010000 , SelfPowered = 0x00020000 , Usb20LpmCapable = 0x00040000 , BeslCapable = 0x00080000 ,   ContainerIdKnown = 0x10000000 , ContainerIdFromBos = 0x20000000 , UxdReserved = 0x01000000 , SupportsSelectiveSuspend = 0x02000000 ,   AllowIdleIrpInD3 = 0x04000000 }
enum class	ChildState : ULONG {   ReprogrammingPending = 0x00000001 , DifferentDeviceOnBootPort = 0x00000002 , ActivityIdSet = 0x00000004 , AttachSucceeded = 0x00000008 ,   WarmResetOnEnumeration = 0x00000010 , LastSetAddressFailed = 0x00000020 , AltSettingFiltered = 0x00000040 , ConfigurationValid = 0x00000080 ,   WasResetAtResume = 0x00000100 , D3ColdEnabledByDriver = 0x00000200 , FailedAnEnumeration = 0x00000400 , U1EnabledUpstream = 0x00000800 ,   U2EnabledUpstream = 0x00001000 , AltEnumCompleted = 0x00002000 , AltEnumCommandSent = 0x00004000 , MsOsInstallHandled = 0x00008000 ,   Disconnected = 0x00010000 , PendingNoPingResponse = 0x00020000 , HotResetOnEnumeration = 0x00040000 , WorkingDevice = 0x10000000 ,   PrefixedSerial = 0x20000000 , DualRoleCommandSent = 0x00800000 }
enum class	ChildSqm : ULONG {   Virtualized = 0x00000004 , IsOnXhci = 0x00000008 , HoldsPagingFiles = 0x00000010 , ValidBos = 0x00000020 ,   SupportsStreams = 0x00000040 , MultipleConfigurations = 0x00000080 , SuperSpeedCapable = 0x00000200 }
enum class	PipeState : UCHAR {   Invalid , NotCreated , PendingCreate , PendingEnable ,   Enabled , PendingDisable , Disabled , Deleted }

Functions
	C_ASSERT (sizeof(HubUxdSettings)==68)
	WDF_DECLARE_CONTEXT_TYPE_WITH_NAME (HubChild, HubGetChildContext)

Macro Definition Documentation

HUB_BILLBOARD_NO_MODE

#define HUB_BILLBOARD_NO_MODE   0xFF

Definition at line 227 of file hubchild.h.

HUB_TUNNEL_STATE_NATIVE

#define HUB_TUNNEL_STATE_NATIVE   UCXHUB_TUNNEL_STATE_NATIVE

Definition at line 53 of file hubchild.h.

HUB_TUNNEL_STATE_NONE

#define HUB_TUNNEL_STATE_NONE   UCXHUB_TUNNEL_STATE_NOT_ANSWERED

Definition at line 50 of file hubchild.h.

HUB_TUNNEL_STATE_NOT_USB4

#define HUB_TUNNEL_STATE_NOT_USB4   UCXHUB_TUNNEL_STATE_NO_INFORMATION

Definition at line 51 of file hubchild.h.

HUB_TUNNEL_STATE_TUNNELED

#define HUB_TUNNEL_STATE_TUNNELED   UCXHUB_TUNNEL_STATE_TUNNELED

Definition at line 52 of file hubchild.h.

HUB_TUNNEL_STATE_UNKNOWN

#define HUB_TUNNEL_STATE_UNKNOWN   UCXHUB_TUNNEL_STATE_UNKNOWN

Definition at line 54 of file hubchild.h.

Enumeration Type Documentation

ChildHack

enum class ChildHack : ULONG

strong

Enumerator
DisableSerialNumber
AlwaysQueryMsOs
ResetAfterSystemResume
DisableOnSoftRemove
RequestConfigDescOnReset
SkipContainerIdQuery
IgnoreBosValidationFailure
DisableLpm
NoExitLatencyRequest
ResetAfterSuperSpeedResume
TolerateStalePipes
DisableUasp
NoIsochDelayRequest
ResetAfterIdleResume
DisableHotReset
SkipBosQuery
NonFunctional
DisableUsb20Lpm
DisableRemoteWakeForUsb20Lpm
DisableSuperSpeed
BlockedDevice
UseWin8DescriptorValidation
AlwaysSecondReset

Definition at line 22 of file hubchild.h.

{
    DisableSerialNumber              = 0x00000001,
    AlwaysQueryMsOs                  = 0x00000002,
    ResetAfterSystemResume           = 0x00000004,
    DisableOnSoftRemove              = 0x00000008,
    RequestConfigDescOnReset         = 0x00000010,
    SkipContainerIdQuery             = 0x00000020,
    IgnoreBosValidationFailure       = 0x00000040,
    DisableLpm                       = 0x00000080,
    NoExitLatencyRequest             = 0x00000100,
    ResetAfterSuperSpeedResume       = 0x00000200,
    TolerateStalePipes               = 0x00000400,
    DisableUasp                      = 0x00000800,
    NoIsochDelayRequest              = 0x00001000,
    ResetAfterIdleResume             = 0x00002000,
    DisableHotReset                  = 0x00004000,
    SkipBosQuery                     = 0x00008000,
    NonFunctional                    = 0x00010000,
    DisableUsb20Lpm                  = 0x00020000,
    DisableRemoteWakeForUsb20Lpm     = 0x00040000,
    DisableSuperSpeed                = 0x00080000,
    BlockedDevice                    = 0x00100000,
    UseWin8DescriptorValidation      = 0x00200000,
    AlwaysSecondReset                = 0x00400000
};

ChildMuxFlag

enum class ChildMuxFlag : ULONG

strong

Enumerator
Stopped
PowerReference
PnpOperationPending

Definition at line 14 of file hubchild.h.

{
    Stopped                  = 0x00000001,
    PowerReference           = 0x00000002,
    PnpOperationPending      = 0x00000004
};

ChildProperty

enum class ChildProperty : ULONG

strong

Enumerator
NotRemovable
IsHub
HighSpeedCapable
MsOsNotSupported
LtmCapable
DualRole
ChargingPolicySupported
AcpiAllowsD3Cold
ExtPropertiesInstalled
IsComposite
HasBillboard
SupportsStreams
RemoteWakeCapable
SelfPowered
Usb20LpmCapable
BeslCapable
ContainerIdKnown	From MS OS, or generated from the serial number
ContainerIdFromBos
UxdReserved	A UXD settings record redirects the device to a VM
SupportsSelectiveSuspend
AllowIdleIrpInD3

Definition at line 57 of file hubchild.h.

{
    NotRemovable                     = 0x00000001,
    IsHub                            = 0x00000002,
    HighSpeedCapable                 = 0x00000004,
    MsOsNotSupported                 = 0x00000080,
    LtmCapable                       = 0x00000100,
    DualRole                         = 0x00000200,
    ChargingPolicySupported          = 0x00000400,
    AcpiAllowsD3Cold                 = 0x00000800,
    ExtPropertiesInstalled           = 0x00001000,
    IsComposite                      = 0x00002000,
    HasBillboard                     = 0x00004000,
    SupportsStreams                  = 0x00008000,
    RemoteWakeCapable                = 0x00010000,
    SelfPowered                      = 0x00020000,
    Usb20LpmCapable                  = 0x00040000,
    BeslCapable                      = 0x00080000,
 
    /* identity */
    ContainerIdKnown                 = 0x10000000,  
    ContainerIdFromBos               = 0x20000000,
 
    /* registry */
    UxdReserved                      = 0x01000000,  
    SupportsSelectiveSuspend         = 0x02000000,
    AllowIdleIrpInD3                 = 0x04000000
};

ChildSqm

enum class ChildSqm : ULONG

strong

Enumerator
Virtualized
IsOnXhci
HoldsPagingFiles
ValidBos
SupportsStreams
MultipleConfigurations
SuperSpeedCapable

Definition at line 120 of file hubchild.h.

{
    Virtualized                      = 0x00000004,
    IsOnXhci                         = 0x00000008,
    HoldsPagingFiles                 = 0x00000010,
    ValidBos                         = 0x00000020,
    SupportsStreams                  = 0x00000040,
    MultipleConfigurations           = 0x00000080,
    SuperSpeedCapable                = 0x00000200
};

ChildState

enum class ChildState : ULONG

strong

Enumerator
ReprogrammingPending
DifferentDeviceOnBootPort
ActivityIdSet
AttachSucceeded
WarmResetOnEnumeration
LastSetAddressFailed
AltSettingFiltered
ConfigurationValid
WasResetAtResume
D3ColdEnabledByDriver
FailedAnEnumeration
U1EnabledUpstream
U2EnabledUpstream
AltEnumCompleted
AltEnumCommandSent
MsOsInstallHandled
Disconnected
PendingNoPingResponse
HotResetOnEnumeration
WorkingDevice	The PDO describes a working device, not a placeholder
PrefixedSerial
DualRoleCommandSent

Definition at line 87 of file hubchild.h.

{
    ReprogrammingPending             = 0x00000001,
    DifferentDeviceOnBootPort        = 0x00000002,
    ActivityIdSet                    = 0x00000004,
    AttachSucceeded                  = 0x00000008,
    WarmResetOnEnumeration           = 0x00000010,
    LastSetAddressFailed             = 0x00000020,
    AltSettingFiltered               = 0x00000040,
    ConfigurationValid               = 0x00000080,
    WasResetAtResume                 = 0x00000100,
    D3ColdEnabledByDriver            = 0x00000200,
    FailedAnEnumeration              = 0x00000400,
    U1EnabledUpstream                = 0x00000800,
    U2EnabledUpstream                = 0x00001000,
    AltEnumCompleted                 = 0x00002000,
    AltEnumCommandSent               = 0x00004000,
    MsOsInstallHandled               = 0x00008000,
    Disconnected                     = 0x00010000,
    PendingNoPingResponse            = 0x00020000,
    HotResetOnEnumeration            = 0x00040000,
 
    /* identity */
    WorkingDevice                    = 0x10000000,  
    PrefixedSerial                   = 0x20000000,
 
    /* devxfer */
    DualRoleCommandSent              = 0x00800000
};

PipeState

enum class PipeState : UCHAR

strong

Enumerator
Invalid
NotCreated
PendingCreate
PendingEnable
Enabled
PendingDisable
Disabled
Deleted

Definition at line 157 of file hubchild.h.

{
    Invalid,
    NotCreated,
    PendingCreate,
    PendingEnable,
    Enabled,
    PendingDisable,
    Disabled,
    Deleted
};

Function Documentation

C_ASSERT()

C_ASSERT

(

sizeof(HubUxdSettings)

= =68

)

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME()

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME	(	HubChild	,
		HubGetChildContext
	)