#include <devobj.h>

Collaboration diagram for UcxUsbDevice:

[legend]

Public Types
typedef VOID(UcxUsbDevice::*	PFN_UCX_OPERATION_DONE) ()

Public Member Functions
VOID	RemoteWakeNotification (_In_ ULONG Interface)

VOID	DeleteFromHub ()

VOID	DisconnectPort (_In_ ULONG PortNumber)

VOID	SetPdo (_In_ PDEVICE_OBJECT Pdo)

ULONG64	Timestamp () const

BOOLEAN	IsRootHub () const

BOOLEAN	IsHub () const

USB_DEVICE_SPEED	Speed () const

BOOLEAN	AllowsEndpointStart () const

VOID	InitializeAsRootHub (_In_ UCXROOTHUB Handle, _In_ UcxController *Controller)

VOID	WalkSubtree (_In_ PFN_UCX_DEVICE_VISITOR Visitor, _In_opt_ PVOID Context, _In_ BOOLEAN IncludeDisconnected)

VOID	DispatchManagement (_In_ WDFREQUEST Request, _In_ ULONG IoControlCode)

VOID	FailManagement (_In_ WDFREQUEST Request, _In_ ULONG IoControlCode)

NTSTATUS	OnHcdEnableDone (_In_ PIRP Irp, _In_ PUSBDEVICE_ENABLE Enable)

NTSTATUS	OnHcdResetDone (_In_ PIRP Irp, _In_ PUSBDEVICE_RESET Reset)

NTSTATUS	OnHcdEndpointsConfigureDone (_In_ PIRP Irp, _In_ PENDPOINTS_CONFIGURE Configure)

VOID	CompleteHubOperation ()

VOID	RegisterComposite (_In_ WDFREQUEST Request)

VOID	UnregisterComposite (_In_ WDFREQUEST Request)

VOID	SetFunctionData (_In_ WDFREQUEST Request)

VOID	RequestRemoteWakeNotification (_In_ WDFREQUEST Request)

	_IRQL_requires_ (PASSIVE_LEVEL) NTSTATUS EnableForwardProgress(_In_ PUCXHUB_FORWARD_PROGRESS_INFO Info)

VOID	TrackStaleHandles ()

VOID	ReportNoPingResponseIfPending ()

Static Public Member Functions
static VOID	InitSetEventCallbacks (_Inout_ PUCXUSBDEVICE_INIT Init, _In_ PUCX_USBDEVICE_EVENT_CALLBACKS Callbacks)

static _Must_inspect_result_ NTSTATUS	Create (_In_ UCXCONTROLLER Controller, _Inout_ PUCXUSBDEVICE_INIT Init, _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes, _Out_ UCXUSBDEVICE UsbDevice)

static _Must_inspect_result_ NTSTATUS	CreateFromHub (_In_ UCXUSBDEVICE Hub, _In_ PUCXHUB_DEVICE_CREATE_INFO Info, _Out_ UCXUSBDEVICE *UsbDevice)

static UcxUsbDevice *	FromHandle (_In_ UCXUSBDEVICE Handle)

Public Attributes
UCXUSBDEVICE	m_Handle

UcxController *	m_Controller

UcxUsbDevice *	m_ParentHub

UCXHUB_DEVICE_CONTEXT	m_HubDeviceContext

ULONG	m_Type

USHORT	m_BcdUsb

UCXUSBDEVICE_INFO	m_Info

UcxUsbDeviceCallbacks	m_Callbacks

PDEVICE_OBJECT	m_Pdo

ULONG64	m_Timestamp

LIST_ENTRY	m_ChildList

LIST_ENTRY	m_ChildLink

LIST_ENTRY	m_EndpointList

LIST_ENTRY	m_StaleEndpointList

BOOLEAN	m_Disconnected

BOOLEAN	m_ChildrenMayLeavePurge

BOOLEAN	m_EndpointsMayLeavePurge

KSPIN_LOCK	m_TrackingLock

LIST_ENTRY	m_TrackingList

BOOLEAN	m_StalePipeIoAllowed

UcxEndpoint *	m_DefaultEndpoint

UcxPipe *	m_DefaultPipe

BOOLEAN	m_Enabled

BOOLEAN	m_DeprogrammedByControllerReset

BOOLEAN	m_PendingDelete

BOOLEAN	m_ResetFailedByControllerReset

BOOLEAN	m_EndpointResetFailedByControllerReset

BOOLEAN	m_FailNextStreamClose

PVOID	m_PendingOperation

PFN_UCX_OPERATION_DONE	m_PendingOperationDone

LONG	m_PendingOperationCount

LONG	m_PendingNoPingResponse

ULONG	m_TransferFailureCount

UCXHUB_HUB_CONTEXT	m_HubContext

PFN_UCXHUB_CLEAR_TT_BUFFER	m_HubClearTtBuffer

PFN_UCXHUB_NO_PING_RESPONSE	m_HubNoPingResponse

BOOLEAN	m_HubUsesGrownInterface

KSPIN_LOCK	m_RemoteWakeLock

UcxRemoteWakeSlot	m_RemoteWake

ULONG	m_FunctionCount

UcxFunctionRecord *	m_Functions

WDFMEMORY	m_FunctionsMemory

KSPIN_LOCK	m_UsbdHandleLock

LIST_ENTRY	m_UsbdHandleList

Private Member Functions
VOID	InitializeLists ()

VOID	StartOperation (_In_ PVOID Pending, _In_ PFN_UCX_OPERATION_DONE Done, _In_ LONG Count)

PVOID	TakeOperation ()

VOID	FanOutToEndpoints (_In_ EpEvent Event)

VOID	HandleHubPurgeIo (_In_ WDFREQUEST Request, _In_ BOOLEAN OnSuspend)

VOID	HandleHubStartIo (_In_ WDFREQUEST Request)

VOID	HandleHubAbortIo (_In_ WDFREQUEST Request)

VOID	HandleHubTreePurge (_In_ WDFREQUEST Request)

VOID	HandleHubReset (_In_ WDFREQUEST Request, _In_ BOOLEAN AfterReset)

VOID	HandleHubDisable (_In_ WDFREQUEST Request, _In_ BOOLEAN AfterReset)

VOID	HandleHubEndpointsConfigure (_In_ WDFREQUEST Request, _In_ BOOLEAN AfterReset)

VOID	UpdateFromHub (_In_ WDFREQUEST Request)

VOID	SendResetToController ()

VOID	PendReset ()

VOID	SendDisableToController ()

VOID	PendDisable ()

VOID	SendEndpointsConfigureToController ()

VOID	PendEndpointsConfigure ()

VOID	CompleteHubRequest ()

VOID	CompleteEnableIrp ()

VOID	CompleteEndpointsConfigureIrp ()

VOID	FinishEndpointResetRequest ()

Static Private Attributes
static EVT_WDF_OBJECT_CONTEXT_DESTROY	EvtDestroy

static EVT_WDF_REQUEST_CANCEL	EvtRemoteWakeCancel

Detailed Description

Definition at line 49 of file devobj.h.

Member Typedef Documentation

◆ PFN_UCX_OPERATION_DONE

typedef VOID(UcxUsbDevice::* UcxUsbDevice::PFN_UCX_OPERATION_DONE) ()

Definition at line 53 of file devobj.h.

Member Function Documentation

◆ _IRQL_requires_()

UcxUsbDevice::_IRQL_requires_ ( PASSIVE_LEVEL )

◆ AllowsEndpointStart()

BOOLEAN UcxUsbDevice::AllowsEndpointStart ( ) const

inline

Definition at line 130 of file devobj.h.

    {
        return !m_Disconnected && !m_DeprogrammedByControllerReset &&
               m_Enabled && m_EndpointsMayLeavePurge;
    }

Referenced by EndpointMachine::DeviceAllowsStart().

◆ CompleteEnableIrp()

VOID UcxUsbDevice::CompleteEnableIrp ( )

private

Definition at line 673 of file devicemgmt.cpp.

{
    PIRP Irp = (PIRP)TakeOperation();
 
    if (m_DeprogrammedByControllerReset)
        DPRINT1("UsbDevice %p enable failed by controller reset\n", m_Handle);
 
    UcxResumeIrpCompletion(Irp, m_DeprogrammedByControllerReset ? STATUS_NO_SUCH_DEVICE : STATUS_SUCCESS);
}

Referenced by CompleteEnableIrp(), and OnHcdEnableDone().

◆ CompleteEndpointsConfigureIrp()

VOID UcxUsbDevice::CompleteEndpointsConfigureIrp ( )

