HubFdo Class Reference

#include <fdo.h>

Collaboration diagram for HubFdo:

Public Member Functions
BOOLEAN	HasFlag (_In_ HubFlag Flag) const
VOID	SetFlag (_In_ HubFlag Flag)
VOID	ClearFlag (_In_ HubFlag Flag)
BOOLEAN	IsRootHub () const
UCXUSBDEVICE	UsbDevice () const
WDFDEVICE	Device () const
VOID	Post (_In_ HubEvent Event)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS PostAndWait(_In_ HubEvent Event
BOOLEAN	NeedsForwardProgress () const
PUCXHUB_WORKITEM	AllocateWorkItem ()
VOID	EnqueueWorkItem (_In_ PUCXHUB_WORKITEM WorkItem, _In_ PUCXHUB_WORKITEM_ROUTINE Routine, _In_ PVOID Context, _In_ BOOLEAN ForwardProgress)
	_IRQL_requires_ (PASSIVE_LEVEL) VOID FlushAndDeleteWorkItem(_Inout_ PUCXHUB_WORKITEM *WorkItem)
HubPort *	FindPort (_In_ ULONG PortNumber)
VOID	InitializeMux ()
	_IRQL_requires_ (PASSIVE_LEVEL) BOOLEAN CreateChildPorts()
VOID	QueuePowerUpToPorts (_In_ PortEvent Event)
VOID	QueueStopToPorts ()
VOID	QueueSuspendToPorts ()
VOID	QueueSurpriseRemovalToPorts ()
VOID	QueueResetToPorts ()
VOID	QueueStatusChangeToPorts ()
VOID	QueueFakeStatusChangeToPorts ()
VOID	QueuePowerDownToDevices (_In_ DsmEvent Event, _In_ HubDeviceFanOut FanOut)
VOID	QueuePowerUpToDevices (_In_ DsmEvent Event)
VOID	AllowHubReset ()
BOOLEAN	RequestHubReset ()
BOOLEAN	PortInterruptRefsReleased ()
BOOLEAN	TakeInterruptReference (_In_ HubPort *Port)
VOID	DropInterruptReference (_In_ HubPort *Port)
VOID	TakePortPowerReference (_In_ HubPort *Port)
VOID	DropPortPowerReference (_In_ HubPort *Port)
VOID	DropHubResetReference (_In_ HubPort *Port)
VOID	ResumeInterruptTransfer (_In_ HubPort *Port)
BOOLEAN	RegisterDevice (_In_ HubChild *Child)
VOID	UnregisterDevice (_In_ HubChild *Child)
VOID	ReferenceDevicePower (_In_ HubChild *Child)
VOID	DereferenceDevicePower (_In_ HubChild *Child)
VOID	ConfirmStopWhileSuspended (_In_ HubChild *Child)
VOID	MarkDevicesProgrammingLost ()
BOOLEAN	IsHubResetInProgress () const
VOID	AcquirePowerReference ()
VOID	ReleasePowerReference ()

Static Public Member Functions
static HubFdo *	FromDevice (_In_ WDFDEVICE Device)
static HubFdo *	FromContext (_In_ UCXHUB_HUB_CONTEXT Context)

Public Attributes
_In_ PCSTR	What
HubMachine	m_Machine
WDFDEVICE	m_Device
PDEVICE_OBJECT	m_WdmPdo
ULONG	m_HubNumber
volatile LONG	m_Flags
UCXHUB_PARENT_INTERFACE	m_Parent
UCXHUB_STACK_INTERFACE	m_Stack
USB_BUS_INTERFACE_USBDI_V3	m_Usbdi
DEVICE_CAPABILITIES	m_Capabilities
HubParentInfo	m_ParentInfo
BOOLEAN	m_StreamsSupported
ULONG	m_ResetFlags
struct _URB_PIPE_REQUEST	m_PipeUrb
WDFIOTARGET	m_RootHubTarget
UCXHUB_CONTROLLER_INFO_V2	m_ControllerInfo
UCXHUB_ROOTHUB_INFO	m_RootHubInfo
PROOTHUB_20PORT_INFO *	m_Root20Ports
PROOTHUB_30PORT_INFO_EX *	m_Root30Ports
ULONG	m_PortCount
USHORT	m_First20Port
USHORT	m_Last20Port
USHORT	m_First30Port
USHORT	m_Last30Port
ULONG	m_MaxPortPower
ULONG	m_SspIsochBurstCount
KEVENT	m_PnpEvent
NTSTATUS	m_PnpStatus
WDFREQUEST	m_PortStatusRequest
HubPort *	m_PortStatusTarget
ULONG	m_IdleTimeout
PVOID	m_IdleTimeoutSetting
PVOID	m_SelectiveSuspendSetting
WDF_POWER_DEVICE_STATE	m_PowerState
ULONG	m_FailureMessageId
LIST_ENTRY	m_HubListEntry
BOOLEAN	m_OnHubList
HubMux	m_Mux
HubTimer	m_Timer
PUCXHUB_WORKITEM	m_WorkItem
BOOLEAN	m_NeedsForwardProgress
HubControlRequest	m_Control
HubInterruptRequest	m_Interrupt
union {
USB_HUB_DESCRIPTOR   Usb20
USB_30_HUB_DESCRIPTOR   Usb30
}	m_HubDescriptor
USB_DEVICE_STATUS	m_DeviceStatus
USB_HUB_STATUS_AND_CHANGE	m_HubStatus
USB_HUB_STATUS_AND_CHANGE	m_PreviousHubStatus
PUSB_CONFIGURATION_DESCRIPTOR	m_ConfigDescriptor
USHORT	m_ConfigTotalLength
USHORT	m_SelectedFeature
HubChange	m_SelectedChange
USHORT	m_InterruptMaxPacket
USBD_CONFIGURATION_HANDLE	m_ConfigurationHandle
USHORT	m_ResetCount
USHORT	m_DescriptorRetryCount
ULONG	m_RecoveryCount
ULONG	m_LifetimeRecoveryCount
LARGE_INTEGER	m_FirstRecoveryTime
ULONG	m_LastResetPortStatus
UNICODE_STRING	m_SymbolicLinkName
ULONG	m_VerifierFlags
WDFWMIINSTANCE	m_WmiInstance
ULONG	m_FwUpdateProtocol
ULONG	m_DromHeader [4]
PULONG	m_DromBuffer
PULONG	m_DromPool
ULONG	m_DromLength
ULONG	m_DromMailbox
HubRouterIdentity	m_RouterIdentity
WDFSTRING	m_Usb4HostName
BOOLEAN	m_HasUsb4Ports
BOOLEAN	m_TunneledDevicesSkipU2
WDFCOLLECTION	m_Usb4Hosts
WDFWAITLOCK	m_Usb4HostsLock
PVOID	m_Usb4Notification

Static Public Attributes
static EVT_WDF_DRIVER_DEVICE_ADD	EvtDeviceAdd

Private Member Functions
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS Initialize(_In_ WDFDEVICE Device)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS QueryCapabilities()
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS QueryInterfaces()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID ProbeParentCapabilities()
	_IRQL_requires_ (PASSIVE_LEVEL) VOID ConfigureIdle()
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS CreateQueue()
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS InitializeMachine()
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS AssignIdleSettings(_In_ WDF_POWER_POLICY_IDLE_TIMEOUT_TYPE TimeoutType)
VOID	PostToAllPorts (_In_ PortEvent Event)
VOID	FinishDeviceFanOut ()

Static Private Member Functions
static VOID NTAPI	TimerFired (_In_ PVOID Context)

Static Private Attributes
static EVT_WDF_DEVICE_PREPARE_HARDWARE	EvtPrepareHardware
static EVT_WDF_DEVICE_RELEASE_HARDWARE	EvtReleaseHardware
static EVT_WDF_DEVICE_D0_ENTRY	EvtD0Entry
static EVT_WDF_DEVICE_D0_EXIT	EvtD0Exit
static EVT_WDF_DEVICE_SURPRISE_REMOVAL	EvtSurpriseRemoval
static EVT_WDF_DEVICE_USAGE_NOTIFICATION	EvtUsageNotification
static EVT_WDF_DEVICE_ARM_WAKE_FROM_S0	EvtArmWakeFromS0
static EVT_WDF_DEVICE_DISARM_WAKE_FROM_S0	EvtDisarmWakeFromS0
static EVT_WDF_DEVICE_ARM_WAKE_FROM_SX	EvtArmWakeFromSx
static EVT_WDF_DEVICE_DISARM_WAKE_FROM_SX	EvtDisarmWakeFromSx
static EVT_WDF_OBJECT_CONTEXT_CLEANUP	EvtCleanup
static EVT_WDF_OBJECT_CONTEXT_DESTROY	EvtDestroy
static EVT_WDFDEVICE_WDM_IRP_PREPROCESS	EvtShutdown
static POWER_SETTING_CALLBACK	PowerSettingChanged
static UCXHUB_WORKITEM_ROUTINE	MachineWorkItem

Friends
class	HubMachine

Detailed Description

Definition at line 131 of file fdo.h.

Member Function Documentation

_IRQL_requires_() [1/11]

HubFdo::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_() [2/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [3/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [4/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [5/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [6/11]

HubFdo::_IRQL_requires_

(

PASSIVE_LEVEL

)

Posts a PnP or power event and waits until the machine answers it.

_IRQL_requires_() [7/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [8/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [9/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

_IRQL_requires_() [10/11]

HubFdo::_IRQL_requires_

(

PASSIVE_LEVEL

)

_IRQL_requires_() [11/11]

HubFdo::_IRQL_requires_ ( PASSIVE_LEVEL  )

private

AcquirePowerReference()

VOID HubFdo::AcquirePowerReference

(

)

Definition at line 105 of file fdo.cpp.

{
    KIRQL OldIrql;
    NTSTATUS Status;
 
    NT_ASSERT(!HasFlag(HubFlag::PowerReferencePending));
 
    KeRaiseIrql(DISPATCH_LEVEL, &OldIrql);
    Status = WdfDeviceStopIdle(m_Device, FALSE);
    KeLowerIrql(OldIrql);
 
    if (NT_SUCCESS(Status))
        SetFlag(HubFlag::PowerReferencePending);
    else
        DPRINT1("Hub %p power reference failed 0x%lx\n", m_Device, Status);
}

Referenced by HubMachine::AcquirePowerReference().

AllocateWorkItem()

PUCXHUB_WORKITEM HubFdo::AllocateWorkItem

(

)

Definition at line 46 of file fdo.cpp.

{
    return m_Stack.WorkItemAllocate(UsbDevice(),
                                    WdfDeviceWdmGetDeviceObject(m_Device),
                                    UCXHUB_WORKITEM_FLAG_NEEDS_FLUSH);
}

Referenced by _IRQL_requires_(), and HubChild::Create().

AllowHubReset()

VOID HubFdo::AllowHubReset

(

)

Definition at line 444 of file fanout.cpp.

{
    HubSpinLockGuard Guard(&m_Mux.Lock);
    m_Mux.HubResetEnabled = TRUE;
}

Referenced by HubMachine::AllowHubReset().

ClearFlag()

VOID HubFdo::ClearFlag ( _In_ HubFlag  Flag )

inline

Definition at line 167 of file fdo.h.

    {
        InterlockedAnd(&m_Flags, ~(LONG)Flag);
    }

Referenced by _IRQL_requires_().

ConfirmStopWhileSuspended()

VOID HubFdo::ConfirmStopWhileSuspended

(

_In_ HubChild *

Child

)

Definition at line 821 of file fanout.cpp.

{
    BOOLEAN Completed;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        Child->m_MuxFlags &= ~(ULONG)ChildMuxFlag::PnpOperationPending;
        Child->m_MuxFlags |= (ULONG)ChildMuxFlag::Stopped;
        Completed = (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0);
    }
 
    if (Completed)
        FinishDeviceFanOut();
}

Referenced by DeviceMachine::ConfirmStopWhileSuspended().

DereferenceDevicePower()

VOID HubFdo::DereferenceDevicePower

(

_In_ HubChild *

Child

)

Definition at line 802 of file fanout.cpp.

{
    BOOLEAN Completed;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        Child->m_MuxFlags &= ~((ULONG)ChildMuxFlag::PnpOperationPending | (ULONG)ChildMuxFlag::PowerReference);
        Child->m_MuxFlags |= (ULONG)ChildMuxFlag::Stopped;
        m_Mux.DevicePowerReferences--;
        Completed = (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0);
    }
 
    if (Completed)
        FinishDeviceFanOut();
}

Referenced by DeviceMachine::DereferenceDevicePower().

Device()

WDFDEVICE HubFdo::Device ( ) const

inline

Definition at line 186 of file fdo.h.

    {
        return m_Device;
    }

DropHubResetReference()

VOID HubFdo::DropHubResetReference

(

_In_ HubPort *

Port

)

Definition at line 563 of file fanout.cpp.

{
    Port->ClearMuxFlag(PortMuxFlag::ResetPending);
 
    if (InterlockedDecrement(&m_Mux.OutstandingResetOperations) == 0)
        Post(HubEvent::PortsResetReleased);
}

Referenced by PortMachine::DropHubResetReference().

DropInterruptReference()

VOID HubFdo::DropInterruptReference

(

_In_ HubPort *

Port

)

Definition at line 499 of file fanout.cpp.

{
    BOOLEAN Released = FALSE;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        if (!Port->HasMuxFlag(PortMuxFlag::InterruptReference))
            DPRINT1("Port %u dropped an interrupt reference it did not hold\n", Port->Number());
        NT_ASSERT(Port->HasMuxFlag(PortMuxFlag::InterruptReference));
        Port->ClearMuxFlag(PortMuxFlag::InterruptReference);
 
        if (m_Mux.InterruptReferences == 0)
            DPRINT1("Hub %p interrupt references released too many times\n", m_Device);
        NT_ASSERT(m_Mux.InterruptReferences != 0);
        if (m_Mux.InterruptReferences != 0)
            m_Mux.InterruptReferences--;
 
        if (m_Mux.InterruptReferences == 0 && m_Mux.InterruptReleasePending)
        {
            m_Mux.InterruptReleasePending = FALSE;
            Released = TRUE;
        }
    }
 
    if (Released)
        Post(HubEvent::PortsInterruptReleased);
}

Referenced by PortMachine::DropInterruptReference().

DropPortPowerReference()

VOID HubFdo::DropPortPowerReference

(

_In_ HubPort *

Port

)

Definition at line 544 of file fanout.cpp.

{
    Port->ClearMuxFlag(PortMuxFlag::PnpOperationPending);
    Port->ClearMuxFlag(PortMuxFlag::PowerReference);
    InterlockedDecrement(&m_Mux.PortPowerReferences);
 
    if (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0)
        Post(HubEvent::PortsReleased);
 
    /* Taken when a root port answered with an operation still pending */
    if (Port->HasFlag(PortFlag::PendingHubPowerReference))
    {
        WdfDeviceResumeIdle(m_Device);
        Port->ClearFlag(PortFlag::PendingHubPowerReference);
    }
}

Referenced by PortMachine::DropPortPowerReference().

EnqueueWorkItem()

VOID HubFdo::EnqueueWorkItem	(	_In_ PUCXHUB_WORKITEM	WorkItem,
		_In_ PUCXHUB_WORKITEM_ROUTINE	Routine,
		_In_ PVOID	Context,
		_In_ BOOLEAN	ForwardProgress
	)

Definition at line 54 of file fdo.cpp.

{
    m_Stack.WorkItemEnqueue(WorkItem,
                            Routine,
                            Context,
                            ForwardProgress ? UcxHubWorkItemDefault : UcxHubWorkItemForwardProgressNotRequired);
}

Referenced by DeviceMachine::QueuePassiveWork(), HubMachine::QueuePassiveWork(), and PortMachine::QueuePassiveWork().

FindPort()

HubPort * HubFdo::FindPort

(

_In_ ULONG

PortNumber

)

Definition at line 42 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
 
    /* The list only changes in CreateChildPorts */
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        if (Port->Number() == PortNumber)
            return Port;
    }
 
    return NULL;
}

Referenced by HubMachine::CheckHubChangeBit(), HubIoGetConnectionAttributes(), HubIoGetConnectionInformation(), HubIoGetConnectionInformationV2(), HubIoGetConnectorProperties(), HubIoGetPortStatus(), HubWmiQueryHubNode(), and HubWmiResetOverCurrent().

FinishDeviceFanOut()

VOID HubFdo::FinishDeviceFanOut ( )

private

Definition at line 609 of file fanout.cpp.

{
    HubDeviceFanOut FanOut = m_Mux.DeviceFanOut;
 
    m_Mux.DeviceFanOut = HubDeviceFanOut::None;
 
    switch (FanOut)
    {
        case HubDeviceFanOut::PowerUp:
            Post(HubEvent::DevicesAcquired);
            break;
 
        case HubDeviceFanOut::PowerDown:
            Post(HubEvent::DevicesReleased);
            break;
 
        case HubDeviceFanOut::StopWhileSuspended:
            Post(HubEvent::DevicesStoppedAfterSuspend);
            break;
 
        default:
            DPRINT1("Hub %p device fan out ended with none running\n", m_Device);
            NT_ASSERT(FALSE);
            break;
    }
}

Referenced by ConfirmStopWhileSuspended(), DereferenceDevicePower(), ReferenceDevicePower(), and UnregisterDevice().

FromContext()

static HubFdo * HubFdo::FromContext ( _In_ UCXHUB_HUB_CONTEXT  Context )

inlinestatic

Definition at line 144 of file fdo.h.

    {
        return (HubFdo*)Context;
    }

Referenced by HubClearTtBuffer().

FromDevice()

HubFdo * HubFdo::FromDevice ( _In_ WDFDEVICE  Device )

static

Definition at line 37 of file fdo.cpp.

{
    return HubGetFdoContext(Device);
}

Referenced by HubConfigurationComplete(), HubEvtIoDeviceControl(), HubEvtIoInternalDeviceControl(), HubEvtOverCurrentWorkItem(), HubUsb4InterfaceChange(), HubUsb4OpenWorkItem(), HubWmiExecuteMethod(), and HubWmiQueryHubNode().

HasFlag()

BOOLEAN HubFdo::HasFlag ( _In_ HubFlag  Flag ) const

inline

Definition at line 153 of file fdo.h.

    {
        return (m_Flags & (LONG)Flag) != 0;
    }

Referenced by _IRQL_requires_(), AcquirePowerReference(), DeviceMachine::DisableWhenUnused(), PortMachine::HubArmedForWake(), HubClearTtBuffer(), HubEvtOverCurrentWorkItem(), HubIoGetHubCapabilities(), HubIoValidate(), HubPdoEvtParentInterfaceQuery(), PortMachine::HubPowerTake(), HubMachine::IsInBootPath(), PortMachine::PollResetCompletion(), PortNextChange30(), ReleasePowerReference(), IdleMachine::SelectiveSuspendSupported(), and PortMachine::SuperSpeedBlocked().

InitializeMux()

VOID HubFdo::InitializeMux

(

)

Definition at line 33 of file fanout.cpp.

{
    RtlZeroMemory(&m_Mux, sizeof(m_Mux));
    KeInitializeSpinLock(&m_Mux.Lock);
    InitializeListHead(&m_Mux.Ports);
    InitializeListHead(&m_Mux.Devices);
}

IsHubResetInProgress()

BOOLEAN HubFdo::IsHubResetInProgress ( ) const

inline

Definition at line 333 of file fdo.h.

    {
        return m_Mux.HubResetInProgress != 0;
    }

Referenced by PortMachine::NotifyBootDeviceRemoval().

IsRootHub()

BOOLEAN HubFdo::IsRootHub ( ) const

inline

Definition at line 174 of file fdo.h.

    {
        return m_Parent.HubDepth == 0;
    }

Referenced by _IRQL_requires_(), HubIoBuild20Descriptor(), HubIoGetConnectionInformationV2(), HubIoGetHubCapabilities(), HubIoGetHubInformationEx(), HubMakeUsb2StyleDescriptor(), HubWmiQueryHubNode(), HubMachine::IsDepthZero(), HubMachine::QueryErrataFlags(), DeviceMachine::SelectConfigValid(), HubMachine::StartStatusChangeRead(), PortMachine::StartTimer(), and UcxBuildPortPath().

MarkDevicesProgrammingLost()

VOID HubFdo::MarkDevicesProgrammingLost

(

)

Definition at line 840 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
 
    HubSpinLockGuard Guard(&m_Mux.Lock);
 
    for (Entry = m_Mux.Devices.Flink; Entry != &m_Mux.Devices; Entry = Entry->Flink)
        CONTAINING_RECORD(Entry, HubChild, m_HubLink)->SetState(ChildState::ReprogrammingPending);
}

Referenced by HubResetComplete(), and HubMachine::WasResetByParent().

NeedsForwardProgress()

BOOLEAN HubFdo::NeedsForwardProgress ( ) const

inline

Definition at line 208 of file fdo.h.

    {
        return m_NeedsForwardProgress;
    }

Referenced by HubMachine::GetConfigDescriptor(), HubClearTtBuffer(), HubMailboxTransfer(), HubSendControl(), PortSendControl(), PortMachine::QueuePassiveWork(), and HubMachine::StartStatusChangeRead().

PortInterruptRefsReleased()

BOOLEAN HubFdo::PortInterruptRefsReleased

(

)

Definition at line 472 of file fanout.cpp.

{
    HubSpinLockGuard Guard(&m_Mux.Lock);
    BOOLEAN Released = (m_Mux.InterruptReferences == 0);
 
    if (!Released)
        m_Mux.InterruptReleasePending = TRUE;
 
    m_Mux.FailInterruptAcquire = TRUE;
    return Released;
}

Referenced by HubMachine::PortInterruptRefsReleased().

Post()

VOID HubFdo::Post ( _In_ HubEvent  Event )

inline

Definition at line 194 of file fdo.h.

    {
        m_Machine.SmPost(Event);
    }

Referenced by DropHubResetReference(), DropInterruptReference(), DropPortPowerReference(), FinishDeviceFanOut(), HubMachine::GetConfigDescriptor(), HubMachine::GetHubDescriptor(), HubMachine::GetParentInfo(), HubMachine::GetRootHub20Ports(), HubMachine::GetRootHub30Ports(), HubMachine::GetRootHubInfo(), HubConfigurationComplete(), HubControlComplete(), HubEvtIoInternalDeviceControl(), HubInterruptComplete(), HubIoctlComplete(), HubIoGetPortStatus(), HubMailboxComplete(), HubMailboxTransfer(), HubParentInfoComplete(), HubPipeResetComplete(), HubResetComplete(), HubRootHubInfoComplete(), HubSendControl(), HubSendUcxIoctl(), QueuePowerDownToDevices(), QueuePowerUpToDevices(), QueuePowerUpToPorts(), QueueStatusChangeToPorts(), QueueStopToPorts(), QueueSuspendToPorts(), RequestHubReset(), HubMachine::ResetHub(), HubMachine::ResetStatusChangePipe(), ResumeInterruptTransfer(), HubMachine::SelectHubConfiguration(), HubMachine::StartStatusChangeRead(), TakePortPowerReference(), and HubMachine::UpdateControllerHubInfo().

PostToAllPorts()

VOID HubFdo::PostToAllPorts ( _In_ PortEvent  Event )

private

Definition at line 258 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
        CONTAINING_RECORD(Entry, HubPort, m_HubLink)->Post(Event);
}

Referenced by QueueSurpriseRemovalToPorts().

QueueFakeStatusChangeToPorts()

VOID HubFdo::QueueFakeStatusChangeToPorts

(

)

Definition at line 425 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
 
    if (m_Mux.PortCount == 0)
        DPRINT1("Hub %p status recheck with no ports will not finish\n", m_Device);
 
    m_Mux.OutstandingPortChanges = m_Mux.PortCount;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        Port->SetMuxFlag(PortMuxFlag::PortChangePending);
        Port->Post(PortEvent::StatusChanged);
    }
}

