[mirror_edk2.git] / ArmPlatformPkg / ArmPlatformPkg.dec

#/** @file
# Arm Versatile Express package.
#
#  Copyright (c) 2011, ARM Limited. All rights reserved.
#  
#  This program and the accompanying materials                          
#  are licensed and made available under the terms and conditions of the BSD License         
#  which accompanies this distribution.  The full text of the license may be found at        
#  http://opensource.org/licenses/bsd-license.php                                            
#
#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     
#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             
#
#**/

[Defines]
  DEC_SPECIFICATION              = 0x00010005
  PACKAGE_NAME                   = ArmPlatformPkg
  PACKAGE_GUID                   = 3308e0a0-1d94-11e0-915c-0002a5d5c51b 
  PACKAGE_VERSION                = 0.1

################################################################################
#
# Include Section - list of Include Paths that are provided by this package.
#                   Comments are used for Keywords and Module Types.
#
# Supported Module Types:
#  BASE SEC PEI_CORE PEIM DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER DXE_SAL_DRIVER UEFI_DRIVER UEFI_APPLICATION
#
################################################################################
[Includes.common]
  Include                        # Root include for the package

[Guids.common]
  gArmPlatformTokenSpaceGuid    =  { 0x9c0aaed4, 0x74c5, 0x4043, { 0xb4, 0x17, 0xa3, 0x22, 0x38, 0x14, 0xce, 0x76 } }
  #
  # Following Guid must match FILE_GUID in MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
  #
  gVariableRuntimeDxeFileGuid = { 0xcbd2e4d5, 0x7068, 0x4ff5, { 0xb4, 0x62, 0x98, 0x22, 0xb4, 0xad, 0x8d, 0x60 } }

[PcdsFeatureFlag.common]
  # Set this PCD to TRUE to map NORFlash at 0x0. FALSE means the DRAM is mapped at 0x0.
  gArmPlatformTokenSpaceGuid.PcdNorFlashRemapping|FALSE|BOOLEAN|0x00000012
  
  gArmPlatformTokenSpaceGuid.PcdStandalone|TRUE|BOOLEAN|0x00000001
  gArmPlatformTokenSpaceGuid.PcdSystemMemoryInitializeInSec|FALSE|BOOLEAN|0x00000002
  gArmPlatformTokenSpaceGuid.PcdSendSgiToBringUpSecondaryCores|FALSE|BOOLEAN|0x00000004
  

