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