#include <epsm.h>

Inheritance diagram for EndpointMachine:

Collaboration diagram for EndpointMachine:

[legend]

Public Member Functions
VOID	Initialize (_In_ UcxEndpoint *Endpoint)

UcxEndpoint *	Endpoint () const

Public Member Functions inherited from SmMachine< EndpointMachine, EpEvent >
VOID	SmInitialize (_In_ const State *Initial)

BOOLEAN	SmPost (_In_ EpEvent Ev)

VOID	SmContinueOnPassive ()

const State *	SmCurrent () const

ULONG	SmDepth () const

const State *	SmFrame (_In_ ULONG Index) const

BOOLEAN	SmIsIn (_In_ const State *Ancestor) const

BOOLEAN	SmIsPaused () const

BOOLEAN	SmIsWaitingForTimer () const

ULONG	SmUnexpectedCount () const

Static Public Attributes
static const SM_EVENT_INFO	EventInfo []

Private Types
enum	PURGE_FOLLOW_UP { PurgeFollowUpNone , PurgeFollowUpHubOperation , PurgeFollowUpTreePurge }

Private Member Functions
BOOLEAN	SmAccepts (_In_ EpEvent Event)
	Abort URB is only taken while running; the caller fails the URB on FALSE.

VOID	SmReference ()

VOID	SmDereference ()

SM_RESULT	OnInactive (_In_ EpEvent Event)

SM_RESULT	OnCreated (_In_ EpEvent Event)

SM_RESULT	OnDisabled (_In_ EpEvent Event)

SM_RESULT	OnRetired (_In_ EpEvent Event)

SM_RESULT	OnStale (_In_ EpEvent Event)

SM_RESULT	OnEnabled (_In_ EpEvent Event)

SM_RESULT	OnBusy (_In_ EpEvent Event)

SM_RESULT	OnPurging (_In_ EpEvent Event)

SM_RESULT	OnOperation (_In_ EpEvent Event)

SM_RESULT	OnAwaitingAbortUrb (_In_ EpEvent Event)

SM_RESULT	OnAborting (_In_ EpEvent Event)

SM_RESULT	OnEnablingStreams (_In_ EpEvent Event)

SM_RESULT	OnDisablingStreams (_In_ EpEvent Event)

SM_RESULT	OnResettingPipe (_In_ EpEvent Event)

SM_RESULT	OnOperationHeld (_In_ EpEvent Event)

SM_RESULT	OnOperationUnwinding (_In_ EpEvent Event)
	Reset under an outstanding operation: finish it, then purge.

SM_RESULT	EnterPurging ()

SM_RESULT	EnterAborting ()

SM_RESULT	EnterEnablingStreams ()

SM_RESULT	EnterDisablingStreams ()

SM_RESULT	EnterResettingPipe ()

SM_RESULT	EnterOperationHeld ()

SM_RESULT	PauseForControllerReset ()
	Pause before the ack; nothing may touch the machine after it.

SM_RESULT	StartPurge (_In_ PURGE_FOLLOW_UP FollowUp)

SM_RESULT	BeginOperation (_In_ const State Target, _In_ const State ReturnTo)

SM_RESULT	TryStart ()

SM_RESULT	Retire ()
	An endpoint the client still has a handle to stays around as stale.

BOOLEAN	CanStart ()

VOID	ReferenceEndpoint ()

VOID	DereferenceEndpoint ()

VOID	StartEndpoint ()

VOID	PurgeEndpoint ()

VOID	AbortEndpoint ()

VOID	ForwardResetRequest ()

VOID	FailResetRequest ()

VOID	FinishEndpointResetRequest ()

VOID	ForwardStreamsEnableRequest ()

VOID	RejectStreamsEnableRequest ()

VOID	FinishStreamsOpenRequest (_In_ BOOLEAN ForceFailure)

VOID	ForwardStreamsDisableRequest ()

VOID	ParkStreamsDisableRequest ()

VOID	FinishStreamsCloseRequest ()

VOID	CompleteAbortUrb ()

VOID	CompleteHubOperation ()

VOID	CompleteTreePurge ()

VOID	AckControllerReset ()

VOID	DeleteEndpoint ()

BOOLEAN	ParkAsStale ()

VOID	DeleteStaleEndpoint ()

BOOLEAN	DeviceAllowsStart ()

BOOLEAN	DeviceDeprogrammed ()

BOOLEAN	DeviceDisconnected ()

BOOLEAN	ClientHoldsHandle ()

Private Attributes
UcxEndpoint *	m_Endpoint

const State *	m_ReturnTo

const State *	m_HeldOperation

PURGE_FOLLOW_UP	m_AfterPurge

BOOLEAN	m_Enabled

BOOLEAN	m_AbortForHub

BOOLEAN	m_PauseAfterPurge

Static Private Attributes
static const State	Inactive

static const State	Created

static const State	Disabled

static const State	Retired

static const State	Stale

static const State	AwaitingDestroy

static const State	Enabled

static const State	Busy

static const State	Purging

static const State	Operation

static const State	AwaitingAbortUrb

static const State	Aborting

static const State	EnablingStreams

static const State	DisablingStreams

static const State	ResettingPipe

static const State	OperationHeld

static const State	OperationUnwinding

Friends
class	SmMachine< EndpointMachine, EpEvent >

Additional Inherited Members
Public Types inherited from SmMachine< EndpointMachine, EpEvent >
typedef SmState< EndpointMachine, EpEvent >	State

Protected Member Functions inherited from SmMachine< EndpointMachine, EpEvent >
VOID	SmBeginPause ()

VOID	SmDiscardQueued (_In_ EpEvent Ev)

BOOLEAN	SmAccepts (_In_ EpEvent Ev)

VOID	SmReference ()

VOID	SmDereference ()

VOID	SmQueuePassive ()

VOID	SmOnDequeue (_In_ EpEvent Ev)

VOID	SmStateChanged ()

BOOLEAN	SmCancelTimer ()

Static Protected Member Functions inherited from SmMachine< EndpointMachine, EpEvent >
static SM_RESULT	SmMakeResult (_In_ SM_RESULT_KIND Kind, _In_ USHORT Ev, _In_opt_ const VOID *Target)

