wdfmemory.h File Reference

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

Go to the source code of this file.

Classes
struct	_WDFMEMORY_OFFSET
struct	_WDF_MEMORY_DESCRIPTOR

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_MEMORY_DESCRIPTOR_TYPE	WDF_MEMORY_DESCRIPTOR_TYPE
typedef struct _WDFMEMORY_OFFSET	WDFMEMORY_OFFSET
typedef struct _WDFMEMORY_OFFSET *	PWDFMEMORY_OFFSET
typedef struct _WDF_MEMORY_DESCRIPTOR	WDF_MEMORY_DESCRIPTOR
typedef struct _WDF_MEMORY_DESCRIPTOR *	PWDF_MEMORY_DESCRIPTOR
typedef _Must_inspect_result_	_When_(PoolType==1||PoolType==257, _IRQL_requires_max_(APC_LEVEL)) _When_(PoolType == 0 || PoolType == 256
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL)) WDFAPI NTSTATUS(STDCALL *PFN_WDFMEMORYCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES	Attributes
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _Strict_type_match_ POOL_TYPE	PoolType
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _Strict_type_match_ POOL_TYPE _In_opt_ ULONG	PoolTag
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _Strict_type_match_ POOL_TYPE _In_opt_ ULONG _In_ _Out_ WDFMEMORY *	Memory
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _Strict_type_match_ POOL_TYPE _In_opt_ ULONG _In_ _Out_ WDFMEMORY	_Outptr_opt_result_bytebuffer_(BufferSize) PVOID *Buffer)
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ __drv_aliasesMem PVOID	Buffer = Buffer
typedef _In_ WDFMEMORY _Out_opt_ size_t *	BufferSize
typedef _Must_inspect_result_ _In_ WDFMEMORY _Pre_notnull_	_Pre_writable_byte_size_(BufferSize) PVOID Buffer
typedef _Must_inspect_result_ _In_ WDFMEMORY	SourceMemory
typedef _Must_inspect_result_ _In_ WDFMEMORY _In_ size_t	SourceOffset
typedef _Must_inspect_result_ _In_ WDFMEMORY _In_ size_t	_Out_writes_bytes_(NumBytesToCopyTo) PVOID Buffer
typedef _Must_inspect_result_ _In_ WDFMEMORY	DestinationMemory
typedef _Must_inspect_result_ _In_ WDFMEMORY _In_ size_t	DestinationOffset
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES	LookasideAttributes
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES	MemoryAttributes
typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ ULONG _Out_ WDFLOOKASIDE *	Lookaside

Enumerations
enum	_WDF_MEMORY_DESCRIPTOR_TYPE { WdfMemoryDescriptorTypeInvalid = 0 , WdfMemoryDescriptorTypeBuffer , WdfMemoryDescriptorTypeMdl , WdfMemoryDescriptorTypeHandle }

Functions
FORCEINLINE VOID	WDF_MEMORY_DESCRIPTOR_INIT_BUFFER (_Out_ PWDF_MEMORY_DESCRIPTOR Descriptor, _In_ PVOID Buffer, _In_ ULONG BufferLength)
FORCEINLINE VOID	WDF_MEMORY_DESCRIPTOR_INIT_HANDLE (_Out_ PWDF_MEMORY_DESCRIPTOR Descriptor, _In_ WDFMEMORY Memory, _In_opt_ PWDFMEMORY_OFFSET Offsets)
FORCEINLINE VOID	WDF_MEMORY_DESCRIPTOR_INIT_MDL (_Out_ PWDF_MEMORY_DESCRIPTOR Descriptor, _In_ PMDL Mdl, _In_ ULONG BufferLength)
_Must_inspect_result_ _In_ _Strict_type_match_ POOL_TYPE _In_opt_ ULONG _In_	_When_ (BufferSize==0, __drv_reportError(BufferSize cannot be zero)) size_t BufferSize
_Must_inspect_result_ _In_ size_t _In_	_When_ (NumBytesToCopyTo==0, __drv_reportError(NumBytesToCopyTo cannot be zero)) size_t NumBytesToCopyTo)
_Must_inspect_result_ _In_ size_t _In_ PVOID _In_	_When_ (NumBytesToCopyFrom==0, __drv_reportError(NumBytesToCopyFrom cannot be zero)) size_t NumBytesToCopyFrom)

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfmemory.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfmemory.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfmemory.h.

Typedef Documentation

_IRQL_requires_max_

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

Definition at line 152 of file wdfmemory.h.