Referenced by HubMachine::QueueFakeStatusChangeToPorts().

QueuePowerDownToDevices()

VOID HubFdo::QueuePowerDownToDevices	(	_In_ DsmEvent	Event,
		_In_ HubDeviceFanOut	FanOut
	)

Definition at line 676 of file fanout.cpp.

{
    LIST_ENTRY FanOutList;
    PLIST_ENTRY Entry;
    HubChild* Child;
    LONG Counted = 0;
    BOOLEAN Any;
 
    InitializeListHead(&FanOutList);
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        m_Mux.FailDeviceRegistration = TRUE;
 
        for (Entry = m_Mux.Devices.Flink; Entry != &m_Mux.Devices; Entry = Entry->Flink)
        {
            Child = CONTAINING_RECORD(Entry, HubChild, m_HubLink);
 
            if (FanOut == HubDeviceFanOut::StopWhileSuspended ||
                (Child->m_MuxFlags & (ULONG)ChildMuxFlag::PowerReference))
            {
                Child->m_MuxFlags |= (ULONG)ChildMuxFlag::PnpOperationPending;
                Counted++;
            }
 
            WdfObjectReferenceWithTag(Child->m_Object, (PVOID)HubTagPnpPower);
            InsertTailList(&FanOutList, &Child->m_FanOutLink);
        }
 
        m_Mux.OutstandingPnpOperations = Counted;
        m_Mux.DeviceFanOut = (Counted != 0) ? FanOut : HubDeviceFanOut::None;
    }
 
    Any = !IsListEmpty(&FanOutList);
 
    while (!IsListEmpty(&FanOutList))
    {
        Entry = RemoveHeadList(&FanOutList);
        HubClearListEntry(Entry);
        Child = CONTAINING_RECORD(Entry, HubChild, m_FanOutLink);
 
        Child->Post(Event);
        WdfObjectDereferenceWithTag(Child->m_Object, (PVOID)HubTagPnpPower);
    }
 
    if (!Any || Counted == 0)
    {
        Post(FanOut == HubDeviceFanOut::StopWhileSuspended ? HubEvent::DevicesStoppedAfterSuspend
                                                           : HubEvent::DevicesReleased);
    }
}

