X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FCore%2FDxeIplPeim%2FDxeIpl.h;h=063fefb414b051b936cabce0fec20155788567f6;hb=9d510e61fceee7b92955ef9a3c20343752d8ce3f;hp=3cd9ebac4ca6cf5d309c00b4054a37c8f66bba09;hpb=b0d803fe3e5c55a9a0c75bc90ccf40ebbbc9ffa3;p=mirror_edk2.git

diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
index 3cd9ebac4c..063fefb414 100644
--- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
+++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
@@ -1,40 +1,30 @@
-/*++
+/** @file
+  Master header file for DxeIpl PEIM. All source files in this module should
+  include this file for common definitions.
 
-Copyright (c) 2006, 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+SPDX-License-Identifier: BSD-2-Clause-Patent
 
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-Module Name:
-
-  DxeIpl.h
-
-Abstract:
-
---*/
+**/
 
 #ifndef __PEI_DXEIPL_H__
 #define __PEI_DXEIPL_H__
 
 #include <PiPei.h>
 #include <Ppi/DxeIpl.h>
-#include <Ppi/S3Resume.h>
-#include <Protocol/EdkDecompress.h>
 #include <Ppi/EndOfPeiPhase.h>
-#include <Protocol/CustomizedDecompress.h>
-#include <Protocol/Decompress.h>
-#include <Ppi/Security.h>
-#include <Ppi/SectionExtraction.h>
-#include <Ppi/FvLoadFile.h>
-#include <Ppi/RecoveryModule.h>
 #include <Ppi/MemoryDiscovered.h>
+#include <Ppi/ReadOnlyVariable2.h>
 #include <Ppi/Decompress.h>
 #include <Ppi/FirmwareVolumeInfo.h>
+#include <Ppi/GuidedSectionExtraction.h>
+#include <Ppi/LoadFile.h>
+#include <Ppi/S3Resume2.h>
+#include <Ppi/RecoveryModule.h>
+#include <Ppi/VectorHandoffInfo.h>
 
+#include <Guid/MemoryTypeInformation.h>
+#include <Guid/MemoryAllocationHob.h>
 #include <Guid/FirmwareFileSystem2.h>
 
 #include <Library/DebugLib.h>
@@ -43,118 +33,206 @@ Abstract:
 #include <Library/HobLib.h>
 #include <Library/PeiServicesLib.h>
 #include <Library/ReportStatusCodeLib.h>
-#include <Library/CacheMaintenanceLib.h>
-#include <Library/PeCoffLoaderLib.h>
 #include <Library/UefiDecompressLib.h>
-#include <Library/CustomDecompressLib.h>
-#include <Library/PeiServicesTablePointerLib.h>
+#include <Library/ExtractGuidedSectionLib.h>
 #include <Library/BaseMemoryLib.h>
 #include <Library/MemoryAllocationLib.h>
 #include <Library/PcdLib.h>
-#include <Library/PeCoffLib.h>
-
+#include <Library/S3Lib.h>
+#include <Library/RecoveryLib.h>
+#include <Library/DebugAgentLib.h>
+#include <Library/PeiServicesTablePointerLib.h>
+#include <Library/PerformanceLib.h>
 
 #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;
 
-EFI_STATUS
-PeiFindFile (
-  IN  UINT8                  Type,
-  IN  EFI_SECTION_TYPE       SectionType,
-  OUT EFI_GUID               *FileName,
-  OUT VOID                   **Pe32Data
-  )
-;
+/**
+   This function installs the PPIs that require permanent memory.
 
-EFI_STATUS
-PeiLoadFile (
-  IN  EFI_PEI_FILE_HANDLE                       FileHandle,
-  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,
-  OUT UINT64                                    *ImageSize,
-  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint
-  )
-;
+   @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.
 
-EFI_STATUS
-DxeIplAddEncapsulatedFirmwareVolumes (
-  VOID
-  )
-;
+   @return EFI_SUCCESS      The PPIs were installed successfully.
+   @return Others           Some error occurs during the execution of this function.
 
+**/
 EFI_STATUS
