X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FPeiServicesLib%2FPeiServicesLib.c;h=e8eaed71c827cbff2f3511fba553ec17a0310944;hp=93495f04b8e9813978faa2df266a6ed51eba8c61;hb=HEAD;hpb=122e21915101b8f38d81edc6d4f1fd1dd353e28a diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c index 93495f04b8..98cc69c3a2 100644 --- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c +++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c @@ -1,21 +1,15 @@ /** @file Implementation for PEI Services Library. - Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. 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. + Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent **/ - #include #include +#include #include #include @@ -24,15 +18,6 @@ #include #include - -GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_PEI_PPI_DESCRIPTOR mPpiListTemplate [] = { - { - (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST), - &gEfiPeiFirmwareVolumeInfoPpiGuid, - NULL - } -}; - /** This service enables a given PEIM to register an interface into the PEI Foundation. @@ -48,7 +33,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_PEI_PPI_DESCRIPTOR mPpiListTemplate EFI_STATUS EFIAPI PeiServicesInstallPpi ( - IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList + IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList ) { CONST EFI_PEI_SERVICES **PeiServices; @@ -60,8 +45,8 @@ PeiServicesInstallPpi ( /** This service enables PEIMs to replace an entry in the PPI database with an alternate entry. - @param OldPpi Pointer to the old PEI PPI Descriptors. - @param NewPpi Pointer to the new PEI PPI Descriptors. + @param OldPpi The pointer to the old PEI PPI Descriptors. + @param NewPpi The pointer to the new PEI PPI Descriptors. @retval EFI_SUCCESS The interface was successfully installed. @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL. @@ -75,11 +60,11 @@ PeiServicesInstallPpi ( EFI_STATUS EFIAPI PeiServicesReInstallPpi ( - IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, - IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi + IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, + IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->ReInstallPpi (PeiServices, OldPpi, NewPpi); @@ -101,13 +86,13 @@ PeiServicesReInstallPpi ( EFI_STATUS EFIAPI PeiServicesLocatePpi ( - IN CONST EFI_GUID *Guid, - IN UINTN Instance, - IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, - IN OUT VOID **Ppi + IN CONST EFI_GUID *Guid, + IN UINTN Instance, + IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor OPTIONAL, + IN OUT VOID **Ppi ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->LocatePpi (PeiServices, Guid, Instance, PpiDescriptor, Ppi); @@ -117,13 +102,14 @@ PeiServicesLocatePpi ( This service enables PEIMs to register a given service to be invoked when another service is installed or reinstalled. - @param NotifyList A pointer to the list of notification interfaces that the caller - shall install. + @param NotifyList A pointer to the list of notification interfaces + that the caller shall install. @retval EFI_SUCCESS The interface was successfully installed. @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL. - @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the - EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field. + @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do + not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES + bit set in the Flags field. @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database. **/ @@ -133,7 +119,7 @@ PeiServicesNotifyPpi ( IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->NotifyPpi (PeiServices, NotifyList); @@ -151,10 +137,10 @@ PeiServicesNotifyPpi ( EFI_STATUS EFIAPI PeiServicesGetBootMode ( - OUT EFI_BOOT_MODE *BootMode + OUT EFI_BOOT_MODE *BootMode ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->GetBootMode (PeiServices, BootMode); @@ -171,10 +157,10 @@ PeiServicesGetBootMode ( EFI_STATUS EFIAPI PeiServicesSetBootMode ( - IN EFI_BOOT_MODE BootMode + IN EFI_BOOT_MODE BootMode ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->SetBootMode (PeiServices, BootMode); @@ -183,7 +169,8 @@ PeiServicesSetBootMode ( /** This service enables a PEIM to ascertain the address of the list of HOBs in memory. - @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize. + @param HobList A pointer to the list of HOBs that the PEI Foundation + will initialize. @retval EFI_SUCCESS The list was successfully returned. @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published. @@ -192,10 +179,10 @@ PeiServicesSetBootMode ( EFI_STATUS EFIAPI PeiServicesGetHobList ( - OUT VOID **HobList + OUT VOID **HobList ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->GetHobList (PeiServices, HobList); @@ -206,7 +193,8 @@ PeiServicesGetHobList ( @param Type The type of HOB to be installed. @param Length The length of the HOB to be added. - @param Hob The address of a pointer that will contain the HOB header. + @param Hob The address of a pointer that will contain the + HOB header. @retval EFI_SUCCESS The HOB was successfully created. @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation. @@ -215,12 +203,12 @@ PeiServicesGetHobList ( EFI_STATUS EFIAPI PeiServicesCreateHob ( - IN UINT16 Type, - IN UINT16 Length, - OUT VOID **Hob + IN UINT16 Type, + IN UINT16 Length, + OUT VOID **Hob ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->CreateHob (PeiServices, Type, Length, Hob); @@ -229,9 +217,10 @@ PeiServicesCreateHob ( /** This service enables PEIMs to discover additional firmware volumes. - @param Instance This instance of the firmware volume to find. The value 0 is the - Boot Firmware Volume (BFV). - @param VolumeHandle Handle of the firmware volume header of the volume to return. + @param Instance This instance of the firmware volume to find. The + value 0 is the Boot Firmware Volume (BFV). + @param VolumeHandle Handle of the firmware volume header of the volume + to return. @retval EFI_SUCCESS The volume was found. @retval EFI_NOT_FOUND The volume was not found. @@ -241,11 +230,11 @@ PeiServicesCreateHob ( EFI_STATUS EFIAPI PeiServicesFfsFindNextVolume ( - IN UINTN Instance, - IN OUT EFI_PEI_FV_HANDLE *VolumeHandle + IN UINTN Instance, + IN OUT EFI_PEI_FV_HANDLE *VolumeHandle ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->FfsFindNextVolume (PeiServices, Instance, VolumeHandle); @@ -255,8 +244,9 @@ PeiServicesFfsFindNextVolume ( This service enables PEIMs to discover additional firmware files. @param SearchType A filter to find files only of this type. - @param VolumeHandle Pointer to the firmware volume header of the volume to search. - This parameter must point to a valid FFS volume. + @param VolumeHandle The pointer to the firmware volume header of the + volume to search. This parameter must point to a + valid FFS volume. @param FileHandle Handle of the current file from which to begin searching. @retval EFI_SUCCESS The file was found. @@ -267,12 +257,12 @@ PeiServicesFfsFindNextVolume ( EFI_STATUS EFIAPI PeiServicesFfsFindNextFile ( - IN EFI_FV_FILETYPE SearchType, - IN EFI_PEI_FV_HANDLE VolumeHandle, - IN OUT EFI_PEI_FILE_HANDLE *FileHandle + IN EFI_FV_FILETYPE SearchType, + IN EFI_PEI_FV_HANDLE VolumeHandle, + IN OUT EFI_PEI_FILE_HANDLE *FileHandle ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->FfsFindNextFile (PeiServices, SearchType, VolumeHandle, FileHandle); @@ -282,8 +272,8 @@ PeiServicesFfsFindNextFile ( This service enables PEIMs to discover sections of a given type within a valid FFS file. @param SectionType The value of the section type to find. - @param FileHandle A pointer to the file header that contains the set of sections to - be searched. + @param FileHandle A pointer to the file header that contains the set + of sections to be searched. @param SectionData A pointer to the discovered section, if successful. @retval EFI_SUCCESS The section was found. @@ -293,17 +283,47 @@ PeiServicesFfsFindNextFile ( EFI_STATUS EFIAPI PeiServicesFfsFindSectionData ( - IN EFI_SECTION_TYPE SectionType, - IN EFI_PEI_FILE_HANDLE FileHandle, - OUT VOID **SectionData + IN EFI_SECTION_TYPE SectionType, + IN EFI_PEI_FILE_HANDLE FileHandle, + OUT VOID **SectionData ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData); } +/** + This service enables PEIMs to discover sections of a given instance and type within a valid FFS file. + + @param SectionType The value of the section type to find. + @param SectionInstance Section instance to find. + @param FileHandle A pointer to the file header that contains the set + of sections to be searched. + @param SectionData A pointer to the discovered section, if successful. + @param AuthenticationStatus A pointer to the authentication status for this section. + + @retval EFI_SUCCESS The section was found. + @retval EFI_NOT_FOUND The section was not found. + +**/ +EFI_STATUS +EFIAPI +PeiServicesFfsFindSectionData3 ( + IN EFI_SECTION_TYPE SectionType, + IN UINTN SectionInstance, + IN EFI_PEI_FILE_HANDLE FileHandle, + OUT VOID **SectionData, + OUT UINT32 *AuthenticationStatus + ) +{ + CONST EFI_PEI_SERVICES **PeiServices; + + PeiServices = GetPeiServicesTablePointer (); + return (*PeiServices)->FindSectionData3 (PeiServices, SectionType, SectionInstance, FileHandle, SectionData, AuthenticationStatus); +} + /** This service enables PEIMs to register the permanent memory configuration that has been initialized with the PEI Foundation. @@ -319,50 +339,75 @@ PeiServicesFfsFindSectionData ( EFI_STATUS EFIAPI PeiServicesInstallPeiMemory ( - IN EFI_PHYSICAL_ADDRESS MemoryBegin, - IN UINT64 MemoryLength + IN EFI_PHYSICAL_ADDRESS MemoryBegin, + IN UINT64 MemoryLength ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->InstallPeiMemory (PeiServices, MemoryBegin, MemoryLength); } /** - This service enables PEIMs to allocate memory after the permanent memory has been installed by a - PEIM. + This service enables PEIMs to allocate memory. @param MemoryType Type of memory to allocate. - @param Pages Number of pages to allocate. + @param Pages The number of pages to allocate. @param Memory Pointer of memory allocated. @retval EFI_SUCCESS The memory range was successfully allocated. - @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages. - @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available. + @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, + EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData, + EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS. @retval EFI_OUT_OF_RESOURCES The pages could not be allocated. **/ EFI_STATUS EFIAPI PeiServicesAllocatePages ( - IN EFI_MEMORY_TYPE MemoryType, - IN UINTN Pages, - OUT EFI_PHYSICAL_ADDRESS *Memory + IN EFI_MEMORY_TYPE MemoryType, + IN UINTN Pages, + OUT EFI_PHYSICAL_ADDRESS *Memory ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->AllocatePages (PeiServices, MemoryType, Pages, Memory); } +/** + This service enables PEIMs to free memory. + + @param Memory Memory to be freed. + @param Pages The number of pages to free. + + @retval EFI_SUCCESS The requested pages were freed. + @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid. + @retval EFI_NOT_FOUND The requested memory pages were not allocated with + AllocatePages(). + +**/ +EFI_STATUS +EFIAPI +PeiServicesFreePages ( + IN EFI_PHYSICAL_ADDRESS Memory, + IN UINTN Pages + ) +{ + CONST EFI_PEI_SERVICES **PeiServices; + + PeiServices = GetPeiServicesTablePointer (); + return (*PeiServices)->FreePages (PeiServices, Memory, Pages); +} + /** This service allocates memory from the Hand-Off Block (HOB) heap. @param Size The number of bytes to allocate from the pool. - @param Buffer If the call succeeds, a pointer to a pointer to the allocate - buffer; undefined otherwise. + @param Buffer If the call succeeds, a pointer to a pointer to + the allocate buffer; otherwise, undefined. @retval EFI_SUCCESS The allocation was successful @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size. @@ -371,11 +416,11 @@ PeiServicesAllocatePages ( EFI_STATUS EFIAPI PeiServicesAllocatePool ( - IN UINTN Size, - OUT VOID **Buffer + IN UINTN Size, + OUT VOID **Buffer ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->AllocatePool (PeiServices, Size, Buffer); @@ -394,80 +439,103 @@ PeiServicesResetSystem ( VOID ) { - CONST EFI_PEI_SERVICES **PeiServices; + CONST EFI_PEI_SERVICES **PeiServices; PeiServices = GetPeiServicesTablePointer (); return (*PeiServices)->ResetSystem (PeiServices); } /** - This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service RegisterForShadow(), except the + pointer to the PEI Services Table has been removed. See the Platform + Initialization Pre-EFI Initialization Core Interface Specification for details. - @param FileHandle PEIM's file handle. Must be the currently - executing PEIM. - - @retval EFI_SUCCESS The PEIM was successfully registered for - shadowing. + @param FileHandle PEIM's file handle. Must be the currently + executing PEIM. + + @retval EFI_SUCCESS The PEIM was successfully registered for + shadowing. @retval EFI_ALREADY_STARTED The PEIM was previously registered for shadowing. - @retval EFI_NOT_FOUND The FileHandle does not refer to a - valid file handle. + @retval EFI_NOT_FOUND The FileHandle does not refer to a + valid file handle. **/ EFI_STATUS EFIAPI PeiServicesRegisterForShadow ( - IN EFI_PEI_FILE_HANDLE FileHandle + IN EFI_PEI_FILE_HANDLE FileHandle ) { - return (*GetPeiServicesTablePointer())->RegisterForShadow (FileHandle); + return (*GetPeiServicesTablePointer ())->RegisterForShadow (FileHandle); } /** - This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. - @param FileHandle Handle of the file. + @param FileHandle The handle of the file. - @param FileInfo Upon exit, points to the file's - information. + @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. - + + @retval EFI_INVALID_PARAMETER FileInfo is NULL. + **/ EFI_STATUS EFIAPI PeiServicesFfsGetFileInfo ( - IN CONST EFI_PEI_FILE_HANDLE FileHandle, - OUT EFI_FV_FILE_INFO *FileInfo + IN CONST EFI_PEI_FILE_HANDLE FileHandle, + OUT EFI_FV_FILE_INFO *FileInfo ) { - return (*GetPeiServicesTablePointer())->FfsGetFileInfo (FileHandle, FileInfo); + return (*GetPeiServicesTablePointer ())->FfsGetFileInfo (FileHandle, FileInfo); } - /** - This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. + + @param FileHandle The handle of the file. + @param FileInfo Upon exit, points to the file's + information. - @param FileName A pointer to the name of the file to - find within the firmware volume. + @retval EFI_SUCCESS File information returned. + @retval EFI_INVALID_PARAMETER If FileHandle does not + represent a valid file. + @retval EFI_INVALID_PARAMETER FileInfo is NULL. - @param VolumeHandle The firmware volume to search FileHandle - Upon exit, points to the found file's - handle or NULL if it could not be found. +**/ +EFI_STATUS +EFIAPI +PeiServicesFfsGetFileInfo2 ( + IN CONST EFI_PEI_FILE_HANDLE FileHandle, + OUT EFI_FV_FILE_INFO2 *FileInfo + ) +{ + return (*GetPeiServicesTablePointer ())->FfsGetFileInfo2 (FileHandle, FileInfo); +} + +/** + This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. + + @param FileName A pointer to the name of the file to + find within the firmware volume. - @param FileHandle The filehandle found in volume. + @param VolumeHandle The firmware volume to search FileHandle + Upon exit, points to the found file's + handle or NULL if it could not be found. + @param FileHandle The pointer to found file handle @retval EFI_SUCCESS File was found. @@ -480,101 +548,261 @@ PeiServicesFfsGetFileInfo ( EFI_STATUS EFIAPI PeiServicesFfsFindFileByName ( - IN CONST EFI_GUID *FileName, - IN CONST EFI_PEI_FV_HANDLE VolumeHandle, - OUT EFI_PEI_FILE_HANDLE *FileHandle + IN CONST EFI_GUID *FileName, + IN CONST EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_PEI_FILE_HANDLE *FileHandle ) { - return (*GetPeiServicesTablePointer())->FfsFindFileByName (FileName, VolumeHandle, FileHandle); + return (*GetPeiServicesTablePointer ())->FfsFindFileByName (FileName, VolumeHandle, FileHandle); } - /** - This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services - Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface - Specification for details. + This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services + Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface + Specification for details. - @param VolumeHandle Handle of the volume. + @param VolumeHandle Handle of the volume. - @param VolumeInfo Upon exit, points to the volume's - information. + @param VolumeInfo Upon exit, points to the volume'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. **/ EFI_STATUS EFIAPI PeiServicesFfsGetVolumeInfo ( - IN EFI_PEI_FV_HANDLE VolumeHandle, - OUT EFI_FV_INFO *VolumeInfo + IN EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_FV_INFO *VolumeInfo ) { - return (*GetPeiServicesTablePointer())->FfsGetVolumeInfo (VolumeHandle, VolumeInfo); + return (*GetPeiServicesTablePointer ())->FfsGetVolumeInfo (VolumeHandle, VolumeInfo); } /** - Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume. - - This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using - the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. - If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). - If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT(). - - - @param FvFormat Unique identifier of the format of the memory-mapped firmware volume. - This parameter is optional and may be NULL. - If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. - @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 The size, in bytes, of FvInfo. For memory-mapped firmware volumes, - this is typically the size of the firmware volume. - @param ParentFvName If the new firmware volume originated from a file in a different firmware volume, - then this parameter specifies the GUID name of the originating firmware volume. - Otherwise, this parameter must be NULL. - @param ParentFileName If the new firmware volume originated from a file in a different firmware volume, - then this parameter specifies the GUID file name of the originating firmware file. - Otherwise, this parameter must be NULL. + Install a EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance so the PEI Core will be notified about a new firmware volume. + + This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI using + the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance. + If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI, then ASSERT(). + If the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI can not be installed, then ASSERT(). + If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT. + + @param InstallFvInfoPpi Install FvInfo Ppi if it is TRUE. Otherwise, install FvInfo2 Ppi. + @param FvFormat Unique identifier of the format of the memory-mapped + firmware volume. This parameter is optional and + may be NULL. If NULL is specified, the + EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. + @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 The size, in bytes, of FvInfo. For memory-mapped + firmware volumes, this is typically the size of + the firmware volume. + @param ParentFvName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID name of the originating firmware + volume. Otherwise, this parameter must be NULL. + @param ParentFileName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID file name of the originating + firmware file. Otherwise, this parameter must be NULL. + @param AuthenticationStatus Authentication Status, it will be ignored if InstallFvInfoPpi is TRUE. **/ VOID EFIAPI -PeiServicesInstallFvInfoPpi ( - IN CONST EFI_GUID *FvFormat, OPTIONAL - IN CONST VOID *FvInfo, - IN UINT32 FvInfoSize, - IN CONST EFI_GUID *ParentFvName, OPTIONAL - IN CONST EFI_GUID *ParentFileName OPTIONAL +InternalPeiServicesInstallFvInfoPpi ( + IN BOOLEAN InstallFvInfoPpi, + IN CONST EFI_GUID *FvFormat OPTIONAL, + IN CONST VOID *FvInfo, + IN UINT32 FvInfoSize, + IN CONST EFI_GUID *ParentFvName OPTIONAL, + IN CONST EFI_GUID *ParentFileName OPTIONAL, + IN UINT32 AuthenticationStatus ) { - EFI_STATUS Status; - EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *FvInfoPpi; - EFI_PEI_PPI_DESCRIPTOR *FvInfoPpiDescriptor; - - FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI)); - ASSERT( FvInfoPpi != NULL); + EFI_STATUS Status; + EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *FvInfoPpi; + EFI_PEI_PPI_DESCRIPTOR *FvInfoPpiDescriptor; + EFI_GUID *ParentFvNameValue; + EFI_GUID *ParentFileNameValue; + EFI_GUID *PpiGuid; + + ParentFvNameValue = NULL; + ParentFileNameValue = NULL; + if (InstallFvInfoPpi) { + // + // To install FvInfo Ppi. + // + FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI)); + ASSERT (FvInfoPpi != NULL); + PpiGuid = &gEfiPeiFirmwareVolumeInfoPpiGuid; + } else { + // + // To install FvInfo2 Ppi. + // + FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI)); + ASSERT (FvInfoPpi != NULL); + ((EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI *)FvInfoPpi)->AuthenticationStatus = AuthenticationStatus; + PpiGuid = &gEfiPeiFirmwareVolumeInfo2PpiGuid; + } if (FvFormat != NULL) { CopyGuid (&FvInfoPpi->FvFormat, FvFormat); } else { CopyGuid (&FvInfoPpi->FvFormat, &gEfiFirmwareFileSystem2Guid); + // + // Since the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed if NULL is specified for FvFormat, + // check the FileSystemGuid pointed by FvInfo against EFI_FIRMWARE_FILE_SYSTEM2_GUID to make sure + // FvInfo has the firmware file system 2 format. + // If the ASSERT really appears, FvFormat needs to be specified correctly, for example, + // EFI_FIRMWARE_FILE_SYSTEM3_GUID can be used for firmware file system 3 format, or + // ((EFI_FIRMWARE_VOLUME_HEADER *) FvInfo)->FileSystemGuid can be just used for both + // firmware file system 2 and 3 format. + // + ASSERT (CompareGuid (&(((EFI_FIRMWARE_VOLUME_HEADER *)FvInfo)->FileSystemGuid), &gEfiFirmwareFileSystem2Guid)); } - FvInfoPpi->FvInfo = (VOID *) FvInfo; + + FvInfoPpi->FvInfo = (VOID *)FvInfo; FvInfoPpi->FvInfoSize = FvInfoSize; - FvInfoPpi->ParentFvName = (EFI_GUID *) ParentFvName; - FvInfoPpi->ParentFileName = (EFI_GUID *) ParentFileName; + if (ParentFvName != NULL) { + ParentFvNameValue = AllocateCopyPool (sizeof (EFI_GUID), ParentFvName); + ASSERT (ParentFvNameValue != NULL); + FvInfoPpi->ParentFvName = ParentFvNameValue; + } + if (ParentFileName != NULL) { + ParentFileNameValue = AllocateCopyPool (sizeof (EFI_GUID), ParentFileName); + ASSERT (ParentFileNameValue != NULL); + FvInfoPpi->ParentFileName = ParentFileNameValue; + } - FvInfoPpiDescriptor = AllocateCopyPool (sizeof(EFI_PEI_PPI_DESCRIPTOR), mPpiListTemplate); + FvInfoPpiDescriptor = AllocatePool (sizeof (EFI_PEI_PPI_DESCRIPTOR)); ASSERT (FvInfoPpiDescriptor != NULL); - FvInfoPpiDescriptor->Ppi = (VOID *) FvInfoPpi; - Status = PeiServicesInstallPpi (FvInfoPpiDescriptor); + FvInfoPpiDescriptor->Guid = PpiGuid; + FvInfoPpiDescriptor->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST; + FvInfoPpiDescriptor->Ppi = (VOID *)FvInfoPpi; + Status = PeiServicesInstallPpi (FvInfoPpiDescriptor); ASSERT_EFI_ERROR (Status); +} + +/** + Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume. + This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using + the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. + If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). + If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT(). + If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT. + + @param FvFormat Unique identifier of the format of the memory-mapped + firmware volume. This parameter is optional and + may be NULL. If NULL is specified, the + EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. + @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 The size, in bytes, of FvInfo. For memory-mapped + firmware volumes, this is typically the size of + the firmware volume. + @param ParentFvName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID name of the originating firmware + volume. Otherwise, this parameter must be NULL. + @param ParentFileName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID file name of the originating + firmware file. Otherwise, this parameter must be NULL. +**/ +VOID +EFIAPI +PeiServicesInstallFvInfoPpi ( + IN CONST EFI_GUID *FvFormat OPTIONAL, + IN CONST VOID *FvInfo, + IN UINT32 FvInfoSize, + IN CONST EFI_GUID *ParentFvName OPTIONAL, + IN CONST EFI_GUID *ParentFileName OPTIONAL + ) +{ + InternalPeiServicesInstallFvInfoPpi (TRUE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, 0); } +/** + Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume. + + This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using + the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance. + If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT(). + If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT(). + If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT. + + @param FvFormat Unique identifier of the format of the memory-mapped + firmware volume. This parameter is optional and + may be NULL. If NULL is specified, the + EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. + @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 The size, in bytes, of FvInfo. For memory-mapped + firmware volumes, this is typically the size of + the firmware volume. + @param ParentFvName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID name of the originating firmware + volume. Otherwise, this parameter must be NULL. + @param ParentFileName If the new firmware volume originated from a file + in a different firmware volume, then this parameter + specifies the GUID file name of the originating + firmware file. Otherwise, this parameter must be NULL. + @param AuthenticationStatus Authentication Status +**/ +VOID +EFIAPI +PeiServicesInstallFvInfo2Ppi ( + IN CONST EFI_GUID *FvFormat OPTIONAL, + IN CONST VOID *FvInfo, + IN UINT32 FvInfoSize, + IN CONST EFI_GUID *ParentFvName OPTIONAL, + IN CONST EFI_GUID *ParentFileName OPTIONAL, + IN UINT32 AuthenticationStatus + ) +{ + InternalPeiServicesInstallFvInfoPpi (FALSE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, AuthenticationStatus); +} + +/** + Resets the entire platform. + + @param[in] ResetType The type of reset to perform. + @param[in] ResetStatus The status code for the reset. + @param[in] DataSize The size, in bytes, of ResetData. + @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown + the data buffer starts with a Null-terminated string, optionally + followed by additional binary data. The string is a description + that the caller may use to further indicate the reason for the + system reset. + +**/ +VOID +EFIAPI +PeiServicesResetSystem2 ( + IN EFI_RESET_TYPE ResetType, + IN EFI_STATUS ResetStatus, + IN UINTN DataSize, + IN VOID *ResetData OPTIONAL + ) +{ + (*GetPeiServicesTablePointer ())->ResetSystem2 (ResetType, ResetStatus, DataSize, ResetData); +}