Referenced by HubMachine::QueueStopAfterSuspendToDevices(), HubMachine::QueueStopToDevices(), and HubMachine::QueueSuspendToDevices().

QueuePowerUpToDevices()

VOID HubFdo::QueuePowerUpToDevices

(

_In_ DsmEvent

Event

)

Definition at line 733 of file fanout.cpp.

{
    LIST_ENTRY FanOutList;
    PLIST_ENTRY Entry;
    HubChild* Child;
    LONG Counted = 0;
 
    InitializeListHead(&FanOutList);
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        for (Entry = m_Mux.Devices.Flink; Entry != &m_Mux.Devices; Entry = Entry->Flink)
        {
            Child = CONTAINING_RECORD(Entry, HubChild, m_HubLink);
            if (!(Child->m_MuxFlags & (ULONG)ChildMuxFlag::Stopped))
                continue;
 
            Child->m_MuxFlags &= ~(ULONG)ChildMuxFlag::Stopped;
            Child->m_MuxFlags |= (ULONG)ChildMuxFlag::PnpOperationPending;
            WdfObjectReferenceWithTag(Child->m_Object, (PVOID)HubTagPnpPower);
            InsertTailList(&FanOutList, &Child->m_FanOutLink);
            Counted++;
        }
 
        m_Mux.OutstandingPnpOperations = Counted;
        m_Mux.DeviceFanOut = (Counted != 0) ? HubDeviceFanOut::PowerUp : HubDeviceFanOut::None;
    }
 
    if (Counted == 0)
    {
        Post(HubEvent::DevicesAcquired);
        return;
    }
 
    while (!IsListEmpty(&FanOutList))
    {
        Entry = RemoveHeadList(&FanOutList);
        HubClearListEntry(Entry);
        Child = CONTAINING_RECORD(Entry, HubChild, m_FanOutLink);
 
        Child->Post(Event);
        WdfObjectDereferenceWithTag(Child->m_Object, (PVOID)HubTagPnpPower);
    }
}

