ArmPkg/ArmPkg.dec

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