FxQueryInterface Struct Reference

#include <fxqueryinterface.hpp>

Inheritance diagram for FxQueryInterface:

Collaboration diagram for FxQueryInterface:

Public Member Functions
	FxQueryInterface (__in CfxDevice *Device, __in PWDF_QUERY_INTERFACE_CONFIG Config)
	~FxQueryInterface (VOID)
VOID	SetEmbedded (__in PWDF_QUERY_INTERFACE_CONFIG Config, __in PINTERFACE Interface)
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 FxQueryInterface *	_FromEntry (__in PSINGLE_LIST_ENTRY Entry)
static VOID	_FormatIrp (__in PIRP Irp, __in const GUID *InterfaceGuid, __out PINTERFACE Interface, __in USHORT InterfaceSize, __in USHORT InterfaceVersion, __in_opt PVOID InterfaceSpecificData=NULL)
static _Must_inspect_result_ NTSTATUS	_QueryForInterface (__in PDEVICE_OBJECT TopOfStack, __in const GUID *InterfaceType, __out PINTERFACE Interface, __in USHORT Size, __in USHORT Version, __in_opt PVOID InterfaceSpecificData)

Public Attributes
GUID	m_InterfaceType
PINTERFACE	m_Interface
CfxDevice *	m_Device
FxDeviceProcessQueryInterfaceRequest	m_ProcessRequest
SINGLE_LIST_ENTRY	m_Entry
BOOLEAN	m_ImportInterface
BOOLEAN	m_SendQueryToParentStack
BOOLEAN	m_EmbeddedInterface

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

Detailed Description

Definition at line 69 of file fxqueryinterface.hpp.

Constructor & Destructor Documentation

FxQueryInterface()

FxQueryInterface::FxQueryInterface	(	__in CfxDevice *	Device,
		__in PWDF_QUERY_INTERFACE_CONFIG	Config
	)

Definition at line 31 of file fxqueryinterface.cpp.

      :
    m_Device(Device),
    m_Interface(NULL)
{
    m_Entry.Next = NULL;
 
    m_EmbeddedInterface = FALSE;
 
    if (Config != NULL) {
        m_SendQueryToParentStack = Config->SendQueryToParentStack;
        m_ImportInterface = Config->ImportInterface;
        m_ProcessRequest.m_Method = Config->EvtDeviceProcessQueryInterfaceRequest;
        RtlCopyMemory(&m_InterfaceType, Config->InterfaceType, sizeof(GUID));
    }
}

~FxQueryInterface()

FxQueryInterface::~FxQueryInterface

(

VOID

)

Definition at line 50 of file fxqueryinterface.cpp.

{
    //
    // Should not in any list
    //
    ASSERT(m_Entry.Next == NULL);
 
    if (m_Interface != NULL && m_EmbeddedInterface == FALSE) {
        FxPoolFree(m_Interface);
    }
}

Member Function Documentation

_FormatIrp()

VOID FxQueryInterface::_FormatIrp ( __in PIRP  Irp, __in const GUID *  InterfaceGuid, __out PINTERFACE  Interface, __in USHORT  InterfaceSize, __in USHORT  InterfaceVersion, __in_opt PVOID  InterfaceSpecificData = NULL  )

static

Definition at line 63 of file fxqueryinterface.cpp.

{
    PIO_STACK_LOCATION stack;
 
    Irp->IoStatus.Status = STATUS_NOT_SUPPORTED;
 
    stack = IoGetNextIrpStackLocation(Irp);
 
    stack->MajorFunction = IRP_MJ_PNP;
    stack->MinorFunction = IRP_MN_QUERY_INTERFACE;
 
    stack->Parameters.QueryInterface.Interface = Interface;
    stack->Parameters.QueryInterface.InterfaceSpecificData = InterfaceSpecificData;
    stack->Parameters.QueryInterface.Size = InterfaceSize;
    stack->Parameters.QueryInterface.Version = InterfaceVersion;
    stack->Parameters.QueryInterface.InterfaceType = InterfaceGuid;
}

Referenced by _QueryForInterface(), and FxUsbDevice::InitDevice().

_FromEntry()

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

inlinestatic

