Windows Hardware Error Architecture (WHEA)

Overview of the Whea technology.

The Whea technology is not associated with any headers.

Enumerations

Title Description
SOC_SUBSYSTEM_TYPE The SOC_SYBSYSTEM_TYPE enumeration defines different types of System on a Chip (SoC) subsystems.
WHEA_ERROR_PACKET_DATA_FORMAT The WHEA_ERROR_PACKET_DATA_FORMAT enumeration defines the raw hardware error data format in a hardware error packet.
WHEA_ERROR_SEVERITY The WHEA_ERROR_SEVERITY enumeration defines the possible severity levels of a hardware error condition.
WHEA_ERROR_SOURCE_STATE The WHEA_ERROR_SOURCE_STATE enumeration defines the different runtime states for an error source.
WHEA_ERROR_SOURCE_TYPE The WHEA_ERROR_SOURCE_TYPE enumeration defines the different types of error sources that can report hardware errors.
WHEA_ERROR_TYPE The WHEA_ERROR_TYPE enumeration defines the different types of hardware components that can report a hardware error.
WHEA_RAW_DATA_FORMAT The WHEA_RAW_DATA_FORMAT enumeration defines the possible formats that raw hardware error data can be encoded in a hardware error packet.

Functions

Title Description
PSHED_PI_ATTEMPT_ERROR_RECOVERY A PSHED plug-in's AttemptRecovery callback function attempts to recover from a recoverable hardware error.
PSHED_PI_CLEAR_ERROR_RECORD A PSHED plug-in's ClearErrorRecord callback function clears the specified error record from the system's persistent data storage.
PSHED_PI_CLEAR_ERROR_STATUS A PSHED plug-in's ClearErrorStatus callback function clears any platform-specific error status registers for a corrected hardware error condition.
PSHED_PI_DISABLE_ERROR_SOURCE A PSHED plug-in's DisableErrorSource callback function disables an error source.
PSHED_PI_ENABLE_ERROR_SOURCE A PSHED plug-in's EnableErrorSource callback function enables an error source.
PSHED_PI_FINALIZE_ERROR_RECORD A PSHED plug-in's FinalizeErrorRecord callback function adds supplementary error record sections to an error record that more fully describe the error condition.
PSHED_PI_GET_ALL_ERROR_SOURCES A PSHED plug-in's GetAllErrorSources callback function returns a list of error source descriptor structures that represents all of the error sources that are implemented by the hardware platform.
PSHED_PI_GET_ERROR_SOURCE_INFO A PSHED plug-in's GetErrorSourceInfo callback function returns an error source descriptor structure that represents a particular error source that is implemented by the hardware platform.
PSHED_PI_GET_INJECTION_CAPABILITIES A PSHED plug-in's GetInjectionCapabilities callback function returns an error injection capabilities union that describes the types of hardware errors that can be injected into the hardware platform.
PSHED_PI_INJECT_ERROR A PSHED plug-in's InjectError callback function injects an error into the hardware platform.
PSHED_PI_READ_ERROR_RECORD A PSHED plug-in's ReadErrorRecord callback function reads an error record from the system's persistent data storage.
PSHED_PI_RETRIEVE_ERROR_INFO A PSHED plug-in's RetrieveErrorInfo callback function retrieves platform-specific error information about a hardware error that has occurred.
PSHED_PI_SET_ERROR_SOURCE_INFO A PSHED plug-in's SetErrorSourceInfo callback function configures an error source.
PSHED_PI_WRITE_ERROR_RECORD A PSHED plug-in's WriteErrorRecord callback function writes an error record to the system's persistent data storage.
PshedAllocateMemory The PshedAllocateMemory function allocates a block of memory from the nonpaged pool.
PshedFreeMemory The PshedFreeMemory function frees a block of memory that was previously allocated by calling the PshedAllocateMemory function.
PshedIsSystemWheaEnabled The PshedIsSystemWheaEnabled function returns a Boolean value that indicates whether the system is WHEA-enabled.
PshedRegisterPlugin The PshedRegisterPlugin function registers a PSHED plug-in with the PSHED.
PshedSynchronizeExecution The PshedSynchronizeExecution function synchronizes the execution of a given function with the hardware error processing for an error source.
WheaFindErrorRecordSection The WheaFindErrorRecordSection function searches for a specified Windows Hardware Error Architecture (WHEA) error record section within a WHEA error record. The error record section is formatted as a WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure.
WheaFindNextErrorRecordSection The WheaFindNextErrorRecordSection function allows a caller to iteratively examine the WHEA error record sections within a WHEA error record. Each error record section is formatted as a WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure.
WheaGetErrPacketFromErrRecord The WheaGetErrPacketFromErrRecord function returns a pointer to the hardware error packet that is contained within a WHEA error record. The hardware error packet is formatted as a WHEA_ERROR_PACKET structure.
WheaIsValidErrorRecordSignature The WheaIsValidErrorRecordSignature function verifies whether a WHEA error record is valid.

