MdePkg/DxeServicesLib: introduce AllocatePeiAccessiblePages routine

[mirror_edk2.git] / MdePkg / Include / Library / DxeServicesLib.h

diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h
index e01dd49c872a511c4b0ccb4fd71f40aca94f145e..20aee68af55821507f982de312a99a7d786bb97a 100644 (file)
--- a/MdePkg/Include/Library/DxeServicesLib.h
+++ b/MdePkg/Include/Library/DxeServicesLib.h
@@ -3,6 +3,7 @@
   These functions help access data from sections of FFS files or from file path.\r
 \r
 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -262,5 +263,68 @@ GetFileBufferByFilePath (
   OUT UINT32                           *AuthenticationStatus\r
   );\r
 \r
-#endif\r
+/**\r
+  Searches all the available firmware volumes and returns the file device path of first matching\r
+  FFS section.\r
 \r
+  This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.\r
+  The order that the firmware volumes is searched is not deterministic. For each FFS file found a search\r
+  is made for FFS sections of type SectionType.\r
+\r
+  If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,\r
+  the search will be retried with a section type of EFI_SECTION_PE32.\r
+  This function must be called with a TPL <= TPL_NOTIFY.\r
+\r
+  If NameGuid is NULL, then ASSERT().\r
+\r
+   @param  NameGuid             A pointer to to the FFS filename GUID to search for\r
+                                within any of the firmware volumes in the platform.\r
+   @param  SectionType          Indicates the FFS section type to search for within\r
+                                the FFS file specified by NameGuid.\r
+   @param  SectionInstance      Indicates which section instance within the FFS file\r
+                                specified by NameGuid to retrieve.\r
+   @param  FvFileDevicePath     Device path for the target FFS\r
+                                file.\r
+\r
+   @retval  EFI_SUCCESS           The specified file device path of FFS section was returned.\r
+   @retval  EFI_NOT_FOUND         The specified file device path of FFS section could not be found.\r
+   @retval  EFI_DEVICE_ERROR      The FFS section could not be retrieves due to a\r
+                                  device error.\r
+   @retval  EFI_ACCESS_DENIED     The FFS section could not be retrieves because the\r
+                                  firmware volume that contains the matching FFS section does not\r
+                                  allow reads.\r
+   @retval  EFI_INVALID_PARAMETER FvFileDevicePath is NULL.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetFileDevicePathFromAnyFv (\r
+  IN CONST  EFI_GUID                  *NameGuid,\r
+  IN        EFI_SECTION_TYPE          SectionType,\r
+  IN        UINTN                     SectionInstance,\r
+  OUT       EFI_DEVICE_PATH_PROTOCOL  **FvFileDevicePath\r
+  );\r
+\r
+/**\r
+  Allocates one or more 4KB pages of a given type from a memory region that is\r
+  accessible to PEI.\r
+\r
+  Allocates the number of 4KB pages of type 'MemoryType' and returns a\r
+  pointer to the allocated buffer.  The buffer returned is aligned on a 4KB\r
+  boundary.  If Pages is 0, then NULL is returned.  If there is not enough\r
+  memory remaining to satisfy the request, then NULL is returned.\r
+\r
+  @param[in]  MemoryType            The memory type to allocate\r
+  @param[in]  Pages                 The number of 4 KB pages to allocate.\r
+\r
+  @return A pointer to the allocated buffer or NULL if allocation fails.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+AllocatePeiAccessiblePages (\r
+  IN EFI_MEMORY_TYPE  MemoryType,\r
+  IN UINTN            Pages\r
+  );\r
+\r
+#endif\r