]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/PeiServicesLib.h
MdePkg PeiServicesLib: Add PeiServicesFreePages
[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesLib.h
index 71d15b606f930db2707ec2437572e066f70e5867..9fc22a10c178b3bece98b16d9c668c37c3d8f306 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   Provides library functions for all PEI Services.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
+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
 http://opensource.org/licenses/bsd-license.php\r
@@ -220,6 +220,30 @@ PeiServicesFfsFindSectionData (
   OUT VOID                      **SectionData\r
   );\r
 \r
+/**\r
+  This service enables PEIMs to discover sections of a given instance and type within a valid FFS file.\r
+\r
+  @param  SectionType           The value of the section type to find.\r
+  @param  SectionInstance       Section instance to find.\r
+  @param  FileHandle            A pointer to the file header that contains the set \r
+                                of sections to be searched.\r
+  @param  SectionData           A pointer to the discovered section, if successful.\r
+  @param  AuthenticationStatus  A pointer to the authentication status for this section.\r
+\r
+  @retval EFI_SUCCESS           The section was found.\r
+  @retval EFI_NOT_FOUND         The section was not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiServicesFfsFindSectionData3 (\r
+  IN EFI_SECTION_TYPE           SectionType,\r
+  IN UINTN                      SectionInstance,\r
+  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
+  OUT VOID                      **SectionData,\r
+  OUT UINT32                    *AuthenticationStatus\r
+  );\r
+\r
 /**\r
   This service enables PEIMs to register the permanent memory configuration\r
   that has been initialized with the PEI Foundation.\r
@@ -240,16 +264,16 @@ PeiServicesInstallPeiMemory (
   );\r
 \r
 /**\r
-  This service enables PEIMs to allocate memory after the permanent memory has been installed by a\r
-  PEIM.\r
+  This service enables PEIMs to allocate memory.\r
 \r
   @param  MemoryType            Type of memory to allocate.\r
-  @param  Pages                 Number of pages to allocate.\r
+  @param  Pages                 The number of pages to allocate.\r
   @param  Memory                Pointer of memory allocated.\r
 \r
   @retval EFI_SUCCESS           The memory range was successfully allocated.\r
-  @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
-  @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.\r
+  @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,\r
+                                EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
+                                EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
   @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.\r
 \r
 **/\r
@@ -261,6 +285,25 @@ PeiServicesAllocatePages (
   OUT EFI_PHYSICAL_ADDRESS      *Memory\r
   );\r
 \r
+/**\r
+  This service enables PEIMs to free memory.\r
+\r
+  @param Memory                 Memory to be freed.\r
+  @param Pages                  The number of pages to free.\r
+\r
+  @retval EFI_SUCCESS           The requested pages were freed.\r
+  @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r
+  @retval EFI_NOT_FOUND         The requested memory pages were not allocated with\r
+                                AllocatePages().\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiServicesFreePages (\r
+  IN EFI_PHYSICAL_ADDRESS       Memory,\r
+  IN UINTN                      Pages\r
+  );\r
+\r
 /**\r
   This service allocates memory from the Hand-Off Block (HOB) heap.\r
 \r
@@ -348,6 +391,31 @@ PeiServicesFfsGetFileInfo (
   OUT EFI_FV_FILE_INFO            *FileInfo\r
   );\r
 \r
+/**\r
+  This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services\r
+  Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
+  Specification for details.\r
+\r
+  @param FileHandle   Handle of the file.\r
+\r
+  @param FileInfo     Upon exit, points to the file's\r
+                      information.\r
+\r
+  @retval EFI_SUCCESS             File information returned.\r
+  \r
+  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
+                                  represent a valid file.\r
+  \r
+  @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r
+  \r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PeiServicesFfsGetFileInfo2 (\r
+  IN CONST  EFI_PEI_FILE_HANDLE   FileHandle,\r
+  OUT EFI_FV_FILE_INFO2           *FileInfo\r
+  );\r
+\r
 /**\r
   This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services \r
   Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface \r
@@ -431,4 +499,45 @@ PeiServicesInstallFvInfoPpi (
   IN CONST EFI_GUID                *ParentFileName OPTIONAL\r
   );\r
 \r
+/**\r
+  Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.\r
+\r
+  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using\r
+  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance.\r
+  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT().\r
+  If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT().\r
+\r
+  @param  FvFormat             Unique identifier of the format of the memory-mapped\r
+                               firmware volume.  This parameter is optional and\r
+                               may be NULL.  If NULL is specified, the\r
+                               EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
+  @param  FvInfo               Points to a buffer which allows the\r
+                               EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r
+                               The format of this buffer is specific to the FvFormat.\r
+                               For memory-mapped firmware volumes, this typically\r
+                               points to the first byte of the firmware volume.\r
+  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped\r
+                               firmware volumes, this is typically the size of\r
+                               the firmware volume.\r
+  @param  ParentFvName         If the new firmware volume originated from a file\r
+                               in a different firmware volume, then this parameter\r
+                               specifies the GUID name of the originating firmware\r
+                               volume. Otherwise, this parameter must be NULL.\r
+  @param  ParentFileName       If the new firmware volume originated from a file\r
+                               in a different firmware volume, then this parameter\r
+                               specifies the GUID file name of the originating\r
+                               firmware file. Otherwise, this parameter must be NULL.\r
+  @param  AuthenticationStatus Authentication Status\r
+**/\r
+VOID\r
+EFIAPI\r
+PeiServicesInstallFvInfo2Ppi (\r
+  IN CONST EFI_GUID                *FvFormat, OPTIONAL\r
+  IN CONST VOID                    *FvInfo,\r
+  IN       UINT32                  FvInfoSize,\r
+  IN CONST EFI_GUID                *ParentFvName, OPTIONAL\r
+  IN CONST EFI_GUID                *ParentFileName, OPTIONAL\r
+  IN       UINT32                  AuthenticationStatus\r
+  );\r
+\r
 #endif\r