#include <fxpowerpolicystatemachine.hpp>

Inheritance diagram for FxPowerPolicyMachine:

[legend]

Collaboration diagram for FxPowerPolicyMachine:

[legend]

Public Member Functions
	FxPowerPolicyMachine (VOID)

	~FxPowerPolicyMachine (VOID)

VOID	UsbSSCallbackProcessingComplete (VOID)

_Must_inspect_result_ NTSTATUS	InitUsbSS (VOID)

VOID	SetWaitWakeUnclaimed (VOID)

BOOLEAN	CanCompleteWaitWakeIrp (VOID)

Public Member Functions inherited from FxThreadedEventQueue
	FxThreadedEventQueue (__in UCHAR QueueDepth)

	~FxThreadedEventQueue (VOID)

_Must_inspect_result_ NTSTATUS	Init (__inout FxPkgPnp *Pnp, __in PFN_PNP_EVENT_WORKER WorkerRoutine, __in PVOID WorkerContext=NULL)

VOID	QueueToThread (VOID)

Public Member Functions inherited from FxEventQueue
	FxEventQueue (__in UCHAR QueueDepth)

_Must_inspect_result_ NTSTATUS	Initialize (__in PFX_DRIVER_GLOBALS DriverGlobals)

	_Acquires_lock_ (this->m_QueueLock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL Irql)

	_Releases_lock_ (this->m_QueueLock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID Unlock(__in __drv_restoresIRQL KIRQL Irql)

BOOLEAN	IsFull (VOID)

BOOLEAN	IsEmpty (VOID)

VOID	IncrementHead (VOID)

UCHAR	GetHead (VOID)

UCHAR	InsertAtHead (VOID)

UCHAR	InsertAtTail (VOID)

UCHAR	IncrementHistoryIndex (VOID)

BOOLEAN	IsClosedLocked (VOID)

VOID	GetFinishedState (__inout FxPostProcessInfo *Info)

BOOLEAN	SetFinished (__in FxCREvent *Event)

VOID	SetDelayedDeletion (VOID)

Public Member Functions inherited from FxStump
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType)

VOID	operator delete (__in PVOID pointer)

PVOID	operator new[] (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)

VOID	operator delete[] (__in PVOID pointer)

Public Attributes
FxPowerPolicyEvent	m_Queue [FxPowerPolicyEventQueueDepth]

FxPowerPolicyMachineStateHistory	m_States

FxPowerPolicyOwnerSettings *	m_Owner

union {
ULONG m_SingularEventsPresent

union {
ULONG PwrPolStartKnown: 1

ULONG PwrPolStopKnown: 1

ULONG PwrPolSxKnown: 1

ULONG PwrPolS0Known: 1

ULONG PwrPolPowerDownKnown: 1

ULONG PwrPolPowerUpKnown: 1

ULONG PwrPolPowerDownIoStoppedKnown: 1

ULONG PwrPolPowerUpHwStartedKnown: 1

ULONG PwrPolWakeArrivedKnown: 1

ULONG PwrPolWakeSuccessKnown: 1

ULONG PwrPolWakeFailedKnown: 1

ULONG PwrPolIoPresentKnown: 1

ULONG PwrPolPowerTimeoutExpiredKnown: 1

ULONG PwrPolS0IdlePolicyChangedKnown: 1

ULONG PwrPolSurpriseRemoveKnown: 1

ULONG PwrPolUsbSelectiveSuspendCallbackKnown: 1

ULONG PwrPolUsbSelectiveSuspendCompletedKnown: 1

ULONG PwrPolPowerDownFailedKnown: 1

ULONG PwrPolPowerUpFailedKnown: 1

} m_SingularEventsPresentByName

};

Public Attributes inherited from FxEventQueue
FxWaitLockInternal	m_StateMachineLock

Additional Inherited Members
Protected Member Functions inherited from FxThreadedEventQueue
VOID	QueueWorkItem (VOID)

Protected Member Functions inherited from FxEventQueue
VOID	Configure (__in FxPkgPnp *Pnp, __in PFN_PNP_EVENT_WORKER WorkerRoutine, __in PVOID Context)

BOOLEAN	QueueToThreadWorker (VOID)

VOID	EventQueueWorker (VOID)

BOOLEAN	IsIdleLocked (VOID)

Protected Member Functions inherited from FxStump
	FxStump (VOID)

Protected Attributes inherited from FxThreadedEventQueue
MxWorkItem	m_WorkItem

WORK_QUEUE_ITEM	m_EventWorkQueueItem

Protected Attributes inherited from FxEventQueue
UCHAR	m_QueueHead

UCHAR	m_QueueTail

UCHAR	m_QueueDepth

UCHAR	m_HistoryIndex

FxPkgPnp *	m_PkgPnp

