#include <fxdmatransaction.hpp>

Inheritance diagram for FxDmaTransactionBase:

[legend]

Collaboration diagram for FxDmaTransactionBase:

[legend]

Public Member Functions
	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 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 Member Functions
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
static PVOID	GetStartVaFromOffset (__in PMDL Mdl, __in size_t Offset)

Static Protected Member Functions inherited from FxObject
static PVOID	_GetBase (__in FxObject *Object)

Protected Attributes
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

};

Friends
class	FxDmaEnabler

Detailed Description

Definition at line 86 of file fxdmatransaction.hpp.

Constructor & Destructor Documentation

◆ FxDmaTransactionBase()

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

Definition at line 30 of file fxdmatransaction.cpp.

      :
    FxNonPagedObject(
        FX_TYPE_DMA_TRANSACTION,
        ExtraSize == 0 ? ObjectSize : COMPUTE_OBJECT_SIZE(ObjectSize, ExtraSize),
        FxDriverGlobals)
{
    m_DmaEnabler            = DmaEnabler;
    m_EncodedRequest        = NULL;
    m_MaxFragmentLength     = 0;
    m_DmaDirection          = WdfDmaDirectionReadFromDevice;
    m_DmaAcquiredContext    = NULL;
    m_CurrentFragmentMdl    = NULL;
    m_CurrentFragmentOffset = 0;
    m_StartOffset           = NULL;
    m_StartMdl              = NULL;
    m_Remaining             = 0;
    m_CurrentFragmentLength = 0;
    m_TransactionLength     = 0;
    m_Transferred           = 0;
    m_Flags                 = 0;
 
    m_DmaAcquiredFunction.Method.ProgramDma = NULL;
 
    m_State = FxDmaTransactionStateCreated;
 
    if (ExtraSize == 0) {
        m_TransferContext = NULL;
    } else {
        m_TransferContext = WDF_PTR_ADD_OFFSET_TYPE(
                                this,
                                COMPUTE_RAW_OBJECT_SIZE(ObjectSize),
                                PVOID
                                );
    }
 
    MarkDisposeOverride(ObjectDoNotLock);
}

Member Function Documentation

◆ _CalculateRequiredMapRegisters()

_Must_inspect_result_ NTSTATUS FxDmaTransactionBase::_CalculateRequiredMapRegisters	(	__in PMDL	Mdl,
		__in size_t	CurrentOffset,
		__in ULONG	Length,
		__in ULONG	AvailableMapRegisters,
		__out_opt PULONG	PossibleTransferLength,
		__out PULONG	MapRegistersRequired
	)

static

Definition at line 633 of file fxdmatransaction.cpp.

{
    PMDL tempMdl;
    ULONG requiredMapRegisters;
    ULONG transferLength;
    ULONG mdlLength;
    ULONG pageOffset;
    ULONG possTransferLength;
 
    //
    // Calculate the number of required map registers.
    //
    tempMdl = Mdl;
    transferLength = (ULONG) MmGetMdlByteCount(tempMdl) - (ULONG) CurrentOffset;
    mdlLength = transferLength;
 
    pageOffset = BYTE_OFFSET(GetStartVaFromOffset(tempMdl, CurrentOffset));
    requiredMapRegisters = 0;
    possTransferLength = 0;
 
    //
    // The virtual address should fit in the first MDL.
    //
 
    ASSERT(CurrentOffset <= tempMdl->ByteCount);
 
    //
    // Loop through chained MDLs, accumulating the required
    // number of map registers.
    //
 
    while (transferLength < Length && tempMdl->Next != NULL) {
 
        //
        // With pageOffset and length, calculate number of pages spanned by
        // the buffer.
        //
        requiredMapRegisters += (pageOffset + mdlLength + PAGE_SIZE - 1) >>
                                    PAGE_SHIFT;
 
        if (requiredMapRegisters <= AvailableMapRegisters) {
            possTransferLength = transferLength;
        }
 
        tempMdl = tempMdl->Next;
        pageOffset = tempMdl->ByteOffset;
        mdlLength = tempMdl->ByteCount;
        transferLength += mdlLength;
    }
 
    if ((transferLength + PAGE_SIZE) < (Length + pageOffset )) {
        ASSERT(transferLength >= Length);
        return STATUS_BUFFER_TOO_SMALL;
    }
 
    //
    // Calculate the last number of map registers based on the requested
    // length not the length of the last MDL.
    //
 
    ASSERT( transferLength <= mdlLength + Length );
 
    requiredMapRegisters += (pageOffset + Length + mdlLength - transferLength +
                             PAGE_SIZE - 1) >> PAGE_SHIFT;
 
    if (requiredMapRegisters <= AvailableMapRegisters) {
        possTransferLength += (Length + mdlLength - transferLength);
    }
 
    if (PossibleTransferLength != NULL) {
        *PossibleTransferLength = possTransferLength;
    }
 
    ASSERT(*PossibleTransferLength);
 
    *MapRegistersRequired = requiredMapRegisters;
 
    return STATUS_SUCCESS;
}

Referenced by FxDmaScatterGatherTransaction::InitializeResources(), FxDmaPacketTransaction::ReserveAdapter(), and FxDmaScatterGatherTransaction::StageTransfer().

◆ _ComputeNextTransferAddress()

