[mirror_edk2.git] / EmulatorPkg / EmulatorPkg.dec

## @file\r
#\r
# This is the Emu Emulation Environment Platform\r
#\r
# Copyright (c) 2008 - 2022, Intel Corporation. All rights reserved.<BR>\r
# Portions copyright (c) 2011, Apple Inc. All rights reserved.\r
# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r
#\r
#    SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = EmulatorPkg\r
  PACKAGE_GUID                   = 36E48BD7-7D92-5A47-A2CD-513F072E3300\r
  PACKAGE_VERSION                = 0.1\r
\r
\r
[Includes]\r
  Include\r
\r
\r
[LibraryClasses]\r
  ThunkPpiList|Include/Library/ThunkPpiList.h\r
  ThunkProtocolList|Include/Library/ThunkProtocolList.h\r
  EmuThunkLib|Include/Library/EmuThunkLib.h\r
  KeyMap|Include/Library/KeyMapLib.h\r
  PpiListLib|Include/Library/PpiListLib.h\r
  SmbiosLib|Include/Library/SmbiosLib.h\r
  EmuMagicPageLib|Include/Library/EmuMagicPageLib.h\r
\r
[Protocols]\r
  gEmuThunkProtocolGuid          = { 0x5CF32E0B, 0x8EDF, 0x2E44, { 0x9C, 0xDA, 0x93, 0x20, 0x5E, 0x99, 0xEC, 0x1C } }\r
  gEmuIoThunkProtocolGuid        = { 0x453368F6, 0x7C85, 0x434A, { 0xA9, 0x8A, 0x72, 0xD1, 0xB7, 0xFF, 0xA9, 0x26 } }\r
  gEmuGraphicsWindowProtocolGuid = { 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }\r
  gEmuThreadThunkProtocolGuid    = { 0x3B1E4B7C, 0x09D8, 0x944F, { 0xA4, 0x08, 0x13, 0x09, 0xEB, 0x8B, 0x44, 0x27 } }\r
  gEmuBlockIoProtocolGuid        = { 0x6888A4AE, 0xAFCE, 0xE84B, { 0x91, 0x02, 0xF7, 0xB9, 0xDA, 0xE6, 0xA0, 0x30 } }\r
  gEmuSnpProtocolGuid            = { 0xFD5FBE54, 0x8C35, 0xB345, { 0x8A, 0x0F, 0x7A, 0xC8, 0xA5, 0xFD, 0x05, 0x21 } }\r
\r
[Ppis]\r
  gEmuThunkPpiGuid               = { 0xE113F896, 0x75CF, 0xF640, { 0x81, 0x7F, 0xC8, 0x5A, 0x79, 0xE8, 0xAE, 0x67 } }\r
\r
[Guids]\r
  gEmulatorPkgTokenSpaceGuid  = { 0x4F792E68, 0xE8C8, 0x794E, { 0xB1, 0xD8, 0x37, 0x03, 0xF3, 0xF2, 0xD5, 0xA5 } }\r
  gEmuSystemConfigGuid       = { 0xF8626165, 0x6CEB, 0x924A, { 0xBA, 0xFC, 0xF1, 0x3A, 0xB9, 0xD6, 0x57, 0x28 } }\r
  gEmuVirtualDisksGuid       = { 0xf2ba331a, 0x8985, 0x11db, { 0xa4, 0x06, 0x00, 0x40, 0xd0, 0x2b, 0x18, 0x35 } }\r
  gEmuPhysicalDisksGuid      = { 0xf2bdcc96, 0x8985, 0x11db, { 0x87, 0x19, 0x00, 0x40, 0xd0, 0x2b, 0x18, 0x35 } }\r
  gEmuRedfishServiceGuid     = { 0x3fb208ac, 0x2185, 0x498c, { 0xbf, 0x46, 0xdc, 0x23, 0xda, 0x58, 0x7b, 0x55 } }\r
\r
[PcdsFeatureFlag]\r
  ## If TRUE, if symbols only load on breakpoints and gdb entry\r
  gEmulatorPkgTokenSpaceGuid.PcdEmulatorLazyLoadSymbols|TRUE|BOOLEAN|0x00020000\r
\r
[PcdsFixedAtBuild]\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageVariableBase|0x0|UINT64|0x00001014\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageFtwSpareBase|0x0|UINT64|0x00001015\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageFtwWorkingBase|0x0|UINT64|0x00001016\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFdBaseAddress|0x0|UINT64|0x00001017\r
\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageEventLogBase|0x0|UINT64|0x0000100e\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageEventLogSize|0x0|UINT32|0x0000100f\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashFvRecoveryBase|0x0|UINT64|0x00001010\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFlashFvRecoverySize|0x0|UINT32|0x00001011\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareFdSize|0x0|UINT32|0x00001012\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareBlockSize|0|UINT32|0x00001013\r
\r
  ## Number of Application Processors (APs) in the system 0 means Uniprocessor mode\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuApCount|L"0"|VOID*|0x00001019\r
