UcxController Class Reference

#include <hostctl.h>

Collaboration diagram for UcxController:

Public Member Functions
VOID	NeedsReset ()
VOID	ResetComplete (_In_ PUCX_CONTROLLER_RESET_COMPLETE_INFO Info)
VOID	SetFailed ()
NTSTATUS	SetIdStrings (_In_ PUNICODE_STRING Manufacturer, _In_ PUNICODE_STRING ModelName, _In_ PUNICODE_STRING ModelNumber)
VOID	NotifyTransportCharacteristicsChange (_In_ PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS Characteristics)
BOOLEAN	BlockReset ()
VOID	UnblockReset ()
VOID	MarkResetInProgress ()
VOID	MarkResetFinished ()
BOOLEAN	IsResetInProgress () const
BOOLEAN	HasFailed () const
NTSTATUS	GetCurrentFrameNumber (_Out_ PULONG FrameNumber)
BOOLEAN	QueryClearTtBufferOnCancel ()
BOOLEAN	QueryStreamsSupported ()
VOID	PostResetEvent (_In_ CrEvent Event)
VOID	PrepareDevicesForReset ()
VOID	NotifyDevicesResetDone ()
VOID	PrepareForResetOperationDone ()
VOID	WalkDevices (_In_ PFN_UCX_DEVICE_VISITOR Visitor, _In_opt_ PVOID Context, _In_ BOOLEAN IncludeDisconnected)
VOID	Address0Release (_In_ UCXUSBDEVICE Hub)
NTSTATUS	StopIdle (_Inout_ PUCXHUB_STOP_IDLE_CONTEXT Context)
VOID	ResumeIdle (_Inout_ PUCXHUB_STOP_IDLE_CONTEXT Context)
VOID	GetInfo (_Out_ PVOID Info, _In_ BOOLEAN Grown)
	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS EnableForwardProgress(_In_ PUCXHUB_FORWARD_PROGRESS_INFO Info)
VOID	QueueOnWorkerThread (_In_ UcxWorkItem *WorkItem)
BOOLEAN	HasWorkerThread () const
PFN_UCX_HCD_GET_BANDWIDTH_INFORMATION	HcdGetBandwidthInformation () const
PFN_UCX_HCD_ENABLE_FORWARD_PROGRESS	HcdEnableForwardProgress () const
PFN_UCX_HCD_GET_DUMP_DATA	HcdGetDumpData () const
PFN_UCX_HCD_FREE_DUMP_DATA	HcdFreeDumpData () const

Static Public Member Functions
static _Must_inspect_result_ NTSTATUS	Create (_In_ PUCX_DRIVER_GLOBALS Globals, _In_ WDFDEVICE Device, _In_ PUCX_CONTROLLER_CONFIG Config, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXCONTROLLER *Controller)
static UcxController *	FromHandle (_In_ UCXCONTROLLER Handle)
static UcxController *	FromFdo (_In_ WDFDEVICE Fdo)

Public Attributes
UCXCONTROLLER	m_Handle
WDFDEVICE	m_Fdo
UCX_CONTROLLER_CONFIG	m_Config
LIST_ENTRY	m_DriverListEntry
WDFQUEUE	m_Address0Queue
WDFQUEUE	m_DeviceMgmtQueue
WDFQUEUE	m_TreePurgeQueue
WDFQUEUE	m_PendDuringResetQueue
WDFQUEUE	m_DefaultQueue
WDFSTRING	m_HostControllerInterfaceName
UcxRootHub *	m_RootHub
DEVICE_CAPABILITIES	m_HcCaps
IO_CSQ	m_AbortPipeCsq
KSPIN_LOCK	m_AbortPipeCsqLock
KSPIN_LOCK	m_TopologyLock
ULONG	m_ChildDeviceCount
ULONG	m_ChildEndpointCount
ControllerResetMachine	m_ResetMachine
BOOLEAN	m_ResetMachineReady
UcxWorkItem *	m_ResetMachineWorkItem
KEVENT	m_RootHubMayExitD0
KEVENT	m_ResetCompleteProcessed
LONG	m_DeviceContextsLost
LONG	m_RootHubResetSeen
BOOLEAN	m_WaitOnResetComplete
BOOLEAN	m_RootHubInD0
KSPIN_LOCK	m_ResetLock
ULONG	m_ResetGeneration
LONG	m_ResetBlockCount
BOOLEAN	m_ResetInProgress
BOOLEAN	m_ResetInitiated
LONG	m_Failed
LONG	m_PendingPrepareForReset
ULONG	m_CachedFrameNumber
ULONG	m_SyntheticFrame
BOOLEAN	m_DriverVerifierEnabled
BOOLEAN	m_ClearTtBufferOnAsyncCancel
KSPIN_LOCK	m_WorkerLock
LIST_ENTRY	m_WorkerItems
PKTHREAD	m_WorkerThread
KEVENT	m_WorkerWake
BOOLEAN	m_WorkerParked
BOOLEAN	m_WorkerExit
KMUTEX	m_ForwardProgressMutex
BOOLEAN	m_HcdReservedIoReady
LONG	m_UsbdInterfaceCount
WDFREQUEST	m_PendingTreePurge
LONG	m_PendingTreePurgeEndpoints
UNICODE_STRING	m_ManufacturerName
UNICODE_STRING	m_ModelName
UNICODE_STRING	m_ModelNumber

Private Member Functions
NTSTATUS	Initialize (_In_ PUCX_DRIVER_GLOBALS Globals, _In_ WDFDEVICE Fdo, _In_ const UCX_CONTROLLER_CONFIG *Config)
NTSTATUS	CreateQueues ()
NTSTATUS	QueryHcCapabilities ()
NTSTATUS	RegisterWmi ()
VOID	Destroy ()
NTSTATUS	StartWorkerThread ()

Static Private Attributes
static EVT_WDF_OBJECT_CONTEXT_DESTROY	EvtDestroy
static KSTART_ROUTINE	WorkerThreadRoutine
static UCXHUB_WORKITEM_ROUTINE	ResetMachinePassiveRoutine

Friends
class	ControllerResetMachine

Detailed Description

Definition at line 112 of file hostctl.h.

Member Function Documentation

_IRQL_requires_()

UcxController::_IRQL_requires_

(

PASSIVE_LEVEL

)

Address0Release()

VOID UcxController::Address0Release

(

_In_ UCXUSBDEVICE

Hub

)

Definition at line 647 of file hostctl.cpp.

{
    UcxAddress0QueueContext* Context = UcxGetAddress0QueueContext(m_Address0Queue);
 
    /* A mismatched hub is only a checked build complaint; the release still happens */
    NT_ASSERT(Context->OwnerHub == Hub);
    UNREFERENCED_PARAMETER(Hub);
 
    Context->OwnerHub = NULL;
    Context->OwnerDevice = NULL;
 
    WdfIoQueueStart(m_Address0Queue);
}

