wdfdmatransaction.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef EVT_WDF_PROGRAM_DMA *	PFN_WDF_PROGRAM_DMA
typedef _In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL	Mdl
typedef _In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL _In_ size_t	Offset
typedef _In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL _In_ size_t _In_ size_t	Length
typedef EVT_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL *	PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL
typedef _In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION _In_ DMA_COMPLETION_STATUS	Status
typedef EVT_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE *	PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE
typedef EVT_WDF_RESERVE_DMA *	PFN_WDF_RESERVE_DMA
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDMATRANSACTIONCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDMAENABLER	DmaEnabler
typedef _Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes
typedef _Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION *	DmaTransaction
typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA	EvtProgramDmaFunction
typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION	DmaDirection
typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID	VirtualAddress
typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID _In_	_When_(Length==0, __drv_reportError(Length cannot be zero)) size_t Length)
typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ WDFREQUEST	Request
typedef _In_ WDFDMATRANSACTION _In_ size_t	TransferredLength
typedef _In_ WDFDMATRANSACTION _In_ size_t	FinalTransferredLength
typedef _In_ WDFDMATRANSACTION _In_ size_t	MaximumLength
typedef _In_ WDFDMATRANSACTION _Out_opt_ ULONG *	MapRegisterCount
typedef _In_ WDFDMATRANSACTION _Out_opt_ ULONG _Out_opt_ ULONG *	ScatterGatherElementCount
typedef _In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL	ConfigureRoutine
typedef _In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL _In_opt_ PVOID	ConfigureContext
typedef _In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE	DmaCompletionRoutine
typedef _In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE _In_opt_ PVOID	DmaCompletionContext
typedef _In_ WDFDMATRANSACTION _In_ BOOLEAN	UseImmediateExecution
typedef _In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG	RequiredMapRegisters
typedef _In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA	EvtReserveDmaFunction
typedef _In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA _In_ PVOID	EvtReserveDmaContext