-DxeIplFindFirmwareVolumeInstance (
-  IN OUT UINTN              *Instance,
-  IN  EFI_FV_FILETYPE       SeachType,
-  OUT EFI_PEI_FV_HANDLE     *VolumeHandle,
-  OUT EFI_PEI_FILE_HANDLE   *FileHandle
-  )
-;
+EFIAPI
+InstallIplPermanentMemoryPpis (
+  IN EFI_PEI_SERVICES           **PeiServices,
+  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,
+  IN VOID                       *Ppi
+  );
 
-EFI_STATUS
-GetImageReadFunction (
-  IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
-  )
-;
+/**
+   Searches DxeCore in all firmware Volumes and loads the first
+   instance that contains DxeCore.
 
-EFI_STATUS
-PeiImageRead (
-  IN     VOID    *FileHandle,
-  IN     UINTN   FileOffset,
-  IN OUT UINTN   *ReadSize,
-  OUT    VOID    *Buffer
-  )
-;
+   @return FileHandle of DxeCore to load DxeCore.
 
-EFI_STATUS
-EFIAPI
-DxeIplLoadFile (
-  IN EFI_PEI_FV_FILE_LOADER_PPI                 *This,
-  IN  EFI_FFS_FILE_HEADER                       *FfsHeader,
-  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,
-  OUT UINT64                                    *ImageSize,
-  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint
+**/
+EFI_PEI_FILE_HANDLE
+DxeIplFindDxeCore (
+  VOID
   );
 
-EFI_STATUS
-ShadowDxeIpl (
-  IN EFI_FFS_FILE_HEADER                       *DxeIpl,
-  IN EFI_PEI_PE_COFF_LOADER_PROTOCOL           *PeiEfiPeiPeCoffLoader
-  );
 
+/**
+   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_OUT_OF_RESOURCES     There are not enough resources to load DXE core.
+
+**/
 EFI_STATUS
 EFIAPI
 DxeLoadCore (
-  IN EFI_DXE_IPL_PPI       *This,
+  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 installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.
+
+   @param DxeCoreEntryPoint         The entry point of DxeCore.
+   @param HobList                   The start of HobList passed to DxeCore.
+
+**/
 VOID
 HandOffToDxeCore (
   IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,
-  IN EFI_PEI_HOB_POINTERS   HobList,
-  IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal
+  IN EFI_PEI_HOB_POINTERS   HobList
   );
 
-EFI_STATUS
-PeiProcessFile (
-  IN      EFI_SECTION_TYPE       SectionType,
-  IN      EFI_FFS_FILE_HEADER    *FfsFileHeader,
-  OUT     VOID                   **Pe32Data,
-  IN      EFI_PEI_HOB_POINTERS   *OrigHob
+
+
+/**
+   Updates the Stack HOB passed to DXE phase.
+
+   This function traverses the whole HOB list and update the stack HOB to
+   reflect the real stack that is used by DXE core.
+
+   @param BaseAddress           The lower address of stack used by DxeCore.
+   @param Length                The length of stack used by DxeCore.
+
+**/
+VOID
+UpdateStackHob (
+  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
-PeimInitializeDxeIpl (
-  IN EFI_PEI_FILE_HANDLE       FfsHandle,
-  IN EFI_PEI_SERVICES          **PeiServices
-  )
-;
+CustomGuidedSectionExtract (
+  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,
+  IN CONST  VOID                                  *InputSection,
+  OUT       VOID                                  **OutputBuffer,
+  OUT       UINTN                                 *OutputSize,
+  OUT       UINT32                                *AuthenticationStatus
+  );
+
+
+/**
+   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  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
+Decompress (
+  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,
+  IN CONST  EFI_COMPRESSION_SECTION *CompressionSection,
+  OUT       VOID                    **OutputBuffer,
+  OUT       UINTN                   *OutputSize
+  );
 
 #endif