Referenced by HubMachine::QueueResumeInS0ToDevices(), HubMachine::QueueResumeToDevices(), HubMachine::QueueResumeWithResetToDevices(), and HubMachine::QueueStartToDevices().

QueuePowerUpToPorts()

VOID HubFdo::QueuePowerUpToPorts

(

_In_ PortEvent

Event

)

Definition at line 269 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        m_Mux.FailDeviceRegistration = FALSE;
        m_Mux.FailInterruptAcquire = FALSE;
    }
 
    if (m_Mux.PortCount == 0)
    {
        Post(HubEvent::PortsAcquired);
        return;
    }
 
    m_Mux.OutstandingPnpOperations = m_Mux.PortCount;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        Port->SetMuxFlag(PortMuxFlag::PnpOperationPending);
        Port->Post(Event);
    }
}

Referenced by HubMachine::QueueResumeInS0ToPorts(), HubMachine::QueueResumeToPorts(), HubMachine::QueueResumeWithResetToPorts(), and HubMachine::QueueStartToPorts().

QueueResetToPorts()

VOID HubFdo::QueueResetToPorts

(

)

Definition at line 361 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
 
    if (m_Mux.PortCount == 0)
        DPRINT1("Hub %p reset fan out with no ports will not finish\n", m_Device);
 
    InterlockedExchange(&m_Mux.HubResetInProgress, 1);
    m_Mux.OutstandingResetOperations = m_Mux.PortCount;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        Port->SetMuxFlag(PortMuxFlag::ResetPending);
        Port->Post(PortEvent::HubResetting);
    }
}

Referenced by HubMachine::QueueResetToPorts().

QueueStatusChangeToPorts()

VOID HubFdo::QueueStatusChangeToPorts

(

)

Definition at line 385 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
    LONG Expected;
    LONG Sent = 0;
 
    Expected = (LONG)RtlNumberOfSetBits(&m_Interrupt.Bitmap);
    if (Expected == 0)
    {
        m_Interrupt.LastInterruptWasEmpty = TRUE;
        Post(HubEvent::PortsEnableInterrupt);
        return;
    }
 
    m_Mux.OutstandingPortChanges = Expected;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        if (Port->Number() >= m_Interrupt.Bitmap.SizeOfBitMap ||
            !RtlCheckBit(&m_Interrupt.Bitmap, Port->Number()))
        {
            continue;
        }
 
        Port->SetMuxFlag(PortMuxFlag::PortChangePending);
        Port->Post(PortEvent::StatusChanged);
        Sent++;
    }
 
    if (Sent < Expected &&
        InterlockedExchangeAdd(&m_Mux.OutstandingPortChanges, -(Expected - Sent)) == Expected - Sent)
    {
        Post(HubEvent::PortsEnableInterrupt);
    }
}

Referenced by HubMachine::QueueStatusChangeToPorts().

QueueStopToPorts()

VOID HubFdo::QueueStopToPorts

(

)

Definition at line 300 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
    BOOLEAN NothingToWaitFor;
 
    if (m_Mux.PortCount == 0)
    {
        Post(HubEvent::PortsReleased);
        return;
    }
 
    m_Mux.OutstandingPnpOperations = m_Mux.PortPowerReferences;
    NothingToWaitFor = (m_Mux.OutstandingPnpOperations == 0);
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        if (Port->HasMuxFlag(PortMuxFlag::PowerReference))
            Port->SetMuxFlag(PortMuxFlag::PnpOperationPending);
        Port->Post(PortEvent::HubStopping);
    }
 
    if (NothingToWaitFor)
        Post(HubEvent::PortsReleased);
}

Referenced by HubMachine::QueueStopToPorts().

QueueSurpriseRemovalToPorts()

VOID HubFdo::QueueSurpriseRemovalToPorts

(

)

Definition at line 351 of file fanout.cpp.

{
    PostToAllPorts(PortEvent::HubRemoved);
 
    HubSpinLockGuard Guard(&m_Mux.Lock);
    m_Mux.FailDeviceRegistration = TRUE;
}

Referenced by HubMachine::QueueSurpriseRemovalToPorts().

