Fix up the comment for several functions and make sure the IN and OUT modifier of...

[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesLib.h

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index 2d028239d737155f09be01f0550ce4bb5ad3ded4..bed110584cbdea4a94246ce5762a075913bf3338 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -1,7 +1,7 @@
 /** @file\r
   Header file for PEI Services Library.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -109,7 +109,7 @@ PeiServicesNotifyPpi (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesGetBootMode (\r
-  IN OUT EFI_BOOT_MODE          *BootMode\r
+  OUT EFI_BOOT_MODE          *BootMode\r
   );\r
 \r
 /**\r
@@ -138,7 +138,7 @@ PeiServicesSetBootMode (
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesGetHobList (\r
-  IN OUT VOID                   **HobList\r
+  OUT VOID                      **HobList\r
   );\r
 \r
 /**\r
@@ -157,7 +157,7 @@ EFIAPI
 PeiServicesCreateHob (\r
   IN UINT16                     Type,\r
   IN UINT16                     Length,\r
-  IN OUT VOID                   **Hob\r
+  OUT VOID                      **Hob\r
   );\r
 \r
 /**\r
@@ -217,7 +217,7 @@ EFIAPI
 PeiServicesFfsFindSectionData (\r
   IN EFI_SECTION_TYPE           SectionType,\r
   IN EFI_PEI_FILE_HANDLE        FileHandle,\r
-  IN OUT VOID                   **SectionData\r
+  OUT VOID                      **SectionData\r
   );\r
 \r
 /**\r
@@ -258,7 +258,7 @@ EFIAPI
 PeiServicesAllocatePages (\r
   IN EFI_MEMORY_TYPE            MemoryType,\r
   IN UINTN                      Pages,\r
-  IN OUT EFI_PHYSICAL_ADDRESS   *Memory\r
+  OUT EFI_PHYSICAL_ADDRESS      *Memory\r
   );\r
 \r
 /**\r
@@ -280,9 +280,11 @@ PeiServicesAllocatePool (
   );\r
 \r
 /**\r
-  This service resets the entire platform, including all processors and devices, and reboots the\r
-  system. \r
+  Resets the entire platform.\r
 \r
+  @param  VOID\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
 \r
 **/\r
@@ -293,6 +295,26 @@ PeiServicesResetSystem (
   );\r
 \r
 \r
+/**\r
+  This service is a wrapper for the PEI Service FfsFindByName(), 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
+\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
+\r
+  @retval EFI_SUCCESS             File was found.\r
+\r
+  @retval EFI_NOT_FOUND           File was not found.\r
+\r
+  @retval EFI_INVALID_PARAMETER   VolumeHandle or FileHandle or\r
+                                  FileName was NULL.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesFfsFindByName (\r
@@ -302,6 +324,24 @@ PeiServicesFfsFindByName (
   );\r
 \r
 \r
+/**\r
+  This service is a wrapper for the PEI Service FfsGetFileInfo(), 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
+\r
+  @param FileHandle   Handle of the file.\r
+\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
+  \r
+**/\r
 EFI_STATUS\r
 EFIAPI \r
 PeiServicesFfsGetFileInfo (\r
@@ -309,6 +349,24 @@ PeiServicesFfsGetFileInfo (
   OUT EFI_FV_FILE_INFO            *FileInfo\r
   );\r
 \r
+/**\r
+  This service is a wrapper for the PEI Service FfsGetVolumeInfo(), 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
+\r
+  @param VolumeHandle   Handle of the volume.\r
+\r
+  @param VolumeInfo     Upon exit, points to the volume'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
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesFfsGetVolumeInfo (\r
@@ -317,6 +375,23 @@ PeiServicesFfsGetVolumeInfo (
   );\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
+\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
+\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
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiServicesRegisterForShadow (\r