Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.dec

##  @file  MdeModulePkg.dec\r
#\r
# This package provides the modules that conform to EFI/PI Industry standards.\r
# It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes) \r
# and libraries instances, which are used for those modules.\r
#\r
# Copyright (c) 2007 - 2009, Intel Corporation.\r
#\r
# All rights reserved.\r
# This program and the accompanying materials are licensed and made available under\r
# the terms and conditions of the BSD License which accompanies this distribution.\r
# The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
##\r
\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = MdeModulePkg\r
  PACKAGE_GUID                   = BA0D78D6-2CAF-414b-BD4D-B6762A894288\r
  PACKAGE_VERSION                = 0.1\r
\r
[Includes.common]\r
  Include\r
\r
\r
[LibraryClasses.common]\r
  ##  @libraryclass  IpIo layer upon EFI IP4 Protocol.\r
  #   This library is only intended to be used by UEFI network stack modules.\r
  IpIoLib|Include/Library/IpIoLib.h\r
  \r
  ##  @libraryclass  Basic function for UEFI network stack.\r
  #   This library is only intended to be used by UEFI network stack modules.\r
  NetLib|Include/Library/NetLib.h\r
  \r
  ##  @libraryclass  The helper routines to access UDP service.\r
  #   This library is only intended to be used by UEFI network stack modules.\r
  UdpIoLib|Include/Library/UdpIoLib.h\r
  \r
  ##  @libraryclass  Defines a set of methods to reset whole system.\r
  ResetSystemLib|Include/Library/ResetSystemLib.h\r
\r
  ##  @libraryclass  Defines a set of methods related do S3 mode.\r
  S3Lib|Include/Library/S3Lib.h\r
  \r
  ##  @libraryclass  Defines a set of methods related recovery mode.\r
  RecoveryLib|Include/Library/RecoveryLib.h\r
  \r
  ##  @libraryclass  Provides HII related functions.\r
  HiiLib|Include/Library/HiiLib.h\r
    \r
  ##  @libraryclass  Defines a set of interfaces on how to process capusle image update.\r
  CapsuleLib|Include/Library/CapsuleLib.h\r
  \r
  ##  @libraryclass  Library for Deferred Procedure Calls.\r
  DpcLib|Include/Library/DpcLib.h\r
\r
  ##  @libraryclass    Provides global variables that are pointers \r
  ##  to the UEFI HII related protocols. \r
  ##\r
  UefiHiiServicesLib|Include/Library/UefiHiiServicesLib.h\r
\r
[Guids.common]\r
  ## MdeModule package token space guid\r
  ## Include/Guid/MdeModulePkgTokenSpace.h\r
  gEfiMdeModulePkgTokenSpaceGuid       = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}\r
\r
  ## Hob guid for Pcd DataBase\r
  ## Include/Guid/PcdDataBaseHobGuid.h\r
  gPcdDataBaseHobGuid            = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }}\r
  \r
  ## Guid for EDKII implementation GUIDed opcodes\r
  #  Include/Guid/MdeModuleHii.h\r
  gEfiIfrTianoGuid      = { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce }}\r
  \r
  ## Guid for Framework vfr GUIDed opcodes.\r
  #  Include/Guid/MdeModuleHii.h\r
  gEfiIfrFrameworkGuid  = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }}\r
  \r
  ## Guid to specify the System Non Volatile FV\r
  ## Include/Guid/SystemNvDataGuid.h\r
  gEfiSystemNvDataFvGuid         = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}\r
  \r
  ## Guid specify the device is the console out device.\r
  ## Include/Guid/ConsoleOutDevice.h\r
  gEfiConsoleOutDeviceGuid       = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}\r
\r
  ## Guid specify the device is the console in device.\r
  ## Include/Guid/ConsoleInDevice.h\r
  gEfiConsoleInDeviceGuid        = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}\r
  \r
  ## Hob and Variable guid specify the platform memory type information.\r
  ## Include/Guid/MemoryTypeInformation.h\r
  gEfiMemoryTypeInformationGuid  = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }}\r
  \r
  ## Capsule update hob and variable guid\r
  ## Include/Guid/CapsuleVendor.h\r
  gEfiCapsuleVendorGuid          = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }}\r
  \r
  ## Guid specifiy the device is the StdErr device.\r
  ## Include/Guid/StandardErrorDevice.h\r
  gEfiStandardErrorDeviceGuid    = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}\r
  \r
  ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table.\r
  ## Include/Guid/VariableFormat.h\r
  gEfiVariableGuid           = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}\r
  \r
  ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID\r
  ## Include/Guid/Performance.h\r
  gPerformanceProtocolGuid       = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}\r
\r
  ## Guid is defined for CRC32 encapsulation scheme.\r
  ## Include/Guid/Crc32GuidedSectionExtraction.h\r
  gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
\r
  ## Include/Guid/NicIp4ConfigNvData.h\r
  gEfiNicIp4ConfigVariableGuid   = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}\r