QueueSuspendToPorts()

VOID HubFdo::QueueSuspendToPorts

(

)

Definition at line 329 of file fanout.cpp.

{
    PLIST_ENTRY Entry;
    HubPort* Port;
 
    if (m_Mux.PortCount == 0)
    {
        Post(HubEvent::PortsReleased);
        return;
    }
 
    m_Mux.OutstandingPnpOperations = m_Mux.PortCount;
 
    for (Entry = m_Mux.Ports.Flink; Entry != &m_Mux.Ports; Entry = Entry->Flink)
    {
        Port = CONTAINING_RECORD(Entry, HubPort, m_HubLink);
        Port->SetMuxFlag(PortMuxFlag::PnpOperationPending);
        Port->Post(PortEvent::HubSuspending);
    }
}

Referenced by HubMachine::QueueSuspendToPorts().

ReferenceDevicePower()

VOID HubFdo::ReferenceDevicePower

(

_In_ HubChild *

Child

)

Definition at line 783 of file fanout.cpp.

{
    BOOLEAN Completed;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        Child->m_MuxFlags &= ~((ULONG)ChildMuxFlag::PnpOperationPending | (ULONG)ChildMuxFlag::Stopped);
        Child->m_MuxFlags |= (ULONG)ChildMuxFlag::PowerReference;
        m_Mux.DevicePowerReferences++;
        Completed = (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0);
    }
 
    if (Completed)
        FinishDeviceFanOut();
}

Referenced by DeviceMachine::ReferenceDevicePower().

RegisterDevice()

BOOLEAN HubFdo::RegisterDevice

(

_In_ HubChild *

Child

)

A new device starts out holding a power reference.

Definition at line 586 of file fanout.cpp.

{
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        if (m_Mux.FailDeviceRegistration)
        {
            DPRINT("Hub %p refused device %p, hub is going down\n", m_Device, Child);
            return FALSE;
        }
 
        Child->m_MuxFlags |= (ULONG)ChildMuxFlag::PowerReference;
        m_Mux.DevicePowerReferences++;
        InsertTailList(&m_Mux.Devices, &Child->m_HubLink);
    }
 
    WdfObjectReferenceWithTag(Child->m_Object, (PVOID)HubTagRegistration);
    return TRUE;
}

Referenced by DeviceMachine::RegisterWithHub().

ReleasePowerReference()

VOID HubFdo::ReleasePowerReference

(

)

Definition at line 123 of file fdo.cpp.

{
    KIRQL OldIrql;
 
    if (!HasFlag(HubFlag::PowerReferencePending))
        return;
 
    KeRaiseIrql(DISPATCH_LEVEL, &OldIrql);
    WdfDeviceResumeIdle(m_Device);
    KeLowerIrql(OldIrql);
 
    ClearFlag(HubFlag::PowerReferencePending);
}

Referenced by HubMachine::ReleasePowerReference().

RequestHubReset()

BOOLEAN HubFdo::RequestHubReset

(

)

Only the first caller after AllowHubReset gets a reset posted.

Definition at line 452 of file fanout.cpp.

{
    BOOLEAN Queue;
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        Queue = m_Mux.HubResetEnabled;
        m_Mux.HubResetEnabled = FALSE;
    }
 
    if (Queue)
        Post(HubEvent::ResetRequested);
 
    return Queue;
}

Referenced by HubIoResetHub(), and PortMachine::RequestHubReset().

ResumeInterruptTransfer()

VOID HubFdo::ResumeInterruptTransfer

(

_In_ HubPort *

Port

)

Definition at line 573 of file fanout.cpp.

{
    Port->ClearMuxFlag(PortMuxFlag::PortChangePending);
 
    if (InterlockedDecrement(&m_Mux.OutstandingPortChanges) == 0)
        Post(HubEvent::PortsEnableInterrupt);
}

Referenced by PortMachine::ResumeInterruptTransfer().

SetFlag()

VOID HubFdo::SetFlag ( _In_ HubFlag  Flag )

inline

Definition at line 160 of file fdo.h.

    {
        InterlockedOr(&m_Flags, (LONG)Flag);
    }

Referenced by _IRQL_requires_(), HubParentInfoComplete(), if(), HubMachine::ParseHubDescriptor(), and HubMachine::UpdateControllerHubInfo().

TakeInterruptReference()

BOOLEAN HubFdo::TakeInterruptReference

(

_In_ HubPort *

Port

)

Definition at line 485 of file fanout.cpp.

{
    HubSpinLockGuard Guard(&m_Mux.Lock);
 
    if (m_Mux.FailInterruptAcquire)
        return FALSE;
 
    Port->SetMuxFlag(PortMuxFlag::InterruptReference);
    m_Mux.InterruptReferences++;
    return TRUE;
}

Referenced by PortMachine::TakeInterruptReference().

TakePortPowerReference()

VOID HubFdo::TakePortPowerReference

(

_In_ HubPort *

Port

)

Definition at line 532 of file fanout.cpp.

{
    Port->ClearMuxFlag(PortMuxFlag::PnpOperationPending);
    Port->SetMuxFlag(PortMuxFlag::PowerReference);
    InterlockedIncrement(&m_Mux.PortPowerReferences);
 
    if (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0)
        Post(HubEvent::PortsAcquired);
}

Referenced by PortMachine::TakePortPowerReference().

TimerFired()

VOID NTAPI HubFdo::TimerFired ( _In_ PVOID  Context )

staticprivate

Definition at line 1170 of file fdo.cpp.

{
    ((HubFdo*)Context)->Post(HubEvent::TimerFired);
}

UnregisterDevice()

VOID HubFdo::UnregisterDevice

(

_In_ HubChild *

Child

)

Definition at line 638 of file fanout.cpp.

{
    BOOLEAN Completed = FALSE;
 
    Child->ClearState(ChildState::ActivityIdSet);
 
    {
        HubSpinLockGuard Guard(&m_Mux.Lock);
 
        if (Child->m_MuxFlags & (ULONG)ChildMuxFlag::PowerReference)
        {
            m_Mux.DevicePowerReferences--;
            Child->m_MuxFlags &= ~(ULONG)ChildMuxFlag::PowerReference;
        }
 
        if (Child->m_MuxFlags & (ULONG)ChildMuxFlag::PnpOperationPending)
        {
            Child->m_MuxFlags &= ~(ULONG)ChildMuxFlag::PnpOperationPending;
            if (InterlockedDecrement(&m_Mux.OutstandingPnpOperations) == 0)
                Completed = TRUE;
        }
 
        RemoveEntryList(&Child->m_HubLink);
        HubClearListEntry(&Child->m_HubLink);
    }
 
    WdfObjectDereferenceWithTag(Child->m_Object, (PVOID)HubTagRegistration);
 
    if (Completed)
        FinishDeviceFanOut();
}

Referenced by DeviceMachine::UnregisterFromHub().

UsbDevice()

UCXUSBDEVICE HubFdo::UsbDevice ( ) const

inline

Definition at line 180 of file fdo.h.

    {
        return m_Parent.Hub;
    }

Referenced by _IRQL_requires_(), AllocateWorkItem(), DeviceMachine::CreateDefaultEndpoint(), DeviceMachine::CreateDeviceInController(), DeviceMachine::CreateEndpoints(), DeviceMachine::DeleteDefaultEndpoint(), DeviceMachine::DeleteDeviceInController(), PortMachine::DisconnectDevice(), for(), HubMachine::GetConfigDescriptor(), HubClearTtBuffer(), HubMailboxTransfer(), HubSendControl(), PortSendControl(), HubMachine::QueryControllerInfo(), DeviceMachine::ReleaseAddressZero(), HubMachine::ResetStatusChangePipe(), HubMachine::StartStatusChangeRead(), and HubMachine::UpdateControllerHubInfo().

Friends And Related Function Documentation

HubMachine

friend class HubMachine

friend

Definition at line 543 of file fdo.h.

Member Data Documentation

EvtArmWakeFromS0

NTSTATUS NTAPI HubFdo::EvtArmWakeFromS0

staticprivate

Definition at line 533 of file fdo.h.

EvtArmWakeFromSx

