ArmPlatformPkg/ArmPlatformPkg.dec

   1 #/** @file
   2 #
   3 #  Copyright (c) 2011-2015, ARM Limited. All rights reserved.
   4 #
   5 #  This program and the accompanying materials
   6 #  are licensed and made available under the terms and conditions of the BSD License
   7 #  which accompanies this distribution.  The full text of the license may be found at
   8 #  http://opensource.org/licenses/bsd-license.php
   9 #
  10 #  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 #
  13 #**/
  14
  15 [Defines]
  16   DEC_SPECIFICATION              = 0x00010005
  17   PACKAGE_NAME                   = ArmPlatformPkg
  18   PACKAGE_GUID                   = 3308e0a0-1d94-11e0-915c-0002a5d5c51b
  19   PACKAGE_VERSION                = 0.1
  20
  21 ################################################################################
  22 #
  23 # Include Section - list of Include Paths that are provided by this package.
  24 #                   Comments are used for Keywords and Module Types.
  25 #
  26 # Supported Module Types:
  27 #  BASE SEC PEI_CORE PEIM DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER DXE_SAL_DRIVER UEFI_DRIVER UEFI_APPLICATION
  28 #
  29 ################################################################################
  30 [Includes.common]
  31   Include                        # Root include for the package
  32
  33 [Guids.common]
  34   gArmPlatformTokenSpaceGuid   = { 0x9c0aaed4, 0x74c5, 0x4043, { 0xb4, 0x17, 0xa3, 0x22, 0x38, 0x14, 0xce, 0x76 } }
  35   #
  36   # Following Guid must match FILE_GUID in MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
  37   #
  38   gVariableRuntimeDxeFileGuid = { 0xcbd2e4d5, 0x7068, 0x4ff5, { 0xb4, 0x62, 0x98, 0x22, 0xb4, 0xad, 0x8d, 0x60 } }
  39
  40   ## Include/Guid/ArmGlobalVariableHob.h
  41   gArmGlobalVariableGuid      = { 0xc3253c90, 0xa24f, 0x4599, { 0xa6, 0x64, 0x1f, 0x88, 0x13, 0x77, 0x8f, 0xc9} }
  42
  43   gArmBootMonFsFileInfoGuid   = { 0x41e26b9c, 0xada6, 0x45b3, { 0x80, 0x8e, 0x23, 0x57, 0xa3, 0x5b, 0x60, 0xd6 } }
  44
  45   ## Include/Guid/ArmPlatformEvents.h
  46   gArmPlatformUpdateFdtEventGuid = { 0xaffe115b, 0x8589, 0x456d, { 0xba, 0xb5, 0x8f, 0x2e, 0xda, 0x53, 0xae, 0xb7 } }
  47
  48 [Ppis]
  49   ## Include/Ppi/ArmGlobalVariable.h
  50   gArmGlobalVariablePpiGuid = { 0xab1c1816, 0xd542, 0x4e6f, {0x9b, 0x1e, 0x8e, 0xcd, 0x92, 0x53, 0xe2, 0xe7} }
  51
  52 [PcdsFeatureFlag.common]
  53   # Set this PCD to TRUE to map NORFlash at 0x0. FALSE means the DRAM is mapped at 0x0.
  54   gArmPlatformTokenSpaceGuid.PcdNorFlashRemapping|FALSE|BOOLEAN|0x00000012
  55
  56   gArmPlatformTokenSpaceGuid.PcdStandalone|TRUE|BOOLEAN|0x00000001
  57   gArmPlatformTokenSpaceGuid.PcdSystemMemoryInitializeInSec|FALSE|BOOLEAN|0x00000002
  58   gArmPlatformTokenSpaceGuid.PcdSendSgiToBringUpSecondaryCores|FALSE|BOOLEAN|0x00000004
  59
  60   gArmPlatformTokenSpaceGuid.PcdNorFlashCheckBlockLocked|FALSE|BOOLEAN|0x0000003C
  61
  62   # Disable the GOP controller on ExitBootServices(). By default the value is FALSE,
  63   # we assume the OS will handle the FrameBuffer from the UEFI GOP information.
  64   gArmPlatformTokenSpaceGuid.PcdGopDisableOnExitBootServices|FALSE|BOOLEAN|0x0000003D
  65
  66 [PcdsFixedAtBuild.common]
  67   gArmPlatformTokenSpaceGuid.PcdCoreCount|1|UINT32|0x00000039
  68   gArmPlatformTokenSpaceGuid.PcdClusterCount|1|UINT32|0x00000038
  69
  70   # Stack for CPU Cores in Secure Mode
  71   gArmPlatformTokenSpaceGuid.PcdCPUCoresSecStackBase|0|UINT32|0x00000005
  72   gArmPlatformTokenSpaceGuid.PcdCPUCoreSecPrimaryStackSize|0x10000|UINT32|0x00000036
  73   gArmPlatformTokenSpaceGuid.PcdCPUCoreSecSecondaryStackSize|0x1000|UINT32|0x00000006
  74
  75   # Stack for CPU Cores in Non Secure Mode
  76   gArmPlatformTokenSpaceGuid.PcdCPUCoresStackBase|0|UINT64|0x00000009
  77   gArmPlatformTokenSpaceGuid.PcdCPUCorePrimaryStackSize|0x10000|UINT32|0x00000037
  78   gArmPlatformTokenSpaceGuid.PcdCPUCoreSecondaryStackSize|0x1000|UINT32|0x0000000A
  79
  80   # Size of the region used by UEFI in permanent memory (Reserved 128MB by default)
  81   gArmPlatformTokenSpaceGuid.PcdSystemMemoryUefiRegionSize|0x08000000|UINT32|0x00000015
  82
  83   # Size to reserve in the primary core stack for PEI Global Variables
  84   #  = sizeof(UINTN) /* PcdPeiServicePtr or HobListPtr */
  85   gArmPlatformTokenSpaceGuid.PcdPeiGlobalVariableSize|0x4|UINT32|0x00000016
  86   # PeiServicePtr and HobListPtr shares the same location in the PEI Global Variable list
  87   # PeiServicePtr is only valid with PEI Core and HobListPtr only when the PEI Core is skipped.
  88   gArmPlatformTokenSpaceGuid.PcdPeiServicePtrGlobalOffset|0x0|UINT32|0x00000017
  89   gArmPlatformTokenSpaceGuid.PcdHobListPtrGlobalOffset|0x0|UINT32|0x00000018
  90
  91   # Size to reserve in the primary core stack for SEC Global Variables
  92   gArmPlatformTokenSpaceGuid.PcdSecGlobalVariableSize|0x0|UINT32|0x00000031
  93
  94   # Boot Monitor FileSystem
  95   gArmPlatformTokenSpaceGuid.PcdBootMonFsSupportedDevicePaths|L""|VOID*|0x0000003A
  96
  97   #
  98   # ARM Primecells
  99   #
 100
 101   ## SP804 DualTimer
 102   gArmPlatformTokenSpaceGuid.PcdSP804TimerFrequencyInMHz|1|UINT32|0x0000001D
 103   gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicInterruptNum|0|UINT32|0x0000001E
 104   gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicBase|0|UINT32|0x0000002A
 105   gArmPlatformTokenSpaceGuid.PcdSP804TimerPerformanceBase|0|UINT32|0x0000002B
 106   gArmPlatformTokenSpaceGuid.PcdSP804TimerMetronomeBase|0|UINT32|0x0000002C
 107
 108   ## SP805 Watchdog
 109   gArmPlatformTokenSpaceGuid.PcdSP805WatchdogBase|0x0|UINT32|0x00000023
 110   gArmPlatformTokenSpaceGuid.PcdSP805WatchdogClockFrequencyInHz|32000|UINT32|0x00000021
 111
 112   ## PL011 UART
 113   gArmPlatformTokenSpaceGuid.PL011UartClkInHz|24000000|UINT32|0x0000001F
 114   gArmPlatformTokenSpaceGuid.PL011UartInteger|0|UINT32|0x00000020
 115   gArmPlatformTokenSpaceGuid.PL011UartFractional|0|UINT32|0x0000002D
 116
 117   ## PL061 GPIO
 118   gArmPlatformTokenSpaceGuid.PcdPL061GpioBase|0x0|UINT32|0x00000025
 119
 120   ## PL111 Lcd & HdLcd
 121   gArmPlatformTokenSpaceGuid.PcdPL111LcdBase|0x0|UINT32|0x00000026
 122   gArmPlatformTokenSpaceGuid.PcdArmHdLcdBase|0x0|UINT32|0x00000027
 123
 124   ## PL180 MCI
 125   gArmPlatformTokenSpaceGuid.PcdPL180SysMciRegAddress|0x00000000|UINT32|0x00000028
 126   gArmPlatformTokenSpaceGuid.PcdPL180MciBaseAddress|0x00000000|UINT32|0x00000029
 127
 128   #
 129   # BDS - Boot Manager
 130   #
 131   gArmPlatformTokenSpaceGuid.PcdFirmwareVendor|"ARM Platform"|VOID*|0x00000019
 132   gArmPlatformTokenSpaceGuid.PcdDefaultBootDescription|L"Default Boot Device"|VOID*|0x0000000C
 133   gArmPlatformTokenSpaceGuid.PcdDefaultBootDevicePath|L""|VOID*|0x0000000D
 134   gArmPlatformTokenSpaceGuid.PcdDefaultBootInitrdPath|L""|VOID*|0x0000000E
 135   gArmPlatformTokenSpaceGuid.PcdDefaultBootArgument|L""|VOID*|0x000000F
 136   # PcdDefaultBootType define the type of the binary pointed by PcdDefaultBootDevicePath:
 137   #  - 0 = an EFI application
 138   #  - 1 = a Linux kernel with ATAG support
 139   #  - 2 = a Linux kernel with FDT support
 140   gArmPlatformTokenSpaceGuid.PcdDefaultBootType|0|UINT32|0x00000010
 141   gArmPlatformTokenSpaceGuid.PcdFdtDevicePath|L""|VOID*|0x00000011
 142
 143   ## Timeout value for displaying progressing bar in before boot OS.
 144   #  According to UEFI 2.0 spec, the default TimeOut should be 0xffff.
 145   gArmPlatformTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x0000001A
 146
 147   gArmPlatformTokenSpaceGuid.PcdDefaultConInPaths|L""|VOID*|0x0000001B
 148   gArmPlatformTokenSpaceGuid.PcdDefaultConOutPaths|L""|VOID*|0x0000001C
 149
 150 [PcdsFixedAtBuild.common,PcdsDynamic.common]
 151   ## PL031 RealTimeClock
 152   gArmPlatformTokenSpaceGuid.PcdPL031RtcBase|0x0|UINT32|0x00000024
 153   gArmPlatformTokenSpaceGuid.PcdPL031RtcPpmAccuracy|300000000|UINT32|0x00000022
 154
 155   #
 156   # Inclusive range of allowed PCI buses.
 157   #
 158   gArmPlatformTokenSpaceGuid.PcdPciBusMin|0x0|UINT32|0x0000003E
 159   gArmPlatformTokenSpaceGuid.PcdPciBusMax|0x0|UINT32|0x0000003F
 160
 161   #
 162   # Bases, sizes and translation offsets of IO and MMIO spaces, respectively.
 163   # Note that "IO" is just another MMIO range that simulates IO space; there
 164   # are no special instructions to access it.
 165   #
 166   # The base addresses PcdPciIoBase, PcdPciMmio32Base and PcdPciMmio64Base are
 167   # specific to their containing address spaces. In order to get the physical
 168   # address for the CPU, for a given access, the respective translation value
 169   # has to be added.
 170   #
 171   # The translations always have to be initialized like this, using UINT64:
 172   #
 173   #   UINT64 IoCpuBase;     // mapping target in 64-bit cpu-physical space
 174   #   UINT64 Mmio32CpuBase; // mapping target in 64-bit cpu-physical space
 175   #   UINT64 Mmio64CpuBase; // mapping target in 64-bit cpu-physical space
 176   #
 177   #   PcdPciIoTranslation     = IoCpuBase     - PcdPciIoBase;
 178   #   PcdPciMmio32Translation = Mmio32CpuBase - (UINT64)PcdPciMmio32Base;
 179   #   PcdPciMmio64Translation = Mmio64CpuBase - PcdPciMmio64Base;
 180   #
 181   # because (a) the target address space (ie. the cpu-physical space) is
 182   # 64-bit, and (b) the translation values are meant as offsets for *modular*
 183   # arithmetic.
 184   #
 185   # Accordingly, the translation itself needs to be implemented as:
 186   #
 187   #   UINT64 UntranslatedIoAddress;     // input parameter
 188   #   UINT32 UntranslatedMmio32Address; // input parameter
 189   #   UINT64 UntranslatedMmio64Address; // input parameter
 190   #
 191   #   UINT64 TranslatedIoAddress;       // output parameter
 192   #   UINT64 TranslatedMmio32Address;   // output parameter
 193   #   UINT64 TranslatedMmio64Address;   // output parameter
 194   #
 195   #   TranslatedIoAddress     = UntranslatedIoAddress +
 196   #                             PcdPciIoTranslation;
 197   #   TranslatedMmio32Address = (UINT64)UntranslatedMmio32Address +
 198   #                             PcdPciMmio32Translation;
 199   #   TranslatedMmio64Address = UntranslatedMmio64Address +
 200   #                             PcdPciMmio64Translation;
 201   #
 202   #  The modular arithmetic performed in UINT64 ensures that the translation
 203   #  works correctly regardless of the relation between IoCpuBase and
 204   #  PcdPciIoBase, Mmio32CpuBase and PcdPciMmio32Base, and Mmio64CpuBase and
 205   #  PcdPciMmio64Base.
 206   #
 207   gArmPlatformTokenSpaceGuid.PcdPciIoBase|0x0|UINT64|0x00000040
 208   gArmPlatformTokenSpaceGuid.PcdPciIoSize|0x0|UINT64|0x00000041
 209   gArmPlatformTokenSpaceGuid.PcdPciIoTranslation|0x0|UINT64|0x00000042
 210   gArmPlatformTokenSpaceGuid.PcdPciMmio32Base|0x0|UINT32|0x00000043
 211   gArmPlatformTokenSpaceGuid.PcdPciMmio32Size|0x0|UINT32|0x00000044
 212   gArmPlatformTokenSpaceGuid.PcdPciMmio32Translation|0x0|UINT64|0x00000045
 213   gArmPlatformTokenSpaceGuid.PcdPciMmio64Base|0x0|UINT64|0x00000046
 214   gArmPlatformTokenSpaceGuid.PcdPciMmio64Size|0x0|UINT64|0x00000047
 215   gArmPlatformTokenSpaceGuid.PcdPciMmio64Translation|0x0|UINT64|0x00000048
 216
 217 [PcdsFixedAtBuild.ARM]
 218   # Stack for CPU Cores in Secure Monitor Mode
 219   gArmPlatformTokenSpaceGuid.PcdCPUCoresSecMonStackBase|0|UINT32|0x00000007
 220   gArmPlatformTokenSpaceGuid.PcdCPUCoreSecMonStackSize|0x1000|UINT32|0x00000008
 221
 222 [PcdsFixedAtBuild.AARCH64]
 223   # The Secure World is only running in EL3. Only one set of stacks is needed for AArch64.
 224   # The Secure stacks are described by PcdCPUCoresSecStackBase, PcdCPUCoreSecPrimaryStackSize
 225   # and PcdCPUCoreSecSecondaryStackSize
 226   gArmPlatformTokenSpaceGuid.PcdCPUCoresSecMonStackBase|0|UINT32|0x00000007
 227   gArmPlatformTokenSpaceGuid.PcdCPUCoreSecMonStackSize|0x0|UINT32|0x00000008
 228