[PcdsFixedAtBuild.common]
  # These PCDs should be FeaturePcds. But we used these PCDs as an '#if' in an ASM file.
  # Using a FeaturePcd make a '(BOOLEAN) casting for its value which is not understood by the preprocessor.
  gArmPlatformTokenSpaceGuid.PcdMPCoreSupport|0|UINT32|0x00000003
  gArmPlatformTokenSpaceGuid.PcdMPCoreMaxCores|1|UINT32|0x0000002D
  
  # Stack for CPU Cores in Secure Mode
  gArmPlatformTokenSpaceGuid.PcdCPUCoresSecStackBase|0|UINT32|0x00000005
  gArmPlatformTokenSpaceGuid.PcdCPUCoreSecStackSize|0|UINT32|0x00000006

  # Stack for CPU Cores in Secure Monitor Mode
  gArmPlatformTokenSpaceGuid.PcdCPUCoresSecMonStackBase|0|UINT32|0x00000007
  gArmPlatformTokenSpaceGuid.PcdCPUCoreSecMonStackSize|0|UINT32|0x00000008

  # Stack for CPU Cores in Non Secure Mode
  gArmPlatformTokenSpaceGuid.PcdCPUCoresNonSecStackBase|0|UINT32|0x00000009
  gArmPlatformTokenSpaceGuid.PcdCPUCoresNonSecStackSize|0|UINT32|0x0000000A
    
  # Size of the region used by UEFI in permanent memory (Reserved 128MB by default)
  gArmPlatformTokenSpaceGuid.PcdSystemMemoryUefiRegionSize|0x08000000|UINT32|0x00000015

  # Size to reserve in the primary core stack for PEI Global Variables
  #  = sizeof(UINTN) /* PcdPeiServicePtr or HobListPtr */
  gArmPlatformTokenSpaceGuid.PcdPeiGlobalVariableSize|0x4|UINT32|0x00000016
  # PeiServicePtr and HobListPtr shares the same location in the PEI Global Variable list
  # PeiServicePtr is only valid with PEI Core and HobListPtr only when the PEI Core is skipped. 
  gArmPlatformTokenSpaceGuid.PcdPeiServicePtrGlobalOffset|0x0|UINT32|0x00000017
  gArmPlatformTokenSpaceGuid.PcdHobListPtrGlobalOffset|0x0|UINT32|0x00000018

  #
  # ARM Primecells
  #

  ## SP804 DualTimer
  gArmPlatformTokenSpaceGuid.PcdSP804TimerFrequencyInMHz|1|UINT32|0x0000001D
  gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicInterruptNum|0|UINT32|0x0000001E
  gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicBase|0|UINT32|0x0000002A
  gArmPlatformTokenSpaceGuid.PcdSP804TimerPerformanceBase|0|UINT32|0x0000002B
  gArmPlatformTokenSpaceGuid.PcdSP804TimerMetronomeBase|0|UINT32|0x0000002C

  ## SP805 Watchdog
  gArmPlatformTokenSpaceGuid.PcdSP805WatchdogBase|0x0|UINT32|0x00000023
  gArmPlatformTokenSpaceGuid.PcdSP805WatchdogClockFrequencyInHz|32000|UINT32|0x00000021

  ## PL011 UART
  gArmPlatformTokenSpaceGuid.PcdUartDefaultReceiveFifoDepth|0x00000000|UINT32|0x0000001F
  gArmPlatformTokenSpaceGuid.PcdUartDefaultTimeout|0x00000000|UINT32|0x00000020

  ## PL031 RealTimeClock
  gArmPlatformTokenSpaceGuid.PcdPL031RtcBase|0x0|UINT32|0x00000024
  gArmPlatformTokenSpaceGuid.PcdPL031RtcPpmAccuracy|300000000|UINT32|0x00000022

  ## PL061 GPIO
  gArmPlatformTokenSpaceGuid.PcdPL061GpioBase|0x0|UINT32|0x00000025
  
  ## PL111 Lcd
  gArmPlatformTokenSpaceGuid.PcdPL111LcdBase|0x0|UINT32|0x00000026
  gArmPlatformTokenSpaceGuid.PcdArmHdLcdBase|0x0|UINT32|0x00000027
  
  ## PL180 MCI
  gArmPlatformTokenSpaceGuid.PcdPL180SysMciRegAddress|0x00000000|UINT32|0x00000028
  gArmPlatformTokenSpaceGuid.PcdPL180MciBaseAddress|0x00000000|UINT32|0x00000029

  #
  # BDS - Boot Manager
  #
  gArmPlatformTokenSpaceGuid.PcdFirmwareVendor|"ARM Platform"|VOID*|0x00000019
  gArmPlatformTokenSpaceGuid.PcdDefaultBootDescription|L"Default Boot Device"|VOID*|0x0000000C
  gArmPlatformTokenSpaceGuid.PcdDefaultBootDevicePath|L""|VOID*|0x0000000D
  gArmPlatformTokenSpaceGuid.PcdDefaultBootInitrdPath|L""|VOID*|0x0000000E
  gArmPlatformTokenSpaceGuid.PcdDefaultBootArgument|""|VOID*|0x000000F
  # PcdDefaultBootType define the type of the binary pointed by PcdDefaultBootDevicePath: 
  #  - 0 = an EFI application
  #  - 1 = a Linux kernel with ATAG support
  #  - 2 = a Linux kernel with FDT support
  gArmPlatformTokenSpaceGuid.PcdDefaultBootType|0|UINT32|0x00000010
  gArmPlatformTokenSpaceGuid.PcdFdtDevicePath|L""|VOID*|0x00000011
  
  ## Timeout value for displaying progressing bar in before boot OS.
  #  According to UEFI 2.0 spec, the default TimeOut should be 0xffff.
  gArmPlatformTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x0000001A
  
  gArmPlatformTokenSpaceGuid.PcdDefaultConInPaths|L""|VOID*|0x0000001B
  gArmPlatformTokenSpaceGuid.PcdDefaultConOutPaths|L""|VOID*|0x0000001C
Commit	Line	Data
1d5d0ae9	1	#/** @file
	2	# Arm Versatile Express package.
	3	#
	4	# Copyright (c) 2011, ARM Limited. All rights reserved.
	5	#
	6	# This program and the accompanying materials
	7	# are licensed and made available under the terms and conditions of the BSD License
	8	# which accompanies this distribution. The full text of the license may be found at
	9	# http://opensource.org/licenses/bsd-license.php
	10	#
	11	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
	12	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
	13	#
	14	#**/
	15
	16	[Defines]
	17	DEC_SPECIFICATION = 0x00010005
	18	PACKAGE_NAME = ArmPlatformPkg
	19	PACKAGE_GUID = 3308e0a0-1d94-11e0-915c-0002a5d5c51b
	20	PACKAGE_VERSION = 0.1
	21
	22	################################################################################
	23	#
	24	# Include Section - list of Include Paths that are provided by this package.
	25	# Comments are used for Keywords and Module Types.
	26	#
	27	# Supported Module Types:
	28	# BASE SEC PEI_CORE PEIM DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER DXE_SAL_DRIVER UEFI_DRIVER UEFI_APPLICATION
	29	#
	30	################################################################################
	31	[Includes.common]
	32	Include # Root include for the package
	33
	34	[Guids.common]
	35	gArmPlatformTokenSpaceGuid = { 0x9c0aaed4, 0x74c5, 0x4043, { 0xb4, 0x17, 0xa3, 0x22, 0x38, 0x14, 0xce, 0x76 } }