private

Definition at line 684 of file devicemgmt.cpp.

{
    UcxResumeIrpCompletion((PIRP)TakeOperation(), STATUS_SUCCESS);
}

Referenced by CompleteEndpointsConfigureIrp(), and OnHcdEndpointsConfigureDone().

◆ CompleteHubOperation()

VOID UcxUsbDevice::CompleteHubOperation ( )

An endpoint finished its part of the current hub operation.

Definition at line 358 of file devicemgmt.cpp.

{
    PFN_UCX_OPERATION_DONE Done;
 
    if (InterlockedDecrement(&m_PendingOperationCount) != 0)
        return;
 
    Done = m_PendingOperationDone;
    m_PendingOperationDone = NULL;
    (this->*Done)();
}

Referenced by CompleteHubOperation(), and EndpointMachine::CompleteHubOperation().

◆ CompleteHubRequest()

VOID UcxUsbDevice::CompleteHubRequest ( )

private

Definition at line 654 of file devicemgmt.cpp.

{
    WdfRequestComplete((WDFREQUEST)TakeOperation(), STATUS_SUCCESS);
}

Referenced by CompleteHubRequest(), HandleHubAbortIo(), HandleHubPurgeIo(), and HandleHubStartIo().

◆ Create()

_Must_inspect_result_ NTSTATUS UcxUsbDevice::Create	(	_In_ UCXCONTROLLER	Controller,
		_Inout_ PUCXUSBDEVICE_INIT *	Init,
		_In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes,
		_Out_ UCXUSBDEVICE *	UsbDevice
	)

static

Definition at line 81 of file devobj.cpp.

{
    UcxUsbDeviceInit* Init = *InitPointer;
    UcxUsbDevice* Parent = FromHandle(Init->ParentHub);
    UcxController* ControllerContext = UcxController::FromHandle(Controller);
    WDF_OBJECT_ATTRIBUTES UcxAttributes;
    UcxUsbDevice* Device;
    WDFOBJECT Object;
    NTSTATUS Status = STATUS_SUCCESS;
 
    PAGED_CODE();
 
    *UsbDevice = NULL;
 
    WDF_OBJECT_ATTRIBUTES_INIT_CONTEXT_TYPE(&UcxAttributes, UcxUsbDevice);
    UcxAttributes.EvtDestroyCallback = UcxUsbDevice::EvtDestroy;
 
    /* Devices hang off their parent hub so deleting a hub deletes what is below it */
    if (Attributes != NULL)
        Attributes->ParentObject = Init->ParentHub;
    else
        UcxAttributes.ParentObject = Init->ParentHub;
 
    Status = UcxCreateObjectWithTwoContexts(Attributes != NULL ? Attributes : &UcxAttributes,
                                            Attributes != NULL ? &UcxAttributes : NULL,
                                            &Object);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UsbDevice object create failed under hub %p 0x%lx\n", Init->ParentHub, Status);
        return Status;
    }
 
    Device = new (UcxGetUsbDeviceContext(Object)) UcxUsbDevice();
    Device->m_Handle = (UCXUSBDEVICE)Object;
    Device->m_Controller = ControllerContext;
    Device->m_ParentHub = Parent;
    Device->m_HubDeviceContext = Init->HubDeviceContext;
    Device->m_Info = Init->Info;
    Device->m_Callbacks = Init->Callbacks;
    Device->m_Timestamp = UcxSystemTimeNow();
    Device->InitializeLists();
 
    /* Keeps the tree intact past WdfObjectDelete for stale endpoints of deleted devices */
    WdfObjectReference(Parent->m_Handle);
 
    {
        SpinLockGuard Guard(&ControllerContext->m_TopologyLock);
 
        if (Parent->m_Disconnected)
        {
            Status = STATUS_NO_SUCH_DEVICE;
        }
        else
        {
            InsertTailList(&Parent->m_ChildList, &Device->m_ChildLink);
            ControllerContext->m_ChildDeviceCount++;
 
            /* A tree purge in progress above covers new devices too */
            Device->m_ChildrenMayLeavePurge = Parent->m_ChildrenMayLeavePurge;
            Device->m_EndpointsMayLeavePurge = Parent->m_ChildrenMayLeavePurge;
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UsbDevice %p not created, parent hub %p is disconnected\n", Object, Parent->m_Handle);
        WdfObjectDelete(Object);
        return Status;
    }
 
    DPRINT("UsbDevice %p created under hub %p\n", Device->m_Handle, Parent->m_Handle);
 
    *UsbDevice = Device->m_Handle;
    Init->Created = Device->m_Handle;
    *InitPointer = NULL;
    return STATUS_SUCCESS;
}

Referenced by Create().

◆ CreateFromHub()

_Must_inspect_result_ NTSTATUS UcxUsbDevice::CreateFromHub	(	_In_ UCXUSBDEVICE	Hub,
		_In_ PUCXHUB_DEVICE_CREATE_INFO	Info,
		_Out_ UCXUSBDEVICE *	UsbDevice
	)

static

Definition at line 297 of file devobj.cpp.

{
    UcxUsbDevice* HubDevice = FromHandle(Hub);
    UcxController* Controller = HubDevice->m_Controller;
    UcxUsbDeviceInit Init;
    NTSTATUS Status;
 
    PAGED_CODE();
    NT_ASSERT(HubDevice->IsHub());
 
    RtlZeroMemory(&Init, sizeof(Init));
    Init.ParentHub = Hub;
    Init.HubDeviceContext = Info->HubDeviceContext;
    Init.Info.Size = sizeof(Init.Info);
    Init.Info.DeviceSpeed = Info->DeviceSpeed;
 
    Status = UcxBuildPortPath(HubDevice, Info->PortNumber, &Init.Info);
    if (!NT_SUCCESS(Status))
    {
        *UsbDevice = NULL;
        return Status;
    }
 
    if (!Controller->BlockReset())
    {
        Status = STATUS_NO_SUCH_DEVICE;
        DPRINT1("Hub %p port %lu device add during controller reset 0x%lx\n", Hub, Info->PortNumber, Status);
    }
    else
    {
        Status = Controller->m_Config.EvtControllerUsbDeviceAdd(Controller->m_Handle, &Init.Info, &Init);
        Controller->UnblockReset();
 
        if (!NT_SUCCESS(Status))
            DPRINT1("Hub %p port %lu HCD device add failed 0x%lx\n", Hub, Info->PortNumber, Status);
    }
 
    if (NT_SUCCESS(Status))
    {
        *UsbDevice = Init.Created;
        return Status;
    }
 
    *UsbDevice = NULL;
    if (Init.Created != NULL)
        FromHandle(Init.Created)->DeleteFromHub();
 
    return Status;
}

Referenced by CreateFromHub().

◆ DeleteFromHub()

VOID UcxUsbDevice::DeleteFromHub ( )

Definition at line 351 of file devobj.cpp.

{
    LIST_ENTRY Stale;
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
 
    PAGED_CODE();
 
    DPRINT("UsbDevice %p deleted by the hub\n", m_Handle);
 
    UcxDropLeakedUsbdHandles(this);
 
    /* Endpoints still alive skip the stale stage from here on */
    m_PendingDelete = TRUE;
 
    InitializeListHead(&Stale);
    {
        SpinLockGuard Guard(&m_Controller->m_TopologyLock);
 
        if (!IsListEmpty(&m_StaleEndpointList))
        {
            /* Move the whole stale list over in one step */
            Stale.Flink = m_StaleEndpointList.Flink;
            Stale.Blink = m_StaleEndpointList.Blink;
            Stale.Flink->Blink = &Stale;
            Stale.Blink->Flink = &Stale;
            InitializeListHead(&m_StaleEndpointList);
        }
    }
 
    while (!IsListEmpty(&Stale))
    {
        Entry = RemoveHeadList(&Stale);
        UcxClearListEntry(Entry);
 
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
        Endpoint->Post(EpEvent::StaleReplaced);
    }
 
    WdfObjectDelete(m_Handle);
}

Referenced by CreateFromHub(), DeleteFromHub(), and UcxHubDeviceDelete().

◆ DisconnectPort()

VOID UcxUsbDevice::DisconnectPort ( _In_ ULONG PortNumber )

Port 0 means this hub itself went away.

Definition at line 440 of file devobj.cpp.