NTSTATUS NTAPI HubFdo::EvtArmWakeFromSx

staticprivate

Definition at line 535 of file fdo.h.

EvtCleanup

VOID NTAPI HubFdo::EvtCleanup

staticprivate

Definition at line 537 of file fdo.h.

EvtD0Entry

NTSTATUS NTAPI HubFdo::EvtD0Entry

staticprivate

Definition at line 529 of file fdo.h.

EvtD0Exit

NTSTATUS NTAPI HubFdo::EvtD0Exit

staticprivate

Definition at line 530 of file fdo.h.

EvtDestroy

VOID NTAPI HubFdo::EvtDestroy

staticprivate

Definition at line 538 of file fdo.h.

EvtDeviceAdd

NTSTATUS NTAPI HubFdo::EvtDeviceAdd

static

Definition at line 135 of file fdo.h.

EvtDisarmWakeFromS0

VOID NTAPI HubFdo::EvtDisarmWakeFromS0

staticprivate

Definition at line 534 of file fdo.h.

EvtDisarmWakeFromSx

VOID NTAPI HubFdo::EvtDisarmWakeFromSx

staticprivate

Definition at line 536 of file fdo.h.

EvtPrepareHardware

NTSTATUS NTAPI HubFdo::EvtPrepareHardware

staticprivate

Definition at line 527 of file fdo.h.

EvtReleaseHardware

NTSTATUS NTAPI HubFdo::EvtReleaseHardware

staticprivate

Definition at line 528 of file fdo.h.

EvtShutdown

NTSTATUS NTAPI HubFdo::EvtShutdown

staticprivate

Definition at line 539 of file fdo.h.

EvtSurpriseRemoval

VOID NTAPI HubFdo::EvtSurpriseRemoval

staticprivate

Definition at line 531 of file fdo.h.

EvtUsageNotification

VOID NTAPI HubFdo::EvtUsageNotification

staticprivate

Definition at line 532 of file fdo.h.

m_Capabilities

DEVICE_CAPABILITIES HubFdo::m_Capabilities

Definition at line 359 of file fdo.h.

m_ConfigDescriptor

PUSB_CONFIGURATION_DESCRIPTOR HubFdo::m_ConfigDescriptor

Definition at line 425 of file fdo.h.

Referenced by HubMachine::CacheConfigDescriptor(), HubMachine::ConfigDescriptorTruncated(), HubMachine::GetConfigDescriptor(), HubFindHubInterface(), HubMachine::SelectHubConfiguration(), and HubMachine::UpdateControllerHubInfo().

m_ConfigTotalLength

USHORT HubFdo::m_ConfigTotalLength

Definition at line 426 of file fdo.h.

Referenced by HubMachine::CacheConfigDescriptor(), and HubMachine::ConfigDescriptorTruncated().

m_ConfigurationHandle

USBD_CONFIGURATION_HANDLE HubFdo::m_ConfigurationHandle

Definition at line 430 of file fdo.h.

Referenced by HubConfigurationComplete().

m_Control

HubControlRequest HubFdo::m_Control

Definition at line 413 of file fdo.h.

Referenced by HubMachine::AckHubChange(), HubMachine::CacheConfigDescriptor(), HubMachine::GetConfigDescriptor(), HubMachine::GetHubDescriptor(), HubMachine::GetHubStatus(), HubMachine::GetPortStatus(), HubMachine::GetStandardStatus(), HubControlComplete(), HubMailboxComplete(), HubMailboxTransfer(), HubPipeResetComplete(), HubSendControl(), HubMachine::ResetStatusChangePipe(), and HubMachine::SetHubDepth().

m_ControllerInfo

UCXHUB_CONTROLLER_INFO_V2 HubFdo::m_ControllerInfo

Definition at line 371 of file fdo.h.

Referenced by HubMachine::QueryControllerInfo(), and HubMachine::QueryErrataFlags().

m_DescriptorRetryCount

USHORT HubFdo::m_DescriptorRetryCount

Definition at line 434 of file fdo.h.

Referenced by HubMachine::DescriptorRetriesExhausted(), and HubMachine::InitializeDescriptorRetries().

m_Device

WDFDEVICE HubFdo::m_Device

Definition at line 349 of file fdo.h.

Referenced by _IRQL_requires_(), _IRQL_requires_max_(), AcquirePowerReference(), AllocateWorkItem(), HubMachine::BugcheckBootHub(), HubChild::Create(), HubMachine::DereferenceHub(), DeviceMachine::DereferenceHubPower(), HubMachine::DescriptorRetriesExhausted(), Device(), DropInterruptReference(), DropPortPowerReference(), FinishDeviceFanOut(), HubMachine::GetRootHub20Ports(), HubMachine::GetRootHub30Ports(), HubMachine::GetRootHubInfo(), HubAcpiAllocate(), HubAddPort(), HubClearTtBuffer(), HubCreateParentRequest(), HubCreateUcxRequest(), HubIoCyclePort(), HubIoForward(), HubIoLockChild(), HubIoUnlockChildren(), HubParentInfoComplete(), PortMachine::HubPowerDrop(), PortMachine::HubPowerTake(), HubSendToParent(), if(), HubMachine::LogResetOnResume(), HubMachine::LogResetRecovery(), PortMachine::LostChange(), HubMachine::PipeResetLimitReached(), PortTrackPendingOperation(), QueueFakeStatusChangeToPorts(), QueueResetToPorts(), HubMachine::RecoveryLimitReached(), HubMachine::ReferenceHub(), DeviceMachine::ReferenceHubPower(), RegisterDevice(), ReleasePowerReference(), HubMachine::ReportFailureToPnp(), HubMachine::ResetLimitReached(), HubMachine::SignalPnpEvent(), HubMachine::SignalPnpFailure(), and HubMachine::StartStatusChangeRead().

m_DeviceStatus

USB_DEVICE_STATUS HubFdo::m_DeviceStatus

Definition at line 422 of file fdo.h.

Referenced by HubMachine::GetStandardStatus(), and HubMachine::ParsePowerStatus().

m_DromBuffer

PULONG HubFdo::m_DromBuffer

Definition at line 457 of file fdo.h.

Referenced by HubMachine::AllocateDromBuffer(), HubMachine::ReleaseDromBuffer(), HubMachine::StoreDromWord(), and HubMachine::UseDromHeaderBuffer().

m_DromHeader

ULONG HubFdo::m_DromHeader[4]

Definition at line 456 of file fdo.h.

Referenced by HubMachine::DromDataLength(), and HubMachine::UseDromHeaderBuffer().

m_DromLength

ULONG HubFdo::m_DromLength

Definition at line 459 of file fdo.h.

Referenced by HubMachine::AllocateDromBuffer(), HubMachine::ParseDromIdentity(), and HubMachine::ReleaseDromBuffer().

m_DromMailbox

ULONG HubFdo::m_DromMailbox

Definition at line 460 of file fdo.h.

Referenced by HubMailboxTransfer(), HubMachine::MailboxValue(), HubMachine::StoreDromWord(), and HubMachine::WriteDromRegister().

m_DromPool

PULONG HubFdo::m_DromPool

Definition at line 458 of file fdo.h.

Referenced by HubMachine::AllocateDromBuffer(), HubMachine::ParseDromIdentity(), and HubMachine::ReleaseDromBuffer().

m_FailureMessageId

ULONG HubFdo::m_FailureMessageId

Definition at line 402 of file fdo.h.

Referenced by HubControlComplete(), HubInterruptComplete(), PortMachine::NextChange(), HubMachine::RecoveryLimitReached(), HubMachine::ReportFailureToPnp(), and HubMachine::ResetLimitReached().

m_First20Port

USHORT HubFdo::m_First20Port

Definition at line 380 of file fdo.h.

Referenced by _IRQL_requires_().

m_First30Port

USHORT HubFdo::m_First30Port

Definition at line 382 of file fdo.h.

Referenced by _IRQL_requires_().

m_FirstRecoveryTime

LARGE_INTEGER HubFdo::m_FirstRecoveryTime

Definition at line 437 of file fdo.h.

Referenced by HubMachine::RecoveryLimitReached().

m_Flags

