3 * Copyright (c) 2011, ARM Limited. All rights reserved.
5 * This program and the accompanying materials
6 * are licensed and made available under the terms and conditions of the BSD License
7 * which accompanies this distribution. The full text of the license may be found at
8 * http://opensource.org/licenses/bsd-license.php
10 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _ARMPLATFORMLIB_H_
16 #define _ARMPLATFORMLIB_H_
19 // The package level header files this module uses
23 // The protocols, PPI and GUID defintions for this module
25 #include <Ppi/MasterBootMode.h>
26 #include <Ppi/BootInRecoveryMode.h>
27 #include <Guid/MemoryTypeInformation.h>
29 #include <Library/ArmLib.h>
32 This structure is used by ArmVExpressGetEfiMemoryMap to describes a region of the EFI memory map
34 Every EFI regions of the system memory described by their physical start address and their size
35 can have different attributes. Some regions can be tested and other untested.
39 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
40 EFI_PHYSICAL_ADDRESS PhysicalStart
;
42 } ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR
;
45 Initialize the memory where the initial stacks will reside
47 This memory can contain the initial stacks (Secure and Secure Monitor stacks).
48 In some platform, this region is already initialized and the implementation of this function can
49 do nothing. This memory can also represent the Secure RAM.
50 This function is called before the satck has been set up. Its implementation must ensure the stack
51 pointer is not used (probably required to use assembly language)
55 ArmPlatformInitializeBootMemory (
60 Return the current Boot Mode
62 This function returns the boot reason on the platform
64 @return Return the current Boot Mode of the platform
68 ArmPlatformGetBootMode (
73 Call at the beginning of the platform boot up
75 This function allows the firmware platform to do extra actions at the early
76 stage of the platform power up.
78 Note: This function must be implemented in assembler as there is no stack set up yet
82 ArmPlatformSecBootAction (
87 Initialize controllers that must setup at the early stage
89 Some peripherals must be initialized in Secure World.
90 For example, some L2x0 requires to be initialized in Secure World
94 ArmPlatformSecInitialize (
99 Call before jumping to Normal World
101 This function allows the firmware platform to do extra actions before
102 jumping to the Normal World
106 ArmPlatformSecExtraAction (
108 OUT UINTN
* JumpAddress
112 Initialize controllers that must setup in the normal world
114 This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
119 ArmPlatformNormalInitialize (
124 Initialize the system (or sometimes called permanent) memory
126 This memory is generally represented by the DRAM.
130 ArmPlatformInitializeSystemMemory (
135 Remap the memory at 0x0
137 Some platform requires or gives the ability to remap the memory at the address 0x0.
138 This function can do nothing if this feature is not relevant to your platform.
142 ArmPlatformBootRemapping (
147 Return if Trustzone is supported by your platform
149 A non-zero value must be returned if you want to support a Secure World on your platform.
150 ArmPlatformTrustzoneInit() will later set up the secure regions.
151 This function can return 0 even if Trustzone is supported by your processor. In this case,
152 the platform will continue to run in Secure World.
154 @return A non-zero value if Trustzone supported.
158 ArmPlatformTrustzoneSupported (
163 Initialize the Secure peripherals and memory regions
165 If Trustzone is supported by your platform then this function makes the required initialization
166 of the secure peripherals and memory regions.
170 ArmPlatformTrustzoneInit (
175 Return the Virtual Memory Map of your platform
177 This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
179 @param[out] VirtualMemoryMap Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
180 Virtual Memory mapping. This array must be ended by a zero-filled
185 ArmPlatformGetVirtualMemoryMap (
186 OUT ARM_MEMORY_REGION_DESCRIPTOR
** VirtualMemoryMap
190 Return the EFI Memory Map of your platform
192 This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource
193 Descriptor HOBs used by DXE core.
195 @param[out] EfiMemoryMap Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an
196 EFI Memory region. This array must be ended by a zero-filled entry
200 ArmPlatformGetAdditionalSystemMemory (
201 OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR
** EfiMemoryMap
205 Return the Platform specific PPIs
207 This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
208 to the PeiCore by PrePeiCore.
210 @param[out] PpiListSize Size in Bytes of the Platform PPI List
211 @param[out] PpiList Platform PPI List
215 ArmPlatformGetPlatformPpiList (
216 OUT UINTN
*PpiListSize
,
217 OUT EFI_PEI_PPI_DESCRIPTOR
**PpiList