MdePkg/Include/Library/SalLib.h

   1 /** @file
   2   Provides library services to make SAL Calls.
   3
   4 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __SAL_LIB__
  10 #define __SAL_LIB__
  11
  12 #include <IndustryStandard/Sal.h>
  13
  14 /**
  15   Makes a SAL procedure call.
  16
  17   This is a wrapper function to make a SAL procedure call.
  18   No parameter checking is performed on the 8 input parameters,
  19   but there are some common rules that the caller should follow
  20   when making a SAL call.  Any address passed to SAL as buffers
  21   for return parameters must be 8-byte aligned.  Unaligned
  22   addresses may cause undefined results.  For those parameters
  23   defined as reserved or some fields defined as reserved must be
  24   zero filled or the invalid argument return value may be returned
  25   or undefined result may occur during the execution of the procedure.
  26   This function is only available on Intel Itanium-based platforms.
  27
  28   @param  Index       The SAL procedure Index number
  29   @param  Arg2        The 2nd parameter for SAL procedure calls
  30   @param  Arg3        The 3rd parameter for SAL procedure calls
  31   @param  Arg4        The 4th parameter for SAL procedure calls
  32   @param  Arg5        The 5th parameter for SAL procedure calls
  33   @param  Arg6        The 6th parameter for SAL procedure calls
  34   @param  Arg7        The 7th parameter for SAL procedure calls
  35   @param  Arg8        The 8th parameter for SAL procedure calls
  36
  37   @return SAL returned registers.
  38
  39 **/
  40 SAL_RETURN_REGS
  41 EFIAPI
  42 SalCall (
  43   IN UINT64  Index,
  44   IN UINT64  Arg2,
  45   IN UINT64  Arg3,
  46   IN UINT64  Arg4,
  47   IN UINT64  Arg5,
  48   IN UINT64  Arg6,
  49   IN UINT64  Arg7,
  50   IN UINT64  Arg8
  51   );
  52
  53 #endif