X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FCore%2FDxeIplPeim%2FDxeIpl.h;h=2f015befceca66375f9393928714c55beb626afb;hp=b046f392226bae42217a4f5eeb68a8d2715195bb;hb=HEAD;hpb=5f597758e20f046a7a76e728370b99308cf2c8a0 diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h index b046f39222..2f015befce 100644 --- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h +++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h @@ -1,15 +1,9 @@ /** @file Master header file for DxeIpl PEIM. All source files in this module should - include this file for common defininitions. + include this file for common definitions. -Copyright (c) 2006 - 2008, Intel Corporation.
-All rights reserved. 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. +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -21,10 +15,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include #include #include -#include #include #include +#include +#include +#include +#include +#include +#include +#include #include #include @@ -34,124 +34,90 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include #include #include -#include #include #include -#include #include #include #include -#include -#include -#include +#include +#include +#include #define STACK_SIZE 0x20000 #define BSP_STORE_SIZE 0x4000 -#define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1)) - -extern BOOLEAN gInMemory; - - - +// +// This PPI is installed to indicate the end of the PEI usage of memory +// +extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi; /** - Loads and relocates a PE/COFF image into memory. + This function installs the PPIs that require permanent memory. + + @param PeiServices Indirect reference to the PEI Services Table. + @param NotifyDescriptor Address of the notification descriptor data structure. + @param Ppi Address of the PPI that was installed. - @param FileHandle The image file handle - @param ImageAddress The base address of the relocated PE/COFF image - @param ImageSize The size of the relocated PE/COFF image - @param EntryPoint The entry point of the relocated PE/COFF image - - @return EFI_SUCCESS The file was loaded and relocated - @return EFI_OUT_OF_RESOURCES There was not enough memory to load and relocate the PE/COFF file + @return EFI_SUCCESS The PPIs were installed successfully. + @return Others Some error occurs during the execution of this function. **/ EFI_STATUS -PeiLoadFile ( - IN EFI_PEI_FILE_HANDLE FileHandle, - OUT EFI_PHYSICAL_ADDRESS *ImageAddress, - OUT UINT64 *ImageSize, - OUT EFI_PHYSICAL_ADDRESS *EntryPoint +EFIAPI +InstallIplPermanentMemoryPpis ( + IN EFI_PEI_SERVICES **PeiServices, + IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor, + IN VOID *Ppi ); - - /** - Find DxeCore driver from all First Volumes. + Searches DxeCore in all firmware Volumes and loads the first + instance that contains DxeCore. - @param FileHandle Pointer to FFS file to search. - - @return EFI_SUCESS Success to find the FFS in specificed FV - @return others Fail to find the FFS in specificed FV + @return FileHandle of DxeCore to load DxeCore. **/ -EFI_STATUS +EFI_PEI_FILE_HANDLE DxeIplFindDxeCore ( - OUT EFI_PEI_FILE_HANDLE *FileHandle + VOID ); - - /** - This function simply retrieves the function pointer of ImageRead in - ImageContext structure. - - @param ImageContext A pointer to the structure of - PE_COFF_LOADER_IMAGE_CONTEXT - - @retval EFI_SUCCESS This function always return EFI_SUCCESS. - -**/ -EFI_STATUS -GetImageReadFunction ( - IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext - ); - - + Main entry point to last PEIM -/** - Main entry point to last PEIM - @param This Entry point for DXE IPL PPI @param PeiServices General purpose services available to every PEIM. @param HobList Address to the Pei HOB list - - @return EFI_SUCCESS DXE core was successfully loaded. + + @return EFI_SUCCESS DXE core was successfully loaded. @return EFI_OUT_OF_RESOURCES There are not enough resources to load DXE core. **/ EFI_STATUS EFIAPI DxeLoadCore ( - IN EFI_DXE_IPL_PPI *This, - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_PEI_HOB_POINTERS HobList + IN CONST EFI_DXE_IPL_PPI *This, + IN EFI_PEI_SERVICES **PeiServices, + IN EFI_PEI_HOB_POINTERS HobList ); - - /** Transfers control to DxeCore. This function performs a CPU architecture specific operations to execute the entry point of DxeCore with the parameters of HobList. - It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase. + It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase. - @param DxeCoreEntryPoint The entrypoint of DxeCore. + @param DxeCoreEntryPoint The entry point of DxeCore. @param HobList The start of HobList passed to DxeCore. - @param EndOfPeiSignal The PPI descriptor for EFI_END_OF_PEI_PPI. **/ VOID HandOffToDxeCore ( - IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint, - IN EFI_PEI_HOB_POINTERS HobList, - IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal + IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint, + IN EFI_PEI_HOB_POINTERS HobList ); - - /** Updates the Stack HOB passed to DXE phase. @@ -164,27 +130,101 @@ HandOffToDxeCore ( **/ VOID UpdateStackHob ( - IN EFI_PHYSICAL_ADDRESS BaseAddress, - IN UINT64 Length + IN EFI_PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length ); +/** + The ExtractSection() function processes the input section and + returns a pointer to the section contents. If the section being + extracted does not require processing (if the section + GuidedSectionHeader.Attributes has the + EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then + OutputBuffer is just updated to point to the start of the + section's contents. Otherwise, *Buffer must be allocated + from PEI permanent memory. + + @param This Indicates the + EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance. + Buffer containing the input GUIDed section to be + processed. OutputBuffer OutputBuffer is + allocated from PEI permanent memory and contains + the new section stream. + @param InputSection A pointer to the input buffer, which contains + the input section to be processed. + @param OutputBuffer A pointer to a caller-allocated buffer, whose + size is specified by the contents of OutputSize. + @param OutputSize A pointer to a caller-allocated + UINTN in which the size of *OutputBuffer + allocation is stored. If the function + returns anything other than EFI_SUCCESS, + the value of OutputSize is undefined. + @param AuthenticationStatus A pointer to a caller-allocated + UINT32 that indicates the + authentication status of the + output buffer. If the input + section's GuidedSectionHeader. + Attributes field has the + EFI_GUIDED_SECTION_AUTH_STATUS_VALID + bit as clear, + AuthenticationStatus must return + zero. These bits reflect the + status of the extraction + operation. If the function + returns anything other than + EFI_SUCCESS, the value of + AuthenticationStatus is + undefined. + + @retval EFI_SUCCESS The InputSection was + successfully processed and the + section contents were returned. + + @retval EFI_OUT_OF_RESOURCES The system has insufficient + resources to process the request. + + @retval EFI_INVALID_PARAMETER The GUID in InputSection does + not match this instance of the + GUIDed Section Extraction PPI. +**/ +EFI_STATUS +EFIAPI +CustomGuidedSectionExtract ( + IN CONST EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This, + IN CONST VOID *InputSection, + OUT VOID **OutputBuffer, + OUT UINTN *OutputSize, + OUT UINT32 *AuthenticationStatus + ); /** - Initializes the Dxe Ipl PPI + Decompresses a section to the output buffer. + + This function looks up the compression type field in the input section and + applies the appropriate compression algorithm to compress the section to a + callee allocated buffer. - @param FfsHandle The handle of FFS file. - @param PeiServices General purpose services available to - every PEIM. - @return EFI_SUCESS + @param This Points to this instance of the + EFI_PEI_DECOMPRESS_PEI PPI. + @param CompressionSection Points to the compressed section. + @param OutputBuffer Holds the returned pointer to the decompressed + sections. + @param OutputSize Holds the returned size of the decompress + section streams. + + @retval EFI_SUCCESS The section was decompressed successfully. + OutputBuffer contains the resulting data and + OutputSize contains the resulting size. **/ EFI_STATUS EFIAPI -PeimInitializeDxeIpl ( - IN EFI_PEI_FILE_HANDLE FfsHandle, - IN EFI_PEI_SERVICES **PeiServices +Decompress ( + IN CONST EFI_PEI_DECOMPRESS_PPI *This, + IN CONST EFI_COMPRESSION_SECTION *CompressionSection, + OUT VOID **OutputBuffer, + OUT UINTN *OutputSize ); - #endif