FxDmaScatterGatherTransaction Class Reference

#include <fxdmatransaction.hpp>

Inheritance diagram for FxDmaScatterGatherTransaction:

Collaboration diagram for FxDmaScatterGatherTransaction:

Public Member Functions
	FxDmaScatterGatherTransaction (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ExtraSize, __in FxDmaEnabler *DmaEnabler)
virtual BOOLEAN	Dispose (VOID)
virtual _Must_inspect_result_ NTSTATUS	InitializeResources (VOID)
virtual _Must_inspect_result_ NTSTATUS	StartTransfer (VOID)
virtual _Must_inspect_result_ NTSTATUS	TransferCompleted (VOID)
virtual _Must_inspect_result_ NTSTATUS	StageTransfer (VOID)
virtual VOID	ReleaseResources (__in BOOLEAN ForceRelease)
Public Member Functions inherited from FxDmaTransactionBase
	FxDmaTransactionBase (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in USHORT ExtraSize, __in FxDmaEnabler *DmaEnabler)
virtual BOOLEAN	Dispose (VOID)
_Must_inspect_result_ NTSTATUS	Initialize (__in PFN_WDF_PROGRAM_DMA ProgramDmaFunction, __in WDF_DMA_DIRECTION DmaDirection, __in PMDL Mdl, __in size_t Offset, __in ULONG Length)
virtual _Must_inspect_result_ NTSTATUS	InitializeResources (VOID)=0
_Must_inspect_result_ NTSTATUS	Execute (__in PVOID Context)
virtual _Must_inspect_result_ NTSTATUS	StartTransfer (VOID)=0
virtual _Must_inspect_result_ NTSTATUS	StageTransfer (VOID)=0
BOOLEAN	DmaCompleted (__in size_t TransferredLength, __out NTSTATUS *ReturnStatus, __in FxDmaCompletionType CompletionType)
virtual _Must_inspect_result_ NTSTATUS	TransferCompleted (VOID)=0
VOID	ReleaseForReuse (__in BOOLEAN ForceRelease)
virtual VOID	ReleaseResources (__in BOOLEAN ForceRelease)=0
VOID	GetTransferInfo (__out_opt ULONG *MapRegisterCount, __out_opt ULONG *ScatterGatherElementCount)
__forceinline size_t	GetBytesTransferred (VOID)
__forceinline FxDmaEnabler *	GetDmaEnabler (VOID)
__forceinline FxRequest *	GetRequest (VOID)
__forceinline BOOLEAN	IsRequestReferenced (VOID)
__forceinline VOID	SetRequest (__in FxRequest *Request)
__forceinline VOID	ReferenceRequest (VOID)
__forceinline VOID	ReleaseButRetainRequest (VOID)
__forceinline VOID	ClearRequest (VOID)
__forceinline size_t	GetMaximumFragmentLength (VOID)
__forceinline VOID	SetMaximumFragmentLength (size_t MaximumFragmentLength)
__forceinline size_t	GetCurrentFragmentLength (VOID)
__forceinline WDFDMATRANSACTION	GetHandle (VOID)
PVOID	GetTransferContext (VOID)
VOID	SetImmediateExecution (__in BOOLEAN Value)
BOOLEAN	CancelResourceAllocation (VOID)
FxDmaTransactionState	GetTransactionState (VOID)
Public Member Functions inherited from FxNonPagedObject
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)
	FxNonPagedObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)
virtual	~FxNonPagedObject (VOID)
	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_maxIRQL(DISPATCH_LEVEL) __drv_setsIRQL(DISPATCH_LEVEL) VOID Lock(__out __drv_deref(__drv_savesIRQL) PKIRQL PreviousIrql)
	_Releases_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID Unlock(__in __drv_restoresIRQL KIRQL PreviousIrql)
	_Acquires_lock_ (this->m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) VOID LockAtDispatch(VOID)
	_Requires_lock_held_ (this->m_NPLock.m_Lock) _Releases_lock_(this -> m_NPLock.m_Lock) __drv_requiresIRQL(DISPATCH_LEVEL) __inline VOID UnlockFromDispatch(VOID)