volatile LONG HubFdo::m_Flags

Definition at line 352 of file fdo.h.

Referenced by _IRQL_requires_max_(), ClearFlag(), HasFlag(), and SetFlag().

m_FwUpdateProtocol

ULONG HubFdo::m_FwUpdateProtocol

Definition at line 453 of file fdo.h.

Referenced by _IRQL_requires_(), and HubMachine::IsDromReadWanted().

m_HasUsb4Ports

BOOLEAN HubFdo::m_HasUsb4Ports

Definition at line 467 of file fdo.h.

Referenced by if().

union { ... } HubFdo::m_HubDescriptor

Referenced by _IRQL_requires_(), DeviceMachine::ComputeExitLatency(), HubMachine::GetHubDescriptor(), HubIoBuild20Descriptor(), HubIoGetHubInformationEx(), HubMakeUsb2StyleDescriptor(), HubPdoFillHubInfo(), HubMachine::ParseHubDescriptor(), DeviceMachine::SetIsochDelay(), DeviceMachine::SetSel(), and HubMachine::UpdateControllerHubInfo().

m_HubListEntry

LIST_ENTRY HubFdo::m_HubListEntry

Definition at line 404 of file fdo.h.

m_HubNumber

ULONG HubFdo::m_HubNumber

Definition at line 351 of file fdo.h.

Referenced by HubConnectorSetRootId(), and HubWmiQueryHubNode().

m_HubStatus

USB_HUB_STATUS_AND_CHANGE HubFdo::m_HubStatus

Definition at line 423 of file fdo.h.

Referenced by HubMachine::GetHubStatus(), HubMachine::OverCurrentCleared(), and HubMachine::SelectHubChange().

m_IdleTimeout

ULONG HubFdo::m_IdleTimeout

Definition at line 396 of file fdo.h.

m_IdleTimeoutSetting

PVOID HubFdo::m_IdleTimeoutSetting

Definition at line 397 of file fdo.h.

m_Interrupt

HubInterruptRequest HubFdo::m_Interrupt

Definition at line 414 of file fdo.h.

Referenced by _IRQL_requires_(), HubMachine::CancelStatusChangeRead(), HubMachine::CheckHubChangeBit(), HubConfigurationComplete(), HubInterruptComplete(), HubRootHubInfoComplete(), QueueStatusChangeToPorts(), HubMachine::ResetStatusChangePipe(), and HubMachine::StartStatusChangeRead().

m_InterruptMaxPacket

USHORT HubFdo::m_InterruptMaxPacket

Definition at line 429 of file fdo.h.

Referenced by _IRQL_requires_(), HubConfigurationComplete(), and HubMachine::StartStatusChangeRead().

m_Last20Port

USHORT HubFdo::m_Last20Port

Definition at line 381 of file fdo.h.

Referenced by _IRQL_requires_().

m_Last30Port

USHORT HubFdo::m_Last30Port

Definition at line 383 of file fdo.h.

Referenced by _IRQL_requires_().

m_LastResetPortStatus

ULONG HubFdo::m_LastResetPortStatus

Definition at line 438 of file fdo.h.

Referenced by HubMachine::LogResetRecovery(), and PortMachine::NextChange().

m_LifetimeRecoveryCount

ULONG HubFdo::m_LifetimeRecoveryCount

Definition at line 436 of file fdo.h.

Referenced by _IRQL_requires_(), and HubMachine::LogResetRecovery().

m_Machine

HubMachine HubFdo::m_Machine

Definition at line 347 of file fdo.h.

Referenced by Post().

m_MaxPortPower

ULONG HubFdo::m_MaxPortPower

Definition at line 384 of file fdo.h.

Referenced by HubIoGetHubCapabilities(), HubIoGetNodeInformation(), HubWmiQueryHubNode(), HubMachine::ParsePowerStatus(), DeviceMachine::SelectConfigValid(), and DeviceMachine::SetPdChargingPolicy().

m_Mux

HubMux HubFdo::m_Mux

Definition at line 407 of file fdo.h.

Referenced by _IRQL_requires_(), AllowHubReset(), ConfirmStopWhileSuspended(), DereferenceDevicePower(), DropHubResetReference(), DropInterruptReference(), DropPortPowerReference(), FindPort(), FinishDeviceFanOut(), HubAddPort(), InitializeMux(), IsHubResetInProgress(), MarkDevicesProgrammingLost(), PortInterruptRefsReleased(), PostToAllPorts(), QueueFakeStatusChangeToPorts(), QueuePowerDownToDevices(), QueuePowerUpToDevices(), QueuePowerUpToPorts(), QueueResetToPorts(), HubMachine::QueueStartToPorts(), QueueStatusChangeToPorts(), QueueStopToPorts(), QueueSurpriseRemovalToPorts(), QueueSuspendToPorts(), ReferenceDevicePower(), RegisterDevice(), RequestHubReset(), ResumeInterruptTransfer(), TakeInterruptReference(), TakePortPowerReference(), and UnregisterDevice().

m_NeedsForwardProgress

BOOLEAN HubFdo::m_NeedsForwardProgress

Definition at line 412 of file fdo.h.

Referenced by NeedsForwardProgress(), and HubMachine::QueuePassiveWork().

m_OnHubList

BOOLEAN HubFdo::m_OnHubList

Definition at line 405 of file fdo.h.

m_Parent

UCXHUB_PARENT_INTERFACE HubFdo::m_Parent

Definition at line 355 of file fdo.h.

Referenced by _IRQL_requires_(), HubMachine::GetHubDescriptor(), HubBuildDescContext(), HubConnectorCopyParentId(), HubFindHubInterface(), HubIoBuild20Descriptor(), HubIoGetConnectionInformationV2(), HubIoGetHubCapabilities(), HubIoGetHubInformationEx(), HubMakeUsb2StyleDescriptor(), HubPdoEvtParentInterfaceQuery(), HubPdoFillHubInfo(), HubPdoTopologyAddress(), HubWmiQueryDeviceNode(), HubWmiQueryHubNode(), if(), HubMachine::IsDromReadWanted(), IsRootHub(), HubMachine::ParseHubDescriptor(), HubMachine::SetHubDepth(), DeviceMachine::SetSel(), HubMachine::UpdateControllerHubInfo(), UsbDevice(), and HubMachine::WasResetByParent().

m_ParentInfo

HubParentInfo HubFdo::m_ParentInfo

Definition at line 360 of file fdo.h.

Referenced by _IRQL_requires_(), DeviceMachine::ComputeExitLatency(), HubMachine::GetParentInfo(), HubBuildDescContext(), HubConfigurationComplete(), HubIoGetHubCapabilities(), HubParentInfoComplete(), HubPdoFillHubInfo(), HubRootHubInfoComplete(), if(), HubMachine::QueryErrataFlags(), DeviceMachine::SetIsochDelay(), and DeviceMachine::SetSel().

m_PipeUrb

struct _URB_PIPE_REQUEST HubFdo::m_PipeUrb

Definition at line 365 of file fdo.h.

Referenced by HubPipeResetComplete(), and HubMachine::ResetStatusChangePipe().

m_PnpEvent

KEVENT HubFdo::m_PnpEvent

Definition at line 388 of file fdo.h.

Referenced by HubMachine::SignalPnpEvent(), and HubMachine::SignalPnpFailure().

m_PnpStatus

NTSTATUS HubFdo::m_PnpStatus

Definition at line 389 of file fdo.h.

Referenced by HubMachine::SignalPnpEvent(), and HubMachine::SignalPnpFailure().

m_PortCount

ULONG HubFdo::m_PortCount

Definition at line 379 of file fdo.h.

Referenced by _IRQL_requires_(), HubIoBuild20Descriptor(), HubIoGetHubInformationEx(), HubIoValidate(), HubMakeUsb2StyleDescriptor(), HubWmiQueryHubNode(), HubMachine::ParseHubDescriptor(), and HubMachine::UpdateControllerHubInfo().

m_PortStatusRequest

WDFREQUEST HubFdo::m_PortStatusRequest

Definition at line 392 of file fdo.h.

Referenced by HubEvtIoInternalDeviceControl(), HubIoGetPortStatus(), and HubTakePortStatusRequest().