Referenced by UcxHubAddress0Release().

BlockReset()

BOOLEAN UcxController::BlockReset

(

)

Definition at line 507 of file hostctl.cpp.

{
    InterlockedIncrement(&m_ResetBlockCount);
 
    if (m_ResetInProgress)
    {
        UnblockReset();
        return FALSE;
    }
 
    return TRUE;
}

Referenced by GetCurrentFrameNumber(), and UcxRootHub::PortChanged().

Create()

_Must_inspect_result_ NTSTATUS UcxController::Create ( _In_ PUCX_DRIVER_GLOBALS  Globals, _In_ WDFDEVICE  Device, _In_ PUCX_CONTROLLER_CONFIG  Config, _In_opt_ PWDF_OBJECT_ATTRIBUTES  Attributes, _Out_ UCXCONTROLLER *  Controller  )

static

Definition at line 41 of file hostctl.cpp.

{
    UCX_CONTROLLER_CONFIG FullConfig;
    WDF_OBJECT_ATTRIBUTES FdoAttributes;
    WDF_OBJECT_ATTRIBUTES UcxAttributes;
    PWDF_OBJECT_ATTRIBUTES Primary;
    UcxFdoContext* FdoContext;
    UcxController* Context;
    WDFOBJECT Object;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    if (Controller == NULL || Config == NULL || !UcxIsAcceptedConfigSize(Config->Size))
    {
        DPRINT1("Controller create rejected, config %p size %lu\n", Config, Config != NULL ? Config->Size : 0);
        return STATUS_INVALID_PARAMETER;
    }
 
    /* The two dump callbacks come as a pair */
    if ((Config->Reserved3 == NULL) != (Config->Reserved4 == NULL))
    {
        DPRINT1("Controller create rejected, only one dump callback given\n");
        return STATUS_INVALID_PARAMETER;
    }
 
    if (Attributes != NULL && Attributes->ParentObject != NULL)
    {
        DPRINT1("Controller create rejected, HCD attributes name a parent\n");
        return STATUS_INVALID_PARAMETER;
    }
 
    /* Older configs are upgraded: fields the HCD did not know about stay zero */
    UCX_CONTROLLER_CONFIG_INIT(&FullConfig, "");
    RtlCopyMemory(&FullConfig, Config, Config->Size);
    FullConfig.Size = sizeof(FullConfig);
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&FdoAttributes, UcxFdoContext);
    Status = WdfObjectAllocateContext(Device, &FdoAttributes, (PVOID*)&FdoContext);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller FDO %p context allocation failed 0x%lx\n", Device, Status);
        return Status;
    }
 
    *Controller = NULL;
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&UcxAttributes, UcxController);
    UcxAttributes.EvtDestroyCallback = UcxController::EvtDestroy;
 
    /* The HCD's attributes come first when given; parent and level are UCX's choice */
    Primary = (Attributes != NULL) ? Attributes : &UcxAttributes;
    Primary->ParentObject = Device;
    Primary->ExecutionLevel = WdfExecutionLevelPassive;
 
    Status = UcxCreateObjectWithTwoContexts(Primary,
                                            (Attributes != NULL) ? &UcxAttributes : NULL,
                                            &Object);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Context = new (UcxGetControllerContext(Object)) UcxController();
    Context->m_Handle = (UCXCONTROLLER)Object;
    FdoContext->Controller = Context;
 
    Status = Context->Initialize(Globals, Device, &FullConfig);
    if (!NT_SUCCESS(Status))
    {
        WdfObjectDelete(Object);
        return Status;
    }
 
    *Controller = Context->m_Handle;
    DPRINT("Controller %p created on FDO %p, bus type %d\n", Context, Device, FullConfig.ParentBusType);
    return STATUS_SUCCESS;
}

Referenced by UcxApiControllerCreate().

CreateQueues()

NTSTATUS UcxController::CreateQueues ( )

private

Definition at line 58 of file hostqueues.cpp.

{
    WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Reserved;
    WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Examine;
    NTSTATUS Status;
 
    /* One reserved request, always used when allocation fails */
    WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_DEFAULT_INIT(&Reserved, 1);
    WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_EXAMINE_INIT(&Examine, 1, UcxEvtDefaultQueueExamineIrp);
 
    Status = UcxCreateControllerQueue(this,
                                      WdfIoQueueDispatchSequential,
                                      1,
                                      UcxEvtAddress0IoInternalDeviceControl,
                                      WDF_GET_CONTEXT_TYPE_INFO(UcxAddress0QueueContext),
                                      &Reserved,
                                      &m_Address0Queue);
    if (!NT_SUCCESS(Status))
        return Status;
 
    UcxGetAddress0QueueContext(m_Address0Queue)->Controller = this;
 
    Status = UcxCreateControllerQueue(this,
                                      WdfIoQueueDispatchParallel,
                                      m_Config.NumberOfPresentedDeviceMgmtEvtCallbacks,
                                      UcxEvtDeviceMgmtIoInternalDeviceControl,
                                      NULL,
                                      &Reserved,
                                      &m_DeviceMgmtQueue);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Status = UcxCreateControllerQueue(this,
                                      WdfIoQueueDispatchSequential,
                                      1,
                                      UcxEvtTreePurgeIoInternalDeviceControl,
                                      NULL,
                                      &Reserved,
                                      &m_TreePurgeQueue);
    if (!NT_SUCCESS(Status))
        return Status;
 
    Status = UcxCreateControllerQueue(this,
                                      WdfIoQueueDispatchParallel,
                                      MAXULONG,
                                      UcxEvtPendDuringResetIoInternalDeviceControl,
                                      NULL,
                                      NULL,
                                      &m_PendDuringResetQueue);
    if (!NT_SUCCESS(Status))
        return Status;
 
    return UcxCreateControllerQueue(this,
                                    WdfIoQueueDispatchParallel,
                                    MAXULONG,
                                    UcxEvtDefaultIoInternalDeviceControl,
                                    NULL,
                                    &Examine,
                                    &m_DefaultQueue);
}

Referenced by Initialize().

Destroy()

VOID UcxController::Destroy ( )

private

Definition at line 364 of file hostctl.cpp.

