1 /** @file 2 Provides library services to make PAL Calls. 3 4 The PAL Library provides a service to make a PAL CALL. This service is identical 5 in functionality to AsmPalCall() in the functions of the Base Library specific to Intel Itanium architecture. 6 The only difference is that the PAL Entry Point is not passed in. Implementations 7 of this library class must manage PAL Entry Point on their own. For example, a PEI 8 implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation 9 can contain a constructor to look up the PAL Entry Point from a HOB. This library class 10 is only available on Intel Itanium-based platforms. 11 12 Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> 13 This program and the accompanying materials 14 are licensed and made available under the terms and conditions of the BSD License 15 which accompanies this distribution. The full text of the license may be found at 16 http://opensource.org/licenses/bsd-license.php 17 18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 20 21 **/ 22 23 #ifndef __PAL_CALL_LIB_H__ 24 #define __PAL_CALL_LIB_H__ 25 26 #include <IndustryStandard/Pal.h> 27 28 /** 29 Makes a PAL procedure call. 30 31 This is a wrapper function to make a PAL procedure call. Based on the Index value, 32 this API will make static or stacked PAL call. Architected procedures may be designated 33 as required or optional. If a PAL procedure is specified as optional, a unique return 34 code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure. 35 This indicates that the procedure is not present in this PAL implementation. It is the 36 caller's responsibility to check for this return code after calling any optional PAL 37 procedure. No parameter checking is performed on the 4 input parameters, but there are 38 some common rules that the caller should follow when making a PAL call. Any address 39 passed to PAL as buffers for return parameters must be 8-byte aligned. Unaligned addresses 40 may cause undefined results. For those parameters defined as reserved or some fields 41 defined as reserved must be zero filled or the invalid argument return value may be 42 returned or undefined result may occur during the execution of the procedure. 43 This function is only available on Intel Itanium-based platforms. 44 45 @param Index The PAL procedure Index number. 46 @param Arg2 The 2nd parameter for PAL procedure calls. 47 @param Arg3 The 3rd parameter for PAL procedure calls. 48 @param Arg4 The 4th parameter for PAL procedure calls. 49 50 @return Structure returned from the PAL Call procedure, including the status and return value. 51 52 **/ 53 PAL_CALL_RETURN 54 EFIAPI 55 PalCall ( 56 IN UINT64 Index, 57 IN UINT64 Arg2, 58 IN UINT64 Arg3, 59 IN UINT64 Arg4 60 ); 61 62 #endif 63 64
