4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides library functions for all PEI Services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables a given PEIM to register an interface into the PEI Foundation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PpiList A pointer to the list of interfaces that the caller shall install.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface was successfully installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to replace an entry in the PPI database with an alternate entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OldPpi Pointer to the old PEI PPI Descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NewPpi Pointer to the new PEI PPI Descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface was successfully installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to discover a given instance of an interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Guid A pointer to the GUID whose corresponding interface needs to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance The N-th instance of the interface that is required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ppi A pointer to the instance of the interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface was successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to register a given service to be invoked when another service is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed or reinstalled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NotifyList A pointer to the list of notification interfaces that the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync shall install.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The interface was successfully installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to ascertain the present value of the boot mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BootMode A pointer to contain the value of the boot mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The boot mode was returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER BootMode is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to update the boot mode variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BootMode The value of the boot mode to set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The value was successfully updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables a PEIM to ascertain the address of the list of HOBs in memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The list was successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to create various types of HOBs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Type The type of HOB to be installed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The length of the HOB to be added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Hob The address of a pointer that will contain the HOB header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The HOB was successfully created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to discover additional firmware volumes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Instance This instance of the firmware volume to find. The value 0 is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Boot Firmware Volume (BFV).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VolumeHandle Handle of the firmware volume header of the volume to return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The volume was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The volume was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to discover additional firmware files.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SearchType A filter to find files only of this type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VolumeHandle Pointer to the firmware volume header of the volume to search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter must point to a valid FFS volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Handle of the current file from which to begin searching.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The file was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The header checksum was not zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to discover sections of a given type within a valid FFS file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType The value of the section type to find.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle A pointer to the file header that contains the set of sections to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be searched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionData A pointer to the discovered section, if successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The section was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The section was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to register the permanent memory configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that has been initialized with the PEI Foundation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryBegin The value of a region of installed memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryLength The corresponding length of a region of installed memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The region was successfully installed in a HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service enables PEIMs to allocate memory after the permanent memory has been installed by a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemoryType Type of memory to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pages Number of pages to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Memory Pointer of memory allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory range was successfully allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service allocates memory from the Hand-Off Block (HOB) heap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size The number of bytes to allocate from the pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer If the call succeeds, a pointer to a pointer to the allocate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer; undefined otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The allocation was successful
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets the entire platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The function completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName A pointer to the name of the file to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync find within the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VolumeHandle The firmware volume to search FileHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Upon exit, points to the found file's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle or NULL if it could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Pointer to found file handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS File was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND File was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileName was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle Handle of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileInfo Upon exit, points to the file's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS File information returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If FileHandle does not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync represent a valid file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If FileInfo is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VolumeHandle Handle of the volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param VolumeInfo Upon exit, points to the volume's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS File information returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If FileHandle does not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync represent a valid file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER If FileInfo is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for details.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileHandle PEIM's file handle. Must be the currently
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executing PEIM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PEIM was successfully registered for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The PEIM was previously
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered for shadowing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The FileHandle does not refer to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync valid file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvFormat Unique identifier of the format of the memory-mapped firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter is optional and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this typically points to the first byte of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is typically the size of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ParentFvName If the new firmware volume originated from a file in a different firmware volume,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then this parameter specifies the GUID name of the originating firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, this parameter must be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ParentFileName If the new firmware volume originated from a file in a different firmware volume,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then this parameter specifies the GUID file name of the originating firmware file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, this parameter must be NULL.