+///\r
+/// Macro used to simplify the lookup table entries of type\r
+/// CPU_SMM_SAVE_STATE_LOOKUP_ENTRY\r
+///\r
+#define SMM_CPU_OFFSET(Field) OFFSET_OF (QEMU_SMRAM_SAVE_STATE_MAP, Field)\r
+\r
+///\r
+/// Macro used to simplify the lookup table entries of type\r
+/// CPU_SMM_SAVE_STATE_REGISTER_RANGE\r
+///\r
+#define SMM_REGISTER_RANGE(Start, End) { Start, End, End - Start + 1 }\r
+\r
+///\r
+/// Structure used to describe a range of registers\r
+///\r
+typedef struct {\r
+ EFI_SMM_SAVE_STATE_REGISTER Start;\r
+ EFI_SMM_SAVE_STATE_REGISTER End;\r
+ UINTN Length;\r
+} CPU_SMM_SAVE_STATE_REGISTER_RANGE;\r
+\r
+///\r
+/// Structure used to build a lookup table to retrieve the widths and offsets\r
+/// associated with each supported EFI_SMM_SAVE_STATE_REGISTER value\r
+///\r
+\r
+#define SMM_SAVE_STATE_REGISTER_FIRST_INDEX 1\r
+\r
+typedef struct {\r
+ UINT8 Width32;\r
+ UINT8 Width64;\r
+ UINT16 Offset32;\r
+ UINT16 Offset64Lo;\r
+ UINT16 Offset64Hi;\r
+ BOOLEAN Writeable;\r
+} CPU_SMM_SAVE_STATE_LOOKUP_ENTRY;\r
+\r
+///\r
+/// Table used by GetRegisterIndex() to convert an EFI_SMM_SAVE_STATE_REGISTER\r
+/// value to an index into a table of type CPU_SMM_SAVE_STATE_LOOKUP_ENTRY\r
+///\r
+STATIC CONST CPU_SMM_SAVE_STATE_REGISTER_RANGE mSmmCpuRegisterRanges[] = {\r
+ SMM_REGISTER_RANGE (\r
+ EFI_SMM_SAVE_STATE_REGISTER_GDTBASE,\r
+ EFI_SMM_SAVE_STATE_REGISTER_LDTINFO\r
+ ),\r
+ SMM_REGISTER_RANGE (\r
+ EFI_SMM_SAVE_STATE_REGISTER_ES,\r
+ EFI_SMM_SAVE_STATE_REGISTER_RIP\r
+ ),\r
+ SMM_REGISTER_RANGE (\r
+ EFI_SMM_SAVE_STATE_REGISTER_RFLAGS,\r
+ EFI_SMM_SAVE_STATE_REGISTER_CR4\r
+ ),\r
+ { (EFI_SMM_SAVE_STATE_REGISTER)0, (EFI_SMM_SAVE_STATE_REGISTER)0, 0 }\r
+};\r
+\r
+///\r
+/// Lookup table used to retrieve the widths and offsets associated with each\r
+/// supported EFI_SMM_SAVE_STATE_REGISTER value\r
+///\r
+STATIC CONST CPU_SMM_SAVE_STATE_LOOKUP_ENTRY mSmmCpuWidthOffset[] = {\r
+ {\r
+ 0, // Width32\r
+ 0, // Width64\r
+ 0, // Offset32\r
+ 0, // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // Reserved\r
+\r
+ //\r
+ // CPU Save State registers defined in PI SMM CPU Protocol.\r
+ //\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._GDTRBase), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._GDTRBase) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_GDTBASE = 4\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._IDTRBase), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._IDTRBase) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_IDTBASE = 5\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._LDTRBase), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._LDTRBase) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_LDTBASE = 6\r
+\r
+ {\r
+ 0, // Width32\r
+ 0, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._GDTRLimit), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._GDTRLimit) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_GDTLIMIT = 7\r
+\r
+ {\r
+ 0, // Width32\r
+ 0, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._IDTRLimit), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._IDTRLimit) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_IDTLIMIT = 8\r
+\r
+ {\r
+ 0, // Width32\r
+ 0, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._LDTRLimit), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._LDTRLimit) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_LDTLIMIT = 9\r
+\r
+ {\r
+ 0, // Width32\r
+ 0, // Width64\r
+ 0, // Offset32\r
+ 0, // Offset64Lo\r
+ 0 + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_LDTINFO = 10\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._ES), // Offset32\r
+ SMM_CPU_OFFSET (x64._ES), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_ES = 20\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._CS), // Offset32\r
+ SMM_CPU_OFFSET (x64._CS), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_CS = 21\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._SS), // Offset32\r
+ SMM_CPU_OFFSET (x64._SS), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_SS = 22\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._DS), // Offset32\r
+ SMM_CPU_OFFSET (x64._DS), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_DS = 23\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._FS), // Offset32\r
+ SMM_CPU_OFFSET (x64._FS), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_FS = 24\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._GS), // Offset32\r
+ SMM_CPU_OFFSET (x64._GS), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_GS = 25\r
+\r
+ {\r
+ 0, // Width32\r
+ 4, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._LDTR), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_LDTR_SEL = 26\r
+\r
+ {\r
+ 4, // Width32\r
+ 4, // Width64\r
+ SMM_CPU_OFFSET (x86._TR), // Offset32\r
+ SMM_CPU_OFFSET (x64._TR), // Offset64Lo\r
+ 0, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_TR_SEL = 27\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._DR7), // Offset32\r
+ SMM_CPU_OFFSET (x64._DR7), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._DR7) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_DR7 = 28\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._DR6), // Offset32\r
+ SMM_CPU_OFFSET (x64._DR6), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._DR6) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_DR6 = 29\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R8), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R8) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R8 = 30\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R9), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R9) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R9 = 31\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R10), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R10) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R10 = 32\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R11), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R11) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R11 = 33\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R12), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R12) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R12 = 34\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R13), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R13) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R13 = 35\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R14), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R14) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R14 = 36\r
+\r
+ {\r
+ 0, // Width32\r
+ 8, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._R15), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._R15) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_R15 = 37\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EAX), // Offset32\r
+ SMM_CPU_OFFSET (x64._RAX), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RAX) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RAX = 38\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EBX), // Offset32\r
+ SMM_CPU_OFFSET (x64._RBX), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RBX) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RBX = 39\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._ECX), // Offset32\r
+ SMM_CPU_OFFSET (x64._RCX), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RCX) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RCX = 40\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EDX), // Offset32\r
+ SMM_CPU_OFFSET (x64._RDX), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RDX) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RDX = 41\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._ESP), // Offset32\r
+ SMM_CPU_OFFSET (x64._RSP), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RSP) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RSP = 42\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EBP), // Offset32\r
+ SMM_CPU_OFFSET (x64._RBP), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RBP) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RBP = 43\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._ESI), // Offset32\r
+ SMM_CPU_OFFSET (x64._RSI), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RSI) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RSI = 44\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EDI), // Offset32\r
+ SMM_CPU_OFFSET (x64._RDI), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RDI) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RDI = 45\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EIP), // Offset32\r
+ SMM_CPU_OFFSET (x64._RIP), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RIP) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RIP = 46\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._EFLAGS), // Offset32\r
+ SMM_CPU_OFFSET (x64._RFLAGS), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._RFLAGS) + 4, // Offset64Hi\r
+ TRUE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_RFLAGS = 51\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._CR0), // Offset32\r
+ SMM_CPU_OFFSET (x64._CR0), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._CR0) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_CR0 = 52\r
+\r
+ {\r
+ 4, // Width32\r
+ 8, // Width64\r
+ SMM_CPU_OFFSET (x86._CR3), // Offset32\r
+ SMM_CPU_OFFSET (x64._CR3), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._CR3) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_CR3 = 53\r
+\r
+ {\r
+ 0, // Width32\r
+ 4, // Width64\r
+ 0, // Offset32\r
+ SMM_CPU_OFFSET (x64._CR4), // Offset64Lo\r
+ SMM_CPU_OFFSET (x64._CR4) + 4, // Offset64Hi\r
+ FALSE // Writeable\r
+ }, // EFI_SMM_SAVE_STATE_REGISTER_CR4 = 54\r
+};\r
+\r
+//\r
+// No support for I/O restart\r
+//\r
+\r
+/**\r
+ Read information from the CPU save state.\r
+\r
+ @param Register Specifies the CPU register to read form the save state.\r
+\r
+ @retval 0 Register is not valid\r
+ @retval >0 Index into mSmmCpuWidthOffset[] associated with Register\r
+\r
+**/\r
+STATIC\r
+UINTN\r
+GetRegisterIndex (\r
+ IN EFI_SMM_SAVE_STATE_REGISTER Register\r
+ )\r
+{\r
+ UINTN Index;\r
+ UINTN Offset;\r
+\r
+ for (Index = 0, Offset = SMM_SAVE_STATE_REGISTER_FIRST_INDEX;\r
+ mSmmCpuRegisterRanges[Index].Length != 0;\r
+ Index++) {\r
+ if (Register >= mSmmCpuRegisterRanges[Index].Start &&\r
+ Register <= mSmmCpuRegisterRanges[Index].End) {\r
+ return Register - mSmmCpuRegisterRanges[Index].Start + Offset;\r
+ }\r
+ Offset += mSmmCpuRegisterRanges[Index].Length;\r
+ }\r
+ return 0;\r
+}\r
+\r
+/**\r
+ Read a CPU Save State register on the target processor.\r
+\r
+ This function abstracts the differences that whether the CPU Save State\r
+ register is in the IA32 CPU Save State Map or X64 CPU Save State Map.\r
+\r
+ This function supports reading a CPU Save State register in SMBase relocation\r
+ handler.\r
+\r
+ @param[in] CpuIndex Specifies the zero-based index of the CPU save\r
+ state.\r
+ @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.\r
+ @param[in] Width The number of bytes to read from the CPU save\r
+ state.\r
+ @param[out] Buffer Upon return, this holds the CPU register value\r
+ read from the save state.\r
+\r
+ @retval EFI_SUCCESS The register was read from Save State.\r
+ @retval EFI_NOT_FOUND The register is not defined for the Save State\r
+ of Processor.\r
+ @retval EFI_INVALID_PARAMTER This or Buffer is NULL.\r
+\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+ReadSaveStateRegisterByIndex (\r
+ IN UINTN CpuIndex,\r
+ IN UINTN RegisterIndex,\r
+ IN UINTN Width,\r
+ OUT VOID *Buffer\r
+ )\r
+{\r
+ QEMU_SMRAM_SAVE_STATE_MAP *CpuSaveState;\r
+\r
+ CpuSaveState = (QEMU_SMRAM_SAVE_STATE_MAP *)gSmst->CpuSaveState[CpuIndex];\r
+\r
+ if ((CpuSaveState->x86.SMMRevId & 0xFFFF) == 0) {\r
+ //\r
+ // If 32-bit mode width is zero, then the specified register can not be\r
+ // accessed\r
+ //\r
+ if (mSmmCpuWidthOffset[RegisterIndex].Width32 == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ //\r
+ // If Width is bigger than the 32-bit mode width, then the specified\r
+ // register can not be accessed\r
+ //\r
+ if (Width > mSmmCpuWidthOffset[RegisterIndex].Width32) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Write return buffer\r
+ //\r
+ ASSERT(CpuSaveState != NULL);\r
+ CopyMem (\r
+ Buffer,\r
+ (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset32,\r
+ Width\r
+ );\r
+ } else {\r
+ //\r
+ // If 64-bit mode width is zero, then the specified register can not be\r
+ // accessed\r
+ //\r
+ if (mSmmCpuWidthOffset[RegisterIndex].Width64 == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ //\r
+ // If Width is bigger than the 64-bit mode width, then the specified\r
+ // register can not be accessed\r
+ //\r
+ if (Width > mSmmCpuWidthOffset[RegisterIndex].Width64) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Write lower 32-bits of return buffer\r
+ //\r
+ CopyMem (\r
+ Buffer,\r
+ (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Lo,\r
+ MIN (4, Width)\r
+ );\r
+ if (Width >= 4) {\r
+ //\r
+ // Write upper 32-bits of return buffer\r
+ //\r
+ CopyMem (\r
+ (UINT8 *)Buffer + 4,\r
+ (UINT8 *)CpuSaveState + mSmmCpuWidthOffset[RegisterIndex].Offset64Hi,\r
+ Width - 4\r
+ );\r
+ }\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
+\r