wdfio.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_IO_QUEUE_CONFIG
struct	_WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS
struct	_WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef WDF_EXTERN_C_START enum _WDF_IO_QUEUE_DISPATCH_TYPE	WDF_IO_QUEUE_DISPATCH_TYPE
typedef enum _WDF_IO_QUEUE_STATE	WDF_IO_QUEUE_STATE
typedef _In_ WDFREQUEST	Request
typedef EVT_WDF_IO_QUEUE_IO_DEFAULT *	PFN_WDF_IO_QUEUE_IO_DEFAULT
typedef _In_ WDFREQUEST _In_ ULONG	ActionFlags
typedef EVT_WDF_IO_QUEUE_IO_STOP *	PFN_WDF_IO_QUEUE_IO_STOP
typedef EVT_WDF_IO_QUEUE_IO_RESUME *	PFN_WDF_IO_QUEUE_IO_RESUME
typedef _In_ WDFREQUEST _In_ size_t	Length
typedef EVT_WDF_IO_QUEUE_IO_READ *	PFN_WDF_IO_QUEUE_IO_READ
typedef EVT_WDF_IO_QUEUE_IO_WRITE *	PFN_WDF_IO_QUEUE_IO_WRITE
typedef _In_ WDFREQUEST _In_ size_t	OutputBufferLength
typedef _In_ WDFREQUEST _In_ size_t _In_ size_t	InputBufferLength
typedef _In_ WDFREQUEST _In_ size_t _In_ size_t _In_ ULONG	IoControlCode
typedef EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL *	PFN_WDF_IO_QUEUE_IO_DEVICE_CONTROL
typedef EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL *	PFN_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL
typedef EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE *	PFN_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE
typedef _In_ WDFCONTEXT	Context
typedef EVT_WDF_IO_QUEUE_STATE *	PFN_WDF_IO_QUEUE_STATE
typedef struct _WDF_IO_QUEUE_CONFIG	WDF_IO_QUEUE_CONFIG
typedef struct _WDF_IO_QUEUE_CONFIG *	PWDF_IO_QUEUE_CONFIG
typedef enum _WDF_IO_FORWARD_PROGRESS_ACTION	WDF_IO_FORWARD_PROGRESS_ACTION
typedef enum _WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY	WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY
typedef EVT_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST *	PFN_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST
typedef EVT_WDF_IO_ALLOCATE_REQUEST_RESOURCES *	PFN_WDF_IO_ALLOCATE_REQUEST_RESOURCES
typedef _In_ PIRP	Irp
typedef EVT_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS *	PFN_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS
typedef struct _WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS	WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS
typedef struct _WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY
typedef struct _WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY *	PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY
typedef _Must_inspect_result_	_IRQL_requires_max_(DISPATCH_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFIOQUEUECREATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_IO_QUEUE_CONFIG	Config
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_IO_QUEUE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES	QueueAttributes
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_IO_QUEUE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES _Out_opt_ WDFQUEUE *	Queue
typedef _In_ WDFQUEUE _Out_opt_ PULONG	QueueRequests
typedef _In_ WDFQUEUE _Out_opt_ PULONG _Out_opt_ PULONG	DriverRequests
typedef _In_ WDFQUEUE	_When_(Context !=0, _In_) _When_(Context == 0
typedef _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE	StopComplete
typedef _Must_inspect_result_ _In_ WDFQUEUE _Out_ WDFREQUEST *	OutRequest
typedef _Must_inspect_result_ _In_ WDFQUEUE _In_ WDFFILEOBJECT	FileObject
typedef _Must_inspect_result_ _In_ WDFQUEUE _In_opt_ WDFREQUEST	FoundRequest
typedef _Must_inspect_result_ _In_ WDFQUEUE _In_opt_ WDFREQUEST _In_opt_ WDFFILEOBJECT _Inout_opt_ PWDF_REQUEST_PARAMETERS	Parameters
typedef _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE	DrainComplete
typedef _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE	PurgeComplete
typedef _Must_inspect_result_ _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE	QueueReady
typedef _Must_inspect_result_ _In_ WDFQUEUE _In_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	ForwardProgressPolicy
typedef _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE	StopAndPurgeComplete

Enumerations
enum	_WDF_IO_QUEUE_DISPATCH_TYPE {   WdfIoQueueDispatchInvalid = 0, WdfIoQueueDispatchSequential, WdfIoQueueDispatchParallel, WdfIoQueueDispatchManual,   WdfIoQueueDispatchMax }
enum	_WDF_IO_QUEUE_STATE {   WdfIoQueueAcceptRequests = 0x01, WdfIoQueueDispatchRequests = 0x02, WdfIoQueueNoRequests = 0x04, WdfIoQueueDriverNoRequests = 0x08,   WdfIoQueuePnpHeld = 0x10 }
enum	_WDF_IO_FORWARD_PROGRESS_ACTION { WdfIoForwardProgressActionInvalid = 0x0, WdfIoForwardProgressActionFailRequest, WdfIoForwardProgressActionUseReservedRequest }
enum	_WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY { WdfIoForwardProgressInvalidPolicy =0x0, WdfIoForwardProgressReservedPolicyAlwaysUseReservedRequest, WdfIoForwardProgressReservedPolicyUseExamine, WdfIoForwardProgressReservedPolicyPagingIO }

Functions
FORCEINLINE BOOLEAN	WDF_IO_QUEUE_IDLE (_In_ WDF_IO_QUEUE_STATE State)
FORCEINLINE BOOLEAN	WDF_IO_QUEUE_READY (_In_ WDF_IO_QUEUE_STATE State)
FORCEINLINE BOOLEAN	WDF_IO_QUEUE_STOPPED (_In_ WDF_IO_QUEUE_STATE State)
FORCEINLINE BOOLEAN	WDF_IO_QUEUE_DRAINED (_In_ WDF_IO_QUEUE_STATE State)
FORCEINLINE BOOLEAN	WDF_IO_QUEUE_PURGED (_In_ WDF_IO_QUEUE_STATE State)
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_DEFAULT) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_DEFAULT(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_STOP) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_STOP(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_RESUME) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_RESUME(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_READ) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_READ(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_WRITE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_WRITE(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_QUEUE_STATE) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) VOID STDCALL EVT_WDF_IO_QUEUE_STATE(_In_ WDFQUEUE Queue
FORCEINLINE VOID	WDF_IO_QUEUE_CONFIG_INIT (_Out_ PWDF_IO_QUEUE_CONFIG Config, _In_ WDF_IO_QUEUE_DISPATCH_TYPE DispatchType)
FORCEINLINE VOID	WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE (_Out_ PWDF_IO_QUEUE_CONFIG Config, _In_ WDF_IO_QUEUE_DISPATCH_TYPE DispatchType)
typedef	_Function_class_ (EVT_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) NTSTATUS STDCALL EVT_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_ALLOCATE_REQUEST_RESOURCES) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) NTSTATUS STDCALL EVT_WDF_IO_ALLOCATE_REQUEST_RESOURCES(_In_ WDFQUEUE Queue
typedef	_Function_class_ (EVT_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS) _IRQL_requires_same_ _IRQL_requires_max_(DISPATCH_LEVEL) WDF_IO_FORWARD_PROGRESS_ACTION STDCALL EVT_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS(_In_ WDFQUEUE Queue
FORCEINLINE VOID	WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_DEFAULT_INIT (_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Policy, _In_ ULONG TotalForwardProgressRequests)
FORCEINLINE VOID	WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_EXAMINE_INIT (_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Policy, _In_ ULONG TotalForwardProgressRequests, _In_ PFN_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS EvtIoWdmIrpForForwardProgress)
FORCEINLINE VOID	WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_PAGINGIO_INIT (_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY Policy, _In_ ULONG TotalForwardProgressRequests)
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) FORCEINLINE NTSTATUS WdfIoQueueCreate(_In_ WDFDEVICE Device
	_When_ (Context !=0, _In_) _When_(Context
_In_opt_ PFN_WDF_IO_QUEUE_STATE	_When_ (StopComplete !=0, _In_) _When_(StopComplete
typedef	_IRQL_requires_max_ (PASSIVE_LEVEL) WDFAPI VOID(STDCALL *PFN_WDFIOQUEUESTOPSYNCHRONOUSLY)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals
	Queries information details about a security descriptor. More...

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 40 of file wdfio.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 42 of file wdfio.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 41 of file wdfio.h.

Typedef Documentation

_IRQL_requires_max_

typedef _Must_inspect_result_ _IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI NTSTATUS(STDCALL *PFN_WDFIOQUEUEASSIGNFORWARDPROGRESSPOLICY)(_In_ PWDF_DRIVER_GLOBALS DriverGlobals

Definition at line 606 of file wdfio.h.

_When_

typedef _In_ WDFQUEUE _In_opt_ PFN_WDF_IO_QUEUE_STATE _When_(StopAndPurgeComplete !=0, _In_) _When_(StopAndPurgeComplete == 0

Definition at line 710 of file wdfio.h.

ActionFlags

typedef _In_ WDFREQUEST _In_ ULONG ActionFlags

Definition at line 252 of file wdfio.h.

Config

_Must_inspect_result_ _In_ PWDF_IO_QUEUE_CONFIG Config

Definition at line 613 of file wdfio.h.

Context

_In_opt_ PFN_WDF_IO_QUEUE_STATE _In_opt_ WDFCONTEXT Context

Initial value:

{
    ((PFN_WDFIOQUEUESTOP) WdfFunctions[WdfIoQueueStopTableIndex])(WdfDriverGlobals, Queue, StopComplete, Context)

Definition at line 378 of file wdfio.h.

Device

typedef _Must_inspect_result_ _In_ WDFDEVICE Device

Definition at line 613 of file wdfio.h.

DrainComplete

_In_opt_ PFN_WDF_IO_QUEUE_STATE DrainComplete

Definition at line 968 of file wdfio.h.

DriverRequests

_Out_opt_ PULONG _Out_opt_ PULONG DriverRequests

Initial value:

{
    return ((PFN_WDFIOQUEUEGETSTATE) WdfFunctions[WdfIoQueueGetStateTableIndex])(WdfDriverGlobals, Queue, QueueRequests, DriverRequests)

Definition at line 651 of file wdfio.h.

FileObject

_Must_inspect_result_ _In_opt_ WDFREQUEST _In_opt_ WDFFILEOBJECT FileObject

Definition at line 828 of file wdfio.h.

ForwardProgressPolicy

_Must_inspect_result_ _In_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY ForwardProgressPolicy

Initial value:

{
    return ((PFN_WDFIOQUEUEASSIGNFORWARDPROGRESSPOLICY) WdfFunctions[WdfIoQueueAssignForwardProgressPolicyTableIndex])(WdfDriverGlobals, Queue, ForwardProgressPolicy)

Definition at line 1100 of file wdfio.h.

FoundRequest

_Must_inspect_result_ _In_ WDFQUEUE _In_ WDFREQUEST FoundRequest

Definition at line 863 of file wdfio.h.

InputBufferLength

_In_opt_ HANDLE _In_opt_ PIO_APC_ROUTINE _In_opt_ PVOID _Out_ PIO_STATUS_BLOCK _In_ ULONG _In_ ULONG InputBufferLength

Definition at line 318 of file wdfio.h.

IoControlCode

typedef _In_ WDFREQUEST _In_ size_t _In_ size_t _In_ ULONG IoControlCode

Definition at line 318 of file wdfio.h.

Irp

typedef _In_ PIRP Irp

Definition at line 513 of file wdfio.h.

Length

typedef _In_ WDFREQUEST _In_ size_t Length

Definition at line 284 of file wdfio.h.

OutputBufferLength

_In_opt_ HANDLE _In_opt_ PIO_APC_ROUTINE _In_opt_ PVOID _Out_ PIO_STATUS_BLOCK _In_ ULONG _In_ ULONG _In_ ULONG OutputBufferLength

Definition at line 318 of file wdfio.h.

OutRequest

_Must_inspect_result_ _In_ WDFQUEUE _In_ WDFREQUEST _Out_ WDFREQUEST * OutRequest

Initial value:

{
    return ((PFN_WDFIOQUEUERETRIEVENEXTREQUEST) WdfFunctions[WdfIoQueueRetrieveNextRequestTableIndex])(WdfDriverGlobals, Queue, OutRequest)

Definition at line 797 of file wdfio.h.

Parameters

_In_ WDFREQUEST _Out_ PWDF_REQUEST_PARAMETERS Parameters

Initial value:

{
    ((PFN_WDFREQUESTGETPARAMETERS) WdfFunctions[WdfRequestGetParametersTableIndex])(WdfDriverGlobals, Request, Parameters)

Definition at line 863 of file wdfio.h.

PFN_WDF_IO_ALLOCATE_REQUEST_RESOURCES

typedef EVT_WDF_IO_ALLOCATE_REQUEST_RESOURCES* PFN_WDF_IO_ALLOCATE_REQUEST_RESOURCES

Definition at line 500 of file wdfio.h.

PFN_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST

typedef EVT_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST* PFN_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST

Definition at line 485 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE

typedef EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE* PFN_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE

Definition at line 364 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_DEFAULT

typedef EVT_WDF_IO_QUEUE_IO_DEFAULT* PFN_WDF_IO_QUEUE_IO_DEFAULT

Definition at line 239 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_DEVICE_CONTROL

typedef EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL* PFN_WDF_IO_QUEUE_IO_DEVICE_CONTROL

Definition at line 327 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL

typedef EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL* PFN_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL

Definition at line 348 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_READ

typedef EVT_WDF_IO_QUEUE_IO_READ* PFN_WDF_IO_QUEUE_IO_READ

Definition at line 289 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_RESUME

typedef EVT_WDF_IO_QUEUE_IO_RESUME* PFN_WDF_IO_QUEUE_IO_RESUME

Definition at line 272 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_STOP

typedef EVT_WDF_IO_QUEUE_IO_STOP* PFN_WDF_IO_QUEUE_IO_STOP

Definition at line 257 of file wdfio.h.

PFN_WDF_IO_QUEUE_IO_WRITE

typedef EVT_WDF_IO_QUEUE_IO_WRITE* PFN_WDF_IO_QUEUE_IO_WRITE

Definition at line 306 of file wdfio.h.

PFN_WDF_IO_QUEUE_STATE

typedef EVT_WDF_IO_QUEUE_STATE* PFN_WDF_IO_QUEUE_STATE

Definition at line 380 of file wdfio.h.

PFN_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS

typedef EVT_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS* PFN_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS

Definition at line 515 of file wdfio.h.

PurgeComplete

_In_opt_ PFN_WDF_IO_QUEUE_STATE PurgeComplete

Definition at line 1030 of file wdfio.h.

PWDF_IO_QUEUE_CONFIG

typedef struct _WDF_IO_QUEUE_CONFIG * PWDF_IO_QUEUE_CONFIG

PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY

typedef struct _WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY * PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY

Queue

typedef _In_ WDFQUEUE Queue

Initial value:

{
    return ((PFN_WDFIOQUEUECREATE) WdfFunctions[WdfIoQueueCreateTableIndex])(WdfDriverGlobals, Device, Config, QueueAttributes, Queue)

Definition at line 613 of file wdfio.h.

QueueAttributes

_Must_inspect_result_ _In_ PWDF_IO_QUEUE_CONFIG _In_opt_ PWDF_OBJECT_ATTRIBUTES QueueAttributes

Definition at line 613 of file wdfio.h.

QueueReady

_Must_inspect_result_ _In_opt_ PFN_WDF_IO_QUEUE_STATE QueueReady

Definition at line 1065 of file wdfio.h.

QueueRequests

_Out_opt_ PULONG QueueRequests

Definition at line 651 of file wdfio.h.

Request

typedef _In_ WDFREQUEST Request

Definition at line 237 of file wdfio.h.

StopAndPurgeComplete

_In_opt_ PFN_WDF_IO_QUEUE_STATE StopAndPurgeComplete

Definition at line 1133 of file wdfio.h.

StopComplete

_In_opt_ PFN_WDF_IO_QUEUE_STATE StopComplete

Definition at line 712 of file wdfio.h.

WDF_IO_FORWARD_PROGRESS_ACTION

typedef enum _WDF_IO_FORWARD_PROGRESS_ACTION WDF_IO_FORWARD_PROGRESS_ACTION

WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY

typedef enum _WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY

WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS

typedef struct _WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY_SETTINGS

WDF_IO_QUEUE_CONFIG

typedef struct _WDF_IO_QUEUE_CONFIG WDF_IO_QUEUE_CONFIG

WDF_IO_QUEUE_DISPATCH_TYPE

typedef WDF_EXTERN_C_START enum _WDF_IO_QUEUE_DISPATCH_TYPE WDF_IO_QUEUE_DISPATCH_TYPE

WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY

typedef struct _WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY

WDF_IO_QUEUE_STATE

typedef enum _WDF_IO_QUEUE_STATE WDF_IO_QUEUE_STATE

Enumeration Type Documentation

_WDF_IO_FORWARD_PROGRESS_ACTION

enum _WDF_IO_FORWARD_PROGRESS_ACTION

Enumerator
WdfIoForwardProgressActionInvalid
WdfIoForwardProgressActionFailRequest
WdfIoForwardProgressActionUseReservedRequest

Definition at line 459 of file wdfio.h.

                                             {
    WdfIoForwardProgressActionInvalid = 0x0,
    WdfIoForwardProgressActionFailRequest,
    WdfIoForwardProgressActionUseReservedRequest
} WDF_IO_FORWARD_PROGRESS_ACTION;

_WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY

enum _WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY

Enumerator
WdfIoForwardProgressInvalidPolicy
WdfIoForwardProgressReservedPolicyAlwaysUseReservedRequest
WdfIoForwardProgressReservedPolicyUseExamine
WdfIoForwardProgressReservedPolicyPagingIO

Definition at line 465 of file wdfio.h.

                                                       {
  WdfIoForwardProgressInvalidPolicy =0x0,
  WdfIoForwardProgressReservedPolicyAlwaysUseReservedRequest,
  WdfIoForwardProgressReservedPolicyUseExamine,
  WdfIoForwardProgressReservedPolicyPagingIO
} WDF_IO_FORWARD_PROGRESS_RESERVED_POLICY;

_WDF_IO_QUEUE_DISPATCH_TYPE

enum _WDF_IO_QUEUE_DISPATCH_TYPE

Enumerator
WdfIoQueueDispatchInvalid
WdfIoQueueDispatchSequential
WdfIoQueueDispatchParallel
WdfIoQueueDispatchManual
WdfIoQueueDispatchMax

Definition at line 76 of file wdfio.h.

                                         {
    WdfIoQueueDispatchInvalid = 0,
    WdfIoQueueDispatchSequential,
    WdfIoQueueDispatchParallel,
    WdfIoQueueDispatchManual,
    WdfIoQueueDispatchMax,
} WDF_IO_QUEUE_DISPATCH_TYPE;

_WDF_IO_QUEUE_STATE

enum _WDF_IO_QUEUE_STATE

Enumerator
WdfIoQueueAcceptRequests
WdfIoQueueDispatchRequests
WdfIoQueueNoRequests
WdfIoQueueDriverNoRequests
WdfIoQueuePnpHeld

Definition at line 124 of file wdfio.h.

                                 {
    WdfIoQueueAcceptRequests = 0x01,
    WdfIoQueueDispatchRequests = 0x02,
    WdfIoQueueNoRequests = 0x04,
    WdfIoQueueDriverNoRequests = 0x08,
    WdfIoQueuePnpHeld = 0x10,
} WDF_IO_QUEUE_STATE;

Function Documentation

_Function_class_() [1/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_DEFAULT

)

_Function_class_() [2/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_STOP

)

_Function_class_() [3/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_RESUME

)

_Function_class_() [4/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_READ

)

_Function_class_() [5/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_WRITE

)

_Function_class_() [6/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL

)

_Function_class_() [7/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL

)

_Function_class_() [8/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_IO_CANCELED_ON_QUEUE

)

_Function_class_() [9/12]

typedef _Function_class_

(

EVT_WDF_IO_QUEUE_STATE

)

_Function_class_() [10/12]

typedef _Function_class_

(

EVT_WDF_IO_ALLOCATE_RESOURCES_FOR_RESERVED_REQUEST

)

_Function_class_() [11/12]

typedef _Function_class_

(

EVT_WDF_IO_ALLOCATE_REQUEST_RESOURCES

)

_Function_class_() [12/12]

typedef _Function_class_

(

EVT_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS

)

_IRQL_requires_max_() [1/2]

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

Definition at line 687 of file wdfio.h.

{
    ((PFN_WDFIOQUEUESTART) WdfFunctions[WdfIoQueueStartTableIndex])(WdfDriverGlobals, Queue);
}

_IRQL_requires_max_() [2/2]

typedef _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 749 of file wdfio.h.

{
    ((PFN_WDFIOQUEUESTOPSYNCHRONOUSLY) WdfFunctions[WdfIoQueueStopSynchronouslyTableIndex])(WdfDriverGlobals, Queue);
}

_When_() [1/2]

_When_	(	Context !	= 0,
		_In_
	)

_When_() [2/2]

_In_opt_ PFN_WDF_IO_QUEUE_STATE _When_	(	StopComplete !	= 0,
		_In_
	)

WDF_IO_QUEUE_CONFIG_INIT()

FORCEINLINE VOID WDF_IO_QUEUE_CONFIG_INIT	(	_Out_ PWDF_IO_QUEUE_CONFIG	Config,
		_In_ WDF_IO_QUEUE_DISPATCH_TYPE	DispatchType
	)

Definition at line 426 of file wdfio.h.

{
    RtlZeroMemory(Config, sizeof(WDF_IO_QUEUE_CONFIG));

    Config->Size = sizeof(WDF_IO_QUEUE_CONFIG);
    Config->PowerManaged = WdfUseDefault;
    Config->DispatchType = DispatchType;
    if (Config->DispatchType == WdfIoQueueDispatchParallel) {
        Config->Settings.Parallel.NumberOfPresentedRequests = (ULONG)-1;
    }
}

Referenced by DriverEvtDeviceAdd(), and FxPkgGeneral::PostCreateDeviceInitialize().

WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE()

FORCEINLINE VOID WDF_IO_QUEUE_CONFIG_INIT_DEFAULT_QUEUE	(	_Out_ PWDF_IO_QUEUE_CONFIG	Config,
		_In_ WDF_IO_QUEUE_DISPATCH_TYPE	DispatchType
	)

Definition at line 443 of file wdfio.h.

{
    RtlZeroMemory(Config, sizeof(WDF_IO_QUEUE_CONFIG));

    Config->Size = sizeof(WDF_IO_QUEUE_CONFIG);
    Config->PowerManaged = WdfUseDefault;
    Config->DefaultQueue = TRUE;
    Config->DispatchType = DispatchType;
    if (Config->DispatchType == WdfIoQueueDispatchParallel) {
        Config->Settings.Parallel.NumberOfPresentedRequests = (ULONG)-1;
    }
}

Referenced by DriverEvtDeviceAdd().

WDF_IO_QUEUE_DRAINED()

FORCEINLINE BOOLEAN WDF_IO_QUEUE_DRAINED

(

_In_ WDF_IO_QUEUE_STATE

State

)

Definition at line 194 of file wdfio.h.

{
    return ( ((State & WdfIoQueueAcceptRequests)==0) &&
          (State & WdfIoQueueDispatchRequests) &&
          (State & WdfIoQueueNoRequests)  &&
          (State & WdfIoQueueDriverNoRequests) ) ? TRUE: FALSE;

}

WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_DEFAULT_INIT()

FORCEINLINE VOID WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_DEFAULT_INIT	(	_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	Policy,
		_In_ ULONG	TotalForwardProgressRequests
	)

Definition at line 556 of file wdfio.h.

{
    RtlZeroMemory(Policy, sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY));

    Policy->Size = sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY);
    Policy->TotalForwardProgressRequests = TotalForwardProgressRequests;
    Policy->ForwardProgressReservedPolicy = WdfIoForwardProgressReservedPolicyAlwaysUseReservedRequest;
}

WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_EXAMINE_INIT()

FORCEINLINE VOID WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_EXAMINE_INIT	(	_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	Policy,
		_In_ ULONG	TotalForwardProgressRequests,
		_In_ PFN_WDF_IO_WDM_IRP_FOR_FORWARD_PROGRESS	EvtIoWdmIrpForForwardProgress
	)

Definition at line 571 of file wdfio.h.

{
    RtlZeroMemory(Policy, sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY));

    Policy->Size = sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY);
    Policy->TotalForwardProgressRequests = TotalForwardProgressRequests;
    Policy->ForwardProgressReservedPolicy =  WdfIoForwardProgressReservedPolicyUseExamine;
    Policy->ForwardProgressReservePolicySettings.Policy.ExaminePolicy.EvtIoWdmIrpForForwardProgress =
            EvtIoWdmIrpForForwardProgress;
}

WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_PAGINGIO_INIT()

FORCEINLINE VOID WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY_PAGINGIO_INIT	(	_Out_ PWDF_IO_QUEUE_FORWARD_PROGRESS_POLICY	Policy,
		_In_ ULONG	TotalForwardProgressRequests
	)

Definition at line 588 of file wdfio.h.

{
    RtlZeroMemory(Policy, sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY));

    Policy->Size = sizeof(WDF_IO_QUEUE_FORWARD_PROGRESS_POLICY);
    Policy->TotalForwardProgressRequests = TotalForwardProgressRequests;
    Policy->ForwardProgressReservedPolicy = WdfIoForwardProgressReservedPolicyPagingIO;
}

WDF_IO_QUEUE_IDLE()

FORCEINLINE BOOLEAN WDF_IO_QUEUE_IDLE

(

_In_ WDF_IO_QUEUE_STATE

State

)

Definition at line 146 of file wdfio.h.

{
    return ((State & WdfIoQueueNoRequests) &&
            (State & WdfIoQueueDriverNoRequests)) ? TRUE: FALSE;
}

WDF_IO_QUEUE_PURGED()

FORCEINLINE BOOLEAN WDF_IO_QUEUE_PURGED

(

_In_ WDF_IO_QUEUE_STATE

State

)

Definition at line 212 of file wdfio.h.

{
    return ( ((State & WdfIoQueueAcceptRequests)==0) &&
          (State & WdfIoQueueNoRequests) &&
          (State & WdfIoQueueDriverNoRequests) ) ? TRUE: FALSE;

}

WDF_IO_QUEUE_READY()

FORCEINLINE BOOLEAN WDF_IO_QUEUE_READY

(

_In_ WDF_IO_QUEUE_STATE

State

)

Definition at line 160 of file wdfio.h.

{
    return ((State & WdfIoQueueDispatchRequests) &&
        (State & WdfIoQueueAcceptRequests) &&
        ((State & WdfIoQueuePnpHeld)==0)) ? TRUE: FALSE;
}

WDF_IO_QUEUE_STOPPED()

FORCEINLINE BOOLEAN WDF_IO_QUEUE_STOPPED

(

_In_ WDF_IO_QUEUE_STATE

State

)

Definition at line 176 of file wdfio.h.

{
    return (((State & WdfIoQueueDispatchRequests) == 0) &&
        (State & WdfIoQueueAcceptRequests) &&
        (State & WdfIoQueueDriverNoRequests)) ? TRUE: FALSE;

}