Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 4.46 KB

nc-wdm-po_fx_component_perf_state_callback.md

File metadata and controls

91 lines (61 loc) · 4.46 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NC:wdm.PO_FX_COMPONENT_PERF_STATE_CALLBACK
PO_FX_COMPONENT_PERF_STATE_CALLBACK (wdm.h)
The ComponentPerfStateCallback callback routine notifies the driver that its request to change the performance state of a component is complete.
kernel\componentperfstatecallback.htm
kernel
04/30/2018
PO_FX_COMPONENT_PERF_STATE_CALLBACK callback function
ComponentPerfStateCallback, ComponentPerfStateCallback routine [Kernel-Mode Driver Architecture], PO_FX_COMPONENT_PERF_STATE_CALLBACK, kernel.componentperfstatecallback, wdm/ComponentPerfStateCallback
wdm.h
Desktop
Supported starting with Windows 10.
Called at IRQL <= DISPATCH_LEVEL.
Windows
PO_FX_COMPONENT_PERF_STATE_CALLBACK
wdm/PO_FX_COMPONENT_PERF_STATE_CALLBACK
APIRef
kbSyntax
UserDefined
Wdm.h
PO_FX_COMPONENT_PERF_STATE_CALLBACK

PO_FX_COMPONENT_PERF_STATE_CALLBACK callback function

-description

The ComponentPerfStateCallback callback routine notifies the driver that its request to change the performance state of a component is complete.

-parameters

-param Context [in]

A pointer to the device context. The device driver uses this context to store information about the current power state of the device. The device driver specified this pointer in the DeviceContext member of the PO_FX_DEVICE structure that the driver used to register the device with the power management framework (PoFx). This context is opaque to PoFx.

-param Component [in]

Specifies the index that identifies the component. This parameter is an index into the Components array in the PO_FX_DEVICE structure that the device driver used to register the device with PoFx. If the Components array contains N elements, component indexes range from 0 to N–1.

-param Succeeded [in]

If TRUE, the platform extension plug-in (PEP) succeeded the performance state change. If FALSE, the PEP failed the performance state change. For more information, see the Remarks section.

-param RequestContext [in]

Pointer to the optional driver or device context that was specified by the Context parameter of the PoFxIssueComponentPerfStateChange or PoFxIssueComponentPerfStateChangeMultiple routine.

-remarks

When a device driver requests a performance state change by calling the PoFxIssueComponentPerfStateChange or PoFxIssueComponentPerfStateChangeMultiple routine, PoFx calls the ComponentPerfStateCallback routine to notify the driver when the request is complete.

To specify a ComponentPerfStateCallback routine, use the ComponentPerfStateCallback parameter of the PoFxRegisterComponentPerfStates routine when the driver registers for performance state management by PoFx. The ComponentPerfStateCallback routine may be the same for all components and all devices.

If Succeeded is TRUE, the driver should perform whatever work is necessary to change the performance state in the hardware. If Succeeded is FALSE, the driver may choose to do nothing or retry the request with the same performance state or an alternate performance state.

-see-also

PoFxIssueComponentPerfStateChange

PoFxIssueComponentPerfStateChangeMultiple

PoFxRegisterDevice