#include <fxdeviceinterface.hpp>

Inheritance diagram for FxDeviceInterface:

Collaboration diagram for FxDeviceInterface:

[legend]

Public Member Functions
	FxDeviceInterface (VOID)

	~FxDeviceInterface (VOID)

_Must_inspect_result_ NTSTATUS	Initialize (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in CONST GUID *InterfaceGUID, __in_opt PCUNICODE_STRING ReferenceString)

VOID	SetState (__in BOOLEAN State)

_Must_inspect_result_ NTSTATUS	Register (__in MdDeviceObject Pdo)

_Must_inspect_result_ NTSTATUS	Register (_In_ FxDevice *Device)

NTSTATUS	GetSymbolicLinkName (_In_ FxString *LinkString)

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)

Static Public Member Functions
static FxDeviceInterface *	_FromEntry (__in PSINGLE_LIST_ENTRY Entry)

Public Attributes
GUID	m_InterfaceClassGUID

UNICODE_STRING	m_ReferenceString

UNICODE_STRING	m_SymbolicLinkName

SINGLE_LIST_ENTRY	m_Entry

BOOLEAN	m_State

MdDeviceObject	m_Device

Additional Inherited Members
Protected Member Functions inherited from FxStump
	FxStump (VOID)

Detailed Description

Definition at line 28 of file fxdeviceinterface.hpp.

Constructor & Destructor Documentation

◆ FxDeviceInterface()

FxDeviceInterface::FxDeviceInterface ( VOID )

Definition at line 31 of file fxdeviceinterface.cpp.

{
    RtlZeroMemory(&m_InterfaceClassGUID, sizeof(m_InterfaceClassGUID));
 
    RtlZeroMemory(&m_SymbolicLinkName, sizeof(m_SymbolicLinkName));
    RtlZeroMemory(&m_ReferenceString, sizeof(m_ReferenceString));
 
    m_Entry.Next = NULL;
 
    m_State = FALSE;
 
#if (FX_CORE_MODE == FX_CORE_USER_MODE)
    m_Device = NULL;
#endif
 
}

◆ ~FxDeviceInterface()

FxDeviceInterface::~FxDeviceInterface ( VOID )

Definition at line 61 of file fxdeviceinterface.cpp.

{
    // the device interface should be off now
    ASSERT(m_State == FALSE);
 
    // should no longer be in any list
    ASSERT(m_Entry.Next == NULL);
 
    if (m_ReferenceString.Buffer != NULL) {
        FxPoolFree(m_ReferenceString.Buffer);
        RtlZeroMemory(&m_ReferenceString, sizeof(m_ReferenceString));
    }
 
    if (m_SymbolicLinkName.Buffer != NULL) {
        RtlFreeUnicodeString(&m_SymbolicLinkName);
    }
}

Member Function Documentation

◆ _FromEntry()

static FxDeviceInterface * FxDeviceInterface::_FromEntry ( __in PSINGLE_LIST_ENTRY Entry )

inlinestatic

Definition at line 60 of file fxdeviceinterface.hpp.

    {
        return CONTAINING_RECORD(Entry, FxDeviceInterface, m_Entry);
    }

Referenced by for(), FxDevice::IsInterfaceRegistered(), FxPkgPnp::PnpDisableInterfaces(), FxPkgPnp::PnpEnableInterfacesAndRegisterWmi(), FxPkgPdo::PnpQueryResourceRequirements(), and FxPkgPnp::~FxPkgPnp().

◆ GetSymbolicLinkName()

NTSTATUS FxDeviceInterface::GetSymbolicLinkName ( _In_ FxString * LinkString )

Definition at line 212 of file fxdeviceinterfacekm.cpp.

{
    NTSTATUS status;
 
    if (m_SymbolicLinkName.Buffer == NULL) {
        //
        // The device interface has not yet been registered b/c it
        // belongs to a PDO and the PDO has not been recognized by
        // pnp yet.
        //
        status = STATUS_INVALID_DEVICE_STATE;
        UNREFERENCED_PARAMETER(LinkString);
    }
    else {
        //
        // Attempt a copy
        //
        status = LinkString->Assign(&m_SymbolicLinkName);
    }
 
    return status;
}

◆ Initialize()

_Must_inspect_result_ NTSTATUS FxDeviceInterface::Initialize	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in CONST GUID *	InterfaceGUID,
		__in_opt PCUNICODE_STRING	ReferenceString
	)

