1. Enable use-cases in PEI using SecurityPPI co-equal to the use-cases in DXE using the Security Arch Protocol

2. Add support to find section by instance rather than only 0 at PEI phase.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14763 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 149 insertions, 3 deletions

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index c8fc77b151..d8998fad17 100644
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -1,7 +1,7 @@
 /** @file

   This file provides functions for accessing a memory-mapped firmware volume of a specific format.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

   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        

@@ -154,6 +154,33 @@ EFI_STATUS
 );

 

 /**

+  Returns information about a specific file.

+

+  This function returns information about a specific

+  file, including its file name, type, attributes, starting

+  address, size and authentication status. 

+

+  @param This                     Points to this instance of the

+                                  EFI_PEI_FIRMWARE_VOLUME_PPI.

+  @param FileHandle               Handle of the file.

+  @param FileInfo                 Upon exit, points to the file's

+                                  information.

+

+  @retval EFI_SUCCESS             File information returned.

+  @retval EFI_INVALID_PARAMETER   If FileHandle does not

+                                  represent a valid file.

+  @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.

+

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_PEI_FV_GET_FILE_INFO2)(

+  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI   *This, 

+  IN  EFI_PEI_FILE_HANDLE                 FileHandle,

+  OUT EFI_FV_FILE_INFO2                   *FileInfo

+);

+

+/**

   This function returns information about the firmware volume.

   

   @param This                     Points to this instance of the

@@ -203,6 +230,43 @@ EFI_STATUS
   OUT VOID                                 **SectionData

 );

 

+/**

+  Find the next matching section in the firmware file.

+

+  This service enables PEI modules to discover sections

+  of a given instance and type within a valid file.

+

+  @param This                   Points to this instance of the

+                                EFI_PEI_FIRMWARE_VOLUME_PPI.

+  @param SearchType             A filter to find only sections of this

+                                type.

+  @param SearchInstance         A filter to find the specific instance

+                                of sections.

+  @param FileHandle             Handle of firmware file in which to

+                                search.

+  @param SectionData            Updated upon return to point to the

+                                section found.

+  @param AuthenticationStatus   Updated upon return to point to the

+                                authentication status for this section.

+

+  @retval EFI_SUCCESS     Section was found.

+  @retval EFI_NOT_FOUND   Section of the specified type was not

+                          found. SectionData contains NULL.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_PEI_FV_FIND_SECTION2)(

+  IN  CONST EFI_PEI_FIRMWARE_VOLUME_PPI    *This,

+  IN  EFI_SECTION_TYPE                     SearchType,

+  IN  UINTN                                SearchInstance,

+  IN  EFI_PEI_FILE_HANDLE                  FileHandle,

+  OUT VOID                                 **SectionData,

+  OUT UINT32                               *AuthenticationStatus

+);

+

+#define EFI_PEI_FIRMWARE_VOLUME_PPI_SIGNATURE SIGNATURE_32 ('P', 'F', 'V', 'P')

+#define EFI_PEI_FIRMWARE_VOLUME_PPI_REVISION 0x00010030

+

 ///

 /// This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.

 ///

@@ -213,6 +277,16 @@ struct _EFI_PEI_FIRMWARE_VOLUME_PPI {
   EFI_PEI_FV_GET_FILE_INFO    GetFileInfo;

   EFI_PEI_FV_GET_INFO         GetVolumeInfo;

   EFI_PEI_FV_FIND_SECTION     FindSectionByType;

+  EFI_PEI_FV_GET_FILE_INFO2   GetFileInfo2;

+  EFI_PEI_FV_FIND_SECTION2    FindSectionByType2;

+  ///

+  /// Signature is used to keep backward-compatibility, set to {'P','F','V','P'}.

+  ///

+  UINT32                      Signature;

+  ///

+  /// Revision for further extension.

+  ///

+  UINT32                      Revision;

 };

 

 extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid;

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h
new file mode 100644
index 0000000000..6cb66b3c38
--- /dev/null
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo2.h
@@ -0,0 +1,72 @@
+/** @file

+  This file provides location, format and authentication status of a firmware volume.

+

+  Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>

+  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                                            

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+  @par Revision Reference:

+  This PPI is introduced in PI Version 1.3 errata.

+

+**/

+

+#ifndef __EFI_PEI_FIRMWARE_VOLUME_INFO2_H__

+#define __EFI_PEI_FIRMWARE_VOLUME_INFO2_H__

+

+

+

+#define EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI_GUID \

+{ 0xea7ca24b, 0xded5, 0x4dad, { 0xa3, 0x89, 0xbf, 0x82, 0x7e, 0x8f, 0x9b, 0x38 } }

+

+typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI;

+

+///

+///  This PPI describes the location and format of a firmware volume. 

+///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for 

+///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is 

+///  the PI Firmware Volume format.

+///

+struct _EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI {

+  ///

+  /// Unique identifier of the format of the memory-mapped firmware volume.

+  ///

+  EFI_GUID  FvFormat;

+  ///

+  /// 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.

+  ///

+  VOID      *FvInfo;

+  ///

+  /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,

+  /// this is typically the size of the firmware volume.

+  ///

+  UINT32    FvInfoSize;

+  ///

+  /// 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.

+  ///

+  EFI_GUID  *ParentFvName;

+  ///

+  /// 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.

+  ///

+  EFI_GUID  *ParentFileName;

+  ///

+  /// Authentication Status.

+  ///

+  UINT32    AuthenticationStatus;

+};

+

+extern EFI_GUID gEfiPeiFirmwareVolumeInfo2PpiGuid;

+

+#endif

+

diff --git a/MdePkg/Include/Ppi/Security2.h b/MdePkg/Include/Ppi/Security2.h
index eed56d7535..f7aabfca37 100644
--- a/MdePkg/Include/Ppi/Security2.h
+++ b/MdePkg/Include/Ppi/Security2.h
@@ -5,7 +5,7 @@
   policy to the PEI Foundation, namely the case of a PEIM's authentication 

   state being returned during the PEI section extraction process.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>

   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        

@@ -75,7 +75,7 @@ EFI_STATUS
   IN CONST  EFI_PEI_SECURITY2_PPI *This,

   IN UINT32                       AuthenticationStatus,

   IN EFI_PEI_FV_HANDLE            FvHandle,

-  IN EFI_PEI_FV_HANDLE            FileHandle,

+  IN EFI_PEI_FILE_HANDLE          FileHandle,

   IN OUT    BOOLEAN               *DeferExecution

 );