VOID FxDmaTransactionBase::_ComputeNextTransferAddress	(	__in PMDL	CurrentMdl,
		__in size_t	CurrentOffset,
		__in ULONG	Transferred,
		__deref_out PMDL *	NextMdl,
		__out size_t *	NextOffset
	)

static

Definition at line 562 of file fxdmatransaction.cpp.

{
    size_t transfered, mdlSize;
    PMDL mdl;
 
    mdlSize = MmGetMdlByteCount(CurrentMdl) - CurrentOffset;
 
    if (Transferred < mdlSize) {
        //
        // We are still in the first MDL
        //
        *NextMdl = CurrentMdl;
        *NextOffset = CurrentOffset + Transferred;
        return;
    }
 
    //
    // We have transfered the content of the first MDL.
    // Move to the next one.
    //
    transfered = Transferred - mdlSize;
    mdl = CurrentMdl->Next;
    ASSERT(mdl != NULL);
 
    while (transfered >= MmGetMdlByteCount(mdl)) {
        //
        // We have transfered the content of this MDL.
        // Move to the next one.
        //
        transfered -= MmGetMdlByteCount(mdl);
        mdl = mdl->Next;
        ASSERT(mdl != NULL);
    }
 
    //
    // This is the mdl where the last transfer occured.
    //
    *NextMdl = mdl;
    *NextOffset = transfered;
 
    return;
}

Referenced by FxDmaScatterGatherTransaction::InitializeResources(), and FxDmaScatterGatherTransaction::StageTransfer().

◆ CancelResourceAllocation()

BOOLEAN FxDmaTransactionBase::CancelResourceAllocation ( VOID )

Definition at line 514 of file fxdmatransaction.cpp.

{
    if ((m_State == FxDmaTransactionStateCreated) ||
        (m_State == FxDmaTransactionStateReleased) ||
        (m_State == FxDmaTransactionStateDeleted)) {
 
        DoTraceLevelMessage(
            GetDriverGlobals(),
            TRACE_LEVEL_ERROR,
            TRACINGDMA,
            "WDFDMATRANSACTION %p cannot be cancelled in state "
            "%!FxDmaTransactionState!",
            GetHandle(),
            m_State
            );
 
        FxVerifierBugCheck(GetDriverGlobals(),
                           WDF_DMA_FATAL_ERROR,
                           (ULONG_PTR) GetObjectHandle(),
                           (ULONG_PTR) m_State);
        // unreachable code
    }
 
    PDMA_OPERATIONS dmaOperations =
        m_AdapterInfo->AdapterObject->DmaOperations;
 
    BOOLEAN result;
 
    result = dmaOperations->CancelAdapterChannel(
                            m_AdapterInfo->AdapterObject,
                            m_DmaEnabler->m_FDO,
                            GetTransferContext()
                            );
 
    if (result) {
        m_State = FxDmaTransactionStateTransferFailed;
 
        if (m_EncodedRequest != NULL) {
            ReleaseButRetainRequest();
        }
    }
 
    return result;
}

◆ ClearRequest()

__forceinline VOID FxDmaTransactionBase::ClearRequest ( VOID )

inline

Definition at line 308 of file fxdmatransaction.hpp.

    {
        if (IsRequestReferenced()) {
            ReleaseButRetainRequest();
        }
        m_EncodedRequest = NULL;
    }

Referenced by Dispose(), and ReleaseForReuse().

◆ Dispose()

BOOLEAN FxDmaTransactionBase::Dispose ( VOID )

virtual

Reimplemented from FxObject.

Reimplemented in FxDmaScatterGatherTransaction.

Definition at line 74 of file fxdmatransaction.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    //
    // Must not be in transfer state.
    //
    if (m_State == FxDmaTransactionStateTransfer) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                    "is invalid", GetHandle(), m_State);
 
        if (pFxDriverGlobals->IsVerificationEnabled(1, 9, OkForDownLevel)) {
            FxVerifierBugCheck(pFxDriverGlobals,               // globals
                               WDF_DMA_FATAL_ERROR,            // type
                               (ULONG_PTR) GetObjectHandle(),  // parm 2
                               (ULONG_PTR) m_State);           // parm 3
        }
    }
 
    m_State = FxDmaTransactionStateDeleted;
 
    //
    // Release resources for this Dma Transaction.
    //
    ReleaseResources(TRUE);
 
    if (m_EncodedRequest != NULL) {
        ClearRequest();
    }
 
    return TRUE;
}

Referenced by FxDmaScatterGatherTransaction::Dispose().

◆ DmaCompleted()

BOOLEAN FxDmaTransactionBase::DmaCompleted	(	__in size_t	TransferredLength,
		__out NTSTATUS *	ReturnStatus,
		__in FxDmaCompletionType	CompletionType
	)

Definition at line 252 of file fxdmatransaction.cpp.