{
    if (m_WorkerThread != NULL)
    {
        {
            SpinLockGuard Guard(&m_WorkerLock);
 
            m_WorkerExit = TRUE;
            KeSetEvent(&m_WorkerWake, IO_NO_INCREMENT, FALSE);
        }
 
        KeWaitForSingleObject(m_WorkerThread, Executive, KernelMode, FALSE, NULL);
        ObDereferenceObject(m_WorkerThread);
        m_WorkerThread = NULL;
    }
 
    if (m_ResetMachineWorkItem != NULL)
    {
        m_ResetMachineWorkItem->Free();
        m_ResetMachineWorkItem = NULL;
    }
    m_ResetMachineReady = FALSE;
 
    NT_ASSERT(m_UsbdInterfaceCount == 0);
 
    /* A create that failed early never linked the entry */
    {
        SpinLockGuard Guard(&UcxDriver.ControllerListLock);
 
        if (UcxIsListEntryLinked(&m_DriverListEntry))
        {
            RemoveEntryList(&m_DriverListEntry);
            UcxDriver.ControllerCount--;
        }
        UcxClearListEntry(&m_DriverListEntry);
    }
 
    if (m_HostControllerInterfaceName != NULL)
    {
        WdfObjectDereferenceWithTag(m_HostControllerInterfaceName, (PVOID)UCX_POOL_TAG);
        m_HostControllerInterfaceName = NULL;
    }
 
    UcxFreeIdString(&m_ManufacturerName);
    UcxFreeIdString(&m_ModelName);
    UcxFreeIdString(&m_ModelNumber);
}

FromFdo()

UcxController * UcxController::FromFdo ( _In_ WDFDEVICE  Fdo )

static

Definition at line 21 of file hostctl.cpp.

{
    return UcxGetFdoContext(Fdo)->Controller;
}

Referenced by UcxEvtDefaultIoInternalDeviceControl(), UcxEvtTreePurgeIoInternalDeviceControl(), UcxEvtWmiNodeInfoQueryInstance(), and UcxHandleUserRequest().

FromHandle()

UcxController * UcxController::FromHandle ( _In_ UCXCONTROLLER  Handle )

static

Definition at line 14 of file hostctl.cpp.

{
    return UcxGetControllerContext(Handle);
}

Referenced by UcxRootHub::Create(), UcxUsbDevice::Create(), UcxApiControllerNeedsReset(), UcxApiControllerNotifyTransportCharacteristicsChange(), UcxApiControllerResetComplete(), UcxApiControllerSetFailed(), and UcxApiControllerSetIdStrings().

GetCurrentFrameNumber()

NTSTATUS UcxController::GetCurrentFrameNumber

(

_Out_ PULONG

FrameNumber

)

Definition at line 564 of file hostctl.cpp.

{
    NTSTATUS Status;
    ULONG Frame;
 
    if (m_Config.EvtControllerGetCurrentFrameNumber == NULL)
    {
        DPRINT1("Controller %p has no frame number callback\n", this);
        NT_ASSERT(FALSE);
        return STATUS_NOT_SUPPORTED;
    }
 
    if (!BlockReset())
    {
        *FrameNumber = m_CachedFrameNumber;
        return STATUS_SUCCESS;
    }
 
    Frame = m_CachedFrameNumber;
    Status = m_Config.EvtControllerGetCurrentFrameNumber(m_Handle, &Frame);
    UnblockReset();
 
    if (!NT_SUCCESS(Status))
    {
        /* The caller still gets whatever the HCD left in the buffer */
        DPRINT1("Controller %p frame number query failed 0x%lx\n", this, Status);
    }
    else if (Frame == MAXULONG)
    {
        /* All ones means the HCD is not in D0; report the cached frame */
        DPRINT("Controller %p has no frame number, reporting cached frame %lu\n", this, m_CachedFrameNumber);
        Frame = m_CachedFrameNumber;
    }
    else
    {
        m_CachedFrameNumber = Frame;
    }
 
    *FrameNumber = Frame;
    return Status;
}

Referenced by UcxBusQueryBusTime().

GetInfo()

VOID UcxController::GetInfo	(	_Out_ PVOID	Info,
		_In_ BOOLEAN	Grown
	)

Grown is TRUE for hubs that asked for the larger stack interface; they expect the V2 layout.

Definition at line 692 of file hostctl.cpp.

{
    PUCX_CONTROLLER_PCI_INFORMATION Pci;
    PUCX_CONTROLLER_ACPI_INFORMATION Acpi;
 
    if (Grown)
    {
        PUCXHUB_CONTROLLER_INFO_V2 Out = (PUCXHUB_CONTROLLER_INFO_V2)Info;
 
        RtlZeroMemory(Out, sizeof(*Out));
        Out->Type = m_Config.ParentBusType;
        Pci = &Out->Pci;
        Acpi = &Out->Acpi;
    }
    else
    {
        PUCXHUB_CONTROLLER_INFO Out = (PUCXHUB_CONTROLLER_INFO)Info;
 
        RtlZeroMemory(Out, sizeof(*Out));
        Out->Type = m_Config.ParentBusType;
        Pci = &Out->Pci;
        Acpi = &Out->Acpi;
    }
 
    if (m_Config.ParentBusType == UcxControllerParentBusTypePci)
        *Pci = m_Config.PciDeviceInfo;
    else if (m_Config.ParentBusType == UcxControllerParentBusTypeAcpi)
        *Acpi = m_Config.AcpiDeviceInfo;
}

HasFailed()

BOOLEAN UcxController::HasFailed ( ) const

inline

Definition at line 180 of file hostctl.h.

    {
        return m_Failed != 0;
    }

HasWorkerThread()

BOOLEAN UcxController::HasWorkerThread ( ) const

inline

Definition at line 255 of file hostctl.h.

    {
        return m_WorkerThread != NULL;
    }

HcdEnableForwardProgress()

PFN_UCX_HCD_ENABLE_FORWARD_PROGRESS UcxController::HcdEnableForwardProgress ( ) const

inline

Definition at line 269 of file hostctl.h.

    {
        return (PFN_UCX_HCD_ENABLE_FORWARD_PROGRESS)m_Config.Reserved2;
    }

Referenced by _IRQL_requires_().

HcdFreeDumpData()

PFN_UCX_HCD_FREE_DUMP_DATA UcxController::HcdFreeDumpData ( ) const

inline

Definition at line 281 of file hostctl.h.

    {
        return (PFN_UCX_HCD_FREE_DUMP_DATA)m_Config.Reserved4;
    }

HcdGetBandwidthInformation()

PFN_UCX_HCD_GET_BANDWIDTH_INFORMATION UcxController::HcdGetBandwidthInformation ( ) const

inline

Definition at line 263 of file hostctl.h.

    {
        return (PFN_UCX_HCD_GET_BANDWIDTH_INFORMATION)m_Config.Reserved1;
    }

HcdGetDumpData()

PFN_UCX_HCD_GET_DUMP_DATA UcxController::HcdGetDumpData ( ) const

inline

Definition at line 275 of file hostctl.h.

    {
        return (PFN_UCX_HCD_GET_DUMP_DATA)m_Config.Reserved3;
    }

Initialize()