_Out_writes_bytes_

typedef _Must_inspect_result_ _In_ WDFMEMORY _In_ size_t _Out_writes_bytes_(NumBytesToCopyTo) PVOID Buffer

Definition at line 321 of file wdfmemory.h.

_Outptr_opt_result_bytebuffer_

typedef _Must_inspect_result_ _In_ WDFUSBDEVICE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ ULONG _Out_ WDFMEMORY _Outptr_opt_result_bytebuffer_(GET_ISO_URB_SIZE(NumberOfIsochPackets)) PURB *Urb)

Definition at line 170 of file wdfmemory.h.

_Pre_writable_byte_size_

_Must_inspect_result_ _Pre_notnull_ _Pre_writable_byte_size_

Definition at line 282 of file wdfmemory.h.

_When_

typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _When_(BufferSize==0, __drv_reportError(BufferSize cannot be zero)) size_t BufferSize == 0 || PoolType == 256

Definition at line 151 of file wdfmemory.h.

Attributes

typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes

Definition at line 159 of file wdfmemory.h.

Buffer

_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID * Buffer = Buffer

Definition at line 213 of file wdfmemory.h.

BufferSize

_Out_opt_ size_t* BufferSize

Initial value:

{
    return ((PFN_WDFMEMORYGETBUFFER) WdfFunctions[WdfMemoryGetBufferTableIndex])(WdfDriverGlobals, Memory, BufferSize)

Definition at line 253 of file wdfmemory.h.

DestinationMemory

typedef _Must_inspect_result_ _In_ WDFMEMORY DestinationMemory

Definition at line 359 of file wdfmemory.h.

DestinationOffset

_Must_inspect_result_ _In_ size_t DestinationOffset

Definition at line 361 of file wdfmemory.h.

Lookaside

_Must_inspect_result_ _In_ WDFLOOKASIDE Lookaside

Initial value:

{
    return ((PFN_WDFLOOKASIDELISTCREATE) WdfFunctions[WdfLookasideListCreateTableIndex])(WdfDriverGlobals, LookasideAttributes, BufferSize, PoolType, MemoryAttributes, PoolTag, Lookaside)

Definition at line 413 of file wdfmemory.h.

LookasideAttributes

typedef _Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES LookasideAttributes

Definition at line 401 of file wdfmemory.h.

Memory

_Must_inspect_result_ _In_ WDFUSBDEVICE _In_ WDFREQUEST _In_ WDFMEMORY Memory

Initial value:

{
    return ((PFN_WDFMEMORYCREATEPREALLOCATED) WdfFunctions[WdfMemoryCreatePreallocatedTableIndex])(WdfDriverGlobals, Attributes, Buffer, BufferSize, Memory)

Definition at line 169 of file wdfmemory.h.

MemoryAttributes

_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES MemoryAttributes

Definition at line 409 of file wdfmemory.h.

PoolTag

_Must_inspect_result_ _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ _In_ _Strict_type_match_ POOL_TYPE _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_opt_ ULONG PoolTag

Definition at line 164 of file wdfmemory.h.

PoolType

_Must_inspect_result_ _In_ _In_ _Strict_type_match_ POOL_TYPE PoolType

Definition at line 162 of file wdfmemory.h.

PWDF_MEMORY_DESCRIPTOR

typedef struct _WDF_MEMORY_DESCRIPTOR * PWDF_MEMORY_DESCRIPTOR

PWDFMEMORY_OFFSET

typedef struct _WDFMEMORY_OFFSET * PWDFMEMORY_OFFSET

SourceMemory

typedef _Must_inspect_result_ _In_ WDFMEMORY SourceMemory

Definition at line 318 of file wdfmemory.h.

SourceOffset

_Must_inspect_result_ _In_ size_t SourceOffset

Definition at line 320 of file wdfmemory.h.

WDF_MEMORY_DESCRIPTOR

typedef struct _WDF_MEMORY_DESCRIPTOR WDF_MEMORY_DESCRIPTOR

WDF_MEMORY_DESCRIPTOR_TYPE

typedef WDF_EXTERN_C_START enum _WDF_MEMORY_DESCRIPTOR_TYPE WDF_MEMORY_DESCRIPTOR_TYPE

WDFMEMORY_OFFSET

typedef struct _WDFMEMORY_OFFSET WDFMEMORY_OFFSET

Enumeration Type Documentation

_WDF_MEMORY_DESCRIPTOR_TYPE

enum _WDF_MEMORY_DESCRIPTOR_TYPE

Enumerator
WdfMemoryDescriptorTypeInvalid
WdfMemoryDescriptorTypeBuffer
WdfMemoryDescriptorTypeMdl
WdfMemoryDescriptorTypeHandle

Definition at line 52 of file wdfmemory.h.

                                         {
    WdfMemoryDescriptorTypeInvalid = 0,
    WdfMemoryDescriptorTypeBuffer,
    WdfMemoryDescriptorTypeMdl,
    WdfMemoryDescriptorTypeHandle,
} WDF_MEMORY_DESCRIPTOR_TYPE;

Function Documentation

_When_() [1/3]

_Must_inspect_result_ _In_ _Strict_type_match_ POOL_TYPE _In_opt_ ULONG _In_ _When_	(	BufferSize	= = 0,
		__drv_reportError(BufferSize cannot be zero)
	)

Definition at line 299 of file wdfmemory.h.

{
    return ((PFN_WDFMEMORYASSIGNBUFFER) WdfFunctions[WdfMemoryAssignBufferTableIndex])(WdfDriverGlobals, Memory, Buffer, BufferSize);
}

_When_() [2/3]

_Must_inspect_result_ _In_ size_t _In_ PVOID _In_ _When_	(	NumBytesToCopyFrom	= = 0,
		__drv_reportError(NumBytesToCopyFrom cannot be zero)
	)

Definition at line 381 of file wdfmemory.h.

{
    return ((PFN_WDFMEMORYCOPYFROMBUFFER) WdfFunctions[WdfMemoryCopyFromBufferTableIndex])(WdfDriverGlobals, DestinationMemory, DestinationOffset, Buffer, NumBytesToCopyFrom);
}

_When_() [3/3]

_Must_inspect_result_ _In_ size_t _In_ _When_	(	NumBytesToCopyTo	= = 0,
		__drv_reportError(NumBytesToCopyTo cannot be zero)
	)

Definition at line 340 of file wdfmemory.h.

{
    return ((PFN_WDFMEMORYCOPYTOBUFFER) WdfFunctions[WdfMemoryCopyToBufferTableIndex])(WdfDriverGlobals, SourceMemory, SourceOffset, Buffer, NumBytesToCopyTo);
}

WDF_MEMORY_DESCRIPTOR_INIT_BUFFER()

FORCEINLINE VOID WDF_MEMORY_DESCRIPTOR_INIT_BUFFER	(	_Out_ PWDF_MEMORY_DESCRIPTOR	Descriptor,
		_In_ PVOID	Buffer,
		_In_ ULONG	BufferLength
	)

Definition at line 102 of file wdfmemory.h.

{
    RtlZeroMemory(Descriptor, sizeof(WDF_MEMORY_DESCRIPTOR));
 
    Descriptor->Type = WdfMemoryDescriptorTypeBuffer;
    Descriptor->u.BufferType.Buffer = Buffer;
    Descriptor->u.BufferType.Length = BufferLength;
}

Referenced by _IRQL_requires_max_().

WDF_MEMORY_DESCRIPTOR_INIT_HANDLE()

FORCEINLINE VOID WDF_MEMORY_DESCRIPTOR_INIT_HANDLE	(	_Out_ PWDF_MEMORY_DESCRIPTOR	Descriptor,
		_In_ WDFMEMORY	Memory,
		_In_opt_ PWDFMEMORY_OFFSET	Offsets
	)

Definition at line 117 of file wdfmemory.h.

{
    RtlZeroMemory(Descriptor, sizeof(WDF_MEMORY_DESCRIPTOR));
 
    Descriptor->Type = WdfMemoryDescriptorTypeHandle;
    Descriptor->u.HandleType.Memory = Memory;
    Descriptor->u.HandleType.Offsets = Offsets;
}

WDF_MEMORY_DESCRIPTOR_INIT_MDL()

FORCEINLINE VOID WDF_MEMORY_DESCRIPTOR_INIT_MDL	(	_Out_ PWDF_MEMORY_DESCRIPTOR	Descriptor,
		_In_ PMDL	Mdl,
		_In_ ULONG	BufferLength
	)

Definition at line 133 of file wdfmemory.h.

{
    RtlZeroMemory(Descriptor, sizeof(WDF_MEMORY_DESCRIPTOR));
 
    Descriptor->Type = WdfMemoryDescriptorTypeMdl;
    Descriptor->u.MdlType.Mdl = Mdl;
    Descriptor->u.MdlType.BufferLength = BufferLength;
}