MxDeviceObject Class Reference

#include <mxdeviceobject.h>

Collaboration diagram for MxDeviceObject:

Public Member Functions
__inline	MxDeviceObject (__in MdDeviceObject DeviceObject)
__inline	MxDeviceObject (VOID)
__inline MdDeviceObject	GetObject (VOID)
__inline VOID	SetObject (__in_opt MdDeviceObject DeviceObject)
CCHAR	GetStackSize (VOID)
VOID	SetStackSize (_In_ CCHAR Size)
VOID	ReferenceObject ()
MdDeviceObject	GetAttachedDeviceReference (VOID)
VOID	DereferenceObject ()
ULONG	GetFlags (VOID)
VOID	SetFlags (ULONG Flags)
POWER_STATE	SetPowerState (__in POWER_STATE_TYPE Type, __in POWER_STATE State)
VOID	InvalidateDeviceRelations (__in DEVICE_RELATION_TYPE Type)
VOID	InvalidateDeviceState (__in MdDeviceObject Fdo)
PVOID	GetDeviceExtension (VOID)
VOID	SetDeviceExtension (PVOID Value)
DEVICE_TYPE	GetDeviceType (VOID)
ULONG	GetCharacteristics (VOID)
VOID	SetDeviceType (DEVICE_TYPE Value)
VOID	SetCharacteristics (ULONG Characteristics)
VOID	SetAlignmentRequirement (_In_ ULONG Value)
ULONG	GetAlignmentRequirement (VOID)

Private Attributes
MdDeviceObject	m_DeviceObject

Detailed Description

Definition at line 20 of file mxdeviceobject.h.

Constructor & Destructor Documentation

MxDeviceObject() [1/2]

__inline MxDeviceObject::MxDeviceObject ( __in MdDeviceObject  DeviceObject )

inline

Definition at line 31 of file mxdeviceobject.h.

          :
        m_DeviceObject(DeviceObject)
    {
    }

MxDeviceObject() [2/2]

__inline MxDeviceObject::MxDeviceObject ( VOID  )

inline

Definition at line 39 of file mxdeviceobject.h.

          :
        m_DeviceObject(NULL)
    {
    }

Member Function Documentation

DereferenceObject()

VOID MxDeviceObject::DereferenceObject

(

)

Definition at line 56 of file mxdeviceobjectkm.h.

{
    ObDereferenceObject(m_DeviceObject);
}

Referenced by FxPkgPnp::PnpDeviceUsageNotification(), and SendDeviceUsageNotificationWorker().

GetAlignmentRequirement()

ULONG MxDeviceObject::GetAlignmentRequirement

(

VOID

)

Definition at line 188 of file mxdeviceobjectkm.h.

{
    return m_DeviceObject->AlignmentRequirement;
}

GetAttachedDeviceReference()

MdDeviceObject MxDeviceObject::GetAttachedDeviceReference

(

VOID

)

Definition at line 47 of file mxdeviceobjectkm.h.

{
    return IoGetAttachedDeviceReference(m_DeviceObject);
}

Referenced by FxPkgPnp::PnpDeviceUsageNotification().

GetCharacteristics()

ULONG MxDeviceObject::GetCharacteristics

(

VOID

)

Definition at line 152 of file mxdeviceobjectkm.h.

{
    return m_DeviceObject->Characteristics;
}

Referenced by FxDevice::FdoInitialize().

GetDeviceExtension()

PVOID MxDeviceObject::GetDeviceExtension

(

VOID

)

Definition at line 125 of file mxdeviceobjectkm.h.

{
    return m_DeviceObject->DeviceExtension;
}

Referenced by FxDevice::CreateDevice().

GetDeviceType()

DEVICE_TYPE MxDeviceObject::GetDeviceType

(

VOID

)

Definition at line 143 of file mxdeviceobjectkm.h.

{
    return m_DeviceObject->DeviceType;
}

Referenced by FxFileObject::_GetFileObjectFromWdm(), and FxDevice::FdoInitialize().

GetFlags()

ULONG MxDeviceObject::GetFlags

(

VOID

)

