Refine code for BasePalCallLibNull & PeiPalCallLib.
authorxli24 <xli24@de2fecce-e211-0410-80a6-f3fac2684e05>
Wed, 16 Jul 2008 14:36:38 +0000 (14:36 +0000)
committerxli24 <xli24@de2fecce-e211-0410-80a6-f3fac2684e05>
Wed, 16 Jul 2008 14:36:38 +0000 (14:36 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5506 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdePkg/Library/BasePalCallLibNull/PalCall.c
edk2/MdePkg/Library/PeiPalCallLib/PalCallLib.c

index 74c3306..3772f70 100644 (file)
@@ -2,7 +2,7 @@
   \r
   Template and Sample instance of PalCallLib.\r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\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
 /**\r
   Makes a PAL procedure call.\r
 \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 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.\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
 \r
 **/\r
 PAL_CALL_RETURN\r
index b1a9b10..aa423c9 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   PAL Call Services Function.\r
 \r
-  Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
+  Copyright (c) 2006 - 2008 Intel Corporation. All rights reserved\r
   This software and associated documentation (if any) is furnished\r
   under a license and may only be used or copied in accordance\r
   with the terms of the license. Except as permitted by such\r
@@ -26,8 +26,8 @@
 #include <Library/DebugLib.h>\r
 \r
 /**\r
-\r
   Makes a PAL procedure call.\r
+\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
   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
@@ -68,28 +68,30 @@ PalCall (
   UINT64                            RecordSize;\r
 \r
   //\r
-  // Get Pei Service Table Pointer\r
+  // Get PEI Service Table Pointer\r
   //\r
   PeiServices = (CONST EFI_PEI_SERVICES **) GetPeiServicesTablePointer ();\r
 \r
   //\r
-  // Locate SEC Ppi\r
+  // Locate SEC Platform Information PPI\r
   //\r
-\r
   Status = PeiServicesLocatePpi (\r
-                             &gEfiSecPlatformInformationPpiGuid,\r
-                             0,\r
-                             NULL,\r
-                             (VOID **)&SecPlatformPpi\r
-                             );\r
+             &gEfiSecPlatformInformationPpiGuid,\r
+             0,\r
+             NULL,\r
+             (VOID **)&SecPlatformPpi\r
+             );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  //\r
+  // Retrieve PAL call address from platform information reported by the PPI\r
+  //\r
   RecordSize = sizeof (IpfStatus);\r
   SecPlatformPpi->PlatformInformation (\r
-                        PeiServices,\r
-                        &RecordSize,\r
-                        (EFI_SEC_PLATFORM_INFORMATION_RECORD *) &IpfStatus\r
-                        );\r
+                    PeiServices,\r
+                    &RecordSize,\r
+                    (EFI_SEC_PLATFORM_INFORMATION_RECORD *) &IpfStatus\r
+                    );\r
   PalCallAddress = IpfStatus.PalCallAddress;\r
 \r
   ReturnVal = AsmPalCall (PalCallAddress, Index, Arg2, Arg3, Arg4);\r