4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PAL Library Class implementation built upon Extended SAL Procedures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <PiDxe.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/ExtendedSalServiceClasses.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PalLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/ExtendedSalLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Makes a PAL procedure call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a wrapper function to make a PAL procedure call. Based on the Index value,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this API will make static or stacked PAL call. Architected procedures may be designated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as required or optional. If a PAL procedure is specified as optional, a unique return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This indicates that the procedure is not present in this PAL implementation. It is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller's responsibility to check for this return code after calling any optional PAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync procedure. No parameter checking is performed on the 4 input parameters, but there are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync some common rules that the caller should follow when making a PAL call. Any address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync passed to PAL as buffers for return parameters must be 8-byte aligned. Unaligned addresses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may cause undefined results. For those parameters defined as reserved or some fields
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined as reserved must be zero filled or the invalid argument return value may be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned or undefined result may occur during the execution of the procedure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is only available on IPF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Index - The PAL procedure Index number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Arg2 - The 2nd parameter for PAL procedure calls.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Arg3 - The 3rd parameter for PAL procedure calls.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Arg4 - The 4th parameter for PAL procedure calls.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return structure returned from the PAL Call procedure, including the status and return value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPAL_CALL_RETURN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPalCall (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Index,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Arg2,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Arg3,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINT64 Arg4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SAL_RETURN_REGS SalReturn;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PAL_CALL_RETURN *PalReturn;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SalReturn = EsalCall (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_EXTENDED_SAL_PAL_SERVICES_PROTOCOL_GUID_LO,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_EXTENDED_SAL_PAL_SERVICES_PROTOCOL_GUID_HI,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PalProcFunctionId,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Index,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Arg2,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Arg3,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Arg4,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PalReturn = (PAL_CALL_RETURN *) (UINTN) (&SalReturn);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return *PalReturn;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}