Definition at line 64 of file mxdeviceobjectkm.h.

{
#ifdef _MSC_VER
#pragma warning(disable:28129)
#endif
    return m_DeviceObject->Flags;
}

Referenced by __drv_strictTypeMatch(), FxDevice::CreateDevice(), FxDevice::FdoInitialize(), FxDevice::FinishInitializing(), FxDeviceBase::GetAttachedDeviceObjectFlags(), FxDeviceBase::GetDeviceObjectFlags(), FxIoTarget::GetTargetIoType(), if(), FxDevice::PdoInitialize(), FxPkgPnp::PowerPolCheckPowerPageable(), and FxDevice::SetFilterIoType().

GetObject()

__inline MdDeviceObject MxDeviceObject::GetObject ( VOID  )

inline

Definition at line 48 of file mxdeviceobject.h.

    {
        return m_DeviceObject;
    }

Referenced by FxDevice::DeleteObject(), FxDevice::Destroy(), FxDevice::DetachDevice(), FxPkgFdo::DispatchSystemSetPower(), FxMpDevice::Dispose(), FxDevice::FdoInitialize(), FxMpDevice::FxMpDevice(), FxDeviceBase::GetAttachedDevice(), FxDeviceBase::GetAttachedDeviceReference(), FxDeviceBase::GetDeviceObject(), FxDeviceBase::GetPhysicalDevice(), FxDevice::GetSafePhysicalDevice(), GetStackCapabilities(), FxDevice::IsRemoveLockEnabledForIo(), FxPkgPnp::PnpDeviceUsageNotification(), FxDevice::PostInitialize(), FxPkgPnp::QueryForD3ColdInterface(), SendDeviceUsageNotificationWorker(), SetD3ColdSupport(), FxDevice::SetFilterIoType(), and FxDevice::~FxDevice().

GetStackSize()

CCHAR MxDeviceObject::GetStackSize

(

VOID

)

Definition at line 21 of file mxdeviceobjectkm.h.

{
    return m_DeviceObject->StackSize;
}

Referenced by FxDevice::GetStackSize(), FxIoTarget::Init(), FxUsbIdleInfo::Initialize(), FxDevice::PdoInitialize(), FxPkgPnp::PnpDeviceUsageNotification(), and FxPkgPnp::QueryForD3ColdInterface().

InvalidateDeviceRelations()

VOID MxDeviceObject::InvalidateDeviceRelations

(

__in DEVICE_RELATION_TYPE

Type

)

Definition at line 98 of file mxdeviceobjectkm.h.

{
    IoInvalidateDeviceRelations(m_DeviceObject, Type);
}

Referenced by FxPkgPnp::HandleQueryDeviceRelations().

InvalidateDeviceState()

VOID MxDeviceObject::InvalidateDeviceState

(

__in MdDeviceObject

Fdo

)

Definition at line 107 of file mxdeviceobjectkm.h.

{
    //
    // UMDF currently needs Fdo for InvalidateDeviceState
    // FDO is not used in km.
    //
    // m_DeviceObject holds PDO that is what is used below.
    //
 
    UNREFERENCED_PARAMETER(Fdo);
 
    IoInvalidateDeviceState(m_DeviceObject);
}

Referenced by FxPkgPnp::CommitUsageNotification(), FxDevice::InvalidateDeviceState(), FxPkgPnp::PnpEventFailedPowerPolicyRemoved(), FxPkgPnp::SetDeviceFailed(), and FxPkgPnp::SetInternalFailure().

ReferenceObject()

VOID MxDeviceObject::ReferenceObject

(

)

Definition at line 39 of file mxdeviceobjectkm.h.

{
    ObReferenceObject(m_DeviceObject);
}

SetAlignmentRequirement()

VOID MxDeviceObject::SetAlignmentRequirement

(

_In_ ULONG

Value

)

Definition at line 179 of file mxdeviceobjectkm.h.

{
    m_DeviceObject->AlignmentRequirement = Value;
}

SetCharacteristics()

VOID MxDeviceObject::SetCharacteristics

(

ULONG

Characteristics

)

