Synchronize function comment in h file

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

/** @file\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
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
     \r
**/\r
\r
#include <Base.h>\r
#include <Library/PalLib.h>\r
#include <Library/DebugLib.h>\r
\r
/**\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
\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
  PAL_CALL_RETURN Ret;\r
\r
  Ret.Status = (UINT64) -1;\r
  ASSERT (!RETURN_ERROR (RETURN_UNSUPPORTED));\r
  return Ret;\r
}\r