pnppriv.hpp File Reference

#include "shared/irphandlers/irphandlerspriv.hpp"
#include "wdfdevice.h"
#include "wdfchildlist.h"
#include "wdfpdo.h"
#include "wdffdo.h"
#include "wdfqueryinterface.h"
#include "wdfmemory.h"
#include "wdfwmi.h"
#include "wdfinterrupt.h"
#include "wdfrequest.h"
#include "wdfio.h"
#include "fxwaitlock.hpp"
#include "fxtransactionedlist.hpp"
#include "fxrelateddevicelist.hpp"
#include "fxcollection.hpp"
#include "stringutil.hpp"
#include "fxstring.hpp"
#include "fxdevicetext.hpp"
#include "fxcallback.hpp"
#include "fxsystemthread.hpp"
#include "fxresource.hpp"
#include "fxpkgioshared.hpp"
#include "fxdeviceinitshared.hpp"
#include "fxchildlist.hpp"
#include "fxdevicetomxinterface.hpp"
#include "fxspinlock.hpp"
#include "fxtelemetry.hpp"
#include "fxrelateddevice.hpp"
#include "fxdeviceinterface.hpp"
#include "fxqueryinterface.hpp"
#include "fxpnpcallbacks.hpp"
#include "fxpackage.hpp"
#include "fxpkgpnp.hpp"
#include "fxwatchdog.hpp"
#include "fxpkgpdo.hpp"
#include "fxpkgfdo.hpp"
#include "fxwmiirphandler.hpp"
#include "fxwmiprovider.hpp"
#include "fxwmiinstance.hpp"

Include dependency graph for pnppriv.hpp:

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

Go to the source code of this file.

Classes
struct	_WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7
struct	_WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9
struct	_WDF_PDO_EVENT_CALLBACKS_V1_9
struct	_WDF_INTERRUPT_INFO_V1_7

Macros
#define	FX_IS_USER_MODE   (TRUE)
#define	FX_IS_KERNEL_MODE   (FALSE)
#define	SET_TRI_STATE_FROM_STATE_BITS(state, S, FieldName)
#define	GET_PNP_STATE_BITS_FROM_STRUCT(S, FieldName)
#define	GET_PNP_CAP_BITS_FROM_STRUCT(S, FieldName)
#define	GET_POWER_CAP_BITS_FROM_STRUCT(S, FieldName)
#define	SET_PNP_DEVICE_STATE_BIT(State, ExternalState, value, Name)
#define	SET_PNP_CAP_IF_TRUE(caps, pCaps, FieldName)
#define	SET_PNP_CAP_IF_FALSE(caps, pCaps, FieldName)
#define	SET_PNP_CAP(caps, pCaps, FieldName)
#define	SET_POWER_CAP(caps, pCaps, FieldName)

Typedefs
typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7	WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7
typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7 *	PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7
typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9	WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9
typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9 *	PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9
typedef struct _WDF_PDO_EVENT_CALLBACKS_V1_9	WDF_PDO_EVENT_CALLBACKS_V1_9
typedef struct _WDF_PDO_EVENT_CALLBACKS_V1_9 *	PWDF_PDO_EVENT_CALLBACKS_V1_9
typedef struct _WDF_INTERRUPT_INFO_V1_7	WDF_INTERRUPT_INFO_V1_7
typedef struct _WDF_INTERRUPT_INFO_V1_7 *	PWDF_INTERRUPT_INFO_V1_7
typedef const struct _WDF_INTERRUPT_INFO_V1_7 *	PCWDF_INTERRUPT_INFO_V1_7

