]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
Add PcdDxeIplSupportUefiDecompress usage into DxeIpl to save space
[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / DxeIpl.h
index 3eac29da295fc13c10fa06b586516541557cfad8..916bc0d82d14292bffb007c1281e2800bbd29346 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   Master header file for DxeIpl PEIM. All source files in this module should\r
-  include this file for common defininitions. \r
+  include this file for common definitions.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -18,16 +18,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <PiPei.h>\r
 #include <Ppi/DxeIpl.h>\r
-#include <Protocol/EdkDecompress.h>\r
 #include <Ppi/EndOfPeiPhase.h>\r
-#include <Protocol/CustomizedDecompress.h>\r
-#include <Protocol/Decompress.h>\r
 #include <Ppi/MemoryDiscovered.h>\r
 #include <Ppi/ReadOnlyVariable2.h>\r
-#include <Guid/MemoryTypeInformation.h>\r
 #include <Ppi/Decompress.h>\r
 #include <Ppi/FirmwareVolumeInfo.h>\r
+#include <Ppi/GuidedSectionExtraction.h>\r
 \r
+#include <Guid/MemoryTypeInformation.h>\r
 #include <Guid/MemoryAllocationHob.h>\r
 #include <Guid/FirmwareFileSystem2.h>\r
 \r
@@ -40,7 +38,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/CacheMaintenanceLib.h>\r
 #include <Library/UefiDecompressLib.h>\r
 #include <Library/ExtractGuidedSectionLib.h>\r
-#include <Library/PeiServicesTablePointerLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/PcdLib.h>\r
@@ -51,10 +48,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define STACK_SIZE      0x20000\r
 #define BSP_STORE_SIZE  0x4000\r
 \r
-#define GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize + (Alignment - 1)) & ~(Alignment - 1))\r
-\r
-extern BOOLEAN gInMemory;\r
 \r
+//\r
+// This PPI is installed to indicate the end of the PEI usage of memory \r
+//\r
+extern CONST EFI_PEI_PPI_DESCRIPTOR gEndOfPeiSignalPpi;\r
 \r
 \r
 \r
@@ -76,44 +74,44 @@ PeiLoadFile (
   OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
   OUT UINT64                                    *ImageSize,\r
   OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
-  )\r
-;\r
+  );\r
 \r
 \r
 \r
 /**\r
-   Find DxeCore driver from all First Volumes.\r
+   Searches DxeCore in all firmware Volumes and loads the first\r
+   instance that contains DxeCore.\r
 \r
-   @param FileHandle    Pointer to FFS file to search.\r
+   @return FileHandle of DxeCore to load DxeCore.\r
    \r
-   @return EFI_SUCESS   Success to find the FFS in specificed FV\r
-   @return others       Fail to find the FFS in specificed FV\r
-\r
 **/\r
-EFI_STATUS\r
+EFI_PEI_FILE_HANDLE\r
 DxeIplFindDxeCore (\r
-  OUT EFI_PEI_FILE_HANDLE   *FileHandle\r
-  )\r
-;\r
-\r
+  VOID\r
+  );\r
 \r
 \r
 /**\r
-   This function simply retrieves the function pointer of ImageRead in\r
-   ImageContext structure.\r
-    \r
-   @param ImageContext       A pointer to the structure of \r
-                             PE_COFF_LOADER_IMAGE_CONTEXT\r
-   \r
-   @retval EFI_SUCCESS       This function always return EFI_SUCCESS.\r
+  Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file\r
+\r
+  @param  FileHandle   The handle to the PE/COFF file \r
+  @param  FileOffset   The offset, in bytes, into the file to read \r
+  @param  ReadSize     The number of bytes to read from the file starting at \r
+                       FileOffset \r
+  @param  Buffer       A pointer to the buffer to read the data into. \r
+\r
+  @retval EFI_SUCCESS  ReadSize bytes of data were read into Buffer from the \r
+                       PE/COFF file starting at FileOffset\r
 \r
 **/\r
 EFI_STATUS\r
-GetImageReadFunction (\r
-  IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext\r
-  )\r
-;\r
-\r
+EFIAPI\r
+PeiImageRead (\r
+  IN     VOID    *FileHandle,\r
+  IN     UINTN   FileOffset,\r
+  IN OUT UINTN   *ReadSize,\r
+  OUT    VOID    *Buffer\r
+  );\r
 \r
 \r
 /**\r
@@ -130,7 +128,7 @@ GetImageReadFunction (
 EFI_STATUS\r
 EFIAPI\r
 DxeLoadCore (\r
-  IN EFI_DXE_IPL_PPI       *This,\r
+  IN CONST EFI_DXE_IPL_PPI *This,\r
   IN EFI_PEI_SERVICES      **PeiServices,\r
   IN EFI_PEI_HOB_POINTERS  HobList\r
   );\r
@@ -142,18 +140,16 @@ DxeLoadCore (
 \r
    This function performs a CPU architecture specific operations to execute\r
    the entry point of DxeCore with the parameters of HobList.\r
-   It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
+   It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
 \r
-   @param DxeCoreEntryPoint         The entrypoint of DxeCore.\r
+   @param DxeCoreEntryPoint         The entry point of DxeCore.\r
    @param HobList                   The start of HobList passed to DxeCore.\r
-   @param EndOfPeiSignal            The PPI descriptor for EFI_END_OF_PEI_PPI.\r
 \r
 **/\r
 VOID\r
 HandOffToDxeCore (\r
   IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r
-  IN EFI_PEI_HOB_POINTERS   HobList,\r
-  IN EFI_PEI_PPI_DESCRIPTOR *EndOfPeiSignal\r
+  IN EFI_PEI_HOB_POINTERS   HobList\r
   );\r
 \r
 \r
