FxCREvent Struct Reference

#include <fxwaitlock.hpp>

Collaboration diagram for FxCREvent:

Public Member Functions
	FxCREvent (__in BOOLEAN InitialState=FALSE)
	FxCREvent (__in EVENT_TYPE Type, __in BOOLEAN InitialState)
CHECK_RETURN_IF_USER_MODE NTSTATUS	Initialize (__in BOOLEAN InitialState=FALSE)
CHECK_RETURN_IF_USER_MODE NTSTATUS	Initialize (__in EVENT_TYPE Type, __in BOOLEAN InitialState)
	__drv_valueIs (==0;==258) _Acquires_lock_(_Global_critical_region_) NTSTATUS EnterCRAndWait(VOID)
NTSTATUS	EnterCRAndWaitAndLeave (VOID)
	__drv_when (Timeout==NULL, __drv_valueIs(==0)) __drv_when(Timeout !
	__drv_valueIs (==0;==258)) __drv_when(Timeout !
_Must_inspect_result_	_Acquires_lock_ (_Global_critical_region_) NTSTATUS EnterCRAndWait(__in PLONGLONG Timeout)
_Must_inspect_result_ NTSTATUS	EnterCRAndWaitAndLeave (__in PLONGLONG Timeout)
	_Releases_lock_ (_Global_critical_region_) VOID LeaveCR(VOID)
VOID	Set (VOID)
VOID	Clear (VOID)
LONG	ReadState (VOID)
PVOID	GetEvent (VOID)
FxCREvent *	GetSelfPointer (VOID)

Private Member Functions
FxCREvent *	operator& (VOID)

Private Attributes
MxEvent	m_Event

Detailed Description

Definition at line 16 of file fxwaitlock.hpp.

Constructor & Destructor Documentation

FxCREvent() [1/2]

FxCREvent::FxCREvent ( __in BOOLEAN  InitialState = FALSE )

inline

Definition at line 17 of file fxwaitlock.hpp.

    {
    //
    // For kernel mode letting c'tor do the initialization to not churn the
    // non-shared code
    //
#if (FX_CORE_MODE==FX_CORE_KERNEL_MODE)
        m_Event.Initialize(SynchronizationEvent, InitialState);
#else
        UNREFERENCED_PARAMETER(InitialState);
#endif
    }

FxCREvent() [2/2]

FxCREvent::FxCREvent ( __in EVENT_TYPE  Type, __in BOOLEAN  InitialState  )

inline

Definition at line 36 of file fxwaitlock.hpp.

    {
#if (FX_CORE_MODE==FX_CORE_KERNEL_MODE)
        m_Event.Initialize(Type, InitialState);
#else
        UNREFERENCED_PARAMETER(Type);
        UNREFERENCED_PARAMETER(InitialState);
#endif
    }

Member Function Documentation

__drv_valueIs() [1/2]

FxCREvent::__drv_valueIs ( )

inline

Definition at line 68 of file fxwaitlock.hpp.

    {
        NTSTATUS status;
 
        Mx::MxEnterCriticalRegion();
 
        status = m_Event.WaitFor(Executive,
                                 KernelMode,
                                 FALSE,
                                 NULL);
        return status;
    }

__drv_valueIs() [2/2]

FxCREvent::__drv_valueIs

(

)

__drv_when()

FxCREvent::__drv_when	(	Timeout	= = NULL,
		__drv_valueIs(==0)
	)

_Acquires_lock_()

_Must_inspect_result_ FxCREvent::_Acquires_lock_ ( _Global_critical_region_  )

inline

Definition at line 102 of file fxwaitlock.hpp.

    {
        NTSTATUS status;
 
        Mx::MxEnterCriticalRegion();
 
        status = m_Event.WaitFor(Executive,
                                 KernelMode,
                                 FALSE,
                                 (PLARGE_INTEGER) Timeout);
 
        return status;
    }

_Releases_lock_()

FxCREvent::_Releases_lock_ ( _Global_critical_region_  )

inline

Definition at line 134 of file fxwaitlock.hpp.

    {
        Mx::MxLeaveCriticalRegion();
    }

Clear()

VOID FxCREvent::Clear ( VOID  )

inline

Definition at line 152 of file fxwaitlock.hpp.

    {
        m_Event.Clear();
    }

Referenced by FxIoTargetRemote::Close(), FxWorkItem::Enqueue(), FxSystemWorkItem::EnqueueWorker(), FxIoTarget::GotoPurgeState(), FxIoTarget::GotoRemoveState(), FxIoTarget::GotoStartState(), FxIoTarget::GotoStopState(), and FxIoTargetRemote::Open().

EnterCRAndWaitAndLeave() [1/2]

_Must_inspect_result_ NTSTATUS FxCREvent::EnterCRAndWaitAndLeave ( __in PLONGLONG  Timeout )

inline

Definition at line 122 of file fxwaitlock.hpp.

    {
        NTSTATUS status;
 
        status = EnterCRAndWait(Timeout);
        LeaveCR();
 
        return status;
    }

EnterCRAndWaitAndLeave() [2/2]

NTSTATUS FxCREvent::EnterCRAndWaitAndLeave ( VOID  )

inline

Definition at line 87 of file fxwaitlock.hpp.

    {
        NTSTATUS status;
 
        status = EnterCRAndWait();
        LeaveCR();
 
        return status;
    }

Referenced by FxIoTargetRemote::Close(), FxWmiIrpHandler::DecrementUpdateCountAndWait(), FxPkgPnp::ReleasePowerThread(), FxSystemWorkItem::ReleaseWorkItemQueuedCountAndWait(), FxPowerIdleMachine::WaitForD0(), FxSystemWorkItem::WaitForExit(), FxIoTarget::WaitForSentIoToComplete(), and FxWorkItem::WaitForSignal().

GetEvent()

PVOID FxCREvent::GetEvent ( VOID  )

inline

Definition at line 172 of file fxwaitlock.hpp.

    {
        return m_Event.GetEvent();
    }

Referenced by FxIoTargetRemote::Close(), FxIoTarget::CompleteCanceledRequest(), FxIoTarget::HandleFailedResubmit(), FxIoTarget::PrintDisposeMessage(), FxIoTarget::RequestCompletionRoutine(), FxIoTarget::TimerCallback(), and FxIoTarget::WaitForDisposeEvent().

GetSelfPointer()

FxCREvent * FxCREvent::GetSelfPointer ( VOID  )

inline

Definition at line 180 of file fxwaitlock.hpp.

    {
        //
        // Since operator& is hidden, we still need to be able to get a pointer
        // to this object, so we must make it an explicit method.
        //
        return this;
    }

Referenced by __drv_maxIRQL(), FxPkgPnp::CleanupStateMachines(), FxPkgPnp::ReleasePowerThread(), and FxIoTarget::WaitForDisposeEvent().

Initialize() [1/2]

CHECK_RETURN_IF_USER_MODE NTSTATUS FxCREvent::Initialize ( __in BOOLEAN  InitialState = FALSE )

inline

Definition at line 51 of file fxwaitlock.hpp.

    {
        return m_Event.Initialize(SynchronizationEvent, InitialState);
    }

Referenced by FxPkgPnp::CleanupStateMachines(), FxPowerIdleMachine::Init(), FxSystemWorkItem::Initialize(), FxWorkItem::Initialize(), FxPkgPnp::Initialize(), FxWmiIrpHandler::ResetStateForPdoRestart(), and FxIoTarget::WaitForDisposeEvent().

Initialize() [2/2]

CHECK_RETURN_IF_USER_MODE NTSTATUS FxCREvent::Initialize ( __in EVENT_TYPE  Type, __in BOOLEAN  InitialState  )

inline

Definition at line 60 of file fxwaitlock.hpp.

    {
        return m_Event.Initialize(Type, InitialState);
    }

operator&()

FxCREvent * FxCREvent::operator& ( VOID  )

inlineprivate

Definition at line 191 of file fxwaitlock.hpp.

    {
        //
        // By making the address of operator private, we make it harder (hopefully
        // impossible) to accidentally use this object in an improper fashion, ie
        // something like this is prevented:
        //
        // FxCREvent event;
        // KeWaitForSingleObject(&event, ...);
        //
        ASSERT(FALSE);
        return NULL;
    }

ReadState()

LONG FxCREvent::ReadState ( VOID  )

inline

Definition at line 160 of file fxwaitlock.hpp.

    {
        return m_Event.ReadState();
    }

Referenced by FxPowerIdleMachine::InD0Locked(), and FxPowerIdleMachine::IsTransitioning().

Set()

VOID FxCREvent::Set ( VOID  )

inline

Definition at line 144 of file fxwaitlock.hpp.

    {
        m_Event.Set();
    }

Referenced by FxPkgPnp::_PowerThreadInterfaceDereference(), FxIoTarget::CompleteCanceledRequest(), FxIoTarget::DecrementIoCount(), FxWmiIrpHandler::DecrementUpdateCount(), FxSystemWorkItem::DecrementWorkItemQueued(), FxPostProcessInfo::Evaluate(), FxIoTarget::GotoPurgeState(), FxIoTarget::GotoRemoveState(), FxIoTarget::GotoStopState(), FxIoTarget::HandleFailedResubmit(), FxIoTargetRemote::Open(), FxIoTarget::RequestCompletionRoutine(), FxPowerIdleMachine::SendD0Notification(), FxIoTarget::TimerCallback(), FxPowerPolicyMachine::UsbSSCallbackProcessingComplete(), FxSystemWorkItem::WorkItemHandler(), and FxWorkItem::WorkItemHandler().

Member Data Documentation

m_Event

MxEvent FxCREvent::m_Event

private

Definition at line 208 of file fxwaitlock.hpp.

Referenced by __drv_valueIs(), _Acquires_lock_(), Clear(), FxCREvent(), GetEvent(), Initialize(), ReadState(), and Set().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxwaitlock.hpp