Definition at line 89 of file fxqueryinterface.hpp.

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

Referenced by FxPkgPnp::Dispose(), and FxPkgPnp::HandleQueryInterface().

_QueryForInterface()

_Must_inspect_result_ NTSTATUS FxQueryInterface::_QueryForInterface ( __in PDEVICE_OBJECT  TopOfStack, __in const GUID *  InterfaceType, __out PINTERFACE  Interface, __in USHORT  Size, __in USHORT  Version, __in_opt PVOID  InterfaceSpecificData  )

static

Definition at line 90 of file fxqueryinterface.cpp.

{
    PIRP pIrp;
    NTSTATUS status;
 
    pIrp = IoAllocateIrp(TopOfStack->StackSize, FALSE);
 
    if (pIrp != NULL) {
        FxAutoIrp irp(pIrp);
 
        _FormatIrp(
            pIrp,
            InterfaceType,
            Interface,
            Size,
            Version,
            InterfaceSpecificData
            );
 
        status = irp.SendIrpSynchronously(TopOfStack);
    }
    else {
        status = STATUS_INSUFFICIENT_RESOURCES;
    }
 
    return status;
}

Referenced by FxDeviceBase::QueryForInterface().

SetEmbedded()

VOID FxQueryInterface::SetEmbedded	(	__in PWDF_QUERY_INTERFACE_CONFIG	Config,
		__in PINTERFACE	Interface
	)

Definition at line 151 of file fxqueryinterface.cpp.

{
    m_EmbeddedInterface = TRUE;
    m_Interface = Interface;
 
    m_SendQueryToParentStack = Config->SendQueryToParentStack;
    m_ImportInterface = Config->ImportInterface;
    m_ProcessRequest.m_Method = Config->EvtDeviceProcessQueryInterfaceRequest;
    RtlCopyMemory(&m_InterfaceType, Config->InterfaceType, sizeof(GUID));
}

Member Data Documentation

m_Device

CfxDevice* FxQueryInterface::m_Device

Definition at line 124 of file fxqueryinterface.hpp.

m_EmbeddedInterface

BOOLEAN FxQueryInterface::m_EmbeddedInterface

Definition at line 134 of file fxqueryinterface.hpp.

Referenced by FxPkgPnp::Dispose(), FxQueryInterface(), SetEmbedded(), and ~FxQueryInterface().

m_Entry

SINGLE_LIST_ENTRY FxQueryInterface::m_Entry

Definition at line 128 of file fxqueryinterface.hpp.

Referenced by _FromEntry(), FxPkgPnp::Dispose(), FxQueryInterface(), and ~FxQueryInterface().

m_ImportInterface

BOOLEAN FxQueryInterface::m_ImportInterface

Definition at line 130 of file fxqueryinterface.hpp.

Referenced by FxQueryInterface(), FxPkgPnp::HandleQueryInterface(), and SetEmbedded().

m_Interface

PINTERFACE FxQueryInterface::m_Interface

Definition at line 122 of file fxqueryinterface.hpp.

Referenced by FxPkgPnp::HandleQueryInterface(), SetEmbedded(), and ~FxQueryInterface().

m_InterfaceType

GUID FxQueryInterface::m_InterfaceType

Definition at line 120 of file fxqueryinterface.hpp.

Referenced by FxQueryInterface(), FxPkgPnp::HandleQueryInterface(), and SetEmbedded().

m_ProcessRequest

FxDeviceProcessQueryInterfaceRequest FxQueryInterface::m_ProcessRequest

Definition at line 126 of file fxqueryinterface.hpp.

Referenced by FxQueryInterface(), FxPkgPnp::HandleQueryInterface(), and SetEmbedded().

m_SendQueryToParentStack

BOOLEAN FxQueryInterface::m_SendQueryToParentStack

Definition at line 132 of file fxqueryinterface.hpp.

Referenced by FxQueryInterface(), FxPkgPnp::HandleQueryInterface(), and SetEmbedded().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/common/fxqueryinterface.hpp
• sdk/lib/drivers/wdf/kmdf/src/support/fxqueryinterface.cpp
• sdk/lib/drivers/wdf/shared/irphandlers/pnp/um/fxqueryinterfaceum.cpp