Public Member Functions inherited from FxObject
PVOID	GetCOMWrapper ()
void	SetCOMWrapper (__drv_aliasesMem PVOID Wrapper)
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)
virtual	~FxObject (VOID)
PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType Type)
PVOID __inline	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __in USHORT ExtraSize=0)
VOID	operator delete (__in PVOID Memory)
VOID	SetNoContextHeader (VOID)
PVOID __inline	GetObjectHandle (VOID)
__inline FxContextHeader *	GetContextHeader (VOID)
__inline PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)
WDFTYPE	GetType (VOID)
USHORT	GetObjectSize (VOID)
LONG	GetRefCnt (VOID)
FxTagTracker *	GetTagTracker (VOID)
CfxDevice *	GetDevice (VOID)
CfxDeviceBase *	GetDeviceBase (VOID)
VOID	SetDeviceBase (__in CfxDeviceBase *DeviceBase)
__inline VOID	CallCleanup (VOID)
ULONG __inline	AddRef (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)
virtual ULONG	Release (__in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)
virtual ULONG	AddRefOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)
virtual ULONG	ReleaseOverride (__in WDFOBJECT_OFFSET Offset, __in_opt PVOID Tag=NULL, __in LONG Line=0, __in_opt PSTR File=NULL)
virtual _Must_inspect_result_ NTSTATUS	QueryInterface (__in FxQueryInterfaceParams *Params)
VOID	MarkTraceState (VOID)
BOOLEAN __inline	IsTraceState (VOID)
VOID __inline	TraceDroppedEvent (__in FxObjectDroppedEvent Event)
VOID	MarkPassiveDispose (__in FxObjectLockState State=ObjectLock)
VOID	MarkPassiveCallbacks (__in FxObjectLockState State=ObjectLock)
VOID	MarkForceDisposeThread (__in FxObjectLockState State=ObjectLock)
BOOLEAN	IsPassiveCallbacks (__in BOOLEAN AcquireLock=TRUE)
BOOLEAN	IsPassiveDispose (__in BOOLEAN AcquireLock=TRUE)
BOOLEAN	IsForceDisposeThread (__in BOOLEAN AcquireLock=TRUE)
VOID	MarkCommitted (VOID)
BOOLEAN	IsCommitted (VOID)
VOID	MarkDisposeOverride (__in FxObjectLockState State=ObjectLock)
VOID	MarkNoDeleteDDI (__in FxObjectLockState State=ObjectLock)
BOOLEAN	IsNoDeleteDDI (VOID)
_Must_inspect_result_ NTSTATUS	Commit (__in_opt PWDF_OBJECT_ATTRIBUTES Attributes, __out_opt WDFOBJECT *ObjectHandle, __in_opt FxObject *Parent=NULL, __in BOOLEAN AssignDriverAsDefaultParent=TRUE)
VOID	DeleteFromFailedCreate (VOID)
VOID	ClearEvtCallbacks (VOID)
BOOLEAN	EarlyDispose (VOID)
virtual VOID	DeleteObject (VOID)
virtual BOOLEAN	Dispose (VOID)
_Must_inspect_result_ NTSTATUS	AssignParentObject (__in FxObject *ParentObject)
_Must_inspect_result_ NTSTATUS	AddContext (__in FxContextHeader *Header, __in PVOID *Context, __in PWDF_OBJECT_ATTRIBUTES Attributes)
_Must_inspect_result_ NTSTATUS	RemoveParentAssignment (VOID)
_Must_inspect_result_ FxObject *	GetParentObjectReferenced (__in PVOID Tag)
BOOLEAN	IsDisposed (VOID)

