wdfdriver.h File Reference

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

Go to the source code of this file.

Classes
struct	_WDF_DRIVER_CONFIG
struct	_WDF_DRIVER_VERSION_AVAILABLE_PARAMS

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END
#define	WDF_TRACE_ID   ('TRAC')

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_DRIVER_INIT_FLAGS	WDF_DRIVER_INIT_FLAGS
typedef _Inout_ PWDFDEVICE_INIT	DeviceInit
typedef EVT_WDF_DRIVER_DEVICE_ADD *	PFN_WDF_DRIVER_DEVICE_ADD
typedef EVT_WDF_DRIVER_UNLOAD *	PFN_WDF_DRIVER_UNLOAD
typedef _In_opt_ PVOID	dataPath
typedef _In_opt_ PVOID _In_ ULONG	bufferLength
typedef _In_opt_ PVOID _In_ ULONG	_Inout_updates_bytes_(bufferLength) PVOID buffer
typedef _In_opt_ PVOID _In_ ULONG _In_ PVOID	context
typedef _In_opt_ PVOID _In_ ULONG _In_ PVOID _Out_ PULONG	size
typedef EVT_WDF_TRACE_CALLBACK *	PFN_WDF_TRACE_CALLBACK
typedef struct _WDF_DRIVER_CONFIG	WDF_DRIVER_CONFIG
typedef struct _WDF_DRIVER_CONFIG *	PWDF_DRIVER_CONFIG
typedef struct _WDF_DRIVER_VERSION_AVAILABLE_PARAMS	WDF_DRIVER_VERSION_AVAILABLE_PARAMS
typedef struct _WDF_DRIVER_VERSION_AVAILABLE_PARAMS *	PWDF_DRIVER_VERSION_AVAILABLE_PARAMS
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFDRIVERCREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT	DriverObject
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING	RegistryPath
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES	DriverAttributes
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PWDF_DRIVER_CONFIG	DriverConfig
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PWDF_DRIVER_CONFIG _Out_opt_ WDFDRIVER *	Driver
typedef _Must_inspect_result_ _In_ WDFDRIVER _In_ ACCESS_MASK	DesiredAccess
typedef _Must_inspect_result_ _In_ WDFDRIVER _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES	KeyAttributes
typedef _Must_inspect_result_ _In_ WDFDRIVER _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFKEY *	Key
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PFN_WDF_TRACE_CALLBACK	EvtTraceCallback
typedef _Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PFN_WDF_TRACE_CALLBACK _In_ PVOID	ControlBlock
typedef _Must_inspect_result_ _In_ WDFDRIVER _In_ WDFSTRING	String
typedef _Must_inspect_result_ _In_ WDFDRIVER _In_ PWDF_DRIVER_VERSION_AVAILABLE_PARAMS	VersionAvailableParams

Enumerations
enum	_WDF_DRIVER_INIT_FLAGS { WdfDriverInitNonPnpDriver = 0x00000001, WdfDriverInitNoDispatchOverride = 0x00000002, WdfVerifyOn = 0x00000004, WdfVerifierOn = 0x00000008 }

