Refine new library instances according to review comments.

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

diff --git a/MdePkg/Library/UefiPalLib/UefiPalLib.c b/MdePkg/Library/UefiPalLib/UefiPalLib.c
index e2550387bab706404514f2e4fbeb81a5149fe23d..f646fd40f849d0a32bc3b48a57abbe84aa19a355 100644 (file)
--- a/MdePkg/Library/UefiPalLib/UefiPalLib.c
+++ b/MdePkg/Library/UefiPalLib/UefiPalLib.c
@@ -1,5 +1,6 @@
 /** @file\r
-  PAL Library implementation built upon UEFI.\r
+  PAL Library implementation retrieving the PAL Entry Point from the SAL System Table\r
+  register in the EFI System Confguration Table.\r
 \r
   Copyright (c) 2007 - 2008, Intel Corporation All rights\r
   reserved. This program and the accompanying materials are\r
@@ -41,12 +42,12 @@ UINT64               mPalProcEntry;
   returned or undefined result may occur during the execution of the procedure.\r
   This function is only available on IPF.\r
 \r
-  @param Index - The PAL procedure Index number.\r
-  @param Arg2  - The 2nd parameter for PAL procedure calls.\r
-  @param Arg3  - The 3rd parameter for PAL procedure calls.\r
-  @param Arg4  - The 4th parameter for PAL procedure calls.\r
+  @param  Index  The PAL procedure Index number.\r
+  @param  Arg2   The 2nd parameter for PAL procedure calls.\r
+  @param  Arg3   The 3rd parameter for PAL procedure calls.\r
+  @param  Arg4   The 4th parameter for PAL procedure calls.\r
 \r
-  @return structure returned from the PAL Call procedure, including the status and return value.\r
+  @return Structure returned from the PAL Call procedure, including the status and return value.\r
 \r
 **/\r
 PAL_CALL_RETURN\r
@@ -76,7 +77,7 @@ PalCall (
 \r
   The constructor function looks up the SAL System Table in the EFI System Configuration\r
   Table. Once the SAL System Table is found, the PAL Entry Point in the SAL System Table\r
-  will be derived and stored inot a global variable for library usage.\r
+  will be derived and stored into a global variable for library usage.\r
   It will ASSERT() if the SAL System Table cannot be found or the data in the SAL System\r
   Table is not the valid data.\r
 \r
@@ -105,9 +106,9 @@ UefiPalLibConstructor (
   ASSERT_EFI_ERROR (Status);\r
 \r
   //\r
-  // Move the SAL System Table point to the first Entry\r
-  // Due to the SAL Entry is in ascending order with the Entry type,\r
-  // the type 0 Entry should be the first if exist.\r
+  // Check the first entry of SAL System Table,\r
+  // because the SAL entry is in ascending order with the entry type,\r
+  // the type 0 entry should be the first if exist.\r
   //\r
   SalStEntryDes = (SAL_ST_ENTRY_POINT_DESCRIPTOR *)(SalSystemTable + 1);\r
 \r