MdePkg/Library/UefiPalLib/UefiPalLib.c File Reference


Functions

PAL_CALL_RETURN EFIAPI PalCall (IN UINT64 Index, IN UINT64 Arg2, IN UINT64 Arg3, IN UINT64 Arg4)
EFI_STATUS EFIAPI UefiPalLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables

UINT64 mPalProcEntry

Detailed Description

PAL Library implementation retrieving the PAL Entry Point from the SAL System Table register in the EFI System Confguration Table.

Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

PAL_CALL_RETURN EFIAPI PalCall ( IN UINT64  Index,
IN UINT64  Arg2,
IN UINT64  Arg3,
IN UINT64  Arg4 
)

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 IPF.

Parameters:
Index The PAL procedure Index number.
Arg2 The 2nd parameter for PAL procedure calls.
Arg3 The 3rd parameter for PAL procedure calls.
Arg4 The 4th parameter for PAL procedure calls.
Returns:
Structure returned from the PAL Call procedure, including the status and return value.

References AsmPalCall(), and mPalProcEntry.

Referenced by CpuSleep(), GetPerformanceCounterProperties(), InvalidateInstructionCache(), WriteBackDataCache(), and WriteBackInvalidateDataCache().

EFI_STATUS EFIAPI UefiPalLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

The constructor function of UEFI Pal Lib.

The constructor function looks up the SAL System Table in the EFI System Configuration Table. Once the SAL System Table is found, the PAL Entry Point in the SAL System Table will be derived and stored into a global variable for library usage. It will ASSERT() if the SAL System Table cannot be found or the data in the SAL System Table is not the valid data.

Parameters:
ImageHandle The firmware allocated handle for the EFI image.
SystemTable A pointer to the EFI System Table.
Return values:
EFI_SUCCESS The constructor always returns EFI_SUCCESS.

References ASSERT, ASSERT_EFI_ERROR, EFI_SAL_ST_ENTRY_POINT, EFI_SUCCESS, EfiGetSystemConfigurationTable(), gEfiSalSystemTableGuid, mPalProcEntry, NULL, SAL_ST_ENTRY_POINT_DESCRIPTOR::PalProcEntry, SAL_ST_ENTRY_POINT_DESCRIPTOR::Type, and VOID.


Variable Documentation

Referenced by PalCall(), and UefiPalLibConstructor().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1