mirror of https://github.com/acidanthera/audk.git
58 lines
2.5 KiB
C
58 lines
2.5 KiB
C
/** @file
|
|
Provides library services to make PAL Calls.
|
|
|
|
The PAL Library provides a service to make a PAL CALL. This service is identical
|
|
in functionality to AsmPalCall() in the functions of the Base Library specific to Intel Itanium architecture.
|
|
The only difference is that the PAL Entry Point is not passed in. Implementations
|
|
of this library class must manage PAL Entry Point on their own. For example, a PEI
|
|
implementation can use a PPI to lookup the PAL Entry Point, and a DXE implementation
|
|
can contain a constructor to look up the PAL Entry Point from a HOB. This library class
|
|
is only available on Intel Itanium-based platforms.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __PAL_CALL_LIB_H__
|
|
#define __PAL_CALL_LIB_H__
|
|
|
|
#include <IndustryStandard/Pal.h>
|
|
|
|
/**
|
|
Makes a PAL procedure call.
|
|
|
|
This is a wrapper function to make a PAL procedure call. Based on the Index value,
|
|
this API will make static or stacked PAL call. Architected procedures may be designated
|
|
as required or optional. If a PAL procedure is specified as optional, a unique return
|
|
code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.
|
|
This indicates that the procedure is not present in this PAL implementation. It is the
|
|
caller's responsibility to check for this return code after calling any optional PAL
|
|
procedure. No parameter checking is performed on the 4 input parameters, but there are
|
|
some common rules that the caller should follow when making a PAL call. Any address
|
|
passed to PAL as buffers for return parameters must be 8-byte aligned. Unaligned addresses
|
|
may cause undefined results. For those parameters defined as reserved or some fields
|
|
defined as reserved must be zero filled or the invalid argument return value may be
|
|
returned or undefined result may occur during the execution of the procedure.
|
|
This function is only available on Intel Itanium-based platforms.
|
|
|
|
@param Index The PAL procedure Index number.
|
|
@param Arg2 The 2nd parameter for PAL procedure calls.
|
|
@param Arg3 The 3rd parameter for PAL procedure calls.
|
|
@param Arg4 The 4th parameter for PAL procedure calls.
|
|
|
|
@return Structure returned from the PAL Call procedure, including the status and return value.
|
|
|
|
**/
|
|
PAL_CALL_RETURN
|
|
EFIAPI
|
|
PalCall (
|
|
IN UINT64 Index,
|
|
IN UINT64 Arg2,
|
|
IN UINT64 Arg3,
|
|
IN UINT64 Arg4
|
|
);
|
|
|
|
#endif
|
|
|