4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file declares the SMM CPU Save State protocol, which provides the processor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync save-state information for IA-32 and Itanium processors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is defined in Framework of EFI SMM Core Interface Spec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Version 0.91.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef _SMM_CPU_SAVE_STATE_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _SMM_CPU_SAVE_STATE_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SMM_CPU_SAVE_STATE_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x21f302ad, 0x6e94, 0x471b, {0x84, 0xbc, 0xb1, 0x48, 0x0, 0x40, 0x3a, 0x1d} \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_SMM_CPU_SAVE_STATE_PROTOCOL EFI_SMM_CPU_SAVE_STATE_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_SMM_MIN_REV_ID_x64 0x30006
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#pragma pack (1)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// CPU save-state strcuture for IA32 and X64.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This struct declaration does not exctly match the Framework SMM CIS 0.91 because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// union in the Framework SMM CIS 0.91 contains an unnamed union member that causes build
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// breaks on many compilers with high warning levels. Instead, the UINT8 Reserved[0x200]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// field has been moved into EFI_SMM_CPU_STATE32. This maintains binary compatibility for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the layout and also maintains source comaptibility for access of all fields in this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// union.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This struct declaration does not exctly match the Framework SMM CIS 0.91 because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the Framework SMM CIS 0.91 uses ASM_XXX for base types in this structure. These
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// have been changed to use the base types defined in the UEFI Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved[0x200];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved1[0xf8]; // fe00h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SMBASE; // fef8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SMMRevId; // fefch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 IORestart; // ff00h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 AutoHALTRestart; // ff02h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IEDBASE; // ff04h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved2[0x98]; // ff08h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IOMemAddr; // ffa0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IOMisc; // ffa4h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _ES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _CS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _SS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _DS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _FS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _GS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _LDTBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _TR;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _DR7;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _DR6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EAX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _ECX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EDX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EBX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _ESP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EBP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _ESI;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EDI;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EIP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _EFLAGS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _CR3;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _CR0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_SMM_CPU_STATE32;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This struct declaration does not exctly match the Framework SMM CIS 0.91 because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the Framework SMM CIS 0.91 uses ASM_XXX for base types in this structure. These
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// have been changed to use the base types defined in the UEFI Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved1[0x1d0]; // fc00h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 GdtBaseHiDword; // fdd0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LdtBaseHiDword; // fdd4h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IdtBaseHiDword; // fdd8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved2[0xc]; // fddch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 IO_EIP; // fde8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved3[0x50]; // fdf0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _CR4; // fe40h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved4[0x48]; // fe44h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 GdtBaseLoDword; // fe8ch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 GdtLimit; // fe90h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IdtBaseLoDword; // fe94h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IdtLimit; // fe98h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LdtBaseLoDword; // fe9ch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LdtLimit; // fea0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LdtInfo; // fea4h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved5[0x50]; // fea8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SMBASE; // fef8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 SMMRevId; // fefch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 AutoHALTRestart; // ff00h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 IORestart; // ff02h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IEDBASE; // ff04h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Reserved6[0x14]; // ff08h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R15; // ff1ch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R14;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R13;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R12;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R11;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R10;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R9;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _R8;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RAX; // ff5ch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RCX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RDX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RBX;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RSP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RBP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RSI;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RDI;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 IOMemAddr; // ff9ch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 IOMisc; // ffa4h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _ES; // ffa8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _CS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _SS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _DS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _FS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _GS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _LDTR; // ffc0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 _TR;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _DR7; // ffc8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _DR6;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RIP; // ffd8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 IA32_EFER; // ffe0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _RFLAGS; // ffe8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _CR3; // fff0h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 _CR0; // fff8h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_SMM_CPU_STATE64;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Union of CPU save-state strcutures for IA32 and X64.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This union declaration does not exctly match the Framework SMM CIS 0.91 because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// union in the Framework SMM CIS 0.91 contains an unnamed union member that causes build
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// breaks on many compilers with high warning levels. Instead, the UINT8 Reserved[0x200]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// field has been moved into EFI_SMM_CPU_STATE32. This maintains binary compatibility for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the layout and also maintains source comaptibility for access of all fields in this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// union.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SMM_CPU_STATE32 x86;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SMM_CPU_STATE64 x64;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_SMM_CPU_STATE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#pragma pack ()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides a programatic means to access SMM save state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _EFI_SMM_CPU_SAVE_STATE_PROTOCOL {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reference to a list of save states.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SMM_CPU_STATE **CpuSaveState;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiSmmCpuSaveStateProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif