[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / Ia32 / DxeLoadFunc.c

/** @file\r
  Ia32-specific functionality for DxeLoad.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "DxeIpl.h"\r
#include "VirtualMemory.h"\r
\r
#define IDT_ENTRY_COUNT       32\r
\r
typedef struct _X64_IDT_TABLE {\r
  //\r
  // Reserved 4 bytes preceding PeiService and IdtTable,\r
  // since IDT base address should be 8-byte alignment.\r
  //\r
  UINT32                   Reserved;\r
  CONST EFI_PEI_SERVICES   **PeiService;\r
  X64_IDT_GATE_DESCRIPTOR  IdtTable[IDT_ENTRY_COUNT];\r
} X64_IDT_TABLE;\r
\r
//\r
// Global Descriptor Table (GDT)\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT gGdtEntries[] = {\r
/* selector { Global Segment Descriptor                              } */\r
/* 0x00 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //null descriptor\r
/* 0x08 */  {{0xffff, 0,  0,  0x2,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //linear data segment descriptor\r
/* 0x10 */  {{0xffff, 0,  0,  0xf,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //linear code segment descriptor\r
/* 0x18 */  {{0xffff, 0,  0,  0x3,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system data segment descriptor\r
/* 0x20 */  {{0xffff, 0,  0,  0xa,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system code segment descriptor\r
/* 0x28 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //spare segment descriptor\r
/* 0x30 */  {{0xffff, 0,  0,  0x2,  1,  0,  1,  0xf,  0,  0, 1,  1,  0}}, //system data segment descriptor\r
/* 0x38 */  {{0xffff, 0,  0,  0xa,  1,  0,  1,  0xf,  0,  1, 0,  1,  0}}, //system code segment descriptor\r
/* 0x40 */  {{0,      0,  0,  0,    0,  0,  0,  0,    0,  0, 0,  0,  0}}, //spare segment descriptor\r
};\r
\r
//\r
// IA32 Gdt register\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR gGdt = {\r
  sizeof (gGdtEntries) - 1,\r
  (UINTN) gGdtEntries\r
  };\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED  IA32_DESCRIPTOR gLidtDescriptor = {\r
  sizeof (X64_IDT_GATE_DESCRIPTOR) * IDT_ENTRY_COUNT - 1,\r
  0\r
};\r
\r
/**\r
  Allocates and fills in the Page Directory and Page Table Entries to\r
  establish a 4G page table.\r
\r
  @param[in] StackBase  Stack base address.\r
  @param[in] StackSize  Stack size.\r
\r
  @return The address of page table.\r
\r
**/\r
UINTN\r
Create4GPageTablesIa32Pae (\r
  IN EFI_PHYSICAL_ADDRESS   StackBase,\r
  IN UINTN                  StackSize\r
  )\r
{\r
  UINT8                                         PhysicalAddressBits;\r
  EFI_PHYSICAL_ADDRESS                          PhysicalAddress;\r
  UINTN                                         IndexOfPdpEntries;\r
  UINTN                                         IndexOfPageDirectoryEntries;\r
  UINT32                                        NumberOfPdpEntriesNeeded;\r
  PAGE_MAP_AND_DIRECTORY_POINTER                *PageMap;\r
  PAGE_MAP_AND_DIRECTORY_POINTER                *PageDirectoryPointerEntry;\r
  PAGE_TABLE_ENTRY                              *PageDirectoryEntry;\r
  UINTN                                         TotalPagesNum;\r
  UINTN                                         PageAddress;\r
  UINT64                                        AddressEncMask;\r
\r
  //\r
  // Make sure AddressEncMask is contained to smallest supported address field\r
  //\r
  AddressEncMask = PcdGet64 (PcdPteMemoryEncryptionAddressOrMask) & PAGING_1G_ADDRESS_MASK_64;\r
\r
  PhysicalAddressBits = 32;\r
\r
  //\r
  // Calculate the table entries needed.\r
  //\r
  NumberOfPdpEntriesNeeded = (UINT32) LShiftU64 (1, (PhysicalAddressBits - 30));\r
\r
  TotalPagesNum = NumberOfPdpEntriesNeeded + 1;\r
  PageAddress = (UINTN) AllocatePageTableMemory (TotalPagesNum);\r
  ASSERT (PageAddress != 0);\r
\r
  PageMap = (VOID *) PageAddress;\r
  PageAddress += SIZE_4KB;\r
\r
  PageDirectoryPointerEntry = PageMap;\r
  PhysicalAddress = 0;\r
\r
  for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
    //\r
    // Each Directory Pointer entries points to a page of Page Directory entires.\r
    // So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.\r
    //\r
    PageDirectoryEntry = (VOID *) PageAddress;\r
    PageAddress += SIZE_4KB;\r
\r
    //\r
    // Fill in a Page Directory Pointer Entries\r
    //\r
    PageDirectoryPointerEntry->Uint64 = (UINT64) (UINTN) PageDirectoryEntry | AddressEncMask;\r
    PageDirectoryPointerEntry->Bits.Present = 1;\r
\r
    for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PhysicalAddress += SIZE_2MB) {\r
      if ((IsNullDetectionEnabled () && PhysicalAddress == 0)\r
          || ((PhysicalAddress < StackBase + StackSize)\r
              && ((PhysicalAddress + SIZE_2MB) > StackBase))) {\r
        //\r
        // Need to split this 2M page that covers stack range.\r
        //\r
        Split2MPageTo4K (PhysicalAddress, (UINT64 *) PageDirectoryEntry, StackBase, StackSize);\r
      } else {\r
        //\r
        // Fill in the Page Directory entries\r
        //\r
        PageDirectoryEntry->Uint64 = (UINT64) PhysicalAddress | AddressEncMask;\r
        PageDirectoryEntry->Bits.ReadWrite = 1;\r
        PageDirectoryEntry->Bits.Present = 1;\r
        PageDirectoryEntry->Bits.MustBe1 = 1;\r
      }\r
    }\r
  }\r
\r
  for (; IndexOfPdpEntries < 512; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
    ZeroMem (\r
      PageDirectoryPointerEntry,\r
      sizeof (PAGE_MAP_AND_DIRECTORY_POINTER)\r
      );\r
  }\r
\r
  //\r
  // Protect the page table by marking the memory used for page table to be\r
  // read-only.\r
  //\r
  EnablePageTableProtection ((UINTN)PageMap, FALSE);\r
\r
  return (UINTN) PageMap;\r
}\r
\r
/**\r
  The function will check if IA32 PAE is supported.\r
\r
  @retval TRUE      IA32 PAE is supported.\r
  @retval FALSE     IA32 PAE is not supported.\r
\r
**/\r
BOOLEAN\r
IsIa32PaeSupport (\r
  VOID\r
  )\r
{\r
  UINT32            RegEax;\r
  UINT32            RegEdx;\r
  BOOLEAN           Ia32PaeSupport;\r
\r
  Ia32PaeSupport = FALSE;\r
  AsmCpuid (0x0, &RegEax, NULL, NULL, NULL);\r
  if (RegEax >= 0x1) {\r
    AsmCpuid (0x1, NULL, NULL, NULL, &RegEdx);\r
    if ((RegEdx & BIT6) != 0) {\r
      Ia32PaeSupport = TRUE;\r
    }\r
  }\r
\r
  return Ia32PaeSupport;\r
}\r
\r
/**\r
  The function will check if Execute Disable Bit is available.\r
\r
  @retval TRUE      Execute Disable Bit is available.\r
  @retval FALSE     Execute Disable Bit is not available.\r
\r
**/\r
BOOLEAN\r
IsExecuteDisableBitAvailable (\r
  VOID\r
  )\r
{\r
  UINT32            RegEax;\r
  UINT32            RegEdx;\r
  BOOLEAN           Available;\r
\r
  Available = FALSE;\r
  AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
  if (RegEax >= 0x80000001) {\r
    AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
    if ((RegEdx & BIT20) != 0) {\r
      //\r
      // Bit 20: Execute Disable Bit available.\r
      //\r
      Available = TRUE;\r
    }\r
  }\r
\r
  return Available;\r
}\r
\r
/**\r
  The function will check if page table should be setup or not.\r
\r
  @retval TRUE      Page table should be created.\r
  @retval FALSE     Page table should not be created.\r
\r
**/\r
BOOLEAN\r
ToBuildPageTable (\r
  VOID\r
  )\r
{\r
  if (!IsIa32PaeSupport ()) {\r
    return FALSE;\r
  }\r
\r
  if (IsNullDetectionEnabled ()) {\r
    return TRUE;\r
  }\r
\r
  if (PcdGet8 (PcdHeapGuardPropertyMask) != 0) {\r
    return TRUE;\r
  }\r
\r
  if (PcdGetBool (PcdCpuStackGuard)) {\r
    return TRUE;\r
  }\r
\r
  if (PcdGetBool (PcdSetNxForStack) && IsExecuteDisableBitAvailable ()) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
   Transfers control to DxeCore.\r
\r
   This function performs a CPU architecture specific operations to execute\r
   the entry point of DxeCore with the parameters of HobList.\r
   It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
\r
   @param DxeCoreEntryPoint         The entry point of DxeCore.\r
   @param HobList                   The start of HobList passed to DxeCore.\r
\r
**/\r
VOID\r
HandOffToDxeCore (\r
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
  IN EFI_PEI_HOB_POINTERS   HobList\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_PHYSICAL_ADDRESS      BaseOfStack;\r
  EFI_PHYSICAL_ADDRESS      TopOfStack;\r
  UINTN                     PageTables;\r
  X64_IDT_GATE_DESCRIPTOR   *IdtTable;\r
  UINTN                     SizeOfTemplate;\r
  VOID                      *TemplateBase;\r
  EFI_PHYSICAL_ADDRESS      VectorAddress;\r
  UINT32                    Index;\r
  X64_IDT_TABLE             *IdtTableForX64;\r
  EFI_VECTOR_HANDOFF_INFO   *VectorInfo;\r
  EFI_PEI_VECTOR_HANDOFF_INFO_PPI *VectorHandoffInfoPpi;\r
  BOOLEAN                   BuildPageTablesIa32Pae;\r
\r
  if (IsNullDetectionEnabled ()) {\r
    ClearFirst4KPage (HobList.Raw);\r
  }\r
\r
  Status = PeiServicesAllocatePages (EfiBootServicesData, EFI_SIZE_TO_PAGES (STACK_SIZE), &BaseOfStack);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  if (FeaturePcdGet(PcdDxeIplSwitchToLongMode)) {\r
    //\r
    // Compute the top of the stack we were allocated, which is used to load X64 dxe core.\r
    // Pre-allocate a 32 bytes which confroms to x64 calling convention.\r
    //\r
    // The first four parameters to a function are passed in rcx, rdx, r8 and r9.\r
    // Any further parameters are pushed on the stack. Furthermore, space (4 * 8bytes) for the\r
    // register parameters is reserved on the stack, in case the called function\r
    // wants to spill them; this is important if the function is variadic.\r
    //\r
    TopOfStack = BaseOfStack + EFI_SIZE_TO_PAGES (STACK_SIZE) * EFI_PAGE_SIZE - 32;\r
\r
    //\r
    //  x64 Calling Conventions requires that the stack must be aligned to 16 bytes\r
    //\r
    TopOfStack = (EFI_PHYSICAL_ADDRESS) (UINTN) ALIGN_POINTER (TopOfStack, 16);\r
\r
    //\r
    // Load the GDT of Go64. Since the GDT of 32-bit Tiano locates in the BS_DATA\r
    // memory, it may be corrupted when copying FV to high-end memory\r
    //\r
    AsmWriteGdtr (&gGdt);\r
    //\r
    // Create page table and save PageMapLevel4 to CR3\r
    //\r
    PageTables = CreateIdentityMappingPageTables (BaseOfStack, STACK_SIZE);\r
\r
    //\r
    // End of PEI phase signal\r
    //\r
    Status = PeiServicesInstallPpi (&gEndOfPeiSignalPpi);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    AsmWriteCr3 (PageTables);\r
\r
    //\r
    // Update the contents of BSP stack HOB to reflect the real stack info passed to DxeCore.\r
    //\r
    UpdateStackHob (BaseOfStack, STACK_SIZE);\r
\r
    SizeOfTemplate = AsmGetVectorTemplatInfo (&TemplateBase);\r
\r
    Status = PeiServicesAllocatePages (\r
               EfiBootServicesData,\r
               EFI_SIZE_TO_PAGES(sizeof (X64_IDT_TABLE) + SizeOfTemplate * IDT_ENTRY_COUNT),\r
               &VectorAddress\r
               );\r
    ASSERT_EFI_ERROR (Status);\r
\r
    //\r
    // Store EFI_PEI_SERVICES** in the 4 bytes immediately preceding IDT to avoid that\r
    // it may not be gotten correctly after IDT register is re-written.\r
    //\r
    IdtTableForX64 = (X64_IDT_TABLE *) (UINTN) VectorAddress;\r
    IdtTableForX64->PeiService = GetPeiServicesTablePointer ();\r
\r
    VectorAddress = (EFI_PHYSICAL_ADDRESS) (UINTN) (IdtTableForX64 + 1);\r
    IdtTable      = IdtTableForX64->IdtTable;\r
    for (Index = 0; Index < IDT_ENTRY_COUNT; Index++) {\r
      IdtTable[Index].Ia32IdtEntry.Bits.GateType    =  0x8e;\r
      IdtTable[Index].Ia32IdtEntry.Bits.Reserved_0  =  0;\r
      IdtTable[Index].Ia32IdtEntry.Bits.Selector    =  SYS_CODE64_SEL;\r
\r
      IdtTable[Index].Ia32IdtEntry.Bits.OffsetLow   = (UINT16) VectorAddress;\r
      IdtTable[Index].Ia32IdtEntry.Bits.OffsetHigh  = (UINT16) (RShiftU64 (VectorAddress, 16));\r
      IdtTable[Index].Offset32To63                  = (UINT32) (RShiftU64 (VectorAddress, 32));\r
      IdtTable[Index].Reserved                      = 0;\r
\r
      CopyMem ((VOID *) (UINTN) VectorAddress, TemplateBase, SizeOfTemplate);\r
      AsmVectorFixup ((VOID *) (UINTN) VectorAddress, (UINT8) Index);\r
\r
      VectorAddress += SizeOfTemplate;\r
    }\r
\r
    gLidtDescriptor.Base = (UINTN) IdtTable;\r
\r
    //\r
    // Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
    //\r
    SaveAndSetDebugTimerInterrupt (FALSE);\r
\r
    AsmWriteIdtr (&gLidtDescriptor);\r
\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "%a() Stack Base: 0x%lx, Stack Size: 0x%x\n",\r
      __FUNCTION__,\r
      BaseOfStack,\r
      STACK_SIZE\r
      ));\r
\r
    //\r
    // Go to Long Mode and transfer control to DxeCore.\r
    // Interrupts will not get turned on until the CPU AP is loaded.\r
    // Call x64 drivers passing in single argument, a pointer to the HOBs.\r
    //\r
    AsmEnablePaging64 (\r
      SYS_CODE64_SEL,\r
      DxeCoreEntryPoint,\r
      (EFI_PHYSICAL_ADDRESS)(UINTN)(HobList.Raw),\r
      0,\r
      TopOfStack\r
      );\r
  } else {\r
    //\r
    // Get Vector Hand-off Info PPI and build Guided HOB\r
    //\r
    Status = PeiServicesLocatePpi (\r
               &gEfiVectorHandoffInfoPpiGuid,\r
               0,\r
               NULL,\r
               (VOID **)&VectorHandoffInfoPpi\r
               );\r
    if (Status == EFI_SUCCESS) {\r
      DEBUG ((EFI_D_INFO, "Vector Hand-off Info PPI is gotten, GUIDed HOB is created!\n"));\r
      VectorInfo = VectorHandoffInfoPpi->Info;\r
      Index = 1;\r
      while (VectorInfo->Attribute != EFI_VECTOR_HANDOFF_LAST_ENTRY) {\r
        VectorInfo ++;\r
        Index ++;\r
      }\r
      BuildGuidDataHob (\r
        &gEfiVectorHandoffInfoPpiGuid,\r
        VectorHandoffInfoPpi->Info,\r
        sizeof (EFI_VECTOR_HANDOFF_INFO) * Index\r
        );\r
    }\r
\r
    //\r
    // Compute the top of the stack we were allocated. Pre-allocate a UINTN\r
    // for safety.\r
    //\r
    TopOfStack = BaseOfStack + EFI_SIZE_TO_PAGES (STACK_SIZE) * EFI_PAGE_SIZE - CPU_STACK_ALIGNMENT;\r
    TopOfStack = (EFI_PHYSICAL_ADDRESS) (UINTN) ALIGN_POINTER (TopOfStack, CPU_STACK_ALIGNMENT);\r
\r
    PageTables = 0;\r
    BuildPageTablesIa32Pae = ToBuildPageTable ();\r
    if (BuildPageTablesIa32Pae) {\r
      PageTables = Create4GPageTablesIa32Pae (BaseOfStack, STACK_SIZE);\r
      if (IsExecuteDisableBitAvailable ()) {\r
        EnableExecuteDisableBit();\r
      }\r
    }\r
\r
    //\r
    // End of PEI phase signal\r
    //\r
    Status = PeiServicesInstallPpi (&gEndOfPeiSignalPpi);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    if (BuildPageTablesIa32Pae) {\r
      AsmWriteCr3 (PageTables);\r
      //\r
      // Set Physical Address Extension (bit 5 of CR4).\r
      //\r
      AsmWriteCr4 (AsmReadCr4 () | BIT5);\r
    }\r
\r
    //\r
    // Update the contents of BSP stack HOB to reflect the real stack info passed to DxeCore.\r
    //\r
    UpdateStackHob (BaseOfStack, STACK_SIZE);\r
\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "%a() Stack Base: 0x%lx, Stack Size: 0x%x\n",\r
      __FUNCTION__,\r
      BaseOfStack,\r
      STACK_SIZE\r
      ));\r
\r
    //\r
    // Transfer the control to the entry point of DxeCore.\r
    //\r
    if (BuildPageTablesIa32Pae) {\r
      AsmEnablePaging32 (\r
        (SWITCH_STACK_ENTRY_POINT)(UINTN)DxeCoreEntryPoint,\r
        HobList.Raw,\r
        NULL,\r
        (VOID *) (UINTN) TopOfStack\r
        );\r
    } else {\r
      SwitchStack (\r
        (SWITCH_STACK_ENTRY_POINT)(UINTN)DxeCoreEntryPoint,\r
        HobList.Raw,\r
        NULL,\r
        (VOID *) (UINTN) TopOfStack\r
        );\r
    }\r
  }\r
}\r
\r
Commit	Line	Data
96226baa	1	/** @file\r
48557c65	2	Ia32-specific functionality for DxeLoad.\r
95276127	3	\r
d1102dba	4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
5997daf7 LD	5	Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>\r
5997daf7 LD	6	\r
cd5ebaa0	7	This program and the accompanying materials\r
95276127	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
96226baa	15	**/\r
95276127	16	\r
95276127	17	#include "DxeIpl.h"\r
	18	#include "VirtualMemory.h"\r
	19	\r
df7aaeb9	20	#define IDT_ENTRY_COUNT 32\r
e7af83ae	21	\r
bdfbe63e	22	typedef struct _X64_IDT_TABLE {\r
	23	//\r
	24	// Reserved 4 bytes preceding PeiService and IdtTable,\r
	25	// since IDT base address should be 8-byte alignment.\r
	26	//\r
	27	UINT32 Reserved;\r
	28	CONST EFI_PEI_SERVICES **PeiService;\r
	29	X64_IDT_GATE_DESCRIPTOR IdtTable[IDT_ENTRY_COUNT];\r
	30	} X64_IDT_TABLE;\r
	31	\r
95276127	32	//\r
	33	// Global Descriptor Table (GDT)\r
	34	//\r
b98da1b1	35	GLOBAL_REMOVE_IF_UNREFERENCED IA32_GDT gGdtEntries[] = {\r
0cf27ce0	36	/* selector { Global Segment Descriptor } */\r
0cf27ce0	37	/* 0x00 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //null descriptor\r
95276127	38	/* 0x08 */ {{0xffff, 0, 0, 0x2, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //linear data segment descriptor\r
	39	/* 0x10 */ {{0xffff, 0, 0, 0xf, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //linear code segment descriptor\r
	40	/* 0x18 */ {{0xffff, 0, 0, 0x3, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system data segment descriptor\r
	41	/* 0x20 */ {{0xffff, 0, 0, 0xa, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system code segment descriptor\r
	42	/* 0x28 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //spare segment descriptor\r
	43	/* 0x30 */ {{0xffff, 0, 0, 0x2, 1, 0, 1, 0xf, 0, 0, 1, 1, 0}}, //system data segment descriptor\r
	44	/* 0x38 */ {{0xffff, 0, 0, 0xa, 1, 0, 1, 0xf, 0, 1, 0, 1, 0}}, //system code segment descriptor\r
	45	/* 0x40 */ {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, //spare segment descriptor\r
	46	};\r
	47	\r
	48	//\r
	49	// IA32 Gdt register\r
	50	//\r
	51	GLOBAL_REMOVE_IF_UNREFERENCED CONST IA32_DESCRIPTOR gGdt = {\r
	52	sizeof (gGdtEntries) - 1,\r
	53	(UINTN) gGdtEntries\r
	54	};\r
	55	\r
5d582956	56	GLOBAL_REMOVE_IF_UNREFERENCED IA32_DESCRIPTOR gLidtDescriptor = {\r
e7af83ae	57	sizeof (X64_IDT_GATE_DESCRIPTOR) * IDT_ENTRY_COUNT - 1,\r
5d582956	58	0\r
	59	};\r
	60	\r
5630cdfe SZ	61	/**\r
	62	Allocates and fills in the Page Directory and Page Table Entries to\r
	63	establish a 4G page table.\r
	64	\r
	65	@param[in] StackBase Stack base address.\r
	66	@param[in] StackSize Stack size.\r
	67	\r
	68	@return The address of page table.\r
	69	\r
	70	**/\r
	71	UINTN\r
	72	Create4GPageTablesIa32Pae (\r
	73	IN EFI_PHYSICAL_ADDRESS StackBase,\r
	74	IN UINTN StackSize\r
	75	)\r
d1102dba	76	{\r
5630cdfe SZ	77	UINT8 PhysicalAddressBits;\r
	78	EFI_PHYSICAL_ADDRESS PhysicalAddress;\r
	79	UINTN IndexOfPdpEntries;\r
	80	UINTN IndexOfPageDirectoryEntries;\r
	81	UINT32 NumberOfPdpEntriesNeeded;\r
	82	PAGE_MAP_AND_DIRECTORY_POINTER *PageMap;\r
	83	PAGE_MAP_AND_DIRECTORY_POINTER *PageDirectoryPointerEntry;\r
	84	PAGE_TABLE_ENTRY *PageDirectoryEntry;\r
	85	UINTN TotalPagesNum;\r
	86	UINTN PageAddress;\r
5997daf7 LD	87	UINT64 AddressEncMask;\r
	88	\r
	89	//\r
	90	// Make sure AddressEncMask is contained to smallest supported address field\r
	91	//\r
	92	AddressEncMask = PcdGet64 (PcdPteMemoryEncryptionAddressOrMask) & PAGING_1G_ADDRESS_MASK_64;\r
5630cdfe SZ	93	\r
	94	PhysicalAddressBits = 32;\r
	95	\r
	96	//\r
	97	// Calculate the table entries needed.\r
	98	//\r
	99	NumberOfPdpEntriesNeeded = (UINT32) LShiftU64 (1, (PhysicalAddressBits - 30));\r
	100	\r
	101	TotalPagesNum = NumberOfPdpEntriesNeeded + 1;\r
2ac1730b	102	PageAddress = (UINTN) AllocatePageTableMemory (TotalPagesNum);\r
5630cdfe SZ	103	ASSERT (PageAddress != 0);\r
	104	\r
	105	PageMap = (VOID *) PageAddress;\r
	106	PageAddress += SIZE_4KB;\r
	107	\r
	108	PageDirectoryPointerEntry = PageMap;\r
	109	PhysicalAddress = 0;\r
	110	\r
	111	for (IndexOfPdpEntries = 0; IndexOfPdpEntries < NumberOfPdpEntriesNeeded; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
	112	//\r
	113	// Each Directory Pointer entries points to a page of Page Directory entires.\r
	114	// So allocate space for them and fill them in in the IndexOfPageDirectoryEntries loop.\r
d1102dba	115	//\r
5630cdfe SZ	116	PageDirectoryEntry = (VOID *) PageAddress;\r
	117	PageAddress += SIZE_4KB;\r
	118	\r
	119	//\r
	120	// Fill in a Page Directory Pointer Entries\r
	121	//\r
5997daf7	122	PageDirectoryPointerEntry->Uint64 = (UINT64) (UINTN) PageDirectoryEntry \| AddressEncMask;\r
5630cdfe SZ	123	PageDirectoryPointerEntry->Bits.Present = 1;\r
	124	\r
	125	for (IndexOfPageDirectoryEntries = 0; IndexOfPageDirectoryEntries < 512; IndexOfPageDirectoryEntries++, PageDirectoryEntry++, PhysicalAddress += SIZE_2MB) {\r
9189ec20 JW	126	if ((IsNullDetectionEnabled () && PhysicalAddress == 0)\r
	127	\|\| ((PhysicalAddress < StackBase + StackSize)\r
	128	&& ((PhysicalAddress + SIZE_2MB) > StackBase))) {\r
5630cdfe SZ	129	//\r
	130	// Need to split this 2M page that covers stack range.\r
	131	//\r
	132	Split2MPageTo4K (PhysicalAddress, (UINT64 *) PageDirectoryEntry, StackBase, StackSize);\r
	133	} else {\r
	134	//\r
	135	// Fill in the Page Directory entries\r
	136	//\r
5997daf7	137	PageDirectoryEntry->Uint64 = (UINT64) PhysicalAddress \| AddressEncMask;\r
5630cdfe SZ	138	PageDirectoryEntry->Bits.ReadWrite = 1;\r
	139	PageDirectoryEntry->Bits.Present = 1;\r
	140	PageDirectoryEntry->Bits.MustBe1 = 1;\r
	141	}\r
	142	}\r
	143	}\r
	144	\r
	145	for (; IndexOfPdpEntries < 512; IndexOfPdpEntries++, PageDirectoryPointerEntry++) {\r
	146	ZeroMem (\r
	147	PageDirectoryPointerEntry,\r
	148	sizeof (PAGE_MAP_AND_DIRECTORY_POINTER)\r
	149	);\r
	150	}\r
	151	\r
2ac1730b JW	152	//\r
	153	// Protect the page table by marking the memory used for page table to be\r
	154	// read-only.\r
	155	//\r
	156	EnablePageTableProtection ((UINTN)PageMap, FALSE);\r
	157	\r
5630cdfe SZ	158	return (UINTN) PageMap;\r
	159	}\r
	160	\r
	161	/**\r
	162	The function will check if IA32 PAE is supported.\r
	163	\r
	164	@retval TRUE IA32 PAE is supported.\r
	165	@retval FALSE IA32 PAE is not supported.\r
	166	\r
	167	**/\r
	168	BOOLEAN\r
	169	IsIa32PaeSupport (\r
	170	VOID\r
	171	)\r
	172	{\r
	173	UINT32 RegEax;\r
	174	UINT32 RegEdx;\r
	175	BOOLEAN Ia32PaeSupport;\r
	176	\r
	177	Ia32PaeSupport = FALSE;\r
	178	AsmCpuid (0x0, &RegEax, NULL, NULL, NULL);\r
	179	if (RegEax >= 0x1) {\r
	180	AsmCpuid (0x1, NULL, NULL, NULL, &RegEdx);\r
	181	if ((RegEdx & BIT6) != 0) {\r
	182	Ia32PaeSupport = TRUE;\r
	183	}\r
	184	}\r
	185	\r
	186	return Ia32PaeSupport;\r
	187	}\r
	188	\r
	189	/**\r
	190	The function will check if Execute Disable Bit is available.\r
	191	\r
	192	@retval TRUE Execute Disable Bit is available.\r
	193	@retval FALSE Execute Disable Bit is not available.\r
	194	\r
	195	**/\r
	196	BOOLEAN\r
	197	IsExecuteDisableBitAvailable (\r
	198	VOID\r
	199	)\r
	200	{\r
	201	UINT32 RegEax;\r
	202	UINT32 RegEdx;\r
	203	BOOLEAN Available;\r
	204	\r
	205	Available = FALSE;\r
	206	AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
	207	if (RegEax >= 0x80000001) {\r
	208	AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
	209	if ((RegEdx & BIT20) != 0) {\r
	210	//\r
	211	// Bit 20: Execute Disable Bit available.\r
	212	//\r
	213	Available = TRUE;\r
	214	}\r
	215	}\r
	216	\r
	217	return Available;\r
	218	}\r
	219	\r
e63da9f0 JW	220	/**\r
	221	The function will check if page table should be setup or not.\r
	222	\r
	223	@retval TRUE Page table should be created.\r
	224	@retval FALSE Page table should not be created.\r
	225	\r
	226	**/\r
	227	BOOLEAN\r
	228	ToBuildPageTable (\r
	229	VOID\r
	230	)\r
	231	{\r
	232	if (!IsIa32PaeSupport ()) {\r
	233	return FALSE;\r
	234	}\r
	235	\r
	236	if (IsNullDetectionEnabled ()) {\r
	237	return TRUE;\r
	238	}\r
	239	\r
	240	if (PcdGet8 (PcdHeapGuardPropertyMask) != 0) {\r
	241	return TRUE;\r
	242	}\r
	243	\r
50255363 JW	244	if (PcdGetBool (PcdCpuStackGuard)) {\r
	245	return TRUE;\r
	246	}\r
	247	\r
e63da9f0 JW	248	if (PcdGetBool (PcdSetNxForStack) && IsExecuteDisableBitAvailable ()) {\r
	249	return TRUE;\r
	250	}\r
	251	\r
	252	return FALSE;\r
	253	}\r
	254	\r
91d92e25	255	/**\r
	256	Transfers control to DxeCore.\r
	257	\r
	258	This function performs a CPU architecture specific operations to execute\r
	259	the entry point of DxeCore with the parameters of HobList.\r
48557c65	260	It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
91d92e25	261	\r
48557c65	262	@param DxeCoreEntryPoint The entry point of DxeCore.\r
91d92e25	263	@param HobList The start of HobList passed to DxeCore.\r
91d92e25	264	\r
91d92e25	265	**/\r
95276127	266	VOID\r
	267	HandOffToDxeCore (\r
	268	IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint,\r
9b937a73	269	IN EFI_PEI_HOB_POINTERS HobList\r
95276127	270	)\r
	271	{\r
	272	EFI_STATUS Status;\r
	273	EFI_PHYSICAL_ADDRESS BaseOfStack;\r
	274	EFI_PHYSICAL_ADDRESS TopOfStack;\r
	275	UINTN PageTables;\r
5d582956	276	X64_IDT_GATE_DESCRIPTOR *IdtTable;\r
	277	UINTN SizeOfTemplate;\r
	278	VOID *TemplateBase;\r
	279	EFI_PHYSICAL_ADDRESS VectorAddress;\r
	280	UINT32 Index;\r
bdfbe63e	281	X64_IDT_TABLE *IdtTableForX64;\r
57f360f2 JF	282	EFI_VECTOR_HANDOFF_INFO *VectorInfo;\r
57f360f2 JF	283	EFI_PEI_VECTOR_HANDOFF_INFO_PPI *VectorHandoffInfoPpi;\r
5630cdfe	284	BOOLEAN BuildPageTablesIa32Pae;\r
95276127	285	\r
9189ec20 JW	286	if (IsNullDetectionEnabled ()) {\r
	287	ClearFirst4KPage (HobList.Raw);\r
	288	}\r
	289	\r
95276127	290	Status = PeiServicesAllocatePages (EfiBootServicesData, EFI_SIZE_TO_PAGES (STACK_SIZE), &BaseOfStack);\r
95276127	291	ASSERT_EFI_ERROR (Status);\r
0cf27ce0	292	\r
95276127	293	if (FeaturePcdGet(PcdDxeIplSwitchToLongMode)) {\r
95276127	294	//\r
0cf27ce0	295	// Compute the top of the stack we were allocated, which is used to load X64 dxe core.\r
95276127	296	// Pre-allocate a 32 bytes which confroms to x64 calling convention.\r
95276127	297	//\r
0cf27ce0	298	// The first four parameters to a function are passed in rcx, rdx, r8 and r9.\r
	299	// Any further parameters are pushed on the stack. Furthermore, space (4 * 8bytes) for the\r
	300	// register parameters is reserved on the stack, in case the called function\r
	301	// wants to spill them; this is important if the function is variadic.\r
95276127	302	//\r
	303	TopOfStack = BaseOfStack + EFI_SIZE_TO_PAGES (STACK_SIZE) * EFI_PAGE_SIZE - 32;\r
	304	\r
	305	//\r
b98da1b1	306	// x64 Calling Conventions requires that the stack must be aligned to 16 bytes\r
95276127	307	//\r
	308	TopOfStack = (EFI_PHYSICAL_ADDRESS) (UINTN) ALIGN_POINTER (TopOfStack, 16);\r
	309	\r
	310	//\r
	311	// Load the GDT of Go64. Since the GDT of 32-bit Tiano locates in the BS_DATA\r
0cf27ce0	312	// memory, it may be corrupted when copying FV to high-end memory\r
95276127	313	//\r
	314	AsmWriteGdtr (&gGdt);\r
	315	//\r
	316	// Create page table and save PageMapLevel4 to CR3\r
	317	//\r
5630cdfe	318	PageTables = CreateIdentityMappingPageTables (BaseOfStack, STACK_SIZE);\r
95276127	319	\r
95276127	320	//\r
48557c65	321	// End of PEI phase signal\r
95276127	322	//\r
9b937a73	323	Status = PeiServicesInstallPpi (&gEndOfPeiSignalPpi);\r
95276127	324	ASSERT_EFI_ERROR (Status);\r
0cf27ce0	325	\r
95276127	326	AsmWriteCr3 (PageTables);\r
5d582956	327	\r
30c8f861	328	//\r
30c8f861	329	// Update the contents of BSP stack HOB to reflect the real stack info passed to DxeCore.\r
0cf27ce0	330	//\r
30c8f861	331	UpdateStackHob (BaseOfStack, STACK_SIZE);\r
5d582956	332	\r
4bfa7dc4	333	SizeOfTemplate = AsmGetVectorTemplatInfo (&TemplateBase);\r
	334	\r
	335	Status = PeiServicesAllocatePages (\r
0cf27ce0	336	EfiBootServicesData,\r
bdfbe63e	337	EFI_SIZE_TO_PAGES(sizeof (X64_IDT_TABLE) + SizeOfTemplate * IDT_ENTRY_COUNT),\r
b028c102	338	&VectorAddress\r
4bfa7dc4	339	);\r
	340	ASSERT_EFI_ERROR (Status);\r
	341	\r
bdfbe63e	342	//\r
	343	// Store EFI_PEI_SERVICES** in the 4 bytes immediately preceding IDT to avoid that\r
	344	// it may not be gotten correctly after IDT register is re-written.\r
	345	//\r
b028c102	346	IdtTableForX64 = (X64_IDT_TABLE *) (UINTN) VectorAddress;\r
bdfbe63e	347	IdtTableForX64->PeiService = GetPeiServicesTablePointer ();\r
	348	\r
	349	VectorAddress = (EFI_PHYSICAL_ADDRESS) (UINTN) (IdtTableForX64 + 1);\r
	350	IdtTable = IdtTableForX64->IdtTable;\r
e7af83ae	351	for (Index = 0; Index < IDT_ENTRY_COUNT; Index++) {\r
4bfa7dc4	352	IdtTable[Index].Ia32IdtEntry.Bits.GateType = 0x8e;\r
	353	IdtTable[Index].Ia32IdtEntry.Bits.Reserved_0 = 0;\r
	354	IdtTable[Index].Ia32IdtEntry.Bits.Selector = SYS_CODE64_SEL;\r
	355	\r
	356	IdtTable[Index].Ia32IdtEntry.Bits.OffsetLow = (UINT16) VectorAddress;\r
	357	IdtTable[Index].Ia32IdtEntry.Bits.OffsetHigh = (UINT16) (RShiftU64 (VectorAddress, 16));\r
	358	IdtTable[Index].Offset32To63 = (UINT32) (RShiftU64 (VectorAddress, 32));\r
	359	IdtTable[Index].Reserved = 0;\r
	360	\r
	361	CopyMem ((VOID *) (UINTN) VectorAddress, TemplateBase, SizeOfTemplate);\r
	362	AsmVectorFixup ((VOID *) (UINTN) VectorAddress, (UINT8) Index);\r
	363	\r
	364	VectorAddress += SizeOfTemplate;\r
5d582956	365	}\r
4bfa7dc4	366	\r
4bfa7dc4	367	gLidtDescriptor.Base = (UINTN) IdtTable;\r
0cf27ce0	368	\r
e7af83ae	369	//\r
	370	// Disable interrupt of Debug timer, since new IDT table cannot handle it.\r
	371	//\r
	372	SaveAndSetDebugTimerInterrupt (FALSE);\r
	373	\r
4bfa7dc4	374	AsmWriteIdtr (&gLidtDescriptor);\r
4bfa7dc4	375	\r
6fb389d0 JF	376	DEBUG ((\r
	377	DEBUG_INFO,\r
	378	"%a() Stack Base: 0x%lx, Stack Size: 0x%x\n",\r
	379	__FUNCTION__,\r
	380	BaseOfStack,\r
	381	STACK_SIZE\r
	382	));\r
	383	\r
5d582956	384	//\r
b98da1b1	385	// Go to Long Mode and transfer control to DxeCore.\r
b98da1b1	386	// Interrupts will not get turned on until the CPU AP is loaded.\r
95276127	387	// Call x64 drivers passing in single argument, a pointer to the HOBs.\r
0cf27ce0	388	//\r
95276127	389	AsmEnablePaging64 (\r
	390	SYS_CODE64_SEL,\r
	391	DxeCoreEntryPoint,\r
	392	(EFI_PHYSICAL_ADDRESS)(UINTN)(HobList.Raw),\r
	393	0,\r
	394	TopOfStack\r
	395	);\r
	396	} else {\r
57f360f2 JF	397	//\r
	398	// Get Vector Hand-off Info PPI and build Guided HOB\r
	399	//\r
	400	Status = PeiServicesLocatePpi (\r
	401	&gEfiVectorHandoffInfoPpiGuid,\r
	402	0,\r
	403	NULL,\r
	404	(VOID **)&VectorHandoffInfoPpi\r
	405	);\r
	406	if (Status == EFI_SUCCESS) {\r
	407	DEBUG ((EFI_D_INFO, "Vector Hand-off Info PPI is gotten, GUIDed HOB is created!\n"));\r
	408	VectorInfo = VectorHandoffInfoPpi->Info;\r
	409	Index = 1;\r
	410	while (VectorInfo->Attribute != EFI_VECTOR_HANDOFF_LAST_ENTRY) {\r
	411	VectorInfo ++;\r
	412	Index ++;\r
	413	}\r
	414	BuildGuidDataHob (\r
	415	&gEfiVectorHandoffInfoPpiGuid,\r
	416	VectorHandoffInfoPpi->Info,\r
	417	sizeof (EFI_VECTOR_HANDOFF_INFO) * Index\r
	418	);\r
	419	}\r
	420	\r
95276127	421	//\r
	422	// Compute the top of the stack we were allocated. Pre-allocate a UINTN\r
	423	// for safety.\r
	424	//\r
	425	TopOfStack = BaseOfStack + EFI_SIZE_TO_PAGES (STACK_SIZE) * EFI_PAGE_SIZE - CPU_STACK_ALIGNMENT;\r
	426	TopOfStack = (EFI_PHYSICAL_ADDRESS) (UINTN) ALIGN_POINTER (TopOfStack, CPU_STACK_ALIGNMENT);\r
	427	\r
09e4a8fd	428	PageTables = 0;\r
e63da9f0	429	BuildPageTablesIa32Pae = ToBuildPageTable ();\r
5630cdfe SZ	430	if (BuildPageTablesIa32Pae) {\r
5630cdfe SZ	431	PageTables = Create4GPageTablesIa32Pae (BaseOfStack, STACK_SIZE);\r
9189ec20 JW	432	if (IsExecuteDisableBitAvailable ()) {\r
	433	EnableExecuteDisableBit();\r
	434	}\r
5630cdfe SZ	435	}\r
5630cdfe SZ	436	\r
95276127	437	//\r
48557c65	438	// End of PEI phase signal\r
95276127	439	//\r
9b937a73	440	Status = PeiServicesInstallPpi (&gEndOfPeiSignalPpi);\r
95276127	441	ASSERT_EFI_ERROR (Status);\r
95276127	442	\r
5630cdfe SZ	443	if (BuildPageTablesIa32Pae) {\r
	444	AsmWriteCr3 (PageTables);\r
	445	//\r
	446	// Set Physical Address Extension (bit 5 of CR4).\r
	447	//\r
	448	AsmWriteCr4 (AsmReadCr4 () \| BIT5);\r
	449	}\r
	450	\r
30c8f861	451	//\r
30c8f861	452	// Update the contents of BSP stack HOB to reflect the real stack info passed to DxeCore.\r
0cf27ce0	453	//\r
30c8f861	454	UpdateStackHob (BaseOfStack, STACK_SIZE);\r
0cf27ce0	455	\r
6fb389d0 JF	456	DEBUG ((\r
	457	DEBUG_INFO,\r
	458	"%a() Stack Base: 0x%lx, Stack Size: 0x%x\n",\r
	459	__FUNCTION__,\r
	460	BaseOfStack,\r
	461	STACK_SIZE\r
	462	));\r
	463	\r
b98da1b1	464	//\r
	465	// Transfer the control to the entry point of DxeCore.\r
	466	//\r
5630cdfe SZ	467	if (BuildPageTablesIa32Pae) {\r
	468	AsmEnablePaging32 (\r
	469	(SWITCH_STACK_ENTRY_POINT)(UINTN)DxeCoreEntryPoint,\r
	470	HobList.Raw,\r
	471	NULL,\r
	472	(VOID *) (UINTN) TopOfStack\r
	473	);\r
	474	} else {\r
	475	SwitchStack (\r
	476	(SWITCH_STACK_ENTRY_POINT)(UINTN)DxeCoreEntryPoint,\r
	477	HobList.Raw,\r
	478	NULL,\r
	479	(VOID *) (UINTN) TopOfStack\r
	480	);\r
	481	}\r
0cf27ce0	482	}\r
95276127	483	}\r
95276127	484	\r