\r
  ## Magic page to implement PEI Services Table Pointer Lib\r
  gEmulatorPkgTokenSpaceGuid.PcdPeiServicesTablePage|0x1013000000|UINT64|0x0000101b\r
\r
  ## Size of the packet filter\r
  gEmulatorPkgTokenSpaceGuid.PcdNetworkPacketFilterSize|524288|UINT32|0x0000101c\r
\r
  ## Platform level Redfish Service control PCD\r
  # These PCDs are used to stop the Redfish sevice when secure boot is disabled\r
  # or exit boot service.\r
  gEmulatorPkgTokenSpaceGuid.PcdRedfishServieStopIfSecureBootDisabled|TRUE|BOOLEAN|0x00001020\r
  gEmulatorPkgTokenSpaceGuid.PcdRedfishServieStopIfExitbootService|TRUE|BOOLEAN|0x00001021\r
  ##\r
  # edk2 Redfish implementation on Emulator package is designed to access\r
  # to Redfish simulator.\r
  # https://github.com/DMTF/Redfish-Profile-Simulator\r
  # The user ID and password are fixed as below.\r
  gEmulatorPkgTokenSpaceGuid.PcdRedfishServieUserId|"admin"|VOID*|0x00001022\r
  gEmulatorPkgTokenSpaceGuid.PcdRedfishServiePassword|"pwd123456"|VOID*|0x00001023\r
  gEmulatorPkgTokenSpaceGuid.PcdPersistentMemorySize|0x4000000|UINT32|0x00001024\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule]\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuBootMode|1|UINT32|0x00001006\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareVolume|L"..\\Fv\\Fv_Recovery.fd"|VOID*|0x00001009\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuMemorySize|L"64!64"|VOID*|0x0000100c\r
\r
  #\r
  # filename[:[R|F][O|W]][:BlockSize]\r
  # filename can be a device node, like /dev/disk1\r
  # R - Removable Media F - Fixed Media\r
  # O - Write protected W - Writable\r
  #   Default is Fixed Media, Writable\r
  # For a file the default BlockSize is 512, and can be overridden via BlockSize,\r
  #  for example 2048 for an ISO CD image. The block size for a device comes from\r
  #  the device and is not configurable.\r
  # Device Size comes from file or device.\r
  # On Mac OS X you can use Disk Utility to create .dmg files and mount them like disks\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuVirtualDisk|L"disk.dmg:FW"|VOID*|0x00001001\r
\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuGop|L"GOP Window"|VOID*|0x00001018\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuFileSystem|L"."|VOID*|0x00001004\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuSerialPort|L"/dev/ttyS0"|VOID*|0x00001002\r
\r
  #\r
  # On Unix host, this is the network interface name on host system that will\r
  #  be used in UEFI.\r
  # On Win host, this is the network interface index number on Windows that\r
  #  will be used in UEFI. For example, string L"0" is the first network\r
  #  interface.\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuNetworkInterface|L"en0"|VOID*|0x0000100d\r
\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuCpuModel|L"Intel(R) Processor Model"|VOID*|0x00001007\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuCpuSpeed|L"3000"|VOID*|0x00001008\r
  gEmulatorPkgTokenSpaceGuid.PcdEmuMpServicesPollingInterval|0x100|UINT64|0x0000101a\r
