]> git.proxmox.com Git - mirror_edk2.git/blame - ArmPkg/ArmPkg.dec
ArmPkg: Add missing library headers to ArmPkg.dec
[mirror_edk2.git] / ArmPkg / ArmPkg.dec
CommitLineData
8bbf0f09
A
1#/** @file\r
2# ARM processor package.\r
3#\r
d6ebcab7 4# Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>\r
d03f71dd 5# Copyright (c) 2011 - 2021, ARM Limited. All rights reserved.\r
8bbf0f09 6#\r
4059386c 7# SPDX-License-Identifier: BSD-2-Clause-Patent\r
8bbf0f09
A
8#\r
9#**/\r
10\r
2ef2b01e
A
11[Defines]\r
12 DEC_SPECIFICATION = 0x00010005\r
13 PACKAGE_NAME = ArmPkg\r
14 PACKAGE_GUID = 5CFBD99E-3C43-4E7F-8054-9CDEAFF7710F\r
15 PACKAGE_VERSION = 0.1\r
16\r
17################################################################################\r
18#\r
19# Include Section - list of Include Paths that are provided by this package.\r
20# Comments are used for Keywords and Module Types.\r
21#\r
22# Supported Module Types:\r
23# BASE SEC PEI_CORE PEIM DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER DXE_SAL_DRIVER UEFI_DRIVER UEFI_APPLICATION\r
24#\r
25################################################################################\r
26[Includes.common]\r
27 Include # Root include for the package\r
28\r
29[LibraryClasses.common]\r
8bbf0f09 30 ArmLib|Include/Library/ArmLib.h\r
12728e11 31 ArmMmuLib|Include/Library/ArmMmuLib.h\r
d03f71dd 32 SemihostLib|Include/Library/SemihostLib.h\r
11c20f4e 33 DefaultExceptionHandlerLib|Include/Library/DefaultExceptionHandlerLib.h\r
097bd461 34 ArmDisassemblerLib|Include/Library/ArmDisassemblerLib.h\r
8d13298b 35 ArmGicArchLib|Include/Library/ArmGicArchLib.h\r
d03f71dd 36 ArmMtlLib|Include/Library/ArmMtlLib.h\r
4d163696 37 ArmSvcLib|Include/Library/ArmSvcLib.h\r
d65b78f1 38 OpteeLib|Include/Library/OpteeLib.h\r
eed947be 39 StandaloneMmMmuLib|Include/Library/StandaloneMmMmuLib.h\r
d03f71dd
PG
40 ArmGenericTimerCounterLib|Include/Library/ArmGenericTimerCounterLib.h\r
41 ArmGicLib|Include/Library/ArmGicLib.h\r
42 ArmHvcLib|Include/Library/ArmHvcLib.h\r
43 OemMiscLib|Include/Library/OemMiscLib.h\r
44 ArmSmcLib|Include/Library/ArmSmcLib.h\r
45\r
c32aaba9 46\r
2ef2b01e
A
47[Guids.common]\r
48 gArmTokenSpaceGuid = { 0xBB11ECFE, 0x820F, 0x4968, { 0xBB, 0xA6, 0xF7, 0x6A, 0xFE, 0x30, 0x25, 0x96 } }\r
49\r
44788bae 50 ## ARM MPCore table\r
51 # Include/Guid/ArmMpCoreInfo.h\r
52 gArmMpCoreInfoGuid = { 0xa4ee0728, 0xe5d7, 0x4ac5, {0xb2, 0x1e, 0x65, 0x8e, 0xd8, 0x57, 0xe8, 0x34} }\r
53\r
4f2494cf
GP
54[Protocols.common]\r
55 ## Arm System Control and Management Interface(SCMI) Base protocol\r
56 ## ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h\r
57 gArmScmiBaseProtocolGuid = { 0xd7e5abe9, 0x33ab, 0x418e, { 0x9f, 0x91, 0x72, 0xda, 0xe2, 0xba, 0x8e, 0x2f } }\r
58\r
59 ## Arm System Control and Management Interface(SCMI) Clock management protocol\r
60 ## ArmPkg/Include/Protocol/ArmScmiClockProtocol.h\r
61 gArmScmiClockProtocolGuid = { 0x91ce67a8, 0xe0aa, 0x4012, { 0xb9, 0x9f, 0xb6, 0xfc, 0xf3, 0x4, 0x8e, 0xaa } }\r
559a07d8 62 gArmScmiClock2ProtocolGuid = { 0xb8d8caf2, 0x9e94, 0x462c, { 0xa8, 0x34, 0x6c, 0x99, 0xfc, 0x05, 0xef, 0xcf } }\r
4f2494cf
GP
63\r
64 ## Arm System Control and Management Interface(SCMI) Clock management protocol\r
65 ## ArmPkg/Include/Protocol/ArmScmiPerformanceProtocol.h\r
66 gArmScmiPerformanceProtocolGuid = { 0x9b8ba84, 0x3dd3, 0x49a6, { 0xa0, 0x5a, 0x31, 0x34, 0xa5, 0xf0, 0x7b, 0xad } }\r
67\r
44788bae 68[Ppis]\r
69 ## Include/Ppi/ArmMpCoreInfo.h\r
70 gArmMpCoreInfoPpiGuid = { 0x6847cc74, 0xe9ec, 0x4f8f, {0xa2, 0x9d, 0xab, 0x44, 0xe7, 0x54, 0xa8, 0xfc} }\r
71\r
2ef2b01e
A
72[PcdsFeatureFlag.common]\r
73 gArmTokenSpaceGuid.PcdCpuDxeProduceDebugSupport|FALSE|BOOLEAN|0x00000001\r
74\r
1bfda055 75 # On ARM Architecture with the Security Extension, the address for the\r
76 # Vector Table can be mapped anywhere in the memory map. It means we can\r
77 # point the Exception Vector Table to its location in CpuDxe.\r
f0bbcdf8 78 # By default we copy the Vector Table at PcdGet64(PcdCpuVectorBaseAddress)\r
1bfda055 79 gArmTokenSpaceGuid.PcdRelocateVectorTable|TRUE|BOOLEAN|0x00000022\r
eeec69c5 80 # Set this PCD to TRUE if the Exception Vector is changed to add debugger support before\r
81 # it has been configured by the CPU DXE\r
82 gArmTokenSpaceGuid.PcdDebuggerExceptionSupport|FALSE|BOOLEAN|0x00000032\r
c32aaba9 83\r
f6d46e29
AB
84 # Define if the GICv3 controller should use the GICv2 legacy\r
85 gArmTokenSpaceGuid.PcdArmGicV3WithV2Legacy|FALSE|BOOLEAN|0x00000042\r
86\r
65ceda91
AB
87[PcdsFeatureFlag.ARM]\r
88 # Whether to map normal memory as non-shareable. FALSE is the safe choice, but\r
89 # TRUE may be appropriate to fix performance problems if you don't care about\r
90 # hardware coherency (i.e., no virtualization or cache coherent DMA)\r
91 gArmTokenSpaceGuid.PcdNormalMemoryNonshareableOverride|FALSE|BOOLEAN|0x00000043\r
92\r
ee283e33
SG
93[PcdsFeatureFlag.AARCH64]\r
94 ## Used to select method for requesting services from S-EL1.<BR><BR>\r
95 # TRUE - Selects FF-A calls for communication between S-EL0 and SPMC.<BR>\r
96 # FALSE - Selects SVC calls for communication between S-EL0 and SPMC.<BR>\r
97 # @Prompt Enable FF-A support.\r
98 gArmTokenSpaceGuid.PcdFfaEnable|FALSE|BOOLEAN|0x0000005B\r
99\r
2ef2b01e 100[PcdsFixedAtBuild.common]\r
12c5ae23 101 gArmTokenSpaceGuid.PcdTrustzoneSupport|FALSE|BOOLEAN|0x00000006\r
102\r
1bfda055 103 # This PCD should be a FeaturePcd. But we used this PCD as an '#if' in an ASM file.\r
104 # Using a FeaturePcd make a '(BOOLEAN) casting for its value which is not understood by the preprocessor.\r
105 gArmTokenSpaceGuid.PcdVFPEnabled|0|UINT32|0x00000024\r
106\r
f0bbcdf8 107 gArmTokenSpaceGuid.PcdCpuVectorBaseAddress|0xffff0000|UINT64|0x00000004\r
2ef2b01e 108 gArmTokenSpaceGuid.PcdCpuResetAddress|0x00000000|UINT32|0x00000005\r
c32aaba9 109\r
1bfda055 110 #\r
262a9b04 111 # ARM Secure Firmware PCDs\r
1bfda055 112 #\r
bb5420bb 113 gArmTokenSpaceGuid.PcdSecureFdBaseAddress|0|UINT64|0x00000015\r
1bfda055 114 gArmTokenSpaceGuid.PcdSecureFdSize|0|UINT32|0x00000016\r
bb5420bb 115 gArmTokenSpaceGuid.PcdSecureFvBaseAddress|0x0|UINT64|0x0000002F\r
1ad14bc8 116 gArmTokenSpaceGuid.PcdSecureFvSize|0x0|UINT32|0x00000030\r
1bfda055 117\r
7245b435 118 #\r
119 # ARM Hypervisor Firmware PCDs\r
c32aaba9 120 #\r
7245b435 121 gArmTokenSpaceGuid.PcdHypFdBaseAddress|0|UINT32|0x0000003A\r
122 gArmTokenSpaceGuid.PcdHypFdSize|0|UINT32|0x0000003B\r
123 gArmTokenSpaceGuid.PcdHypFvBaseAddress|0|UINT32|0x0000003C\r
124 gArmTokenSpaceGuid.PcdHypFvSize|0|UINT32|0x0000003D\r
d6dc67ba 125\r
0787bc61 126 # Use ClusterId + CoreId to identify the PrimaryCore\r
127 gArmTokenSpaceGuid.PcdArmPrimaryCoreMask|0xF03|UINT32|0x00000031\r
c32aaba9 128 # The Primary Core is ClusterId[0] & CoreId[0]\r
0787bc61 129 gArmTokenSpaceGuid.PcdArmPrimaryCore|0|UINT32|0x00000037\r
130\r
660d4faa
RC
131 #\r
132 # SMBIOS PCDs\r
133 #\r
134 gArmTokenSpaceGuid.PcdSystemProductName|L""|VOID*|0x30000053\r
135 gArmTokenSpaceGuid.PcdSystemVersion|L""|VOID*|0x30000054\r
136 gArmTokenSpaceGuid.PcdBaseBoardManufacturer|L""|VOID*|0x30000055\r
137 gArmTokenSpaceGuid.PcdBaseBoardProductName|L""|VOID*|0x30000056\r
138 gArmTokenSpaceGuid.PcdBaseBoardVersion|L""|VOID*|0x30000057\r
139 gArmTokenSpaceGuid.PcdProcessorManufacturer|L""|VOID*|0x30000071\r
140 gArmTokenSpaceGuid.PcdProcessorVersion|L""|VOID*|0x30000072\r
141 gArmTokenSpaceGuid.PcdProcessorSerialNumber|L""|VOID*|0x30000073\r
142 gArmTokenSpaceGuid.PcdProcessorAssetTag|L""|VOID*|0x30000074\r
143 gArmTokenSpaceGuid.PcdProcessorPartNumber|L""|VOID*|0x30000075\r
144\r
1bfda055 145 #\r
146 # ARM L2x0 PCDs\r
147 #\r
148 gArmTokenSpaceGuid.PcdL2x0ControllerBase|0|UINT32|0x0000001B\r
c32aaba9 149\r
523b5266
AB
150 #\r
151 # ARM Normal (or Non Secure) Firmware PCDs\r
152 #\r
153 gArmTokenSpaceGuid.PcdFdSize|0|UINT32|0x0000002C\r
154 gArmTokenSpaceGuid.PcdFvSize|0|UINT32|0x0000002E\r
155\r
bfe34275
AB
156 #\r
157 # Value to add to a host address to obtain a device address, using\r
158 # unsigned 64-bit integer arithmetic on both ARM and AArch64. This\r
159 # means we can rely on truncation on overflow to specify negative\r
160 # offsets.\r
161 #\r
162 gArmTokenSpaceGuid.PcdArmDmaDeviceOffset|0x0|UINT64|0x0000044\r
163\r
523b5266
AB
164[PcdsFixedAtBuild.common, PcdsPatchableInModule.common]\r
165 gArmTokenSpaceGuid.PcdFdBaseAddress|0|UINT64|0x0000002B\r
166 gArmTokenSpaceGuid.PcdFvBaseAddress|0|UINT64|0x0000002D\r
387653a4 167\r
168[PcdsFixedAtBuild.ARM]\r
cc935544
OM
169 #\r
170 # ARM Security Extension\r
171 #\r
172\r
173 # Secure Configuration Register\r
174 # - BIT0 : NS - Non Secure bit\r
175 # - BIT1 : IRQ Handler\r
176 # - BIT2 : FIQ Handler\r
177 # - BIT3 : EA - External Abort\r
178 # - BIT4 : FW - F bit writable\r
179 # - BIT5 : AW - A bit writable\r
180 # - BIT6 : nET - Not Early Termination\r
181 # - BIT7 : SCD - Secure Monitor Call Disable\r
182 # - BIT8 : HCE - Hyp Call enable\r
183 # - BIT9 : SIF - Secure Instruction Fetch\r
184 # 0x31 = NS | EA | FW\r
185 gArmTokenSpaceGuid.PcdArmScr|0x31|UINT32|0x00000038\r
186\r
387653a4 187 # By default we do not do a transition to non-secure mode\r
188 gArmTokenSpaceGuid.PcdArmNonSecModeTransition|0x0|UINT32|0x0000003E\r
2425e1d4 189\r
d6dc67ba
OM
190 # Non Secure Access Control Register\r
191 # - BIT15 : NSASEDIS - Disable Non-secure Advanced SIMD functionality\r
192 # - BIT14 : NSD32DIS - Disable Non-secure use of D16-D31\r
193 # - BIT11 : cp11 - Non-secure access to coprocessor 11 enable\r
194 # - BIT10 : cp10 - Non-secure access to coprocessor 10 enable\r
195 # 0xC00 = cp10 | cp11\r
196 gArmTokenSpaceGuid.PcdArmNsacr|0xC00|UINT32|0x00000039\r
197\r
25402f5d 198[PcdsFixedAtBuild.AARCH64]\r
cc935544
OM
199 #\r
200 # AArch64 Security Extension\r
201 #\r
202\r
203 # Secure Configuration Register\r
204 # - BIT0 : NS - Non Secure bit\r
205 # - BIT1 : IRQ Handler\r
206 # - BIT2 : FIQ Handler\r
207 # - BIT3 : EA - External Abort\r
208 # - BIT4 : FW - F bit writable\r
209 # - BIT5 : AW - A bit writable\r
210 # - BIT6 : nET - Not Early Termination\r
211 # - BIT7 : SCD - Secure Monitor Call Disable\r
212 # - BIT8 : HCE - Hyp Call enable\r
213 # - BIT9 : SIF - Secure Instruction Fetch\r
214 # - BIT10: RW - Register width control for lower exception levels\r
215 # - BIT11: SIF - Enables Secure EL1 access to EL1 Architectural Timer\r
216 # - BIT12: TWI - Trap WFI\r
217 # - BIT13: TWE - Trap WFE\r
218 # 0x501 = NS | HCE | RW\r
219 gArmTokenSpaceGuid.PcdArmScr|0x501|UINT32|0x00000038\r
220\r
25402f5d
HL
221 # By default we do transition to EL2 non-secure mode with Stack for EL2.\r
222 # Mode Description Bits\r
c32aaba9
OM
223 # NS EL2 SP2 all interrupts disabled = 0x3c9\r
224 # NS EL1 SP1 all interrupts disabled = 0x3c5\r
25402f5d
HL
225 # Other modes include using SP0 or switching to Aarch32, but these are\r
226 # not currently supported.\r
227 gArmTokenSpaceGuid.PcdArmNonSecModeTransition|0x3c9|UINT32|0x0000003E\r
e1e2e66c
AB
228\r
229\r
dc63be24 230#\r
523b5266
AB
231# These PCDs are also defined as 'PcdsDynamic' or 'PcdsPatchableInModule' to be\r
232# redefined when using UEFI in a context of virtual machine.\r
dc63be24 233#\r
523b5266
AB
234[PcdsFixedAtBuild.common, PcdsDynamic.common, PcdsPatchableInModule.common]\r
235\r
f8d7d6e1 236 # System Memory (DRAM): These PCDs define the region of in-built system memory\r
142fa386
AB
237 # Some platforms can get DRAM extensions, these additional regions may be\r
238 # declared to UEFI using separate resource descriptor HOBs\r
f8d7d6e1
AB
239 gArmTokenSpaceGuid.PcdSystemMemoryBase|0|UINT64|0x00000029\r
240 gArmTokenSpaceGuid.PcdSystemMemorySize|0|UINT64|0x0000002A\r
241\r
767febf8
AG
242 gArmTokenSpaceGuid.PcdMmBufferBase|0|UINT64|0x00000045\r
243 gArmTokenSpaceGuid.PcdMmBufferSize|0|UINT64|0x00000046\r
244\r
660d4faa
RC
245 gArmTokenSpaceGuid.PcdSystemBiosRelease|0xFFFF|UINT16|0x30000058\r
246 gArmTokenSpaceGuid.PcdEmbeddedControllerFirmwareRelease|0xFFFF|UINT16|0x30000059\r
247\r
523b5266 248[PcdsFixedAtBuild.common, PcdsDynamic.common]\r
e1e2e66c
AB
249 #\r
250 # ARM Architectural Timer\r
251 #\r
252 gArmTokenSpaceGuid.PcdArmArchTimerFreqInHz|0|UINT32|0x00000034\r
253\r
254 # ARM Architectural Timer Interrupt(GIC PPI) numbers\r
255 gArmTokenSpaceGuid.PcdArmArchTimerSecIntrNum|29|UINT32|0x00000035\r
256 gArmTokenSpaceGuid.PcdArmArchTimerIntrNum|30|UINT32|0x00000036\r
257 gArmTokenSpaceGuid.PcdArmArchTimerHypIntrNum|26|UINT32|0x00000040\r
258 gArmTokenSpaceGuid.PcdArmArchTimerVirtIntrNum|27|UINT32|0x00000041\r
dc63be24 259\r
0b4d97a0
RC
260 #\r
261 # ARM Generic Watchdog\r
262 #\r
263\r
7c609a14
A
264 gArmTokenSpaceGuid.PcdGenericWatchdogControlBase|0x2A440000|UINT64|0x00000007\r
265 gArmTokenSpaceGuid.PcdGenericWatchdogRefreshBase|0x2A450000|UINT64|0x00000008\r
0b4d97a0
RC
266 gArmTokenSpaceGuid.PcdGenericWatchdogEl2IntrNum|93|UINT32|0x00000009\r
267\r
dc63be24
AB
268 #\r
269 # ARM Generic Interrupt Controller\r
270 #\r
8a1f2378 271 gArmTokenSpaceGuid.PcdGicDistributorBase|0|UINT64|0x0000000C\r
919697ae 272 # Base address for the GIC Redistributor region that contains the boot CPU\r
8a1f2378
DC
273 gArmTokenSpaceGuid.PcdGicRedistributorsBase|0|UINT64|0x0000000E\r
274 gArmTokenSpaceGuid.PcdGicInterruptInterfaceBase|0|UINT64|0x0000000D\r
dc63be24 275 gArmTokenSpaceGuid.PcdGicSgiIntId|0|UINT32|0x00000025\r
d7c06eb0
AB
276\r
277 #\r
278 # Bases, sizes and translation offsets of IO and MMIO spaces, respectively.\r
279 # Note that "IO" is just another MMIO range that simulates IO space; there\r
280 # are no special instructions to access it.\r
281 #\r
282 # The base addresses PcdPciIoBase, PcdPciMmio32Base and PcdPciMmio64Base are\r
283 # specific to their containing address spaces. In order to get the physical\r
284 # address for the CPU, for a given access, the respective translation value\r
285 # has to be added.\r
286 #\r
287 # The translations always have to be initialized like this, using UINT64:\r
288 #\r
289 # UINT64 IoCpuBase; // mapping target in 64-bit cpu-physical space\r
290 # UINT64 Mmio32CpuBase; // mapping target in 64-bit cpu-physical space\r
291 # UINT64 Mmio64CpuBase; // mapping target in 64-bit cpu-physical space\r
292 #\r
293 # PcdPciIoTranslation = IoCpuBase - PcdPciIoBase;\r
294 # PcdPciMmio32Translation = Mmio32CpuBase - (UINT64)PcdPciMmio32Base;\r
295 # PcdPciMmio64Translation = Mmio64CpuBase - PcdPciMmio64Base;\r
296 #\r
297 # because (a) the target address space (ie. the cpu-physical space) is\r
298 # 64-bit, and (b) the translation values are meant as offsets for *modular*\r
299 # arithmetic.\r
300 #\r
301 # Accordingly, the translation itself needs to be implemented as:\r
302 #\r
303 # UINT64 UntranslatedIoAddress; // input parameter\r
304 # UINT32 UntranslatedMmio32Address; // input parameter\r
305 # UINT64 UntranslatedMmio64Address; // input parameter\r
306 #\r
307 # UINT64 TranslatedIoAddress; // output parameter\r
308 # UINT64 TranslatedMmio32Address; // output parameter\r
309 # UINT64 TranslatedMmio64Address; // output parameter\r
310 #\r
311 # TranslatedIoAddress = UntranslatedIoAddress +\r
312 # PcdPciIoTranslation;\r
313 # TranslatedMmio32Address = (UINT64)UntranslatedMmio32Address +\r
314 # PcdPciMmio32Translation;\r
315 # TranslatedMmio64Address = UntranslatedMmio64Address +\r
316 # PcdPciMmio64Translation;\r
317 #\r
318 # The modular arithmetic performed in UINT64 ensures that the translation\r
319 # works correctly regardless of the relation between IoCpuBase and\r
320 # PcdPciIoBase, Mmio32CpuBase and PcdPciMmio32Base, and Mmio64CpuBase and\r
321 # PcdPciMmio64Base.\r
322 #\r
323 gArmTokenSpaceGuid.PcdPciIoBase|0x0|UINT64|0x00000050\r
324 gArmTokenSpaceGuid.PcdPciIoSize|0x0|UINT64|0x00000051\r
325 gArmTokenSpaceGuid.PcdPciIoTranslation|0x0|UINT64|0x00000052\r
326 gArmTokenSpaceGuid.PcdPciMmio32Base|0x0|UINT32|0x00000053\r
327 gArmTokenSpaceGuid.PcdPciMmio32Size|0x0|UINT32|0x00000054\r
328 gArmTokenSpaceGuid.PcdPciMmio32Translation|0x0|UINT64|0x00000055\r
329 gArmTokenSpaceGuid.PcdPciMmio64Base|0x0|UINT64|0x00000056\r
330 gArmTokenSpaceGuid.PcdPciMmio64Size|0x0|UINT64|0x00000057\r
331 gArmTokenSpaceGuid.PcdPciMmio64Translation|0x0|UINT64|0x00000058\r
332\r
333 #\r
334 # Inclusive range of allowed PCI buses.\r
335 #\r
336 gArmTokenSpaceGuid.PcdPciBusMin|0x0|UINT32|0x00000059\r
337 gArmTokenSpaceGuid.PcdPciBusMax|0x0|UINT32|0x0000005A\r