EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmulatorPkg / Sec / Sec.c

/*++ @file\r
  Stub SEC that is called from the OS appliation that is the root of the emulator.\r
\r
  The OS application will call the SEC with the PEI Entry Point API.\r
\r
Copyright (c) 2011, Apple Inc. All rights reserved.<BR>\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 "Sec.h"\r
\r
\r
\r
EFI_PEI_TEMPORARY_RAM_SUPPORT_PPI mSecTemporaryRamSupportPpi = {\r
  SecTemporaryRamSupport\r
};\r
\r
\r
EFI_PEI_PPI_DESCRIPTOR  gPrivateDispatchTable[] = {\r
  {\r
    EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r
    &gEfiTemporaryRamSupportPpiGuid,\r
    &mSecTemporaryRamSupportPpi\r
  }\r
};\r
\r
\r
\r
/**\r
  The entry point of PE/COFF Image for the PEI Core, that has been hijacked by this\r
  SEC that sits on top of an OS application. So the entry and exit of this module\r
  has the same API.\r
\r
  This function is the entry point for the PEI Foundation, which allows the SEC phase\r
  to pass information about the stack, temporary RAM and the Boot Firmware Volume.\r
  In addition, it also allows the SEC phase to pass services and data forward for use\r
  during the PEI phase in the form of one or more PPIs.\r
  There is no limit to the number of additional PPIs that can be passed from SEC into\r
  the PEI Foundation. As part of its initialization phase, the PEI Foundation will add\r
  these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any\r
  modules can leverage the associated service calls and/or code in these early PPIs.\r
  This function is required to call ProcessModuleEntryPointList() with the Context\r
  parameter set to NULL.  ProcessModuleEntryPoint() is never expected to return.\r
  The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as\r
  the PEI Services Table and the file handle for the PEI Core itself have been established.\r
  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
\r
  @param SecCoreData  Points to a data structure containing information about the PEI\r
                      core's operating environment, such as the size and location of\r
                      temporary RAM, the stack location and the BFV location.\r
\r
  @param PpiList      Points to a list of one or more PPI descriptors to be installed\r
                      initially by the PEI core. An empty PPI list consists of a single\r
                      descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r
                      As part of its initialization phase, the PEI Foundation will add\r
                      these SEC-hosted PPIs to its PPI database such that both the PEI\r
                      Foundation and any modules can leverage the associated service calls\r
                      and/or code in these early PPIs.\r
\r
**/\r
VOID\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_SEC_PEI_HAND_OFF   *SecCoreData,\r
  IN EFI_PEI_PPI_DESCRIPTOR *PpiList\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_PEI_FV_HANDLE         VolumeHandle;\r
  EFI_PEI_FILE_HANDLE       FileHandle;\r
  VOID                      *PeCoffImage;\r
  EFI_PEI_CORE_ENTRY_POINT  EntryPoint;\r
  EFI_PEI_PPI_DESCRIPTOR    *Ppi;\r
  EFI_PEI_PPI_DESCRIPTOR    *SecPpiList;\r
  UINTN                     SecReseveredMemorySize;\r
  UINTN                     Index;\r
\r
  EMU_MAGIC_PAGE()->PpiList = PpiList;\r
  ProcessLibraryConstructorList ();\r
\r
  DEBUG ((EFI_D_ERROR, "SEC Has Started\n"));\r
\r
  //\r
  // Add Our PPIs to the list\r
  //\r
  SecReseveredMemorySize = sizeof (gPrivateDispatchTable);\r
  for (Ppi = PpiList, Index = 1; ; Ppi++, Index++) {\r
    SecReseveredMemorySize += sizeof (EFI_PEI_PPI_DESCRIPTOR);\r
\r
    if ((Ppi->Flags & EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST) == EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST) {\r
      // Since we are appending, need to clear out privious list terminator.\r
      Ppi->Flags &= ~EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
      break;\r
    }\r
  }\r
\r
  // Keep everything on a good alignment\r
  SecReseveredMemorySize = ALIGN_VALUE (SecReseveredMemorySize, CPU_STACK_ALIGNMENT);\r
\r
#if 0\r
  // Tell the PEI Core to not use our buffer in temp RAM\r
  SecPpiList = (EFI_PEI_PPI_DESCRIPTOR *)SecCoreData->PeiTemporaryRamBase;\r
  SecCoreData->PeiTemporaryRamBase = (VOID *)((UINTN)SecCoreData->PeiTemporaryRamBase + SecReseveredMemorySize);\r
  SecCoreData->PeiTemporaryRamSize -= SecReseveredMemorySize;\r
#else\r
  {\r
    //\r
    // When I subtrack from SecCoreData->PeiTemporaryRamBase PEI Core crashes? Either there is a bug\r
    // or I don't understand temp RAM correctly?\r
    //\r
    EFI_PEI_PPI_DESCRIPTOR    PpiArray[10];\r
\r
    SecPpiList = &PpiArray[0];\r
    ASSERT (sizeof (PpiArray) >= SecReseveredMemorySize);\r
  }\r
#endif\r
  // Copy existing list, and append our entries.\r
  CopyMem (SecPpiList, PpiList, sizeof (EFI_PEI_PPI_DESCRIPTOR) * Index);\r
  CopyMem (&SecPpiList[Index], gPrivateDispatchTable, sizeof (gPrivateDispatchTable));\r
\r
  // Find PEI Core and transfer control\r
  VolumeHandle = (EFI_PEI_FV_HANDLE)(UINTN)SecCoreData->BootFirmwareVolumeBase;\r
  FileHandle   = NULL;\r
  Status = PeiServicesFfsFindNextFile (EFI_FV_FILETYPE_PEI_CORE, VolumeHandle, &FileHandle);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = PeiServicesFfsFindSectionData (EFI_SECTION_PE32, FileHandle, &PeCoffImage);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = PeCoffLoaderGetEntryPoint (PeCoffImage, (VOID **)&EntryPoint);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  // Transfer control to PEI Core\r
  EntryPoint (SecCoreData, SecPpiList);\r
\r
  // PEI Core never returns\r
  ASSERT (FALSE);\r
  return;\r
}\r
\r
\r
\r