@@ -174,24 +170,98 @@ UpdateStackHob (
   IN UINT64                      Length\r
   );\r
 \r
+/**\r
+  The ExtractSection() function processes the input section and\r
+  returns a pointer to the section contents. If the section being\r
+  extracted does not require processing (if the section\r
+  GuidedSectionHeader.Attributes has the\r
+  EFI_GUIDED_SECTION_PROCESSING_REQUIRED field cleared), then\r
+  OutputBuffer is just updated to point to the start of the\r
+  section's contents. Otherwise, *Buffer must be allocated\r
+  from PEI permanent memory.\r
+\r
+  @param This                   Indicates the\r
+                                EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
+                                Buffer containing the input GUIDed section to be\r
+                                processed. OutputBuffer OutputBuffer is\r
+                                allocated from PEI permanent memory and contains\r
+                                the new section stream.\r
+  @param InputSection           A pointer to the input buffer, which contains\r
+                                the input section to be processed.\r
+  @param OutputBuffer           A pointer to a caller-allocated buffer, whose\r
+                                size is specified by the contents of OutputSize.\r
+  @param OutputSize             A pointer to a caller-allocated\r
+                                UINTN in which the size of *OutputBuffer\r
+                                allocation is stored. If the function\r
+                                returns anything other than EFI_SUCCESS,\r
+                                the value of OutputSize is undefined.\r
+  @param AuthenticationStatus   A pointer to a caller-allocated\r
+                                UINT32 that indicates the\r
+                                authentication status of the\r
+                                output buffer. If the input\r
+                                section's GuidedSectionHeader.\r
+                                Attributes field has the\r
+                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
+                                bit as clear,\r
+                                AuthenticationStatus must return\r
+                                zero. These bits reflect the\r
+                                status of the extraction\r
+                                operation. If the function\r
+                                returns anything other than\r
+                                EFI_SUCCESS, the value of\r
+                                AuthenticationStatus is\r
+                                undefined.\r
+  \r
+  @retval EFI_SUCCESS           The InputSection was\r
+                                successfully processed and the\r
+                                section contents were returned.\r
+  \r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
+                                resources to process the request.\r
+  \r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
+                                not match this instance of the\r
+                                GUIDed Section Extraction PPI.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+CustomGuidedSectionExtract (\r
+  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
+  IN CONST  VOID                                  *InputSection,\r
+  OUT       VOID                                  **OutputBuffer,\r
+  OUT       UINTN                                 *OutputSize,\r
+  OUT       UINT32                                *AuthenticationStatus\r
+  );\r
 \r
 \r
 /**\r
-  Initializes the Dxe Ipl PPI\r
+   Decompresses a section to the output buffer.\r
 \r
-  @param  FfsHandle   The handle of FFS file.\r
-  @param  PeiServices General purpose services available to\r
-                      every PEIM.\r
-  @return EFI_SUCESS\r
+   This function looks up the compression type field in the input section and\r
+   applies the appropriate compression algorithm to compress the section to a\r
+   callee allocated buffer.\r
+    \r
+   @param  This                  Points to this instance of the\r
+                                 EFI_PEI_DECOMPRESS_PEI PPI.\r
+   @param  CompressionSection    Points to the compressed section.\r
+   @param  OutputBuffer          Holds the returned pointer to the decompressed\r
+                                 sections.\r
+   @param  OutputSize            Holds the returned size of the decompress\r
+                                 section streams.\r
+   \r
+   @retval EFI_SUCCESS           The section was decompressed successfully.\r
+                                 OutputBuffer contains the resulting data and\r
+                                 OutputSize contains the resulting size.\r
 \r
 **/\r
 EFI_STATUS\r
-EFIAPI\r
-PeimInitializeDxeIpl (\r
-  IN EFI_PEI_FILE_HANDLE       FfsHandle,\r
-  IN EFI_PEI_SERVICES          **PeiServices\r
-  )\r
-;\r
-\r
+EFIAPI \r
+Decompress (\r
+  IN CONST  EFI_PEI_DECOMPRESS_PPI  *This,\r
+  IN CONST  EFI_COMPRESSION_SECTION *CompressionSection,\r
+  OUT       VOID                    **OutputBuffer,\r
+  OUT       UINTN                   *OutputSize\r
+  );\r
 \r
 #endif\r