Static Public Member Functions
static _Must_inspect_result_ NTSTATUS	_Create (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PWDF_OBJECT_ATTRIBUTES Attributes, __in FxDmaEnabler *DmaEnabler, __out WDFDMATRANSACTION *Transaction)
Static Public Member Functions inherited from FxDmaTransactionBase
static VOID	_ComputeNextTransferAddress (__in PMDL CurrentMdl, __in size_t CurrentOffset, __in ULONG Transferred, __deref_out PMDL *NextMdl, __out size_t *NextOffset)
static _Must_inspect_result_ NTSTATUS	_CalculateRequiredMapRegisters (__in PMDL Mdl, __in size_t CurrentOffset, __in ULONG Length, __in ULONG AvailableMapRegisters, __out_opt PULONG PossibleTransferLength, __out PULONG MapRegistersRequired)
Static Public Member Functions inherited from FxObject
static FxObject *	_FromDisposeEntry (__in PSINGLE_LIST_ENTRY Entry)
static FxObject *	_GetObjectFromHandle (__in WDFOBJECT Handle, __inout PWDFOBJECT_OFFSET ObjectOffset)
static PVOID __inline	_ToHandle (__in FxObject *Object)
static VOID __inline	_ReferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)
static VOID __inline	_DereferenceActual (__in WDFOBJECT Object, __in_opt PVOID Tag, __in LONG Line, __in PSTR File)
static PVOID	_GetDebugBase (__in FxObject *Object)
static PFX_POOL_HEADER	_CleanupPointer (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Object)
static _Must_inspect_result_ NTSTATUS	_GetEffectiveLock (__in FxObject *Object, __in_opt IFxHasCallbacks *Callbacks, __in BOOLEAN AutomaticLocking, __in BOOLEAN PassiveCallbacks, __out FxCallbackLock **CallbackLock, __out_opt FxObject **CallbackLockObject)
static _Must_inspect_result_ NTSTATUS	_ObjectQuery (_In_ FxObject *Object, _In_ CONST GUID *Guid, _In_ ULONG QueryBufferLength, _Out_writes_bytes_(QueryBufferLength) PVOID QueryBuffer)

Protected Attributes
PSCATTER_GATHER_LIST	m_SGList
PVOID	m_LookasideBuffer
Protected Attributes inherited from FxDmaTransactionBase
FxDmaTransactionState	m_State
WDF_DMA_DIRECTION	m_DmaDirection
FxDmaEnabler *	m_DmaEnabler
FxDmaDescription *	m_AdapterInfo
FxRequest *	m_EncodedRequest
FxDmaTransactionProgramOrReserveDma	m_DmaAcquiredFunction
PVOID	m_DmaAcquiredContext
PVOID	m_TransferContext
PMDL	m_StartMdl
PMDL	m_CurrentFragmentMdl
size_t	m_StartOffset
size_t	m_CurrentFragmentOffset
size_t	m_MaxFragmentLength
size_t	m_TransactionLength
size_t	m_Remaining
size_t	m_Transferred
size_t	m_CurrentFragmentLength
ULONG	m_Flags
Protected Attributes inherited from FxObject
union {
CfxDeviceBase *   m_DeviceBase
CfxDevice *   m_Device
};

Private Member Functions
_Must_inspect_result_ NTSTATUS	GetScatterGatherList (__in PMDL Mdl, __in size_t CurrentOffset, __in ULONG Length, __in PDRIVER_LIST_CONTROL ExecutionRoutine, __in PVOID Context)
VOID	PutScatterGatherList (__in PSCATTER_GATHER_LIST ScatterGather)
_Must_inspect_result_ NTSTATUS	BuildScatterGatherList (__in PMDL Mdl, __in size_t CurrentOffset, __in ULONG Length, __in PDRIVER_LIST_CONTROL ExecutionRoutine, __in PVOID Context, __in PVOID ScatterGatherBuffer, __in ULONG ScatterGatherBufferLength)

Static Private Member Functions
static VOID	_AdapterListControl (__in DEVICE_OBJECT *DeviceObject, __in IRP *Irp, __in SCATTER_GATHER_LIST *SgList, __in VOID *Context)

Additional Inherited Members
Protected Member Functions inherited from FxDmaTransactionBase
virtual VOID	Reuse (VOID)
Protected Member Functions inherited from FxObject
	FxObject (__in WDFTYPE Type, __in USHORT Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObjectType ObjectType)