d5e12da4	36	#
	37	# Following Guid must match FILE_GUID in MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
	38	#
	39	gVariableRuntimeDxeFileGuid = { 0xcbd2e4d5, 0x7068, 0x4ff5, { 0xb4, 0x62, 0x98, 0x22, 0xb4, 0xad, 0x8d, 0x60 } }
1d5d0ae9	40
1d5d0ae9	41	[PcdsFeatureFlag.common]
d6b5f236	42	# Set this PCD to TRUE to map NORFlash at 0x0. FALSE means the DRAM is mapped at 0x0.
d6b5f236	43	gArmPlatformTokenSpaceGuid.PcdNorFlashRemapping\|FALSE\|BOOLEAN\|0x00000012
a6caee65	44
	45	gArmPlatformTokenSpaceGuid.PcdStandalone\|TRUE\|BOOLEAN\|0x00000001
	46	gArmPlatformTokenSpaceGuid.PcdSystemMemoryInitializeInSec\|FALSE\|BOOLEAN\|0x00000002
	47	gArmPlatformTokenSpaceGuid.PcdSendSgiToBringUpSecondaryCores\|FALSE\|BOOLEAN\|0x00000004
	48
1d5d0ae9	49
1d5d0ae9	50	[PcdsFixedAtBuild.common]
d6b5f236	51	# These PCDs should be FeaturePcds. But we used these PCDs as an '#if' in an ASM file.
1d5d0ae9	52	# Using a FeaturePcd make a '(BOOLEAN) casting for its value which is not understood by the preprocessor.
d6b5f236	53	gArmPlatformTokenSpaceGuid.PcdMPCoreSupport\|0\|UINT32\|0x00000003
d269095b	54	gArmPlatformTokenSpaceGuid.PcdMPCoreMaxCores\|1\|UINT32\|0x0000002D
1d5d0ae9	55
1d5d0ae9	56	# Stack for CPU Cores in Secure Mode
d6b5f236	57	gArmPlatformTokenSpaceGuid.PcdCPUCoresSecStackBase\|0\|UINT32\|0x00000005
d6b5f236	58	gArmPlatformTokenSpaceGuid.PcdCPUCoreSecStackSize\|0\|UINT32\|0x00000006
1d5d0ae9	59
1d5d0ae9	60	# Stack for CPU Cores in Secure Monitor Mode
d6b5f236	61	gArmPlatformTokenSpaceGuid.PcdCPUCoresSecMonStackBase\|0\|UINT32\|0x00000007
d6b5f236	62	gArmPlatformTokenSpaceGuid.PcdCPUCoreSecMonStackSize\|0\|UINT32\|0x00000008
1d5d0ae9	63
1d5d0ae9	64	# Stack for CPU Cores in Non Secure Mode
d6b5f236	65	gArmPlatformTokenSpaceGuid.PcdCPUCoresNonSecStackBase\|0\|UINT32\|0x00000009
d6b5f236	66	gArmPlatformTokenSpaceGuid.PcdCPUCoresNonSecStackSize\|0\|UINT32\|0x0000000A
964680c1	67
	68	# Size of the region used by UEFI in permanent memory (Reserved 128MB by default)
	69	gArmPlatformTokenSpaceGuid.PcdSystemMemoryUefiRegionSize\|0x08000000\|UINT32\|0x00000015
	70
47a8e12f	71	# Size to reserve in the primary core stack for PEI Global Variables
	72	# = sizeof(UINTN) /* PcdPeiServicePtr or HobListPtr */
	73	gArmPlatformTokenSpaceGuid.PcdPeiGlobalVariableSize\|0x4\|UINT32\|0x00000016
	74	# PeiServicePtr and HobListPtr shares the same location in the PEI Global Variable list
	75	# PeiServicePtr is only valid with PEI Core and HobListPtr only when the PEI Core is skipped.
