EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Library / PrePiLib / PrePiLib.c

/** @file\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PrePi.h>\r
\r
//\r
// Hack to work in NT32\r
//\r
EFI_STATUS\r
\r
EFIAPI\r
\r
SecWinNtPeiLoadFile (\r
  IN  VOID                    *Pe32Data,\r
  IN  EFI_PHYSICAL_ADDRESS    *ImageAddress,\r
  IN  UINT64                  *ImageSize,\r
  IN  EFI_PHYSICAL_ADDRESS    *EntryPoint\r
  );\r
\r
STATIC\r
VOID*\r
EFIAPI\r
AllocateCodePages (\r
  IN  UINTN     Pages\r
  )\r
{\r
  VOID                    *Alloc;\r
  EFI_PEI_HOB_POINTERS    Hob;\r
\r
  Alloc = AllocatePages (Pages);\r
  if (Alloc == NULL) {\r
    return NULL;\r
  }\r
\r
  // find the HOB we just created, and change the type to EfiBootServicesCode\r
  Hob.Raw = GetFirstHob (EFI_HOB_TYPE_MEMORY_ALLOCATION);\r
  while (Hob.Raw != NULL) {\r
    if (Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress == (UINTN)Alloc) {\r
      Hob.MemoryAllocation->AllocDescriptor.MemoryType = EfiBootServicesCode;\r
      return Alloc;\r
    }\r
    Hob.Raw = GetNextHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, GET_NEXT_HOB (Hob));\r
  }\r
\r
  ASSERT (FALSE);\r
\r
  FreePages (Alloc, Pages);\r
  return NULL;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
LoadPeCoffImage (\r
  IN  VOID                                      *PeCoffImage,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  )\r
{\r
  RETURN_STATUS                 Status;\r
  PE_COFF_LOADER_IMAGE_CONTEXT  ImageContext;\r
  VOID                           *Buffer;\r
\r
  ZeroMem (&ImageContext, sizeof (ImageContext));\r
\r
  ImageContext.Handle    = PeCoffImage;\r
  ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r
\r
  Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  //\r
  // Allocate Memory for the image\r
  //\r
  Buffer = AllocateCodePages (EFI_SIZE_TO_PAGES((UINT32)ImageContext.ImageSize));\r
  ASSERT (Buffer != 0);\r
\r
\r
  ImageContext.ImageAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;\r
\r
  //\r
  // Load the image to our new buffer\r
  //\r
  Status = PeCoffLoaderLoadImage (&ImageContext);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Relocate the image in our new buffer\r
  //\r
  Status = PeCoffLoaderRelocateImage (&ImageContext);\r
  ASSERT_EFI_ERROR (Status);\r
\r
\r
  *ImageAddress = ImageContext.ImageAddress;\r
  *ImageSize    = ImageContext.ImageSize;\r
  *EntryPoint   = ImageContext.EntryPoint;\r
\r
  //\r
  // Flush not needed for all architectures. We could have a processor specific\r
  // function in this library that does the no-op if needed.\r
  //\r
  InvalidateInstructionCacheRange ((VOID *)(UINTN)*ImageAddress, (UINTN)*ImageSize);\r
\r
  return Status;\r
}\r
\r
\r
\r
typedef\r
VOID\r
(EFIAPI *DXE_CORE_ENTRY_POINT) (\r
  IN  VOID *HobStart\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
LoadDxeCoreFromFfsFile (\r
  IN EFI_PEI_FILE_HANDLE  FileHandle,\r
  IN UINTN                StackSize\r
  )\r
{\r
  EFI_STATUS              Status;\r
  VOID                    *PeCoffImage;\r
  EFI_PHYSICAL_ADDRESS    ImageAddress;\r
  UINT64                  ImageSize;\r
  EFI_PHYSICAL_ADDRESS    EntryPoint;\r
  VOID                    *BaseOfStack;\r
  VOID                    *TopOfStack;\r
  VOID                    *Hob;\r
  EFI_FV_FILE_INFO        FvFileInfo;\r
\r
  Status = FfsFindSectionData (EFI_SECTION_PE32, FileHandle, &PeCoffImage);\r
  if (EFI_ERROR  (Status)) {\r
    return Status;\r
  }\r
\r
\r
  Status = LoadPeCoffImage (PeCoffImage, &ImageAddress, &ImageSize, &EntryPoint);\r
// For NT32 Debug  Status = SecWinNtPeiLoadFile (PeCoffImage, &ImageAddress, &ImageSize, &EntryPoint);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Extract the DxeCore GUID file name.\r
  //\r
  Status = FfsGetFileInfo (FileHandle, &FvFileInfo);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  BuildModuleHob (&FvFileInfo.FileName, (EFI_PHYSICAL_ADDRESS)(UINTN)ImageAddress, EFI_SIZE_TO_PAGES ((UINT32) ImageSize) * EFI_PAGE_SIZE, EntryPoint);\r
\r
  DEBUG ((EFI_D_INFO | EFI_D_LOAD, "Loading DxeCore at 0x%10p EntryPoint=0x%10p\n", (VOID *)(UINTN)ImageAddress, (VOID *)(UINTN)EntryPoint));\r
\r
  Hob = GetHobList ();\r
  if (StackSize == 0) {\r
    // User the current stack\r
\r
    ((DXE_CORE_ENTRY_POINT)(UINTN)EntryPoint) (Hob);\r
  } else {\r
\r
    //\r
    // Allocate 128KB for the Stack\r
    //\r
    BaseOfStack = AllocatePages (EFI_SIZE_TO_PAGES (StackSize));\r
    ASSERT (BaseOfStack != NULL);\r
\r
    //\r
    // Compute the top of the stack we were allocated. Pre-allocate a UINTN\r
    // for safety.\r
    //\r
    TopOfStack = (VOID *) ((UINTN) BaseOfStack + EFI_SIZE_TO_PAGES (StackSize) * EFI_PAGE_SIZE - CPU_STACK_ALIGNMENT);\r
    TopOfStack = ALIGN_POINTER (TopOfStack, CPU_STACK_ALIGNMENT);\r
\r
    //\r
    // Update the contents of BSP stack HOB to reflect the real stack info passed to DxeCore.\r
    //\r
    UpdateStackHob ((EFI_PHYSICAL_ADDRESS)(UINTN) BaseOfStack, StackSize);\r
\r
    SwitchStack (\r
      (SWITCH_STACK_ENTRY_POINT)(UINTN)EntryPoint,\r
      Hob,\r
      NULL,\r
      TopOfStack\r
      );\r
\r
  }\r
\r
  // Should never get here as DXE Core does not return\r
  DEBUG ((EFI_D_ERROR, "DxeCore returned\n"));\r
  ASSERT (FALSE);\r
\r
  return EFI_DEVICE_ERROR;\r
}\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
LoadDxeCoreFromFv (\r
  IN UINTN  *FvInstance,   OPTIONAL\r
  IN UINTN  StackSize\r
  )\r
{\r
  EFI_STATUS          Status;\r
  EFI_PEI_FV_HANDLE   VolumeHandle;\r
  EFI_PEI_FILE_HANDLE FileHandle = NULL;\r
\r
  if (FvInstance != NULL) {\r
    //\r
    // Caller passed in a specific FV to try, so only try that one\r
    //\r
    Status = FfsFindNextVolume (*FvInstance, &VolumeHandle);\r
    if (!EFI_ERROR (Status)) {\r
      Status = FfsFindNextFile (EFI_FV_FILETYPE_DXE_CORE, VolumeHandle, &FileHandle);\r
    }\r
  } else {\r
    Status = FfsAnyFvFindFirstFile (EFI_FV_FILETYPE_DXE_CORE, &VolumeHandle, &FileHandle);\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    return LoadDxeCoreFromFfsFile (FileHandle, StackSize);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
DecompressFirstFv (\r
  VOID\r
  )\r
{\r
  EFI_STATUS          Status;\r
  EFI_PEI_FV_HANDLE   VolumeHandle;\r
  EFI_PEI_FILE_HANDLE FileHandle;\r
\r
  Status = FfsAnyFvFindFirstFile (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE, &VolumeHandle, &FileHandle);\r
  if (!EFI_ERROR (Status)) {\r
    Status = FfsProcessFvFile (FileHandle);\r
  }\r
\r
  return Status;\r
}\r
\r
\r