From b0d803fe3e5c55a9a0c75bc90ccf40ebbbc9ffa3 Mon Sep 17 00:00:00 2001 From: klu2 Date: Mon, 24 Sep 2007 11:38:43 +0000 Subject: Merge branch of PI tree to main trunk git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3918 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Library/HobLib.h | 24 +++ MdePkg/Include/Library/PeiPiLib.h | 30 +++ MdePkg/Include/Library/PeiServicesLib.h | 31 +++ .../Include/Library/PeiServicesTablePointerLib.h | 6 + MdePkg/Include/Library/PiLib.h | 227 +++++++++++++++++++++ MdePkg/Include/Pi/PiPeiCis.h | 6 +- 6 files changed, 321 insertions(+), 3 deletions(-) create mode 100644 MdePkg/Include/Library/PeiPiLib.h (limited to 'MdePkg/Include') diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h index 0e1555de10..50e0d10676 100644 --- a/MdePkg/Include/Library/HobLib.h +++ b/MdePkg/Include/Library/HobLib.h @@ -262,6 +262,30 @@ BuildFvHob ( ) ; +/** + Builds a EFI_HOB_TYPE_FV2 HOB. + + This function builds a EFI_HOB_TYPE_FV2 HOB. + It can only be invoked during PEI phase; + for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. + If there is no additional space for HOB creation, then ASSERT(). + + @param BaseAddress The base address of the Firmware Volume. + @param Length The size of the Firmware Volume in bytes. + @param FvName The name of the Firmware Volume. + @param FileName The name of the file. + +**/ +VOID +EFIAPI +BuildFv2Hob ( + IN EFI_PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN CONST EFI_GUID *FvName, + IN CONST EFI_GUID *FileName + ) +; + /** Builds a Capsule Volume HOB. diff --git a/MdePkg/Include/Library/PeiPiLib.h b/MdePkg/Include/Library/PeiPiLib.h new file mode 100644 index 0000000000..a34fd50c10 --- /dev/null +++ b/MdePkg/Include/Library/PeiPiLib.h @@ -0,0 +1,30 @@ +/** @file + MDE PI library functions and macros for PEI phase + + Copyright (c) 2007, 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. + +**/ + +#ifndef __PEI_PI_LIB_H__ +#define __PEI_PI_LIB_H__ + +#include + +VOID +EFIAPI +PeiPiLibBuildPiFvInfoPpi ( + IN EFI_PHYSICAL_ADDRESS FvStart, + IN UINT64 FvLength, + IN EFI_GUID *ParentFvName, + IN EFI_GUID *PraentFileName +); + +#endif + diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h index 3d0deb9ba4..2d028239d7 100644 --- a/MdePkg/Include/Library/PeiServicesLib.h +++ b/MdePkg/Include/Library/PeiServicesLib.h @@ -293,4 +293,35 @@ PeiServicesResetSystem ( ); +EFI_STATUS +EFIAPI +PeiServicesFfsFindByName ( + IN CONST EFI_GUID *FileName, + IN CONST EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_PEI_FILE_HANDLE *FileHandle + ); + + +EFI_STATUS +EFIAPI +PeiServicesFfsGetFileInfo ( + IN CONST EFI_PEI_FILE_HANDLE FileHandle, + OUT EFI_FV_FILE_INFO *FileInfo + ); + +EFI_STATUS +EFIAPI +PeiServicesFfsGetVolumeInfo ( + IN EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_FV_INFO *VolumeInfo + ); + + +EFI_STATUS +EFIAPI +PeiServicesRegisterForShadow ( + IN EFI_PEI_FILE_HANDLE FileHandle + ); + + #endif diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h index ede0337730..7a602f9041 100644 --- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h +++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h @@ -30,5 +30,11 @@ GetPeiServicesTablePointer ( VOID ); +VOID +EFIAPI +SetPeiServicesTablePointer ( + EFI_PEI_SERVICES ** PeiServicesTablePointer + ); + #endif diff --git a/MdePkg/Include/Library/PiLib.h b/MdePkg/Include/Library/PiLib.h index d15a712678..8aaad25058 100644 --- a/MdePkg/Include/Library/PiLib.h +++ b/MdePkg/Include/Library/PiLib.h @@ -75,6 +75,233 @@ GetSectionFromFvFile ( ) ; +/** + 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. + + The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the + any Firmware Volume 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 + 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 only be called at TPL_NOTIFY and below. + + 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 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_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 +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, + 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 same Firmware Volume with the caller's FFS. + + This functions first locates the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance for same Firmrware Volume + which also contains the FFS of the caller 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 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 +GetSectionFromCurrentFv ( + 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 the first Firmware Section in the same Firmware File as the caller of this function. + + The function will read the first Firmware Section found sepcifed by NameGuid and SectionType from the + Firmware Volume specified by FvHandle. On this FvHandle, an EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance + should be located succesfully in order to carry out the Firmware Volume operations. + + 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 FvHandle 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 +GetSectionFromCurrentFfs ( + IN EFI_SECTION_TYPE SectionType, + IN UINTN Instance, + OUT VOID **Buffer, + OUT UINTN *Size + ) +; #endif diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h index 4d95c7fbd8..d75a79c6b7 100644 --- a/MdePkg/Include/Pi/PiPeiCis.h +++ b/MdePkg/Include/Pi/PiPeiCis.h @@ -51,8 +51,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR; typedef EFI_STATUS (EFIAPI *EFI_PEIM_ENTRY_POINT2)( - IN EFI_PEI_FILE_HANDLE *FileHandle, - IN EFI_PEI_SERVICES **PeiServices + IN EFI_PEI_FILE_HANDLE FileHandle, + IN CONST EFI_PEI_SERVICES **PeiServices ); /** @@ -491,7 +491,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_RESET_SYSTEM) ( - IN EFI_PEI_SERVICES **PeiServices + IN CONST EFI_PEI_SERVICES **PeiServices ); /** -- cgit v1.2.3