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

[mirror_edk2.git] / MdePkg / Library / PeiServicesLib / PeiServicesLib.c

diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
index 29aaaaa235e94196df250f554ba0cb75895686f4..9e3adbe66d2bafac4d12799f09c4f8533abd3bd6 100644 (file)
--- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
+++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c
@@ -281,7 +281,7 @@ EFIAPI
 PeiServicesFfsFindSectionData (\r
   IN EFI_SECTION_TYPE           SectionType,\r
   IN EFI_PEI_FILE_HANDLE        FfsFileHeader,\r
-  IN OUT VOID                   **SectionData\r
+  OUT VOID                      **SectionData\r
   )\r
 {\r
   CONST EFI_PEI_SERVICES **PeiServices;\r
@@ -334,7 +334,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
   CONST EFI_PEI_SERVICES **PeiServices;\r
@@ -368,9 +368,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
@@ -386,6 +388,23 @@ PeiServicesResetSystem (
   return (*PeiServices)->ResetSystem (PeiServices);\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
@@ -398,6 +417,24 @@ PeiServicesRegisterForShadow (
   return (*PeiServices)->RegisterForShadow (FileHandle);\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
@@ -412,6 +449,26 @@ PeiServicesFfsGetFileInfo (
 }\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
 PeiServicesFfsFindFileByName (\r
@@ -424,6 +481,24 @@ PeiServicesFfsFindFileByName (
 }\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