v2:
  Per Laszlo and Andrew's comments at
    https://lists.01.org/pipermail/edk2-devel/2016-November/004759.html
  SecCoreData->StackBase is VOID * type. We should use %p to dump VOID * type.
  SecCoreData->StackSize is UINTN type, but %x only could print unsinged-int
  type. We will cast it to UINT32 firstly and then use %x to print it.
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Andrew Fish <afish@apple.com>
Cc: Feng Tian <feng.tian@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
		
	
		
			
				
	
	
		
			311 lines
		
	
	
		
			9.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			311 lines
		
	
	
		
			9.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  C functions in SEC
 | 
						|
 | 
						|
  Copyright (c) 2008 - 2016, Intel Corporation. All rights reserved.<BR>
 | 
						|
  This program and the accompanying materials
 | 
						|
  are licensed and made available under the terms and conditions of the BSD License
 | 
						|
  which accompanies this distribution.  The full text of the license may be found at
 | 
						|
  http://opensource.org/licenses/bsd-license.php
 | 
						|
 | 
						|
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 | 
						|
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include "SecMain.h"
 | 
						|
 | 
						|
EFI_PEI_TEMPORARY_RAM_DONE_PPI gSecTemporaryRamDonePpi = {
 | 
						|
  SecTemporaryRamDone
 | 
						|
};
 | 
						|
 | 
						|
EFI_SEC_PLATFORM_INFORMATION_PPI  mSecPlatformInformationPpi = { SecPlatformInformation };
 | 
						|
 | 
						|
EFI_PEI_PPI_DESCRIPTOR            mPeiSecPlatformInformationPpi[] = {
 | 
						|
  {
 | 
						|
    EFI_PEI_PPI_DESCRIPTOR_PPI,
 | 
						|
    &gEfiTemporaryRamDonePpiGuid,
 | 
						|
    &gSecTemporaryRamDonePpi
 | 
						|
  },
 | 
						|
  {
 | 
						|
    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
 | 
						|
    &gEfiSecPlatformInformationPpiGuid,
 | 
						|
    &mSecPlatformInformationPpi
 | 
						|
  }
 | 
						|
};
 | 
						|
 | 
						|
//
 | 
						|
// These are IDT entries pointing to 10:FFFFFFE4h.
 | 
						|
//
 | 
						|
UINT64  mIdtEntryTemplate = 0xffff8e000010ffe4ULL;
 | 
						|
 | 
						|
/**
 | 
						|
  Caller provided function to be invoked at the end of InitializeDebugAgent().
 | 
						|
 | 
						|
  Entry point to the C language phase of SEC. After the SEC assembly
 | 
						|
  code has initialized some temporary memory and set up the stack,
 | 
						|
  the control is transferred to this function.
 | 
						|
 | 
						|
  @param[in] Context    The first input parameter of InitializeDebugAgent().
 | 
						|
 | 
						|
**/
 | 
						|
VOID
 | 
						|
NORETURN
 | 
						|
EFIAPI
 | 
						|
SecStartupPhase2(
 | 
						|
  IN VOID                     *Context
 | 
						|
  );
 | 
						|
 | 
						|
/**
 | 
						|
 | 
						|
  Entry point to the C language phase of SEC. After the SEC assembly
 | 
						|
  code has initialized some temporary memory and set up the stack,
 | 
						|
  the control is transferred to this function.
 | 
						|
 | 
						|
 | 
						|
  @param SizeOfRam           Size of the temporary memory available for use.
 | 
						|
  @param TempRamBase         Base address of temporary ram
 | 
						|
  @param BootFirmwareVolume  Base address of the Boot Firmware Volume.
 | 
						|
**/
 | 
						|
VOID
 | 
						|
EFIAPI
 | 
						|
