WDF_POWER_FRAMEWORK_SETTINGS structure

[Applies to KMDF only]

The WDF_POWER_FRAMEWORK_SETTINGS structure describes power management framework (PoFx) settings for single-component devices.

Syntax

C++


typedef struct _WDF_POWER_FRAMEWORK_SETTINGS {
  ULONG                                         Size;
  PFN_WDFDEVICE_WDM_POST_PO_FX_REGISTER_DEVICE  EvtDeviceWdmPostPoFxRegisterDevice;
  PFN_WDFDEVICE_WDM_PRE_PO_FX_UNREGISTER_DEVICE EvtDeviceWdmPrePoFxUnregisterDevice;
  PPO_FX_COMPONENT                              Component;
  PPO_FX_COMPONENT_ACTIVE_CONDITION_CALLBACK    ComponentActiveConditionCallback;
  PPO_FX_COMPONENT_IDLE_CONDITION_CALLBACK      ComponentIdleConditionCallback;
  PPO_FX_COMPONENT_IDLE_STATE_CALLBACK          ComponentIdleStateCallback;
  PPO_FX_POWER_CONTROL_CALLBACK                 PowerControlCallback;
  PVOID                                         PoFxDeviceContext;
} WDF_POWER_FRAMEWORK_SETTINGS, *PWDF_POWER_FRAMEWORK_SETTINGS;

Members

Size: The size, in bytes, of this structure.
EvtDeviceWdmPostPoFxRegisterDevice: A pointer to the driver's EvtDeviceWdmPostPoFxRegisterDevice event callback function, or NULL.
EvtDeviceWdmPrePoFxUnregisterDevice: A pointer to the driver's EvtDeviceWdmPrePoFxUnregisterDevice event callback function, or NULL.
Component: A pointer to a PO_FX_COMPONENT structure that describes the only component in the single-component device, or NULL. If NULL, KMDF defaults to F0 support only for this component. This structure specifies the number and attributes of the F-states that the component supports, as well as the deepest Fx state from which the component can awaken.
ComponentActiveConditionCallback: A pointer to the driver's ComponentActiveConditionCallback callback routine, or NULL. The power management framework (PoFx) calls this callback function when a component becomes active. While in the Active condition, the component is guaranteed to be in F0.
ComponentIdleConditionCallback: A pointer to the driver's ComponentIdleConditionCallback callback function, or NULL. PoFx calls this callback function when a component becomes idle. While in the Idle condition, the component may be in any F-state, including F0.
ComponentIdleStateCallback: A pointer to the driver's ComponentIdleStateCallback callback function, or NULL. PoFx calls this callback function when the F-state of the component changes.
PowerControlCallback: A pointer to the client driver's PowerControlCallback callback function, or NULL. PoFx calls this routine to pass a request for a power control operation directly to the driver. If your driver does not support any power control codes, set this parameter to NULL.
PoFxDeviceContext: A context pointer that the framework supplies to ComponentActiveConditionCallback, ComponentIdleConditionCallback, ComponentIdleStateCallback, and PowerControlCallback.

Remarks

The WDF_POWER_FRAMEWORK_SETTINGS structure is used an input to WdfDeviceWdmAssignPowerFrameworkSettings.

To initialize its WDF_POWER_FRAMEWORK_SETTINGS structure, your driver should call WDF_POWER_FRAMEWORK_SETTINGS_INIT.

For more information, see Supporting Functional Power States and Overview of the Power Management Framework.

This structure is not applicable to KMDF client drivers for multiple-component devices.

Requirements

Minimum KMDF version	1.11
Header	Wdfdevice.h (include Wdf.h)

WDF_POWER_FRAMEWORK_SETTINGS structure

Syntax

Members

Remarks

Requirements

See also