FxObjectDebugExtension *	GetDebugExtension (VOID)
BOOLEAN	IsDebug (VOID)
VOID	AllocateTagTracker (__in WDFTYPE Type)
virtual VOID	SelfDestruct (VOID)
PVOID __inline	GetObjectHandleUnchecked (VOID)
VOID __inline	DestroyChildren (VOID)
VOID	DeleteEarlyDisposedObject (VOID)
Static Protected Member Functions inherited from FxDmaTransactionBase
static PVOID	GetStartVaFromOffset (__in PMDL Mdl, __in size_t Offset)
Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Detailed Description

Definition at line 500 of file fxdmatransaction.hpp.

Constructor & Destructor Documentation

FxDmaScatterGatherTransaction()

FxDmaScatterGatherTransaction::FxDmaScatterGatherTransaction	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in USHORT	ExtraSize,
		__in FxDmaEnabler *	DmaEnabler
	)

Definition at line 754 of file fxdmatransaction.cpp.

      :
    FxDmaTransactionBase(FxDriverGlobals,
                         sizeof(FxDmaScatterGatherTransaction),
                         ExtraSize,
                         DmaEnabler)
{
    m_LookasideBuffer       = NULL;
    m_SGList                = NULL;
}

Member Function Documentation

_AdapterListControl()

VOID FxDmaScatterGatherTransaction::_AdapterListControl ( __in DEVICE_OBJECT *  DeviceObject, __in IRP *  Irp, __in SCATTER_GATHER_LIST *  SgList, __in VOID *  Context  )

staticprivate

Definition at line 1092 of file fxdmatransaction.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    WDFDMATRANSACTION dmaTransaction;
    FxDmaScatterGatherTransaction * pDmaTransaction;
 
    UNREFERENCED_PARAMETER(Irp);
    UNREFERENCED_PARAMETER(DeviceObject);
 
    pDmaTransaction = (FxDmaScatterGatherTransaction*) Context;
    pFxDriverGlobals = pDmaTransaction->GetDriverGlobals();
    dmaTransaction = pDmaTransaction->GetHandle();
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Enter WDFDMATRANSACTION %p",
                        dmaTransaction);
    }
 
    ASSERT(pDmaTransaction != NULL);
    ASSERT(pDmaTransaction->m_DmaAcquiredFunction.Method.ProgramDma != NULL);
 
    ASSERT(SgList->NumberOfElements <= pDmaTransaction->m_DmaEnabler->GetMaxSGElements());
 
    pDmaTransaction->m_SGList = SgList;
 
    //
    // We ignore the return value. The pattern we want the driver to follow is
    // that if it fails to program DMA transfer, it should call DmaCompletedFinal
    // to abort the transfer.
    //
    (VOID) pDmaTransaction->m_DmaAcquiredFunction.InvokeProgramDma(
                dmaTransaction,
                pDmaTransaction->m_DmaEnabler->m_DeviceBase->GetHandle(),
                pDmaTransaction->m_DmaAcquiredContext,
                pDmaTransaction->m_DmaDirection,
                SgList);
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Exit WDFDMATRANSACTION %p",
                        dmaTransaction);
    }
}

Referenced by StageTransfer().

_Create()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::_Create ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals, __in PWDF_OBJECT_ATTRIBUTES  Attributes, __in FxDmaEnabler *  DmaEnabler, __out WDFDMATRANSACTION *  Transaction  )

static

Definition at line 770 of file fxdmatransaction.cpp.

