0) Change the PEI core behavior to not install FV HOB for each FV INFO PPI installed. This allows more freedom to platform developer to choose to expose which FV to PEI core or DXE core.

1) Split MdePkg/Include/Library/PiLib.h to DxePiLib.h and PeiPiLib.h. These two library classes are for DXE phase and PEI phase.
2) Update the API names in DxePiLib and PeiPiLib to be longer ones to be more meaningfull and to avoid name collisions. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4067 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 34 insertions, 145 deletions

diff --git a/MdePkg/Include/Library/PiLib.h b/MdePkg/Include/Library/DxePiLib.h
index 8aaad25058..01cebeb084 100644
--- a/MdePkg/Include/Library/PiLib.h
+++ b/MdePkg/Include/Library/DxePiLib.h
@@ -17,94 +17,13 @@
 

 #include <Pi/PiFirmwareFile.h>

 

-/**

-  Allocate and fill a buffer with an image identified by a Firmware File GUID name and a Firmware Section type. 

-  The Firmware Volumes to search for the Firmware File can be specified to be either all Firmware Volumes 

-  in the system, or the Firmware Volume which contains the Firmware File specified by an image handle.

-

-  If ImageHandle is NULL, all Firmware Volumes in the system will be searched. If ImageHandle is not NULL, 

-  ImageHandle is interpreted as EFI_PEI_FILE_HANDLE for the implementation of this function for PEI phase. 

-  The input parameter ImageHandle is interpreted as EFI_HANDLE, on which an EFI_LOADED_IMAGE_PROTOCOL 

-  is installed, for the implementation of this function for DXE phase. The search always starts from the FV 

-  identified by ImageHandle. If WithinImageFv is TRUE, search will only be performed on the first FV. If WithinImageFv 

-  is FALSE, search will continue on other FVs if it fails on the first FV. The search order of Firmware Volumes is 

-  deterministic but arbitrary if no new firmware volume is added into the system between each search. 

-  

-  The search order for the section type specified by SectionType in the Firmware File is using a depth-first 

-  and left-to-right algorithm through all sections. The first section found to match SectionType will be returned. 

-  

-  If SectionType is EFI_SECTION_PE32, EFI_SECTION_PE32 will be used as Firmware Section type 

-  to read Firmware Section data from the Firmware File. If no such section exists, the function will try 

-  to read a Firmware File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.

-  

-  If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section 

-  data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to 

-  read Firmware Section data from the Firmware File. If no such section exists, the function will try to read a Firmware 

-  File named with NameGuid. If no such file exists, EFI_NOT_FOUND is returned.

-  

-  The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated 

-  by this function. This function can only be called at TPL_NOTIFY and below.

-  

-  If ImageHandle is NULL and WithinImage is TRUE, then ASSERT ();

-  If NameGuid is NULL, then ASSERT();

-  If Buffer is NULL, then ASSERT();

-  If Size is NULL, then ASSERT().

-

-  @param  NameGuid             The GUID name of a Firmware File.

-  @param  SectionType         The Firmware Section type.

-  @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.

-  @param  Size                    On output, the size of Buffer.

-

-  @retval  EFI_SUCCESS	      The image is found and data and size is returned.

-  @retval  EFI_NOT_FOUND	    The image specified by NameGuid and SectionType can't be found.

-  @retval  EFI_OUT_OF_RESOURCES	There were not enough resources to allocate the output data buffer or complete the operations.

-  @retval  EFI_DEVICE_ERROR	A hardware error occurs during reading from the Firmware Volume.

-  @retval  EFI_ACCESS_DENIED	The firmware volume containing the searched Firmware File is configured to disallow reads.

-

-**/

-

-EFI_STATUS

-EFIAPI

-GetSectionFromFvFile (

-  IN  CONST VOID*        ImageHandle OPTIONAL,

-  IN  CONST EFI_GUID     *NameGuid,

-  IN  EFI_SECTION_TYPE   SectionType,

-  OUT VOID               **Buffer,

-  OUT UINTN              *Size,

-  IN  BOOLEAN            WithImageFv

-  )

-;

-

-/**

-  Identify the device handle from which the Image is loaded from. As this device handle is passed to

-  GetSectionFromFv as the identifier for a Firmware Volume, an EFI_FIRMWARE_VOLUME2_PROTOCOL 

-  protocol instance should be located succesfully by calling gBS->HandleProtocol ().

-

-  This function locates the EFI_LOADED_IMAGE_PROTOCOL instance installed

-  on ImageHandle. It then returns EFI_LOADED_IMAGE_PROTOCOL.DeviceHandle.

-  

-  If ImageHandle is NULL, then ASSERT ();

-  If failed to locate a EFI_LOADED_IMAGE_PROTOCOL on ImageHandle, then ASSERT ();

-  

-  @param  ImageHandle         The firmware allocated handle for UEFI image.

-

-  @retval  EFI_HANDLE	        The device handle from which the Image is loaded from.

-

-**/

-

-EFI_HANDLE

-EFIAPI

-ImageHandleToFvHandle (

-  EFI_HANDLE ImageHandle

-  )

