/** @file
*
-* Copyright (c) 2011, ARM Limited. All rights reserved.
+* Copyright (c) 2011-2012, ARM Limited. All rights reserved.
*
* This program and the accompanying materials
* are licensed and made available under the terms and conditions of the BSD License
#include <Guid/MemoryTypeInformation.h>
#include <Library/ArmLib.h>
-#include <ArmPlatform.h>
/**
- This structure is used by ArmVExpressGetEfiMemoryMap to describes a region of the EFI memory map
+ This structure is used to describe a region of the EFI memory map
Every EFI regions of the system memory described by their physical start address and their size
can have different attributes. Some regions can be tested and other untested.
UINT64 NumberOfBytes;
} ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR;
-/**
- Called at the early stage of the Boot phase to know if the memory has already been initialized
-
- Running the code from the reset vector does not mean we start from cold boot. In some case, we
- can go through this code with the memory already initialized.
- Because this function is called at the early stage, the implementation must not use the stack.
- Its implementation must probably done in assembly to ensure this requirement.
-
- @return Return the condition value into the 'Z' flag
-
-**/
-VOID ArmPlatformIsMemoryInitialized(VOID);
-
/**
Initialize the memory where the initial stacks will reside
pointer is not used (probably required to use assembly language)
**/
-VOID ArmPlatformInitializeBootMemory(VOID);
+VOID
+ArmPlatformInitializeBootMemory (
+ VOID
+ );
/**
- Initialize the system (or sometimes called permanent) memory
+ Return the current Boot Mode
- This memory is generally represented by the DRAM.
+ This function returns the boot reason on the platform
+
+ @return Return the current Boot Mode of the platform
**/
-VOID ArmPlatformInitializeSystemMemory(VOID);
+EFI_BOOT_MODE
+ArmPlatformGetBootMode (
+ VOID
+ );
/**
- Remap the memory at 0x0
+ Call at the beginning of the platform boot up
+
+ This function allows the firmware platform to do extra actions at the early
+ stage of the platform power up.
- Some platform requires or gives the ability to remap the memory at the address 0x0.
- This function can do nothing if this feature is not relevant to your platform.
+ Note: This function must be implemented in assembler as there is no stack set up yet
**/
-VOID ArmPlatformBootRemapping(VOID);
+VOID
+ArmPlatformSecBootAction (
+ VOID
+ );
/**
- Return if Trustzone is supported by your platform
+ Initialize controllers that must setup at the early stage
+
+ Some peripherals must be initialized in Secure World.
+ For example, some L2x0 requires to be initialized in Secure World
+
+**/
+VOID
+ArmPlatformSecInitialize (
+ VOID
+ );
- A non-zero value must be returned if you want to support a Secure World on your platform.
- ArmPlatformTrustzoneInit() will later set up the secure regions.
- This function can return 0 even if Trustzone is supported by your processor. In this case,
- the platform will continue to run in Secure World.
+/**
+ Call before jumping to Normal World
- @return A non-zero value if Trustzone supported.
+ This function allows the firmware platform to do extra actions before
+ jumping to the Normal World
**/
-UINTN ArmPlatformTrustzoneSupported(VOID);
+VOID
+ArmPlatformSecExtraAction (
+ IN UINTN MpId,
+ OUT UINTN* JumpAddress
+ );
/**
- Initialize the Secure peripherals and memory regions
+ Initialize controllers that must setup in the normal world
- If Trustzone is supported by your platform then this function makes the required initialization
- of the secure peripherals and memory regions.
+ This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
+ in the PEI phase.
**/
-VOID ArmPlatformTrustzoneInit(VOID);
+VOID
+ArmPlatformNormalInitialize (
+ VOID
+ );
/**
- Return the information about the memory region in permanent memory used by PEI
+ Initialize the system (or sometimes called permanent) memory
+
+ This memory is generally represented by the DRAM.
- One of the PEI Module must install the permament memory used by PEI. This function returns the
- information about this region for your platform to this PEIM module.
+**/
+VOID
+ArmPlatformInitializeSystemMemory (
+ VOID
+ );
+
+/**
+ Initialize the Secure peripherals and memory regions
- @param[out] PeiMemoryBase Base of the memory region used by PEI core and modules
- @param[out] PeiMemorySize Size of the memory region used by PEI core and modules
+ If Trustzone is supported by your platform then this function makes the required initialization
+ of the secure peripherals and memory regions.
**/
-VOID ArmPlatformGetPeiMemory (
- OUT UINTN* PeiMemoryBase,
- OUT UINTN* PeiMemorySize
- );
+VOID
+ArmPlatformTrustzoneInit (
+ VOID
+ );
/**
Return the Virtual Memory Map of your platform
entry
**/
-VOID ArmPlatformGetVirtualMemoryMap (
- OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
-);
+VOID
+ArmPlatformGetVirtualMemoryMap (
+ OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap
+ );
/**
Return the EFI Memory Map of your platform
EFI Memory region. This array must be ended by a zero-filled entry
**/
-VOID ArmPlatformGetEfiMemoryMap (
- OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
-);
+EFI_STATUS
+ArmPlatformGetAdditionalSystemMemory (
+ OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap
+ );
+
+/**
+ 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.
+
+ @param[out] PpiListSize Size in Bytes of the Platform PPI List
+ @param[out] PpiList Platform PPI List
+
+**/
+VOID
+ArmPlatformGetPlatformPpiList (
+ OUT UINTN *PpiListSize,
+ OUT EFI_PEI_PPI_DESCRIPTOR **PpiList
+ );
#endif
projects / mirror_edk2.git / blobdiff