Functions
VOID	PnpPassThroughQIWorker (__in MxDeviceObject *Device, __inout FxIrp *Irp, __inout FxIrp *ForwardIrp)
VOID	CopyQueryInterfaceToIrpStack (__in PPOWER_THREAD_INTERFACE PowerThreadInterface, __in FxIrp *Irp)
_Must_inspect_result_ NTSTATUS NTAPI	SendDeviceUsageNotification (__in MxDeviceObject *RelatedDevice, __in FxIrp *RelatedIrp, __in MxWorkItem *Workitem, __in FxIrp *OriginalIrp, __in BOOLEAN Revert)
_Must_inspect_result_ NTSTATUS NTAPI	GetStackCapabilities (__in PFX_DRIVER_GLOBALS DriverGlobals, __in MxDeviceObject *DeviceInStack, __in_opt PD3COLD_SUPPORT_INTERFACE D3ColdInterface, __out PSTACK_DEVICE_CAPABILITIES Capabilities)
VOID NTAPI	SetD3ColdSupport (__in PFX_DRIVER_GLOBALS DriverGlobals, __in MxDeviceObject *DeviceInStack, __in PD3COLD_SUPPORT_INTERFACE D3ColdInterface, __in BOOLEAN UseD3Cold)
LONG __inline	FxGetValueBits (__in WDF_TRI_STATE State, __in LONG TrueValue, __in LONG UseDefaultValue)
__inline VOID	FxSetPnpDeviceStateBit (__in PNP_DEVICE_STATE *PnpDeviceState, __in LONG ExternalState, __in LONG InternalState, __in LONG BitMask, __in LONG TrueValue)
_Must_inspect_result_ PVOID	GetIoMgrObjectForWorkItemAllocation (VOID)

Macro Definition Documentation

FX_IS_KERNEL_MODE

#define FX_IS_KERNEL_MODE   (FALSE)

Definition at line 32 of file pnppriv.hpp.

FX_IS_USER_MODE

#define FX_IS_USER_MODE   (TRUE)

Definition at line 31 of file pnppriv.hpp.

GET_PNP_CAP_BITS_FROM_STRUCT

#define GET_PNP_CAP_BITS_FROM_STRUCT	(		S,
			FieldName
	)

Value:

    FxGetValueBits(S->FieldName,                    \
                 FxPnpCap##FieldName##True,         \
                 FxPnpCap##FieldName##UseDefault)

Definition at line 229 of file pnppriv.hpp.

GET_PNP_STATE_BITS_FROM_STRUCT

#define GET_PNP_STATE_BITS_FROM_STRUCT	(		S,
			FieldName
	)

Value:

    FxGetValueBits(S->FieldName,                    \
                 FxPnpState##FieldName##True,       \
                 FxPnpState##FieldName##UseDefault)

Definition at line 224 of file pnppriv.hpp.

GET_POWER_CAP_BITS_FROM_STRUCT

#define GET_POWER_CAP_BITS_FROM_STRUCT	(		S,
			FieldName
	)

Value:

    FxGetValueBits(S->FieldName,                    \
                   FxPowerCap##FieldName##True,     \
                   FxPowerCap##FieldName##UseDefault)

Definition at line 234 of file pnppriv.hpp.

SET_PNP_CAP

#define SET_PNP_CAP	(		caps,
			pCaps,
			FieldName
	)

Value:

{                                                                           \
    if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##False) { \
        pCaps->FieldName = FALSE;                                           \
    }                                                                       \
    else if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##True) {  \
        pCaps->FieldName = TRUE;                                            \
    }                                                                       \
}

Definition at line 282 of file pnppriv.hpp.

SET_PNP_CAP_IF_FALSE

#define SET_PNP_CAP_IF_FALSE	(		caps,
			pCaps,
			FieldName
	)

Value:

{                                                                           \
    if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##False) { \
        pCaps->FieldName = FALSE;                                           \
    }                                                                       \
}

Definition at line 275 of file pnppriv.hpp.

SET_PNP_CAP_IF_TRUE

#define SET_PNP_CAP_IF_TRUE	(		caps,
			pCaps,
			FieldName
	)

Value:

{                                                                           \
    if ((caps & FxPnpCap##FieldName##Mask) == FxPnpCap##FieldName##True) {  \
        pCaps->FieldName = TRUE;                                            \
    }                                                                       \
}

Definition at line 268 of file pnppriv.hpp.

SET_PNP_DEVICE_STATE_BIT

#define SET_PNP_DEVICE_STATE_BIT	(		State,
			ExternalState,
			value,
			Name
	)

Value:

    FxSetPnpDeviceStateBit(State,                                   \
                           ExternalState,                           \
                           state,                                   \
                           FxPnpState##Name##Mask,                  \
                           FxPnpState##Name##True)

Definition at line 261 of file pnppriv.hpp.

SET_POWER_CAP

#define SET_POWER_CAP	(		caps,
			pCaps,
			FieldName
	)