SecStartup (
 | 
						|
  IN UINT32                   SizeOfRam,
 | 
						|
  IN UINT32                   TempRamBase,
 | 
						|
  IN VOID                     *BootFirmwareVolume
 | 
						|
  )
 | 
						|
{
 | 
						|
  EFI_SEC_PEI_HAND_OFF        SecCoreData;
 | 
						|
  IA32_DESCRIPTOR             IdtDescriptor;
 | 
						|
  SEC_IDT_TABLE               IdtTableInStack;
 | 
						|
  UINT32                      Index;
 | 
						|
  UINT32                      PeiStackSize;
 | 
						|
  EFI_STATUS                  Status;
 | 
						|
 | 
						|
  //
 | 
						|
  // Report Status Code to indicate entering SEC core
 | 
						|
  //
 | 
						|
  REPORT_STATUS_CODE (
 | 
						|
    EFI_PROGRESS_CODE,
 | 
						|
    EFI_SOFTWARE_SEC | EFI_SW_SEC_PC_ENTRY_POINT
 | 
						|
    );
 | 
						|
 | 
						|
  PeiStackSize = PcdGet32 (PcdPeiTemporaryRamStackSize);
 | 
						|
  if (PeiStackSize == 0) {
 | 
						|
    PeiStackSize = (SizeOfRam >> 1);
 | 
						|
  }
 | 
						|
 | 
						|
  ASSERT (PeiStackSize < SizeOfRam);
 | 
						|
 | 
						|
  //
 | 
						|
  // Process all libraries constructor function linked to SecCore.
 | 
						|
  //
 | 
						|
  ProcessLibraryConstructorList ();
 | 
						|
 | 
						|
  //
 | 
						|
  // Initialize floating point operating environment
 | 
						|
  // to be compliant with UEFI spec.
 | 
						|
  //
 | 
						|
  InitializeFloatingPointUnits ();
 | 
						|
 | 
						|
  // |-------------------|---->
 | 
						|
  // |IDT Table          |
 | 
						|
  // |-------------------|
 | 
						|
  // |PeiService Pointer |    PeiStackSize
 | 
						|
  // |-------------------|
 | 
						|
  // |                   |
 | 
						|
  // |      Stack        |
 | 
						|
  // |-------------------|---->
 | 
						|
  // |                   |
 | 
						|
  // |                   |
 | 
						|
  // |      Heap         |    PeiTemporayRamSize
 | 
						|
  // |                   |
 | 
						|
  // |                   |
 | 
						|
  // |-------------------|---->  TempRamBase
 | 
						|
 | 
						|
  IdtTableInStack.PeiService = 0;
 | 
						|
  for (Index = 0; Index < SEC_IDT_ENTRY_COUNT; Index ++) {
 | 
						|
    CopyMem ((VOID*)&IdtTableInStack.IdtTable[Index], (VOID*)&mIdtEntryTemplate, sizeof (UINT64));
 | 
						|
  }
 | 
						|
 | 
						|
  IdtDescriptor.Base  = (UINTN) &IdtTableInStack.IdtTable;
 | 
						|
  IdtDescriptor.Limit = (UINT16)(sizeof (IdtTableInStack.IdtTable) - 1);
 | 
						|
 | 
						|
  AsmWriteIdtr (&IdtDescriptor);
 | 
						|
 | 
						|
  //
 | 
						|
  // Setup the default exception handlers
 | 
						|
  //
 | 
						|
  Status = InitializeCpuExceptionHandlers (NULL);
 | 
						|
  ASSERT_EFI_ERROR (Status);
 | 
						|
 | 
						|
  //
 | 
						|
  // Update the base address and length of Pei temporary memory
 | 
						|
  //
 | 
						|
  SecCoreData.DataSize               = (UINT16) sizeof (EFI_SEC_PEI_HAND_OFF);
 | 
						|
  SecCoreData.BootFirmwareVolumeBase = BootFirmwareVolume;
 | 
						|
  SecCoreData.BootFirmwareVolumeSize = (UINTN)(0x100000000ULL - (UINTN) BootFirmwareVolume);
 | 
						|
  SecCoreData.TemporaryRamBase       = (VOID*)(UINTN) TempRamBase;
 | 
						|
  SecCoreData.TemporaryRamSize       = SizeOfRam;
 | 
						|
  SecCoreData.PeiTemporaryRamBase    = SecCoreData.TemporaryRamBase;
 | 
						|
  SecCoreData.PeiTemporaryRamSize    = SizeOfRam - PeiStackSize;
 | 
						|
  SecCoreData.StackBase              = (VOID*)(UINTN)(TempRamBase + SecCoreData.PeiTemporaryRamSize);
 | 
						|
  SecCoreData.StackSize              = PeiStackSize;
 | 
						|
 | 
						|
  //
 | 
						|
  // Initialize Debug Agent to support source level debug in SEC/PEI phases before memory ready.
 | 
						|
  //
 | 
						|
  InitializeDebugAgent (DEBUG_AGENT_INIT_PREMEM_SEC, &SecCoreData, SecStartupPhase2);
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Caller provided function to be invoked at the end of InitializeDebugAgent().
 | 
						|
 | 
						|
  Entry point to the C language phase of SEC. After the SEC assembly
 | 
						|
  code has initialized some temporary memory and set up the stack,
 | 
						|
  the control is transferred to this function.
 | 
						|
 | 
						|
  @param[in] Context    The first input parameter of InitializeDebugAgent().
 | 
						|
 | 
						|
**/
 | 
						|
VOID
 | 
						|
NORETURN
 | 
						|
EFIAPI
 | 
						|
SecStartupPhase2(
 | 
						|
  IN VOID                     *Context
 | 
						|
  )
 | 
						|
{
 | 
						|
  EFI_SEC_PEI_HAND_OFF        *SecCoreData;
 | 
						|
  EFI_PEI_PPI_DESCRIPTOR      *PpiList;
 | 
						|
  UINT32                      Index;
 | 
						|
  EFI_PEI_PPI_DESCRIPTOR      *AllSecPpiList;
 | 
						|
  EFI_PEI_CORE_ENTRY_POINT    PeiCoreEntryPoint;
 | 
						|
 | 
						|
  SecCoreData   = (EFI_SEC_PEI_HAND_OFF *) Context;
 | 
						|
  AllSecPpiList = (EFI_PEI_PPI_DESCRIPTOR *) SecCoreData->PeiTemporaryRamBase;
 | 
						|
  //
 | 
						|
  // Find Pei Core entry point. It will report SEC and Pei Core debug information if remote debug
 | 
						|
  // is enabled.
 | 
						|
  //
 | 
						|
  FindAndReportEntryPoints ((EFI_FIRMWARE_VOLUME_HEADER *) SecCoreData->BootFirmwareVolumeBase, &PeiCoreEntryPoint);
 | 
						|
  if (PeiCoreEntryPoint == NULL)
 | 
						|
  {
 | 
						|
    CpuDeadLoop ();
 | 
						|
  }
 | 
						|
 | 
						|
  //
 | 
						|
  // Perform platform specific initialization before entering PeiCore.
 | 
						|
  //
 | 
						|
  PpiList = SecPlatformMain (SecCoreData);
 | 
						|
  if (PpiList != NULL) {
 | 
						|
    //
 | 
						|
    // Remove the terminal flag from the terminal PPI
 | 
						|
    //
 | 
						|
    CopyMem (AllSecPpiList, mPeiSecPlatformInformationPpi, sizeof (mPeiSecPlatformInformationPpi));
 | 
						|
    Index = sizeof (mPeiSecPlatformInformationPpi) / sizeof (EFI_PEI_PPI_DESCRIPTOR) - 1;
 | 
						|
    AllSecPpiList[Index].Flags = AllSecPpiList[Index].Flags & (~EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST);
 | 
						|
 | 
						|
    //
 | 
						|
    // Append the platform additional PPI list
 | 
						|
    //
 | 
						|
    Index += 1;
 | 
						|
    while (((PpiList->Flags & EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST) != EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST)) {
 | 
						|
      CopyMem (&AllSecPpiList[Index], PpiList, sizeof (EFI_PEI_PPI_DESCRIPTOR));
 | 
						|
      Index++;
 | 
						|
      PpiList++;
 | 
						|
    }
 | 
						|
 | 
						|
    //
 | 
						|
    // Add the terminal PPI
 | 
						|
    //
 | 
						|
    CopyMem (&AllSecPpiList[Index ++], PpiList, sizeof (EFI_PEI_PPI_DESCRIPTOR));
 | 
						|
 | 
						|
    //
 | 
						|
    // Set PpiList to the total PPI
 | 
						|
    //
 | 
						|
    PpiList = AllSecPpiList;
 | 
						|
 | 
						|
    //
 | 
						|
    // Adjust PEI TEMP RAM Range.
 | 
						|
    //
 | 
						|
    ASSERT (SecCoreData->PeiTemporaryRamSize > Index * sizeof (EFI_PEI_PPI_DESCRIPTOR));
 | 
						|
    SecCoreData->PeiTemporaryRamBase = (VOID *)((UINTN) SecCoreData->PeiTemporaryRamBase + Index * sizeof (EFI_PEI_PPI_DESCRIPTOR));
 | 
						|
    SecCoreData->PeiTemporaryRamSize = SecCoreData->PeiTemporaryRamSize - Index * sizeof (EFI_PEI_PPI_DESCRIPTOR);
 | 
						|
  } else {
 | 
						|
    //
 | 
						|
    // No addition PPI, PpiList directly point to the common PPI list.
 | 
						|
    //
 | 
						|
    PpiList = &mPeiSecPlatformInformationPpi[0];
 | 
						|
  }
 | 
						|
 | 
						|
  DEBUG ((
 | 
						|
    DEBUG_INFO,
 | 
						|
    "%a() Stack Base: 0x%p, Stack Size: 0x%x\n",
 | 
						|
    __FUNCTION__,
 | 
						|
    SecCoreData->StackBase,
 | 
						|
    (UINT32) SecCoreData->StackSize
 | 
						|
    ));
 | 
						|
 | 
						|
  //
 | 
						|
  // Report Status Code to indicate transferring to PEI core
 | 
						|
  //
 | 
						|
  REPORT_STATUS_CODE (
 | 
						|
    EFI_PROGRESS_CODE,
 | 
						|
    EFI_SOFTWARE_SEC | EFI_SW_SEC_PC_HANDOFF_TO_NEXT
 | 
						|
    );
 | 
						|
 | 
						|
  //
 | 
						|
  // Transfer the control to the PEI core
 | 
						|
  //
 | 
						|
  ASSERT (PeiCoreEntryPoint != NULL);
 | 
						|
  (*PeiCoreEntryPoint) (SecCoreData, PpiList);
 | 
						|
 | 
						|
  //
 | 
						|
  // Should not come here.
 | 
						|
  //
 | 
						|
  UNREACHABLE ();
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked
 | 
						|
  by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.
 | 
						|
 | 
						|
  @retval EFI_SUCCESS           Use of Temporary RAM was disabled.
 | 
						|
  @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.
 | 
						|
 | 
						|
**/
 | 
						|
EFI_STATUS
 | 
						|
EFIAPI
 | 
						|
SecTemporaryRamDone (
 | 
						|
  VOID
 | 
						|
  )
 | 
						|
{
 | 
						|
  BOOLEAN  State;
 | 
						|
 | 
						|
  //
 | 
						|
  // Republish Sec Platform Information(2) PPI
 | 
						|
  //
 | 
						|
  RepublishSecPlatformInformationPpi ();
 | 
						|
 | 
						|
  //
 | 
						|
  // Migrate DebugAgentContext.
 | 
						|
  //
 | 
						|
  InitializeDebugAgent (DEBUG_AGENT_INIT_POSTMEM_SEC, NULL, NULL);
 | 
						|
 | 
						|
  //
 | 
						|
  // Disable interrupts and save current interrupt state
 | 
						|
  //
 | 
						|
  State = SaveAndDisableInterrupts();
 | 
						|
 | 
						|
  //
 | 
						|
  // Disable Temporary RAM after Stack and Heap have been migrated at this point.
 | 
						|
  //
 | 
						|
  SecPlatformDisableTemporaryMemory ();
 | 
						|
 | 
						|
  //
 | 
						|
  // Restore original interrupt state
 | 
						|
  //
 | 
						|
  SetInterruptState (State);
 | 
						|
 | 
						|
  return EFI_SUCCESS;
 | 
						|
}
 |