From 1c280088ec83160a5f190b3d0ba796b224ee23b3 Mon Sep 17 00:00:00 2001 From: qwang12 Date: Tue, 4 Sep 2007 06:11:47 +0000 Subject: Merge the PI enabling works from the branch First round of PI enabling work: 1) PiPeiCis changes (CONST, EFI_PEI_FILE_HANDLE.. etc) 2) Make use of FirmwareVolume 2 protocol. 3) Verified for Nt32Pkg and real platform for S3. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3772 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Library/PeiServicesLib.h | 18 +++---- MdePkg/Include/Library/PiLib.h | 80 +++++++++++++++++++++++++++ MdePkg/Include/Pi/PiPeiCis.h | 96 ++++++++++++++++----------------- 3 files changed, 137 insertions(+), 57 deletions(-) create mode 100644 MdePkg/Include/Library/PiLib.h (limited to 'MdePkg/Include') diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h index eab3eff59e..3d0deb9ba4 100644 --- a/MdePkg/Include/Library/PeiServicesLib.h +++ b/MdePkg/Include/Library/PeiServicesLib.h @@ -30,7 +30,7 @@ EFI_STATUS EFIAPI PeiServicesInstallPpi ( - IN EFI_PEI_PPI_DESCRIPTOR *PpiList + IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList ); /** @@ -51,8 +51,8 @@ PeiServicesInstallPpi ( EFI_STATUS EFIAPI PeiServicesReInstallPpi ( - IN EFI_PEI_PPI_DESCRIPTOR *OldPpi, - IN EFI_PEI_PPI_DESCRIPTOR *NewPpi + IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, + IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi ); /** @@ -71,7 +71,7 @@ PeiServicesReInstallPpi ( EFI_STATUS EFIAPI PeiServicesLocatePpi ( - IN EFI_GUID *Guid, + IN CONST EFI_GUID *Guid, IN UINTN Instance, IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, IN OUT VOID **Ppi @@ -94,7 +94,7 @@ PeiServicesLocatePpi ( EFI_STATUS EFIAPI PeiServicesNotifyPpi ( - IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList + IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList ); /** @@ -176,7 +176,7 @@ EFI_STATUS EFIAPI PeiServicesFfsFindNextVolume ( IN UINTN Instance, - IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader + IN OUT EFI_PEI_FV_HANDLE *VolumeHandle ); /** @@ -196,8 +196,8 @@ EFI_STATUS EFIAPI PeiServicesFfsFindNextFile ( IN EFI_FV_FILETYPE SearchType, - IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader, - IN OUT EFI_FFS_FILE_HEADER **FileHeader + IN EFI_PEI_FV_HANDLE VolumeHandle, + IN OUT EFI_PEI_FILE_HANDLE *FileHandle ); /** @@ -216,7 +216,7 @@ EFI_STATUS EFIAPI PeiServicesFfsFindSectionData ( IN EFI_SECTION_TYPE SectionType, - IN EFI_FFS_FILE_HEADER *FfsFileHeader, + IN EFI_PEI_FILE_HANDLE FileHandle, IN OUT VOID **SectionData ); diff --git a/MdePkg/Include/Library/PiLib.h b/MdePkg/Include/Library/PiLib.h new file mode 100644 index 0000000000..d15a712678 --- /dev/null +++ b/MdePkg/Include/Library/PiLib.h @@ -0,0 +1,80 @@ +/** @file + MDE PI library functions and macros + + 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 __PI_LIB_H__ +#define __PI_LIB_H__ + +#include + +/** + 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 + ) +; + + +#endif + diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h index ce8dc8a849..4d95c7fbd8 100644 --- a/MdePkg/Include/Pi/PiPeiCis.h +++ b/MdePkg/Include/Pi/PiPeiCis.h @@ -126,8 +126,8 @@ typedef struct _EFI_HOB_LOAD_PEIM { typedef EFI_STATUS (EFIAPI *EFI_PEI_INSTALL_PPI) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_PEI_PPI_DESCRIPTOR *PpiList + IN CONST EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList ); /** @@ -151,9 +151,9 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_REINSTALL_PPI) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_PEI_PPI_DESCRIPTOR *OldPpi, - IN EFI_PEI_PPI_DESCRIPTOR *NewPpi + IN CONST EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, + IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi ); /** @@ -172,11 +172,11 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_LOCATE_PPI) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_GUID *Guid, - IN UINTN Instance, - IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, - IN OUT VOID **Ppi + IN CONST EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_GUID *Guid, + IN UINTN Instance, + IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor OPTIONAL, + IN OUT VOID **Ppi ); /** @@ -197,8 +197,8 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_NOTIFY_PPI) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList + IN CONST EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList ); /** @@ -213,8 +213,8 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_GET_BOOT_MODE) ( - IN EFI_PEI_SERVICES **PeiServices, - OUT EFI_BOOT_MODE *BootMode + IN CONST EFI_PEI_SERVICES **PeiServices, + OUT EFI_BOOT_MODE *BootMode ); /** @@ -229,8 +229,8 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_SET_BOOT_MODE) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_BOOT_MODE BootMode + IN CONST EFI_PEI_SERVICES **PeiServices, + IN EFI_BOOT_MODE BootMode ); /** @@ -246,8 +246,8 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_GET_HOB_LIST) ( - IN EFI_PEI_SERVICES **PeiServices, - IN OUT VOID **HobList + IN CONST EFI_PEI_SERVICES **PeiServices, + IN OUT VOID **HobList ); /** @@ -265,10 +265,10 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_CREATE_HOB) ( - IN EFI_PEI_SERVICES **PeiServices, - IN UINT16 Type, - IN UINT16 Length, - IN OUT VOID **Hob + IN CONST EFI_PEI_SERVICES **PeiServices, + IN UINT16 Type, + IN UINT16 Length, + IN OUT VOID **Hob ); /** @@ -279,19 +279,19 @@ EFI_STATUS @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV). - @param FwVolHeader Pointer to the firmware volume header of the volume to return. + @param VolumeHandle On exit, points to the next volumn handle or NULL if it does not exist. @retval EFI_SUCCESS The volume was found. @retval EFI_NOT_FOUND The volume was not found. - @retval EFI_INVALID_PARAMETER FwVolHeader is NULL + @retval EFI_INVALID_PARAMETER VolHandle is NULL **/ typedef EFI_STATUS (EFIAPI *EFI_PEI_FFS_FIND_NEXT_VOLUME2) ( - IN EFI_PEI_SERVICES **PeiServices, - IN UINTN Instance, - IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader + IN CONST EFI_PEI_SERVICES **PeiServices, + IN UINTN Instance, + OUT EFI_PEI_FV_HANDLE *VolumeHandle ); /** @@ -315,10 +315,10 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_FFS_FIND_NEXT_FILE2) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_FV_FILETYPE SearchType, - IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader, - IN OUT EFI_FFS_FILE_HEADER **FileHeader + IN CONST EFI_PEI_SERVICES **PeiServices, + IN EFI_FV_FILETYPE SearchType, + IN EFI_PEI_FV_HANDLE VolumeHandle, + IN OUT EFI_PEI_FILE_HANDLE *FileHandle ); /** @@ -337,10 +337,10 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA2) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_SECTION_TYPE SectionType, - IN EFI_FFS_FILE_HEADER *FfsFileHeader, - IN OUT VOID **SectionData + IN CONST EFI_PEI_SERVICES **PeiServices, + IN EFI_SECTION_TYPE SectionType, + IN EFI_PEI_FILE_HANDLE FileHandle, + IN OUT VOID **SectionData ); /** @@ -358,7 +358,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_INSTALL_PEI_MEMORY) ( - IN EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength ); @@ -381,7 +381,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_ALLOCATE_PAGES) ( - IN EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT EFI_PHYSICAL_ADDRESS *Memory @@ -402,7 +402,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_ALLOCATE_POOL) ( - IN EFI_PEI_SERVICES **PeiServices, + IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Size, OUT VOID **Buffer ); @@ -470,12 +470,12 @@ VOID typedef EFI_STATUS (EFIAPI *EFI_PEI_REPORT_STATUS_CODE) ( - IN EFI_PEI_SERVICES **PeiServices, - IN EFI_STATUS_CODE_TYPE Type, - IN EFI_STATUS_CODE_VALUE Value, - IN UINT32 Instance, - IN EFI_GUID *CallerId OPTIONAL, - IN EFI_STATUS_CODE_DATA *Data OPTIONAL + IN CONST EFI_PEI_SERVICES **PeiServices, + IN EFI_STATUS_CODE_TYPE Type, + IN EFI_STATUS_CODE_VALUE Value, + IN UINT32 Instance, + IN CONST EFI_GUID *CallerId OPTIONAL, + IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL ); /** @@ -578,7 +578,7 @@ typedef EFI_STATUS (EFIAPI *EFI_PEI_FFS_GET_FILE_INFO) ( IN CONST EFI_PEI_FILE_HANDLE FileHandle, - OUT EFI_FV_FILE_INFO *FileInfo + OUT EFI_FV_FILE_INFO *FileInfo ); @@ -636,8 +636,8 @@ typedef struct { typedef EFI_STATUS (EFIAPI *EFI_PEI_FFS_GET_VOLUME_INFO) ( - IN CONST EFI_PEI_FV_HANDLE *VolumeHandle, - OUT EFI_FV_INFO *VolumeInfo + IN EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_FV_INFO *VolumeInfo ); /** @@ -668,7 +668,7 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_REGISTER_FOR_SHADOW) ( - IN CONST EFI_PEI_FILE_HANDLE FileHandle + IN EFI_PEI_FILE_HANDLE FileHandle ); -- cgit v1.2.3