NTSTATUS UcxController::Initialize ( _In_ PUCX_DRIVER_GLOBALS  Globals, _In_ WDFDEVICE  Fdo, _In_ const UCX_CONTROLLER_CONFIG *  Config  )

private

Definition at line 124 of file hostctl.cpp.

{
    PDEVICE_OBJECT FdoObject;
    NTSTATUS Status;
 
    m_Fdo = Fdo;
    m_Config = *Config;
    UcxClearListEntry(&m_DriverListEntry);
 
    KeInitializeSpinLock(&m_TopologyLock);
    m_ChildDeviceCount = 0;
    m_ChildEndpointCount = 0;
 
    FdoObject = WdfDeviceWdmGetDeviceObject(Fdo);
 
    m_ResetMachineWorkItem = UcxWorkItem::Allocate(this, FdoObject, UCXHUB_WORKITEM_NO_FLAGS);
    if (m_ResetMachineWorkItem == NULL)
        return STATUS_INSUFFICIENT_RESOURCES;
 
    m_ResetMachine.Initialize(this);
    m_ResetMachineReady = TRUE;
 
    KeInitializeEvent(&m_RootHubMayExitD0, SynchronizationEvent, FALSE);
    KeInitializeEvent(&m_ResetCompleteProcessed, SynchronizationEvent, FALSE);
 
    KeInitializeSpinLock(&m_ResetLock);
    m_Failed = 0;
    m_ResetBlockCount = 1;
    m_PendingTreePurge = NULL;
    m_PendingTreePurgeEndpoints = 0;
 
    m_DriverVerifierEnabled = MmIsDriverVerifying(FdoObject->DriverObject) != 0 ||
                              (Globals->WdfDriverGlobals->DriverFlags & WdfVerifyOn) != 0;
 
    Status = CreateQueues();
    if (!NT_SUCCESS(Status))
        return Status;
 
    IoCsqInitialize(&m_AbortPipeCsq,
                    UcxCsqInsertAbortIrp,
                    UcxCsqRemoveAbortIrp,
                    UcxCsqPeekAbortIrp,
                    UcxCsqAcquireAbortLock,
                    UcxCsqReleaseAbortLock,
                    UcxCsqCompleteCanceledAbortIrp);
    KeInitializeSpinLock(&m_AbortPipeCsqLock);
 
    Status = WdfDeviceCreateDeviceInterface(Fdo, &GUID_DEVINTERFACE_USB_HOST_CONTROLLER, NULL);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p host controller interface create failed 0x%lx\n", this, Status);
        return Status;
    }
 
    {
        WDF_OBJECT_ATTRIBUTES StringAttributes;
 
        WDF_OBJECT_ATTRIBUTES_INIT(&StringAttributes);
        StringAttributes.ParentObject = m_Handle;
 
        Status = WdfStringCreate(NULL, &StringAttributes, &m_HostControllerInterfaceName);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Controller %p interface string create failed 0x%lx\n", this, Status);
            return Status;
        }
 
        Status = WdfDeviceRetrieveDeviceInterfaceString(Fdo,
                                                        &GUID_DEVINTERFACE_USB_HOST_CONTROLLER,
                                                        NULL,
                                                        m_HostControllerInterfaceName);
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Controller %p interface name query failed 0x%lx\n", this, Status);
            return Status;
        }
 
        /* Kept past the parent's cleanup; dropped in Destroy */
        WdfObjectReferenceWithTag(m_HostControllerInterfaceName, (PVOID)UCX_POOL_TAG);
    }
 
    Status = QueryHcCapabilities();
    if (!NT_SUCCESS(Status))
        return Status;
 
    Status = RegisterWmi();
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p WMI registration failed 0x%lx\n", this, Status);
        return Status;
    }
 
    KeInitializeSpinLock(&m_WorkerLock);
    InitializeListHead(&m_WorkerItems);
    KeInitializeEvent(&m_WorkerWake, NotificationEvent, FALSE);
    m_WorkerParked = TRUE;
    m_WaitOnResetComplete = TRUE;
    m_HcdReservedIoReady = FALSE;
    KeInitializeMutex(&m_ForwardProgressMutex, 0);
 
    {
        SpinLockGuard Guard(&UcxDriver.ControllerListLock);
 
        InsertTailList(&UcxDriver.ControllerList, &m_DriverListEntry);
        UcxDriver.ControllerCount++;
    }
 
    return STATUS_SUCCESS;
}

IsResetInProgress()

BOOLEAN UcxController::IsResetInProgress ( ) const

inline

Definition at line 174 of file hostctl.h.

    {
        return m_ResetInProgress;
    }

MarkResetFinished()

VOID UcxController::MarkResetFinished

(

)

Definition at line 551 of file hostctl.cpp.

{
    SpinLockGuard Guard(&m_ResetLock);
 
    m_ResetGeneration++;
    m_ResetInProgress = FALSE;
    m_ResetInitiated = FALSE;
 
    /* The controller's own reference comes back */
    InterlockedIncrement(&m_ResetBlockCount);
}

Referenced by ControllerResetMachine::MarkResetFinished().

MarkResetInProgress()

VOID UcxController::MarkResetInProgress

(

)

Definition at line 542 of file hostctl.cpp.

{
    SpinLockGuard Guard(&m_ResetLock);
 
    NT_ASSERT(!m_ResetInProgress && !m_ResetInitiated);
    m_ResetInProgress = TRUE;
}

Referenced by ControllerResetMachine::MarkResetInProgress().

NeedsReset()

VOID UcxController::NeedsReset

(

)

Definition at line 415 of file hostctl.cpp.

{
    DPRINT1("Controller %p reports it needs a reset\n", this);
    PostResetEvent(CrEvent::ControllerNeedsReset);
}

Referenced by UcxApiControllerNeedsReset().

NotifyDevicesResetDone()

VOID UcxController::NotifyDevicesResetDone

(

)

Definition at line 110 of file hostreset.cpp.

{
    UcxResetFanOut FanOut;
 
    InitializeListHead(&FanOut.Endpoints);
    FanOut.Count = 0;
    FanOut.MarkDeprogrammed = FALSE;
 
    WalkDevices(UcxCollectEndpointsForReset, &FanOut, TRUE);
    DPRINT("Controller %p reset done, notifying %lu endpoints\n", this, FanOut.Count);
    UcxPostToCollectedEndpoints(&FanOut, EpEvent::ControllerResetDone);
}

Referenced by ControllerResetMachine::NotifyDevicesResetDone().

NotifyTransportCharacteristicsChange()

VOID UcxController::NotifyTransportCharacteristicsChange

(

_In_ PUCX_CONTROLLER_TRANSPORT_CHARACTERISTICS

Characteristics

)

Definition at line 498 of file hostctl.cpp.

{
    UNREFERENCED_PARAMETER(Characteristics);
}