{
    BOOLEAN         hasTransitioned;
    NTSTATUS        status;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
    WDFDMATRANSACTION dmaTransaction;
 
    //
    // In the case of partial completion, we will start a new transfer
    // from with in this function by calling StageTransfer. After that
    // call, we lose ownership of the object.  Since we need the handle
    // for tracing purposes, we will save the value in a local variable and
    // use that.
    //
    dmaTransaction = GetHandle();
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Enter WDFDMATRANSACTION %p, length %d",
                        dmaTransaction, (ULONG)TransferredLength);
    }
 
    //
    // Must be in Transfer state.
    //
    if (m_State != FxDmaTransactionStateTransfer) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                    "is invalid", dmaTransaction, m_State);
 
        FxVerifierBugCheck(pFxDriverGlobals,                // globals
                            WDF_DMA_FATAL_ERROR, // specific type
                            (ULONG_PTR) dmaTransaction,  // parm 2
                            (ULONG_PTR) m_State);           // parm 3
    }
 
    if (TransferredLength > m_CurrentFragmentLength) {
        status = STATUS_INVALID_PARAMETER;
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p Transfered Length %I64d can't be more "
                    "than the length asked to transfer %I64d "
                    "%!STATUS!", dmaTransaction, TransferredLength,
                    m_CurrentFragmentLength, status);
        FxVerifierDbgBreakPoint(pFxDriverGlobals);
        goto End;
    }
 
 
    if (CompletionType == FxDmaCompletionTypePartial ||
        CompletionType == FxDmaCompletionTypeAbort) {
        //
        // Tally this DMA tranferred byte count into the accumulator.
        //
        m_Transferred += TransferredLength;
 
        //
        // Adjust the remaining length to account for the partial transfer.
        //
        m_Remaining += (m_CurrentFragmentLength - TransferredLength);
 
        //
        // Update CurrentDmaLength to reflect actual transfer because
        // we need to FlushAdapterBuffers based on this value in
        // TransferCompleted for packet based transfer.
        //
        m_CurrentFragmentLength = TransferredLength;
 
    } else {
        //
        // Tally this DMA tranferred byte count into the accumulator.
        //
        m_Transferred += m_CurrentFragmentLength;
    }
 
    ASSERT(m_Transferred <= m_TransactionLength);
 
    //
    // Inform the derived object that transfer is completed so it
    // can release resources specific to last transfer.
    //
    status = TransferCompleted();
    if (!NT_SUCCESS(status)) {
        goto End;
    }
 
    //
    // If remaining DmaTransaction length is zero or if the driver wants
    // this to be the last transfer then free the map registers and
    // change the state to completed.
    //
    if (m_Remaining == 0 || CompletionType == FxDmaCompletionTypeAbort) {
        status = STATUS_SUCCESS;
        goto End;
    }
 
    //
    // Stage the next packet for this DmaTransaction...
    //
    status = StageTransfer();
 
    if (NT_SUCCESS(status)) {
        //
        // StageTransfer results in a call to the EvtProgramDma routine
        // where driver could complete and delete the object.  So
        // don't touch the object beyond this point.
        //
        status = STATUS_MORE_PROCESSING_REQUIRED;
    }
    else {
        //
        // The error will be returned to the caller of
        // WdfDmaTransactionDmaComplete*()
        //
    }
 
End:
 
    if (status != STATUS_MORE_PROCESSING_REQUIRED) {
        //
        // Failed or succeeded. Either way free
        // map registers and release the device.
        //
        if (NT_SUCCESS(status)) {
            m_State = FxDmaTransactionStateTransferCompleted;
        } else {
            m_State = FxDmaTransactionStateTransferFailed;
        }
 
        if (pFxDriverGlobals->FxVerifierOn) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                                "WDFDMATRANSACTION %p completed with status %!STATUS! - "
                                "releasing DMA resources",
                                GetHandle(),
                                status);
        }
 
        ReleaseResources(FALSE);
 
        if (m_EncodedRequest != NULL) {
            ReleaseButRetainRequest();
        }
 
        m_CurrentFragmentLength = 0;
 
        hasTransitioned = TRUE;
    } else {
        hasTransitioned = FALSE;
    }
 
    *ReturnStatus = status;
 
    if (pFxDriverGlobals->FxVerifierOn) {
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Exit WDFDMATRANSACTION %p "
                        "Transitioned(%!BOOLEAN!)",
                        dmaTransaction, hasTransitioned);
    }
 
    return hasTransitioned;
}

◆ Execute()

_Must_inspect_result_ NTSTATUS FxDmaTransactionBase::Execute ( __in PVOID Context )

Definition at line 187 of file fxdmatransaction.cpp.

{
    NTSTATUS status;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    //
    // Must be in Initialized state.
    //
    if (m_State != FxDmaTransactionStateInitialized) {
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                    "is invalid", GetHandle(), m_State);
 
        FxVerifierBugCheck(pFxDriverGlobals,                // globals
                           WDF_DMA_FATAL_ERROR, // specific type
                           (ULONG_PTR) GetObjectHandle(),  // parm 2
                           (ULONG_PTR) m_State);           // parm 3
    }
 
    //
    // If this was initialized with a request, then reference the
    // request now.
    //
    if (m_EncodedRequest != NULL) {
        ReferenceRequest();
    }
 
    //
    // Set state to Transfer.
    // This is necessary because the Execute path complete
    // all the way to DmaCompleted before returning to this point.
    //
    m_State = FxDmaTransactionStateTransfer;
 
    //
    // Save the caller's context
    //
    m_DmaAcquiredContext = Context;
 
    ASSERT(m_Transferred == 0);
    ASSERT(m_CurrentFragmentLength == 0);
 
    status = StartTransfer();
    if (!NT_SUCCESS(status)) {
        m_State = FxDmaTransactionStateTransferFailed;
        m_DmaAcquiredContext = NULL;
 
        if (m_EncodedRequest != NULL) {
            ReleaseButRetainRequest();
        }
    }
 
    //
    // StartTransfer results in a call to the EvtProgramDma routine
    // where driver could complete and delete the object.  So
    // don't touch the object beyond this point.
    //
 
    return status;
}

