added additional comments and fixed some typo.

[mirror_edk2.git] / MdePkg / Include / Pi / PiPeiCis.h

diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h
index 50e3b09d0ec460657cde5dfe8b5d79e75c3a6d90..34691a085173efa7f6534564f579995d38310314 100644 (file)
--- a/MdePkg/Include/Pi/PiPeiCis.h
+++ b/MdePkg/Include/Pi/PiPeiCis.h
@@ -1,7 +1,7 @@
 /** @file\r
   PI PEI master include file. This file should match the PI spec.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -52,7 +52,8 @@ typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;
   @param  FileHandle       Pointer to the FFS file header.\r
   @param  PeiServices      Describes the list of possible PEI Services.\r
 \r
-  @return Status code\r
+  @retval EFI_SUCCESS      The PEI completed successfully.\r
+  @retval !EFI_SUCCESS     There is error in PEIM.\r
 \r
 **/\r
 typedef\r
@@ -69,7 +70,7 @@ EFI_STATUS
   @param  NotifyDescriptor Address of the notification descriptor data structure.\r
   @param  Ppi              Address of the PPI that was installed.\r
 \r
-  @return Status code\r
+  @return Status of the notification.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -281,7 +282,7 @@ EFI_STATUS
   IN CONST EFI_PEI_SERVICES            **PeiServices,\r
   IN UINT16                            Type,\r
   IN UINT16                            Length,\r
-  OUT VOID                             **Hob\r
+  IN OUT VOID                          **Hob\r
   );\r
 \r
 /**\r
@@ -296,7 +297,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
-  @retval EFI_INVALID_PARAMETER VolHandle is NULL\r
+  @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.\r
 \r
 **/\r
 typedef\r
@@ -427,8 +428,6 @@ EFI_STATUS
   @param  Source           Pointer to the source buffer of the memory copy\r
   @param  Length           Number of bytes to copy from Source to Destination.\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -445,8 +444,6 @@ VOID
   @param  Size             Number of bytes in Buffer to fill.\r
   @param  Value            Value to fill Buffer with\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -516,19 +513,15 @@ EFI_STATUS
 \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
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -542,20 +535,16 @@ EFI_STATUS
 /**\r
    \r
   @param FileName   Name of the file.\r
-\r
   @param FileType   File type. See EFI_FV_FILETYPE, which is\r
                     defined in the Platform Initialization\r
                     Firmware Storage Specification.\r
-\r
   @param FileAttributes   Attributes of the file. Type\r
                           EFI_FV_FILE_ATTRIBUTES is defined in\r
                           the Platform Initialization Firmware\r
                           Storage Specification.\r
-\r
   @param Buffer   Points to the file's data (not the header).\r
                   Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r
                   is zero.\r
-\r
   @param BufferSize   Size of the file's data.\r
 \r
 **/\r
@@ -568,22 +557,18 @@ typedef struct {
 } EFI_FV_FILE_INFO;\r
 \r
 /**\r
-   \r
   This function returns information about a specific file,\r
   including its file name, type, attributes, starting address and\r
   size. If the firmware volume is not memory mapped then the\r
   Buffer member will be NULL.\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
@@ -598,7 +583,7 @@ EFI_STATUS
 /**\r
    \r
   @param FvAttributes   Attributes of the firmware volume. Type\r
-                        EFI_FVB_ATTRIBUTES is defined in the\r
+                        EFI_FVB_ATTRIBUTES_2 is defined in the\r
                         Platform Initialization Firmware Storage\r
                         Specficiation.\r
 \r
@@ -620,11 +605,11 @@ EFI_STATUS
 \r
 **/\r
 typedef struct {\r
-  EFI_FVB_ATTRIBUTES  FvAttributes;\r
-  EFI_GUID            FvFormat;\r
-  EFI_GUID            FvName;\r
-  VOID                *FvStart;\r
-  UINT64              FvSize;\r
+  EFI_FVB_ATTRIBUTES_2  FvAttributes;\r
+  EFI_GUID              FvFormat;\r
+  EFI_GUID              FvName;\r
+  VOID                  *FvStart;\r
+  UINT64                FvSize;\r
 } EFI_FV_INFO;\r
 \r
 /**\r
@@ -639,10 +624,8 @@ typedef struct {
                         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
@@ -668,14 +651,12 @@ EFI_STATUS
   @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_SUCCESS           The PEIM was successfully registered for\r
+                                shadowing.\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
 **/\r
 typedef\r