UefiPayloadPkg/PayloadLoaderPeim/PayloadLoaderPeim.c

   1 /** @file
   2   ELF Load Image Support
   3
   4 Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include <PiPei.h>
  10 #include <UniversalPayload/UniversalPayload.h>
  11 #include <UniversalPayload/ExtraData.h>
  12
  13 #include <Ppi/LoadFile.h>
  14
  15 #include <Library/DebugLib.h>
  16 #include <Library/HobLib.h>
  17 #include <Library/PeiServicesLib.h>
  18 #include <Library/MemoryAllocationLib.h>
  19 #include <Library/BaseMemoryLib.h>
  20
  21 #include "ElfLib.h"
  22
  23 /**
  24   The wrapper function of PeiLoadImageLoadImage().
  25
  26   @param This            - Pointer to EFI_PEI_LOAD_FILE_PPI.
  27   @param FileHandle      - Pointer to the FFS file header of the image.
  28   @param ImageAddressArg - Pointer to PE/TE image.
  29   @param ImageSizeArg    - Size of PE/TE image.
  30   @param EntryPoint      - Pointer to entry point of specified image file for output.
  31   @param AuthenticationState - Pointer to attestation authentication state of image.
  32
  33   @return Status of PeiLoadImageLoadImage().
  34
  35 **/
  36 EFI_STATUS
  37 EFIAPI
  38 PeiLoadFileLoadPayload (
  39   IN     CONST EFI_PEI_LOAD_FILE_PPI  *This,
  40   IN     EFI_PEI_FILE_HANDLE          FileHandle,
  41   OUT    EFI_PHYSICAL_ADDRESS         *ImageAddressArg,  OPTIONAL
  42   OUT    UINT64                       *ImageSizeArg,     OPTIONAL
  43   OUT    EFI_PHYSICAL_ADDRESS         *EntryPoint,
  44   OUT    UINT32                       *AuthenticationState
  45   )
  46 {
  47   EFI_STATUS                    Status;
  48   VOID                          *Elf;
  49   UNIVERSAL_PAYLOAD_EXTRA_DATA  *ExtraData;
  50   ELF_IMAGE_CONTEXT             Context;
  51   UNIVERSAL_PAYLOAD_INFO_HEADER *PldInfo;
  52   UINT32                        Index;
  53   UINT16                        ExtraDataIndex;
  54   CHAR8                         *SectionName;
  55   UINTN                         Offset;
  56   UINTN                         Size;
  57   UINT32                        ExtraDataCount;
  58   UINTN                         Instance;
  59   UINTN                         Length;
  60
  61   //
  62   // ELF is added to file as RAW section for EDKII bootloader.
  63   // But RAW section might be added by build tool before the ELF RAW section when alignment is specified for ELF RAW section.
  64   // Below loop skips the RAW section that doesn't contain valid ELF image.
  65   //
  66   Instance = 0;
  67   do {
  68     Status = PeiServicesFfsFindSectionData3 (EFI_SECTION_RAW, Instance++, FileHandle, &Elf, AuthenticationState);
  69     if (EFI_ERROR (Status)) {
  70       return Status;
  71     }
  72
  73     ZeroMem (&Context, sizeof (Context));
  74     Status = ParseElfImage (Elf, &Context);
  75   } while (EFI_ERROR (Status));
  76
  77   DEBUG ((
  78     DEBUG_INFO, "Payload File Size: 0x%08X, Mem Size: 0x%08x, Reload: %d\n",
  79     Context.FileSize, Context.ImageSize, Context.ReloadRequired
  80     ));
  81
  82   //
  83   // Get UNIVERSAL_PAYLOAD_INFO_HEADER and number of additional PLD sections.
  84   //
  85   PldInfo        = NULL;
  86   ExtraDataCount = 0;
  87   for (Index = 0; Index < Context.ShNum; Index++) {
  88     Status = GetElfSectionName (&Context, Index, &SectionName);
  89     if (EFI_ERROR(Status)) {
  90       continue;
  91     }
  92     DEBUG ((DEBUG_INFO, "Payload Section[%d]: %a\n", Index, SectionName));
  93     if (AsciiStrCmp(SectionName, UNIVERSAL_PAYLOAD_INFO_SEC_NAME) == 0) {
  94       Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
  95       if (!EFI_ERROR(Status)) {
  96         PldInfo = (UNIVERSAL_PAYLOAD_INFO_HEADER *)(Context.FileBase + Offset);
  97       }
  98     } else if (AsciiStrnCmp(SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {
  99       Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
 100       if (!EFI_ERROR (Status)) {
 101         ExtraDataCount++;
 102       }
 103     }
 104   }
 105
 106   //
 107   // Report the additional PLD sections through HOB.
 108   //
 109   Length = sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA) + ExtraDataCount * sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY);
 110   ExtraData = BuildGuidHob (
 111                &gUniversalPayloadExtraDataGuid,
 112                Length
 113                );
 114   ExtraData->Count = ExtraDataCount;
 115   ExtraData->Header.Revision = UNIVERSAL_PAYLOAD_EXTRA_DATA_REVISION;
 116   ExtraData->Header.Length = (UINT16) Length;
 117   if (ExtraDataCount != 0) {
 118     for (ExtraDataIndex = 0, Index = 0; Index < Context.ShNum; Index++) {
 119       Status = GetElfSectionName (&Context, Index, &SectionName);
 120       if (EFI_ERROR(Status)) {
 121         continue;
 122       }
 123       if (AsciiStrnCmp(SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {
 124         Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
 125         if (!EFI_ERROR (Status)) {
 126           ASSERT (ExtraDataIndex < ExtraDataCount);
 127           AsciiStrCpyS (
 128             ExtraData->Entry[ExtraDataIndex].Identifier,
 129             sizeof(ExtraData->Entry[ExtraDataIndex].Identifier),
 130             SectionName + UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH
 131             );
 132           ExtraData->Entry[ExtraDataIndex].Base = (UINTN)(Context.FileBase + Offset);
 133           ExtraData->Entry[ExtraDataIndex].Size = Size;
 134           ExtraDataIndex++;
 135         }
 136       }
 137     }
 138   }
 139
 140   if (Context.ReloadRequired || Context.PreferredImageAddress != Context.FileBase) {
 141     Context.ImageAddress = AllocatePages (EFI_SIZE_TO_PAGES (Context.ImageSize));
 142   } else {
 143     Context.ImageAddress = Context.FileBase;
 144   }
 145
 146   //
 147   // Load ELF into the required base
 148   //
 149   Status = LoadElfImage (&Context);
 150   if (!EFI_ERROR(Status)) {
 151     *ImageAddressArg = (UINTN) Context.ImageAddress;
 152     *EntryPoint      = Context.EntryPoint;
 153     *ImageSizeArg    = Context.ImageSize;
 154   }
 155   return Status;
 156 }
 157
 158
 159 EFI_PEI_LOAD_FILE_PPI   mPeiLoadFilePpi = {
 160   PeiLoadFileLoadPayload
 161 };
 162
 163
 164 EFI_PEI_PPI_DESCRIPTOR     gPpiLoadFilePpiList = {
 165   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
 166   &gEfiPeiLoadFilePpiGuid,
 167   &mPeiLoadFilePpi
 168 };
 169 /**
 170
 171   Install Pei Load File PPI.
 172
 173   @param  FileHandle  Handle of the file being invoked.
 174   @param  PeiServices Describes the list of possible PEI Services.
 175
 176   @retval EFI_SUCESS  The entry point executes successfully.
 177   @retval Others      Some error occurs during the execution of this function.
 178
 179 **/
 180 EFI_STATUS
 181 EFIAPI
 182 InitializePayloadLoaderPeim (
 183   IN       EFI_PEI_FILE_HANDLE  FileHandle,
 184   IN CONST EFI_PEI_SERVICES     **PeiServices
 185   )
 186 {
 187   EFI_STATUS  Status;
 188   Status = PeiServicesInstallPpi (&gPpiLoadFilePpiList);
 189
 190   return Status;
 191 }