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