\r
[Protocols.common] \r
  ## Load File protocol provides capability to load and unload EFI image into memory and execute it.\r
  ## Include/Protocol/LoadPe32Image.h\r
  ## This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image.\r
  ## If developer need implement such functionality, they should use BasePeCoffLib.\r
  gEfiLoadPeImageProtocolGuid    = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}\r
  \r
  ## Print protocol defines basic print functions to print the format unicode and ascii string.\r
  ## Include/Protocol/Print2.h\r
  gEfiPrint2ProtocolGuid          = { 0xf05976ef, 0x83f1, 0x4f3d, { 0x86, 0x19, 0xf7, 0x59, 0x5d, 0x41, 0xe5, 0x38 } }\r
\r
  ## This protocol defines the generic memory test interfaces in Dxe phase.\r
  ## Include/Protocol/GenericMemoryTest.h\r
  gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}\r
  \r
  ## Include/Protocol/Dpc.h\r
  gEfiDpcProtocolGuid            = {0x480f8ae9, 0xc46, 0x4aa9,  { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}\r
  \r
  ## Fault Tolerant Write protocol provides boot-time service to do fault tolerant write capability for block devices.\r
  #  Include/Protocol/FaultTolerantWrite.h\r
  gEfiFaultTolerantWriteProtocolGuid = { 0x3EBD9E82, 0x2C78, 0x4DE6, { 0x97, 0x86, 0x8D, 0x4B, 0xFC, 0xB7, 0xC8, 0x81 }}\r
  \r
  ## This protocol is used to abstract the swap operation of boot block and backup block of boot FV.\r
  #  Include/Protocol/SwapAddressRange.h\r
  gEfiSwapAddressRangeProtocolGuid = { 0x1259F60D, 0xB754, 0x468E, { 0xA7, 0x89, 0x4D, 0xB8, 0x5D, 0x55, 0xE8, 0x7E }}\r
  \r
[PcdsFeatureFlag]\r
  ## Indicate whether platform can support update capsule across a system reset\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d\r
 \r
  ## This feature flag can be used to enable or disable all PCD PEIM services.\r
  #  If TRUE, all PCD PPI services will be produced.\r
  ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020\r
\r
  ## If TRUE, then the Device Path To Text Protocol should be produced by the platform.\r
  #  It can be disabled to save size.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathToText|TRUE|BOOLEAN|0x00010037\r
  \r
  ## If TRUE, then the Device Path From Text Protocol should be produced by the platform.\r
  #  It can be disabled to save size.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathFromText|TRUE|BOOLEAN|0x00010038\r
    \r
  ## If TRUE, enable the statistic functionality about variable usage. Such information is\r
  #  stored as a vendor configuration table into the EFI system table.\r
  #  If user wants to use VariableInfo application in MdeModulePkg\Application directory to get\r
  #  variable usage info, this pcd should be set as TRUE. Otherwise VariableInfo application can \r
  #  not output useful info.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics|FALSE|BOOLEAN|0x0001003f\r
  \r
  ## If TRUE, Unicode Collation Protocol will be installed.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollationSupport|TRUE|BOOLEAN|0x00010040\r
  \r
  ## If TRUE, Unicode Collation 2 Protocol will be installed.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollation2Support|TRUE|BOOLEAN|0x00010041\r
  \r
  ## If TRUE, Graphics Output Protocol will be installed on virtual handle created by ConsplitterDxe.\r
  #  It could be set FALSE to save size.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport|TRUE|BOOLEAN|0x00010042\r
  \r
  ## If TRUE, UGA Draw Protocol will be installed on virtual handle created by ConsplitterDxe.\r
  #  It could be set FALSE to save size.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport|TRUE|BOOLEAN|0x00010043\r
  \r
  ## If TRUE, when PeiCore dispatches a PEI module, PeiCore will first search TE section from this PEIM to load the image.\r
  #  If TE section is not found, then PeiCore will search PE section.\r
  #  If FALSE, PeiCore will first search PE section from PEIM to load the image.\r
  #  This PCD is used to tune Pei phase performance to reduce the search image time.\r
  #  It can be set according to the generated image section type.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst|TRUE|BOOLEAN|0x00010044\r
  \r
  ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI\r
  #  interrupt to access usb device in the case of absence of usb stack.\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047\r
\r
  ## If TRUE, HiiImageProtocol will be installed.\r
  #  FALSE is for size reduction.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100\r
  \r
  ## If TRUE, USB KeyBoard Driver disables the default keyboard layout.\r
  #  The default keyboard layout serves as the backup when no keyboard layout can be retrieved\r
  #  from HII database.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200\r
\r
  ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler. \r
  #  If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.\r
  ## This is used to provide backward compatibility support to Framework HII and Framework FvHob.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009\r
  \r
  ##\r
  #  If TRUE, HelloWorld Application will print the verbose information.\r
  #  This PCD is a sample to explain FeatureFlag PCD usage.\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a\r
\r
  ##\r
  #  If TRUE, FULL FTW protocol services (total six APIs) will be produced.\r
  #  If FASLE, only FTW Write service is available.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200b\r
\r
  ##\r
  #  If TRUE, DXE IPL must support the UEFI decompression algorithm.\r
  #  If FALSE, DXE IPL will not support UEFI decompression to save space.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportUefiDecompress|TRUE|BOOLEAN|0x0001200c\r
\r
[PcdsFeatureFlag.IA32]\r
  ## \r
  # This feature flag specifies whether DxeIpl switches to long mode to enter DXE phase.\r
  # If it is TRUE, DxeIpl will load a 64-bit DxeCore and switch to long mode to hand over to DxeCore;\r
  # otherwise, DxeIpl will load a 32-bit DxeCore and perform stack switch to hand over to DxeCore.\r
  # It is assumed that 64-bit DxeCore is built in firmware if it is true; otherwise 32-bit DxeCore\r
  # is built in firmware.\r
  #\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b\r
\r
[PcdsFixedAtBuild]\r
  ## Dynamic type PCD can be registered callback function for Pcd setting action.\r
  #  PcdMaxPeiPcdCallBackNumberPerPcdEntry indicate maximum number of callback function\r
  #  for a dynamic PCD used in PEI phase.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPcdCallBackNumberPerPcdEntry|0x08|UINT32|0x0001000f\r
\r
  ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress\r
  #  to store PCD value. \r
  #\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdVpdBaseAddress|0x0|UINT32|0x00010010\r
    \r
  ## Maximum number of FV is supported by PeiCore's dispatching.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxFvSupported|6|UINT32|0x00010030\r
\r
  ## Maximum PEIM count in every FV is supported by PeiCore's dispatching.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeimPerFv|32|UINT32|0x00010031\r
\r
  ## Maximum stack size for PeiCore.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeiStackSize|0x20000|UINT32|0x00010032\r
\r
  ## Maximum PPI count is supported by PeiCore's PPI database.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033\r
  \r
  ## Size of the NV variable range. Note that this value should less than or equal to PcdFlashNvStorageFtwSpareSize\r
  # The root cause is that variable driver will use FTW protocol to reclaim variable region.\r
  # If the length of variable region is larger than FTW spare size, it means the whole variable region can not\r
  # be reflushed through the manner of fault tolerant write. \r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002\r
  \r
  ## The maximum size of single common variable, that is non-HwErr type varible.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003\r
  \r
  ## The maximum size of single hardware error record variable.\r
  # In IA32/X64 platforms, this value should be larger than 1KB.\r
  # In IA64 platforms, this value should be larger than 128KB.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004\r
  \r
  ## The size of reserved HwErr variable space. This space is located at NV variable range.\r
  # HwErr type variable is stored with common non-volatile variables in NV region.\r
  # this value is used to guarantee the space of HwErr type variable and not populated by common variable.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize|0x8000|UINT32|0x30000006\r
\r
  ## The size of volatile buffer. This buffer is used to store VOLATILE attribute variable.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize|0x10000|UINT32|0x30000005\r
\r
  ## Size of the FTW spare block range. Note that this value should larger than PcdFlashNvStorageVariableSize\r
  # The root cause is that variable driver will use FTW protocol to reclaim variable region.\r
  # If the length of variable region is larger than FTW spare size, it means the whole variable region can not\r
  # be reflushed through the manner of fault tolerant write.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x0|UINT32|0x30000014\r
    \r
  ## Size of the FTW working block range.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize|0x0|UINT32|0x30000011\r
\r
  ## FFS filename to find the ACPI tables\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile|{ 0x25, 0x4e, 0x37, 0x7e, 0x01, 0x8e, 0xee, 0x4f, 0x87, 0xf2, 0x39, 0xc, 0x23, 0xc6, 0x6, 0xcd }|VOID*|16\r
\r
[PcdsFixedAtBuild,PcdsPatchableInModule]\r
  ## Maximun number of performance log entries during PEI phase.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f\r
\r
  ## RTC Update Timeout Value\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034\r
  \r
[PcdsPatchableInModule,PcdsDynamic]\r
  ##\r
  #  This PCD defines the Console output column and the default value is 25 according to UEFI spec\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006\r
  \r
  ##\r
  #  This PCD defines the Console output row and the default value is 80 according to UEFI spec\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007\r
  \r
[PcdsFixedAtBuild,PcdsDynamic]\r
  ## Base address of the NV variable range in flash device \r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase|0x0|UINT32|0x30000001\r
  \r
  ## Base address of the FTW spare block range in flash device.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x0|UINT32|0x30000013 \r
  \r
  ## Base address of the FTW working block range in flash device.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010 \r
  \r
  ##\r
  #  This PCD defines the print string.\r
  #  This PCD is a sample to explain String typed PCD usage.\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004 \r
  \r
[PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]\r
  ##\r
  #  This PCD defines the times to print hello world string.\r
  #  This PCD is a sample to explain FixedAtBuild UINT32 PCD usage.\r
  ##\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005\r
\r
  ## Indicate the max size of the populated capsule image that the platform can support.\r
  #  The default max size is 100MB (0x6400000) for more than one large capsule images. \r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizePopulateCapsule|0x6400000|UINT32|0x0001001e\r
  \r
  ## Indicate the max size of the non-populated capsule image that the platform can support.\r
  #  The default max size is 10MB (0xa00000) for the casule image without populated flag setting.\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizeNonPopulateCapsule|0xa00000|UINT32|0x0001001f\r