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