static SM_RESULT	SmHandled ()

static SM_RESULT	SmUnhandled ()

static SM_RESULT	SmTransition (_In_ const State *Target)

static SM_RESULT	SmPaused ()

static SM_RESULT	SmCall (_In_ const State *Start)

static SM_RESULT	SmReturn (_In_ EpEvent Ev)

Static Protected Attributes inherited from SmMachine< EndpointMachine, EpEvent >
static const BOOLEAN	SmCompletionsFirst

static const USHORT	SmTimerEventId

Detailed Description

Definition at line 48 of file epsm.h.

Member Enumeration Documentation

◆ PURGE_FOLLOW_UP

enum EndpointMachine::PURGE_FOLLOW_UP

private

Enumerator
PurgeFollowUpNone
PurgeFollowUpHubOperation
PurgeFollowUpTreePurge

Definition at line 66 of file epsm.h.

    {
        PurgeFollowUpNone,
        PurgeFollowUpHubOperation,
        PurgeFollowUpTreePurge
    };

Member Function Documentation

◆ AbortEndpoint()

VOID EndpointMachine::AbortEndpoint ( )

private

Definition at line 676 of file pipe.cpp.

{
    m_Endpoint->m_Callbacks.Abort(m_Endpoint->m_Controller->m_Handle, m_Endpoint->m_Handle);
}

Referenced by EnterAborting().

◆ AckControllerReset()

VOID EndpointMachine::AckControllerReset ( )

private

Definition at line 816 of file pipe.cpp.

{
    m_Endpoint->m_Controller->PrepareForResetOperationDone();
}

Referenced by OnRetired(), and PauseForControllerReset().

◆ BeginOperation()

SM_RESULT EndpointMachine::BeginOperation	(	_In_ const State *	Target,
		_In_ const State *	ReturnTo
	)

private

Definition at line 563 of file epsm.cpp.

{
    m_ReturnTo = ReturnTo;
    return SmTransition(Target);
}

Referenced by OnDisabled(), and OnEnabled().

◆ CanStart()

BOOLEAN EndpointMachine::CanStart ( )

private

Definition at line 606 of file epsm.cpp.

{
    return m_Enabled && DeviceAllowsStart();
}

Referenced by OnCreated(), and TryStart().

◆ ClientHoldsHandle()

BOOLEAN EndpointMachine::ClientHoldsHandle ( )

private

Definition at line 943 of file pipe.cpp.

{
    return m_Endpoint->m_ClientHoldsHandle;
}

Referenced by Retire().

◆ CompleteAbortUrb()

VOID EndpointMachine::CompleteAbortUrb ( )

private

Definition at line 783 of file pipe.cpp.

{
    PIRP Irp = IoCsqRemoveIrp(&m_Endpoint->m_Controller->m_AbortPipeCsq, &m_Endpoint->m_AbortCsqContext);
    PURB Urb;
 
    if (Irp == NULL)
        return;
 
    Urb = (PURB)IoGetCurrentIrpStackLocation(Irp)->Parameters.Others.Argument1;
    UcxCompleteUrbAtDispatch(Irp, Urb, STATUS_SUCCESS, USBD_STATUS_SUCCESS);
}

Referenced by OnAborting(), and OnOperationUnwinding().

◆ CompleteHubOperation()

VOID EndpointMachine::CompleteHubOperation ( )

private

Definition at line 796 of file pipe.cpp.

{
    m_Endpoint->m_Device->CompleteHubOperation();
}

Referenced by OnAborting(), OnCreated(), OnDisabled(), OnInactive(), OnOperationUnwinding(), OnPurging(), and TryStart().

◆ CompleteTreePurge()

VOID EndpointMachine::CompleteTreePurge ( )

private

Definition at line 803 of file pipe.cpp.

{
    UcxController* Controller = m_Endpoint->m_Controller;
 
    if (InterlockedDecrement(&Controller->m_PendingTreePurgeEndpoints) != 0)
        return;
 
    WdfRequestComplete(Controller->m_PendingTreePurge, STATUS_SUCCESS);
    Controller->m_PendingTreePurge = NULL;
    WdfIoQueueStart(Controller->m_TreePurgeQueue);
}

Referenced by OnInactive(), and OnPurging().

◆ DeleteEndpoint()

VOID EndpointMachine::DeleteEndpoint ( )

private

Definition at line 844 of file pipe.cpp.

{
    UcxController* Controller = m_Endpoint->m_Controller;
    UCXENDPOINT Handle = m_Endpoint->m_Handle;
 
    DPRINT("Endpoint %p deleted\n", Handle);
 
    UcxUntrackEndpoint(m_Endpoint);
 
    {
        SpinLockGuard Guard(&Controller->m_TopologyLock);
 
        Controller->m_ChildEndpointCount--;
        RemoveEntryList(&m_Endpoint->m_DeviceLink);
        UcxClearListEntry(&m_Endpoint->m_DeviceLink);
    }
 
    WdfObjectDelete(Handle);
    WdfObjectDereference(Handle);
}

Referenced by Retire().

◆ DeleteStaleEndpoint()

VOID EndpointMachine::DeleteStaleEndpoint ( )

private

Definition at line 914 of file pipe.cpp.

{
    UCXENDPOINT Handle = m_Endpoint->m_Handle;
 
    DPRINT("Stale endpoint %p deleted\n", Handle);
 
    WdfObjectDelete(Handle);
    WdfObjectDereference(Handle);
}

Referenced by OnStale(), and Retire().

◆ DereferenceEndpoint()

VOID EndpointMachine::DereferenceEndpoint ( )

private

Definition at line 657 of file pipe.cpp.

{
    WdfObjectDereference(m_Endpoint->m_Handle);
}

Referenced by SmDereference().

◆ DeviceAllowsStart()

BOOLEAN EndpointMachine::DeviceAllowsStart ( )

private

Definition at line 925 of file pipe.cpp.

{
    return m_Endpoint->m_Device->AllowsEndpointStart();
}

Referenced by CanStart().

◆ DeviceDeprogrammed()

BOOLEAN EndpointMachine::DeviceDeprogrammed ( )