{
    FxDmaScatterGatherTransaction* pTransaction;
    WDFOBJECT hTransaction;
    NTSTATUS status;
 
    pTransaction = new (FxDriverGlobals, Attributes, DmaEnabler->GetTransferContextSize())
                FxDmaScatterGatherTransaction(FxDriverGlobals,
                                              DmaEnabler->GetTransferContextSize(),
                                              DmaEnabler);
 
    if (pTransaction == NULL) {
        status =  STATUS_INSUFFICIENT_RESOURCES;
        DoTraceLevelMessage(
            FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
            "Could not allocate memory for WDFTRANSACTION, %!STATUS!", status);
        return status;
    }
 
    //
    // Commit and apply the attributes
    //
    status = pTransaction->Commit(Attributes, &hTransaction, DmaEnabler);
 
    if (NT_SUCCESS(status) && DmaEnabler->m_IsSGListAllocated) {
 
        //
        // Allocate buffer for SGList from lookaside list.
        //
        pTransaction->m_LookasideBuffer = (SCATTER_GATHER_LIST *)
            FxAllocateFromNPagedLookasideList(
                &DmaEnabler->m_SGList.ScatterGatherProfile.Lookaside
                );
 
        if (pTransaction->m_LookasideBuffer == NULL) {
            status = STATUS_INSUFFICIENT_RESOURCES;
            DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                                "Unable to allocate memory for SG List, "
                                "WDFDMATRANSACTION %p, %!STATUS! ",
                                pTransaction->GetHandle(), status);
        }
        else {
            //
            // Take a reference on the enabler to ensure that it remains valid
            // if the transaction's disposal is deferred.
            //
            DmaEnabler->ADDREF(pTransaction);
        }
    }
 
    if (NT_SUCCESS(status)) {
        *Transaction = (WDFDMATRANSACTION)hTransaction;
    }
    else {
        //
        // This will properly clean up the target's state and free it
        //
        pTransaction->DeleteFromFailedCreate();
    }
 
    return status;
}

Referenced by switch().

BuildScatterGatherList()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::BuildScatterGatherList ( __in PMDL  Mdl, __in size_t  CurrentOffset, __in ULONG  Length, __in PDRIVER_LIST_CONTROL  ExecutionRoutine, __in PVOID  Context, __in PVOID  ScatterGatherBuffer, __in ULONG  ScatterGatherBufferLength  )

inlineprivate

Definition at line 659 of file fxdmatransaction.hpp.

    {
        NTSTATUS status;
        KIRQL irql;
 
        KeRaiseIrql(DISPATCH_LEVEL, &irql);
 
        if (m_DmaEnabler->UsesDmaV3()) {
 
            PDMA_OPERATIONS dmaOperations =
                m_AdapterInfo->AdapterObject->DmaOperations;
            ULONG flags = 0;
 
            if (GetDriverGlobals()->IsVersionGreaterThanOrEqualTo(1,15)) {
                //
                // Though the correct behavior is to pass the m_Flags to the
                // BuildScatterGatherListEx function, the code was not doing it
                // for versions <= 1.13. To reduce any chance of regression,
                // the m_Flags is honored for drivers that are 1.15
                // or newer.
                //
                flags = m_Flags;
            }
 
            status = dmaOperations->BuildScatterGatherListEx(
                                                 m_AdapterInfo->AdapterObject,
                                                 m_DmaEnabler->m_FDO,
                                                 GetTransferContext(),
                                                 Mdl,
                                                 CurrentOffset,
                                                 Length,
                                                 flags,
                                                 ExecutionRoutine,
                                                 Context,
                                                 (BOOLEAN) m_DmaDirection,
                                                 ScatterGatherBuffer,
                                                 ScatterGatherBufferLength,
                                                 NULL,
                                                 NULL,
                                                 NULL
                                                 );
        }
        else {
 
            status = m_AdapterInfo->AdapterObject->DmaOperations->
                        BuildScatterGatherList(m_AdapterInfo->AdapterObject,
                                               m_DmaEnabler->m_FDO,
                                               Mdl,
                                               GetStartVaFromOffset(Mdl, CurrentOffset),
                                               Length,
                                               ExecutionRoutine,
                                               Context,
                                               (BOOLEAN) m_DmaDirection,
                                               ScatterGatherBuffer,
                                               ScatterGatherBufferLength);
        }
 
 
        KeLowerIrql(irql);
 
        return status;
    }

Referenced by BuildScatterGatherList(), and StageTransfer().

Dispose()

BOOLEAN FxDmaScatterGatherTransaction::Dispose ( VOID  )

virtual

Reimplemented from FxDmaTransactionBase.

