diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2007-11-18 16:01:09 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2007-11-18 16:01:09 +0000 |
| commit | 67c89a212705e53508f1f54e611ee9757ce34502 (patch) | |
| tree | 1a270f8014e22f65b0f2de566ac8ce1c59653ceb /MdePkg/Library | |
| parent | 10e2e070c9f62e884d7b18752ff91ca9d0b74fb2 (diff) | |
| download | edk2-67c89a212705e53508f1f54e611ee9757ce34502.zip edk2-67c89a212705e53508f1f54e611ee9757ce34502.tar.gz edk2-67c89a212705e53508f1f54e611ee9757ce34502.tar.bz2 | |
Fix up the comment for several functions and make sure the IN and OUT modifier of the function parameter is correct.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4301 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library')
| -rw-r--r-- | MdePkg/Library/PeiServicesLib/PeiServicesLib.c | 83 |
1 files changed, 79 insertions, 4 deletions
diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c index 29aaaaa..9e3adbe 100644 --- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c +++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c @@ -281,7 +281,7 @@ EFIAPI PeiServicesFfsFindSectionData (
IN EFI_SECTION_TYPE SectionType,
IN EFI_PEI_FILE_HANDLE FfsFileHeader,
- IN OUT VOID **SectionData
+ OUT VOID **SectionData
)
{
CONST EFI_PEI_SERVICES **PeiServices;
@@ -334,7 +334,7 @@ EFIAPI PeiServicesAllocatePages (
IN EFI_MEMORY_TYPE MemoryType,
IN UINTN Pages,
- IN OUT EFI_PHYSICAL_ADDRESS *Memory
+ OUT EFI_PHYSICAL_ADDRESS *Memory
)
{
CONST EFI_PEI_SERVICES **PeiServices;
@@ -368,9 +368,11 @@ PeiServicesAllocatePool ( }
/**
- This service resets the entire platform, including all processors and devices, and reboots the
- system.
+ Resets the entire platform.
+ @param VOID
+
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
**/
@@ -386,6 +388,23 @@ PeiServicesResetSystem ( return (*PeiServices)->ResetSystem (PeiServices);
}
+/**
+ 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 (
@@ -398,6 +417,24 @@ PeiServicesRegisterForShadow ( return (*PeiServices)->RegisterForShadow (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 (
@@ -412,6 +449,26 @@ PeiServicesFfsGetFileInfo ( }
+/**
+ 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.
+
+ @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
PeiServicesFfsFindFileByName (
@@ -424,6 +481,24 @@ PeiServicesFfsFindFileByName ( }
+/**
+ 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 (
|