Minor grammatical work--mostly adding periods. Items with ONLY period added did...

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

/** @file\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 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
  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
#include <PiDxe.h>\r
\r
#include <IndustryStandard/Sal.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include <Guid/SalSystemTable.h>\r
\r
UINT64               mPalProcEntry;\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
  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
\r
**/\r
PAL_CALL_RETURN\r
EFIAPI\r
PalCall (\r
  IN UINT64                  Index,\r
  IN UINT64                  Arg2,\r
  IN UINT64                  Arg3,\r
  IN UINT64                  Arg4\r
  )\r
{\r
  //\r
  // mPalProcEntry is initialized in library constructor as PAL entry.\r
  //\r
  return AsmPalCall (\r
           mPalProcEntry,\r
           Index,\r
           Arg2,\r
           Arg3,\r
           Arg4\r
           );\r
\r
}\r
\r
/**\r
  The constructor function of UEFI Pal Lib.\r
\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 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
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
UefiPalLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  SAL_ST_ENTRY_POINT_DESCRIPTOR  *SalStEntryDes;\r
  SAL_SYSTEM_TABLE_HEADER        *SalSystemTable;\r
\r
  Status = EfiGetSystemConfigurationTable (\r
             &gEfiSalSystemTableGuid,\r
             (VOID **) &SalSystemTable\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
  ASSERT (SalSystemTable != NULL);\r
\r
  //\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
  //\r
  // Assure the SAL ENTRY Type is 0\r
  //\r
  ASSERT (SalStEntryDes->Type == EFI_SAL_ST_ENTRY_POINT);\r
\r
  mPalProcEntry = SalStEntryDes->PalProcEntry;\r
  //\r
  // Make sure the PalCallAddress has the valid value\r
  //\r
  ASSERT (mPalProcEntry != 0);\r
\r
  return EFI_SUCCESS;\r
}\r