◆ GetBytesTransferred()

__forceinline size_t FxDmaTransactionBase::GetBytesTransferred ( VOID )

inline

Definition at line 197 of file fxdmatransaction.hpp.

    {
        return m_Transferred;
    }

◆ GetCurrentFragmentLength()

__forceinline size_t FxDmaTransactionBase::GetCurrentFragmentLength ( VOID )

inline

Definition at line 340 of file fxdmatransaction.hpp.

    {
        return m_CurrentFragmentLength;
    }

◆ GetDmaEnabler()

__forceinline FxDmaEnabler * FxDmaTransactionBase::GetDmaEnabler ( VOID )

inline

Definition at line 206 of file fxdmatransaction.hpp.

    {
        return m_DmaEnabler;
    }

Referenced by FxDmaPacketTransaction::_AdapterControl(), and if().

◆ GetHandle()

__forceinline WDFDMATRANSACTION FxDmaTransactionBase::GetHandle ( VOID )

inline

Definition at line 349 of file fxdmatransaction.hpp.

    {
        return (WDFDMATRANSACTION) GetObjectHandle();
    }

Referenced by FxDmaPacketTransaction::_AdapterControl(), FxDmaScatterGatherTransaction::_AdapterListControl(), and FxDmaScatterGatherTransaction::_Create().

◆ GetMaximumFragmentLength()

__forceinline size_t FxDmaTransactionBase::GetMaximumFragmentLength ( VOID )

inline

Definition at line 320 of file fxdmatransaction.hpp.

    {
        return m_MaxFragmentLength;
    }

◆ GetRequest()

__forceinline FxRequest * FxDmaTransactionBase::GetRequest ( VOID )

inline

Definition at line 215 of file fxdmatransaction.hpp.

    {
        //
        // Strip out the strong reference tag if it's set
        //
        return FX_DECODE_POINTER(FxRequest,
                                 m_EncodedRequest,
                                 FX_STRONG_REF_TAG);
    }

◆ GetStartVaFromOffset()

static PVOID FxDmaTransactionBase::GetStartVaFromOffset	(	__in PMDL	Mdl,
		__in size_t	Offset
	)

inlinestaticprotected

Definition at line 481 of file fxdmatransaction.hpp.

    {
        return ((PUCHAR) MmGetMdlVirtualAddress(Mdl)) + Offset;
    }

Referenced by _CalculateRequiredMapRegisters(), FxDmaScatterGatherTransaction::BuildScatterGatherList(), FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaScatterGatherTransaction::GetScatterGatherList(), FxDmaPacketTransaction::MapTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ GetTransactionState()

FxDmaTransactionState FxDmaTransactionBase::GetTransactionState ( VOID )

inline

Definition at line 375 of file fxdmatransaction.hpp.

    {
        return m_State;
    }

◆ GetTransferContext()

PVOID FxDmaTransactionBase::GetTransferContext ( VOID )

inline

Definition at line 357 of file fxdmatransaction.hpp.

    {
        return m_TransferContext;
    }

◆ GetTransferInfo()

VOID FxDmaTransactionBase::GetTransferInfo	(	__out_opt ULONG *	MapRegisterCount,
		__out_opt ULONG *	ScatterGatherElementCount
	)

Definition at line 2331 of file fxdmatransaction.cpp.

{
    if (m_State != FxDmaTransactionStateInitialized) {
        PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                    "is invalid", GetHandle(), m_State);
 
        FxVerifierBugCheck(pFxDriverGlobals,               // globals
                           WDF_DMA_FATAL_ERROR,            // specific type
                           (ULONG_PTR) GetObjectHandle(),  // parm 2
                           (ULONG_PTR) m_State);           // parm 3
    }
 
    DMA_TRANSFER_INFO info = {0};
 
 
 
 
 
 
    if (m_DmaEnabler->UsesDmaV3()) {
 
        //
        // Ask the HAL for information about the MDL and how many resources
        // it will require to transfer.
        //
        m_AdapterInfo->AdapterObject->DmaOperations->GetDmaTransferInfo(
            m_AdapterInfo->AdapterObject,
            m_StartMdl,
            m_StartOffset,
            (ULONG) this->m_TransactionLength,
            this->m_DmaDirection == WDF_DMA_DIRECTION::WdfDmaDirectionWriteToDevice,
            &info
            );
    } else {
        size_t offset = m_StartOffset;
        size_t length = m_TransactionLength;
 
        //
        // Walk through the MDL chain and make a worst-case computation of
        // the number of scatter gather entries and map registers the
        // transaction would require.
        //
        for(PMDL mdl = m_StartMdl;
            mdl != NULL && length != 0;
            mdl = mdl->Next) {
 
            size_t byteCount = MmGetMdlByteCount(mdl);
            if (byteCount <= offset) {
                offset -= byteCount;
            } else {
                ULONG_PTR startVa = (ULONG_PTR) MmGetMdlVirtualAddress(mdl);
 
                startVa += offset;
                byteCount -= offset;
 
                info.V1.MapRegisterCount +=
                    (ULONG) ADDRESS_AND_SIZE_TO_SPAN_PAGES(
                        startVa,
                        min(byteCount, length)
                        );
 
                length -= min(byteCount, length);
            }
        }
 
        info.V1.ScatterGatherElementCount = info.V1.MapRegisterCount;
    }
 
    if (ARGUMENT_PRESENT(MapRegisterCount)) {
        *MapRegisterCount = info.V1.MapRegisterCount;
    }
 
    if (ARGUMENT_PRESENT(ScatterGatherElementCount)) {
        *ScatterGatherElementCount = info.V1.ScatterGatherElementCount;
    }
 
    return;
}

