From 54e27ada3e63b559e2e18c44d3cb8c69a5f5a561 Mon Sep 17 00:00:00 2001
From: jyao1 <jyao1@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Thu, 16 Aug 2012 03:39:10 +0000
Subject: Add missing function comments

signed-off-by: jiewen.yao@intel.com
reviewed-by: eric.dong@intel.com

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13639 6f19259b-4bc3-4df7-8a09-765794883524
---
 .../Acpi/BootScriptExecutorDxe/X64/SetIdtEntry.c   | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'MdeModulePkg')

diff --git a/MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/X64/SetIdtEntry.c b/MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/X64/SetIdtEntry.c
index db11697e7c..8c34993587 100644
--- a/MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/X64/SetIdtEntry.c
+++ b/MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/X64/SetIdtEntry.c
@@ -43,12 +43,22 @@ BOOLEAN                            mPage1GSupport;
 VOID                               *mOriginalHandler;
 UINTN                              mS3NvsPageTableAddress;
 
+/**
+  Page fault handler.
+
+**/
 VOID
 EFIAPI
 PageFaultHandlerHook (
   VOID
   );
 
+/**
+  Hook IDT with our page fault handler so that the on-demand paging works on page fault.
+
+  @param  IdtEntry  a pointer to IDT entry
+
+**/
 VOID
 HookPageFaultHandler (
   IN INTERRUPT_GATE_DESCRIPTOR                     *IdtEntry
@@ -135,6 +145,13 @@ SetIdtEntry (
   AsmWriteIdtr (IdtDescriptor);
 }
 
+/**
+  Get new page address.
+
+  @param  PageNum  new page number needed
+
+  @return new page address
+**/
 UINTN
 GetNewPage (
   IN UINTN  PageNum
@@ -147,6 +164,13 @@ GetNewPage (
   return NewPage;
 }
 
+/**
+  The page fault handler that on-demand read >4G memory/MMIO.
+  
+  @retval TRUE     The page fault is correctly handled.
+  @retval FALSE    The page fault is not handled and is passed through to original handler.
+
+**/
 BOOLEAN
 EFIAPI
 PageFaultHandler (
-- 
cgit v1.2.3