Structures

Title Description
WHEA_ERROR_RECORD The WHEA_ERROR_RECORD structure describes an error record that contains error information about a hardware error condition that occurred.
WHEA_ERROR_SOURCE_DESCRIPTOR The WHEA_ERROR_SOURCE_DESCRIPTOR structure describes an error source.
SOC_SUBSYSTEM_FAILURE_DETAILS The SOC_SUBSYSTEM_FAILURE_DETAILS structure holds information related to a System on a Chip (SoC) bug code.
WHEA_AER_BRIDGE_DESCRIPTOR The WHEA_AER_BRIDGE_DESCRIPTOR structure describes a PCI Express (PCIe) bridge error source.
WHEA_AER_ENDPOINT_DESCRIPTOR The WHEA_AER_ENDPOINT_DESCRIPTOR structure describes a PCI Express (PCIe) endpoint error source.
WHEA_AER_ROOTPORT_DESCRIPTOR The WHEA_AER_ROOTPORT_DESCRIPTOR structure describes a PCI Express (PCIe) root port error source.
WHEA_ERROR_INJECTION_CAPABILITIES The WHEA_ERROR_INJECTION_CAPABILITIES union describes the types of hardware errors that can be injected into a hardware platform.
WHEA_ERROR_PACKET_FLAGS The WHEA_ERROR_PACKET_FLAGS union defines the error condition reported through a WHEA_ERROR_PACKET structure.
WHEA_ERROR_PACKET_V1 The WHEA_ERROR_PACKET_V1 structure describes the hardware error data that is passed to the operating system by a low-level hardware error handler (LLHEH).Note  The WHEA_ERROR_PACKET_V1 structure is supported in Windows Server 2008 and Windows Vista SP1.
WHEA_ERROR_PACKET_V2 The WHEA_ERROR_PACKET_V1 structure describes the hardware error data that is passed to the operating system by a low-level hardware error handler (LLHEH).Note  The WHEA_ERROR_PACKET_V1 structure is supported in Windows Server 2008 and Windows Vista SP1.
WHEA_ERROR_RECORD_HEADER The WHEA_ERROR_RECORD_HEADER structure describes general information about a hardware error condition.
WHEA_ERROR_RECORD_HEADER_VALIDBITS The WHEA_ERROR_RECORD_HEADER_VALIDBITS union describes which members of a WHEA_ERROR_RECORD_HEADER structure contain valid data.
WHEA_ERROR_RECORD_SECTION_DESCRIPTOR The WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure describes a section of error information that is part of an error record.
WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_VALIDBITS The WHEA_ERROR_RECORD_SECTION_DESCRIPTOR_VALIDBITS union describes which members of a WHEA_ERROR_RECORD_SECTION_DESCRIPTOR structure contain valid data.
WHEA_ERROR_STATUS The WHEA_ERROR_STATUS union describes generic error codes that are abstracted from the data contained in implementation-specific error registers.
WHEA_FIRMWARE_ERROR_RECORD_REFERENCE The WHEA_FIRMWARE_ERROR_RECORD_REFERENCE structure describes a reference to a firmware error record that is specific to the Itanium processor architecture.
WHEA_GENERIC_ERROR The WHEA_GENERIC_ERROR structure describes error status data for a generic error source.
WHEA_GENERIC_ERROR_BLOCKSTATUS The WHEA_GENERIC_ERROR_BLOCKSTATUS union indicates what kind of error data is reported in a generic error status block.
WHEA_GENERIC_ERROR_DATA_ENTRY_V2 The WHEA_GENERIC_ERROR_DATA_ENTRY structure describes an error data section in a generic error status block.
WHEA_GENERIC_ERROR_DESCRIPTOR The WHEA_GENERIC_ERROR_DESCRIPTOR structure describes a generic error source.
WHEA_IPF_CMC_DESCRIPTOR The WHEA_IPF_CMC_DESCRIPTOR structure describes a corrected machine check (CMC) error source for an Itanium processor.
WHEA_IPF_CPE_DESCRIPTOR The WHEA_IPF_CPE_DESCRIPTOR structure describes a corrected platform error (CPE) error source for an Itanium processor.
WHEA_IPF_MCA_DESCRIPTOR The WHEA_IPF_MCA_DESCRIPTOR structure describes a machine check abort (MCA) error source for an Itanium processor.
WHEA_MEMORY_ERROR_SECTION The WHEA_MEMORY_ERROR_SECTION structure describes platform memory error data.
WHEA_MEMORY_ERROR_SECTION_VALIDBITS The WHEA_MEMORY_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_MEMORY_ERROR_SECTION structure contain valid data.
WHEA_NMI_ERROR_SECTION The WHEA_NMI_ERROR_SECTION structure describes nonmaskable interrupt (NMI) error data.
WHEA_NOTIFICATION_DESCRIPTOR The WHEA_NOTIFICATION_DESCRIPTOR structure describes the notification mechanism that is used by an error source.
WHEA_PCI_SLOT_NUMBER The WHEA_PCI_SLOT_NUMBER structure describes a logical PCI slot.
WHEA_PCIEXPRESS_ERROR_SECTION The WHEA_PCIEXPRESS_ERROR_SECTION structure describes PCI Express (PCIe) error data.
WHEA_PCIEXPRESS_ERROR_SECTION_VALIDBITS The WHEA_PCIEXPRESS_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_PCIEXPRESS_ERROR_SECTION structure contain valid data.
WHEA_PCIXBUS_ERROR_SECTION The WHEA_PCIXBUS_ERROR_SECTION structure describes PCI or PCI-X bus error data.
WHEA_PCIXBUS_ERROR_SECTION_VALIDBITS The WHEA_PCIXBUS_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_PCIXBUS_ERROR_SECTION structure contain valid data.
WHEA_PCIXDEVICE_ERROR_SECTION The WHEA_PCIXDEVICE_ERROR_SECTION structure describes PCI or PCI-X device error data.
WHEA_PCIXDEVICE_ERROR_SECTION_VALIDBITS The WHEA_PCIXDEVICE_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_PCIXDEVICE_ERROR_SECTION structure contain valid data.
WHEA_PERSISTENCE_INFO The WHEA_PERSISTENCE_INFO union describes data that is used by the error record persistence interface for storing an error record.
WHEA_PROCESSOR_FAMILY_INFO The WHEA_PROCESSOR_FAMILY_INFO union describes the processor family information for an x86 or x64 processor.
WHEA_PROCESSOR_GENERIC_ERROR_SECTION Describes processor error data that is not specific to a particular processor architecture.
WHEA_PROCESSOR_GENERIC_ERROR_SECTION_VALIDBITS The WHEA_PROCESSOR_GENERIC_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_PROCESSOR_GENERIC_ERROR_SECTION structure contain valid data.
WHEA_PSHED_PLUGIN_CALLBACKS The WHEA_PSHED_PLUGIN_CALLBACKS structure describes the callback functions for a PSHED plug-in.
WHEA_REVISION The WHEA_REVISION union describes the revision of the error record data structures.
WHEA_TIMESTAMP The WHEA_TIMESTAMP union describes the time that an error was reported to the operating system.
WHEA_X64_REGISTER_STATE The WHEA_X64_REGISTER_STATE structure describes the state of an x64 processor's registers.
WHEA_X86_REGISTER_STATE The WHEA_X86_REGISTER_STATE structure describes the state of an x86 processor's registers.
WHEA_XPF_BUS_CHECK The WHEA_XPF_BUS_CHECK union describes bus error information for an x86 or x64 processor.
WHEA_XPF_CACHE_CHECK The WHEA_XPF_CACHE_CHECK union describes cache error information for an x86 or x64 processor.
WHEA_XPF_CMC_DESCRIPTOR The WHEA_XPF_CMC_DESCRIPTOR structure describes a corrected machine check (CMC) error source for an x86 or x64 processor.
WHEA_XPF_CONTEXT_INFO The WHEA_XPF_CONTEXT_INFO structure describes processor context information for an x86 or x64 processor.
WHEA_XPF_MC_BANK_DESCRIPTOR The WHEA_XPF_MC_BANK_DESCRIPTOR structure describes a bank of machine check registers for an x86 or x64 processor.
WHEA_XPF_MCE_DESCRIPTOR The WHEA_XPF_MCE_DESCRIPTOR structure describes a machine check exception (MCE) error source for an x86 or x64 processor.
WHEA_XPF_MS_CHECK The WHEA_XPF_MS_CHECK union describes microarchitecture-specific error information for an x86 or x64 processor.
WHEA_XPF_NMI_DESCRIPTOR The WHEA_XPF_NMI_DESCRIPTOR structure describes a nonmaskable interrupt (NMI) error source for an x86 or x64 processor.
WHEA_XPF_PROCESSOR_ERROR_SECTION The WHEA_XPF_PROCESSOR_ERROR_SECTION structure describes processor error data that is specific to the x86/x64 processor architecture.
WHEA_XPF_PROCESSOR_ERROR_SECTION_VALIDBITS The WHEA_XPF_PROCESSOR_ERROR_SECTION_VALIDBITS union describes which members of a WHEA_XPF_PROCESSOR_ERROR_SECTION structure contain valid data and the number of structures that are contained in the WHEA_XPF_PROCESSOR_ERROR_SECTION structure's VariableInfo member.
WHEA_XPF_PROCINFO The WHEA_XPF_PROCINFO structure describes processor error information that is specific to the x86 and x64 processor architectures.
WHEA_XPF_PROCINFO_VALIDBITS The WHEA_XPF_PROCINFO_VALIDBITS union describes which members of a WHEA_XPF_PROCINFO structure contain valid data.
WHEA_XPF_TLB_CHECK The WHEA_XPF_TLB_CHECK union describes translation lookaside buffer (TLB) error information for an x86 or x64 processor.