Edit

PROCESSOR_HALT_ROUTINE callback function (wdm.h)

  • Article

A Halt callback routine transitions the processor to an idle state.

Syntax

PROCESSOR_HALT_ROUTINE ProcessorHaltRoutine;

NTSTATUS ProcessorHaltRoutine(
  [in, out, optional] PVOID Context
)
{...}

Parameters

[in, out, optional] Context

A pointer to a PEP-defined processor-halt context. This pointer is the Context parameter value that the PEP previously passed to the ProcessorHalt routine.

Return value

A Halt callback routine may or may not return. If this routine does return, it returns STATUS_SUCCESS to indicates that the processor successfully entered the idle state. Otherwise, it returns an appropriate error status code.

Remarks

This routine is implemented by the platform extension plug-in (PEP) and is called by the Windows power management framework (PoFx). The ProcessorHalt routine accepts a pointer to a Halt callback routine as a parameter.

The PEP's Halt routine is called at the same IRQL at which the PEP called ProcessorHalt.

Requirements

Requirement Value
Minimum supported client Supported starting with Windows 10.
Target Platform Windows
Header wdm.h (include Pepfx.h)
IRQL See Remarks.

See also

PEP_CRASHDUMP_INFORMATION

ProcessorHalt