Definition at line 94 of file fxdeviceinterface.cpp.

{
    RtlCopyMemory(&m_InterfaceClassGUID, InterfaceGUID, sizeof(GUID));
 
    if (ReferenceString != NULL) {
        return FxDuplicateUnicodeString(FxDriverGlobals,
                                        ReferenceString,
                                        &m_ReferenceString);
    }
    else {
        return STATUS_SUCCESS;
    }
}

◆ Register() [1/2]

_Must_inspect_result_ NTSTATUS FxDeviceInterface::Register ( __in MdDeviceObject Pdo )

Definition at line 153 of file fxdeviceinterfacekm.cpp.

{
    PUNICODE_STRING pString;
 
    if (m_ReferenceString.Length > 0) {
        pString = &m_ReferenceString;
    }
    else {
        pString = NULL;
    }
 
    return Mx::MxRegisterDeviceInterface(
        Pdo, &m_InterfaceClassGUID, pString, &m_SymbolicLinkName);
}

Referenced by FxPkgPdo::PnpQueryResourceRequirements().

◆ Register() [2/2]

_Must_inspect_result_ NTSTATUS FxDeviceInterface::Register ( _In_ FxDevice * Device )

Definition at line 185 of file fxdeviceinterfacekm.cpp.

{
    NTSTATUS status;
    MdDeviceObject pdo;
 
    pdo = Device->GetSafePhysicalDevice();
 
    if (pdo != NULL) {
        status = Register(pdo);
    }
    else {
        //
        // Leave the device interface unregistered.  When we are in hardware
        // available, we will register there once we know for sure we have a
        // real live PDO that the system has acknowledged.
        //
        DO_NOTHING();
 
        status = STATUS_SUCCESS;
    }
 
    return status;
}

◆ SetState()

VOID FxDeviceInterface::SetState ( __in BOOLEAN State )

Definition at line 129 of file fxdeviceinterface.cpp.

{
    m_State = State;
 
    //
    // Only set the state if the interface has been registered
    //
    if (m_SymbolicLinkName.Buffer != NULL) {
        Mx::MxSetDeviceInterfaceState(&m_SymbolicLinkName, m_State);
    }
}

Referenced by for(), FxPkgPnp::PnpDisableInterfaces(), and FxPkgPnp::PnpEnableInterfacesAndRegisterWmi().

Member Data Documentation

◆ m_Device

MdDeviceObject FxDeviceInterface::m_Device

Definition at line 45 of file fxdeviceinterface.hpp.

Referenced by FxDeviceInterface().

◆ m_Entry

SINGLE_LIST_ENTRY FxDeviceInterface::m_Entry

Definition at line 37 of file fxdeviceinterface.hpp.

Referenced by _FromEntry(), FxDeviceInterface(), if(), ~FxDeviceInterface(), and FxPkgPnp::~FxPkgPnp().

◆ m_InterfaceClassGUID

GUID FxDeviceInterface::m_InterfaceClassGUID

Definition at line 31 of file fxdeviceinterface.hpp.

Referenced by for(), FxDeviceInterface(), Initialize(), FxDevice::IsInterfaceRegistered(), and Register().

◆ m_ReferenceString

UNICODE_STRING FxDeviceInterface::m_ReferenceString

Definition at line 33 of file fxdeviceinterface.hpp.

Referenced by for(), FxDeviceInterface(), Initialize(), FxDevice::IsInterfaceRegistered(), Register(), and ~FxDeviceInterface().

◆ m_State

BOOLEAN FxDeviceInterface::m_State

Definition at line 39 of file fxdeviceinterface.hpp.

Referenced by FxDeviceInterface(), SetState(), and ~FxDeviceInterface().

◆ m_SymbolicLinkName

UNICODE_STRING FxDeviceInterface::m_SymbolicLinkName

Definition at line 35 of file fxdeviceinterface.hpp.

Referenced by FxDeviceInterface(), GetSymbolicLinkName(), FxPkgPnp::PnpEnableInterfacesAndRegisterWmi(), FxPkgPdo::PnpQueryResourceRequirements(), Register(), SetState(), and ~FxDeviceInterface().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxdeviceinterface.hpp
sdk/lib/drivers/wdf/shared/support/fxdeviceinterface.cpp
sdk/lib/drivers/wdf/shared/support/km/fxdeviceinterfacekm.cpp
sdk/lib/drivers/wdf/shared/support/um/fxdeviceinterfaceum.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members