◆ Initialize()

_Must_inspect_result_ NTSTATUS FxDmaTransactionBase::Initialize	(	__in PFN_WDF_PROGRAM_DMA	ProgramDmaFunction,
		__in WDF_DMA_DIRECTION	DmaDirection,
		__in PMDL	Mdl,
		__in size_t	Offset,
		__in ULONG	Length
	)

Definition at line 112 of file fxdmatransaction.cpp.

{
    NTSTATUS status;
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Enter WDFDMATRANSACTION %p", GetHandle());
    //
    // Must be in Reserve, Created or Released state.
    //
    if (m_State != FxDmaTransactionStateCreated &&
        m_State != FxDmaTransactionStateReserved &&
        m_State != FxDmaTransactionStateReleased) {
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                    "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                    "is invalid", GetHandle(), m_State);
 
        FxVerifierBugCheck(pFxDriverGlobals,                // globals
                           WDF_DMA_FATAL_ERROR, // specific type
                           (ULONG_PTR) GetObjectHandle(),  // parm 2
                           (ULONG_PTR) m_State);           // parm 3
    }
 
    if (DmaDirection == WdfDmaDirectionReadFromDevice) {
        m_AdapterInfo = m_DmaEnabler->GetReadDmaDescription();
    } else {
        m_AdapterInfo = m_DmaEnabler->GetWriteDmaDescription();
    }
 
    //
    // Initialize the DmaTransaction object
    //
 
    m_MaxFragmentLength  = m_AdapterInfo->MaximumFragmentLength;
    m_DmaDirection       = DmaDirection;
    m_StartMdl           = Mdl;
    m_StartOffset        = Offset;
    m_CurrentFragmentMdl = Mdl;
    m_CurrentFragmentOffset = Offset;
    m_Remaining          = Length;
    m_TransactionLength  = Length;
    m_DmaAcquiredFunction.Method.ProgramDma = ProgramDmaFunction;
 
    //
    // If needed, initialize the transfer context.
    //
 
    if (m_DmaEnabler->UsesDmaV3()) {
        m_DmaEnabler->InitializeTransferContext(GetTransferContext(),
                                                m_DmaDirection);
    }
 
    status = InitializeResources();
    if (NT_SUCCESS(status)) {
        m_State = FxDmaTransactionStateInitialized;
    } else {
        ReleaseForReuse(FALSE);
    }
 
    DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                        "Exit WDFDMATRANSACTION %p, %!STATUS!",
                        GetHandle(), status);
 
    return status;
}

◆ InitializeResources()

virtual _Must_inspect_result_ NTSTATUS FxDmaTransactionBase::InitializeResources ( VOID )

pure virtual

Implemented in FxDmaScatterGatherTransaction, and FxDmaPacketTransaction.

Referenced by Initialize().

◆ IsRequestReferenced()

__forceinline BOOLEAN FxDmaTransactionBase::IsRequestReferenced ( VOID )

inline

Definition at line 229 of file fxdmatransaction.hpp.

    {
        return FX_IS_POINTER_ENCODED(m_EncodedRequest, FX_STRONG_REF_TAG);
    }

Referenced by ClearRequest(), ReferenceRequest(), and ReleaseButRetainRequest().

◆ ReferenceRequest()

__forceinline VOID FxDmaTransactionBase::ReferenceRequest ( VOID )

inline

Definition at line 254 of file fxdmatransaction.hpp.

    {
        ASSERT(m_EncodedRequest != NULL);
        ASSERT(IsRequestReferenced() == false);
 
        //
        // Take a reference on the irp to catch completion of request
        // when there is a pending DMA transaction.
        // While there is no need to take a reference on request itself,
        // I'm keeping it to avoid regression as we are so close to
        // shipping this.
        //
        m_EncodedRequest->AddIrpReference();
 
        //
        // Increment reference to this Request.
        // See complementary section in WdfDmaTransactionDelete
        // and WdfDmaTransactionRelease.
        //
        m_EncodedRequest->ADDREF( this );
 
        m_EncodedRequest = FX_ENCODE_POINTER(FxRequest,
                                             m_EncodedRequest,
                                             FX_STRONG_REF_TAG);
    }

Referenced by Execute().

◆ ReleaseButRetainRequest()

__forceinline VOID FxDmaTransactionBase::ReleaseButRetainRequest ( VOID )

inline

Definition at line 284 of file fxdmatransaction.hpp.

    {
        ASSERT(m_EncodedRequest != NULL);
        ASSERT(IsRequestReferenced());
 
        //
        // Clear the referenced bit on the encoded request.
        //
        m_EncodedRequest = FX_DECODE_POINTER(FxRequest,
                                             m_EncodedRequest,
                                             FX_STRONG_REF_TAG);
 
        //
        // Release this reference to the Irp and FxRequest.
        //
        m_EncodedRequest->ReleaseIrpReference();
 
        m_EncodedRequest->RELEASE( this );
    }