{
    LIST_ENTRY Endpoints;
    PLIST_ENTRY Entry;
    UcxUsbDevice* Child;
    UcxEndpoint* Endpoint;
 
    InitializeListHead(&Endpoints);
 
    DPRINT("Hub %p disconnect on port %lu\n", m_Handle, PortNumber);
 
    {
        SpinLockGuard Guard(&m_Controller->m_TopologyLock);
 
        if (PortNumber == 0)
        {
            WalkSubtree(UcxDisconnectVisitor, &Endpoints, FALSE);
        }
        else
        {
            /* A new enumeration may already sit on the port beside the old device */
            for (Entry = m_ChildList.Flink; Entry != &m_ChildList; Entry = Entry->Flink)
            {
                Child = CONTAINING_RECORD(Entry, UcxUsbDevice, m_ChildLink);
                const USB_DEVICE_PORT_PATH* Path = &Child->m_Info.PortPath;
 
                if (Path->PortPath[Path->PortPathDepth - 1] == PortNumber)
                    Child->WalkSubtree(UcxDisconnectVisitor, &Endpoints, FALSE);
            }
        }
    }
 
    while (!IsListEmpty(&Endpoints))
    {
        Entry = RemoveHeadList(&Endpoints);
        UcxClearListEntry(Entry);
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DisconnectLink);
 
        /* Root hub endpoints have no machine */
        if (Endpoint->HasMachine())
            Endpoint->Post(EpEvent::HubDisconnect);
 
        WdfObjectDereference(Endpoint->m_Handle);
    }
}

Referenced by DisconnectPort(), UcxController::SetFailed(), and UcxHubDeviceDisconnect().

◆ DispatchManagement()

VOID UcxUsbDevice::DispatchManagement	(	_In_ WDFREQUEST	Request,
		_In_ ULONG	IoControlCode
	)

Definition at line 80 of file devicemgmt.cpp.