Definition at line 839 of file fxdmatransaction.cpp.

{
    BOOLEAN ret;
 
    ret = FxDmaTransactionBase::Dispose(); // __super call
 
    //
    // Free Lookaside Buffer which held SGList
    //
    if (m_LookasideBuffer != NULL) {
 
        FxFreeToNPagedLookasideList(
            &m_DmaEnabler->m_SGList.ScatterGatherProfile.Lookaside,
            m_LookasideBuffer
            );
        m_LookasideBuffer = NULL;
        m_DmaEnabler->RELEASE(this);
    }
 
    return ret;
}

GetScatterGatherList()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::GetScatterGatherList ( __in PMDL  Mdl, __in size_t  CurrentOffset, __in ULONG  Length, __in PDRIVER_LIST_CONTROL  ExecutionRoutine, __in PVOID  Context  )

inlineprivate

Definition at line 587 of file fxdmatransaction.hpp.

    {
        NTSTATUS status;
        KIRQL irql;
 
        KeRaiseIrql(DISPATCH_LEVEL, &irql);
 
        if (m_DmaEnabler->UsesDmaV3())
        {
            PDMA_OPERATIONS dmaOperations =
                m_AdapterInfo->AdapterObject->DmaOperations;
 
            status = dmaOperations->GetScatterGatherListEx(
                                               m_AdapterInfo->AdapterObject,
                                               m_DmaEnabler->m_FDO,
                                               GetTransferContext(),
                                               Mdl,
                                               CurrentOffset,
                                               Length,
                                               m_Flags,
                                               ExecutionRoutine,
                                               Context,
                                               (BOOLEAN) m_DmaDirection,
                                               NULL,
                                               NULL,
                                               NULL
                                               );
        }
        else
        {
            status = m_AdapterInfo->AdapterObject->DmaOperations->
                        GetScatterGatherList(m_AdapterInfo->AdapterObject,
                                             m_DmaEnabler->m_FDO,
                                             Mdl,
                                             GetStartVaFromOffset(Mdl, CurrentOffset),
                                             Length,
                                             ExecutionRoutine,
                                             Context,
                                             (BOOLEAN) m_DmaDirection);
        }
 
        KeLowerIrql(irql);
 
        return status;
    }

Referenced by GetScatterGatherList(), and StageTransfer().

InitializeResources()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::InitializeResources ( VOID  )

virtual

Implements FxDmaTransactionBase.

Definition at line 865 of file fxdmatransaction.cpp.

{
    NTSTATUS status;
    PMDL  nextMdl;
    size_t nextOffset;
    ULONG mapRegistersRequired;
    size_t remLength, transferLength, transferred, possibleLength=0;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    status = STATUS_SUCCESS;
 
    //
    // If the caller has specified a limit on the number of scatter-gather
    // elements each transfer can support then make sure it's within the
    // limit by breaking up the whole transfer into m_MaxFragmentLength and
    // computing the number of map-registers required for each fragment.
    // This check may not be valid if the driver starts to do partial
    // transfers. So driver that do partial transfer with sg-element limit
    // should be capable of handling STATUS_WDF_TOO_FRAGMENTED failures during
    // dma execution.
    //
    remLength = m_TransactionLength;
    transferred = 0;
    nextMdl = m_StartMdl;
    nextOffset = m_StartOffset;
    transferLength = 0;
 
    while (remLength != 0) {
 
        _ComputeNextTransferAddress(nextMdl,
                                    nextOffset,
                                    (ULONG) transferLength,
                                    &nextMdl,
                                    &nextOffset);
 
        transferLength = FxSizeTMin(remLength, m_MaxFragmentLength);
 
        status = _CalculateRequiredMapRegisters(nextMdl,
                                     nextOffset,
                                     (ULONG) transferLength,
                                     m_AdapterInfo->NumberOfMapRegisters,
                                     (PULONG) &possibleLength,
                                     &mapRegistersRequired
                                     );
 
        if (!NT_SUCCESS(status)) {
            DoTraceLevelMessage(
                pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                "CalculateScatterGatherList failed for "
                "WDFDMATRANSACTION %p, %!STATUS!", GetHandle(), status);
            FxVerifierDbgBreakPoint(pFxDriverGlobals);
            return status;
        }
 
        if (mapRegistersRequired > m_DmaEnabler->m_MaxSGElements) {
            status = STATUS_WDF_TOO_FRAGMENTED;
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                        "WDFDMATRANSACTION %p for MDL %p is more fragmented (%d) "
                        "than the limit (%I64d) specified by the driver, %!STATUS! ",
                        GetHandle(), nextMdl, mapRegistersRequired,
                        m_DmaEnabler->m_MaxSGElements, status);
            return status;
        }
 
        transferred += transferLength;
        remLength -= transferLength;
    }
 
    return status;
}

