MdePkg: Clean up source files

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

diff --git a/MdePkg/Library/UefiSalLib/UefiSalLib.c b/MdePkg/Library/UefiSalLib/UefiSalLib.c
index e41cc0d980cb2458b12d11aece7b0eb9f87f695c..3cfc89fc5258e32deaeaf1a85cddf5659ffa6386 100644 (file)
--- a/MdePkg/Library/UefiSalLib/UefiSalLib.c
+++ b/MdePkg/Library/UefiSalLib/UefiSalLib.c
@@ -1,13 +1,14 @@
 /** @file\r
-  SAL Library implementation built upon UEFI.\r
+  SAL Library implementation retrieving the SAL Entry Point from the SAL System Table\r
+  register in the EFI System Configuration Table.\r
 \r
-  Copyright (c) 2007 - 2008, Intel Corporation All rights\r
-  reserved. This program and the accompanying materials are\r
+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are\r
   licensed and made available under the terms and conditions of\r
   the BSD License which accompanies this distribution.  The full\r
   text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-  \r
+  http://opensource.org/licenses/bsd-license.php.\r
+\r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
@@ -39,14 +40,14 @@ SAL_PROC         mSalProcEntry;
   or undefined result may occur during the execution of the procedure.\r
   This function is only available on IPF.\r
 \r
-  @param  Index       The SAL procedure Index number\r
-  @param  Arg2        The 2nd parameter for SAL procedure calls\r
-  @param  Arg3        The 3rd parameter for SAL procedure calls\r
-  @param  Arg4        The 4th parameter for SAL procedure calls\r
-  @param  Arg5        The 5th parameter for SAL procedure calls\r
-  @param  Arg6        The 6th parameter for SAL procedure calls\r
-  @param  Arg7        The 7th parameter for SAL procedure calls\r
-  @param  Arg8        The 8th parameter for SAL procedure calls\r
+  @param  Index       The SAL procedure Index number.\r
+  @param  Arg2        The 2nd parameter for SAL procedure calls.\r
+  @param  Arg3        The 3rd parameter for SAL procedure calls.\r
+  @param  Arg4        The 4th parameter for SAL procedure calls.\r
+  @param  Arg5        The 5th parameter for SAL procedure calls.\r
+  @param  Arg6        The 6th parameter for SAL procedure calls.\r
+  @param  Arg7        The 7th parameter for SAL procedure calls.\r
+  @param  Arg8        The 8th parameter for SAL procedure calls.\r
 \r
   @return SAL returned registers.\r
 \r
@@ -85,7 +86,7 @@ SalCall (
 \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 SAL 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
@@ -110,13 +111,13 @@ UefiSalLibConstructor (
              &gEfiSalSystemTableGuid,\r
              (VOID **) &SalSystemTable\r
              );\r
-\r
   ASSERT_EFI_ERROR (Status);\r
+  ASSERT (SalSystemTable != NULL);\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
@@ -128,7 +129,7 @@ UefiSalLibConstructor (
   mPlabel.EntryPoint = SalStEntryDes->SalProcEntry;\r
   mPlabel.GP = SalStEntryDes->SalGlobalDataPointer;\r
   //\r
-  // Make sure the EntryPoint has the real value\r
+  // Make sure the EntryPoint has the valid value\r
   //\r
   ASSERT ((mPlabel.EntryPoint != 0) && (mPlabel.GP != 0));\r
 \r