Referenced by UcxApiControllerNotifyTransportCharacteristicsChange().

PostResetEvent()

VOID UcxController::PostResetEvent ( _In_ CrEvent  Event )

inline

Definition at line 200 of file hostctl.h.

    {
        m_ResetMachine.SmPost(Event);
    }

Referenced by NeedsReset(), PrepareDevicesForReset(), PrepareForResetOperationDone(), ResetComplete(), SetFailed(), and UnblockReset().

PrepareDevicesForReset()

VOID UcxController::PrepareDevicesForReset

(

)

Warns every endpoint of the reset; each acknowledges once idle.

Definition at line 86 of file hostreset.cpp.

{
    UcxResetFanOut FanOut;
 
    InitializeListHead(&FanOut.Endpoints);
    FanOut.Count = 0;
    FanOut.MarkDeprogrammed = TRUE;
 
    WalkDevices(UcxCollectEndpointsForReset, &FanOut, TRUE);
 
    /* Set before the first post so a synchronous ack cannot underflow it */
    NT_ASSERT(m_PendingPrepareForReset == 0);
    m_PendingPrepareForReset = FanOut.Count;
 
    DPRINT("Controller %p preparing %lu endpoints for reset\n", this, FanOut.Count);
 
    UcxPostToCollectedEndpoints(&FanOut, EpEvent::ControllerResetStarting);
 
    if (FanOut.Count == 0)
        PostResetEvent(CrEvent::DevicesReady);
}

Referenced by ControllerResetMachine::PrepareDevicesForReset().

PrepareForResetOperationDone()

VOID UcxController::PrepareForResetOperationDone

(

)

An endpoint finished preparing for the reset.

Definition at line 124 of file hostreset.cpp.

{
    if (InterlockedDecrement(&m_PendingPrepareForReset) == 0)
        PostResetEvent(CrEvent::DevicesReady);
}

Referenced by EndpointMachine::AckControllerReset().

QueryClearTtBufferOnCancel()

BOOLEAN UcxController::QueryClearTtBufferOnCancel

(

)

Definition at line 610 of file hostctl.cpp.

{
    ULONG ResultLength = 0;
 
    if (m_Config.EvtControllerQueryUsbCapability == NULL)
        return FALSE;
 
    return NT_SUCCESS(m_Config.EvtControllerQueryUsbCapability(
        m_Handle,
        (PGUID)&GUID_USB_CAPABILITY_CLEAR_TT_BUFFER_ON_ASYNC_TRANSFER_CANCEL,
        0,
        NULL,
        &ResultLength));
}

QueryHcCapabilities()

NTSTATUS UcxController::QueryHcCapabilities ( )

private

Synchronous IRP_MN_QUERY_CAPABILITIES down the FDO's stack.

Definition at line 239 of file hostctl.cpp.

{
    WDF_REQUEST_SEND_OPTIONS SendOptions;
    WDF_REQUEST_REUSE_PARAMS ReuseParams;
    IO_STACK_LOCATION Stack;
    WDFIOTARGET Target;
    WDFREQUEST Request;
    NTSTATUS Status;
 
    Target = WdfDeviceGetIoTarget(m_Fdo);
 
    Status = WdfRequestCreate(WDF_NO_OBJECT_ATTRIBUTES, Target, &Request);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p capabilities request create failed 0x%lx\n", this, Status);
        return Status;
    }
 
    /* PnP IRPs must start out as not supported */
    WDF_REQUEST_REUSE_PARAMS_INIT(&ReuseParams, WDF_REQUEST_REUSE_NO_FLAGS, STATUS_NOT_SUPPORTED);
    Status = WdfRequestReuse(Request, &ReuseParams);
    if (NT_SUCCESS(Status))
    {
        RtlZeroMemory(&m_HcCaps, sizeof(m_HcCaps));
        m_HcCaps.Size = sizeof(m_HcCaps);
        m_HcCaps.Version = 1;
        m_HcCaps.Address = MAXULONG;
        m_HcCaps.UINumber = MAXULONG;
 
        RtlZeroMemory(&Stack, sizeof(Stack));
        Stack.MajorFunction = IRP_MJ_PNP;
        Stack.MinorFunction = IRP_MN_QUERY_CAPABILITIES;
        Stack.Parameters.DeviceCapabilities.Capabilities = &m_HcCaps;
        WdfRequestWdmFormatUsingStackLocation(Request, &Stack);
 
        /* A send that fails to go out still records its status in the request */
        WDF_REQUEST_SEND_OPTIONS_INIT(&SendOptions, WDF_REQUEST_SEND_OPTION_SYNCHRONOUS);
        WdfRequestSend(Request, Target, &SendOptions);
        Status = WdfRequestGetStatus(Request);
    }
 
    WdfObjectDelete(Request);
 
    if (!NT_SUCCESS(Status))
        DPRINT1("Controller %p query capabilities failed 0x%lx\n", this, Status);
 
    return Status;
}

Referenced by Initialize().

QueryStreamsSupported()

BOOLEAN UcxController::QueryStreamsSupported

(

)

Definition at line 626 of file hostctl.cpp.

{
    USHORT StreamCount = 0;
    ULONG ResultLength = 0;
    NTSTATUS Status;
 
    if (m_Config.EvtControllerQueryUsbCapability == NULL)
        return FALSE;
 
    Status = m_Config.EvtControllerQueryUsbCapability(m_Handle,
                                                      (PGUID)&GUID_USB_CAPABILITY_STATIC_STREAMS,
                                                      sizeof(StreamCount),
                                                      &StreamCount,
                                                      &ResultLength);
 
    return NT_SUCCESS(Status) && StreamCount > 0;
}

Referenced by UcxHubStreamsSupported().

QueueOnWorkerThread()

VOID UcxController::QueueOnWorkerThread

(

_In_ UcxWorkItem *

WorkItem

)

Definition at line 811 of file hostctl.cpp.

{
    SpinLockGuard Guard(&m_WorkerLock);
 
    InsertTailList(&m_WorkerItems, &WorkItem->ThreadQueueEntry);
    KeSetEvent(&m_WorkerWake, IO_NO_INCREMENT, FALSE);
}

RegisterWmi()

NTSTATUS UcxController::RegisterWmi ( )

private

Definition at line 289 of file hostctl.cpp.

{
    WDF_WMI_PROVIDER_CONFIG ProviderConfig;
    WDF_WMI_INSTANCE_CONFIG InstanceConfig;
 
    WDF_WMI_PROVIDER_CONFIG_INIT(&ProviderConfig, &GUID_USB_WMI_NODE_INFO);
    WDF_WMI_INSTANCE_CONFIG_INIT_PROVIDER_CONFIG(&InstanceConfig, &ProviderConfig);
    InstanceConfig.Register = TRUE;
    InstanceConfig.EvtWmiInstanceQueryInstance = UcxEvtWmiNodeInfoQueryInstance;
 
    return WdfWmiInstanceCreate(m_Fdo, &InstanceConfig, WDF_NO_OBJECT_ATTRIBUTES, WDF_NO_HANDLE);
}