m_PortStatusTarget

HubPort* HubFdo::m_PortStatusTarget

Definition at line 393 of file fdo.h.

Referenced by HubMachine::FailPortStatus(), HubMachine::GetPortStatus(), HubEvtIoInternalDeviceControl(), HubIoGetPortStatus(), and HubMachine::ReplyPortStatus().

m_PowerState

WDF_POWER_DEVICE_STATE HubFdo::m_PowerState

Definition at line 399 of file fdo.h.

m_PreviousHubStatus

USB_HUB_STATUS_AND_CHANGE HubFdo::m_PreviousHubStatus

Definition at line 424 of file fdo.h.

Referenced by HubMachine::GetHubStatus().

m_RecoveryCount

ULONG HubFdo::m_RecoveryCount

Definition at line 435 of file fdo.h.

Referenced by HubMachine::RecoveryLimitReached().

m_ResetCount

USHORT HubFdo::m_ResetCount

Definition at line 433 of file fdo.h.

Referenced by HubMachine::ClearPipeResetCount(), HubMachine::InitializeResetCount(), HubMachine::PipeResetLimitReached(), and HubMachine::ResetLimitReached().

m_ResetFlags

ULONG HubFdo::m_ResetFlags

Definition at line 364 of file fdo.h.

Referenced by HubResetComplete(), and HubMachine::ResetHub().

m_Root20Ports

PROOTHUB_20PORT_INFO* HubFdo::m_Root20Ports

Definition at line 375 of file fdo.h.

Referenced by _IRQL_requires_(), and HubMachine::GetRootHub20Ports().

m_Root30Ports

PROOTHUB_30PORT_INFO_EX* HubFdo::m_Root30Ports

Definition at line 376 of file fdo.h.

Referenced by _IRQL_requires_(), and HubMachine::GetRootHub30Ports().

m_RootHubInfo

UCXHUB_ROOTHUB_INFO HubFdo::m_RootHubInfo

Definition at line 374 of file fdo.h.

Referenced by _IRQL_requires_(), HubMachine::GetRootHub20Ports(), HubMachine::GetRootHub30Ports(), HubMachine::GetRootHubInfo(), and HubRootHubInfoComplete().

m_RootHubTarget

WDFIOTARGET HubFdo::m_RootHubTarget

Definition at line 368 of file fdo.h.

Referenced by _IRQL_requires_(), HubMachine::GetConfigDescriptor(), HubClearTtBuffer(), HubMailboxTransfer(), HubParentInfoComplete(), HubSendControl(), PortSendControl(), and HubMachine::UpdateControllerHubInfo().

m_RouterIdentity

HubRouterIdentity HubFdo::m_RouterIdentity

Definition at line 461 of file fdo.h.

Referenced by _IRQL_requires_(), and HubMachine::ParseDromIdentity().

m_SelectedChange

HubChange HubFdo::m_SelectedChange

Definition at line 428 of file fdo.h.

Referenced by HubMachine::PendingHubChange(), and HubMachine::SelectHubChange().

m_SelectedFeature

USHORT HubFdo::m_SelectedFeature

Definition at line 427 of file fdo.h.

Referenced by HubMachine::AckHubChange(), and HubMachine::SelectHubChange().

m_SelectiveSuspendSetting

PVOID HubFdo::m_SelectiveSuspendSetting

Definition at line 398 of file fdo.h.

m_SspIsochBurstCount

ULONG HubFdo::m_SspIsochBurstCount

Definition at line 385 of file fdo.h.

Referenced by _IRQL_requires_().

m_Stack

UCXHUB_STACK_INTERFACE HubFdo::m_Stack

Definition at line 356 of file fdo.h.

Referenced by _IRQL_requires_(), AllocateWorkItem(), DeviceMachine::CreateDefaultEndpoint(), DeviceMachine::CreateDeviceInController(), DeviceMachine::CreateEndpoints(), DeviceMachine::DeleteDefaultEndpoint(), DeviceMachine::DeleteDeviceInController(), PortMachine::DisconnectDevice(), EnqueueWorkItem(), for(), HubClearTtBuffer(), HubTtClearComplete(), HubMachine::QueryControllerInfo(), and DeviceMachine::ReleaseAddressZero().

m_StreamsSupported

BOOLEAN HubFdo::m_StreamsSupported

Definition at line 361 of file fdo.h.

m_SymbolicLinkName

UNICODE_STRING HubFdo::m_SymbolicLinkName

Definition at line 441 of file fdo.h.

Referenced by HubWmiHubName().

m_Timer

HubTimer HubFdo::m_Timer

Definition at line 410 of file fdo.h.

Referenced by HubMachine::ArmOverCurrentTimer(), HubMachine::ArmResetRetryTimer(), and HubMachine::StartDescriptorRetryTimer().

m_TunneledDevicesSkipU2

BOOLEAN HubFdo::m_TunneledDevicesSkipU2

Definition at line 470 of file fdo.h.

Referenced by if().

m_Usb4HostName

WDFSTRING HubFdo::m_Usb4HostName

Definition at line 464 of file fdo.h.

m_Usb4Hosts

WDFCOLLECTION HubFdo::m_Usb4Hosts

Definition at line 473 of file fdo.h.

Referenced by _IRQL_requires_(), HubUsb4FindHost(), and HubUsb4HostAt().

m_Usb4HostsLock

WDFWAITLOCK HubFdo::m_Usb4HostsLock

Definition at line 474 of file fdo.h.

Referenced by _IRQL_requires_(), HubUsb4InterfaceChange(), HubUsb4OpenWorkItem(), and HubUsb4TargetRemoveComplete().

m_Usb4Notification

PVOID HubFdo::m_Usb4Notification

Definition at line 477 of file fdo.h.

m_Usbdi

USB_BUS_INTERFACE_USBDI_V3 HubFdo::m_Usbdi

Definition at line 357 of file fdo.h.

Referenced by if().

m_VerifierFlags

ULONG HubFdo::m_VerifierFlags

Definition at line 443 of file fdo.h.

Referenced by HubMachine::QueryErrataFlags().

m_WdmPdo

PDEVICE_OBJECT HubFdo::m_WdmPdo

Definition at line 350 of file fdo.h.

m_WmiInstance

WDFWMIINSTANCE HubFdo::m_WmiInstance

Definition at line 448 of file fdo.h.

Referenced by _IRQL_requires_(), and HubWmiFirePortEvent().

m_WorkItem

PUCXHUB_WORKITEM HubFdo::m_WorkItem

Definition at line 411 of file fdo.h.

Referenced by HubMachine::QueuePassiveWork().

MachineWorkItem

VOID NTAPI HubFdo::MachineWorkItem

staticprivate

Definition at line 541 of file fdo.h.

Referenced by HubMachine::QueuePassiveWork().

PowerSettingChanged

NTSTATUS NTAPI HubFdo::PowerSettingChanged

staticprivate

Definition at line 540 of file fdo.h.

Usb20

USB_HUB_DESCRIPTOR HubFdo::Usb20

Definition at line 419 of file fdo.h.

Referenced by HubMachine::GetHubDescriptor(), HubIoBuild20Descriptor(), HubIoGetHubInformationEx(), HubMakeUsb2StyleDescriptor(), HubMachine::ParseHubDescriptor(), and HubMachine::UpdateControllerHubInfo().

Usb30

USB_30_HUB_DESCRIPTOR HubFdo::Usb30

Definition at line 420 of file fdo.h.

Referenced by DeviceMachine::ComputeExitLatency(), HubMachine::GetHubDescriptor(), HubIoBuild20Descriptor(), HubIoGetHubInformationEx(), HubMakeUsb2StyleDescriptor(), HubPdoFillHubInfo(), HubMachine::ParseHubDescriptor(), DeviceMachine::SetIsochDelay(), and DeviceMachine::SetSel().

What

_In_ PCSTR HubFdo::What

Definition at line 205 of file fdo.h.

---

The documentation for this class was generated from the following files:

• drivers/usb/usbhub3/fdo.h
• drivers/usb/usbhub3/fanout.cpp
• drivers/usb/usbhub3/fdo.cpp