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