Referenced by Initialize().

ResetComplete()

VOID UcxController::ResetComplete

(

_In_ PUCX_CONTROLLER_RESET_COMPLETE_INFO

Info

)

Definition at line 422 of file hostctl.cpp.

{
    if (Info->UcxControllerState == UcxControllerStateLost)
        m_DeviceContextsLost = 1;
 
    m_RootHubResetSeen = 1;
 
    DPRINT("Controller %p reset complete, state %d\n", this, Info->UcxControllerState);
    PostResetEvent(CrEvent::ControllerResetDone);
 
    /* While the root hub is out of D0 the machine releases this thread when done */
    if (m_WaitOnResetComplete)
        KeWaitForSingleObject(&m_ResetCompleteProcessed, Executive, KernelMode, FALSE, NULL);
}

Referenced by UcxApiControllerResetComplete().

ResumeIdle()

VOID UcxController::ResumeIdle

(

_Inout_ PUCXHUB_STOP_IDLE_CONTEXT

Context

)

Definition at line 680 of file hostctl.cpp.

{
    if (!Context->PowerReferenceAcquired)
        return;
 
    WdfDeviceResumeIdle(m_Fdo);
    Context->PowerReferenceAcquired = FALSE;
}

Referenced by UcxHubAllowControllerIdle().

SetFailed()

VOID UcxController::SetFailed

(

)

Definition at line 439 of file hostctl.cpp.

{
    if (InterlockedCompareExchange(&m_Failed, 1, 0) != 0)
        return;
 
    DPRINT1("Controller %p marked failed by the HCD\n", this);
 
    /* Tear the tree down first so the purges recurse on one stack */
    m_RootHub->Device()->DisconnectPort(0);
 
    PostResetEvent(CrEvent::ControllerLost);
}

Referenced by UcxApiControllerSetFailed().

SetIdStrings()

NTSTATUS UcxController::SetIdStrings	(	_In_ PUNICODE_STRING	Manufacturer,
		_In_ PUNICODE_STRING	ModelName,
		_In_ PUNICODE_STRING	ModelNumber
	)

Definition at line 453 of file hostctl.cpp.

{
    NTSTATUS Status;
 
    /* Only a non empty manufacturer counts as already set */
    if (m_ManufacturerName.Length != 0)
    {
        DPRINT1("Controller %p ID strings already set\n", this);
        return STATUS_INVALID_PARAMETER;
    }
 
    if (!UcxIsValidIdString(Manufacturer) || !UcxIsValidIdString(ModelName) || !UcxIsValidIdString(ModelNumber))
    {
        DPRINT1("Controller %p ID strings malformed\n", this);
        return STATUS_INVALID_PARAMETER;
    }
 
    /* An earlier call with an empty manufacturer may have left copies behind */
    UcxFreeIdString(&m_ManufacturerName);
    UcxFreeIdString(&m_ModelName);
    UcxFreeIdString(&m_ModelNumber);
 
    Status = UcxCopyIdString(Manufacturer, &m_ManufacturerName);
    if (NT_SUCCESS(Status))
        Status = UcxCopyIdString(ModelName, &m_ModelName);
    if (NT_SUCCESS(Status))
        Status = UcxCopyIdString(ModelNumber, &m_ModelNumber);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p ID string copy failed 0x%lx\n", this, Status);
        UcxFreeIdString(&m_ManufacturerName);
        UcxFreeIdString(&m_ModelName);
        UcxFreeIdString(&m_ModelNumber);
        return Status;
    }
 
    return STATUS_SUCCESS;
}

Referenced by UcxApiControllerSetIdStrings().

StartWorkerThread()

NTSTATUS UcxController::StartWorkerThread ( )

private

Definition at line 772 of file hostctl.cpp.

{
    OBJECT_ATTRIBUTES ObjectAttributes;
    HANDLE ThreadHandle;
    NTSTATUS Status;
 
    InitializeObjectAttributes(&ObjectAttributes, NULL, OBJ_KERNEL_HANDLE, NULL, NULL);
 
    Status = PsCreateSystemThread(&ThreadHandle,
                                  THREAD_ALL_ACCESS,
                                  &ObjectAttributes,
                                  NULL,
                                  NULL,
                                  UcxController::WorkerThreadRoutine,
                                  this);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p system thread create failed 0x%lx\n", this, Status);
        return Status;
    }
 
    Status = ObReferenceObjectByHandle(ThreadHandle,
                                       0,
                                       NULL,
                                       KernelMode,
                                       (PVOID*)&m_WorkerThread,
                                       NULL);
    ZwClose(ThreadHandle);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("Controller %p system thread reference failed 0x%lx\n", this, Status);
        m_WorkerThread = NULL;
    }
 
    return Status;
}

Referenced by _IRQL_requires_().

StopIdle()

NTSTATUS UcxController::StopIdle

(

_Inout_ PUCXHUB_STOP_IDLE_CONTEXT

Context

)

Definition at line 663 of file hostctl.cpp.

{
    NTSTATUS Status;
 
    PAGED_CODE();
 
    Status = WdfDeviceStopIdle(m_Fdo, TRUE);
    if (NT_SUCCESS(Status))
        Context->PowerReferenceAcquired = TRUE;
    else
        DPRINT1("Controller %p stop idle failed 0x%lx\n", this, Status);
 
    return Status;
}

Referenced by UcxHubBlockControllerIdle().

UnblockReset()

VOID UcxController::UnblockReset

(

)

Drops a reset reference; the last one during a reset tells the machine once.

Definition at line 522 of file hostctl.cpp.

{
    ULONG Generation = m_ResetGeneration;
 
    if (InterlockedDecrement(&m_ResetBlockCount) != 0)
        return;
 
    {
        SpinLockGuard Guard(&m_ResetLock);
 
        if (m_ResetInitiated || Generation != m_ResetGeneration)
            return;
 
        m_ResetInitiated = TRUE;
    }
 
    PostResetEvent(CrEvent::ResetBlocksCleared);
}

Referenced by BlockReset(), ControllerResetMachine::DropResetBlock(), GetCurrentFrameNumber(), and UcxRootHub::PortChanged().

WalkDevices()

VOID UcxController::WalkDevices	(	_In_ PFN_UCX_DEVICE_VISITOR	Visitor,
		_In_opt_ PVOID	Context,
		_In_ BOOLEAN	IncludeDisconnected
	)

Definition at line 74 of file hostreset.cpp.

