/** @file\r
Implementation for PEI Services Library.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
This service enables PEIMs to register a given service to be invoked when another service is\r
installed or reinstalled.\r
\r
- @param NotifyList A pointer to the list of notification interfaces that the caller\r
- shall install.\r
+ @param NotifyList A pointer to the list of notification interfaces \r
+ that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
@retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.\r
- @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the\r
- EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r
+ @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do\r
+ not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES\r
+ bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
/**\r
This service enables a PEIM to ascertain the address of the list of HOBs in memory.\r
\r
- @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize.\r
-\r
+ @param HobList A pointer to the list of HOBs that the PEI Foundation \r
+ will initialize.\r
+ \r
@retval EFI_SUCCESS The list was successfully returned.\r
@retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r
\r
\r
@param Type The type of HOB to be installed.\r
@param Length The length of the HOB to be added.\r
- @param Hob The address of a pointer that will contain the HOB header.\r
+ @param Hob The address of a pointer that will contain the \r
+ HOB header.\r
\r
@retval EFI_SUCCESS The HOB was successfully created.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r
/**\r
This service enables PEIMs to discover additional firmware volumes.\r
\r
- @param Instance This instance of the firmware volume to find. The value 0 is the\r
- Boot Firmware Volume (BFV).\r
- @param VolumeHandle Handle of the firmware volume header of the volume to return.\r
+ @param Instance This instance of the firmware volume to find. The \r
+ value 0 is the Boot Firmware Volume (BFV).\r
+ @param VolumeHandle Handle of the firmware volume header of the volume\r
+ to return.\r
\r
@retval EFI_SUCCESS The volume was found.\r
@retval EFI_NOT_FOUND The volume was not found.\r
This service enables PEIMs to discover additional firmware files.\r
\r
@param SearchType A filter to find files only of this type.\r
- @param VolumeHandle The pointer to the firmware volume header of the volume to search.\r
- This parameter must point to a valid FFS volume.\r
+ @param VolumeHandle The pointer to the firmware volume header of the \r
+ volume to search. This parameter must point to a \r
+ valid FFS volume. \r
@param FileHandle Handle of the current file from which to begin searching.\r
\r
@retval EFI_SUCCESS The file was found.\r
This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
\r
@param SectionType The value of the section type to find.\r
- @param FileHandle A pointer to the file header that contains the set of sections to\r
- be searched.\r
+ @param FileHandle A pointer to the file header that contains the set \r
+ of sections to be searched.\r
@param SectionData A pointer to the discovered section, if successful.\r
\r
@retval EFI_SUCCESS The section was found.\r
}\r
\r
/**\r
- This service enables PEIMs to allocate memory after the permanent memory has been installed by a\r
- PEIM.\r
+ This service enables PEIMs to allocate memory after the permanent memory has been\r
+ installed by a PEIM.\r
\r
@param MemoryType Type of memory to allocate.\r
@param Pages The number of pages to allocate.\r
This service allocates memory from the Hand-Off Block (HOB) heap.\r
\r
@param Size The number of bytes to allocate from the pool.\r
- @param Buffer If the call succeeds, a pointer to a pointer to the allocate\r
- buffer; undefined otherwise.\r
+ @param Buffer If the call succeeds, a pointer to a pointer to \r
+ the allocate buffer; otherwise, undefined.\r
\r
@retval EFI_SUCCESS The allocation was successful\r
@retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r
}\r
\r
/**\r
- This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services \r
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
- Specification for details. \r
+ This service is a wrapper for the PEI Service RegisterForShadow(), except the \r
+ pointer to the PEI Services Table has been removed. See the Platform \r
+ Initialization Pre-EFI Initialization Core Interface Specification for details. \r
\r
- @param FileHandle PEIM's file handle. Must be the currently\r
- executing PEIM.\r
+ @param FileHandle PEIM's file handle. Must be the currently\r
+ executing PEIM.\r
\r
- @retval EFI_SUCCESS The PEIM was successfully registered for\r
- shadowing.\r
+ @retval EFI_SUCCESS The PEIM was successfully registered for\r
+ shadowing.\r
\r
@retval EFI_ALREADY_STARTED The PEIM was previously\r
registered for shadowing.\r
\r
- @retval EFI_NOT_FOUND The FileHandle does not refer to a\r
- valid file handle.\r
+ @retval EFI_NOT_FOUND The FileHandle does not refer to a\r
+ valid file handle.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
Specification for details. \r
\r
- @param FileHandle Handle of the file.\r
+ @param FileHandle The handle of the file.\r
\r
- @param FileInfo Upon exit, points to the file's\r
- information.\r
+ @param FileInfo Upon exit, points to the file's\r
+ information.\r
\r
@retval EFI_SUCCESS File information returned.\r
\r
@retval EFI_INVALID_PARAMETER If FileHandle does not\r
represent a valid file.\r
\r
- @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
\r
**/\r
EFI_STATUS\r
Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
Specification for details. \r
\r
- @param FileName A pointer to the name of the file to\r
- find within the firmware volume.\r
+ @param FileName A pointer to the name of the file to\r
+ find within the firmware volume.\r
\r
- @param VolumeHandle The firmware volume to search FileHandle\r
- Upon exit, points to the found file's\r
- handle or NULL if it could not be found.\r
- @param FileHandle The pointer to found file handle \r
+ @param VolumeHandle The firmware volume to search FileHandle\r
+ Upon exit, points to the found file's\r
+ handle or NULL if it could not be found.\r
+ @param FileHandle The pointer to found file handle \r
\r
@retval EFI_SUCCESS File was found.\r
\r
Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
Specification for details. \r
\r
- @param VolumeHandle Handle of the volume.\r
+ @param VolumeHandle Handle of the volume.\r
\r
- @param VolumeInfo Upon exit, points to the volume's\r
- information.\r
+ @param VolumeInfo Upon exit, points to the volume's\r
+ information.\r
\r
@retval EFI_SUCCESS File information returned.\r
\r
If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r
\r
\r
- @param FvFormat Unique identifier of the format of the memory-mapped firmware volume.\r
- This parameter is optional and may be NULL. \r
- If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
- @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. \r
- The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, \r
- this typically points to the first byte of the firmware volume.\r
- @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes, \r
- this is typically the size of the firmware volume.\r
- @param ParentFvName If the new firmware volume originated from a file in a different firmware volume, \r
- then this parameter specifies the GUID name of the originating firmware volume.\r
- Otherwise, this parameter must be NULL.\r
- @param ParentFileName If the new firmware volume originated from a file in a different firmware volume, \r
- then this parameter specifies the GUID file name of the originating firmware file.\r
- Otherwise, this parameter must be NULL.\r
+ @param FvFormat Unique identifier of the format of the memory-mapped \r
+ firmware volume. This parameter is optional and \r
+ may be NULL. If NULL is specified, the \r
+ EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
+ @param FvInfo Points to a buffer which allows the \r
+ EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. \r
+ The format of this buffer is specific to the FvFormat. \r
+ For memory-mapped firmware volumes, this typically \r
+ points to the first byte of the firmware volume.\r
+ @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped \r
+ firmware volumes, this is typically the size of \r
+ the firmware volume.\r
+ @param ParentFvName If the new firmware volume originated from a file \r
+ in a different firmware volume, then this parameter \r
+ specifies the GUID name of the originating firmware\r
+ volume. Otherwise, this parameter must be NULL.\r
+ @param ParentFileName If the new firmware volume originated from a file \r
+ in a different firmware volume, then this parameter \r
+ specifies the GUID file name of the originating \r
+ firmware file. Otherwise, this parameter must be NULL.\r
**/\r
VOID\r
EFIAPI\r
projects / mirror_edk2.git / blobdiff