private

Definition at line 931 of file pipe.cpp.

{
    return m_Endpoint->m_Device->m_DeprogrammedByControllerReset;
}

Referenced by EnterDisablingStreams(), and EnterResettingPipe().

◆ DeviceDisconnected()

BOOLEAN EndpointMachine::DeviceDisconnected ( )

private

Definition at line 937 of file pipe.cpp.

{
    return m_Endpoint->m_Device->m_Disconnected;
}

Referenced by EnterResettingPipe().

◆ Endpoint()

UcxEndpoint * EndpointMachine::Endpoint ( ) const

inline

Definition at line 58 of file epsm.h.

    {
        return m_Endpoint;
    }

Referenced by Initialize().

◆ EnterAborting()

SM_RESULT EndpointMachine::EnterAborting ( )

private

Definition at line 385 of file epsm.cpp.

{
    AbortEndpoint();
    return SmHandled();
}

◆ EnterDisablingStreams()

SM_RESULT EndpointMachine::EnterDisablingStreams ( )

private

Definition at line 435 of file epsm.cpp.

{
    /* A deprogrammed device has no streams on the controller to tear down */
    if ((m_ReturnTo == &Disabled) && DeviceDeprogrammed())
        ParkStreamsDisableRequest();
    else
        ForwardStreamsDisableRequest();
 
    return SmHandled();
}

◆ EnterEnablingStreams()

SM_RESULT EndpointMachine::EnterEnablingStreams ( )

private

Definition at line 413 of file epsm.cpp.

{
    if (m_ReturnTo == &Enabled)
        ForwardStreamsEnableRequest();
    else
        RejectStreamsEnableRequest();
 
    return SmHandled();
}

◆ EnterOperationHeld()

SM_RESULT EndpointMachine::EnterOperationHeld ( )

private

Definition at line 480 of file epsm.cpp.

{
    return PauseForControllerReset();
}

◆ EnterPurging()

SM_RESULT EndpointMachine::EnterPurging ( )

private

Definition at line 331 of file epsm.cpp.

{
    PurgeEndpoint();
 
    if (m_PauseAfterPurge)
    {
        m_PauseAfterPurge = FALSE;
        return PauseForControllerReset();
    }
 
    return SmHandled();
}

◆ EnterResettingPipe()

SM_RESULT EndpointMachine::EnterResettingPipe ( )

private

Definition at line 458 of file epsm.cpp.

{
    if ((m_ReturnTo == &Disabled) && (DeviceDeprogrammed() || DeviceDisconnected()))
        FailResetRequest();
    else
        ForwardResetRequest();
 
    return SmHandled();
}

◆ FailResetRequest()

VOID EndpointMachine::FailResetRequest ( )

private

Definition at line 691 of file pipe.cpp.

{
    DPRINT1("Endpoint %p reset failed, device is gone or reset\n", m_Endpoint->m_Handle);
    WdfRequestComplete((WDFREQUEST)m_Endpoint->TakePending(), STATUS_NO_SUCH_DEVICE);
}

Referenced by EnterResettingPipe().

◆ FinishEndpointResetRequest()

VOID EndpointMachine::FinishEndpointResetRequest ( )

private

Definition at line 698 of file pipe.cpp.

{
    IoCompleteRequest((PIRP)m_Endpoint->TakePending(), IO_NO_INCREMENT);
}

Referenced by OnOperationUnwinding(), and OnResettingPipe().

◆ FinishStreamsCloseRequest()

VOID EndpointMachine::FinishStreamsCloseRequest ( )

private

Definition at line 762 of file pipe.cpp.

{
    PIRP Irp = (PIRP)m_Endpoint->TakePending();
    UcxStaticStreams* Streams;
 
    {
        SpinLockGuard Guard(&m_Endpoint->m_Controller->m_TopologyLock);
 
        Streams = m_Endpoint->m_Streams;
        m_Endpoint->m_Streams = NULL;
    }
 
    if (Streams != NULL)
        WdfObjectDelete(Streams->m_Handle);
 
    InterlockedDecrement(&m_Endpoint->m_StreamsOpenCount);
    UcxCompleteHeldUrbIrp(Irp);
}

Referenced by OnDisablingStreams(), and OnOperationUnwinding().

◆ FinishStreamsOpenRequest()

VOID EndpointMachine::FinishStreamsOpenRequest ( _In_ BOOLEAN ForceFailure )

private

Definition at line 720 of file pipe.cpp.

{
    PIRP Irp = (PIRP)m_Endpoint->TakePending();
 
    if (ForceFailure)
    {
        DPRINT1("Endpoint %p static streams open failed by endpoint state\n", m_Endpoint->m_Handle);
        InterlockedDecrement(&m_Endpoint->m_StreamsOpenCount);
        Irp->IoStatus.Status = STATUS_INVALID_DEVICE_STATE;
        Irp->IoStatus.Information = 0;
    }
    else if (!NT_SUCCESS(Irp->IoStatus.Status))
    {
        InterlockedDecrement(&m_Endpoint->m_StreamsOpenCount);
    }
 
    UcxCompleteHeldUrbIrp(Irp);
}

Referenced by OnEnablingStreams(), and OnOperationUnwinding().

◆ ForwardResetRequest()

VOID EndpointMachine::ForwardResetRequest ( )

private

Definition at line 682 of file pipe.cpp.

{
    WDFREQUEST Request = (WDFREQUEST)m_Endpoint->TakePending();
 
    m_Endpoint->m_Callbacks.Reset(m_Endpoint->m_Controller->m_Handle, m_Endpoint->m_Handle, Request);
}

Referenced by EnterResettingPipe().

◆ ForwardStreamsDisableRequest()

VOID EndpointMachine::ForwardStreamsDisableRequest ( )

private

Definition at line 741 of file pipe.cpp.

{
    WDFREQUEST Request = (WDFREQUEST)m_Endpoint->TakePending();
 
    m_Endpoint->m_Callbacks.StaticStreamsDisable(m_Endpoint->m_Handle, m_Endpoint->m_Streams->m_Handle, Request);
}

Referenced by EnterDisablingStreams().

