]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
50a64e5b | 2 | Provides library services to make PAL Calls.\r |
9095d37b | 3 | \r |
8789c5e0 | 4 | The PAL Library provides a service to make a PAL CALL. This service is identical\r |
1a2f870c | 5 | in functionality to AsmPalCall() in the functions of the Base Library specific to Intel Itanium architecture.\r |
6 | The only difference is that the PAL Entry Point is not passed in. Implementations\r | |
8789c5e0 | 7 | of this library class must manage PAL Entry Point on their own. For example, a PEI\r |
8 | implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation\r | |
9095d37b | 9 | can contain a constructor to look up the PAL Entry Point from a HOB. This library class\r |
1a2f870c | 10 | is only available on Intel Itanium-based platforms.\r |
9095d37b LG |
11 | \r |
12 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
9344f092 | 13 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
fb3df220 | 14 | \r |
fb3df220 | 15 | **/\r |
16 | \r | |
17 | #ifndef __PAL_CALL_LIB_H__\r | |
18 | #define __PAL_CALL_LIB_H__\r | |
19 | \r | |
a7b64584 | 20 | #include <IndustryStandard/Pal.h>\r |
9c2369c1 | 21 | \r |
fb3df220 | 22 | /**\r |
23 | Makes a PAL procedure call.\r | |
24 | \r | |
25 | This is a wrapper function to make a PAL procedure call. Based on the Index value,\r | |
26 | this API will make static or stacked PAL call. Architected procedures may be designated\r | |
27 | as required or optional. If a PAL procedure is specified as optional, a unique return\r | |
28 | code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.\r | |
29 | This indicates that the procedure is not present in this PAL implementation. It is the\r | |
ac644614 | 30 | caller's responsibility to check for this return code after calling any optional PAL\r |
fb3df220 | 31 | procedure. No parameter checking is performed on the 4 input parameters, but there are\r |
32 | some common rules that the caller should follow when making a PAL call. Any address\r | |
33 | passed to PAL as buffers for return parameters must be 8-byte aligned. Unaligned addresses\r | |
34 | may cause undefined results. For those parameters defined as reserved or some fields\r | |
35 | defined as reserved must be zero filled or the invalid argument return value may be\r | |
36 | returned or undefined result may occur during the execution of the procedure.\r | |
1a2f870c | 37 | This function is only available on Intel Itanium-based platforms.\r |
fb3df220 | 38 | \r |
e7b1b596 | 39 | @param Index The PAL procedure Index number.\r |
40 | @param Arg2 The 2nd parameter for PAL procedure calls.\r | |
41 | @param Arg3 The 3rd parameter for PAL procedure calls.\r | |
42 | @param Arg4 The 4th parameter for PAL procedure calls.\r | |
fb3df220 | 43 | \r |
98ea597b | 44 | @return Structure returned from the PAL Call procedure, including the status and return value.\r |
fb3df220 | 45 | \r |
46 | **/\r | |
47 | PAL_CALL_RETURN\r | |
48 | EFIAPI\r | |
49 | PalCall (\r | |
50 | IN UINT64 Index,\r | |
51 | IN UINT64 Arg2,\r | |
52 | IN UINT64 Arg3,\r | |
53 | IN UINT64 Arg4\r | |
54 | );\r | |
55 | \r | |
56 | #endif\r | |
57 | \r |