Remove msa file and add more comments for DXE core entry

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

diff --git a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
index 34e84614767e8e5e4c313f14723a8af3008c0a98..d9c93bdf761fde9934f39397991f799a5b547c7a 100644 (file)
--- a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
+++ b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
@@ -12,10 +12,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+\r
+#include <PiDxe.h>\r
+\r
+\r
+#include <Library/DxeCoreEntryPoint.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseLib.h>\r
 \r
 //\r
 // Cache copy of HobList pointer. \r
@@ -25,6 +28,22 @@ VOID *gHobList = NULL;
 /**\r
   Enrty point to DXE core.\r
 \r
+  This function is the entry point to the DXE Foundation. The PEI phase, which executes just before\r
+  DXE, is responsible for loading and invoking the DXE Foundation in system memory. The only\r
+  parameter that is passed to the DXE Foundation is HobStart. This parameter is a pointer to the\r
+  HOB list that describes the system state at the hand-off to the DXE Foundation. At a minimum,\r
+  this system state must include the following:\r
+    - PHIT HOB\r
+    - CPU HOB\r
+    - Description of system memory\r
+    - Description of one or more firmware volumes\r
+  The DXE Foundation is also guaranteed that only one processor is running and that the processor is\r
+  running with interrupts disabled. The implementation of the DXE Foundation must not make any\r
+  assumptions about where the DXE Foundation will be loaded or where the stack is located. In\r
+  general, the DXE Foundation should make as few assumptions about the state of the system as\r
+  possible. This lack of assumptions will allow the DXE Foundation to be portable to the widest\r
+  variety of system architectures.\r
+  \r
   @param  HobStart Pointer of HobList.\r
 \r
 **/\r