Remove the package header files PiDxe.h/PiPei.h/Uefi.h included by Protocol/Ppi/Guid...

[mirror_edk2.git] / MdePkg / Include / Ppi / DxeIpl.h

diff --git a/MdePkg/Include/Ppi/DxeIpl.h b/MdePkg/Include/Ppi/DxeIpl.h
index 29c4df51b9d829d7dda5b6c8d706819d4b9c5541..1ea629a0119eadacb1be3d41cb73b6d0a33355ea 100644 (file)
--- 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 \r
   there are no additional PEIMs to invoke.\r
 \r
+  This function is invoked by the PEI Foundation.\r
+  The PEI Foundation will invoke this service when there are\r
+  no additional PEIMs to invoke in the system.\r
+  If this PPI does not exist, it is an error condition and\r
+  an ill-formed firmware set. The DXE IPL PPI should never\r
+  return after having been invoked by the PEI Foundation.\r
+  The DXE IPL PPI can do many things internally, including the following:\r
+    - Invoke the DXE entry point from a firmware volume\r
+    - Invoke the recovery processing modules\r
+    - Invoke the S3 resume modules\r
+\r
   @param  This           Pointer to the DXE IPL PPI instance\r
   @param  PeiServices    Pointer to the PEI Services Table.\r
   @param  HobList        Pointer to the list of Hand-Off Block (HOB) entries.\r
@@ -43,22 +54,20 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_DXE_IPL_ENTRY)(\r
-  IN EFI_DXE_IPL_PPI              *This,\r
+  IN CONST EFI_DXE_IPL_PPI        *This,\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_HOB_POINTERS         HobList\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  Final service to be invoked by the PEI Foundation.\r
-  The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
-  The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
-\r
-  @param Entry\r
-  The entry point to the DXE IPL PPI.\r
-\r
-**/\r
+///\r
+/// Final service to be invoked by the PEI Foundation.\r
+/// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
+/// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
+///\r
 struct _EFI_DXE_IPL_PPI {\r
+  ///\r
+  /// The entry point to the DXE IPL PPI.\r
+  ///\r
   EFI_DXE_IPL_ENTRY Entry;\r
 };\r
 \r