ca8afbca	76	gArmPlatformTokenSpaceGuid.PcdPeiServicePtrGlobalOffset\|0x0\|UINT32\|0x00000017
ca8afbca	77	gArmPlatformTokenSpaceGuid.PcdHobListPtrGlobalOffset\|0x0\|UINT32\|0x00000018
47a8e12f	78
ce9cc403	79	#
	80	# ARM Primecells
	81	#
5cc45b70	82
	83	## SP804 DualTimer
	84	gArmPlatformTokenSpaceGuid.PcdSP804TimerFrequencyInMHz\|1\|UINT32\|0x0000001D
	85	gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicInterruptNum\|0\|UINT32\|0x0000001E
	86	gArmPlatformTokenSpaceGuid.PcdSP804TimerPeriodicBase\|0\|UINT32\|0x0000002A
	87	gArmPlatformTokenSpaceGuid.PcdSP804TimerPerformanceBase\|0\|UINT32\|0x0000002B
	88	gArmPlatformTokenSpaceGuid.PcdSP804TimerMetronomeBase\|0\|UINT32\|0x0000002C
	89
	90	## SP805 Watchdog
	91	gArmPlatformTokenSpaceGuid.PcdSP805WatchdogBase\|0x0\|UINT32\|0x00000023
	92	gArmPlatformTokenSpaceGuid.PcdSP805WatchdogClockFrequencyInHz\|32000\|UINT32\|0x00000021
	93
	94	## PL011 UART
	95	gArmPlatformTokenSpaceGuid.PcdUartDefaultReceiveFifoDepth\|0x00000000\|UINT32\|0x0000001F
	96	gArmPlatformTokenSpaceGuid.PcdUartDefaultTimeout\|0x00000000\|UINT32\|0x00000020
	97
	98	## PL031 RealTimeClock
	99	gArmPlatformTokenSpaceGuid.PcdPL031RtcBase\|0x0\|UINT32\|0x00000024
	100	gArmPlatformTokenSpaceGuid.PcdPL031RtcPpmAccuracy\|300000000\|UINT32\|0x00000022
	101
	102	## PL061 GPIO
	103	gArmPlatformTokenSpaceGuid.PcdPL061GpioBase\|0x0\|UINT32\|0x00000025
	104
	105	## PL111 Lcd
	106	gArmPlatformTokenSpaceGuid.PcdPL111LcdBase\|0x0\|UINT32\|0x00000026
	107	gArmPlatformTokenSpaceGuid.PcdArmHdLcdBase\|0x0\|UINT32\|0x00000027
	108
	109	## PL180 MCI
	110	gArmPlatformTokenSpaceGuid.PcdPL180SysMciRegAddress\|0x00000000\|UINT32\|0x00000028
	111	gArmPlatformTokenSpaceGuid.PcdPL180MciBaseAddress\|0x00000000\|UINT32\|0x00000029
ce9cc403	112
ea46ebbe	113	#
	114	# BDS - Boot Manager
	115	#
	116	gArmPlatformTokenSpaceGuid.PcdFirmwareVendor\|"ARM Platform"\|VOID*\|0x00000019
fb42fffe	117	gArmPlatformTokenSpaceGuid.PcdDefaultBootDescription\|L"Default Boot Device"\|VOID*\|0x0000000C
ea46ebbe	118	gArmPlatformTokenSpaceGuid.PcdDefaultBootDevicePath\|L""\|VOID*\|0x0000000D
656416bc	119	gArmPlatformTokenSpaceGuid.PcdDefaultBootInitrdPath\|L""\|VOID*\|0x0000000E
ea46ebbe	120	gArmPlatformTokenSpaceGuid.PcdDefaultBootArgument\|""\|VOID*\|0x000000F
	121	# PcdDefaultBootType define the type of the binary pointed by PcdDefaultBootDevicePath:
	122	# - 0 = an EFI application
	123	# - 1 = a Linux kernel with ATAG support
	124	# - 2 = a Linux kernel with FDT support
	125	gArmPlatformTokenSpaceGuid.PcdDefaultBootType\|0\|UINT32\|0x00000010
	126	gArmPlatformTokenSpaceGuid.PcdFdtDevicePath\|L""\|VOID*\|0x00000011
	127
	128	## Timeout value for displaying progressing bar in before boot OS.
	129	# According to UEFI 2.0 spec, the default TimeOut should be 0xffff.
	130	gArmPlatformTokenSpaceGuid.PcdPlatformBootTimeOut\|0xffff\|UINT16\|0x0000001A
	131
	132	gArmPlatformTokenSpaceGuid.PcdDefaultConInPaths\|L""\|VOID*\|0x0000001B
	133	gArmPlatformTokenSpaceGuid.PcdDefaultConOutPaths\|L""\|VOID*\|0x0000001C
	134