PVOID	m_EventWorkerContext

MxLock	m_QueueLock

PFN_PNP_EVENT_WORKER	m_EventWorker

FxCREvent *	m_WorkItemFinished

union {
UCHAR m_QueueFlags

struct {
UCHAR WorkItemQueued: 1

UCHAR Closed: 1

UCHAR DelayDeletion: 1

} m_QueueFlagsByName

};

UCHAR	m_WorkItemRunningCount

Static Protected Attributes inherited from FxThreadedEventQueue
static WORKER_THREAD_ROUTINE	_WorkerThreadRoutine

static MX_WORKITEM_ROUTINE	_WorkItemCallback

Detailed Description

Definition at line 722 of file fxpowerpolicystatemachine.hpp.

Constructor & Destructor Documentation

◆ FxPowerPolicyMachine()

FxPowerPolicyMachine::FxPowerPolicyMachine ( VOID )

Definition at line 2536 of file powerpolicystatemachine.cpp.

      : FxThreadedEventQueue(FxPowerPolicyEventQueueDepth)
{
    m_Owner = NULL;
 
    RtlZeroMemory(&m_Queue[0], sizeof(m_Queue));
    RtlZeroMemory(&m_States, sizeof(m_States));
 
    m_States.History[IncrementHistoryIndex()] = WdfDevStatePwrPolObjectCreated;
 
    m_SingularEventsPresent = 0x0;
}

◆ ~FxPowerPolicyMachine()

FxPowerPolicyMachine::~FxPowerPolicyMachine ( VOID )

Definition at line 2550 of file powerpolicystatemachine.cpp.

{
    if (m_Owner != NULL) {
        delete m_Owner;
        m_Owner = NULL;
    }
}

Member Function Documentation

◆ CanCompleteWaitWakeIrp()

BOOLEAN FxPowerPolicyMachine::CanCompleteWaitWakeIrp ( VOID )

inline

Definition at line 751 of file fxpowerpolicystatemachine.hpp.

    {
        //
        // We have 2 potential call sites racing on trying to complete the wait
        // wake irp.  The first is the cancelling call site.  The other is the
        // irp's completion routine.  What we want is for the *2nd* (and last)
        // call site to actually complete the irp.  This is why we check to see
        // if the result of the exchange is that the ownership is already claimed
        // (and not unclaimed as one might first be led to think).
        //
        if (InterlockedExchange(&m_Owner->m_WaitWakeCancelCompletionOwnership,
                                CancelOwnershipClaimed) == CancelOwnershipClaimed) {
            return TRUE;
        }
        else {
            return FALSE;
        }
    }

Referenced by FxPkgPnp::PowerPolicyCancelWaitWake().

◆ InitUsbSS()

_Must_inspect_result_ NTSTATUS FxPowerPolicyMachine::InitUsbSS ( VOID )

Definition at line 2562 of file powerpolicystatemachine.cpp.

