Add doxygen style comments for functions in DxeIpl.

[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / Ia32 / VirtualMemory.h

diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h
index 9e824ed28084a218959dadc60d04dc10198e6b06..5bb3e43786243ee3f45c59b62074f46b82ca2b11 100644 (file)
--- a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h
+++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.h
@@ -99,6 +99,20 @@ typedef union {
 \r
 #pragma pack()\r
 \r
+\r
+\r
+/**\r
+  Allocates and fills in the Page Directory and Page Table Entries to\r
+  establish a 1:1 Virtual to Physical mapping.\r
+\r
+  @param  NumberOfProcessorPhysicalAddressBits  Number of processor address bits \r
+                                                to use. Limits the number of page \r
+                                                table entries  to the physical \r
+                                                address space. \r
+\r
+  @return EFI_SUCCESS           The 1:1 Virtual to Physical identity mapping was created\r
+\r
+**/\r
 UINTN\r
 CreateIdentityMappingPageTables (\r
   VOID\r
@@ -106,6 +120,9 @@ CreateIdentityMappingPageTables (
 ;\r
 \r
 \r
+\r
+\r
+\r
 /**\r
  \r
   Fix up the vector number in the vector code.\r
@@ -113,7 +130,7 @@ CreateIdentityMappingPageTables (
   @param VectorBase   Base address of the vector handler.\r
  \r
   @param VectorNum    Index of vector.\r
- \r
+\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -123,6 +140,9 @@ AsmVectorFixup (
   );\r
 \r
 \r
+\r
+\r
+\r
 /**\r
  \r
   Get the information of vector template.\r
@@ -130,7 +150,7 @@ AsmVectorFixup (
   @param TemplateBase   Base address of the template code.\r
  \r
   @return               Size of the Template code.\r
- \r
+\r
 **/\r
 UINTN\r
 EFIAPI\r