PutScatterGatherList()

VOID FxDmaScatterGatherTransaction::PutScatterGatherList ( __in PSCATTER_GATHER_LIST  ScatterGather )

inlineprivate

Definition at line 640 of file fxdmatransaction.hpp.

    {
        KIRQL irql;
 
        KeRaiseIrql(DISPATCH_LEVEL, &irql);
 
        m_AdapterInfo->AdapterObject->DmaOperations->
                PutScatterGatherList(m_AdapterInfo->AdapterObject,
                                     ScatterGather,
                                     (BOOLEAN) m_DmaDirection);
        KeLowerIrql(irql);
 
        return;
    }

Referenced by PutScatterGatherList(), ReleaseResources(), and TransferCompleted().

ReleaseResources()

VOID FxDmaScatterGatherTransaction::ReleaseResources ( __in BOOLEAN  ForceRelease )

virtual

Implements FxDmaTransactionBase.

Definition at line 939 of file fxdmatransaction.cpp.

{
    if (m_SGList != NULL) {
        PutScatterGatherList(m_SGList);
        m_SGList = NULL;
    }
    m_AdapterInfo = NULL;
}

StageTransfer()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::StageTransfer ( VOID  )

virtual

Implements FxDmaTransactionBase.

Definition at line 966 of file fxdmatransaction.cpp.