◆ ForwardStreamsEnableRequest()

VOID EndpointMachine::ForwardStreamsEnableRequest ( )

private

Definition at line 704 of file pipe.cpp.

{
    WDFREQUEST Request = (WDFREQUEST)m_Endpoint->TakePending();
 
    m_Endpoint->m_Callbacks.StaticStreamsEnable(m_Endpoint->m_Handle, m_Endpoint->m_Streams->m_Handle, Request);
}

Referenced by EnterEnablingStreams().

◆ Initialize()

VOID EndpointMachine::Initialize ( _In_ UcxEndpoint * Endpoint )

Definition at line 107 of file epsm.cpp.

{
    m_Endpoint = Endpoint;
    m_ReturnTo = NULL;
    m_HeldOperation = NULL;
    m_AfterPurge = PurgeFollowUpNone;
    m_Enabled = FALSE;
    m_AbortForHub = FALSE;
    m_PauseAfterPurge = FALSE;
 
    SmInitialize(&Created);
}

◆ OnAborting()

SM_RESULT EndpointMachine::OnAborting ( _In_ EpEvent Event )

private

Definition at line 392 of file epsm.cpp.

{
    if (Event != EpEvent::AbortDone)
        return SmUnhandled();
 
    if (m_AbortForHub)
    {
        StartEndpoint();
        CompleteHubOperation();
    }
    else
    {
        CompleteAbortUrb();
        StartEndpoint();
    }
 
    return SmTransition(&Enabled);
}

◆ OnAwaitingAbortUrb()

SM_RESULT EndpointMachine::OnAwaitingAbortUrb ( _In_ EpEvent Event )

private

Definition at line 375 of file epsm.cpp.

{
    if (Event == EpEvent::AbortUrbParked)
        return SmTransition(&Aborting);
 
    return SmUnhandled();
}

◆ OnBusy()

SM_RESULT EndpointMachine::OnBusy ( _In_ EpEvent Event )

private

Definition at line 314 of file epsm.cpp.

{
    switch (Event)
    {
        case EpEvent::ControllerResetStarting:
            return PauseForControllerReset();
 
        case EpEvent::ControllerResetDone:
            return SmHandled();
 
        default:
            return SmUnhandled();
    }
}

◆ OnCreated()

SM_RESULT EndpointMachine::OnCreated ( _In_ EpEvent Event )

private

Definition at line 179 of file epsm.cpp.

{
    switch (Event)
    {
        case EpEvent::Delete:
            return Retire();
 
        case EpEvent::ConfigureDone:
            m_Enabled = TRUE;
            if (!CanStart())
                return StartPurge(PurgeFollowUpHubOperation);
 
            CompleteHubOperation();
            return SmTransition(&Enabled);
 
        case EpEvent::DeviceResetDone:
            CompleteHubOperation();
            return SmHandled();
 
        default:
            return SmUnhandled();
    }
}

◆ OnDisabled()

SM_RESULT EndpointMachine::OnDisabled ( _In_ EpEvent Event )

private

Definition at line 205 of file epsm.cpp.

{
    switch (Event)
    {
        case EpEvent::Delete:
            return Retire();
 
        case EpEvent::HubDisable:
        case EpEvent::HubDeviceReset:
            m_Enabled = FALSE;
            CompleteHubOperation();
            return SmHandled();
 
        case EpEvent::ConfigureDone:
        case EpEvent::DeviceResetDone:
            m_Enabled = TRUE;
            return TryStart();
 
        case EpEvent::HubStartRequest:
            return TryStart();
 
        case EpEvent::ClientStreamsEnable:
            return BeginOperation(&EnablingStreams, &Disabled);
 
        case EpEvent::ClientStreamsDisable:
            return BeginOperation(&DisablingStreams, &Disabled);
 
        case EpEvent::HubEndpointReset:
            return BeginOperation(&ResettingPipe, &Disabled);
 
        default:
            return SmUnhandled();
    }
}

◆ OnDisablingStreams()

SM_RESULT EndpointMachine::OnDisablingStreams ( _In_ EpEvent Event )

private

Definition at line 447 of file epsm.cpp.

{
    if (Event != EpEvent::StreamsClosed)
        return SmUnhandled();
 
    FinishStreamsCloseRequest();
    return SmTransition(m_ReturnTo);
}

◆ OnEnabled()

SM_RESULT EndpointMachine::OnEnabled ( _In_ EpEvent Event )

private

Definition at line 268 of file epsm.cpp.

{
    switch (Event)
    {
        case EpEvent::ClientStreamsEnable:
            return BeginOperation(&EnablingStreams, &Enabled);
 
        case EpEvent::ClientStreamsDisable:
            return BeginOperation(&DisablingStreams, &Enabled);
 
        case EpEvent::HubEndpointReset:
            return BeginOperation(&ResettingPipe, &Enabled);
 
        case EpEvent::ClientAbortUrb:
            m_AbortForHub = FALSE;
            return BeginOperation(&AwaitingAbortUrb, &Enabled);
 
        case EpEvent::HubAbort:
            m_AbortForHub = TRUE;
            return BeginOperation(&Aborting, &Enabled);
 
        case EpEvent::HubDisable:
        case EpEvent::HubDeviceReset:
            m_Enabled = FALSE;
            return StartPurge(PurgeFollowUpHubOperation);
 
        case EpEvent::HubPurge:
            return StartPurge(PurgeFollowUpHubOperation);
 
        case EpEvent::HubTreePurge:
            return StartPurge(PurgeFollowUpTreePurge);
 
        case EpEvent::HubDisconnect:
            return StartPurge(PurgeFollowUpNone);
 
        case EpEvent::ControllerResetStarting:
            m_PauseAfterPurge = TRUE;
            return StartPurge(PurgeFollowUpNone);
 
        default:
            return SmUnhandled();
    }
}

◆ OnEnablingStreams()

SM_RESULT EndpointMachine::OnEnablingStreams ( _In_ EpEvent Event )

private

Definition at line 424 of file epsm.cpp.

{
    if (Event != EpEvent::StreamsOpened)
        return SmUnhandled();
 
    FinishStreamsOpenRequest(FALSE);
    return SmTransition(m_ReturnTo);
}