{
    UCXCONTROLLER Controller = m_Controller->m_Handle;
    const UCX_USBDEVICE_EVENT_CALLBACKS* Hcd = &m_Callbacks.Public;
    PVOID Arg1 = UcxRequestArgs(Request).Arg1;
    PURB Urb;
 
    KeQuerySystemTime((PLARGE_INTEGER)&m_Timestamp);
 
    DPRINT("UsbDevice %p IOCTL 0x%lx request %p\n", m_Handle, IoControlCode, Request);
 
    switch (IoControlCode)
    {
        case IOCTL_UCXHUB_DEVICE_PURGE_IO:
            HandleHubPurgeIo(Request, ((PUSBDEVICE_PURGEIO)Arg1)->OnSuspend);
            break;
 
        case IOCTL_UCXHUB_DEVICE_ABORT_IO:
            HandleHubAbortIo(Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO:
            HandleHubTreePurge(Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_START_IO:
            HandleHubStartIo(Request);
            break;
 
        case IOCTL_INTERNAL_USB_SUBMIT_URB:
            Urb = (PURB)Arg1;
            if (Urb->UrbHeader.Function == URB_FUNCTION_OPEN_STATIC_STREAMS)
                UcxEndpoint::FromPipe(Urb->UrbOpenStaticStreams.PipeHandle)->HandleClientStreamsEnable(Request);
            else if (Urb->UrbHeader.Function == URB_FUNCTION_CLOSE_STATIC_STREAMS)
                UcxEndpoint::FromPipe(Urb->UrbPipeRequest.PipeHandle)->HandleClientStreamsDisable(Request);
            else
            {
                DPRINT1("UsbDevice %p unexpected URB function 0x%x\n", m_Handle, Urb->UrbHeader.Function);
                WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
            }
            break;
 
        case IOCTL_UCXHUB_DEVICE_RESET:
            HandleHubReset(Request, FALSE);
            break;
 
        case IOCTL_UCXHUB_DEVICE_ADDRESS:
            Hcd->EvtUsbDeviceAddress(Controller, Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_UPDATE:
            UpdateFromHub(Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_HUB_INFO:
            Hcd->EvtUsbDeviceHubInfo(Controller, Request);
            break;
 
        /* Goes to the device's default endpoint, not the one in the payload */
        case IOCTL_UCXHUB_DEFAULT_ENDPOINT_UPDATE:
            m_DefaultEndpoint->m_Callbacks.DefaultEndpointUpdate(Controller, Request);
            break;
 
        case IOCTL_UCXHUB_ENDPOINT_RESET:
            UcxEndpoint::FromHandle(((PENDPOINT_RESET)Arg1)->Endpoint)->HandleHubReset(Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_ENABLE:
            Hcd->EvtUsbDeviceEnable(Controller, Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_DISABLE:
            HandleHubDisable(Request, FALSE);
            break;
 
        case IOCTL_UCXHUB_ENDPOINTS_CONFIGURE:
            HandleHubEndpointsConfigure(Request, FALSE);
            break;
 
        default:
            DPRINT1("UsbDevice %p unexpected IOCTL 0x%lx\n", m_Handle, IoControlCode);
            WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
            break;
    }
}

Referenced by DispatchManagement().

◆ FailManagement()

VOID UcxUsbDevice::FailManagement	(	_In_ WDFREQUEST	Request,
		_In_ ULONG	IoControlCode
	)

Controller reset in progress or device deprogrammed.

Definition at line 170 of file devicemgmt.cpp.

{
    PVOID Arg1 = UcxRequestArgs(Request).Arg1;
    PURB Urb;
 
    switch (IoControlCode)
    {
        /* The suspend hint is dropped on this path */
        case IOCTL_UCXHUB_DEVICE_PURGE_IO:
            HandleHubPurgeIo(Request, FALSE);
            break;
 
        case IOCTL_UCXHUB_DEVICE_ABORT_IO:
            HandleHubAbortIo(Request);
            break;
 
        case IOCTL_UCXHUB_DEVICE_TREE_PURGE_IO:
            HandleHubTreePurge(Request);
            break;
 
        case IOCTL_INTERNAL_USB_SUBMIT_URB:
            Urb = (PURB)Arg1;
            if (Urb->UrbHeader.Function == URB_FUNCTION_OPEN_STATIC_STREAMS)
            {
                UcxEndpoint* Endpoint = UcxEndpoint::FromPipe(Urb->UrbOpenStaticStreams.PipeHandle);
 
                NT_ASSERT(!Endpoint->m_OpenFailedOnReset);
                Endpoint->m_OpenFailedOnReset = TRUE;
                DPRINT1("Endpoint %p static streams open failed by controller reset\n", Endpoint->m_Handle);
                WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
            }
            else if (Urb->UrbHeader.Function == URB_FUNCTION_CLOSE_STATIC_STREAMS)
            {
                UcxEndpoint::FromPipe(Urb->UrbPipeRequest.PipeHandle)->HandleClientStreamsDisable(Request);
            }
            else
            {
                DPRINT1("UsbDevice %p unexpected URB function 0x%x during reset\n", m_Handle, Urb->UrbHeader.Function);
                WdfRequestComplete(Request, STATUS_INVALID_DEVICE_REQUEST);
            }
            break;
 
        case IOCTL_UCXHUB_DEVICE_RESET:
            NT_ASSERT(!m_ResetFailedByControllerReset);
            m_ResetFailedByControllerReset = TRUE;
            HandleHubReset(Request, TRUE);
            break;
 
        case IOCTL_UCXHUB_DEVICE_DISABLE:
            HandleHubDisable(Request, TRUE);
            break;
 
        case IOCTL_UCXHUB_ENDPOINTS_CONFIGURE:
            HandleHubEndpointsConfigure(Request, TRUE);
            break;
 
        case IOCTL_UCXHUB_ENDPOINT_RESET:
            NT_ASSERT(!m_EndpointResetFailedByControllerReset);
            m_EndpointResetFailedByControllerReset = TRUE;
            DPRINT1("UsbDevice %p endpoint reset failed by controller reset\n", m_Handle);
            WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
            break;
 
        default:
            DPRINT1("UsbDevice %p IOCTL 0x%lx failed by controller reset\n", m_Handle, IoControlCode);
            WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
            break;
    }
}

Referenced by FailManagement().

◆ FanOutToEndpoints()

VOID UcxUsbDevice::FanOutToEndpoints ( _In_ EpEvent Event )

private

Definition at line 372 of file devicemgmt.cpp.

{
    LIST_ENTRY Endpoints;
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
    LONG Count = 0;
 
    InitializeListHead(&Endpoints);
 
    {
        SpinLockGuard Guard(&m_Controller->m_TopologyLock);
 
        for (Entry = m_EndpointList.Flink; Entry != &m_EndpointList; Entry = Entry->Flink)
        {
            Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
 
            WdfObjectReference(Endpoint->m_Handle);
            InsertTailList(&Endpoints, &Endpoint->m_OperationLink);
            Count++;
        }
    }
 
    m_PendingOperationCount = Count;
 
    while (!IsListEmpty(&Endpoints))
    {
        Entry = RemoveHeadList(&Endpoints);
        UcxClearListEntry(Entry);
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_OperationLink);
 
        Endpoint->Post(Event);
        WdfObjectDereference(Endpoint->m_Handle);
    }
}

Referenced by FanOutToEndpoints(), HandleHubAbortIo(), HandleHubPurgeIo(), and HandleHubStartIo().

◆ FinishEndpointResetRequest()

VOID UcxUsbDevice::FinishEndpointResetRequest ( )

private

Definition at line 691 of file devicemgmt.cpp.

{
    PIRP Irp;
 
    {
        SpinLockGuard Guard(&m_Controller->m_TopologyLock);
 
        if (m_EndpointsMayLeavePurge && !m_ChildrenMayLeavePurge)
            m_ChildrenMayLeavePurge = TRUE;
    }
 
    Irp = (PIRP)TakeOperation();
    UcxResumeIrpCompletion(Irp, STATUS_SUCCESS);
}

Referenced by FinishEndpointResetRequest(), and OnHcdResetDone().

◆ FromHandle()

UcxUsbDevice * UcxUsbDevice::FromHandle ( _In_ UCXUSBDEVICE Handle )

static

Definition at line 18 of file devobj.cpp.

{
    return UcxGetUsbDeviceContext(Handle);
}

Referenced by Create(), CreateFromHub(), and FromHandle().

◆ HandleHubAbortIo()

VOID UcxUsbDevice::HandleHubAbortIo ( _In_ WDFREQUEST Request )

private

Definition at line 433 of file devicemgmt.cpp.

{
    StartOperation(Request, &UcxUsbDevice::CompleteHubRequest, 0);
    FanOutToEndpoints(EpEvent::HubAbort);
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubAbortIo().

◆ HandleHubDisable()

VOID UcxUsbDevice::HandleHubDisable	(	_In_ WDFREQUEST	Request,
		_In_ BOOLEAN	AfterReset
	)

private

Definition at line 532 of file devicemgmt.cpp.

{
    PUSBDEVICE_DISABLE Disable = (PUSBDEVICE_DISABLE)UcxRequestArgs(Request).Arg1;
    UCXENDPOINT DefaultEndpoint = Disable->DefaultEndpoint;
 
    m_Enabled = FALSE;
    StartOperation(Request,
                   AfterReset ? &UcxUsbDevice::PendDisable : &UcxUsbDevice::SendDisableToController,
                   1);
 
    UcxEndpoint::FromHandle(DefaultEndpoint)->Post(EpEvent::HubDisable);
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubDisable().

◆ HandleHubEndpointsConfigure()

VOID UcxUsbDevice::HandleHubEndpointsConfigure	(	_In_ WDFREQUEST	Request,
		_In_ BOOLEAN	AfterReset
	)

private

Definition at line 548 of file devicemgmt.cpp.

{
    PENDPOINTS_CONFIGURE Configure = (PENDPOINTS_CONFIGURE)UcxRequestArgs(Request).Arg1;
    ULONG Count = Configure->EndpointsToDisableCount;
    UCXENDPOINT* ToDisable = Configure->EndpointsToDisable;
    ULONG Index;
 
    if (Count == 0)
    {
        /* Unlike the parked path, nothing to disable after a reset is a failure here */
        if (AfterReset)
        {
            DPRINT1("UsbDevice %p endpoints configure failed by controller reset\n", m_Handle);
            WdfRequestComplete(Request, STATUS_NO_SUCH_DEVICE);
        }
        else
        {
            m_Callbacks.Public.EvtUsbDeviceEndpointsConfigure(m_Controller->m_Handle, Request);
        }
        return;
    }
 
    StartOperation(Request,
                   AfterReset ? &UcxUsbDevice::PendEndpointsConfigure
                              : &UcxUsbDevice::SendEndpointsConfigureToController,
                   Count);
 
    for (Index = 0; Index < Count; Index++)
        UcxEndpoint::FromHandle(ToDisable[Index])->Post(EpEvent::HubDisable);
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubEndpointsConfigure().

◆ HandleHubPurgeIo()

VOID UcxUsbDevice::HandleHubPurgeIo	(	_In_ WDFREQUEST	Request,
		_In_ BOOLEAN	OnSuspend
	)

private

Definition at line 409 of file devicemgmt.cpp.

{
    if (OnSuspend && m_Callbacks.Public.EvtUsbDeviceSuspend != NULL)
        m_Callbacks.Public.EvtUsbDeviceSuspend(m_Controller->m_Handle, m_Handle);
 
    StartOperation(Request, &UcxUsbDevice::CompleteHubRequest, 0);
    FanOutToEndpoints(EpEvent::HubPurge);
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubPurgeIo().

◆ HandleHubReset()

VOID UcxUsbDevice::HandleHubReset	(	_In_ WDFREQUEST	Request,
		_In_ BOOLEAN	AfterReset
	)

private

Definition at line 501 of file devicemgmt.cpp.

{
    PUSBDEVICE_RESET Reset = (PUSBDEVICE_RESET)UcxRequestArgs(Request).Arg1;
    ULONG Count = Reset->EndpointsToDisableCount;
    UCXENDPOINT* ToDisable = Reset->EndpointsToDisable;
    UCXENDPOINT DefaultEndpoint = Reset->DefaultEndpoint;
    ULONG Index;
 
    {
        SpinLockGuard Guard(&m_Controller->m_TopologyLock);
 
        /* A tree purged device may leave tree purge once its parent has */
        if (!m_EndpointsMayLeavePurge && m_ParentHub->m_ChildrenMayLeavePurge)
            m_EndpointsMayLeavePurge = TRUE;
    }
 
    StartOperation(Request,
                   AfterReset ? &UcxUsbDevice::PendReset : &UcxUsbDevice::SendResetToController,
                   Count + 1);
 
    /* The payload may be gone once the last post finishes the operation */
    for (Index = 0; Index < Count; Index++)
        UcxEndpoint::FromHandle(ToDisable[Index])->Post(EpEvent::HubDeviceReset);
 
    UcxEndpoint::FromHandle(DefaultEndpoint)->Post(EpEvent::HubDeviceReset);
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubReset().

◆ HandleHubStartIo()

VOID UcxUsbDevice::HandleHubStartIo ( _In_ WDFREQUEST Request )

private

Definition at line 422 of file devicemgmt.cpp.

{
    if (m_Callbacks.Public.EvtUsbDeviceResume != NULL)
        m_Callbacks.Public.EvtUsbDeviceResume(m_Controller->m_Handle, m_Handle);
 
    StartOperation(Request, &UcxUsbDevice::CompleteHubRequest, 0);
    FanOutToEndpoints(EpEvent::HubStartRequest);
}

Referenced by DispatchManagement(), and HandleHubStartIo().

◆ HandleHubTreePurge()

VOID UcxUsbDevice::HandleHubTreePurge ( _In_ WDFREQUEST Request )

private

Definition at line 465 of file devicemgmt.cpp.

{
    UcxController* Controller = m_Controller;
    LIST_ENTRY Endpoints;
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
    LONG Count = 0;
 
    InitializeListHead(&Endpoints);
 
    {
        SpinLockGuard Guard(&Controller->m_TopologyLock);
 
        WalkSubtree(UcxTreePurgeVisitor, &Endpoints, TRUE);
    }
 
    for (Entry = Endpoints.Flink; Entry != &Endpoints; Entry = Entry->Flink)
        Count++;
 
    NT_ASSERT(Controller->m_PendingTreePurge == NULL && Controller->m_PendingTreePurgeEndpoints == 0);
    Controller->m_PendingTreePurge = Request;
    Controller->m_PendingTreePurgeEndpoints = Count;
 
    while (!IsListEmpty(&Endpoints))
    {
        Entry = RemoveHeadList(&Endpoints);
        UcxClearListEntry(Entry);
        Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_TreePurgeLink);
 
        Endpoint->Post(EpEvent::HubTreePurge);
        WdfObjectDereference(Endpoint->m_Handle);
    }
}

Referenced by DispatchManagement(), FailManagement(), and HandleHubTreePurge().

◆ InitializeAsRootHub()

VOID UcxUsbDevice::InitializeAsRootHub	(	_In_ UCXROOTHUB	Handle,
		_In_ UcxController *	Controller
	)

Root hub setup; the device context lives on the UCXROOTHUB object.

Definition at line 50 of file devobj.cpp.

{
    m_Handle = (UCXUSBDEVICE)Handle;
    m_Controller = Controller;
    m_Type = UCX_DEVICE_TYPE_HUB | UCX_DEVICE_TYPE_ROOT_HUB;
 
    /* Reported as SuperSpeed for filters that ask the controller about its speed */
    m_Info.Size = sizeof(m_Info);
    m_Info.DeviceSpeed = UsbSuperSpeed;
 
    InitializeLists();
    m_ChildrenMayLeavePurge = TRUE;
    m_EndpointsMayLeavePurge = TRUE;
}

Referenced by UcxRootHub::Initialize(), and InitializeAsRootHub().

◆ InitializeLists()

VOID UcxUsbDevice::InitializeLists ( )

private

Definition at line 36 of file devobj.cpp.

{
    InitializeListHead(&m_ChildList);
    UcxClearListEntry(&m_ChildLink);
    InitializeListHead(&m_EndpointList);
    InitializeListHead(&m_StaleEndpointList);
    KeInitializeSpinLock(&m_TrackingLock);
    InitializeListHead(&m_TrackingList);
    KeInitializeSpinLock(&m_RemoteWakeLock);
    KeInitializeSpinLock(&m_UsbdHandleLock);
    InitializeListHead(&m_UsbdHandleList);
}

Referenced by InitializeAsRootHub(), and InitializeLists().

◆ InitSetEventCallbacks()

VOID UcxUsbDevice::InitSetEventCallbacks	(	_Inout_ PUCXUSBDEVICE_INIT	Init,
		_In_ PUCX_USBDEVICE_EVENT_CALLBACKS	Callbacks
	)

static

Definition at line 71 of file devobj.cpp.

{
    RtlZeroMemory(&Init->Callbacks, sizeof(Init->Callbacks));
    RtlCopyMemory(&Init->Callbacks, Callbacks, min(Callbacks->Size, (ULONG)sizeof(Init->Callbacks)));
}

Referenced by InitSetEventCallbacks().

◆ IsHub()

BOOLEAN UcxUsbDevice::IsHub ( ) const

inline

Definition at line 118 of file devobj.h.

    {
        return (m_Type & UCX_DEVICE_TYPE_HUB) != 0;
    }

◆ IsRootHub()

BOOLEAN UcxUsbDevice::IsRootHub ( ) const

inline

Definition at line 112 of file devobj.h.

    {
        return (m_Type & UCX_DEVICE_TYPE_ROOT_HUB) != 0;
    }

◆ OnHcdEnableDone()

NTSTATUS UcxUsbDevice::OnHcdEnableDone	(	_In_ PIRP	Irp,
		_In_ PUSBDEVICE_ENABLE	Enable
	)

Definition at line 709 of file devicemgmt.cpp.

{
    /* Completed again right here; the hub's routine runs nested */
    if (!NT_SUCCESS(Irp->IoStatus.Status))
    {
        DPRINT1("UsbDevice %p HCD enable failed 0x%lx\n", m_Handle, Irp->IoStatus.Status);
        IoCompleteRequest(Irp, IO_NO_INCREMENT);
        return STATUS_MORE_PROCESSING_REQUIRED;
    }
 
    StartOperation(Irp, &UcxUsbDevice::CompleteEnableIrp, 1);
    m_Enabled = TRUE;
    UcxEndpoint::FromHandle(Enable->DefaultEndpoint)->Post(EpEvent::ConfigureDone);
 
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by OnHcdEnableDone().

◆ OnHcdEndpointsConfigureDone()

NTSTATUS UcxUsbDevice::OnHcdEndpointsConfigureDone	(	_In_ PIRP	Irp,
		_In_ PENDPOINTS_CONFIGURE	Configure
	)

Definition at line 743 of file devicemgmt.cpp.

{
    ULONG Count = Configure->EndpointsToEnableCount;
    UCXENDPOINT* ToEnable = Configure->EndpointsToEnable;
    ULONG Index;
 
    if (!NT_SUCCESS(Irp->IoStatus.Status))
    {
        DPRINT1("UsbDevice %p HCD endpoints configure failed 0x%lx\n", m_Handle, Irp->IoStatus.Status);
        IoCompleteRequest(Irp, IO_NO_INCREMENT);
        return STATUS_MORE_PROCESSING_REQUIRED;
    }
 
    if (Count == 0)
    {
        UcxResumeIrpCompletion(Irp, STATUS_SUCCESS);
        return STATUS_MORE_PROCESSING_REQUIRED;
    }
 
    StartOperation(Irp, &UcxUsbDevice::CompleteEndpointsConfigureIrp, Count);
 
    for (Index = 0; Index < Count; Index++)
        UcxEndpoint::FromHandle(ToEnable[Index])->Post(EpEvent::ConfigureDone);
 
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by OnHcdEndpointsConfigureDone().

◆ OnHcdResetDone()

NTSTATUS UcxUsbDevice::OnHcdResetDone	(	_In_ PIRP	Irp,
		_In_ PUSBDEVICE_RESET	Reset
	)

Definition at line 730 of file devicemgmt.cpp.

{
    NT_ASSERT(NT_SUCCESS(Irp->IoStatus.Status));
 
    StartOperation(Irp, &UcxUsbDevice::FinishEndpointResetRequest, 1);
    UcxEndpoint::FromHandle(Reset->DefaultEndpoint)->Post(EpEvent::DeviceResetDone);
 
    return STATUS_MORE_PROCESSING_REQUIRED;
}

Referenced by OnHcdResetDone().

◆ PendDisable()

VOID UcxUsbDevice::PendDisable ( )

private

Definition at line 642 of file devicemgmt.cpp.

{
    UcxParkDuringReset(this, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubDisable(), and PendDisable().

◆ PendEndpointsConfigure()

VOID UcxUsbDevice::PendEndpointsConfigure ( )

private

Definition at line 648 of file devicemgmt.cpp.

{
    UcxParkDuringReset(this, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubEndpointsConfigure(), and PendEndpointsConfigure().

◆ PendReset()

VOID UcxUsbDevice::PendReset ( )

private

Definition at line 636 of file devicemgmt.cpp.

{
    UcxParkDuringReset(this, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubReset(), and PendReset().

◆ RegisterComposite()

VOID UcxUsbDevice::RegisterComposite ( _In_ WDFREQUEST Request )

Definition at line 640 of file devobj.cpp.

{
    PREGISTER_COMPOSITE_DEVICE Register = (PREGISTER_COMPOSITE_DEVICE)UcxRequestArgs(Request).Arg1;
    PUSBD_FUNCTION_HANDLE Handles;
    WDF_OBJECT_ATTRIBUTES Attributes;
    UcxFunctionRecord* Records;
    WDFMEMORY Memory;
    ULONG Index;
    NTSTATUS Status;
 
    Handles = (PUSBD_FUNCTION_HANDLE)WdfRequestWdmGetIrp(Request)->AssociatedIrp.SystemBuffer;
 
    if (Register == NULL || Handles == NULL ||
        Register->Size != sizeof(*Register) ||
        Register->Version != UCX_COMPOSITE_VERSION ||
        Register->FunctionCount == 0 ||
        Register->FunctionCount > UCX_MAX_COMPOSITE_FUNCTIONS)
    {
        DPRINT1("UsbDevice %p composite register rejected, request %p\n", m_Handle, Request);
        WdfRequestComplete(Request, STATUS_INVALID_PARAMETER);
        return;
    }
 
    WDF_OBJECT_ATTRIBUTES_INIT(&Attributes);
    Attributes.ParentObject = m_Handle;
 
    Status = WdfMemoryCreate(&Attributes,
                             NonPagedPool,
                             UCX_POOL_TAG,
                             Register->FunctionCount * sizeof(UcxFunctionRecord),
                             &Memory,
                             (PVOID*)&Records);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UsbDevice %p function records allocation failed 0x%lx\n", m_Handle, Status);
        WdfRequestComplete(Request, Status);
        return;
    }
 
    RtlZeroMemory(Records, Register->FunctionCount * sizeof(UcxFunctionRecord));
 
    {
        SpinLockGuard Guard(&m_RemoteWakeLock);
 
        if (m_FunctionsMemory != NULL)
        {
            Status = STATUS_INVALID_DEVICE_STATE;
        }
        else
        {
            m_FunctionCount = Register->FunctionCount;
            m_Functions = Records;
            m_FunctionsMemory = Memory;
        }
    }
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UsbDevice %p is already registered as composite\n", m_Handle);
        WdfObjectDelete(Memory);
        WdfRequestComplete(Request, Status);
        return;
    }
 
    /* The output length is not checked */
    for (Index = 0; Index < Register->FunctionCount; Index++)
    {
        Records[Index].Index = Index;
        Records[Index].Device = this;
        Handles[Index] = (USBD_FUNCTION_HANDLE)&Records[Index];
    }
 
    WdfRequestComplete(Request, STATUS_SUCCESS);
}

Referenced by RegisterComposite().

◆ RemoteWakeNotification()

VOID UcxUsbDevice::RemoteWakeNotification ( _In_ ULONG Interface )

Function wake from a device; completes the matching armed notification.

Definition at line 189 of file devobj.cpp.

{
    UcxRemoteWakeSlot* Slot = NULL;
    WDFREQUEST Request;
    KIRQL OldIrql;
    ULONG Index;
 
    KeAcquireSpinLock(&m_RemoteWakeLock, &OldIrql);
 
    if (m_Functions == NULL)
    {
        if (m_RemoteWake.Request != NULL && m_RemoteWake.Params->Interface == Interface)
            Slot = &m_RemoteWake;
    }
    else
    {
        for (Index = 0; Index < m_FunctionCount; Index++)
        {
            UcxRemoteWakeSlot* Candidate = &m_Functions[Index].Wake;
 
            if (Candidate->Request != NULL && Candidate->Params->Interface == Interface)
            {
                Slot = Candidate;
                break;
            }
        }
    }
 
    if (Slot == NULL)
    {
        KeReleaseSpinLock(&m_RemoteWakeLock, OldIrql);
        DPRINT1("UsbDevice %p remote wake on interface %lu with no armed request\n", m_Handle, Interface);
        return;
    }
 
    /* A failed unmark means the cancel routine owns the request */
    if (!NT_SUCCESS(WdfRequestUnmarkCancelable(Slot->Request)))
    {
        KeReleaseSpinLock(&m_RemoteWakeLock, OldIrql);
        DPRINT("UsbDevice %p remote wake request is being canceled\n", m_Handle);
        return;
    }
 
    Request = Slot->Request;
    Slot->Request = NULL;
    Slot->Params = NULL;
 
    KeReleaseSpinLock(&m_RemoteWakeLock, OldIrql);
 
    DPRINT("UsbDevice %p remote wake on interface %lu\n", m_Handle, Interface);
    WdfRequestComplete(Request, STATUS_SUCCESS);
}

Referenced by RemoteWakeNotification(), and UcxApiUsbDeviceRemoteWakeNotification().

◆ ReportNoPingResponseIfPending()

VOID UcxUsbDevice::ReportNoPingResponseIfPending ( )

Called by failing transfer completions; tells the parent hub once per error.

Definition at line 521 of file devobj.cpp.

{
    UcxUsbDevice* Parent = m_ParentHub;
 
    if (InterlockedExchange(&m_PendingNoPingResponse, 0) != 1)
        return;
 
    if (Parent != NULL && Parent->m_HubNoPingResponse != NULL)
        Parent->m_HubNoPingResponse(Parent->m_HubContext, m_HubDeviceContext);
}

Referenced by ReportNoPingResponseIfPending().

◆ RequestRemoteWakeNotification()

VOID UcxUsbDevice::RequestRemoteWakeNotification ( _In_ WDFREQUEST Request )

Definition at line 764 of file devobj.cpp.

{
    PREQUEST_REMOTE_WAKE_NOTIFICATION Params;
    UcxRemoteWakeSlot* Slot;
    NTSTATUS Status;
    KIRQL OldIrql;
 
    Params = (PREQUEST_REMOTE_WAKE_NOTIFICATION)UcxRequestArgs(Request).Arg1;
    if (Params == NULL)
    {
        DPRINT1("UsbDevice %p remote wake request %p has no parameters\n", m_Handle, Request);
        WdfRequestComplete(Request, STATUS_INVALID_PARAMETER);
        return;
    }
 
    KeAcquireSpinLock(&m_RemoteWakeLock, &OldIrql);
 
    if ((m_Functions == NULL) != (Params->UsbdFunctionHandle == NULL))
    {
        Status = STATUS_INVALID_PARAMETER;
    }
    else
    {
        Slot = (m_Functions == NULL) ? &m_RemoteWake
                                     : &((UcxFunctionRecord*)Params->UsbdFunctionHandle)->Wake;
 
        if (Slot->Request != NULL)
        {
            Status = STATUS_INVALID_DEVICE_STATE;
        }
        else
        {
            Status = WdfRequestMarkCancelableEx(Request, UcxUsbDevice::EvtRemoteWakeCancel);
            if (NT_SUCCESS(Status))
            {
                Slot->Request = Request;
                Slot->Params = Params;
            }
        }
    }
 
    KeReleaseSpinLock(&m_RemoteWakeLock, OldIrql);
 
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("UsbDevice %p remote wake request %p failed 0x%lx\n", m_Handle, Request, Status);
        WdfRequestComplete(Request, Status);
    }
}

Referenced by RequestRemoteWakeNotification().

◆ SendDisableToController()

VOID UcxUsbDevice::SendDisableToController ( )

private

Definition at line 609 of file devicemgmt.cpp.

{
    m_Callbacks.Public.EvtUsbDeviceDisable(m_Controller->m_Handle, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubDisable(), and SendDisableToController().

◆ SendEndpointsConfigureToController()

VOID UcxUsbDevice::SendEndpointsConfigureToController ( )

private

Definition at line 615 of file devicemgmt.cpp.

{
    m_Callbacks.Public.EvtUsbDeviceEndpointsConfigure(m_Controller->m_Handle, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubEndpointsConfigure(), and SendEndpointsConfigureToController().

◆ SendResetToController()

VOID UcxUsbDevice::SendResetToController ( )

private

Definition at line 603 of file devicemgmt.cpp.

{
    m_Callbacks.Public.EvtUsbDeviceReset(m_Controller->m_Handle, (WDFREQUEST)TakeOperation());
}

Referenced by HandleHubReset(), and SendResetToController().

◆ SetFunctionData()

VOID UcxUsbDevice::SetFunctionData ( _In_ WDFREQUEST Request )

Definition at line 747 of file devobj.cpp.

{
    PUCXHUB_FUNCTION_DATA Data;
 
    Data = (PUCXHUB_FUNCTION_DATA)WdfRequestWdmGetIrp(Request)->AssociatedIrp.SystemBuffer;
 
    {
        SpinLockGuard Guard(&m_RemoteWakeLock);
 
        ((UcxFunctionRecord*)Data->FunctionHandle)->ClientPdo = Data->PhysicalDeviceObject;
    }
 
    WdfRequestComplete(Request, STATUS_SUCCESS);
}

Referenced by SetFunctionData().

◆ SetPdo()

VOID UcxUsbDevice::SetPdo ( _In_ PDEVICE_OBJECT Pdo )

Definition at line 489 of file devobj.cpp.

{
    NT_ASSERT(m_Pdo == NULL);
    m_Pdo = Pdo;
}

Referenced by SetPdo(), and UcxHubDeviceSetPdo().

◆ Speed()

USB_DEVICE_SPEED UcxUsbDevice::Speed ( ) const

inline

Definition at line 124 of file devobj.h.

    {
        return m_Info.DeviceSpeed;
    }

◆ StartOperation()

VOID UcxUsbDevice::StartOperation	(	_In_ PVOID	Pending,
		_In_ PFN_UCX_OPERATION_DONE	Done,
		_In_ LONG	Count
	)

private

Definition at line 345 of file devicemgmt.cpp.

{
    NT_ASSERT(m_PendingOperation == NULL && m_PendingOperationDone == NULL);
 
    m_PendingOperation = Pending;
    m_PendingOperationDone = Done;
    m_PendingOperationCount = Count;
}

Referenced by HandleHubAbortIo(), HandleHubDisable(), HandleHubEndpointsConfigure(), HandleHubPurgeIo(), HandleHubReset(), HandleHubStartIo(), OnHcdEnableDone(), OnHcdEndpointsConfigureDone(), OnHcdResetDone(), and StartOperation().

◆ TakeOperation()

PVOID UcxUsbDevice::TakeOperation ( )

inlineprivate

Definition at line 290 of file devobj.h.

    {
        PVOID Pending = m_PendingOperation;
 
        m_PendingOperation = NULL;
        return Pending;
    }

Referenced by CompleteEnableIrp(), CompleteEndpointsConfigureIrp(), CompleteHubRequest(), FinishEndpointResetRequest(), PendDisable(), PendEndpointsConfigure(), PendReset(), SendDisableToController(), SendEndpointsConfigureToController(), and SendResetToController().

◆ Timestamp()

ULONG64 UcxUsbDevice::Timestamp ( ) const

inline

Definition at line 99 of file devobj.h.

    {
        return m_Timestamp;
    }

Referenced by UcxHubDeviceGetTimestamp().

◆ TrackStaleHandles()

VOID UcxUsbDevice::TrackStaleHandles ( )

Pipe handles are checked against the live endpoint list from now on.

Definition at line 500 of file devobj.cpp.

{
    PLIST_ENTRY Entry;
    UcxEndpoint* Endpoint;
 
    SpinLockGuard Topology(&m_Controller->m_TopologyLock);
 
    KeAcquireSpinLockAtDpcLevel(&m_TrackingLock);
    if (!m_StalePipeIoAllowed)
    {
        for (Entry = m_EndpointList.Flink; Entry != &m_EndpointList; Entry = Entry->Flink)
        {
            Endpoint = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
            InsertTailList(&m_TrackingList, &Endpoint->m_TrackingLink);
        }
        m_StalePipeIoAllowed = TRUE;
    }
    KeReleaseSpinLockFromDpcLevel(&m_TrackingLock);
}

Referenced by TrackStaleHandles(), and UpdateFromHub().

◆ UnregisterComposite()

VOID UcxUsbDevice::UnregisterComposite ( _In_ WDFREQUEST Request )

Definition at line 718 of file devobj.cpp.

{
    WDFMEMORY Memory = NULL;
 
    {
        SpinLockGuard Guard(&m_RemoteWakeLock);
 
        if (m_FunctionsMemory != NULL)
        {
            Memory = m_FunctionsMemory;
            m_FunctionsMemory = NULL;
            m_Functions = NULL;
            m_FunctionCount = 0;
        }
    }
 
    if (Memory == NULL)
    {
        DPRINT1("UsbDevice %p composite unregister without a registration\n", m_Handle);
        WdfRequestComplete(Request, STATUS_INVALID_DEVICE_STATE);
        return;
    }
 
    WdfObjectDelete(Memory);
    WdfRequestComplete(Request, STATUS_SUCCESS);
}

Referenced by UnregisterComposite().

◆ UpdateFromHub()

VOID UcxUsbDevice::UpdateFromHub ( _In_ WDFREQUEST Request )

private

Definition at line 583 of file devicemgmt.cpp.

{
    PUSBDEVICE_UPDATE Update = (PUSBDEVICE_UPDATE)UcxRequestArgs(Request).Arg1;
 
    if (Update->Flags.UpdateIsHub && Update->IsHub)
        m_Type |= UCX_DEVICE_TYPE_HUB;
 
    if (Update->Flags.UpdateAllowIoOnInvalidPipeHandles)
        TrackStaleHandles();
 
    if (Update->Flags.UpdateDeviceDescriptor)
        m_BcdUsb = Update->DeviceDescriptor->bcdUSB;
 
    m_Callbacks.Public.EvtUsbDeviceUpdate(m_Controller->m_Handle, Request);
}

Referenced by DispatchManagement(), and UpdateFromHub().

◆ WalkSubtree()

VOID UcxUsbDevice::WalkSubtree	(	_In_ PFN_UCX_DEVICE_VISITOR	Visitor,
		_In_opt_ PVOID	Context,
		_In_ BOOLEAN	IncludeDisconnected
	)

Definition at line 396 of file devobj.cpp.

{
    PLIST_ENTRY Entry;
    UcxUsbDevice* Child;
 
    if (!IncludeDisconnected && m_Disconnected)
        return;
 
    Visitor(this, Context);
 
    for (Entry = m_ChildList.Flink; Entry != &m_ChildList; Entry = Entry->Flink)
    {
        Child = CONTAINING_RECORD(Entry, UcxUsbDevice, m_ChildLink);
        Child->WalkSubtree(Visitor, Context, IncludeDisconnected);
    }
}

Referenced by DisconnectPort(), HandleHubTreePurge(), UcxController::WalkDevices(), and WalkSubtree().

Member Data Documentation

◆ EvtDestroy

VOID UcxUsbDevice::EvtDestroy

staticprivate

Definition at line 352 of file devobj.h.

Referenced by Create().

◆ EvtRemoteWakeCancel

VOID UcxUsbDevice::EvtRemoteWakeCancel

staticprivate

Definition at line 355 of file devobj.h.

Referenced by RequestRemoteWakeNotification().

◆ m_BcdUsb

USHORT UcxUsbDevice::m_BcdUsb

Definition at line 220 of file devobj.h.

Referenced by UpdateFromHub().

◆ m_Callbacks

UcxUsbDeviceCallbacks UcxUsbDevice::m_Callbacks

Definition at line 222 of file devobj.h.

Referenced by DispatchManagement(), HandleHubEndpointsConfigure(), HandleHubPurgeIo(), HandleHubStartIo(), SendDisableToController(), SendEndpointsConfigureToController(), SendResetToController(), and UpdateFromHub().

◆ m_ChildLink

LIST_ENTRY UcxUsbDevice::m_ChildLink

Definition at line 228 of file devobj.h.

Referenced by DisconnectPort(), InitializeLists(), and WalkSubtree().

◆ m_ChildList

LIST_ENTRY UcxUsbDevice::m_ChildList

Definition at line 227 of file devobj.h.

Referenced by DisconnectPort(), InitializeLists(), and WalkSubtree().

◆ m_ChildrenMayLeavePurge

BOOLEAN UcxUsbDevice::m_ChildrenMayLeavePurge

Definition at line 232 of file devobj.h.

Referenced by FinishEndpointResetRequest(), HandleHubReset(), and InitializeAsRootHub().

◆ m_Controller

◆ m_DefaultEndpoint

UcxEndpoint* UcxUsbDevice::m_DefaultEndpoint

Definition at line 240 of file devobj.h.

Referenced by _IRQL_requires_(), and DispatchManagement().

◆ m_DefaultPipe

UcxPipe* UcxUsbDevice::m_DefaultPipe

Definition at line 241 of file devobj.h.

Referenced by _IRQL_requires_().

◆ m_DeprogrammedByControllerReset

BOOLEAN UcxUsbDevice::m_DeprogrammedByControllerReset

Definition at line 244 of file devobj.h.

Referenced by AllowsEndpointStart(), CompleteEnableIrp(), and EndpointMachine::DeviceDeprogrammed().

◆ m_Disconnected

BOOLEAN UcxUsbDevice::m_Disconnected

Definition at line 231 of file devobj.h.

Referenced by AllowsEndpointStart(), EndpointMachine::DeviceDisconnected(), UcxHubIsDeviceDisconnected(), and WalkSubtree().

◆ m_Enabled

BOOLEAN UcxUsbDevice::m_Enabled

Definition at line 243 of file devobj.h.

Referenced by AllowsEndpointStart(), HandleHubDisable(), and OnHcdEnableDone().

◆ m_EndpointList

LIST_ENTRY UcxUsbDevice::m_EndpointList

Definition at line 229 of file devobj.h.

Referenced by FanOutToEndpoints(), InitializeLists(), and TrackStaleHandles().

◆ m_EndpointResetFailedByControllerReset

BOOLEAN UcxUsbDevice::m_EndpointResetFailedByControllerReset

Definition at line 249 of file devobj.h.

Referenced by FailManagement().

◆ m_EndpointsMayLeavePurge

BOOLEAN UcxUsbDevice::m_EndpointsMayLeavePurge

Definition at line 233 of file devobj.h.

Referenced by AllowsEndpointStart(), FinishEndpointResetRequest(), HandleHubReset(), and InitializeAsRootHub().

◆ m_FailNextStreamClose

BOOLEAN UcxUsbDevice::m_FailNextStreamClose

Definition at line 250 of file devobj.h.

◆ m_FunctionCount

ULONG UcxUsbDevice::m_FunctionCount

Definition at line 269 of file devobj.h.

Referenced by RegisterComposite(), RemoteWakeNotification(), and UnregisterComposite().

◆ m_Functions

UcxFunctionRecord* UcxUsbDevice::m_Functions

Definition at line 270 of file devobj.h.

Referenced by RegisterComposite(), RemoteWakeNotification(), RequestRemoteWakeNotification(), and UnregisterComposite().

◆ m_FunctionsMemory

WDFMEMORY UcxUsbDevice::m_FunctionsMemory

Definition at line 271 of file devobj.h.

Referenced by RegisterComposite(), and UnregisterComposite().

◆ m_Handle

UCXUSBDEVICE UcxUsbDevice::m_Handle

Definition at line 215 of file devobj.h.

Referenced by _IRQL_requires_(), CompleteEnableIrp(), Create(), DeleteFromHub(), DisconnectPort(), DispatchManagement(), FailManagement(), HandleHubEndpointsConfigure(), HandleHubPurgeIo(), HandleHubStartIo(), InitializeAsRootHub(), OnHcdEnableDone(), OnHcdEndpointsConfigureDone(), RegisterComposite(), RemoteWakeNotification(), RequestRemoteWakeNotification(), and UnregisterComposite().

◆ m_HubClearTtBuffer

PFN_UCXHUB_CLEAR_TT_BUFFER UcxUsbDevice::m_HubClearTtBuffer

Definition at line 262 of file devobj.h.

◆ m_HubContext

UCXHUB_HUB_CONTEXT UcxUsbDevice::m_HubContext

Definition at line 261 of file devobj.h.

◆ m_HubDeviceContext

UCXHUB_DEVICE_CONTEXT UcxUsbDevice::m_HubDeviceContext

Definition at line 218 of file devobj.h.

Referenced by UcxEndpoint::NeedToCancelTransfers(), and ReportNoPingResponseIfPending().

◆ m_HubNoPingResponse

PFN_UCXHUB_NO_PING_RESPONSE UcxUsbDevice::m_HubNoPingResponse

Definition at line 263 of file devobj.h.

◆ m_HubUsesGrownInterface

BOOLEAN UcxUsbDevice::m_HubUsesGrownInterface

Definition at line 264 of file devobj.h.

◆ m_Info

UCXUSBDEVICE_INFO UcxUsbDevice::m_Info

Definition at line 221 of file devobj.h.

Referenced by InitializeAsRootHub(), UcxEndpoint::NeedToCancelTransfers(), and Speed().

◆ m_ParentHub

UcxUsbDevice* UcxUsbDevice::m_ParentHub

Definition at line 217 of file devobj.h.

Referenced by HandleHubReset(), and ReportNoPingResponseIfPending().

◆ m_Pdo

PDEVICE_OBJECT UcxUsbDevice::m_Pdo

Definition at line 223 of file devobj.h.

Referenced by SetPdo().

◆ m_PendingDelete

BOOLEAN UcxUsbDevice::m_PendingDelete

Definition at line 245 of file devobj.h.

Referenced by DeleteFromHub().

◆ m_PendingNoPingResponse

LONG UcxUsbDevice::m_PendingNoPingResponse

Definition at line 257 of file devobj.h.

Referenced by ReportNoPingResponseIfPending(), and UcxApiEndpointNoPingResponseError().

◆ m_PendingOperation

PVOID UcxUsbDevice::m_PendingOperation

Definition at line 253 of file devobj.h.

Referenced by StartOperation(), and TakeOperation().

◆ m_PendingOperationCount

LONG UcxUsbDevice::m_PendingOperationCount

Definition at line 255 of file devobj.h.

Referenced by CompleteHubOperation(), FanOutToEndpoints(), and StartOperation().

◆ m_PendingOperationDone

PFN_UCX_OPERATION_DONE UcxUsbDevice::m_PendingOperationDone

Definition at line 254 of file devobj.h.

Referenced by CompleteHubOperation(), and StartOperation().

◆ m_RemoteWake

UcxRemoteWakeSlot UcxUsbDevice::m_RemoteWake

Definition at line 268 of file devobj.h.

Referenced by RemoteWakeNotification(), and RequestRemoteWakeNotification().

◆ m_RemoteWakeLock

KSPIN_LOCK UcxUsbDevice::m_RemoteWakeLock

Definition at line 267 of file devobj.h.

Referenced by InitializeLists(), RegisterComposite(), RemoteWakeNotification(), RequestRemoteWakeNotification(), SetFunctionData(), and UnregisterComposite().

◆ m_ResetFailedByControllerReset

BOOLEAN UcxUsbDevice::m_ResetFailedByControllerReset

Definition at line 248 of file devobj.h.

Referenced by FailManagement().

◆ m_StaleEndpointList

LIST_ENTRY UcxUsbDevice::m_StaleEndpointList

Definition at line 230 of file devobj.h.

Referenced by DeleteFromHub(), and InitializeLists().

◆ m_StalePipeIoAllowed

BOOLEAN UcxUsbDevice::m_StalePipeIoAllowed

Definition at line 238 of file devobj.h.

Referenced by TrackStaleHandles().

◆ m_Timestamp

ULONG64 UcxUsbDevice::m_Timestamp

Definition at line 224 of file devobj.h.

Referenced by DispatchManagement(), and Timestamp().

◆ m_TrackingList

LIST_ENTRY UcxUsbDevice::m_TrackingList

Definition at line 237 of file devobj.h.

Referenced by InitializeLists(), and TrackStaleHandles().

◆ m_TrackingLock

KSPIN_LOCK UcxUsbDevice::m_TrackingLock

Definition at line 236 of file devobj.h.

Referenced by InitializeLists(), and TrackStaleHandles().

◆ m_TransferFailureCount

ULONG UcxUsbDevice::m_TransferFailureCount

Definition at line 258 of file devobj.h.

◆ m_Type

ULONG UcxUsbDevice::m_Type

Definition at line 219 of file devobj.h.

Referenced by InitializeAsRootHub(), IsHub(), IsRootHub(), and UpdateFromHub().

◆ m_UsbdHandleList

LIST_ENTRY UcxUsbDevice::m_UsbdHandleList

Definition at line 275 of file devobj.h.

Referenced by InitializeLists().

◆ m_UsbdHandleLock

KSPIN_LOCK UcxUsbDevice::m_UsbdHandleLock

Definition at line 274 of file devobj.h.

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

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

drivers/usb/ucx01000/devobj.h
drivers/usb/ucx01000/devicemgmt.cpp
drivers/usb/ucx01000/devobj.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ PFN_UCX_OPERATION_DONE

Member Function Documentation

◆ _IRQL_requires_()

◆ AllowsEndpointStart()

◆ CompleteEnableIrp()

◆ CompleteEndpointsConfigureIrp()

◆ CompleteHubOperation()

◆ CompleteHubRequest()

◆ Create()

◆ CreateFromHub()

◆ DeleteFromHub()

◆ DisconnectPort()

◆ DispatchManagement()

◆ FailManagement()

◆ FanOutToEndpoints()

◆ FinishEndpointResetRequest()

◆ FromHandle()

◆ HandleHubAbortIo()

◆ HandleHubDisable()

◆ HandleHubEndpointsConfigure()

◆ HandleHubPurgeIo()

◆ HandleHubReset()

◆ HandleHubStartIo()

◆ HandleHubTreePurge()

◆ InitializeAsRootHub()

◆ InitializeLists()

◆ InitSetEventCallbacks()

◆ IsHub()

◆ IsRootHub()

◆ OnHcdEnableDone()

◆ OnHcdEndpointsConfigureDone()

◆ OnHcdResetDone()

◆ PendDisable()

◆ PendEndpointsConfigure()

◆ PendReset()

◆ RegisterComposite()

◆ RemoteWakeNotification()

◆ ReportNoPingResponseIfPending()

◆ RequestRemoteWakeNotification()

◆ SendDisableToController()

◆ SendEndpointsConfigureToController()

◆ SendResetToController()

◆ SetFunctionData()

◆ SetPdo()

◆ Speed()

◆ StartOperation()

◆ TakeOperation()

◆ Timestamp()

◆ TrackStaleHandles()

◆ UnregisterComposite()

◆ UpdateFromHub()

◆ WalkSubtree()

Member Data Documentation

◆ EvtDestroy

◆ EvtRemoteWakeCancel

◆ m_BcdUsb

◆ m_Callbacks

◆ m_ChildLink

◆ m_ChildList

◆ m_ChildrenMayLeavePurge

◆ m_Controller

◆ m_DefaultEndpoint

◆ m_DefaultPipe

◆ m_DeprogrammedByControllerReset

◆ m_Disconnected

◆ m_Enabled

◆ m_EndpointList

◆ m_EndpointResetFailedByControllerReset

◆ m_EndpointsMayLeavePurge

◆ m_FailNextStreamClose

◆ m_FunctionCount

◆ m_Functions