{
    NTSTATUS           status;
    ULONG   mapRegistersRequired;
    WDFDMATRANSACTION dmaTransaction;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    //
    // Use an invalid value to make the function fail if the var is not
    // updated correctly below.
    //
    mapRegistersRequired = 0xFFFFFFFF;
 
    //
    // Client driver could complete and delete the object in
    // EvtProgramDmaFunction. So, save the handle because we need it
    // for tracing after we invoke the callback.
    //
    dmaTransaction = GetHandle();
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Enter WDFDMATRANSACTION %p ", GetHandle());
    }
 
    //
    // Given the first MDL and the bytes transfered, find the next MDL
    // and byteoffset within that MDL.
    //
    _ComputeNextTransferAddress(m_CurrentFragmentMdl,
                                m_CurrentFragmentOffset,
                                (ULONG) m_CurrentFragmentLength,
                                &m_CurrentFragmentMdl,
                                &m_CurrentFragmentOffset);
 
    //
    // Get the next possible transfer size.
    //
    m_CurrentFragmentLength = FxSizeTMin(m_Remaining, m_MaxFragmentLength);
 
    //
    // Fix m_CurrentFragmentLength to meet the map registers limit. This is done
    // in case the MDL is a chained MDL for an highly fragmented buffer.
    //
    status = _CalculateRequiredMapRegisters(m_CurrentFragmentMdl,
                                   m_CurrentFragmentOffset,
                                   (ULONG) m_CurrentFragmentLength,
                                   m_AdapterInfo->NumberOfMapRegisters,
                                   (PULONG)&m_CurrentFragmentLength,
                                   &mapRegistersRequired);
    //
    // We have already validated the entire transfer during initialize
    // to see each transfer meets the sglimit. So this call shouldn't fail.
    // But, if the driver does partial transfer and changes the fragment
    // boundaries then it's possible for the sg-elements to vary. So, check
    // one more time to see if we are within the bounds before building
    // the sglist and calling into the driver.
    //
    ASSERT(NT_SUCCESS(status));
 
    if (mapRegistersRequired > m_DmaEnabler->m_MaxSGElements) {
        status = STATUS_WDF_TOO_FRAGMENTED;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p for MDL %p is more fragmented (%d) "
                    "than the limit (%I64d) specified by the driver, %!STATUS! ",
                    dmaTransaction, m_CurrentFragmentMdl, mapRegistersRequired,
                    m_DmaEnabler->m_MaxSGElements, status);
        return status;
    }
 
 
    m_Remaining -= m_CurrentFragmentLength;
 
    if (m_DmaEnabler->m_IsSGListAllocated) {
 
        ASSERT(m_LookasideBuffer != NULL);
        status = BuildScatterGatherList(m_CurrentFragmentMdl,
                                        m_CurrentFragmentOffset,
                                        (ULONG) m_CurrentFragmentLength,
#pragma prefast(suppress: __WARNING_CLASS_MISMATCH_NONE, "This warning requires a wrapper class for the DRIVER_LIST_CONTROL type.")
                                        _AdapterListControl,
                                        this,
                                        m_LookasideBuffer,
                                        (ULONG) m_AdapterInfo->PreallocatedSGListSize);
 
    } else {
 
        status = GetScatterGatherList(m_CurrentFragmentMdl,
                                      m_CurrentFragmentOffset,
                                      (ULONG) m_CurrentFragmentLength,
#pragma prefast(suppress: __WARNING_CLASS_MISMATCH_NONE, "This warning requires a wrapper class for the DRIVER_LIST_CONTROL type.")
                                      _AdapterListControl,
                                      this);
    }
 
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "Build or GetScatterGatherList failed for "
                            "WDFDMATRANSACTION %p, %!STATUS!",
                            dmaTransaction, status);
        //
        // Readjust remaining bytes transfered.
        //
        m_Remaining += m_CurrentFragmentLength;
        return status;
    }
 
    //
    // Before GetScatterGatherList returns, _AdapterListControl can get called
    // on another thread and the driver could delete the transaction object.
    // So don't touch the object after this point.
    //
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Exit WDFDMATRANSACTION %p, "
                        "%!STATUS!", dmaTransaction, status);
    }
 
    return status;
}

Referenced by StartTransfer().

StartTransfer()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::StartTransfer ( VOID  )

virtual

Implements FxDmaTransactionBase.

Definition at line 952 of file fxdmatransaction.cpp.

{
    ASSERT(m_CurrentFragmentMdl == m_StartMdl);
    ASSERT(m_CurrentFragmentOffset == m_StartOffset);
    ASSERT(m_CurrentFragmentLength == 0);
    ASSERT(m_Transferred == 0);
 
    return StageTransfer();
}

TransferCompleted()

_Must_inspect_result_ NTSTATUS FxDmaScatterGatherTransaction::TransferCompleted ( VOID  )

virtual

Implements FxDmaTransactionBase.

Definition at line 1144 of file fxdmatransaction.cpp.

{
    //
    // All we have to do is release the scatter-gather list.
    //
    if (m_SGList != NULL) {
 
        PutScatterGatherList(m_SGList);
        m_SGList = NULL;
    }
 
    return STATUS_SUCCESS;
}

Member Data Documentation

m_LookasideBuffer

PVOID FxDmaScatterGatherTransaction::m_LookasideBuffer

protected

Definition at line 571 of file fxdmatransaction.hpp.

Referenced by _Create(), Dispose(), FxDmaScatterGatherTransaction(), and StageTransfer().

m_SGList

PSCATTER_GATHER_LIST FxDmaScatterGatherTransaction::m_SGList

protected

Definition at line 565 of file fxdmatransaction.hpp.

Referenced by _AdapterListControl(), FxDmaScatterGatherTransaction(), ReleaseResources(), and TransferCompleted().

---

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

• sdk/lib/drivers/wdf/kmdf/inc/private/fxdmatransaction.hpp
• sdk/lib/drivers/wdf/kmdf/src/dma/base/fxdmatransaction.cpp