◆ OnInactive()

SM_RESULT EndpointMachine::OnInactive ( _In_ EpEvent Event )

private

Definition at line 148 of file epsm.cpp.

{
    switch (Event)
    {
        case EpEvent::HubStartRequest:
        case EpEvent::HubPurge:
        case EpEvent::HubAbort:
        case EpEvent::HubDeviceReset:
            CompleteHubOperation();
            return SmHandled();
 
        case EpEvent::HubTreePurge:
            CompleteTreePurge();
            return SmHandled();
 
        case EpEvent::HubDisconnect:
            return SmHandled();
 
        case EpEvent::ControllerResetStarting:
            return PauseForControllerReset();
 
        case EpEvent::ControllerResetDone:
            return SmHandled();
 
        default:
            return SmUnhandled();
    }
}

◆ OnOperation()

SM_RESULT EndpointMachine::OnOperation ( _In_ EpEvent Event )

private

Definition at line 360 of file epsm.cpp.

{
    if (Event != EpEvent::ControllerResetStarting)
        return SmUnhandled();
 
    /* Endpoint is already purged, Busy pauses in place */
    if (m_ReturnTo == &Disabled)
        return SmUnhandled();
 
    m_HeldOperation = SmCurrent();
    return SmTransition(&OperationHeld);
}

◆ OnOperationHeld()

SM_RESULT EndpointMachine::OnOperationHeld ( _In_ EpEvent Event )

private

Definition at line 486 of file epsm.cpp.

{
    if (Event == EpEvent::ControllerResetDone)
        return SmTransition(&OperationUnwinding);
 
    return SmUnhandled();
}

◆ OnOperationUnwinding()

SM_RESULT EndpointMachine::OnOperationUnwinding ( _In_ EpEvent Event )

private

Reset under an outstanding operation: finish it, then purge.

Definition at line 500 of file epsm.cpp.

{
    if (Event == EpEvent::ControllerResetStarting)
        return SmTransition(&OperationHeld);
 
    /* A hub abort only ever has the abort itself outstanding */
    if ((m_HeldOperation == &Aborting) && m_AbortForHub)
    {
        if (Event != EpEvent::AbortDone)
            return SmUnhandled();
 
        CompleteHubOperation();
        return StartPurge(PurgeFollowUpNone);
    }
 
    switch (Event)
    {
        case EpEvent::AbortUrbParked:
        case EpEvent::AbortDone:
            CompleteAbortUrb();
            break;
 
        case EpEvent::StreamsOpened:
            FinishStreamsOpenRequest(TRUE);
            break;
 
        case EpEvent::StreamsClosed:
            FinishStreamsCloseRequest();
            break;
 
        case EpEvent::EndpointResetDone:
            FinishEndpointResetRequest();
            break;
 
        default:
            return SmUnhandled();
    }
 
    return StartPurge(PurgeFollowUpNone);
}

◆ OnPurging()

SM_RESULT EndpointMachine::OnPurging ( _In_ EpEvent Event )

private

Definition at line 345 of file epsm.cpp.

{
    if (Event != EpEvent::PurgeDone)
        return SmUnhandled();
 
    if (m_AfterPurge == PurgeFollowUpHubOperation)
        CompleteHubOperation();
    else if (m_AfterPurge == PurgeFollowUpTreePurge)
        CompleteTreePurge();
 
    return SmTransition(&Disabled);
}

◆ OnResettingPipe()

SM_RESULT EndpointMachine::OnResettingPipe ( _In_ EpEvent Event )

private

Definition at line 469 of file epsm.cpp.

{
    if (Event != EpEvent::EndpointResetDone)
        return SmUnhandled();
 
    FinishEndpointResetRequest();
    return SmTransition(m_ReturnTo);
}

◆ OnRetired()

SM_RESULT EndpointMachine::OnRetired ( _In_ EpEvent Event )

private

Definition at line 242 of file epsm.cpp.

{
    if (Event == EpEvent::ControllerResetStarting)
    {
        AckControllerReset();
        return SmHandled();
    }
 
    return SmUnhandled();
}

◆ OnStale()

SM_RESULT EndpointMachine::OnStale ( _In_ EpEvent Event )

private

Definition at line 255 of file epsm.cpp.

{
    if (Event == EpEvent::StaleReplaced)
    {
        DeleteStaleEndpoint();
        return SmTransition(&AwaitingDestroy);
    }
 
    return SmUnhandled();
}

◆ ParkAsStale()

BOOLEAN EndpointMachine::ParkAsStale ( )

private

Keeps one stale endpoint per address readable for clients still holding it.

Definition at line 867 of file pipe.cpp.

{
    UcxUsbDevice* Device = m_Endpoint->m_Device;
    UcxController* Controller = m_Endpoint->m_Controller;
    UcxEndpoint* Replaced = NULL;
    UcxEndpoint* Candidate;
    PLIST_ENTRY Entry;
    BOOLEAN Parked;
 
    UcxUntrackEndpoint(m_Endpoint);
 
    {
        SpinLockGuard Guard(&Controller->m_TopologyLock);
 
        for (Entry = Device->m_StaleEndpointList.Flink; Entry != &Device->m_StaleEndpointList; Entry = Entry->Flink)
        {
            Candidate = CONTAINING_RECORD(Entry, UcxEndpoint, m_DeviceLink);
 
            if (Candidate->m_Descriptor.bEndpointAddress == m_Endpoint->m_Descriptor.bEndpointAddress)
            {
                RemoveEntryList(Entry);
                UcxClearListEntry(Entry);
                Replaced = Candidate;
                break;
            }
        }
 
        Controller->m_ChildEndpointCount--;
        RemoveEntryList(&m_Endpoint->m_DeviceLink);
        UcxClearListEntry(&m_Endpoint->m_DeviceLink);
        m_Endpoint->m_Pipe.Self = NULL;
 
        Parked = !Device->m_PendingDelete;
        if (Parked)
            InsertTailList(&Device->m_StaleEndpointList, &m_Endpoint->m_DeviceLink);
    }
 
    if (Replaced != NULL)
        Replaced->Post(EpEvent::StaleReplaced);
 
    DPRINT("Endpoint %p parked as stale %u, replaced %p\n", m_Endpoint->m_Handle, Parked, Replaced);
 
    return Parked;
}

