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