Referenced by CancelResourceAllocation(), ClearRequest(), DmaCompleted(), Execute(), and FxDmaPacketTransaction::ReserveAdapter().

◆ ReleaseForReuse()

VOID FxDmaTransactionBase::ReleaseForReuse ( __in BOOLEAN ForceRelease )

Definition at line 418 of file fxdmatransaction.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
    if (ForceRelease == FALSE)
    {
        if (m_State == FxDmaTransactionStateReleased) {
 
            //
            // Double release is probably due to cancel during early in transaction
            // initialization.  DC2 on very slow machines shows this behavior.
            // The double release case is rare and benign.
            //
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGDMA,
                                "WDFDMATRANSACTION %p is already released, "
                                "%!STATUS!", GetHandle(), STATUS_SUCCESS);
 
            return;  // already released.
        }
 
        //
        // Must not be in transfer state.
        //
        if (m_State == FxDmaTransactionStateTransfer) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                        "WDFDMATRANSACTION %p state %!FxDmaTransactionState! "
                        "is invalid (release transaction)", GetHandle(), m_State);
 
            if (pFxDriverGlobals->IsVerificationEnabled(1, 11, OkForDownLevel)) {
                FxVerifierBugCheck(pFxDriverGlobals,               // globals
                                   WDF_DMA_FATAL_ERROR,            // type
                                   (ULONG_PTR) GetObjectHandle(),  // parm 2
                                   (ULONG_PTR) m_State);           // parm 3
            }
        }
    }
 
    m_State = FxDmaTransactionStateReleased;
 
    ReleaseResources(ForceRelease);
 
    //
    // Except DMA enabler field and adapter info everything else should be
    // cleared.  Adapter info is cleared by ReleaseResources above.
    //
    m_DmaAcquiredContext = NULL;
 
    if (m_EncodedRequest != NULL) {
        ClearRequest();
    }
 
    m_StartMdl = NULL;
    m_CurrentFragmentMdl = NULL;
    m_StartOffset = 0;
    m_CurrentFragmentOffset = 0;
    m_CurrentFragmentLength = 0;
    m_Transferred = 0;
    m_Remaining = 0;
    m_MaxFragmentLength = 0;
    m_TransactionLength = 0;
    m_Flags = 0;
 
    m_DmaAcquiredFunction.Method.ProgramDma = NULL;
 
}

Referenced by Initialize(), FxDmaPacketTransaction::ReleaseAdapter(), and FxDmaPacketTransaction::ReserveAdapter().

◆ ReleaseResources()

virtual VOID FxDmaTransactionBase::ReleaseResources ( __in BOOLEAN ForceRelease )

pure virtual

Implemented in FxDmaScatterGatherTransaction, and FxDmaPacketTransaction.

Referenced by Dispose(), DmaCompleted(), and ReleaseForReuse().

◆ Reuse()

virtual VOID FxDmaTransactionBase::Reuse ( VOID )

inlineprotectedvirtual

Reimplemented in FxDmaPacketTransaction, and FxDmaSystemTransaction.

Definition at line 491 of file fxdmatransaction.hpp.

    {
        return;
    }

◆ SetImmediateExecution()

VOID FxDmaTransactionBase::SetImmediateExecution ( __in BOOLEAN Value )

Definition at line 487 of file fxdmatransaction.cpp.

{
    if (m_State != FxDmaTransactionStateCreated &&
        m_State != FxDmaTransactionStateInitialized &&
        m_State != FxDmaTransactionStateReleased) {
        DoTraceLevelMessage(
            GetDriverGlobals(), TRACE_LEVEL_ERROR, TRACINGDMA,
            "Must set immediate execution flag for WDFDMATRANSACTION "
            "%p before calling AllocateResources or Execute (current "
            "state is %!FxDmaTransactionState!)",
            GetHandle(),
            m_State
            );
        FxVerifierDbgBreakPoint(GetDriverGlobals());
    }
 
    if (Value) {
        m_Flags |= DMA_SYNCHRONOUS_CALLBACK;
    }
    else {
        m_Flags &= ~DMA_SYNCHRONOUS_CALLBACK;
    }
}

◆ SetMaximumFragmentLength()

__forceinline VOID FxDmaTransactionBase::SetMaximumFragmentLength ( size_t MaximumFragmentLength )

inline

Definition at line 329 of file fxdmatransaction.hpp.

    {
        if (MaximumFragmentLength < m_AdapterInfo->MaximumFragmentLength) {
            m_MaxFragmentLength = MaximumFragmentLength;
        }
    }

◆ SetRequest()

__forceinline VOID FxDmaTransactionBase::SetRequest ( __in FxRequest * Request )

inline

Definition at line 238 of file fxdmatransaction.hpp.

    {
        ASSERT(m_EncodedRequest == NULL);
 
        //
        // Make sure the pointer doesn't have the strong ref flag set already
        //
        ASSERT(FX_IS_POINTER_ENCODED(Request, FX_STRONG_REF_TAG) == FALSE);
 
        m_EncodedRequest = Request;
    }

◆ StageTransfer()

virtual _Must_inspect_result_ NTSTATUS FxDmaTransactionBase::StageTransfer ( VOID )

pure virtual

Implemented in FxDmaScatterGatherTransaction, and FxDmaPacketTransaction.