Referenced by Retire().

◆ ParkStreamsDisableRequest()

VOID EndpointMachine::ParkStreamsDisableRequest ( )

private

Definition at line 750 of file pipe.cpp.

{
    WDFREQUEST Request = (WDFREQUEST)m_Endpoint->TakePending();
    NTSTATUS Status;
 
    Status = WdfRequestForwardToIoQueue(Request, m_Endpoint->m_Controller->m_PendDuringResetQueue);
    if (!NT_SUCCESS(Status))
        DPRINT1("Endpoint %p could not park streams close %p 0x%lx\n", m_Endpoint->m_Handle, Request, Status);
}

Referenced by EnterDisablingStreams().

◆ PauseForControllerReset()

SM_RESULT EndpointMachine::PauseForControllerReset ( )

private

Pause before the ack; nothing may touch the machine after it.

Definition at line 547 of file epsm.cpp.

{
    SmBeginPause();
    AckControllerReset();
    return SmPaused();
}

Referenced by EnterOperationHeld(), EnterPurging(), OnBusy(), and OnInactive().

◆ PurgeEndpoint()

VOID EndpointMachine::PurgeEndpoint ( )

private

Definition at line 670 of file pipe.cpp.

{
    m_Endpoint->m_Callbacks.Purge(m_Endpoint->m_Controller->m_Handle, m_Endpoint->m_Handle);
}

Referenced by EnterPurging().

◆ ReferenceEndpoint()

VOID EndpointMachine::ReferenceEndpoint ( )

private

Definition at line 651 of file pipe.cpp.

{
    WdfObjectReference(m_Endpoint->m_Handle);
}

Referenced by SmReference().

◆ RejectStreamsEnableRequest()

VOID EndpointMachine::RejectStreamsEnableRequest ( )

private

Definition at line 713 of file pipe.cpp.

{
    DPRINT1("Endpoint %p static streams enable rejected in this state\n", m_Endpoint->m_Handle);
    WdfRequestComplete((WDFREQUEST)m_Endpoint->TakePending(), STATUS_INVALID_DEVICE_STATE);
}

Referenced by EnterEnablingStreams().

◆ Retire()

SM_RESULT EndpointMachine::Retire ( )

private

An endpoint the client still has a handle to stays around as stale.

Definition at line 590 of file epsm.cpp.

{
    if (!ClientHoldsHandle())
    {
        DeleteEndpoint();
        return SmTransition(&AwaitingDestroy);
    }
 
    if (ParkAsStale())
        return SmTransition(&Stale);
 
    DeleteStaleEndpoint();
    return SmTransition(&AwaitingDestroy);
}

Referenced by OnCreated(), and OnDisabled().

◆ SmAccepts()

BOOLEAN EndpointMachine::SmAccepts ( _In_ EpEvent Event )

private

Abort URB is only taken while running; the caller fails the URB on FALSE.

Definition at line 126 of file epsm.cpp.

{
    if (Event == EpEvent::ClientAbortUrb)
        return SmCurrent() == &Enabled;
 
    return TRUE;
}

◆ SmDereference()

VOID EndpointMachine::SmDereference ( )

private

Definition at line 142 of file epsm.cpp.

{
    DereferenceEndpoint();
}

◆ SmReference()

VOID EndpointMachine::SmReference ( )

private

Definition at line 136 of file epsm.cpp.

{
    ReferenceEndpoint();
}

◆ StartEndpoint()

VOID EndpointMachine::StartEndpoint ( )

private

Definition at line 663 of file pipe.cpp.

{
    m_Endpoint->m_Callbacks.Start(m_Endpoint->m_Controller->m_Handle, m_Endpoint->m_Handle);
}

Referenced by OnAborting(), and TryStart().

◆ StartPurge()

SM_RESULT EndpointMachine::StartPurge ( _In_ PURGE_FOLLOW_UP FollowUp )

private

Definition at line 555 of file epsm.cpp.

{
    m_AfterPurge = FollowUp;
    return SmTransition(&Purging);
}

Referenced by OnCreated(), OnEnabled(), and OnOperationUnwinding().

◆ TryStart()

SM_RESULT EndpointMachine::TryStart ( )

private

Definition at line 572 of file epsm.cpp.

{
    if (!CanStart())
    {
        CompleteHubOperation();
        return SmHandled();
    }
 
    StartEndpoint();
    CompleteHubOperation();
    return SmTransition(&Enabled);
}

Referenced by OnDisabled().

Friends And Related Function Documentation

◆ SmMachine< EndpointMachine, EpEvent >

friend class SmMachine< EndpointMachine, EpEvent >

friend

Definition at line 1 of file epsm.h.

Member Data Documentation

◆ Aborting

const EndpointMachine::State EndpointMachine::Aborting

staticprivate

Initial value:

=

{ &Operation, "Aborting", 0, &EndpointMachine::OnAborting, &EndpointMachine::EnterAborting }

EndpointMachine::OnAborting

SM_RESULT OnAborting(_In_ EpEvent Event)

Definition: epsm.cpp:392

EndpointMachine::EnterAborting

SM_RESULT EnterAborting()

Definition: epsm.cpp:385

EndpointMachine::Operation

static const State Operation

Definition: epsm.h:83

Definition at line 85 of file epsm.h.

Referenced by OnAwaitingAbortUrb(), OnEnabled(), and OnOperationUnwinding().

◆ AwaitingAbortUrb

const EndpointMachine::State EndpointMachine::AwaitingAbortUrb

staticprivate

Initial value:

=

{ &Operation, "AwaitingAbortUrb", 0, &EndpointMachine::OnAwaitingAbortUrb, NULL }

EndpointMachine::OnAwaitingAbortUrb

SM_RESULT OnAwaitingAbortUrb(_In_ EpEvent Event)

Definition: epsm.cpp:375

Definition at line 84 of file epsm.h.

Referenced by OnEnabled().

◆ AwaitingDestroy

