ReactOS  0.4.15-dev-1636-gf634010
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_ ULONGMapRegisterCount
 
typedef _In_ WDFDMATRANSACTION _Out_opt_ ULONG _Out_opt_ ULONGScatterGatherElementCount
 
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_

◆ Attributes

◆ ConfigureContext

Initial value:
{
_In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL ConfigureRoutine
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_CONFIGURE_DMA_CHANNEL _In_opt_ PVOID ConfigureContext
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 632 of file wdfdmatransaction.h.

◆ ConfigureRoutine

◆ DmaCompletionContext

Initial value:
{
_In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE _In_opt_ PVOID DmaCompletionContext
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDMATRANSACTION _In_opt_ PFN_WDF_DMA_TRANSACTION_DMA_TRANSFER_COMPLETE DmaCompletionRoutine
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 665 of file wdfdmatransaction.h.

◆ DmaCompletionRoutine

◆ DmaDirection

Initial value:
{
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ WDFREQUEST Request
#define WdfFunctions
Definition: wdf.h:66
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA EvtProgramDmaFunction
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION DmaDirection
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

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:
{
#define WdfFunctions
Definition: wdf.h:66
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes
_Must_inspect_result_ _In_ WDFDMAENABLER DmaEnabler
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 146 of file wdfdmatransaction.h.

◆ EvtProgramDmaFunction

Definition at line 181 of file wdfdmatransaction.h.

◆ EvtReserveDmaContext

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
_In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA _In_ PVOID EvtReserveDmaContext
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION DmaDirection
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG RequiredMapRegisters
_In_ WDFDMATRANSACTION _In_ WDF_DMA_DIRECTION _In_ ULONG _In_ PFN_WDF_RESERVE_DMA EvtReserveDmaFunction
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 727 of file wdfdmatransaction.h.

◆ EvtReserveDmaFunction

◆ FinalTransferredLength

◆ Length

Definition at line 85 of file wdfdmatransaction.h.

◆ MapRegisterCount

Definition at line 599 of file wdfdmatransaction.h.

◆ MaximumLength

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDMATRANSACTION _In_ size_t MaximumLength
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 495 of file wdfdmatransaction.h.

◆ Mdl

Initial value:
{
return ((PFN_WDFREQUESTRETRIEVEINPUTWDMMDL) WdfFunctions[WdfRequestRetrieveInputWdmMdlTableIndex])(WdfDriverGlobals, Request, Mdl)
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ WDFREQUEST Request
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL Mdl

Definition at line 85 of file wdfdmatransaction.h.

◆ Offset

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
_In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL _In_ size_t Offset
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

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

Definition at line 279 of file wdfdmatransaction.h.

◆ RequiredMapRegisters

◆ ScatterGatherElementCount

Initial value:
{
_In_ WDFDMATRANSACTION _Out_opt_ ULONG * MapRegisterCount
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction
_In_ WDFDMATRANSACTION _Out_opt_ ULONG _Out_opt_ ULONG * ScatterGatherElementCount

Definition at line 599 of file wdfdmatransaction.h.

◆ Status

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDEVICE _In_ WDFCONTEXT _In_ WDF_DMA_DIRECTION _In_ DMA_COMPLETION_STATUS Status
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 108 of file wdfdmatransaction.h.

◆ TransferredLength

Definition at line 404 of file wdfdmatransaction.h.

◆ UseImmediateExecution

Initial value:
{
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDMATRANSACTION _In_ BOOLEAN UseImmediateExecution
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 698 of file wdfdmatransaction.h.

◆ VirtualAddress

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.

480 {
481  return ((PFN_WDFDMATRANSACTIONGETBYTESTRANSFERRED) WdfFunctions[WdfDmaTransactionGetBytesTransferredTableIndex])(WdfDriverGlobals, DmaTransaction);
482 }
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

◆ _Success_()

_Success_ ( TRUE  )

Definition at line 352 of file wdfdmatransaction.h.

360 {
361  return ((PFN_WDFDMATRANSACTIONRELEASE) WdfFunctions[WdfDmaTransactionReleaseTableIndex])(WdfDriverGlobals, DmaTransaction);
362 }
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

◆ _When_()

Definition at line 211 of file wdfdmatransaction.h.

214 {
216 }
#define WdfFunctions
Definition: wdf.h:66
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA EvtProgramDmaFunction
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION DmaDirection
_Must_inspect_result_ _In_ WDFDMATRANSACTION _In_ PFN_WDF_PROGRAM_DMA _In_ WDF_DMA_DIRECTION _In_ PMDL _In_ PVOID VirtualAddress
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL _In_ size_t _In_ size_t Length
_In_ WDFDEVICE _In_ PVOID _In_opt_ PMDL Mdl
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Variable Documentation

◆ Context

Initial value:
{
WDF_EXTERN_C_START typedef _In_ WDFDEVICE _In_ WDFCONTEXT Context
#define WdfFunctions
Definition: wdf.h:66
PWDF_DRIVER_GLOBALS WdfDriverGlobals
_Must_inspect_result_ _In_ WDFDMAENABLER _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFDMATRANSACTION * DmaTransaction

Definition at line 64 of file wdfdmatransaction.h.

◆ Device

typedef _In_ WDFDEVICE Device

Definition at line 64 of file wdfdmatransaction.h.

◆ Direction

◆ SgList