MdePkg/Include/Library/PalLib.h

   1 /** @file
   2   Provides library services to make PAL Calls.
   3
   4   The PAL Library provides a service to make a PAL CALL.  This service is identical
   5   in functionality to AsmPalCall() in the Itanium specific functions of the Base Library.
   6   The only difference is that the  PAL Entry Point is not passed in.  Implementations
   7   of this library class must manage PAL Entry Point on their own.  For example, a PEI
   8   implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation
   9   can contain a constructor to look up the PAL Entry Point from a HOB.  This library class
  10   is only available on IPF.
  11
  12 Copyright (c) 2006 -2008, Intel Corporation All rights
  13 reserved. This program and the accompanying materials are
  14 licensed and made available under the terms and conditions of
  15 the BSD License which accompanies this distribution.  The full
  16 text of the license may be found at
  17 http://opensource.org/licenses/bsd-license.php
  18
  19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  21
  22 **/
  23
  24 #ifndef __PAL_CALL_LIB_H__
  25 #define __PAL_CALL_LIB_H__
  26
  27 #include <IndustryStandard/Pal.h>
  28
  29 /**
  30   Makes a PAL procedure call.
  31
  32   This is a wrapper function to make a PAL procedure call.  Based on the Index value,
  33   this API will make static or stacked PAL call. Architected procedures may be designated
  34   as required or optional.  If a PAL procedure is specified as optional, a unique return
  35   code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.
  36   This indicates that the procedure is not present in this PAL implementation.  It is the
  37   caller's responsibility to check for this return code after calling any optional PAL
  38   procedure. No parameter checking is performed on the 4 input parameters, but there are
  39   some common rules that the caller should follow when making a PAL call.  Any address
  40   passed to PAL as buffers for return parameters must be 8-byte aligned.  Unaligned addresses
  41   may cause undefined results.  For those parameters defined as reserved or some fields
  42   defined as reserved must be zero filled or the invalid argument return value may be
  43   returned or undefined result may occur during the execution of the procedure.
  44   This function is only available on IPF.
  45
  46   @param Index  The PAL procedure Index number.
  47   @param Arg2   The 2nd parameter for PAL procedure calls.
  48   @param Arg3   The 3rd parameter for PAL procedure calls.
  49   @param Arg4   The 4th parameter for PAL procedure calls.
  50
  51   @return Structure returned from the PAL Call procedure, including the status and return value.
  52
  53 **/
  54 PAL_CALL_RETURN
  55 EFIAPI
  56 PalCall (
  57   IN UINT64                  Index,
  58   IN UINT64                  Arg2,
  59   IN UINT64                  Arg3,
  60   IN UINT64                  Arg4
  61   );
  62
  63 #endif
  64