const EndpointMachine::State EndpointMachine::AwaitingDestroy

staticprivate

Initial value:

=

{ &Retired, "AwaitingDestroy", 0, NULL, NULL }

EndpointMachine::Retired

static const State Retired

Definition: epsm.h:77

Definition at line 79 of file epsm.h.

Referenced by OnStale(), and Retire().

◆ Busy

const EndpointMachine::State EndpointMachine::Busy

staticprivate

Initial value:

=

{ NULL, "Busy", 0, &EndpointMachine::OnBusy, NULL }

EndpointMachine::OnBusy

SM_RESULT OnBusy(_In_ EpEvent Event)

Definition: epsm.cpp:314

Definition at line 81 of file epsm.h.

◆ Created

const EndpointMachine::State EndpointMachine::Created

staticprivate

Initial value:

=

{ &Inactive, "Created", 0, &EndpointMachine::OnCreated, NULL }

EndpointMachine::Inactive

static const State Inactive

Definition: epsm.h:74

EndpointMachine::OnCreated

SM_RESULT OnCreated(_In_ EpEvent Event)

Definition: epsm.cpp:179

Definition at line 75 of file epsm.h.

Referenced by Initialize().

◆ Disabled

const EndpointMachine::State EndpointMachine::Disabled

staticprivate

Initial value:

=

{ &Inactive, "Disabled", 0, &EndpointMachine::OnDisabled, NULL }

EndpointMachine::OnDisabled

SM_RESULT OnDisabled(_In_ EpEvent Event)

Definition: epsm.cpp:205

Definition at line 76 of file epsm.h.

Referenced by EnterDisablingStreams(), EnterResettingPipe(), OnDisabled(), OnOperation(), and OnPurging().

◆ DisablingStreams

const EndpointMachine::State EndpointMachine::DisablingStreams

staticprivate

Initial value:

=
    { &Operation, "DisablingStreams", 0,
      &EndpointMachine::OnDisablingStreams, &EndpointMachine::EnterDisablingStreams }

Definition at line 87 of file epsm.h.

Referenced by OnDisabled(), and OnEnabled().

◆ Enabled

const EndpointMachine::State EndpointMachine::Enabled

staticprivate

Initial value:

=

{ NULL, "Enabled", SM_STATE_TAKES_REQUESTS, &EndpointMachine::OnEnabled, NULL }

EndpointMachine::OnEnabled

SM_RESULT OnEnabled(_In_ EpEvent Event)

Definition: epsm.cpp:268

SM_STATE_TAKES_REQUESTS

#define SM_STATE_TAKES_REQUESTS

Definition: smengine.h:39

Definition at line 80 of file epsm.h.

Referenced by EnterEnablingStreams(), OnAborting(), OnCreated(), OnEnabled(), SmAccepts(), and TryStart().

◆ EnablingStreams

const EndpointMachine::State EndpointMachine::EnablingStreams

staticprivate

Initial value:

=
    { &Operation, "EnablingStreams", 0,
      &EndpointMachine::OnEnablingStreams, &EndpointMachine::EnterEnablingStreams }

Definition at line 86 of file epsm.h.

Referenced by OnDisabled(), and OnEnabled().

◆ EventInfo

const SM_EVENT_INFO EndpointMachine::EventInfo

static

Initial value:

=
{
    { "HubStartRequest",         SmEventRequest,    FALSE },
    { "HubPurge",                SmEventRequest,    FALSE },
    { "HubTreePurge",            SmEventRequest,    FALSE },
    { "HubAbort",                SmEventRequest,    FALSE },
    { "HubDisconnect",           SmEventRequest,    FALSE },
    { "HubDisable",              SmEventRequest,    FALSE },
    { "HubDeviceReset",          SmEventRequest,    FALSE },
    { "DeviceResetDone",         SmEventRequest,    FALSE },
    { "ConfigureDone",           SmEventRequest,    FALSE },
    { "HubEndpointReset",        SmEventRequest,    FALSE },
    { "Delete",                  SmEventRequest,    FALSE },
    { "ClientAbortUrb",          SmEventRequest,    FALSE },
    { "ClientStreamsEnable",     SmEventRequest,    FALSE },
    { "ClientStreamsDisable",    SmEventRequest,    FALSE },
    { "AbortUrbParked",          SmEventCompletion, FALSE },
    { "AbortDone",               SmEventCompletion, FALSE },
    { "PurgeDone",               SmEventCompletion, FALSE },
    { "EndpointResetDone",       SmEventCompletion, FALSE },
    { "StreamsOpened",           SmEventCompletion, FALSE },
    { "StreamsClosed",           SmEventCompletion, FALSE },
    { "ControllerResetStarting", SmEventCompletion, FALSE },
    { "StaleReplaced",           SmEventCompletion, FALSE },
    { "ControllerResetDone",     SmEventResume,     FALSE },
}

Definition at line 63 of file epsm.h.

◆ Inactive

const EndpointMachine::State EndpointMachine::Inactive

staticprivate

Initial value:

=

{ NULL, "Inactive", SM_STATE_TAKES_REQUESTS, &EndpointMachine::OnInactive, NULL }

EndpointMachine::OnInactive

SM_RESULT OnInactive(_In_ EpEvent Event)

Definition: epsm.cpp:148

Definition at line 74 of file epsm.h.

◆ m_AbortForHub

BOOLEAN EndpointMachine::m_AbortForHub

private

Definition at line 217 of file epsm.h.

Referenced by Initialize(), OnAborting(), OnEnabled(), and OnOperationUnwinding().

◆ m_AfterPurge

PURGE_FOLLOW_UP EndpointMachine::m_AfterPurge

private

Definition at line 215 of file epsm.h.

Referenced by Initialize(), OnPurging(), and StartPurge().

◆ m_Enabled

BOOLEAN EndpointMachine::m_Enabled

private

Definition at line 216 of file epsm.h.

Referenced by CanStart(), Initialize(), OnCreated(), OnDisabled(), and OnEnabled().

◆ m_Endpoint

UcxEndpoint* EndpointMachine::m_Endpoint

private

◆ m_HeldOperation

const State* EndpointMachine::m_HeldOperation

private

