]>
Commit | Line | Data |
---|---|---|
1d5d0ae9 | 1 | /** @file |
2 | * | |
3 | * Copyright (c) 2011, ARM Limited. All rights reserved. | |
4 | * | |
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 | |
9 | * | |
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. | |
12 | * | |
13 | **/ | |
14 | ||
15 | #ifndef _ARMPLATFORMLIB_H_ | |
16 | #define _ARMPLATFORMLIB_H_ | |
17 | ||
18 | // | |
19 | // The package level header files this module uses | |
20 | // | |
21 | #include <PiPei.h> | |
22 | // | |
23 | // The protocols, PPI and GUID defintions for this module | |
24 | // | |
25 | #include <Ppi/MasterBootMode.h> | |
26 | #include <Ppi/BootInRecoveryMode.h> | |
27 | #include <Guid/MemoryTypeInformation.h> | |
28 | ||
29 | #include <Library/ArmLib.h> | |
30 | #include <ArmPlatform.h> | |
31 | ||
32 | /** | |
33 | This structure is used by ArmVExpressGetEfiMemoryMap to describes a region of the EFI memory map | |
34 | ||
35 | Every EFI regions of the system memory described by their physical start address and their size | |
36 | can have different attributes. Some regions can be tested and other untested. | |
37 | ||
38 | **/ | |
39 | typedef struct { | |
40 | EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute; | |
41 | EFI_PHYSICAL_ADDRESS PhysicalStart; | |
42 | UINT64 NumberOfBytes; | |
43 | } ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR; | |
44 | ||
45 | /** | |
46 | Called at the early stage of the Boot phase to know if the memory has already been initialized | |
47 | ||
48 | Running the code from the reset vector does not mean we start from cold boot. In some case, we | |
49 | can go through this code with the memory already initialized. | |
50 | Because this function is called at the early stage, the implementation must not use the stack. | |
51 | Its implementation must probably done in assembly to ensure this requirement. | |
52 | ||
53 | @return Return the condition value into the 'Z' flag | |
54 | ||
55 | **/ | |
56 | VOID ArmPlatformIsMemoryInitialized(VOID); | |
57 | ||
58 | /** | |
59 | Initialize the memory where the initial stacks will reside | |
60 | ||
61 | This memory can contain the initial stacks (Secure and Secure Monitor stacks). | |
62 | In some platform, this region is already initialized and the implementation of this function can | |
63 | do nothing. This memory can also represent the Secure RAM. | |
64 | This function is called before the satck has been set up. Its implementation must ensure the stack | |
65 | pointer is not used (probably required to use assembly language) | |
66 | ||
67 | **/ | |
68 | VOID ArmPlatformInitializeBootMemory(VOID); | |
69 | ||
70 | /** | |
71 | Initialize the system (or sometimes called permanent) memory | |
72 | ||
73 | This memory is generally represented by the DRAM. | |
74 | ||
75 | **/ | |
76 | VOID ArmPlatformInitializeSystemMemory(VOID); | |
77 | ||
78 | /** | |
79 | Remap the memory at 0x0 | |
80 | ||
81 | Some platform requires or gives the ability to remap the memory at the address 0x0. | |
82 | This function can do nothing if this feature is not relevant to your platform. | |
83 | ||
84 | **/ | |
85 | VOID ArmPlatformBootRemapping(VOID); | |
86 | ||
87 | /** | |
88 | Return if Trustzone is supported by your platform | |
89 | ||
90 | A non-zero value must be returned if you want to support a Secure World on your platform. | |
91 | ArmPlatformTrustzoneInit() will later set up the secure regions. | |
92 | This function can return 0 even if Trustzone is supported by your processor. In this case, | |
93 | the platform will continue to run in Secure World. | |
94 | ||
95 | @return A non-zero value if Trustzone supported. | |
96 | ||
97 | **/ | |
98 | UINTN ArmPlatformTrustzoneSupported(VOID); | |
99 | ||
100 | /** | |
101 | Initialize the Secure peripherals and memory regions | |
102 | ||
103 | If Trustzone is supported by your platform then this function makes the required initialization | |
104 | of the secure peripherals and memory regions. | |
105 | ||
106 | **/ | |
107 | VOID ArmPlatformTrustzoneInit(VOID); | |
108 | ||
109 | /** | |
110 | Return the information about the memory region in permanent memory used by PEI | |
111 | ||
112 | One of the PEI Module must install the permament memory used by PEI. This function returns the | |
113 | information about this region for your platform to this PEIM module. | |
114 | ||
115 | @param[out] PeiMemoryBase Base of the memory region used by PEI core and modules | |
116 | @param[out] PeiMemorySize Size of the memory region used by PEI core and modules | |
117 | ||
118 | **/ | |
119 | VOID ArmPlatformGetPeiMemory ( | |
120 | OUT UINTN* PeiMemoryBase, | |
121 | OUT UINTN* PeiMemorySize | |
122 | ); | |
123 | ||
124 | /** | |
125 | Return the Virtual Memory Map of your platform | |
126 | ||
127 | This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform. | |
128 | ||
129 | @param[out] VirtualMemoryMap Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to- | |
130 | Virtual Memory mapping. This array must be ended by a zero-filled | |
131 | entry | |
132 | ||
133 | **/ | |
134 | VOID ArmPlatformGetVirtualMemoryMap ( | |
135 | OUT ARM_MEMORY_REGION_DESCRIPTOR** VirtualMemoryMap | |
136 | ); | |
137 | ||
138 | /** | |
139 | Return the EFI Memory Map of your platform | |
140 | ||
141 | This EFI Memory Map of the System Memory is used by MemoryInitPei module to create the Resource | |
142 | Descriptor HOBs used by DXE core. | |
143 | ||
144 | @param[out] EfiMemoryMap Array of ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR describing an | |
145 | EFI Memory region. This array must be ended by a zero-filled entry | |
146 | ||
147 | **/ | |
148 | VOID ArmPlatformGetEfiMemoryMap ( | |
149 | OUT ARM_SYSTEM_MEMORY_REGION_DESCRIPTOR** EfiMemoryMap | |
150 | ); | |
151 | ||
152 | #endif |