Definition at line 170 of file mxdeviceobjectkm.h.

{
    m_DeviceObject->Characteristics = Characteristics;
}

Referenced by FxDevice::FdoInitialize().

SetDeviceExtension()

VOID MxDeviceObject::SetDeviceExtension

(

PVOID

Value

)

Definition at line 134 of file mxdeviceobjectkm.h.

{
    m_DeviceObject->DeviceExtension = Value;
}

Referenced by FxDevice::CreateDevice(), and FxDevice::Destroy().

SetDeviceType()

VOID MxDeviceObject::SetDeviceType

(

DEVICE_TYPE

Value

)

Definition at line 161 of file mxdeviceobjectkm.h.

{
    m_DeviceObject->DeviceType = Value;
}

Referenced by FxDevice::FdoInitialize().

SetFlags()

VOID MxDeviceObject::SetFlags

(

ULONG

Flags

)

Definition at line 76 of file mxdeviceobjectkm.h.

{
#ifdef _MSC_VER
#pragma warning(disable:28129)
#endif
    m_DeviceObject->Flags = Flags;
}

Referenced by FxDevice::CreateDevice(), FxDevice::FdoInitialize(), FxDevice::FinishInitializing(), FxDevice::PdoInitialize(), FxDeviceBase::SetDeviceObjectFlags(), and FxDevice::SetFilterIoType().

SetObject()

__inline VOID MxDeviceObject::SetObject ( __in_opt MdDeviceObject  DeviceObject )

inline

Definition at line 57 of file mxdeviceobject.h.

    {
        m_DeviceObject = DeviceObject;
    }

Referenced by FxPkgPdo::_QueryCapsWorkItem(), FxDevice::CreateDevice(), FxDevice::Destroy(), FxDevice::DetachDevice(), FxDevice::FdoInitialize(), FxIoTarget::Init(), FxDeviceBase::Init(), FxUsbIdleInfo::Initialize(), FxPkgPnp::PnpDeviceUsageNotification(), FxPkgPdo::PnpQueryCapabilities(), FxPkgPnp::PowerPolCheckPowerPageable(), FxPkgPnp::PowerPolicySetS0IdleSettings(), FxPkgPnp::QueryForCapabilities(), FxPkgPnp::QueryForD3ColdInterface(), and SendDeviceUsageNotificationWorker().

SetPowerState()

POWER_STATE MxDeviceObject::SetPowerState	(	__in POWER_STATE_TYPE	Type,
		__in POWER_STATE	State
	)

Definition at line 88 of file mxdeviceobjectkm.h.

{
    return PoSetPowerState(m_DeviceObject, Type, State);
}

Referenced by FxPkgFdo::DispatchSystemSetPower(), FxPkgPdo::DispatchSystemSetPower(), and FxPkgPnp::PowerSetDevicePowerState().

SetStackSize()

VOID MxDeviceObject::SetStackSize

(

_In_ CCHAR

Size

)

Definition at line 30 of file mxdeviceobjectkm.h.

{
    m_DeviceObject->StackSize = Size;
}

Referenced by FxDevice::PdoInitialize(), and FxDevice::SetStackSize().

Member Data Documentation

m_DeviceObject

MdDeviceObject MxDeviceObject::m_DeviceObject

private

Definition at line 27 of file mxdeviceobject.h.

Referenced by DereferenceObject(), GetAlignmentRequirement(), GetAttachedDeviceReference(), GetCharacteristics(), GetDeviceExtension(), GetDeviceType(), GetFlags(), GetObject(), GetStackSize(), InvalidateDeviceRelations(), InvalidateDeviceState(), ReferenceObject(), SetAlignmentRequirement(), SetCharacteristics(), SetDeviceExtension(), SetDeviceType(), SetFlags(), SetObject(), SetPowerState(), and SetStackSize().

---

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

• sdk/lib/drivers/wdf/shared/inc/primitives/common/mxdeviceobject.h
• sdk/lib/drivers/wdf/shared/inc/primitives/km/mxdeviceobjectkm.h
• sdk/lib/drivers/wdf/shared/primitives/um/mxdeviceobjectum.cpp