Update MdePkg/Include/Ppi according to code review comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 20 insertions, 11 deletions

diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h
index 29c4df51b9..1ea629a011 100644
--- a/MdePkg/Include/Ppi/DxeIpl.h
+++ b/MdePkg/Include/Ppi/DxeIpl.h
@@ -31,6 +31,17 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
   The architectural PPI that the PEI Foundation invokes when 

   there are no additional PEIMs to invoke.

 

+  This function is invoked by the PEI Foundation.

+  The PEI Foundation will invoke this service when there are

+  no additional PEIMs to invoke in the system.

+  If this PPI does not exist, it is an error condition and

+  an ill-formed firmware set. The DXE IPL PPI should never

+  return after having been invoked by the PEI Foundation.

+  The DXE IPL PPI can do many things internally, including the following:

+    - Invoke the DXE entry point from a firmware volume

+    - Invoke the recovery processing modules

+    - Invoke the S3 resume modules

+

   @param  This           Pointer to the DXE IPL PPI instance

   @param  PeiServices    Pointer to the PEI Services Table.

   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.

@@ -43,22 +54,20 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
 typedef

 EFI_STATUS

 (EFIAPI *EFI_DXE_IPL_ENTRY)(

-  IN EFI_DXE_IPL_PPI              *This,

+  IN CONST EFI_DXE_IPL_PPI        *This,

   IN EFI_PEI_SERVICES             **PeiServices,

   IN EFI_PEI_HOB_POINTERS         HobList

   );

 

-/**

-  @par Ppi Description:

-  Final service to be invoked by the PEI Foundation.

-  The DXE IPL PPI is responsible for locating and loading the DXE Foundation.

-  The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.

-

-  @param Entry

-  The entry point to the DXE IPL PPI.

-

-**/

+///

+/// Final service to be invoked by the PEI Foundation.

+/// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.

+/// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.

+///

 struct _EFI_DXE_IPL_PPI {

+  ///

+  /// The entry point to the DXE IPL PPI.

+  ///

   EFI_DXE_IPL_ENTRY Entry;

 };