#include <fxdmatransaction.hpp>

Inheritance diagram for FxDmaSystemTransaction:

[legend]

Collaboration diagram for FxDmaSystemTransaction:

[legend]

Public Member Functions
	FxDmaSystemTransaction (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ExtraSize, __in FxDmaEnabler *DmaEnabler)

VOID	SetConfigureChannelCallback (__in_opt PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL Callback, __in_opt PVOID Context)

VOID	SetTransferCompleteCallback (__in_opt PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE Callback, __in_opt PVOID Context)

VOID	StopTransfer (VOID)

Public Member Functions inherited from FxDmaPacketTransaction
virtual _Must_inspect_result_ NTSTATUS	InitializeResources (VOID)

_Must_inspect_result_ NTSTATUS	ReserveAdapter (__in ULONG NumberOfMapRegisters, __in WDF_DMA_DIRECTION Direction, __in PFN_WDF_RESERVE_DMA Callback, __in_opt PVOID Context)

VOID	ReleaseAdapter (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)

VOID	SetDeviceAddressOffset (__in ULONG Offset)

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 FxDmaPacketTransaction
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 Member Functions
IO_ALLOCATION_ACTION	GetAdapterControlReturnValue (VOID)

VOID	FreeMapRegistersAndAdapter (VOID)

BOOLEAN	CancelMappedTransfer (VOID)

VOID	Reuse (VOID)

VOID	CallEvtDmaCompleted (__in DMA_COMPLETION_STATUS Status)

virtual BOOLEAN	PreMapTransfer (VOID)

virtual PDMA_COMPLETION_ROUTINE	GetTransferCompletionRoutine (VOID)

Protected Member Functions inherited from FxDmaPacketTransaction
	FxDmaPacketTransaction (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in USHORT ObjectSize, __in USHORT ExtraSize, __in FxDmaEnabler *DmaEnabler)

virtual VOID	Reuse (VOID)

void	SetMapRegisterBase (__in PVOID Value)

void	ClearMapRegisterBase (VOID)

BOOLEAN	IsMapRegisterBaseSet (VOID)

PVOID	GetMapRegisterBase (VOID)

virtual IO_ALLOCATION_ACTION	GetAdapterControlReturnValue (VOID)

virtual BOOLEAN	PreMapTransfer (VOID)

	_Acquires_lock_ (this) VOID __drv_raisesIRQL(DISPATCH_LEVEL) LockTransferState(__out __drv_deref(__drv_savesIRQL) KIRQL *OldIrql)

	_Requires_lock_held_ (this) _Releases_lock_(this) VOID UnlockTransferState(__in __drv_restoresIRQL KIRQL OldIrql)

virtual PDMA_COMPLETION_ROUTINE	GetTransferCompletionRoutine (VOID)

_Must_inspect_result_ NTSTATUS	AcquireDevice (VOID)

FORCEINLINE VOID	ReleaseDevice (VOID)

_Must_inspect_result_ NTSTATUS	AllocateAdapterChannel (__in BOOLEAN MapRegistersReserved)

FORCEINLINE NTSTATUS	MapTransfer (__out_bcount_opt(ScatterGatherListCb) PSCATTER_GATHER_LIST ScatterGatherList, __in ULONG ScatterGatherListCb, __in_opt PDMA_COMPLETION_ROUTINE CompletionRoutine, __in_opt PVOID CompletionContext, __out ULONG *TransferLength)

FORCEINLINE NTSTATUS	FlushAdapterBuffers (VOID)

virtual VOID	FreeMapRegistersAndAdapter (VOID)

virtual VOID	CallEvtDmaCompleted (__in DMA_COMPLETION_STATUS)

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)

Protected Attributes
FxDmaTransactionConfigureChannel	m_ConfigureChannelFunction

PVOID	m_ConfigureChannelContext

FxDmaTransactionTransferComplete	m_TransferCompleteFunction

PVOID	m_TransferCompleteContext

Protected Attributes inherited from FxDmaPacketTransaction
ULONG	m_MapRegistersNeeded

PVOID	m_MapRegisterBase

BOOLEAN	m_MapRegisterBaseSet

ULONG	m_DeviceAddressOffset

ULONG	m_MapRegistersReserved

struct {
PKTHREAD CurrentStagingThread

BOOLEAN RerunStaging

BOOLEAN RerunCompletion

DMA_COMPLETION_STATUS CompletionStatus

}	m_TransferState

ULONG	m_IsCancelled

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

};

Static Protected Attributes
static DMA_COMPLETION_ROUTINE	_SystemDmaCompletion

Private Attributes
friend	FxDmaPacketTransaction

Additional Inherited Members
Static Protected Member Functions inherited from FxDmaPacketTransaction
static IO_ALLOCATION_ACTION STDCALL	_AdapterControl (__in PDEVICE_OBJECT DeviceObject, __in PIRP Irp, __in PVOID MapRegisterBase, __in PVOID Context)

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 1410 of file fxdmatransaction.hpp.

