MdePkg/Include/Library/PalCallLib.h

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