#include <fxrequestcontext.hpp>

Inheritance diagram for FxRequestContext:

[legend]

Collaboration diagram for FxRequestContext:

[legend]

Public Member Functions
	FxRequestContext (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual	~FxRequestContext (VOID)

virtual VOID	Dispose (VOID)

virtual VOID	StoreAndReferenceMemory (__in FxRequestBuffer *Buffer)

virtual VOID	ReleaseAndRestore (__in FxRequestBase *Request)

__inline BOOLEAN	IsType (__in FX_REQUEST_CONTEXT_TYPE Type)

virtual VOID	CopyParameters (__in FxRequestBase *Request)

VOID	FormatWriteParams (__in_opt IFxMemory *WriteMemory, __in_opt PWDFMEMORY_OFFSET WriteOffsets)

VOID	FormatReadParams (__in_opt IFxMemory *ReadMemory, __in_opt PWDFMEMORY_OFFSET ReadOffsets)

VOID	FormatOtherParams (__in FxInternalIoctlParams *InternalIoctlParams)

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
WDF_REQUEST_COMPLETION_PARAMS	m_CompletionParams

IFxMemory *	m_RequestMemory

FX_REQUEST_CONTEXT_TYPE	m_RequestType

Protected Member Functions
VOID __inline	InitCompletionParams (VOID)

Protected Member Functions inherited from FxStump
	FxStump (VOID)

Static Protected Member Functions
static VOID	_StoreAndReferenceMemoryWorker (__in PVOID Tag, __deref_out_opt IFxMemory *PPMemory, __in FxRequestBuffer Buffer)

Detailed Description

Definition at line 57 of file fxrequestcontext.hpp.

Constructor & Destructor Documentation

◆ FxRequestContext()

FxRequestContext::FxRequestContext ( __in FX_REQUEST_CONTEXT_TYPE Type )

Definition at line 34 of file fxrequestcontext.cpp.

      :
    m_RequestType(Type),
    m_RequestMemory(NULL)
 
/*++
 
Routine Description:
    Constructs an FxRequestContext and initialized the m_RequestType field
 
Arguments:
    Type - The type of this request.
 
 
 
 
 
Return Value:
    None.
 
  --*/
{
    InitCompletionParams();
}

◆ ~FxRequestContext()

FxRequestContext::~FxRequestContext ( VOID )

virtual

Definition at line 60 of file fxrequestcontext.cpp.

{
    ASSERT(m_RequestMemory == NULL);
}

Member Function Documentation

◆ _StoreAndReferenceMemoryWorker()

VOID FxRequestContext::_StoreAndReferenceMemoryWorker	(	__in PVOID	Tag,
		__deref_out_opt IFxMemory **	PPMemory,
		__in FxRequestBuffer *	Buffer
	)

staticprotected

Definition at line 120 of file fxrequestcontext.cpp.

{
    ASSERT(*PPMemory == NULL);
 
    switch (Buffer->DataType) {
    case FxRequestBufferMemory:
        Buffer->u.Memory.Memory->ADDREF(Tag);
        *PPMemory = Buffer->u.Memory.Memory;
        break;
 
    case FxRequestBufferReferencedMdl:
        Buffer->u.RefMdl.Memory->ADDREF(Tag);
        *PPMemory = Buffer->u.RefMdl.Memory;
        break;
 
    default:
        *PPMemory = NULL;
    }
}

Referenced by StoreAndReferenceMemory(), FxInternalIoctlOthersContext::StoreAndReferenceOtherMemories(), and FxIoContext::StoreAndReferenceOtherMemory().

◆ CopyParameters()

virtual VOID FxRequestContext::CopyParameters ( __in FxRequestBase * Request )

inlinevirtual

Reimplemented in FxIoContext, FxUsbDeviceControlContext, FxUsbDeviceStringContext, FxUsbPipeTransferContext, and FxUsbRequestContext.

Definition at line 98 of file fxrequestcontext.hpp.

    {
        UNREFERENCED_PARAMETER(Request);
    }

Referenced by FxRequestBase::CompleteSubmitted(), and FxUsbRequestContext::CopyParameters().

◆ Dispose()

virtual VOID FxRequestContext::Dispose ( VOID )

inlinevirtual

Reimplemented in FxUsbDeviceControlContext, FxUsbDeviceStringContext, FxUsbPipeTransferContext, and FxUsbPipeRequestContext.

Definition at line 70 of file fxrequestcontext.hpp.

73 {}

Referenced by FxRequestBase::Dispose().

◆ FormatOtherParams()

VOID FxRequestContext::FormatOtherParams ( __in FxInternalIoctlParams * InternalIoctlParams )

Definition at line 187 of file fxrequestcontext.cpp.

{
    m_CompletionParams.Type = WdfRequestTypeOther;
    m_CompletionParams.Parameters.Others.Argument1.Ptr = InternalIoctlParams->Argument1;
    m_CompletionParams.Parameters.Others.Argument2.Ptr = InternalIoctlParams->Argument2;
    m_CompletionParams.Parameters.Others.Argument4.Ptr = InternalIoctlParams->Argument4;
}

◆ FormatReadParams()

VOID FxRequestContext::FormatReadParams	(	__in_opt IFxMemory *	ReadMemory,
		__in_opt PWDFMEMORY_OFFSET	ReadOffsets
	)

Definition at line 166 of file fxrequestcontext.cpp.

{
    m_CompletionParams.Type = WdfRequestTypeRead;
 
    if (ReadMemory != NULL) {
        m_CompletionParams.Parameters.Read.Buffer = ReadMemory->GetHandle();
    }
 
    if (ReadOffsets != NULL) {
        m_CompletionParams.Parameters.Read.Offset =
            ReadOffsets->BufferOffset;
    }
    else {
        m_CompletionParams.Parameters.Read.Offset = 0;
    }
}

Referenced by FxIoTargetFormatIo().

◆ FormatWriteParams()

VOID FxRequestContext::FormatWriteParams	(	__in_opt IFxMemory *	WriteMemory,
		__in_opt PWDFMEMORY_OFFSET	WriteOffsets
	)

Definition at line 145 of file fxrequestcontext.cpp.

{
    m_CompletionParams.Type = WdfRequestTypeWrite;
 
    if (WriteMemory != NULL) {
        m_CompletionParams.Parameters.Write.Buffer = WriteMemory->GetHandle();
    }
 
    if (WriteOffsets != NULL) {
        m_CompletionParams.Parameters.Write.Offset =
            WriteOffsets->BufferOffset;
    }
    else {
        m_CompletionParams.Parameters.Write.Offset = 0;
    }
}

Referenced by FxIoTargetFormatIo().

◆ InitCompletionParams()

VOID __inline FxRequestContext::InitCompletionParams ( VOID )

inlineprotected

Definition at line 133 of file fxrequestcontext.hpp.

    {
        WDF_REQUEST_COMPLETION_PARAMS_INIT(&m_CompletionParams);
        m_CompletionParams.Type = WdfRequestTypeNoFormat;
    }

Referenced by FxRequestContext(), and ReleaseAndRestore().

◆ IsType()

__inline BOOLEAN FxRequestContext::IsType ( __in FX_REQUEST_CONTEXT_TYPE Type )

inline

Definition at line 89 of file fxrequestcontext.hpp.

    {
        return m_RequestType == Type;
    }

◆ ReleaseAndRestore()

VOID FxRequestContext::ReleaseAndRestore ( __in FxRequestBase * Request )

virtual

Reimplemented in FxIoContext, FxInternalIoctlOthersContext, FxUsbDeviceControlContext, FxUsbPipeTransferContext, and FxUsbUrbContext.

Definition at line 86 of file fxrequestcontext.cpp.

{
#if (FX_CORE_MODE == FX_CORE_KERNEL_MODE)
    Request->FreeMdls();
#else
    UNREFERENCED_PARAMETER(Request);
#endif
 
    if (m_RequestMemory != NULL) {
        m_RequestMemory->RELEASE(this);
        m_RequestMemory = NULL;
    }
 
    InitCompletionParams();
}

Referenced by FxRequest::CompleteInternal(), FxRequestBase::ContextReleaseAndRestore(), FxRequestBase::Dispose(), FxRequest::FreeRequest(), FxIoContext::ReleaseAndRestore(), FxInternalIoctlOthersContext::ReleaseAndRestore(), FxUsbDeviceControlContext::ReleaseAndRestore(), FxUsbPipeTransferContext::ReleaseAndRestore(), FxUsbUrbContext::ReleaseAndRestore(), FxRequest::Reuse(), and FxRequestBase::~FxRequestBase().

◆ StoreAndReferenceMemory()

VOID FxRequestContext::StoreAndReferenceMemory ( __in FxRequestBuffer * Buffer )

virtual

Reimplemented in FxInternalIoctlOthersContext, FxUsbPipeTransferContext, and FxUsbUrbContext.

Definition at line 78 of file fxrequestcontext.cpp.

{
    _StoreAndReferenceMemoryWorker(this, &m_RequestMemory, Buffer);
}

Referenced by FxIoTarget::FormatIoctlRequest(), FxIoTarget::FormatIoRequest(), FxUsbDevice::FormatStringRequest(), FxInternalIoctlOthersContext::StoreAndReferenceMemory(), FxUsbPipeTransferContext::StoreAndReferenceMemory(), FxUsbUrbContext::StoreAndReferenceMemory(), and FxUsbDeviceControlContext::StoreAndReferenceMemory().

Member Data Documentation

◆ m_CompletionParams

WDF_REQUEST_COMPLETION_PARAMS FxRequestContext::m_CompletionParams

Definition at line 142 of file fxrequestcontext.hpp.

Referenced by FxRequestBase::CompleteSubmitted(), FxRequest::CopyCompletionParams(), FxIoContext::CopyParameters(), FxUsbDeviceControlContext::CopyParameters(), FxUsbDeviceStringContext::CopyParameters(), FxUsbPipeTransferContext::CopyParameters(), FormatOtherParams(), FormatReadParams(), FormatWriteParams(), FxIoTargetFormatIoctl(), InitCompletionParams(), and FxUsbRequestContext::SetUsbType().

◆ m_RequestMemory

IFxMemory* FxRequestContext::m_RequestMemory

Definition at line 148 of file fxrequestcontext.hpp.

Referenced by FxUsbDeviceStringContext::CopyParameters(), FxUsbPipeContinuousReader::DeleteMemory(), FxUsbPipeContinuousReader::FormatRepeater(), ReleaseAndRestore(), StoreAndReferenceMemory(), and ~FxRequestContext().

◆ m_RequestType

FX_REQUEST_CONTEXT_TYPE FxRequestContext::m_RequestType

Definition at line 153 of file fxrequestcontext.hpp.

Referenced by FxRequestBase::HasContext(), FxRequestBase::HasContextType(), and IsType().

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

sdk/lib/drivers/wdf/shared/inc/private/common/fxrequestcontext.hpp
sdk/lib/drivers/wdf/shared/core/fxrequestcontext.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FxRequestContext()

◆ ~FxRequestContext()

Member Function Documentation

◆ _StoreAndReferenceMemoryWorker()

◆ CopyParameters()

◆ Dispose()

◆ FormatOtherParams()

◆ FormatReadParams()

◆ FormatWriteParams()

◆ InitCompletionParams()

◆ IsType()

◆ ReleaseAndRestore()

◆ StoreAndReferenceMemory()

Member Data Documentation

◆ m_CompletionParams

◆ m_RequestMemory

◆ m_RequestType