]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiServicesLib/PeiServicesLib.c
1. Enable use-cases in PEI using SecurityPPI co-equal to the use-cases in DXE using...
[mirror_edk2.git] / MdePkg / Library / PeiServicesLib / PeiServicesLib.c
index 835325cc38d727bfe9cf908edc717e0b538e811e..e10dd8800fb9226812005a0df40e6fd6cc2354b2 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Implementation for PEI Services Library.\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2013, 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
@@ -16,6 +16,7 @@
 #include <PiPei.h>\r
 \r
 #include <Ppi/FirmwareVolumeInfo.h>\r
+#include <Ppi/FirmwareVolumeInfo2.h>\r
 #include <Guid/FirmwareFileSystem2.h>\r
 \r
 #include <Library/PeiServicesLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
 \r
-\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_PEI_PPI_DESCRIPTOR     mPpiListTemplate[] = {\r
-  {\r
-    (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
-    &gEfiPeiFirmwareVolumeInfoPpiGuid,\r
-    NULL\r
-  }\r
-};\r
-\r
 /**\r
   This service enables a given PEIM to register an interface into the PEI Foundation.\r
 \r
@@ -309,6 +301,36 @@ PeiServicesFfsFindSectionData (
   return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, 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
+  CONST EFI_PEI_SERVICES **PeiServices;\r
+\r
+  PeiServices = GetPeiServicesTablePointer ();\r
+  return (*PeiServices)->FindSectionData3 (PeiServices, SectionType, SectionInstance, FileHandle, SectionData, 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
@@ -459,6 +481,30 @@ PeiServicesFfsGetFileInfo (
   return (*GetPeiServicesTablePointer())->FfsGetFileInfo (FileHandle, 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               The handle of the file.\r
+  @param FileInfo                 Upon exit, points to the file's\r
+                                  information.\r
+\r
+  @retval EFI_SUCCESS             File information returned.\r
+  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
+                                  represent a valid file.\r
+  @retval EFI_INVALID_PARAMETER   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
+  return (*GetPeiServicesTablePointer())->FfsGetFileInfo2 (FileHandle, FileInfo);\r
+}\r
 \r
 /**\r
   This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services \r
@@ -522,43 +568,46 @@ PeiServicesFfsGetVolumeInfo (
 }\r
 \r
 /**\r
-  Install a EFI_PEI_FIRMWARE_VOLUME_INFO_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_INFO_PPI using \r
-  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r
-  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r
-  If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r
+  Install a EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance so the PEI Core will be notified about a new firmware volume.\r
 \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
+  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI using\r
+  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance.\r
+  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI, then ASSERT().\r
+  If the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI can not be installed, then ASSERT().\r
+\r
+  @param  InstallFvInfoPpi     Install FvInfo Ppi if it is TRUE. Otherwise, install FvInfo2 Ppi.\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
+  @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
+  @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
+  @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
+  @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, it will be ignored if InstallFvInfoPpi is TRUE.\r
 **/\r
 VOID\r
 EFIAPI\r
-PeiServicesInstallFvInfoPpi (\r
+InternalPeiServicesInstallFvInfoPpi (\r
+  IN       BOOLEAN                 InstallFvInfoPpi,\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 CONST EFI_GUID                *ParentFileName, OPTIONAL\r
+  IN       UINT32                  AuthenticationStatus\r
   )\r
 {\r
   EFI_STATUS                       Status;   \r
@@ -566,11 +615,24 @@ PeiServicesInstallFvInfoPpi (
   EFI_PEI_PPI_DESCRIPTOR           *FvInfoPpiDescriptor;\r
   EFI_GUID                         *ParentFvNameValue;\r
   EFI_GUID                         *ParentFileNameValue;\r
+  EFI_GUID                         *PpiGuid;\r
 \r
   ParentFvNameValue   = NULL;\r
   ParentFileNameValue = NULL;\r
-  FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI));\r
-  ASSERT(FvInfoPpi != NULL);\r
+  if (InstallFvInfoPpi) {\r
+    //\r
+    // To install FvInfo Ppi.\r
+    //\r
+    FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI));\r
+    PpiGuid = &gEfiPeiFirmwareVolumeInfoPpiGuid;\r
+  } else {\r
+    //\r
+    // To install FvInfo2 Ppi.\r
+    //\r
+    FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI));\r
+    ((EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI *) FvInfoPpi)->AuthenticationStatus = AuthenticationStatus;\r
+    PpiGuid = &gEfiPeiFirmwareVolumeInfo2PpiGuid;\r
+  }\r
 \r
   if (FvFormat != NULL) {\r
     CopyGuid (&FvInfoPpi->FvFormat, FvFormat);\r
@@ -590,12 +652,100 @@ PeiServicesInstallFvInfoPpi (
     FvInfoPpi->ParentFileName = ParentFileNameValue;\r
   }\r
 \r
-  FvInfoPpiDescriptor = AllocateCopyPool (sizeof(EFI_PEI_PPI_DESCRIPTOR), mPpiListTemplate);\r
+  FvInfoPpiDescriptor = AllocatePool (sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
   ASSERT (FvInfoPpiDescriptor != NULL);\r
 \r
+  FvInfoPpiDescriptor->Guid  = PpiGuid;\r
+  FvInfoPpiDescriptor->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
   FvInfoPpiDescriptor->Ppi   = (VOID *) FvInfoPpi;\r
   Status = PeiServicesInstallPpi (FvInfoPpiDescriptor);\r
   ASSERT_EFI_ERROR (Status);\r
 \r
 }\r
 \r
+/**\r
+  Install a EFI_PEI_FIRMWARE_VOLUME_INFO_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_INFO_PPI using\r
+  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r
+  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r
+  If the EFI_PEI_FIRMWARE_VOLUME_INFO_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
+**/\r
+VOID\r
+EFIAPI\r
+PeiServicesInstallFvInfoPpi (\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
+  )\r
+{\r
+  InternalPeiServicesInstallFvInfoPpi (TRUE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, 0);\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
+  InternalPeiServicesInstallFvInfoPpi (FALSE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, AuthenticationStatus);\r
+}\r
+\r