Definition at line 214 of file epsm.h.

Referenced by Initialize(), OnOperation(), and OnOperationUnwinding().

◆ m_PauseAfterPurge

BOOLEAN EndpointMachine::m_PauseAfterPurge

private

Definition at line 218 of file epsm.h.

Referenced by EnterPurging(), Initialize(), and OnEnabled().

◆ m_ReturnTo

const State* EndpointMachine::m_ReturnTo

private

Definition at line 213 of file epsm.h.

Referenced by BeginOperation(), EnterDisablingStreams(), EnterEnablingStreams(), EnterResettingPipe(), Initialize(), OnDisablingStreams(), OnEnablingStreams(), OnOperation(), and OnResettingPipe().

◆ Operation

const EndpointMachine::State EndpointMachine::Operation

staticprivate

Initial value:

=

{ &Busy, "Operation", 0, &EndpointMachine::OnOperation, NULL }

EndpointMachine::OnOperation

SM_RESULT OnOperation(_In_ EpEvent Event)

Definition: epsm.cpp:360

EndpointMachine::Busy

static const State Busy

Definition: epsm.h:81

Definition at line 83 of file epsm.h.

◆ OperationHeld

const EndpointMachine::State EndpointMachine::OperationHeld

staticprivate

Initial value:

=
    { NULL, "OperationHeld", 0,
      &EndpointMachine::OnOperationHeld, &EndpointMachine::EnterOperationHeld }

Definition at line 89 of file epsm.h.

Referenced by OnOperation(), and OnOperationUnwinding().

◆ OperationUnwinding

const EndpointMachine::State EndpointMachine::OperationUnwinding

staticprivate

Initial value:

=

{ NULL, "OperationUnwinding", 0, &EndpointMachine::OnOperationUnwinding, NULL }

EndpointMachine::OnOperationUnwinding

SM_RESULT OnOperationUnwinding(_In_ EpEvent Event)

Reset under an outstanding operation: finish it, then purge.

Definition: epsm.cpp:500

Definition at line 90 of file epsm.h.

Referenced by OnOperationHeld().

◆ Purging

const EndpointMachine::State EndpointMachine::Purging

staticprivate

Initial value:

=

{ &Busy, "Purging", 0, &EndpointMachine::OnPurging, &EndpointMachine::EnterPurging }

EndpointMachine::EnterPurging

SM_RESULT EnterPurging()

Definition: epsm.cpp:331

EndpointMachine::OnPurging

SM_RESULT OnPurging(_In_ EpEvent Event)

Definition: epsm.cpp:345

Definition at line 82 of file epsm.h.

Referenced by StartPurge().

◆ ResettingPipe

const EndpointMachine::State EndpointMachine::ResettingPipe

staticprivate

Initial value:

=
    { &Operation, "ResettingPipe", 0,
      &EndpointMachine::OnResettingPipe, &EndpointMachine::EnterResettingPipe }

Definition at line 88 of file epsm.h.

Referenced by OnDisabled(), and OnEnabled().

◆ Retired

const EndpointMachine::State EndpointMachine::Retired

staticprivate

Initial value:

=

{ &Inactive, "Retired", 0, &EndpointMachine::OnRetired, NULL }

EndpointMachine::OnRetired

SM_RESULT OnRetired(_In_ EpEvent Event)

Definition: epsm.cpp:242

Definition at line 77 of file epsm.h.

◆ Stale

const EndpointMachine::State EndpointMachine::Stale

staticprivate

Initial value:

=

{ &Retired, "Stale", 0, &EndpointMachine::OnStale, NULL }

EndpointMachine::OnStale

SM_RESULT OnStale(_In_ EpEvent Event)

Definition: epsm.cpp:255

Definition at line 78 of file epsm.h.

Referenced by Retire().

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

drivers/usb/ucx01000/epsm.h
drivers/usb/ucx01000/epsm.cpp
drivers/usb/ucx01000/pipe.cpp

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PURGE_FOLLOW_UP

Member Function Documentation

◆ AbortEndpoint()

◆ AckControllerReset()

◆ BeginOperation()

◆ CanStart()

◆ ClientHoldsHandle()

◆ CompleteAbortUrb()

◆ CompleteHubOperation()

◆ CompleteTreePurge()

◆ DeleteEndpoint()

◆ DeleteStaleEndpoint()

◆ DereferenceEndpoint()

◆ DeviceAllowsStart()

◆ DeviceDeprogrammed()

◆ DeviceDisconnected()

◆ Endpoint()

◆ EnterAborting()

◆ EnterDisablingStreams()

◆ EnterEnablingStreams()

◆ EnterOperationHeld()

◆ EnterPurging()

◆ EnterResettingPipe()

◆ FailResetRequest()

◆ FinishEndpointResetRequest()

◆ FinishStreamsCloseRequest()

◆ FinishStreamsOpenRequest()

◆ ForwardResetRequest()

◆ ForwardStreamsDisableRequest()

◆ ForwardStreamsEnableRequest()

◆ Initialize()

◆ OnAborting()

◆ OnAwaitingAbortUrb()

◆ OnBusy()

◆ OnCreated()

◆ OnDisabled()

◆ OnDisablingStreams()

◆ OnEnabled()

◆ OnEnablingStreams()

◆ OnInactive()

◆ OnOperation()

◆ OnOperationHeld()

◆ OnOperationUnwinding()

◆ OnPurging()

◆ OnResettingPipe()

◆ OnRetired()

◆ OnStale()

◆ ParkAsStale()

◆ ParkStreamsDisableRequest()

◆ PauseForControllerReset()

◆ PurgeEndpoint()

◆ ReferenceEndpoint()

◆ RejectStreamsEnableRequest()

◆ Retire()

◆ SmAccepts()

◆ SmDereference()

◆ SmReference()

◆ StartEndpoint()

◆ StartPurge()

◆ TryStart()

Friends And Related Function Documentation

◆ SmMachine< EndpointMachine, EpEvent >

Member Data Documentation

◆ Aborting

◆ AwaitingAbortUrb

◆ AwaitingDestroy

◆ Busy

◆ Created

◆ Disabled

◆ DisablingStreams