Check in library class of SalLib.
[people/mcb30/edk2.git] / edk2 / MdePkg / Include / Library / SalLib.h
1 /** @file\r
2   SAL Library Functions\r
3 \r
4   Copyright (c) 2007, Intel Corporation\r
5   All rights reserved. This program and the accompanying materials\r
6   are licensed and made available under the terms and conditions of the BSD License\r
7   which accompanies this distribution.  The full text of the license may be found at\r
8   http://opensource.org/licenses/bsd-license.php\r
9 \r
10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 \r
13   Module Name:  SalLib.h\r
14 \r
15 **/\r
16 \r
17 #ifndef __SAL_LIB__\r
18 #define __SAL_LIB__\r
19 \r
20 #include <IndustryStandard/Sal.h>\r
21 \r
22 /**\r
23   Makes a SAL procedure call.\r
24   \r
25   This is a wrapper function to make a SAL procedure call.  \r
26   No parameter checking is performed on the 8 input parameters,\r
27   but there are some common rules that the caller should follow\r
28   when making a SAL call.  Any address passed to SAL as buffers\r
29   for return parameters must be 8-byte aligned.  Unaligned\r
30   addresses may cause undefined results.  For those parameters\r
31   defined as reserved or some fields defined as reserved must be\r
32   zero filled or the invalid argument return value may be returned\r
33   or undefined result may occur during the execution of the procedure.\r
34   This function is only available on IPF.\r
35 \r
36   @param  Index       The SAL procedure Index number\r
37   @param  Arg2        The 2nd parameter for SAL procedure calls\r
38   @param  Arg3        The 3rd parameter for SAL procedure calls\r
39   @param  Arg4        The 4th parameter for SAL procedure calls\r
40   @param  Arg5        The 5th parameter for SAL procedure calls\r
41   @param  Arg6        The 6th parameter for SAL procedure calls\r
42   @param  Arg7        The 7th parameter for SAL procedure calls\r
43   @param  Arg8        The 8th parameter for SAL procedure calls\r
44 \r
45   @return SAL returned registers.\r
46 \r
47 **/\r
48 SAL_RETURN_REGS\r
49 EFIAPI\r
50 SalCall (\r
51   IN UINT64  Index,\r
52   IN UINT64  Arg2,\r
53   IN UINT64  Arg3,\r
54   IN UINT64  Arg4,\r
55   IN UINT64  Arg5,\r
56   IN UINT64  Arg6,\r
57   IN UINT64  Arg7,\r
58   IN UINT64  Arg8\r
59   );\r
60 \r
61 #endif\r