Constructor & Destructor Documentation

◆ FxDmaSystemTransaction()

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

Definition at line 2210 of file fxdmatransaction.cpp.

      :
    FxDmaPacketTransaction(FxDriverGlobals, sizeof(FxDmaSystemTransaction), ExtraSize, DmaEnabler)
{
    return;
}

Member Function Documentation

◆ _Create()

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

static

Definition at line 2222 of file fxdmatransaction.cpp.

{
    FxDmaPacketTransaction* pTransaction;
    WDFOBJECT hTransaction;
    NTSTATUS status;
 
    pTransaction = new (FxDriverGlobals, Attributes, DmaEnabler->GetTransferContextSize())
                FxDmaSystemTransaction(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)) {
        *Transaction = (WDFDMATRANSACTION)hTransaction;
    }
    else {
        //
        // This will properly clean up the target's state and free it
        //
        pTransaction->DeleteFromFailedCreate();
    }
 
    return status;
}

Referenced by switch().

◆ CallEvtDmaCompleted()

VOID FxDmaSystemTransaction::CallEvtDmaCompleted ( __in DMA_COMPLETION_STATUS Status )

protectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 2313 of file fxdmatransaction.cpp.

{
    //
    // Call the TransferComplete callback to indicate that the
    // transfer was aborted.
    //
    m_TransferCompleteFunction.Invoke(
        GetHandle(),
        m_DmaEnabler->m_Device->GetHandle(),
        m_TransferCompleteContext,
        m_DmaDirection,
        Status
        );
}

◆ CancelMappedTransfer()

BOOLEAN FxDmaSystemTransaction::CancelMappedTransfer ( VOID )

inlineprotected

Definition at line 1503 of file fxdmatransaction.hpp.

    {
        NTSTATUS status;
 
        ASSERT(m_DmaEnabler->UsesDmaV3());
 
        //
        // Cancel the transfer.  if it's not yet mapped this will mark the
        // TC so that mapping will fail.  If it's running this will invoke the
        // DMA completion routine.
        //
        status =
            m_AdapterInfo->AdapterObject->DmaOperations->CancelMappedTransfer(
                m_AdapterInfo->AdapterObject,
                GetTransferContext()
                );
 
        DoTraceLevelMessage(GetDriverGlobals(), TRACE_LEVEL_VERBOSE, TRACINGDMA,
                            "Stopping WDFDMATRANSACTION %p returned status %!STATUS!",
                            GetHandle(),
                            status);
 
        return NT_SUCCESS(status);
    }

Referenced by StopTransfer().

◆ FreeMapRegistersAndAdapter()

VOID FxDmaSystemTransaction::FreeMapRegistersAndAdapter ( VOID )

inlineprotectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 1480 of file fxdmatransaction.hpp.

    {
        PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
        KIRQL irql;
 
        KeRaiseIrql(DISPATCH_LEVEL, &irql);
 
        if (pFxDriverGlobals->FxVerifierOn) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                                "Freeing adapter channel for WDFDMATRANSACTION %p",
                                GetHandle());
        }
 
        m_AdapterInfo->AdapterObject->DmaOperations->
                    FreeAdapterChannel(m_AdapterInfo->AdapterObject);
        KeLowerIrql(irql);
 
        return;
    }

◆ GetAdapterControlReturnValue()

IO_ALLOCATION_ACTION FxDmaSystemTransaction::GetAdapterControlReturnValue ( VOID )

inlineprotectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 1472 of file fxdmatransaction.hpp.

    {
        return KeepObject;
    }

◆ GetTransferCompletionRoutine()

PDMA_COMPLETION_ROUTINE FxDmaSystemTransaction::GetTransferCompletionRoutine ( VOID )

protectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 2300 of file fxdmatransaction.cpp.

{
    if (m_TransferCompleteFunction.Method == NULL) {
        return NULL;
    }
    else {
        return _SystemDmaCompletion;
    }
}

◆ PreMapTransfer()

BOOLEAN FxDmaSystemTransaction::PreMapTransfer ( VOID )

protectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 2262 of file fxdmatransaction.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
    BOOLEAN result = TRUE;
 
    if (m_ConfigureChannelFunction.Method != NULL) {
        //
        // Invoke the callback.  If it returns false then the driver has
        // completed the transaction in the callback and we must abort
        // processing.
        //
 
        if (pFxDriverGlobals->FxVerifierOn) {
            DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGDMA,
                                "Invoking ConfigureChannel callback %p (context "
                                "%p) for WDFDMATRANSACTION %p.",
                                m_ConfigureChannelFunction.Method,
                                m_ConfigureChannelContext,
                                GetHandle());
        }
 
        result = m_ConfigureChannelFunction.Invoke(
                    GetHandle(),
                    m_DmaEnabler->m_DeviceBase->GetHandle(),
                    m_ConfigureChannelContext,
                    m_CurrentFragmentMdl,
                    m_CurrentFragmentOffset,
                    m_CurrentFragmentLength
                    );
    }
 
    return result;
}

