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,
  79     "Payload File Size: 0x%08X, Mem Size: 0x%08x, Reload: %d\n",
  80     Context.FileSize,
  81     Context.ImageSize,
  82     Context.ReloadRequired
  83     ));
  84
  85   //
  86   // Get UNIVERSAL_PAYLOAD_INFO_HEADER and number of additional PLD sections.
  87   //
  88   PldInfo        = NULL;
  89   ExtraDataCount = 0;
  90   for (Index = 0; Index < Context.ShNum; Index++) {
  91     Status = GetElfSectionName (&Context, Index, &SectionName);
  92     if (EFI_ERROR (Status)) {
  93       continue;
  94     }
  95
  96     DEBUG ((DEBUG_INFO, "Payload Section[%d]: %a\n", Index, SectionName));
  97     if (AsciiStrCmp (SectionName, UNIVERSAL_PAYLOAD_INFO_SEC_NAME) == 0) {
  98       Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
  99       if (!EFI_ERROR (Status)) {
 100         PldInfo = (UNIVERSAL_PAYLOAD_INFO_HEADER *)(Context.FileBase + Offset);
 101       }
 102     } else if (AsciiStrnCmp (SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {
 103       Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
 104       if (!EFI_ERROR (Status)) {
 105         ExtraDataCount++;
 106       }
 107     }
 108   }
 109
 110   //
 111   // Report the additional PLD sections through HOB.
 112   //
 113   Length    = sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA) + ExtraDataCount * sizeof (UNIVERSAL_PAYLOAD_EXTRA_DATA_ENTRY);
 114   ExtraData = BuildGuidHob (
 115                 &gUniversalPayloadExtraDataGuid,
 116                 Length
 117                 );
 118   ExtraData->Count           = ExtraDataCount;
 119   ExtraData->Header.Revision = UNIVERSAL_PAYLOAD_EXTRA_DATA_REVISION;
 120   ExtraData->Header.Length   = (UINT16)Length;
 121   if (ExtraDataCount != 0) {
 122     for (ExtraDataIndex = 0, Index = 0; Index < Context.ShNum; Index++) {
 123       Status = GetElfSectionName (&Context, Index, &SectionName);
 124       if (EFI_ERROR (Status)) {
 125         continue;
 126       }
 127
 128       if (AsciiStrnCmp (SectionName, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX, UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH) == 0) {
 129         Status = GetElfSectionPos (&Context, Index, &Offset, &Size);
 130         if (!EFI_ERROR (Status)) {
 131           ASSERT (ExtraDataIndex < ExtraDataCount);
 132           AsciiStrCpyS (
 133             ExtraData->Entry[ExtraDataIndex].Identifier,
 134             sizeof (ExtraData->Entry[ExtraDataIndex].Identifier),
 135             SectionName + UNIVERSAL_PAYLOAD_EXTRA_SEC_NAME_PREFIX_LENGTH
 136             );
 137           ExtraData->Entry[ExtraDataIndex].Base = (UINTN)(Context.FileBase + Offset);
 138           ExtraData->Entry[ExtraDataIndex].Size = Size;
 139           ExtraDataIndex++;
 140         }
 141       }
 142     }
 143   }
 144
 145   if (Context.ReloadRequired || (Context.PreferredImageAddress != Context.FileBase)) {
 146     Context.ImageAddress = AllocatePages (EFI_SIZE_TO_PAGES (Context.ImageSize));
 147   } else {
 148     Context.ImageAddress = Context.FileBase;
 149   }
 150
 151   //
 152   // Load ELF into the required base
 153   //
 154   Status = LoadElfImage (&Context);
 155   if (!EFI_ERROR (Status)) {
 156     *ImageAddressArg = (UINTN)Context.ImageAddress;
 157     *EntryPoint      = Context.EntryPoint;
 158     *ImageSizeArg    = Context.ImageSize;
 159   }
 160
 161   return Status;
 162 }
 163
 164 EFI_PEI_LOAD_FILE_PPI  mPeiLoadFilePpi = {
 165   PeiLoadFileLoadPayload
 166 };
 167
 168 EFI_PEI_PPI_DESCRIPTOR  gPpiLoadFilePpiList = {
 169   (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
 170   &gEfiPeiLoadFilePpiGuid,
 171   &mPeiLoadFilePpi
 172 };
 173
 174 /**
 175
 176   Install Pei Load File PPI.
 177
 178   @param  FileHandle  Handle of the file being invoked.
 179   @param  PeiServices Describes the list of possible PEI Services.
 180
 181   @retval EFI_SUCESS  The entry point executes successfully.
 182   @retval Others      Some error occurs during the execution of this function.
 183
 184 **/
 185 EFI_STATUS
 186 EFIAPI
 187 InitializePayloadLoaderPeim (
 188   IN       EFI_PEI_FILE_HANDLE  FileHandle,
 189   IN CONST EFI_PEI_SERVICES     **PeiServices
 190   )
 191 {
 192   EFI_STATUS  Status;
 193
 194   Status = PeiServicesInstallPpi (&gPpiLoadFilePpiList);
 195
 196   return Status;
 197 }