Value:

{                                                                           \
    if ((caps & FxPowerCap##FieldName##Mask) == FxPowerCap##FieldName##False) { \
        pCaps->FieldName = FALSE;                                           \
    }                                                                       \
    else if ((caps & FxPowerCap##FieldName##Mask) == FxPowerCap##FieldName##True) {  \
        pCaps->FieldName = TRUE;                                            \
    }                                                                       \
}

Definition at line 292 of file pnppriv.hpp.

SET_TRI_STATE_FROM_STATE_BITS

#define SET_TRI_STATE_FROM_STATE_BITS	(		state,
			S,
			FieldName
	)

Value:

{                                                               \
    switch (state & (FxPnpState##FieldName##Mask)) {            \
    case FxPnpState##FieldName##False :                         \
        S->FieldName =  WdfFalse;                               \
        break;                                                  \
    case FxPnpState##FieldName##True:                           \
        S->FieldName =  WdfTrue;                                \
        break;                                                  \
    case FxPnpState##FieldName##UseDefault :                    \
    default:                                                    \
        S->FieldName =  WdfUseDefault;                          \
        break;                                                  \
    }                                                           \
}

Definition at line 192 of file pnppriv.hpp.

Typedef Documentation

PCWDF_INTERRUPT_INFO_V1_7

typedef const struct _WDF_INTERRUPT_INFO_V1_7* PCWDF_INTERRUPT_INFO_V1_7

Definition at line 483 of file pnppriv.hpp.

PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7

typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7 * PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7

PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9

typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9 * PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9

PWDF_INTERRUPT_INFO_V1_7

typedef struct _WDF_INTERRUPT_INFO_V1_7* PWDF_INTERRUPT_INFO_V1_7

Definition at line 482 of file pnppriv.hpp.

PWDF_PDO_EVENT_CALLBACKS_V1_9

typedef struct _WDF_PDO_EVENT_CALLBACKS_V1_9 * PWDF_PDO_EVENT_CALLBACKS_V1_9

WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7

typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_7

WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9

typedef struct _WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_V1_9

WDF_INTERRUPT_INFO_V1_7

typedef struct _WDF_INTERRUPT_INFO_V1_7 WDF_INTERRUPT_INFO_V1_7

WDF_PDO_EVENT_CALLBACKS_V1_9

typedef struct _WDF_PDO_EVENT_CALLBACKS_V1_9 WDF_PDO_EVENT_CALLBACKS_V1_9

Function Documentation

CopyQueryInterfaceToIrpStack()

VOID CopyQueryInterfaceToIrpStack	(	__in PPOWER_THREAD_INTERFACE	PowerThreadInterface,
		__in FxIrp *	Irp
	)

Definition at line 32 of file supportkm.cpp.

{
    PIO_STACK_LOCATION stack;
 
    stack = Irp->GetCurrentIrpStackLocation();
 
    RtlCopyMemory(stack->Parameters.QueryInterface.Interface,
        PowerThreadInterface,
        PowerThreadInterface->Interface.Size);
}

Referenced by FxPkgPnp::HandleQueryInterfaceForPowerThread().

FxGetValueBits()

LONG __inline FxGetValueBits	(	__in WDF_TRI_STATE	State,
		__in LONG	TrueValue,
		__in LONG	UseDefaultValue
	)

Definition at line 210 of file pnppriv.hpp.

{
    switch (State) {
    case WdfFalse:      return 0x0;
    case WdfTrue:       return TrueValue;
    case WdfUseDefault:
    default:            return UseDefaultValue;
    }
}

FxSetPnpDeviceStateBit()

__inline VOID FxSetPnpDeviceStateBit	(	__in PNP_DEVICE_STATE *	PnpDeviceState,
		__in LONG	ExternalState,
		__in LONG	InternalState,
		__in LONG	BitMask,
		__in LONG	TrueValue
	)

Definition at line 241 of file pnppriv.hpp.

{
    LONG bits;
 
    bits = InternalState & BitMask;
 
    if (bits == TrueValue) {
        *PnpDeviceState |= ExternalState;
    }
    else if (bits == 0) {  // 0 is the always false for every bit-set
        *PnpDeviceState &= ~ExternalState;
    }
}

GetIoMgrObjectForWorkItemAllocation()

_Must_inspect_result_ PVOID GetIoMgrObjectForWorkItemAllocation

(

VOID

)

Definition at line 98 of file supportum.cpp.

{
    //
    // In user-mode we don't need an IO manager object for work item allocation
    // so we return NULL.
    //
    return NULL;
}

Referenced by FxWorkItemEventQueue::Init().

GetStackCapabilities()

_Must_inspect_result_ NTSTATUS NTAPI GetStackCapabilities	(	__in PFX_DRIVER_GLOBALS	DriverGlobals,
		__in MxDeviceObject *	DeviceInStack,
		__in_opt PD3COLD_SUPPORT_INTERFACE	D3ColdInterface,
		__out PSTACK_DEVICE_CAPABILITIES	Capabilities
	)

Definition at line 49 of file supportkm.cpp.

{
    ULONG i;
    FxAutoIrp irp;
    NTSTATUS status;
 
    ASSERT(Capabilities != NULL);
 
    status = STATUS_INSUFFICIENT_RESOURCES;
 
    //
    // Normally this would be assigned to a local variable on the stack.  Since
    // query caps iteratively moves down the device's tree until it hits the
    // root.  As such, stack usage is consumed quickly.  While this is only one
    // pointer value we are saving, it does eventually add up on very deep stacks.
    //
    DeviceInStack->SetObject(DeviceInStack->GetAttachedDeviceReference());
    if (DeviceInStack->GetObject() == NULL) {
        goto Done;
    }
 
    irp.SetIrp(FxIrp::AllocateIrp(DeviceInStack->GetStackSize()));
    if (irp.GetIrp() == NULL) {
        goto Done;
    }
 
    //
    // Initialize device capabilities.
    //
    RtlZeroMemory(Capabilities, sizeof(STACK_DEVICE_CAPABILITIES));
    Capabilities->DeviceCaps.Size = sizeof(DEVICE_CAPABILITIES);
    Capabilities->DeviceCaps.Version  =  1;
    Capabilities->DeviceCaps.Address  = (ULONG) -1;
    Capabilities->DeviceCaps.UINumber = (ULONG) -1;
 
    //
    // Initialize the Irp.
    //
    irp.SetStatus(STATUS_NOT_SUPPORTED);
 
    irp.ClearNextStack();
    irp.SetMajorFunction(IRP_MJ_PNP);
    irp.SetMinorFunction(IRP_MN_QUERY_CAPABILITIES);
    irp.SetParameterDeviceCapabilities(&Capabilities->DeviceCaps);
 
    status = irp.SendIrpSynchronously(DeviceInStack->GetObject());
 
    if (!NT_SUCCESS(status)) {
        DoTraceLevelMessage(
            DriverGlobals, TRACE_LEVEL_ERROR, TRACINGPNP,
            "Failed to get DEVICE_CAPABILITIES from !devobj %p, %!STATUS!",
            DeviceInStack->GetObject(), status);
        goto Done;
    }
 
    //
    // Invoke the D3cold support interface.  If present, it will tell
    // us specifically which D-states will work for generating wake signals
    // from specific S-states.
    //
    // Earlier versions of WDF didn't make this query, so for compatibility,
    // we only make it now if the driver was built against WDF 1.11 or
    // later.  In truth, this just shifts the failure from initialization
    // time to run time, because the information that we're presumably
    // getting from the BIOS with this interrogation is saying that the
    // code in earlier verisions of WDF would have blindly enabled a device
    // for wake which simply wasn't capable of generating its wake signal
    // from the chosen D-state.  Thus the device would have been put into
    // a low power state and then failed to resume in response to its wake
    // signal.
    //
 
    for (i = 0; i <= PowerSystemHibernate; i++) {
        Capabilities->DeepestWakeableDstate[i] = DeviceWakeDepthMaximum;
    }
 
    if (ARGUMENT_PRESENT(D3ColdInterface) &&
        (D3ColdInterface->GetIdleWakeInfo != NULL) &&
        DriverGlobals->IsVersionGreaterThanOrEqualTo(1,11)) {
 
        DEVICE_WAKE_DEPTH deepestWakeableDstate;
 
        for (i = PowerSystemWorking; i <= PowerSystemHibernate; i++) {
 
            //
            // Failure from D3ColdInterface->GetIdleWakeInfo just means that
            // the bus drivers didn't have any information beyond what can
            // gleaned from the older Query-Capabilities code path.
            //
            // In specific ACPI terms, ACPI will respond to this function with
            // success whenever there is an _SxW object (where x is the sleep
            // state, a value from 0 to 4.)
            //
            // PCI will respond to this interface if ACPI doesn't override its
            // answer and if a parent bus is capable of leaving D0 in S0, and
            // if the PCI device has
            status = D3ColdInterface->GetIdleWakeInfo(
                D3ColdInterface->Context,
                (SYSTEM_POWER_STATE)i,
                &deepestWakeableDstate
                );
 
            if (NT_SUCCESS(status)) {
                Capabilities->DeepestWakeableDstate[i] = deepestWakeableDstate;
            }
        }
    }
 
    status = STATUS_SUCCESS;
 
Done:
    if (DeviceInStack->GetObject() != NULL) {
        DeviceInStack->DereferenceObject();
    }
 
    return status;
}

Referenced by FxPkgPdo::_QueryCapsWorkItem(), FxPkgPdo::PnpQueryCapabilities(), and FxPkgPnp::QueryForCapabilities().

PnpPassThroughQIWorker()

VOID PnpPassThroughQIWorker	(	__in MxDeviceObject *	Device,
		__inout FxIrp *	Irp,
		__inout FxIrp *	ForwardIrp
	)

Definition at line 498 of file fxpkgpnpkm.cpp.

{
    PIO_STACK_LOCATION pFwdStack, pCurStack;
 
    pCurStack = Irp->GetCurrentIrpStackLocation();
 
    ForwardIrp->SetStatus(STATUS_NOT_SUPPORTED);
 
    pFwdStack = ForwardIrp->GetNextIrpStackLocation();
    pFwdStack->MajorFunction = Irp->GetMajorFunction();
    pFwdStack->MinorFunction = Irp->GetMinorFunction();
 
    RtlCopyMemory(&pFwdStack->Parameters.QueryInterface,
                  &pCurStack->Parameters.QueryInterface,
                  sizeof(pFwdStack->Parameters.QueryInterface));
 
    ForwardIrp->SetInformation(Irp->GetInformation());
    ForwardIrp->SendIrpSynchronously(Device->GetObject());
 
    pFwdStack = ForwardIrp->GetNextIrpStackLocation();
 
    RtlCopyMemory(&pCurStack->Parameters.QueryInterface,
                  &pFwdStack->Parameters.QueryInterface,
                  sizeof(pCurStack->Parameters.QueryInterface));
}

Referenced by PnpPassThroughQI().

SendDeviceUsageNotification()

_Must_inspect_result_ NTSTATUS NTAPI SendDeviceUsageNotification	(	__in MxDeviceObject *	RelatedDevice,
		__in FxIrp *	RelatedIrp,
		__in MxWorkItem *	Workitem,
		__in FxIrp *	OriginalIrp,
		__in BOOLEAN	Revert
	)

SetD3ColdSupport()

VOID NTAPI SetD3ColdSupport	(	__in PFX_DRIVER_GLOBALS	DriverGlobals,
		__in MxDeviceObject *	DeviceInStack,
		__in PD3COLD_SUPPORT_INTERFACE	D3ColdInterface,
		__in BOOLEAN	UseD3Cold
	)

Definition at line 174 of file supportkm.cpp.

{
    UNREFERENCED_PARAMETER(DriverGlobals);
    UNREFERENCED_PARAMETER(DeviceInStack);
 
    if (D3ColdInterface->SetD3ColdSupport != NULL) {
        D3ColdInterface->SetD3ColdSupport(D3ColdInterface->Context, UseD3Cold);
    }
}

Referenced by FxPkgPnp::PowerPolicySetS0IdleSettings().