wdfpdo.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_PDO_EVENT_CALLBACKS

Macros
#define	WDF_EXTERN_C
#define	WDF_EXTERN_C_START
#define	WDF_EXTERN_C_END

Typedefs
typedef EVT_WDF_DEVICE_RESOURCES_QUERY *	PFN_WDF_DEVICE_RESOURCES_QUERY
typedef _In_ WDFIORESREQLIST	IoResourceRequirementsList
typedef EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY *	PFN_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY
typedef EVT_WDF_DEVICE_EJECT *	PFN_WDF_DEVICE_EJECT
typedef _In_ BOOLEAN	IsLocked
typedef EVT_WDF_DEVICE_SET_LOCK *	PFN_WDF_DEVICE_SET_LOCK
typedef _In_ SYSTEM_POWER_STATE	PowerState
typedef EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS *	PFN_WDF_DEVICE_ENABLE_WAKE_AT_BUS
typedef EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS *	PFN_WDF_DEVICE_DISABLE_WAKE_AT_BUS
typedef EVT_WDF_DEVICE_REPORTED_MISSING *	PFN_WDF_DEVICE_REPORTED_MISSING
typedef struct _WDF_PDO_EVENT_CALLBACKS	WDF_PDO_EVENT_CALLBACKS
typedef struct _WDF_PDO_EVENT_CALLBACKS *	PWDF_PDO_EVENT_CALLBACKS
typedef _Must_inspect_result_	_IRQL_requires_max_(PASSIVE_LEVEL) WDFAPI PWDFDEVICE_INIT(STDCALL *PFN_WDFPDOINITALLOCATE) (_In_ PWDF_DRIVER_GLOBALS DriverGlobals
typedef _Must_inspect_result_ _In_ WDFDEVICE	ParentDevice
typedef _In_ PWDFDEVICE_INIT	DeviceInit
typedef _In_ PWDFDEVICE_INIT _In_ PWDF_PDO_EVENT_CALLBACKS	DispatchTable
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	DeviceID
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	InstanceID
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	HardwareID
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	CompatibleID
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	ContainerID
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING	DeviceDescription
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING _In_ PCUNICODE_STRING	DeviceLocation
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ PCUNICODE_STRING _In_ PCUNICODE_STRING _In_ LCID	LocaleId
typedef _Must_inspect_result_ _In_ PWDFDEVICE_INIT _In_ CONST GUID *	DeviceClassGuid
typedef _Must_inspect_result_ _In_ WDFDEVICE	Device
typedef _Must_inspect_result_ _In_ WDFDEVICE _Inout_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER	IdentificationDescription
typedef _Must_inspect_result_ _In_ WDFDEVICE _Inout_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER	AddressDescription
typedef _Must_inspect_result_ _In_ WDFDEVICE _In_ PDEVICE_OBJECT	PhysicalDevice

Functions
WDF_EXTERN_C_START typedef	_Function_class_ (EVT_WDF_DEVICE_RESOURCES_QUERY) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DEVICE_RESOURCES_QUERY(_In_ WDFDEVICE Device
typedef	_Function_class_ (EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY(_In_ WDFDEVICE Device
typedef	_Function_class_ (EVT_WDF_DEVICE_EJECT) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DEVICE_EJECT(_In_ WDFDEVICE Device)
typedef	_Function_class_ (EVT_WDF_DEVICE_SET_LOCK) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DEVICE_SET_LOCK(_In_ WDFDEVICE Device
typedef	_Function_class_ (EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS STDCALL EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS(_In_ WDFDEVICE Device
typedef	_Function_class_ (EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS(_In_ WDFDEVICE Device)
typedef	_Function_class_ (EVT_WDF_DEVICE_REPORTED_MISSING) _IRQL_requires_same_ _IRQL_requires_max_(PASSIVE_LEVEL) VOID STDCALL EVT_WDF_DEVICE_REPORTED_MISSING(_In_ WDFDEVICE Device)
FORCEINLINE VOID	WDF_PDO_EVENT_CALLBACKS_INIT (_Out_ PWDF_PDO_EVENT_CALLBACKS Callbacks)
_Must_inspect_result_	_IRQL_requires_max_ (DISPATCH_LEVEL) FORCEINLINE NTSTATUS WdfPdoMarkMissing(_In_ WDFDEVICE Device)

Variables
WDF_EXTERN_C_START typedef _In_ WDFCMRESLIST	Resources

Macro Definition Documentation

WDF_EXTERN_C

#define WDF_EXTERN_C

Definition at line 38 of file wdfpdo.h.

WDF_EXTERN_C_END

#define WDF_EXTERN_C_END

Definition at line 40 of file wdfpdo.h.

WDF_EXTERN_C_START

#define WDF_EXTERN_C_START

Definition at line 39 of file wdfpdo.h.

Typedef Documentation

_IRQL_requires_max_

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

Definition at line 212 of file wdfpdo.h.

AddressDescription

_Must_inspect_result_ _Inout_ PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER AddressDescription

Initial value:

{
    return ((PFN_WDFPDORETRIEVEADDRESSDESCRIPTION) WdfFunctions[WdfPdoRetrieveAddressDescriptionTableIndex])(WdfDriverGlobals, Device, AddressDescription)

Definition at line 664 of file wdfpdo.h.

CompatibleID

_Must_inspect_result_ _In_ PCUNICODE_STRING CompatibleID

Initial value:

{
    return ((PFN_WDFPDOINITADDCOMPATIBLEID) WdfFunctions[WdfPdoInitAddCompatibleIDTableIndex])(WdfDriverGlobals, DeviceInit, CompatibleID)

Definition at line 370 of file wdfpdo.h.

ContainerID

_Must_inspect_result_ _In_ PCUNICODE_STRING ContainerID

Initial value:

{
    return ((PFN_WDFPDOINITASSIGNCONTAINERID) WdfFunctions[WdfPdoInitAssignContainerIDTableIndex])(WdfDriverGlobals, DeviceInit, ContainerID)

Definition at line 401 of file wdfpdo.h.

Device

typedef _In_ WDFDEVICE Device

Definition at line 554 of file wdfpdo.h.

DeviceClassGuid

_Must_inspect_result_ _In_ CONST GUID* DeviceClassGuid

Initial value:

{
    return ((PFN_WDFPDOINITASSIGNRAWDEVICE) WdfFunctions[WdfPdoInitAssignRawDeviceTableIndex])(WdfDriverGlobals, DeviceInit, DeviceClassGuid)

Definition at line 500 of file wdfpdo.h.

DeviceDescription

_Must_inspect_result_ _In_ PCUNICODE_STRING DeviceDescription

Definition at line 432 of file wdfpdo.h.

DeviceID

_Must_inspect_result_ _In_ PCUNICODE_STRING DeviceID

Initial value:

{
    return ((PFN_WDFPDOINITASSIGNDEVICEID) WdfFunctions[WdfPdoInitAssignDeviceIDTableIndex])(WdfDriverGlobals, DeviceInit, DeviceID)

Definition at line 277 of file wdfpdo.h.

DeviceInit

typedef _In_ PWDFDEVICE_INIT DeviceInit

Definition at line 245 of file wdfpdo.h.

DeviceLocation

_Must_inspect_result_ _In_ PCUNICODE_STRING _In_ PCUNICODE_STRING DeviceLocation

Definition at line 434 of file wdfpdo.h.

DispatchTable

_In_ PWDF_PDO_EVENT_CALLBACKS DispatchTable

Initial value:

{
    ((PFN_WDFPDOINITSETEVENTCALLBACKS) WdfFunctions[WdfPdoInitSetEventCallbacksTableIndex])(WdfDriverGlobals, DeviceInit, DispatchTable)

Definition at line 247 of file wdfpdo.h.

HardwareID

_Must_inspect_result_ _In_ PCUNICODE_STRING HardwareID

Initial value:

{
    return ((PFN_WDFPDOINITADDHARDWAREID) WdfFunctions[WdfPdoInitAddHardwareIDTableIndex])(WdfDriverGlobals, DeviceInit, HardwareID)

Definition at line 339 of file wdfpdo.h.

IdentificationDescription

_Must_inspect_result_ _Inout_ PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription

Initial value:

{
    return ((PFN_WDFPDORETRIEVEIDENTIFICATIONDESCRIPTION) WdfFunctions[WdfPdoRetrieveIdentificationDescriptionTableIndex])(WdfDriverGlobals, Device, IdentificationDescription)

Definition at line 633 of file wdfpdo.h.

InstanceID

_Must_inspect_result_ _In_ PCUNICODE_STRING InstanceID

Initial value:

{
    return ((PFN_WDFPDOINITASSIGNINSTANCEID) WdfFunctions[WdfPdoInitAssignInstanceIDTableIndex])(WdfDriverGlobals, DeviceInit, InstanceID)

Definition at line 308 of file wdfpdo.h.

IoResourceRequirementsList

typedef _In_ WDFIORESREQLIST IoResourceRequirementsList

Definition at line 77 of file wdfpdo.h.

IsLocked

typedef _In_ BOOLEAN IsLocked

Definition at line 105 of file wdfpdo.h.

LocaleId

_In_ PWDFDEVICE_INIT _In_ LCID LocaleId

Initial value:

{
    return ((PFN_WDFPDOINITADDDEVICETEXT) WdfFunctions[WdfPdoInitAddDeviceTextTableIndex])(WdfDriverGlobals, DeviceInit, DeviceDescription, DeviceLocation, LocaleId)

Definition at line 436 of file wdfpdo.h.

ParentDevice

typedef _Must_inspect_result_ _In_ WDFDEVICE ParentDevice

Definition at line 219 of file wdfpdo.h.

PFN_WDF_DEVICE_DISABLE_WAKE_AT_BUS

typedef EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS* PFN_WDF_DEVICE_DISABLE_WAKE_AT_BUS

Definition at line 136 of file wdfpdo.h.

PFN_WDF_DEVICE_EJECT

typedef EVT_WDF_DEVICE_EJECT* PFN_WDF_DEVICE_EJECT

Definition at line 93 of file wdfpdo.h.

PFN_WDF_DEVICE_ENABLE_WAKE_AT_BUS

typedef EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS* PFN_WDF_DEVICE_ENABLE_WAKE_AT_BUS

Definition at line 123 of file wdfpdo.h.

PFN_WDF_DEVICE_REPORTED_MISSING

typedef EVT_WDF_DEVICE_REPORTED_MISSING* PFN_WDF_DEVICE_REPORTED_MISSING

Definition at line 149 of file wdfpdo.h.

PFN_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY

typedef EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY* PFN_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY

Definition at line 80 of file wdfpdo.h.

PFN_WDF_DEVICE_RESOURCES_QUERY

typedef EVT_WDF_DEVICE_RESOURCES_QUERY* PFN_WDF_DEVICE_RESOURCES_QUERY

Definition at line 65 of file wdfpdo.h.

PFN_WDF_DEVICE_SET_LOCK

typedef EVT_WDF_DEVICE_SET_LOCK* PFN_WDF_DEVICE_SET_LOCK

Definition at line 108 of file wdfpdo.h.

PhysicalDevice

_In_ PDEVICE_OBJECT PhysicalDevice

Initial value:

{
    return ((PFN_WDFPDOADDEJECTIONRELATIONSPHYSICALDEVICE) WdfFunctions[WdfPdoAddEjectionRelationsPhysicalDeviceTableIndex])(WdfDriverGlobals, Device, PhysicalDevice)

Definition at line 726 of file wdfpdo.h.

PowerState

typedef _In_ SYSTEM_POWER_STATE PowerState

Definition at line 120 of file wdfpdo.h.

PWDF_PDO_EVENT_CALLBACKS

typedef struct _WDF_PDO_EVENT_CALLBACKS * PWDF_PDO_EVENT_CALLBACKS

WDF_PDO_EVENT_CALLBACKS

typedef struct _WDF_PDO_EVENT_CALLBACKS WDF_PDO_EVENT_CALLBACKS

Function Documentation

_Function_class_() [1/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_DISABLE_WAKE_AT_BUS

)

_Function_class_() [2/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_EJECT

)

_Function_class_() [3/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_ENABLE_WAKE_AT_BUS

)

_Function_class_() [4/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_REPORTED_MISSING

)

_Function_class_() [5/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_RESOURCE_REQUIREMENTS_QUERY

)

_Function_class_() [6/7]

WDF_EXTERN_C_START typedef _Function_class_

(

EVT_WDF_DEVICE_RESOURCES_QUERY

)

_Function_class_() [7/7]

typedef _Function_class_

(

EVT_WDF_DEVICE_SET_LOCK

)

_IRQL_requires_max_()

_Must_inspect_result_ _IRQL_requires_max_

(

DISPATCH_LEVEL

)

IOCTL_INTERNAL_USB_SUBMIT_IDLE_NOTIFICATION; the idle machine owns the IRP afterwards.

Records hub over current in the hub hardware key, once per devnode.

First selective suspend of the device; the registry write runs in a work item.

"USB device not recognized" popup for a port.

A hub was attached beyond the allowed tier depth.

The selected configuration draws more power than the port can give.

The controller ran out of bandwidth for the device; fired by the out of bandwidth timer.

Priority 1 to 3, forwarded to the HCD's EvtEndpointSetCharacteristic.

Tells apart devices that claim the same VID, PID and serial number.

Definition at line 558 of file wdfpdo.h.

{
    return ((PFN_WDFPDOMARKMISSING) WdfFunctions[WdfPdoMarkMissingTableIndex])(WdfDriverGlobals, Device);
}

WDF_PDO_EVENT_CALLBACKS_INIT()

FORCEINLINE VOID WDF_PDO_EVENT_CALLBACKS_INIT

(

_Out_ PWDF_PDO_EVENT_CALLBACKS

Callbacks

)

Definition at line 199 of file wdfpdo.h.

{
    RtlZeroMemory(Callbacks, sizeof(WDF_PDO_EVENT_CALLBACKS));
    Callbacks->Size = sizeof(WDF_PDO_EVENT_CALLBACKS);
}

Referenced by UcxRootHub::CreatePdo().

Variable Documentation

Resources

WDF_EXTERN_C_START typedef _In_ WDFCMRESLIST Resources

Definition at line 62 of file wdfpdo.h.