Functions
typedef	_Function_class_ (EVT_WDF_DRIVER_DEVICE_ADD) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DRIVER_DEVICE_ADD(_In_ WDFDRIVER Driver
typedef	_Function_class_ (EVT_WDF_DRIVER_UNLOAD) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_DRIVER_UNLOAD(_In_ WDFDRIVER Driver)
typedef	_Function_class_ (EVT_WDF_TRACE_CALLBACK) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_TRACE_CALLBACK(_In_ UCHAR minorFunction
FORCEINLINE VOID	WDF_DRIVER_CONFIG_INIT (_Out_ PWDF_DRIVER_CONFIG Config, _In_opt_ PFN_WDF_DRIVER_DEVICE_ADD EvtDriverDeviceAdd)
FORCEINLINE VOID	WDF_DRIVER_VERSION_AVAILABLE_PARAMS_INIT (_Out_ PWDF_DRIVER_VERSION_AVAILABLE_PARAMS Params, _In_ ULONG MajorVersion, _In_ ULONG MinorVersion)
FORCEINLINE WDFDRIVER	WdfGetDriver (VOID)
_Must_inspect_result_	_IRQL_requires_max_ (PASSIVE_LEVEL) FORCEINLINE NTSTATUS WdfDriverCreate(_In_ PDRIVER_OBJECT DriverObject
	Queries information details about a security descriptor. More...
typedef	_IRQL_requires_max_ (DISPATCH_LEVEL) WDFAPI PDRIVER_OBJECT(STDCALL *PFN_WDFDRIVERWDMGETDRIVEROBJECT)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfdriver.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfdriver.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfdriver.h.

WDF_TRACE_ID

#define WDF_TRACE_ID   ('TRAC')

Definition at line 59 of file wdfdriver.h.

Typedef Documentation

_Inout_updates_bytes_

typedef _In_opt_ PVOID _In_ ULONG _Inout_updates_bytes_(bufferLength) PVOID buffer

Definition at line 110 of file wdfdriver.h.

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI BOOLEAN(STDCALL *PFN_WDFDRIVERISVERSIONAVAILABLE)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 206 of file wdfdriver.h.

bufferLength

typedef _In_opt_ PVOID _In_ ULONG bufferLength

Definition at line 107 of file wdfdriver.h.

context

typedef _In_opt_ PVOID _In_ ULONG _In_ PVOID context

Definition at line 113 of file wdfdriver.h.

ControlBlock

_Must_inspect_result_ _In_ PFN_WDF_TRACE_CALLBACK _In_ PVOID ControlBlock

Initial value:

{
    return ((PFN_WDFDRIVERREGISTERTRACEINFO) WdfFunctions[WdfDriverRegisterTraceInfoTableIndex])(WdfDriverGlobals, DriverObject, EvtTraceCallback, ControlBlock)

Definition at line 370 of file wdfdriver.h.

dataPath

typedef _In_opt_ PVOID dataPath

Definition at line 107 of file wdfdriver.h.

DesiredAccess

_Must_inspect_result_ _In_ ACCESS_MASK DesiredAccess

Definition at line 306 of file wdfdriver.h.

DeviceInit

typedef _Inout_ PWDFDEVICE_INIT DeviceInit

Definition at line 76 of file wdfdriver.h.

Driver

typedef _Must_inspect_result_ _In_ WDFDRIVER Driver

Initial value:

{
    return ((PFN_WDFDRIVERCREATE) WdfFunctions[WdfDriverCreateTableIndex])(WdfDriverGlobals, DriverObject, RegistryPath, DriverAttributes, DriverConfig, Driver)

Definition at line 213 of file wdfdriver.h.

DriverAttributes

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES DriverAttributes

Definition at line 213 of file wdfdriver.h.

DriverConfig

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_opt_ PWDF_OBJECT_ATTRIBUTES _In_ PWDF_DRIVER_CONFIG DriverConfig

Definition at line 213 of file wdfdriver.h.

DriverObject

_Must_inspect_result_ _In_ PDRIVER_OBJECT DriverObject

Initial value:

{
    PAGED_CODE_LOCKED()

Definition at line 213 of file wdfdriver.h.

EvtTraceCallback

_Must_inspect_result_ _In_ PFN_WDF_TRACE_CALLBACK EvtTraceCallback

Definition at line 370 of file wdfdriver.h.

Key

_Must_inspect_result_ _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFKEY* Key

Initial value:

{
    return ((PFN_WDFDRIVEROPENPARAMETERSREGISTRYKEY) WdfFunctions[WdfDriverOpenParametersRegistryKeyTableIndex])(WdfDriverGlobals, Driver, DesiredAccess, KeyAttributes, Key)

Definition at line 306 of file wdfdriver.h.

KeyAttributes

_Must_inspect_result_ _In_ ACCESS_MASK _In_opt_ PWDF_OBJECT_ATTRIBUTES KeyAttributes

Definition at line 306 of file wdfdriver.h.

PFN_WDF_DRIVER_DEVICE_ADD

typedef EVT_WDF_DRIVER_DEVICE_ADD* PFN_WDF_DRIVER_DEVICE_ADD

Definition at line 78 of file wdfdriver.h.

PFN_WDF_DRIVER_UNLOAD

typedef EVT_WDF_DRIVER_UNLOAD* PFN_WDF_DRIVER_UNLOAD

Definition at line 91 of file wdfdriver.h.

PFN_WDF_TRACE_CALLBACK

typedef EVT_WDF_TRACE_CALLBACK* PFN_WDF_TRACE_CALLBACK

Definition at line 118 of file wdfdriver.h.

PWDF_DRIVER_CONFIG

typedef struct _WDF_DRIVER_CONFIG * PWDF_DRIVER_CONFIG

PWDF_DRIVER_VERSION_AVAILABLE_PARAMS

typedef struct _WDF_DRIVER_VERSION_AVAILABLE_PARAMS * PWDF_DRIVER_VERSION_AVAILABLE_PARAMS

RegistryPath

_Must_inspect_result_ _In_ PCUNICODE_STRING RegistryPath

Definition at line 213 of file wdfdriver.h.

size

typedef _In_opt_ PVOID _In_ ULONG _In_ PVOID _Out_ PULONG size

Definition at line 113 of file wdfdriver.h.

String

_Must_inspect_result_ _In_ WDFSTRING String

Initial value:

{
    return ((PFN_WDFDRIVERRETRIEVEVERSIONSTRING) WdfFunctions[WdfDriverRetrieveVersionStringTableIndex])(WdfDriverGlobals, Driver, String)

Definition at line 405 of file wdfdriver.h.

VersionAvailableParams

_Must_inspect_result_ _In_ PWDF_DRIVER_VERSION_AVAILABLE_PARAMS VersionAvailableParams

Initial value:

{
    return ((PFN_WDFDRIVERISVERSIONAVAILABLE) WdfFunctions[WdfDriverIsVersionAvailableTableIndex])(WdfDriverGlobals, Driver, VersionAvailableParams)

Definition at line 436 of file wdfdriver.h.

WDF_DRIVER_CONFIG

typedef struct _WDF_DRIVER_CONFIG WDF_DRIVER_CONFIG

WDF_DRIVER_INIT_FLAGS

typedef WDF_EXTERN_C_START enum _WDF_DRIVER_INIT_FLAGS WDF_DRIVER_INIT_FLAGS

WDF_DRIVER_VERSION_AVAILABLE_PARAMS

typedef struct _WDF_DRIVER_VERSION_AVAILABLE_PARAMS WDF_DRIVER_VERSION_AVAILABLE_PARAMS

Enumeration Type Documentation

_WDF_DRIVER_INIT_FLAGS

enum _WDF_DRIVER_INIT_FLAGS

Enumerator
WdfDriverInitNonPnpDriver
WdfDriverInitNoDispatchOverride
WdfVerifyOn
WdfVerifierOn

Definition at line 50 of file wdfdriver.h.

                                    {
    WdfDriverInitNonPnpDriver = 0x00000001, //  If set, no Add Device routine is assigned.
    WdfDriverInitNoDispatchOverride = 0x00000002, //  Useful for miniports.
    WdfVerifyOn = 0x00000004, //  Controls whether WDFVERIFY macros are live.
    WdfVerifierOn = 0x00000008, //  Top level verififer flag.
} WDF_DRIVER_INIT_FLAGS;

Function Documentation

_Function_class_() [1/3]

typedef _Function_class_

(

EVT_WDF_DRIVER_DEVICE_ADD

)

_Function_class_() [2/3]

typedef _Function_class_

(

EVT_WDF_DRIVER_UNLOAD

)

_Function_class_() [3/3]

typedef _Function_class_

(

EVT_WDF_TRACE_CALLBACK

)

_IRQL_requires_max_() [1/2]

_Must_inspect_result_ _IRQL_requires_max_

(

PASSIVE_LEVEL

)

Queries information details about a security descriptor.

Computes the quota size of a security descriptor.

Assigns a security descriptor for a new object.

An extended function that assigns a security descriptor for a new object.

Frees a security descriptor.

An extended function that sets new information data to a security descriptor.

Modifies some information data about a security descriptor.

Parameters

[in]	SecurityInformation	Security information details to be queried from a security descriptor.
[out]	SecurityDescriptor	The returned security descriptor with security information data.
[in,out]	Length	The returned length of a security descriptor.
[in,out]	ObjectsSecurityDescriptor	The returned object security descriptor.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the specific information about the security descriptor has been queried. STATUS_BUFFER_TOO_SMALL is returned if the buffer size is too small to contain the queried info about the security descriptor.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

See SeSetSecurityDescriptorInfoEx.

Parameters

[in]	Object	If specified, the function will use this arbitrary object that points to an object security descriptor.
[in]	SecurityInformation	Security information details to be set.
[in]	SecurityDescriptor	A security descriptor where its info is to be changed.
[in,out]	ObjectsSecurityDescriptor	The returned pointer to security descriptor objects.
[in]	AutoInheritFlags	Flags bitmask inheritation, influencing how the security descriptor can be inherited and if it can be in the first place.
[in]	PoolType	Pool type for the new security descriptor to allocate.
[in]	GenericMapping	The generic mapping of access rights masks.

Returns

Returns STATUS_SUCCESS if the operations have been completed without problems and that new info has been set to the security descriptor. STATUS_NO_SECURITY_ON_OBJECT is returned if the object does not have a security descriptor. STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the new security descriptor with new info set has failed.

Parameters

[in]

SecurityDescriptor

A security descriptor to be freed from memory.

Returns

Returns STATUS_SUCCESS.

Parameters

[in]	_ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	_ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	ObjectType	The type of the new object.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	AutoInheritFlags	Automatic inheritance flags that influence how access control entries within ACLs from security descriptors are inherited.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

Returns STATUS_SUCCESS if the operations have been completed successfully and that the security descriptor has been assigned to the new object. STATUS_NO_TOKEN is returned if the caller hasn't supplied a valid argument to a security subject context. STATUS_INVALID_OWNER is returned if the caller hasn't supplied a parent descriptor that belongs to the main user (owner). STATUS_INVALID_PRIMARY_GROUP is returned by the same reason as with the previous NTSTATUS code. The two NTSTATUS codes are returned if the calling thread stated that the owner and/or group is defaulted to the parent descriptor (SEF_DEFAULT_OWNER_FROM_PARENT and/or SEF_DEFAULT_GROUP_FROM_PARENT respectively). STATUS_INSUFFICIENT_RESOURCES is returned if memory pool allocation for the descriptor buffer has failed. A failure NTSTATUS is returned otherwise.

Parameters

[in]	ParentDescriptor	A security descriptor of the parent object that is being created.
[in]	ExplicitDescriptor	An explicit security descriptor that is applied to a new object.
[out]	NewDescriptor	The new allocated security descriptor.
[in]	IsDirectoryObject	Set this to TRUE if the newly created object is a directory object, otherwise set this to FALSE.
[in]	SubjectContext	Security subject context of the new object.
[in]	GenericMapping	Generic mapping of access mask rights.
[in]	PoolType	This parameter is unused.

Returns

See SeAssignSecurityEx.

Parameters

[in]	SecurityDescriptor	A security descriptor.
[out]	QuotaInfoSize	The returned quota size of the given security descriptor to the caller. The function may return 0 to this parameter if the descriptor doesn't have a group or a discretionary access control list (DACL) even.

Returns

Returns STATUS_SUCCESS if the quota size of a security descriptor has been computed successfully. STATUS_UNKNOWN_REVISION is returned if the security descriptor has an invalid revision.

Definition at line 258 of file wdfdriver.h.

{
    return ((PFN_WDFDRIVERGETREGISTRYPATH) WdfFunctions[WdfDriverGetRegistryPathTableIndex])(WdfDriverGlobals, Driver);
}

_IRQL_requires_max_() [2/2]

typedef _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 283 of file wdfdriver.h.

{
    return ((PFN_WDFDRIVERWDMGETDRIVEROBJECT) WdfFunctions[WdfDriverWdmGetDriverObjectTableIndex])(WdfDriverGlobals, Driver);
}

WDF_DRIVER_CONFIG_INIT()

FORCEINLINE VOID WDF_DRIVER_CONFIG_INIT	(	_Out_ PWDF_DRIVER_CONFIG	Config,
		_In_opt_ PFN_WDF_DRIVER_DEVICE_ADD	EvtDriverDeviceAdd
	)

Definition at line 148 of file wdfdriver.h.

{
    RtlZeroMemory(Config, sizeof(WDF_DRIVER_CONFIG));

    Config->Size = sizeof(WDF_DRIVER_CONFIG);
    Config->EvtDriverDeviceAdd = EvtDriverDeviceAdd;
}

Referenced by DriverEntry(), and FxDriver::FxDriver().

WDF_DRIVER_VERSION_AVAILABLE_PARAMS_INIT()

FORCEINLINE VOID WDF_DRIVER_VERSION_AVAILABLE_PARAMS_INIT	(	_Out_ PWDF_DRIVER_VERSION_AVAILABLE_PARAMS	Params,
		_In_ ULONG	MajorVersion,
		_In_ ULONG	MinorVersion
	)

Definition at line 179 of file wdfdriver.h.

{
    RtlZeroMemory(Params, sizeof(WDF_DRIVER_VERSION_AVAILABLE_PARAMS));

    Params->Size = sizeof(WDF_DRIVER_VERSION_AVAILABLE_PARAMS);
    Params->MajorVersion = MajorVersion;
    Params->MinorVersion = MinorVersion;
}

WdfGetDriver()

FORCEINLINE WDFDRIVER WdfGetDriver

(

VOID

)

Definition at line 194 of file wdfdriver.h.

{
    return WdfDriverGlobals->Driver;
}