Functions
WDF_EXTERN_C_START typedef	_Function_class_ (EVT_WDF_PROGRAM_DMA) _IRQL_requires_same_ _IRQL_requires_(DISPATCH_LEVEL) BOOLEAN STDCALL EVT_WDF_PROGRAM_DMA(_In_ WDFDMATRANSACTION Transaction
typedef	_Function_class_ (EVT_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL) _IRQL_requires_same_ _IRQL_requires_(DISPATCH_LEVEL) BOOLEAN STDCALL EVT_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL(_In_ WDFDMATRANSACTION DmaTransaction
typedef	_Function_class_ (EVT_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE) _IRQL_requires_same_ _IRQL_requires_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE(_In_ WDFDMATRANSACTION Transaction
typedef	_Function_class_ (EVT_WDF_RESERVE_DMA) _IRQL_requires_same_ _IRQL_requires_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_RESERVE_DMA(_In_ WDFDMATRANSACTION DmaTransaction
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) FORCEINLINE NTSTATUS WdfDmaTransactionCreate(_In_ WDFDMAENABLER DmaEnabler
_Must_inspect_result_ _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID _In_	_When_ (Length==0, __drv_reportError(Length cannot be zero)) size_t Length)
typedef	_Success_ (TRUE) _IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDMATRANSACTIONRELEASE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Variables
WDF_EXTERN_C_START typedef _In_ WDFDEVICE	Device
WDF_EXTERN_C_START typedef _In_ WDFDEVICE _In_ WDFCONTEXT	Context
WDF_EXTERN_C_START typedef _In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION	Direction
WDF_EXTERN_C_START typedef _In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION _In_ PSCATTER_GATHER_LIST	SgList

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfdmatransaction.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfdmatransaction.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfdmatransaction.h.

Typedef Documentation

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDMATRANSACTIONEXECUTE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 139 of file wdfdmatransaction.h.

_When_

typedef _Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ size_t _In_ _When_(Length==0, __drv_reportError(Length cannot be zero)) size_t Length)

Definition at line 191 of file wdfdmatransaction.h.

Attributes

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 146 of file wdfdmatransaction.h.

ConfigureContext

_In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL _In_opt_ PVOID ConfigureContext

Initial value:

{
    ((PFN_WDFDMATRANSACTIONSETCHANNELCONFIGURATIONCALLBACK) WdfFunctions[WdfDmaTransactionSetChannelConfigurationCallbackTableIndex])(WdfDriverGlobals, DmaTransaction, ConfigureRoutine, ConfigureContext)

Definition at line 632 of file wdfdmatransaction.h.

ConfigureRoutine

_In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL ConfigureRoutine

Definition at line 632 of file wdfdmatransaction.h.

DmaCompletionContext

_In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE _In_opt_ PVOID DmaCompletionContext

Initial value:

{
    ((PFN_WDFDMATRANSACTIONSETTRANSFERCOMPLETECALLBACK) WdfFunctions[WdfDmaTransactionSetTransferCompleteCallbackTableIndex])(WdfDriverGlobals, DmaTransaction, DmaCompletionRoutine, DmaCompletionContext)

Definition at line 665 of file wdfdmatransaction.h.

DmaCompletionRoutine

_In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE DmaCompletionRoutine

Definition at line 665 of file wdfdmatransaction.h.

DmaDirection

_In_ WDF_DMA_DIRECTION DmaDirection

Initial value:

{
    return ((PFN_WDFDMATRANSACTIONINITIALIZEUSINGREQUEST) WdfFunctions[WdfDmaTransactionInitializeUsingRequestTableIndex])(WdfDriverGlobals, DmaTransaction, Request, EvtProgramDmaFunction, DmaDirection)

Definition at line 181 of file wdfdmatransaction.h.

DmaEnabler

typedef _Must_inspect_result_ _In_ WDFDMAENABLER DmaEnabler

Definition at line 146 of file wdfdmatransaction.h.

DmaTransaction

_In_ WDFDMATRANSACTION DmaTransaction

Initial value:

{
    return ((PFN_WDFDMATRANSACTIONCREATE) WdfFunctions[WdfDmaTransactionCreateTableIndex])(WdfDriverGlobals, DmaEnabler, Attributes, DmaTransaction)

Definition at line 146 of file wdfdmatransaction.h.

EvtProgramDmaFunction

_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ WDFREQUEST _In_ PFN_WDF_PROGRAM_DMA EvtProgramDmaFunction

Definition at line 181 of file wdfdmatransaction.h.

EvtReserveDmaContext

_In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA _In_ PVOID EvtReserveDmaContext

Initial value:

{
    return ((PFN_WDFDMATRANSACTIONALLOCATERESOURCES) WdfFunctions[WdfDmaTransactionAllocateResourcesTableIndex])(WdfDriverGlobals, DmaTransaction, DmaDirection, RequiredMapRegisters, EvtReserveDmaFunction, EvtReserveDmaContext)

Definition at line 727 of file wdfdmatransaction.h.

EvtReserveDmaFunction

_In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA EvtReserveDmaFunction

Definition at line 727 of file wdfdmatransaction.h.

FinalTransferredLength

_In_ size_t FinalTransferredLength

Definition at line 437 of file wdfdmatransaction.h.

Length

typedef _In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL _In_ size_t _In_ size_t Length

Definition at line 85 of file wdfdmatransaction.h.

MapRegisterCount

_Out_opt_ ULONG * MapRegisterCount

Definition at line 599 of file wdfdmatransaction.h.

MaximumLength

_In_ size_t MaximumLength

Initial value:

{
    ((PFN_WDFDMATRANSACTIONSETMAXIMUMLENGTH) WdfFunctions[WdfDmaTransactionSetMaximumLengthTableIndex])(WdfDriverGlobals, DmaTransaction, MaximumLength)

Definition at line 495 of file wdfdmatransaction.h.

Mdl

_Must_inspect_result_ _In_ WDFREQUEST _Outptr_ PMDL * Mdl

Initial value:

{
    return ((PFN_WDFREQUESTRETRIEVEINPUTWDMMDL) WdfFunctions[WdfRequestRetrieveInputWdmMdlTableIndex])(WdfDriverGlobals, Request, Mdl)

Definition at line 85 of file wdfdmatransaction.h.

Offset

_In_ ULONG Offset

Initial value:

{
    ((PFN_WDFDMATRANSACTIONSETDEVICEADDRESSOFFSET) WdfFunctions[WdfDmaTransactionSetDeviceAddressOffsetTableIndex])(WdfDriverGlobals, DmaTransaction, Offset)

Definition at line 85 of file wdfdmatransaction.h.

PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL

typedef EVT_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL* PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL

Definition at line 96 of file wdfdmatransaction.h.

PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE

typedef EVT_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE* PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE

Definition at line 117 of file wdfdmatransaction.h.

PFN_WDF_PROGRAM_DMA

typedef EVT_WDF_PROGRAM_DMA* PFN_WDF_PROGRAM_DMA

Definition at line 73 of file wdfdmatransaction.h.

PFN_WDF_RESERVE_DMA

typedef EVT_WDF_RESERVE_DMA* PFN_WDF_RESERVE_DMA

Definition at line 132 of file wdfdmatransaction.h.

Request

_Must_inspect_result_ _In_ WDFREQUEST Request

Definition at line 279 of file wdfdmatransaction.h.

RequiredMapRegisters

_In_ WDF_DMA_DIRECTION _In_ ULONG RequiredMapRegisters

Definition at line 727 of file wdfdmatransaction.h.

ScatterGatherElementCount

_Out_opt_ ULONG _Out_opt_ ULONG * ScatterGatherElementCount

Initial value:

{
    ((PFN_WDFDMATRANSACTIONGETTRANSFERINFO) WdfFunctions[WdfDmaTransactionGetTransferInfoTableIndex])(WdfDriverGlobals, DmaTransaction, MapRegisterCount, ScatterGatherElementCount)

Definition at line 599 of file wdfdmatransaction.h.

Status

_In_ size_t _Out_ NTSTATUS* Status

Initial value:

{
    return ((PFN_WDFDMATRANSACTIONDMACOMPLETED) WdfFunctions[WdfDmaTransactionDmaCompletedTableIndex])(WdfDriverGlobals, DmaTransaction, Status)

Definition at line 108 of file wdfdmatransaction.h.

TransferredLength

_In_ size_t TransferredLength

Definition at line 404 of file wdfdmatransaction.h.

UseImmediateExecution

_In_ BOOLEAN UseImmediateExecution

Initial value:

{
    ((PFN_WDFDMATRANSACTIONSETIMMEDIATEEXECUTION) WdfFunctions[WdfDmaTransactionSetImmediateExecutionTableIndex])(WdfDriverGlobals, DmaTransaction, UseImmediateExecution)

Definition at line 698 of file wdfdmatransaction.h.

VirtualAddress

_Must_inspect_result_ _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID VirtualAddress

Definition at line 181 of file wdfdmatransaction.h.

Function Documentation

_Function_class_() [1/4]

WDF_EXTERN_C_START typedef _Function_class_

(

EVT_WDF_PROGRAM_DMA

)

_Function_class_() [2/4]

typedef _Function_class_

(

EVT_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL

)

_Function_class_() [3/4]

typedef _Function_class_

(

EVT_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE

)

_Function_class_() [4/4]

typedef _Function_class_

(

EVT_WDF_RESERVE_DMA

)

_IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 473 of file wdfdmatransaction.h.

{
    return ((PFN_WDFDMATRANSACTIONGETBYTESTRANSFERRED) WdfFunctions[WdfDmaTransactionGetBytesTransferredTableIndex])(WdfDriverGlobals, DmaTransaction);
}

_Success_()

_Success_

(

TRUE

)

Definition at line 352 of file wdfdmatransaction.h.

{
    return ((PFN_WDFDMATRANSACTIONRELEASE) WdfFunctions[WdfDmaTransactionReleaseTableIndex])(WdfDriverGlobals, DmaTransaction);
}

_When_()

_Must_inspect_result_ _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID _In_ _When_	(	Length	= = 0,
		__drv_reportError(Length cannot be zero)
	)

Definition at line 211 of file wdfdmatransaction.h.

{
    return ((PFN_WDFDMATRANSACTIONINITIALIZE) WdfFunctions[WdfDmaTransactionInitializeTableIndex])(WdfDriverGlobals, DmaTransaction, EvtProgramDmaFunction, DmaDirection, Mdl, VirtualAddress, Length);
}

Variable Documentation

Context

_Must_inspect_result_ _In_opt_ WDFCONTEXT Context

Initial value:

{
    return ((PFN_WDFDMATRANSACTIONEXECUTE) WdfFunctions[WdfDmaTransactionExecuteTableIndex])(WdfDriverGlobals, DmaTransaction, Context)

Definition at line 64 of file wdfdmatransaction.h.

Device

typedef _In_ WDFDEVICE Device

Definition at line 64 of file wdfdmatransaction.h.

Direction

typedef _In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION Direction

Definition at line 64 of file wdfdmatransaction.h.

Referenced by CApplicationView::AppendTabOrderWindow(), d3dx9_set_light_parameter(), DrvBitBlt(), EngBitBlt(), EngMaskBitBlt(), EngStretchBltROP(), EngTransparentBlt(), FstubTranslateResource(), FxDmaEnabler::GetDmaDescription(), FxDmaEnabler::InitializeTransferContext(), FxDmaTransactionTransferComplete::Invoke(), FxDmaTransactionProgramOrReserveDma::InvokeProgramDma(), ODBC32_SQLDataSources(), ODBC32_SQLDataSourcesA(), ODBC32_SQLDataSourcesW(), USB2_AllocateHS(), USB2_DeallocateHS(), USB2_GetCMASK(), USB2_GetHsOverhead(), USB2_GetOverhead(), USB2_InitTtEndpoint(), USBPORT_AllocateBandwidthUSB2(), USBPORT_OpenPipe(), VidBiosScrollWindow(), WDF_USB_CONTROL_SETUP_PACKET_INIT(), WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS(), and WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR().

SgList

WDF_EXTERN_C_START typedef _In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION _In_ PSCATTER_GATHER_LIST SgList

Definition at line 64 of file wdfdmatransaction.h.

Referenced by FxDmaScatterGatherTransaction::_AdapterListControl(), EHCI_BulkTransfer(), EHCI_ControlTransfer(), EHCI_InterruptTransfer(), EHCI_MapAsyncTransferToTd(), EHCI_SubmitTransfer(), FxDmaTransactionProgramOrReserveDma::InvokeProgramDma(), UhciBulkOrInterruptTransfer(), UhciControlTransfer(), UhciMapAsyncTransferToTDs(), and UhciSubmitTransfer().