Referenced by DmaCompleted().

◆ StartTransfer()

virtual _Must_inspect_result_ NTSTATUS FxDmaTransactionBase::StartTransfer ( VOID )

pure virtual

Implemented in FxDmaScatterGatherTransaction, and FxDmaPacketTransaction.

Referenced by Execute().

◆ TransferCompleted()

virtual _Must_inspect_result_ NTSTATUS FxDmaTransactionBase::TransferCompleted ( VOID )

pure virtual

Implemented in FxDmaScatterGatherTransaction, and FxDmaPacketTransaction.

Referenced by DmaCompleted().

Friends And Related Function Documentation

◆ FxDmaEnabler

friend class FxDmaEnabler

friend

Definition at line 88 of file fxdmatransaction.hpp.

Member Data Documentation

◆ m_AdapterInfo

FxDmaDescription* FxDmaTransactionBase::m_AdapterInfo

protected

Definition at line 395 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::AllocateAdapterChannel(), FxDmaScatterGatherTransaction::BuildScatterGatherList(), FxDmaSystemTransaction::CancelMappedTransfer(), CancelResourceAllocation(), FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaPacketTransaction::FreeMapRegistersAndAdapter(), FxDmaSystemTransaction::FreeMapRegistersAndAdapter(), FxDmaScatterGatherTransaction::GetScatterGatherList(), GetTransferInfo(), Initialize(), FxDmaScatterGatherTransaction::InitializeResources(), FxDmaPacketTransaction::MapTransfer(), FxDmaScatterGatherTransaction::PutScatterGatherList(), FxDmaScatterGatherTransaction::ReleaseResources(), FxDmaPacketTransaction::ReleaseResources(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaScatterGatherTransaction::StageTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_CurrentFragmentLength

size_t FxDmaTransactionBase::m_CurrentFragmentLength

protected

Definition at line 470 of file fxdmatransaction.hpp.

Referenced by DmaCompleted(), Execute(), FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaTransactionBase(), GetCurrentFragmentLength(), FxDmaPacketTransaction::MapTransfer(), FxDmaSystemTransaction::PreMapTransfer(), ReleaseForReuse(), FxDmaScatterGatherTransaction::StageTransfer(), FxDmaPacketTransaction::StageTransfer(), FxDmaScatterGatherTransaction::StartTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_CurrentFragmentMdl

PMDL FxDmaTransactionBase::m_CurrentFragmentMdl

protected

Definition at line 432 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaTransactionBase(), Initialize(), FxDmaPacketTransaction::MapTransfer(), FxDmaSystemTransaction::PreMapTransfer(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaScatterGatherTransaction::StageTransfer(), FxDmaPacketTransaction::StageTransfer(), FxDmaScatterGatherTransaction::StartTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_CurrentFragmentOffset

size_t FxDmaTransactionBase::m_CurrentFragmentOffset

protected

Definition at line 443 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaTransactionBase(), Initialize(), FxDmaPacketTransaction::MapTransfer(), FxDmaSystemTransaction::PreMapTransfer(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaScatterGatherTransaction::StageTransfer(), FxDmaPacketTransaction::StageTransfer(), FxDmaScatterGatherTransaction::StartTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_DmaAcquiredContext

PVOID FxDmaTransactionBase::m_DmaAcquiredContext

protected

Definition at line 414 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::_AdapterControl(), FxDmaScatterGatherTransaction::_AdapterListControl(), Execute(), FxDmaTransactionBase(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), and FxDmaPacketTransaction::StageTransfer().

◆ m_DmaAcquiredFunction

FxDmaTransactionProgramOrReserveDma FxDmaTransactionBase::m_DmaAcquiredFunction

protected

Definition at line 413 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::_AdapterControl(), FxDmaScatterGatherTransaction::_AdapterListControl(), FxDmaTransactionBase(), Initialize(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), and FxDmaPacketTransaction::StageTransfer().

◆ m_DmaDirection

WDF_DMA_DIRECTION FxDmaTransactionBase::m_DmaDirection

protected

Definition at line 386 of file fxdmatransaction.hpp.

Referenced by FxDmaScatterGatherTransaction::_AdapterListControl(), FxDmaScatterGatherTransaction::BuildScatterGatherList(), FxDmaSystemTransaction::CallEvtDmaCompleted(), FxDmaPacketTransaction::FlushAdapterBuffers(), FxDmaTransactionBase(), FxDmaScatterGatherTransaction::GetScatterGatherList(), Initialize(), FxDmaPacketTransaction::MapTransfer(), FxDmaScatterGatherTransaction::PutScatterGatherList(), FxDmaPacketTransaction::ReserveAdapter(), and FxDmaPacketTransaction::StageTransfer().

◆ m_DmaEnabler

FxDmaEnabler* FxDmaTransactionBase::m_DmaEnabler

protected

Definition at line 388 of file fxdmatransaction.hpp.

◆ m_EncodedRequest

FxRequest* FxDmaTransactionBase::m_EncodedRequest

protected

Definition at line 402 of file fxdmatransaction.hpp.

Referenced by CancelResourceAllocation(), ClearRequest(), Dispose(), DmaCompleted(), Execute(), FxDmaTransactionBase(), GetRequest(), IsRequestReferenced(), ReferenceRequest(), ReleaseButRetainRequest(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), and SetRequest().

◆ m_Flags

ULONG FxDmaTransactionBase::m_Flags

protected

Definition at line 477 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::AllocateAdapterChannel(), FxDmaScatterGatherTransaction::BuildScatterGatherList(), FxDmaTransactionBase(), FxDmaScatterGatherTransaction::GetScatterGatherList(), ReleaseForReuse(), and SetImmediateExecution().

◆ m_MaxFragmentLength

size_t FxDmaTransactionBase::m_MaxFragmentLength

protected

Definition at line 450 of file fxdmatransaction.hpp.

Referenced by FxDmaTransactionBase(), GetMaximumFragmentLength(), Initialize(), FxDmaScatterGatherTransaction::InitializeResources(), ReleaseForReuse(), SetMaximumFragmentLength(), FxDmaScatterGatherTransaction::StageTransfer(), FxDmaPacketTransaction::StageTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_Remaining

size_t FxDmaTransactionBase::m_Remaining

protected

Definition at line 460 of file fxdmatransaction.hpp.

Referenced by DmaCompleted(), FxDmaTransactionBase(), Initialize(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaScatterGatherTransaction::StageTransfer(), FxDmaPacketTransaction::StageTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_StartMdl

PMDL FxDmaTransactionBase::m_StartMdl

protected

Definition at line 424 of file fxdmatransaction.hpp.

Referenced by FxDmaTransactionBase(), GetTransferInfo(), Initialize(), FxDmaScatterGatherTransaction::InitializeResources(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaPacketTransaction::StageTransfer(), FxDmaScatterGatherTransaction::StartTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_StartOffset

size_t FxDmaTransactionBase::m_StartOffset

protected

Definition at line 438 of file fxdmatransaction.hpp.

Referenced by FxDmaTransactionBase(), GetTransferInfo(), Initialize(), FxDmaScatterGatherTransaction::InitializeResources(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), FxDmaPacketTransaction::StageTransfer(), FxDmaScatterGatherTransaction::StartTransfer(), and FxDmaPacketTransaction::StartTransfer().

◆ m_State

FxDmaTransactionState FxDmaTransactionBase::m_State

protected

Definition at line 384 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::_AdapterControl(), CancelResourceAllocation(), Dispose(), DmaCompleted(), Execute(), FxDmaTransactionBase(), GetTransactionState(), GetTransferInfo(), Initialize(), FxDmaPacketTransaction::ReleaseAdapter(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), SetImmediateExecution(), FxDmaPacketTransaction::StartTransfer(), and FxDmaSystemTransaction::StopTransfer().

◆ m_TransactionLength

size_t FxDmaTransactionBase::m_TransactionLength

protected

Definition at line 455 of file fxdmatransaction.hpp.

Referenced by DmaCompleted(), FxDmaTransactionBase(), GetTransferInfo(), Initialize(), FxDmaScatterGatherTransaction::InitializeResources(), ReleaseForReuse(), FxDmaPacketTransaction::ReserveAdapter(), and FxDmaPacketTransaction::StartTransfer().

◆ m_TransferContext

PVOID FxDmaTransactionBase::m_TransferContext

protected

Definition at line 419 of file fxdmatransaction.hpp.

Referenced by FxDmaTransactionBase(), and GetTransferContext().

◆ m_Transferred

size_t FxDmaTransactionBase::m_Transferred

protected

Definition at line 465 of file fxdmatransaction.hpp.

Referenced by DmaCompleted(), Execute(), FxDmaTransactionBase(), GetBytesTransferred(), ReleaseForReuse(), FxDmaPacketTransaction::StageTransfer(), and FxDmaScatterGatherTransaction::StartTransfer().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FxDmaTransactionBase()

Member Function Documentation

◆ _CalculateRequiredMapRegisters()

◆ _ComputeNextTransferAddress()

◆ CancelResourceAllocation()

◆ ClearRequest()

◆ Dispose()

◆ DmaCompleted()

◆ Execute()

◆ GetBytesTransferred()

◆ GetCurrentFragmentLength()

◆ GetDmaEnabler()

◆ GetHandle()

◆ GetMaximumFragmentLength()

◆ GetRequest()

◆ GetStartVaFromOffset()

◆ GetTransactionState()

◆ GetTransferContext()

◆ GetTransferInfo()

◆ Initialize()

◆ InitializeResources()

◆ IsRequestReferenced()

◆ ReferenceRequest()

◆ ReleaseButRetainRequest()

◆ ReleaseForReuse()

◆ ReleaseResources()

◆ Reuse()

◆ SetImmediateExecution()

◆ SetMaximumFragmentLength()

◆ SetRequest()

◆ StageTransfer()

◆ StartTransfer()

◆ TransferCompleted()

Friends And Related Function Documentation

◆ FxDmaEnabler

Member Data Documentation

◆ m_AdapterInfo

◆ m_CurrentFragmentLength

◆ m_CurrentFragmentMdl

◆ m_CurrentFragmentOffset

◆ m_DmaAcquiredContext

◆ m_DmaAcquiredFunction

◆ m_DmaDirection

◆ m_DmaEnabler

◆ m_EncodedRequest

◆ m_Flags

◆ m_MaxFragmentLength

◆ m_Remaining

◆ m_StartMdl

◆ m_StartOffset

◆ m_State

◆ m_TransactionLength

◆ m_TransferContext

◆ m_Transferred