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