{
    SpinLockGuard Guard(&m_TopologyLock);
 
    m_RootHub->Device()->WalkSubtree(Visitor, Context, IncludeDisconnected);
}

Referenced by NotifyDevicesResetDone(), and PrepareDevicesForReset().

Friends And Related Function Documentation

ControllerResetMachine

friend class ControllerResetMachine

friend

Definition at line 391 of file hostctl.h.

Member Data Documentation

EvtDestroy

VOID UcxController::EvtDestroy

staticprivate

Definition at line 377 of file hostctl.h.

Referenced by Create().

m_AbortPipeCsq

IO_CSQ UcxController::m_AbortPipeCsq

Definition at line 306 of file hostctl.h.

Referenced by UcxEndpoint::AbortPipe(), EndpointMachine::CompleteAbortUrb(), and Initialize().

m_AbortPipeCsqLock

KSPIN_LOCK UcxController::m_AbortPipeCsqLock

Definition at line 307 of file hostctl.h.

Referenced by Initialize().

m_Address0Queue

WDFQUEUE UcxController::m_Address0Queue

Definition at line 293 of file hostctl.h.

Referenced by Address0Release(), and CreateQueues().

m_CachedFrameNumber

ULONG UcxController::m_CachedFrameNumber

Definition at line 333 of file hostctl.h.

Referenced by GetCurrentFrameNumber().

m_ChildDeviceCount

ULONG UcxController::m_ChildDeviceCount

Definition at line 311 of file hostctl.h.

Referenced by UcxRootHub::Create(), UcxUsbDevice::Create(), and Initialize().

m_ChildEndpointCount

ULONG UcxController::m_ChildEndpointCount

Definition at line 312 of file hostctl.h.

Referenced by Initialize().

m_ClearTtBufferOnAsyncCancel

BOOLEAN UcxController::m_ClearTtBufferOnAsyncCancel

Definition at line 337 of file hostctl.h.

Referenced by UcxEndpoint::Initialize().

m_Config

UCX_CONTROLLER_CONFIG UcxController::m_Config

Definition at line 289 of file hostctl.h.

Referenced by UcxRootHub::CreatePdo(), CreateQueues(), GetCurrentFrameNumber(), GetInfo(), HcdEnableForwardProgress(), HcdFreeDumpData(), HcdGetBandwidthInformation(), HcdGetDumpData(), Initialize(), QueryClearTtBufferOnCancel(), QueryStreamsSupported(), and ControllerResetMachine::ResetController().

m_DefaultQueue

WDFQUEUE UcxController::m_DefaultQueue

Definition at line 297 of file hostctl.h.

Referenced by CreateQueues().

m_DeviceContextsLost

LONG UcxController::m_DeviceContextsLost

Definition at line 320 of file hostctl.h.

Referenced by UcxRootHub::FinishPortResetRequest(), and ResetComplete().

m_DeviceMgmtQueue

WDFQUEUE UcxController::m_DeviceMgmtQueue

Definition at line 294 of file hostctl.h.

Referenced by CreateQueues().

m_DriverListEntry

LIST_ENTRY UcxController::m_DriverListEntry

Definition at line 290 of file hostctl.h.

Referenced by Destroy(), and Initialize().

m_DriverVerifierEnabled

BOOLEAN UcxController::m_DriverVerifierEnabled

Definition at line 336 of file hostctl.h.

Referenced by Initialize(), and UcxStaticStreams::SetStreamInfo().

m_Failed

LONG UcxController::m_Failed

Definition at line 330 of file hostctl.h.

Referenced by HasFailed(), Initialize(), and SetFailed().

m_Fdo

WDFDEVICE UcxController::m_Fdo

Definition at line 288 of file hostctl.h.

Referenced by UcxRootHub::CreateEndpoint(), UcxRootHub::CreatePdo(), Initialize(), QueryHcCapabilities(), RegisterWmi(), ResumeIdle(), and StopIdle().

m_ForwardProgressMutex

KMUTEX UcxController::m_ForwardProgressMutex

Definition at line 346 of file hostctl.h.

Referenced by _IRQL_requires_(), and Initialize().

m_Handle

UCXCONTROLLER UcxController::m_Handle

Definition at line 287 of file hostctl.h.

Referenced by _IRQL_requires_(), EndpointMachine::AbortEndpoint(), Create(), ControllerResetMachine::DereferenceController(), UcxUsbDevice::DispatchManagement(), EndpointMachine::ForwardResetRequest(), GetCurrentFrameNumber(), UcxUsbDevice::HandleHubEndpointsConfigure(), UcxUsbDevice::HandleHubPurgeIo(), UcxUsbDevice::HandleHubStartIo(), Initialize(), EndpointMachine::PurgeEndpoint(), QueryClearTtBufferOnCancel(), QueryStreamsSupported(), ControllerResetMachine::ReferenceController(), ControllerResetMachine::ResetController(), UcxUsbDevice::SendDisableToController(), UcxUsbDevice::SendEndpointsConfigureToController(), UcxUsbDevice::SendResetToController(), EndpointMachine::StartEndpoint(), and UcxUsbDevice::UpdateFromHub().

m_HcCaps

DEVICE_CAPABILITIES UcxController::m_HcCaps

Definition at line 303 of file hostctl.h.

Referenced by UcxRootHub::BuildPowerCapabilities(), and QueryHcCapabilities().

m_HcdReservedIoReady

BOOLEAN UcxController::m_HcdReservedIoReady

Definition at line 347 of file hostctl.h.

Referenced by _IRQL_requires_(), and Initialize().

m_HostControllerInterfaceName

WDFSTRING UcxController::m_HostControllerInterfaceName

Definition at line 300 of file hostctl.h.

Referenced by Destroy(), and Initialize().

m_ManufacturerName

UNICODE_STRING UcxController::m_ManufacturerName

Definition at line 356 of file hostctl.h.

Referenced by Destroy(), and SetIdStrings().

m_ModelName

UNICODE_STRING UcxController::m_ModelName

Definition at line 357 of file hostctl.h.

Referenced by Destroy(), and SetIdStrings().

m_ModelNumber

UNICODE_STRING UcxController::m_ModelNumber

Definition at line 358 of file hostctl.h.

Referenced by Destroy(), and SetIdStrings().

m_PendDuringResetQueue

WDFQUEUE UcxController::m_PendDuringResetQueue

Definition at line 296 of file hostctl.h.

Referenced by CreateQueues(), ControllerResetMachine::HoldDeviceRequests(), EndpointMachine::ParkStreamsDisableRequest(), and ControllerResetMachine::ReleaseDeviceRequests().

m_PendingPrepareForReset

LONG UcxController::m_PendingPrepareForReset

Definition at line 331 of file hostctl.h.

Referenced by PrepareDevicesForReset(), and PrepareForResetOperationDone().

m_PendingTreePurge

