X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FPeiServicesLib.h;h=e417870cdbe679537dcd7d1c0503ce578a6dfb86;hb=003c1db883a1e5c4011ded3fe17c2d9405292dd9;hp=53d1cdba427bcb30d19a8595ccc04a024068e3f3;hpb=add13dc21720eff1a37fdea34c0fef190e2ad37d;p=mirror_edk2.git diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h index 53d1cdba42..e417870cdb 100644 --- a/MdePkg/Include/Library/PeiServicesLib.h +++ b/MdePkg/Include/Library/PeiServicesLib.h @@ -1,16 +1,14 @@ /** @file - Header file for PEI Services Library. + Provides library functions for all PEI Services. - Copyright (c) 2006, 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 +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. - - Module Name: PeiServicesLib.h +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -32,7 +30,7 @@ EFI_STATUS EFIAPI PeiServicesInstallPpi ( - IN EFI_PEI_PPI_DESCRIPTOR *PpiList + IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList ); /** @@ -53,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 ); /** @@ -73,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 @@ -96,7 +94,7 @@ PeiServicesLocatePpi ( EFI_STATUS EFIAPI PeiServicesNotifyPpi ( - IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList + IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList ); /** @@ -111,7 +109,7 @@ PeiServicesNotifyPpi ( EFI_STATUS EFIAPI PeiServicesGetBootMode ( - IN OUT EFI_BOOT_MODE *BootMode + OUT EFI_BOOT_MODE *BootMode ); /** @@ -140,7 +138,7 @@ PeiServicesSetBootMode ( EFI_STATUS EFIAPI PeiServicesGetHobList ( - IN OUT VOID **HobList + OUT VOID **HobList ); /** @@ -159,7 +157,7 @@ EFIAPI PeiServicesCreateHob ( IN UINT16 Type, IN UINT16 Length, - IN OUT VOID **Hob + OUT VOID **Hob ); /** @@ -167,7 +165,7 @@ PeiServicesCreateHob ( @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 Pointer to 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. @@ -178,16 +176,16 @@ EFI_STATUS EFIAPI PeiServicesFfsFindNextVolume ( IN UINTN Instance, - IN OUT EFI_FIRMWARE_VOLUME_HEADER **FwVolHeader + IN OUT EFI_PEI_FV_HANDLE *VolumeHandle ); /** This service enables PEIMs to discover additional firmware files. @param SearchType A filter to find files only of this type. - @param FwVolHeader Pointer to the firmware volume header of the volume to search. + @param VolumeHandle Pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume. - @param FileHeader Pointer to the current file from which to begin searching. + @param FileHandle Pointer to the current file from which to begin searching. @retval EFI_SUCCESS The file was found. @retval EFI_NOT_FOUND The file was not found. @@ -198,15 +196,15 @@ 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 ); /** This service enables PEIMs to discover sections of a given type within a valid FFS file. - @param SearchType The value of the section type to find. - @param FfsFileHeader A pointer to the file header that contains the set of sections to + @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 SectionData A pointer to the discovered section, if successful. @@ -218,8 +216,8 @@ EFI_STATUS EFIAPI PeiServicesFfsFindSectionData ( IN EFI_SECTION_TYPE SectionType, - IN EFI_FFS_FILE_HEADER *FfsFileHeader, - IN OUT VOID **SectionData + IN EFI_PEI_FILE_HANDLE FileHandle, + OUT VOID **SectionData ); /** @@ -260,7 +258,7 @@ EFIAPI PeiServicesAllocatePages ( IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, - IN OUT EFI_PHYSICAL_ADDRESS *Memory + OUT EFI_PHYSICAL_ADDRESS *Memory ); /** @@ -282,9 +280,9 @@ PeiServicesAllocatePool ( ); /** - This service resets the entire platform, including all processors and devices, and reboots the - system. + Resets the entire platform. + @retval EFI_SUCCESS The function completed successfully. @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet. **/ @@ -295,4 +293,142 @@ PeiServicesResetSystem ( ); +/** + 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 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 Pointer to found file handle + + @retval EFI_SUCCESS File was found. + + @retval EFI_NOT_FOUND File was not found. + + @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or + FileName was NULL. + +**/ +EFI_STATUS +EFIAPI +PeiServicesFfsFindByName ( + IN CONST EFI_GUID *FileName, + IN CONST EFI_PEI_FV_HANDLE VolumeHandle, + OUT EFI_PEI_FILE_HANDLE *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. + + @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. + +**/ +EFI_STATUS +EFIAPI +PeiServicesFfsGetFileInfo ( + IN CONST EFI_PEI_FILE_HANDLE FileHandle, + OUT EFI_FV_FILE_INFO *FileInfo + ); + +/** + 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 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 + ); + + +/** + 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. + + @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. +**/ +EFI_STATUS +EFIAPI +PeiServicesRegisterForShadow ( + IN EFI_PEI_FILE_HANDLE FileHandle + ); + +/** + 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. +**/ +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 + ); + #endif