◆ Reuse()

VOID FxDmaSystemTransaction::Reuse ( VOID )

inlineprotectedvirtual

Reimplemented from FxDmaPacketTransaction.

Definition at line 1531 of file fxdmatransaction.hpp.

    {
        FxDmaPacketTransaction::Reuse(); // __super call
        m_ConfigureChannelFunction.Method = NULL;
        m_ConfigureChannelContext = NULL;
 
        m_TransferCompleteFunction.Method = NULL;
        m_TransferCompleteContext = NULL;
    }

◆ SetConfigureChannelCallback()

VOID FxDmaSystemTransaction::SetConfigureChannelCallback	(	__in_opt PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL	Callback,
		__in_opt PVOID	Context
	)

inline

Definition at line 1433 of file fxdmatransaction.hpp.

    {
        m_ConfigureChannelFunction.Method = Callback;
        m_ConfigureChannelContext = Context;
    }

◆ SetTransferCompleteCallback()

VOID FxDmaSystemTransaction::SetTransferCompleteCallback	(	__in_opt PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE	Callback,
		__in_opt PVOID	Context
	)

inline

Definition at line 1443 of file fxdmatransaction.hpp.

    {
        m_TransferCompleteFunction.Method = Callback;
        m_TransferCompleteContext = Context;
    }

◆ StopTransfer()

VOID FxDmaSystemTransaction::StopTransfer ( VOID )

Definition at line 2498 of file fxdmatransaction.cpp.

{
    //
    // Mark the transfer cancelled so we have a record of it even if
    // a racing call to FlushAdapterBuffers clears the TC.
    //
    m_IsCancelled = TRUE;
 
    //
    // Cancel the system DMA transfer.  This arranges for one of two things
    // to happen:
    //  * the next call to MapTransfer will fail
    //  * the DMA completion routine will run
    //
    if (CancelMappedTransfer() == FALSE) {
 
        //
        // The cancel failed.  Someone has already stopped this transfer.
        // That's illegal.
        //
        PFX_DRIVER_GLOBALS pFxDriverGlobals = GetDriverGlobals();
 
        DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDMA,
                            "WDFDMATRANSACTION %p has already been stopped",
                            GetHandle());
 
        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
        }
    }
}

Member Data Documentation

◆ _SystemDmaCompletion

VOID FxDmaSystemTransaction::_SystemDmaCompletion

staticprotected

Definition at line 1560 of file fxdmatransaction.hpp.

Referenced by GetTransferCompletionRoutine().

◆ FxDmaPacketTransaction

friend FxDmaSystemTransaction::FxDmaPacketTransaction

private

Definition at line 1412 of file fxdmatransaction.hpp.

◆ m_ConfigureChannelContext

PVOID FxDmaSystemTransaction::m_ConfigureChannelContext

protected

Definition at line 1463 of file fxdmatransaction.hpp.

Referenced by PreMapTransfer(), Reuse(), and SetConfigureChannelCallback().

◆ m_ConfigureChannelFunction

FxDmaTransactionConfigureChannel FxDmaSystemTransaction::m_ConfigureChannelFunction

protected

Definition at line 1462 of file fxdmatransaction.hpp.

Referenced by PreMapTransfer(), Reuse(), and SetConfigureChannelCallback().

◆ m_TransferCompleteContext

PVOID FxDmaSystemTransaction::m_TransferCompleteContext

protected

Definition at line 1469 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::_AdapterControl(), CallEvtDmaCompleted(), Reuse(), SetTransferCompleteCallback(), and FxDmaPacketTransaction::StageTransfer().

◆ m_TransferCompleteFunction

FxDmaTransactionTransferComplete FxDmaSystemTransaction::m_TransferCompleteFunction

protected

Definition at line 1468 of file fxdmatransaction.hpp.

Referenced by FxDmaPacketTransaction::_AdapterControl(), CallEvtDmaCompleted(), GetTransferCompletionRoutine(), Reuse(), SetTransferCompleteCallback(), and FxDmaPacketTransaction::StageTransfer().

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

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FxDmaSystemTransaction()

Member Function Documentation

◆ _Create()

◆ CallEvtDmaCompleted()

◆ CancelMappedTransfer()

◆ FreeMapRegistersAndAdapter()

◆ GetAdapterControlReturnValue()

◆ GetTransferCompletionRoutine()

◆ PreMapTransfer()

◆ Reuse()

◆ SetConfigureChannelCallback()

◆ SetTransferCompleteCallback()

◆ StopTransfer()

Member Data Documentation

◆ _SystemDmaCompletion

◆ FxDmaPacketTransaction

◆ m_ConfigureChannelContext

◆ m_ConfigureChannelFunction

◆ m_TransferCompleteContext

◆ m_TransferCompleteFunction