WDFREQUEST UcxController::m_PendingTreePurge

Definition at line 352 of file hostctl.h.

Referenced by Initialize().

m_PendingTreePurgeEndpoints

LONG UcxController::m_PendingTreePurgeEndpoints

Definition at line 353 of file hostctl.h.

Referenced by Initialize().

m_ResetBlockCount

LONG UcxController::m_ResetBlockCount

Definition at line 327 of file hostctl.h.

Referenced by BlockReset(), Initialize(), MarkResetFinished(), and UnblockReset().

m_ResetCompleteProcessed

KEVENT UcxController::m_ResetCompleteProcessed

Definition at line 319 of file hostctl.h.

Referenced by Initialize(), ControllerResetMachine::ReleaseResetCompleteWaiter(), and ResetComplete().

m_ResetGeneration

ULONG UcxController::m_ResetGeneration

Definition at line 326 of file hostctl.h.

Referenced by MarkResetFinished(), and UnblockReset().

m_ResetInitiated

BOOLEAN UcxController::m_ResetInitiated

Definition at line 329 of file hostctl.h.

Referenced by MarkResetFinished(), MarkResetInProgress(), and UnblockReset().

m_ResetInProgress

BOOLEAN UcxController::m_ResetInProgress

Definition at line 328 of file hostctl.h.

Referenced by BlockReset(), IsResetInProgress(), MarkResetFinished(), and MarkResetInProgress().

m_ResetLock

KSPIN_LOCK UcxController::m_ResetLock

Definition at line 325 of file hostctl.h.

Referenced by Initialize(), MarkResetFinished(), MarkResetInProgress(), and UnblockReset().

m_ResetMachine

ControllerResetMachine UcxController::m_ResetMachine

Definition at line 314 of file hostctl.h.

Referenced by Initialize(), and PostResetEvent().

m_ResetMachineReady

BOOLEAN UcxController::m_ResetMachineReady

Definition at line 315 of file hostctl.h.

Referenced by Destroy(), and Initialize().

m_ResetMachineWorkItem

UcxWorkItem* UcxController::m_ResetMachineWorkItem

Definition at line 316 of file hostctl.h.

Referenced by Destroy(), Initialize(), and ControllerResetMachine::QueuePassiveWork().

m_RootHub

UcxRootHub* UcxController::m_RootHub

Definition at line 302 of file hostctl.h.

Referenced by _IRQL_requires_(), UcxEndpoint::CloseStaticStreams(), ControllerResetMachine::CompleteHubReset(), UcxRootHub::Create(), ControllerResetMachine::FailRootHubIo(), UcxEndpoint::OpenStaticStreams(), SetFailed(), ControllerResetMachine::SignalPortChange(), ControllerResetMachine::UnblockRootHubTraffic(), and WalkDevices().

m_RootHubInD0

BOOLEAN UcxController::m_RootHubInD0

Definition at line 323 of file hostctl.h.

Referenced by UcxEndpoint::CloseStaticStreams().

m_RootHubMayExitD0

KEVENT UcxController::m_RootHubMayExitD0

Definition at line 318 of file hostctl.h.

Referenced by ControllerResetMachine::AllowRootHubPowerDown(), and Initialize().

m_RootHubResetSeen

LONG UcxController::m_RootHubResetSeen

Definition at line 321 of file hostctl.h.

Referenced by UcxRootHub::FinishPortResetRequest(), and ResetComplete().

m_SyntheticFrame

ULONG UcxController::m_SyntheticFrame

Definition at line 334 of file hostctl.h.

m_TopologyLock

KSPIN_LOCK UcxController::m_TopologyLock

Definition at line 310 of file hostctl.h.

Referenced by UcxRootHub::Create(), UcxUsbDevice::Create(), UcxUsbDevice::DeleteFromHub(), UcxUsbDevice::DisconnectPort(), UcxUsbDevice::FanOutToEndpoints(), UcxUsbDevice::FinishEndpointResetRequest(), EndpointMachine::FinishStreamsCloseRequest(), UcxEndpoint::GetStaticStreamsReferenced(), UcxUsbDevice::HandleHubReset(), Initialize(), UcxEndpoint::OpenStaticStreams(), UcxEndpoint::OpenStaticStreamsComplete(), UcxUsbDevice::TrackStaleHandles(), and WalkDevices().

m_TreePurgeQueue

WDFQUEUE UcxController::m_TreePurgeQueue

Definition at line 295 of file hostctl.h.

Referenced by CreateQueues().

m_UsbdInterfaceCount

LONG UcxController::m_UsbdInterfaceCount

Definition at line 349 of file hostctl.h.

Referenced by Destroy(), and UcxUsbdHandle::Unregister().

m_WaitOnResetComplete

BOOLEAN UcxController::m_WaitOnResetComplete

Definition at line 322 of file hostctl.h.

Referenced by ControllerResetMachine::AllowRootHubPowerDown(), Initialize(), ControllerResetMachine::LetResetCompletionProceed(), and ResetComplete().

m_WorkerExit

BOOLEAN UcxController::m_WorkerExit

Definition at line 345 of file hostctl.h.

Referenced by Destroy().

m_WorkerItems

LIST_ENTRY UcxController::m_WorkerItems

Definition at line 341 of file hostctl.h.

Referenced by Initialize(), and QueueOnWorkerThread().

m_WorkerLock

KSPIN_LOCK UcxController::m_WorkerLock

Definition at line 340 of file hostctl.h.

Referenced by Destroy(), Initialize(), and QueueOnWorkerThread().

m_WorkerParked

BOOLEAN UcxController::m_WorkerParked

Definition at line 344 of file hostctl.h.

Referenced by Initialize().

m_WorkerThread

PKTHREAD UcxController::m_WorkerThread

Definition at line 342 of file hostctl.h.

Referenced by _IRQL_requires_(), Destroy(), HasWorkerThread(), and StartWorkerThread().

m_WorkerWake

KEVENT UcxController::m_WorkerWake

Definition at line 343 of file hostctl.h.

Referenced by Destroy(), Initialize(), and QueueOnWorkerThread().

ResetMachinePassiveRoutine

VOID NTAPI UcxController::ResetMachinePassiveRoutine

staticprivate

Definition at line 389 of file hostctl.h.

Referenced by ControllerResetMachine::QueuePassiveWork().

WorkerThreadRoutine

VOID NTAPI UcxController::WorkerThreadRoutine

staticprivate

Runs work items the worker pool could not take, so paging I/O keeps moving.

Definition at line 386 of file hostctl.h.

Referenced by StartWorkerThread().

---

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

• drivers/usb/ucx01000/hostctl.h
• drivers/usb/ucx01000/hostctl.cpp
• drivers/usb/ucx01000/hostqueues.cpp
• drivers/usb/ucx01000/hostreset.cpp