-;

 

 /**

     Allocate and fill a buffer from the Firmware Section identified by a Firmware File GUID name and a Firmware 

-    Section type and instance number from the any Firmware Volumes in the system.

+    Section type and instance number from any Firmware Volumes in the system.

   

-    The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the 

-    any Firmware Volume in the system. 

+    The function will read the first Firmware Section sepcifed by NameGuid, SectionType and Instance by searching

+    for all Firmware Volumes in the system. 

 

     The search order for Firmware Volumes in the system is determistic but abitrary if no new Firmware Volume is installed

     into the system. The search order for the section specified by SectionType within a Firmware File is defined by

@@ -139,60 +58,7 @@ ImageHandleToFvHandle (
 

 EFI_STATUS

 EFIAPI

-GetSectionFromAnyFv (

-  IN  CONST EFI_GUID                *NameGuid,

-  IN  EFI_SECTION_TYPE              SectionType,

-  IN  UINTN                         Instance,

-  OUT VOID                          **Buffer,

-  OUT UINTN                         *Size

-  )

-;

-

-/**

-    Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware 

-    Section type and instance number from the specified Firmware Volume.

-  

-    This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to 

-    carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed 

-    by NameGuid, SectionType and Instance. 

-    

-    The search order for the section specified by SectionType within a Firmware File is defined by

-    EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection (). Please check Section 2.4 of Volume 3: Platform Initialization 

-    Shared Architectural Elements for detailes.

-    

-    If SectionType is EFI_SECTION_TE, EFI_SECTION_TE will be used as Firmware Section type to read Firmware Section 

-    data from the Firmware File. If no such section exists, EFI_SECTION_PE32 will be used as Firmware Section type to 

-    read Firmware Section data from the Firmware File. If no such section specified is found to match , 

-    EFI_NOT_FOUND is returned.

-    

-    The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated 

-    by this function. This function can be only called at TPL_NOTIFY and below.

-    

-    If FvHandle is NULL, then ASSERT ();

-    If NameGuid is NULL, then ASSERT();

-    If Buffer is NULL, then ASSERT();

-    If Size is NULL, then ASSERT().

-

-    @param  FvHandle              The device handle that contains a instance of EFI_FIRMWARE_VOLUME2_PROTOCOL instance.

-    @param  NameGuid             The GUID name of a Firmware File.

-    @param  SectionType         The Firmware Section type.

-    @param  Instance              The instance number of Firmware Section to read from starting from 0.

-    @param  Buffer                  On output, Buffer contains the the data read from the section in the Firmware File found.

-    @param  Size                    On output, the size of Buffer.

-  

-    @retval  EFI_SUCCESS        The image is found and data and size is returned.

-    @retval  EFI_UNSUPPORTED   FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.

-    @retval  EFI_NOT_FOUND      The image specified by NameGuid and SectionType can't be found.

-    @retval  EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.

-    @retval  EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.

-    @retval  EFI_ACCESS_DENIED  The firmware volume containing the searched Firmware File is configured to disallow reads.

-  

-  **/

-

-EFI_STATUS

-EFIAPI

-GetSectionFromFv (

-  IN  EFI_HANDLE                    FvHandle,

+PiLibGetSectionFromAnyFv (

   IN  CONST EFI_GUID                *NameGuid,

   IN  EFI_SECTION_TYPE              SectionType,

   IN  UINTN                         Instance,

@@ -243,7 +109,7 @@ GetSectionFromFv (
 

 EFI_STATUS

 EFIAPI

-GetSectionFromCurrentFv (

+PiLibGetSectionFromCurrentFv (

   IN  CONST EFI_GUID                *NameGuid,

   IN  EFI_SECTION_TYPE              SectionType,

   IN  UINTN                         Instance,

@@ -295,7 +161,7 @@ GetSectionFromCurrentFv (
 

 EFI_STATUS

 EFIAPI

-GetSectionFromCurrentFfs (

+PiLibGetSectionFromCurrentFfs (

   IN  EFI_SECTION_TYPE              SectionType,

   IN  UINTN                         Instance,

   OUT VOID                          **Buffer,

diff --git a/MdePkg/Include/Library/PeiPiLib.h b/MdePkg/Include/Library/PeiPiLib.h
index a34fd50c10..a1b472ac69 100644
--- a/MdePkg/Include/Library/PeiPiLib.h
+++ b/MdePkg/Include/Library/PeiPiLib.h
@@ -17,13 +17,36 @@
 

 #include <Pi/PiFirmwareFile.h>

 

+/**

+    Install a EFI_PEI_FIRMWARE_VOLUME_INFO PPI to inform PEI core about the existence of a new Firmware Volume.

+  

+    The function allocate the EFI_PEI_PPI_DESCRIPTOR structure and update the fields accordingly to parameter passed

+    in and install the PPI.

+    

+    @param  FvStart              Unique identifier of the format of the memory-mapped firmware volume. If NULL is specified,

+                                         EFI_FIRMWARE_FILE_SYSTEM2_GUID is used as the Format GUID.

+    @param  FvInfo               Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to

+                                         process the volume. The format of this buffer is specific to the FvFormat. For

+                                         memory-mapped firmware volumes, this typically points to the first byte of the

+                                         firmware volume.

+    @param  FvInfoSize          Size of the data provided by FvInfo. For memory-mapped firmware volumes, this is

+                                         typically the size of the firmware volume.

+    @param  ParentFvName, ParentFileName      If the firmware volume originally came from a firmware file, then these point to the

+                                          parent firmware volume name and firmware volume file. If it did not originally come

+                                          from a firmware file, these should be NULL

+  

+    @retval  VOID

+  

+  **/

+

 VOID

 EFIAPI

-PeiPiLibBuildPiFvInfoPpi (

-  IN EFI_PHYSICAL_ADDRESS    FvStart,

-  IN UINT64                  FvLength,

-  IN EFI_GUID                *ParentFvName,

-  IN EFI_GUID                *PraentFileName

+PiLibInstallFvInfoPpi (

+  IN EFI_GUID                *FvFormat, OPTIONAL

+  IN VOID                    *FvInfo,

+  IN UINT32                  FvInfoSize,

+  IN EFI_GUID                *ParentFvName, OPTIONAL

+  IN EFI_GUID                *PraentFileName OPTIONAL

 );

 

 #endif