ArmPlatformPkg[all]  0.1
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Pages
ArmPlatformLib.h File Reference

Functions

UINTN ArmPlatformGetCorePosition (IN UINTN MpId)
 
UINTN ArmPlatformIsPrimaryCore (IN UINTN MpId)
 
UINTN ArmPlatformGetPrimaryCoreMpId (VOID)
 
EFI_BOOT_MODE ArmPlatformGetBootMode (VOID)
 
VOID ArmPlatformPeiBootAction (VOID)
 
RETURN_STATUS ArmPlatformInitialize (IN UINTN MpId)
 
VOID ArmPlatformGetVirtualMemoryMap (OUT ARM_MEMORY_REGION_DESCRIPTOR **VirtualMemoryMap)
 
VOID ArmPlatformGetPlatformPpiList (OUT UINTN *PpiListSize, OUT EFI_PEI_PPI_DESCRIPTOR **PpiList)
 

Detailed Description

Copyright (c) 2011-2013, ARM Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

EFI_BOOT_MODE ArmPlatformGetBootMode ( VOID  )

Return the current Boot Mode

This function returns the boot reason on the platform

Returns
Return the current Boot Mode of the platform
UINTN ArmPlatformGetCorePosition ( IN UINTN  MpId)

Return the core position from the value of its MpId register

This function returns the core position from the position 0 in the processor. This function might be called from assembler before any stack is set.

Returns
Return the core position
VOID ArmPlatformGetPlatformPpiList ( OUT UINTN *  PpiListSize,
OUT EFI_PEI_PPI_DESCRIPTOR **  PpiList 
)

Return the Platform specific PPIs

This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed to the PeiCore by PrePeiCore.

Parameters
[out]PpiListSizeSize in Bytes of the Platform PPI List
[out]PpiListPlatform PPI List
UINTN ArmPlatformGetPrimaryCoreMpId ( VOID  )

Return the MpId of the primary core

This function returns the MpId of the primary core. This function might be called from assembler before any stack is set.

Returns
Return the MpId of the primary core
VOID ArmPlatformGetVirtualMemoryMap ( OUT ARM_MEMORY_REGION_DESCRIPTOR **  VirtualMemoryMap)

Return the Virtual Memory Map of your platform

This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.

Parameters
[out]VirtualMemoryMapArray of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to- Virtual Memory mapping. This array must be ended by a zero-filled entry
RETURN_STATUS ArmPlatformInitialize ( IN UINTN  MpId)

Initialize controllers that must setup in the normal world

This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei in the PEI phase.

UINTN ArmPlatformIsPrimaryCore ( IN UINTN  MpId)

Return a non-zero value if the callee is the primary core

This function returns a non-zero value if the callee is the primary core. The primary core is the core responsible to initialize the hardware and run UEFI. This function might be called from assembler before any stack is set.

Returns
Return a non-zero value if the callee is the primary core.
VOID ArmPlatformPeiBootAction ( VOID  )

First platform specific function to be called in the PEI phase

This function is actually the first function called by the PrePi or PrePeiCore modules. It allows to retrieve arguments passed to the UEFI firmware through the CPU registers.

This function might be written into assembler as no stack are set when the function is invoked.