POFXCALLBACKUPDATEPROCESSORIDLESTATE callback function (pepfx.h)

Article
02/22/2024

The UpdateProcessorIdleState routine is called by the platform extension plug-in (PEP) to update the properties of the specified processor idle state.

Syntax

POFXCALLBACKUPDATEPROCESSORIDLESTATE Pofxcallbackupdateprocessoridlestate;

NTSTATUS Pofxcallbackupdateprocessoridlestate(
  [in] POHANDLE ProcessorHandle,
  [in] ULONG ProcessorState,
  [in] PPEP_PROCESSOR_IDLE_STATE_UPDATE Update
)
{...}

Parameters

[in] ProcessorHandle

A POHANDLE value that represents the registration of the processor (as a device) with the Windows power management framework (PoFx). The PEP previously received this handle from PoFx during the PEP_DPM_REGISTER_DEVICE notification that informed the PEP that the processor had been registered with PoFx.

[in] ProcessorState

An index that identifies the processor idle state whose properties are to be updated. In response to a previous PEP_NOTIFY_PPM_QUERY_IDLE_STATES_V2 notification, the PEP specified the number of supported processor idle states and the properties of these states. If the PEP specified N processor idle states, valid processor idle state indexes range from 0 to N-1.

[in] Update

A pointer to a PEP_PROCESSOR_IDLE_STATE_UPDATE structure that contains the updated properties of the processor idle state.

Return value

UpdateProcessorIdleState returns STATUS_SUCCESS if it successfully updates the properties of the processor idle state. Possible error return values include the following status codes.

Return value	Description
STATUS_NOT_SUPPORTED	The version number in the PEP_PROCESSOR_IDLE_STATE_UPDATE structure is not a supported value.
STATUS_NOT_IMPLEMENTED	The UpdateProcessorIdleState routine is not implemented for this processor.

Remarks

This routine is implemented by PoFx and is called by the PEP. The UpdateProcessorIdleState member of the PEP_KERNEL_INFORMATION_STRUCT_V3 structure is a pointer to an UpdateProcessorIdleState routine.

The UpdateProcessorIdleState routine must be called at IRQL = PASSIVE_LEVEL.

Requirements

Requirement	Value
Minimum supported client	Supported starting with Windows 10.
Target Platform	Windows
Header	pepfx.h (include Pep_x.h)
IRQL	PASSIVE_LEVEL