\r
Commit	Line	Data
	1	## @file\r
	2	#\r
	3	# This is the Emu Emulation Environment Platform\r
	4	#\r
	5	# Copyright (c) 2008 - 2022, Intel Corporation. All rights reserved.<BR>\r
	6	# Portions copyright (c) 2011, Apple Inc. All rights reserved.\r
	7	# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r
	8	#\r
	9	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
	10	#\r
	11	##\r
	12	\r
	13	[Defines]\r
	14	DEC_SPECIFICATION = 0x00010005\r
	15	PACKAGE_NAME = EmulatorPkg\r
	16	PACKAGE_GUID = 36E48BD7-7D92-5A47-A2CD-513F072E3300\r
	17	PACKAGE_VERSION = 0.1\r
	18	\r
	19	\r
	20	[Includes]\r
	21	Include\r
	22	\r
	23	\r
	24	[LibraryClasses]\r
	25	ThunkPpiList\|Include/Library/ThunkPpiList.h\r
	26	ThunkProtocolList\|Include/Library/ThunkProtocolList.h\r
	27	EmuThunkLib\|Include/Library/EmuThunkLib.h\r
	28	KeyMap\|Include/Library/KeyMapLib.h\r
	29	PpiListLib\|Include/Library/PpiListLib.h\r
	30	SmbiosLib\|Include/Library/SmbiosLib.h\r
	31	EmuMagicPageLib\|Include/Library/EmuMagicPageLib.h\r
	32	\r
	33	[Protocols]\r
	34	gEmuThunkProtocolGuid = { 0x5CF32E0B, 0x8EDF, 0x2E44, { 0x9C, 0xDA, 0x93, 0x20, 0x5E, 0x99, 0xEC, 0x1C } }\r
	35	gEmuIoThunkProtocolGuid = { 0x453368F6, 0x7C85, 0x434A, { 0xA9, 0x8A, 0x72, 0xD1, 0xB7, 0xFF, 0xA9, 0x26 } }\r
	36	gEmuGraphicsWindowProtocolGuid = { 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }\r
	37	gEmuThreadThunkProtocolGuid = { 0x3B1E4B7C, 0x09D8, 0x944F, { 0xA4, 0x08, 0x13, 0x09, 0xEB, 0x8B, 0x44, 0x27 } }\r
	38	gEmuBlockIoProtocolGuid = { 0x6888A4AE, 0xAFCE, 0xE84B, { 0x91, 0x02, 0xF7, 0xB9, 0xDA, 0xE6, 0xA0, 0x30 } }\r
	39	gEmuSnpProtocolGuid = { 0xFD5FBE54, 0x8C35, 0xB345, { 0x8A, 0x0F, 0x7A, 0xC8, 0xA5, 0xFD, 0x05, 0x21 } }\r
	40	\r
	41	[Ppis]\r
	42	gEmuThunkPpiGuid = { 0xE113F896, 0x75CF, 0xF640, { 0x81, 0x7F, 0xC8, 0x5A, 0x79, 0xE8, 0xAE, 0x67 } }\r
	43	\r
	44	[Guids]\r
	45	gEmulatorPkgTokenSpaceGuid = { 0x4F792E68, 0xE8C8, 0x794E, { 0xB1, 0xD8, 0x37, 0x03, 0xF3, 0xF2, 0xD5, 0xA5 } }\r
	46	gEmuSystemConfigGuid = { 0xF8626165, 0x6CEB, 0x924A, { 0xBA, 0xFC, 0xF1, 0x3A, 0xB9, 0xD6, 0x57, 0x28 } }\r
	47	gEmuVirtualDisksGuid = { 0xf2ba331a, 0x8985, 0x11db, { 0xa4, 0x06, 0x00, 0x40, 0xd0, 0x2b, 0x18, 0x35 } }\r
	48	gEmuPhysicalDisksGuid = { 0xf2bdcc96, 0x8985, 0x11db, { 0x87, 0x19, 0x00, 0x40, 0xd0, 0x2b, 0x18, 0x35 } }\r
	49	gEmuRedfishServiceGuid = { 0x3fb208ac, 0x2185, 0x498c, { 0xbf, 0x46, 0xdc, 0x23, 0xda, 0x58, 0x7b, 0x55 } }\r
	50	\r
	51	[PcdsFeatureFlag]\r
	52	## If TRUE, if symbols only load on breakpoints and gdb entry\r
	53	gEmulatorPkgTokenSpaceGuid.PcdEmulatorLazyLoadSymbols\|TRUE\|BOOLEAN\|0x00020000\r
	54	\r
	55	[PcdsFixedAtBuild]\r
	56	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageVariableBase\|0x0\|UINT64\|0x00001014\r
	57	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageFtwSpareBase\|0x0\|UINT64\|0x00001015\r
	58	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageFtwWorkingBase\|0x0\|UINT64\|0x00001016\r
	59	gEmulatorPkgTokenSpaceGuid.PcdEmuFdBaseAddress\|0x0\|UINT64\|0x00001017\r
	60	\r
	61	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageEventLogBase\|0x0\|UINT64\|0x0000100e\r
	62	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashNvStorageEventLogSize\|0x0\|UINT32\|0x0000100f\r
	63	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashFvRecoveryBase\|0x0\|UINT64\|0x00001010\r
	64	gEmulatorPkgTokenSpaceGuid.PcdEmuFlashFvRecoverySize\|0x0\|UINT32\|0x00001011\r
	65	gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareFdSize\|0x0\|UINT32\|0x00001012\r
	66	gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareBlockSize\|0\|UINT32\|0x00001013\r
	67	\r
	68	## Number of Application Processors (APs) in the system 0 means Uniprocessor mode\r
	69	gEmulatorPkgTokenSpaceGuid.PcdEmuApCount\|L"0"\|VOID*\|0x00001019\r
	70	\r
	71	## Magic page to implement PEI Services Table Pointer Lib\r
	72	gEmulatorPkgTokenSpaceGuid.PcdPeiServicesTablePage\|0x1013000000\|UINT64\|0x0000101b\r
	73	\r
	74	## Size of the packet filter\r
	75	gEmulatorPkgTokenSpaceGuid.PcdNetworkPacketFilterSize\|524288\|UINT32\|0x0000101c\r
	76	\r
	77	## Platform level Redfish Service control PCD\r
	78	# These PCDs are used to stop the Redfish sevice when secure boot is disabled\r
	79	# or exit boot service.\r
	80	gEmulatorPkgTokenSpaceGuid.PcdRedfishServieStopIfSecureBootDisabled\|TRUE\|BOOLEAN\|0x00001020\r
	81	gEmulatorPkgTokenSpaceGuid.PcdRedfishServieStopIfExitbootService\|TRUE\|BOOLEAN\|0x00001021\r
	82	##\r
	83	# edk2 Redfish implementation on Emulator package is designed to access\r
	84	# to Redfish simulator.\r
	85	# https://github.com/DMTF/Redfish-Profile-Simulator\r
	86	# The user ID and password are fixed as below.\r
	87	gEmulatorPkgTokenSpaceGuid.PcdRedfishServieUserId\|"admin"\|VOID*\|0x00001022\r
	88	gEmulatorPkgTokenSpaceGuid.PcdRedfishServiePassword\|"pwd123456"\|VOID*\|0x00001023\r
	89	gEmulatorPkgTokenSpaceGuid.PcdPersistentMemorySize\|0x4000000\|UINT32\|0x00001024\r
	90	\r
	91	[PcdsFixedAtBuild, PcdsPatchableInModule]\r
	92	gEmulatorPkgTokenSpaceGuid.PcdEmuBootMode\|1\|UINT32\|0x00001006\r
	93	gEmulatorPkgTokenSpaceGuid.PcdEmuFirmwareVolume\|L"..\\Fv\\Fv_Recovery.fd"\|VOID*\|0x00001009\r
	94	gEmulatorPkgTokenSpaceGuid.PcdEmuMemorySize\|L"64!64"\|VOID*\|0x0000100c\r
	95	\r
	96	#\r
	97	# filename[:[R\|F][O\|W]][:BlockSize]\r
	98	# filename can be a device node, like /dev/disk1\r
	99	# R - Removable Media F - Fixed Media\r
	100	# O - Write protected W - Writable\r
	101	# Default is Fixed Media, Writable\r
	102	# For a file the default BlockSize is 512, and can be overridden via BlockSize,\r
	103	# for example 2048 for an ISO CD image. The block size for a device comes from\r
	104	# the device and is not configurable.\r
	105	# Device Size comes from file or device.\r
	106	# On Mac OS X you can use Disk Utility to create .dmg files and mount them like disks\r
	107	gEmulatorPkgTokenSpaceGuid.PcdEmuVirtualDisk\|L"disk.dmg:FW"\|VOID*\|0x00001001\r
	108	\r
	109	gEmulatorPkgTokenSpaceGuid.PcdEmuGop\|L"GOP Window"\|VOID*\|0x00001018\r
	110	gEmulatorPkgTokenSpaceGuid.PcdEmuFileSystem\|L"."\|VOID*\|0x00001004\r
	111	gEmulatorPkgTokenSpaceGuid.PcdEmuSerialPort\|L"/dev/ttyS0"\|VOID*\|0x00001002\r
	112	\r
	113	#\r
	114	# On Unix host, this is the network interface name on host system that will\r
	115	# be used in UEFI.\r
	116	# On Win host, this is the network interface index number on Windows that\r
	117	# will be used in UEFI. For example, string L"0" is the first network\r
	118	# interface.\r
	119	gEmulatorPkgTokenSpaceGuid.PcdEmuNetworkInterface\|L"en0"\|VOID*\|0x0000100d\r
	120	\r
	121	gEmulatorPkgTokenSpaceGuid.PcdEmuCpuModel\|L"Intel(R) Processor Model"\|VOID*\|0x00001007\r
	122	gEmulatorPkgTokenSpaceGuid.PcdEmuCpuSpeed\|L"3000"\|VOID*\|0x00001008\r
	123	gEmulatorPkgTokenSpaceGuid.PcdEmuMpServicesPollingInterval\|0x100\|UINT64\|0x0000101a\r
	124	\r