{
    FxUsbIdleInfo* pInfo;
    NTSTATUS status;
 
    //
    // The field is already set, we are good to go
    //
    if (m_Owner->m_UsbIdle != NULL) {
        return STATUS_SUCCESS;
    }
 
    pInfo = new (m_PkgPnp->GetDriverGlobals()) FxUsbIdleInfo(m_PkgPnp);
 
    if (pInfo == NULL) {
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    status = pInfo->Initialize();
    if (!NT_SUCCESS(status)) {
        delete pInfo;
        return status;
    }
 
    if (InterlockedCompareExchangePointer((PVOID*) &m_Owner->m_UsbIdle,
                                          pInfo,
                                          NULL) == NULL) {
        //
        // This thread was the one that set the field value.
        //
        DO_NOTHING();
    }
    else {
        //
        // Another thread raced in and beat this thread in setting the field,
        // just delete our allocation and use the other allocated FxUsbIdleInfo.
        //
        delete pInfo;
    }
 
    return STATUS_SUCCESS;
}

Referenced by FxPkgPnp::PowerPolicySetS0IdleSettings().

◆ SetWaitWakeUnclaimed()

VOID FxPowerPolicyMachine::SetWaitWakeUnclaimed ( VOID )

inline

Definition at line 743 of file fxpowerpolicystatemachine.hpp.

    {
        m_Owner->m_WaitWakeCancelCompletionOwnership = CancelOwnershipUnclaimed;
    }

Referenced by FxPkgPnp::DispatchWaitWake().

◆ UsbSSCallbackProcessingComplete()

VOID FxPowerPolicyMachine::UsbSSCallbackProcessingComplete ( VOID )

Definition at line 237 of file powerpolicystatemachinekm.cpp.

{
    ASSERT(m_Owner->m_UsbIdle->m_IdleCallbackEvent != NULL);
    m_Owner->m_UsbIdle->m_IdleCallbackEvent->Set();
}

Referenced by FxPkgPnp::PowerPolicyProcessEventInner().

Member Data Documentation

◆

union { ... } FxPowerPolicyMachine::@4781

◆ m_Owner

FxPowerPolicyOwnerSettings* FxPowerPolicyMachine::m_Owner

Definition at line 777 of file fxpowerpolicystatemachine.hpp.

◆ m_Queue

FxPowerPolicyEvent FxPowerPolicyMachine::m_Queue[FxPowerPolicyEventQueueDepth]

Definition at line 773 of file fxpowerpolicystatemachine.hpp.

Referenced by FxPowerPolicyMachine(), FxPkgPnp::PowerPolicyCheckAssumptions(), FxPkgPnp::PowerPolicyProcessEvent(), and FxPkgPnp::PowerPolicyProcessEventInner().

◆ m_SingularEventsPresent

ULONG FxPowerPolicyMachine::m_SingularEventsPresent

Definition at line 780 of file fxpowerpolicystatemachine.hpp.

Referenced by FxPowerPolicyMachine(), FxPkgPnp::PowerPolicyProcessEvent(), and FxPkgPnp::PowerPolicyProcessEventInner().

◆

union { ... } FxPowerPolicyMachine::m_SingularEventsPresentByName

◆ m_States

FxPowerPolicyMachineStateHistory FxPowerPolicyMachine::m_States

Definition at line 775 of file fxpowerpolicystatemachine.hpp.

Referenced by FxPowerPolicyMachine(), FxPkgPnp::NotPowerPolicyOwnerEnterNewState(), FxPkgPnp::PowerPolicyCheckAssumptions(), and FxPkgPnp::PowerPolicyEnterNewState().

◆ PwrPolIoPresentKnown

ULONG FxPowerPolicyMachine::PwrPolIoPresentKnown

Definition at line 799 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerDownFailedKnown

ULONG FxPowerPolicyMachine::PwrPolPowerDownFailedKnown

Definition at line 805 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerDownIoStoppedKnown

ULONG FxPowerPolicyMachine::PwrPolPowerDownIoStoppedKnown

Definition at line 794 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerDownKnown

ULONG FxPowerPolicyMachine::PwrPolPowerDownKnown

Definition at line 792 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerTimeoutExpiredKnown

ULONG FxPowerPolicyMachine::PwrPolPowerTimeoutExpiredKnown

Definition at line 800 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerUpFailedKnown

ULONG FxPowerPolicyMachine::PwrPolPowerUpFailedKnown

Definition at line 806 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerUpHwStartedKnown

ULONG FxPowerPolicyMachine::PwrPolPowerUpHwStartedKnown

Definition at line 795 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolPowerUpKnown

ULONG FxPowerPolicyMachine::PwrPolPowerUpKnown

Definition at line 793 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolS0IdlePolicyChangedKnown

ULONG FxPowerPolicyMachine::PwrPolS0IdlePolicyChangedKnown

Definition at line 801 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolS0Known

ULONG FxPowerPolicyMachine::PwrPolS0Known

Definition at line 791 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolStartKnown

ULONG FxPowerPolicyMachine::PwrPolStartKnown

Definition at line 788 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolStopKnown

ULONG FxPowerPolicyMachine::PwrPolStopKnown

Definition at line 789 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolSurpriseRemoveKnown

ULONG FxPowerPolicyMachine::PwrPolSurpriseRemoveKnown

Definition at line 802 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolSxKnown

ULONG FxPowerPolicyMachine::PwrPolSxKnown

Definition at line 790 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolUsbSelectiveSuspendCallbackKnown

ULONG FxPowerPolicyMachine::PwrPolUsbSelectiveSuspendCallbackKnown

Definition at line 803 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolUsbSelectiveSuspendCompletedKnown

ULONG FxPowerPolicyMachine::PwrPolUsbSelectiveSuspendCompletedKnown

Definition at line 804 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolWakeArrivedKnown

ULONG FxPowerPolicyMachine::PwrPolWakeArrivedKnown

Definition at line 796 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolWakeFailedKnown

ULONG FxPowerPolicyMachine::PwrPolWakeFailedKnown

Definition at line 798 of file fxpowerpolicystatemachine.hpp.

◆ PwrPolWakeSuccessKnown

ULONG FxPowerPolicyMachine::PwrPolWakeSuccessKnown

Definition at line 797 of file fxpowerpolicystatemachine.hpp.

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxpowerpolicystatemachine.hpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/km/powerpolicystatemachinekm.cpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/powerpolicystatemachine.cpp
sdk/lib/drivers/wdf/shared/irphandlers/pnp/um/powerpolicystatemachineum.cpp

Public Member Functions

Public Attributes

Additional Inherited Members