MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Library / BasePalLibNull / PalCall.c

diff --git a/MdePkg/Library/BasePalLibNull/PalCall.c b/MdePkg/Library/BasePalLibNull/PalCall.c
index 82db43cf65f7a3b8de11a1c68a0015c817b6214d..d28bb838a3691e4e44e4cac386f5fc06fb69a62d 100644 (file)
--- a/MdePkg/Library/BasePalLibNull/PalCall.c
+++ b/MdePkg/Library/BasePalLibNull/PalCall.c
@@ -1,16 +1,16 @@
 /** @file\r
-  \r
+\r
   Template and Sample instance of PalCallLib.\r
-  \r
-  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\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
+\r
 **/\r
 \r
 #include <Base.h>\r
@@ -20,16 +20,26 @@
 /**\r
   Makes a PAL procedure call.\r
 \r
-  This is a wrapper function to make a PAL procedure call.\r
-  This is just a template as simple instance. It does not\r
-  make real PAL call. It directly reports error if called.\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
-\r
-  @return Structure returned from the PAL Call procedure, including the status and return value.\r
+  This is a wrapper function to make a PAL procedure call.  Based on the Index value,\r
+  this API will make static or stacked PAL call. Architected procedures may be designated\r
+  as required or optional.  If a PAL procedure is specified as optional, a unique return\r
+  code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.\r
+  This indicates that the procedure is not present in this PAL implementation.  It is the\r
+  caller's responsibility to check for this return code after calling any optional PAL\r
+  procedure. No parameter checking is performed on the 4 input parameters, but there are\r
+  some common rules that the caller should follow when making a PAL call.  Any address\r
+  passed to PAL as buffers for return parameters must be 8-byte aligned.  Unaligned addresses\r
+  may cause undefined results.  For those parameters defined as reserved or some fields\r
+  defined as reserved must be zero filled or the invalid argument return value may be\r
+  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
+\r
+  @return The structure returned from the PAL Call procedure, including the status and return value.\r
 \r
 **/\r
 PAL_CALL_RETURN\r