MdeModulePkg/MdeModulePkg.dec

   1 ##  @file  MdeModulePkg.dec
   2 #
   3 # This package provides the modules that conform to EFI/PI Industry standards.
   4 # It also provides the defintions(including PPIs/PROTOCOLs/GUIDs and library classes)
   5 # and libraries instances, which are used for those modules.
   6 #
   7 # Copyright (c) 2007 - 2009, Intel Corporation.
   8 #
   9 # All rights reserved.
  10 # This program and the accompanying materials are licensed and made available under
  11 # the terms and conditions of the BSD License which accompanies this distribution.
  12 # The full text of the license may be found at
  13 # http://opensource.org/licenses/bsd-license.php
  14 #
  15 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  16 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  17 #
  18 ##
  19
  20
  21 [Defines]
  22   DEC_SPECIFICATION              = 0x00010005
  23   PACKAGE_NAME                   = MdeModulePkg
  24   PACKAGE_GUID                   = BA0D78D6-2CAF-414b-BD4D-B6762A894288
  25   PACKAGE_VERSION                = 0.1
  26
  27 [Includes.common]
  28   Include
  29
  30
  31 [LibraryClasses.common]
  32   ##  @libraryclass  IpIo layer upon EFI IP4 Protocol.
  33   #   This library is only intended to be used by UEFI network stack modules.
  34   IpIoLib|Include/Library/IpIoLib.h
  35
  36   ##  @libraryclass  Basic function for UEFI network stack.
  37   #   This library is only intended to be used by UEFI network stack modules.
  38   NetLib|Include/Library/NetLib.h
  39
  40   ##  @libraryclass  The helper routines to access UDP service.
  41   #   This library is only intended to be used by UEFI network stack modules.
  42   UdpIoLib|Include/Library/UdpIoLib.h
  43
  44   ##  @libraryclass  Defines a set of methods to reset whole system.
  45   ResetSystemLib|Include/Library/ResetSystemLib.h
  46
  47   ##  @libraryclass  Defines a set of methods related do S3 mode.
  48   S3Lib|Include/Library/S3Lib.h
  49
  50   ##  @libraryclass  Defines a set of methods related recovery mode.
  51   RecoveryLib|Include/Library/RecoveryLib.h
  52
  53   ##  @libraryclass  Basic platform driver override functions.
  54   #   This library is only intended to be used by Platform Driver Override Dxe Driver and Application.
  55   PlatformDriverOverrideLib|Include/Library/PlatformDriverOverrideLib.h
  56
  57   ##  @libraryclass  Provides HII related functions.
  58   HiiLib|Include/Library/HiiLib.h
  59
  60   ##  @libraryclass  Defines a set of interfaces on how to process capusle image update.
  61   CapsuleLib|Include/Library/CapsuleLib.h
  62
  63   ##  @libraryclass  Library for Deferred Procedure Calls.
  64   DpcLib|Include/Library/DpcLib.h
  65
  66   ##  @libraryclass  Provides APIs for system memory test.
  67   ##
  68   MemoryTestLib|Include/Library/MemoryTestLib.h
  69
  70   ##  @libraryclass  Provides APIs for HII related functions.
  71   ##
  72   NewHiiLib|MdeModulePkg/Include/Library/NewHiiLib.h
  73
  74   ##  @libraryclass    Provides global variables that are pointers
  75   ##  to the UEFI HII related protocols.
  76   ##
  77   UefiHiiServicesLib|MdeModulePkg/Include/Library/UefiHiiServicesLib.h
  78
  79 [Guids.common]
  80   ## MdeModule package token space guid
  81   ## Include/Guid/MdeModulePkgTokenSpace.h
  82   gEfiMdeModulePkgTokenSpaceGuid       = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}
  83
  84   ## Hob guid for Pcd DataBase
  85   ## Include/Guid/PcdDataBaseHobGuid.h
  86   gPcdDataBaseHobGuid            = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }}
  87
  88   ## Guid for EDKII implementation GUIDed opcodes
  89   #  Include/Guid/MdeModuleHii.h
  90   gEfiIfrTianoGuid      = { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce }}
  91
  92   ## Guid for Framework vfr GUIDed opcodes.
  93   #  Include/Guid/MdeModuleHii.h
  94   gEfiIfrFrameworkGuid  = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }}
  95
  96   ## Guid to specify the System Non Volatile FV
  97   ## Include/Guid/SystemNvDataGuid.h
  98   gEfiSystemNvDataFvGuid         = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }}
  99
 100   ## Guid specify the device is the console out device.
 101   ## Include/Guid/ConsoleOutDevice.h
 102   gEfiConsoleOutDeviceGuid       = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
 103
 104   ## Guid specify the device is the console in device.
 105   ## Include/Guid/ConsoleInDevice.h
 106   gEfiConsoleInDeviceGuid        = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
 107
 108   ## Hob and Variable guid specify the platform memory type information.
 109   ## Include/Guid/MemoryTypeInformation.h
 110   gEfiMemoryTypeInformationGuid  = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }}
 111
 112   ## Capsule update hob and variable guid
 113   ## Include/Guid/CapsuleVendor.h
 114   gEfiCapsuleVendorGuid          = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }}
 115
 116   ## Guid specifiy the device is the StdErr device.
 117   ## Include/Guid/StandardErrorDevice.h
 118   gEfiStandardErrorDeviceGuid    = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}
 119
 120   ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table.
 121   ## Include/Guid/VariableFormat.h
 122   gEfiVariableGuid           = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}
 123
 124   ## Platform Override Variable guid
 125   ## Include/Guid/OverrideVariable.h
 126   gEfiOverrideVariableGuid       = { 0x8e3d4ad5, 0xf762, 0x438a, { 0xa1, 0xc1, 0x5b, 0x9f, 0xe6, 0x8c, 0x6b, 0x15 }}
 127
 128   ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID
 129   ## Include/Guid/Performance.h
 130   gPerformanceProtocolGuid       = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}
 131
 132   ## Guid is defined for CRC32 encapsulation scheme.
 133   ## Include/Guid/Crc32GuidedSectionExtraction.h
 134   gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }
 135
 136 [Protocols.common]
 137   ## Load File protocol provides capability to load and unload EFI image into memory and execute it.
 138   ## Include/Protocol/LoadPe32Image.h
 139   ## This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image.
 140   ## If developer need implement such functionality, they should use BasePeCoffLib.
 141   gEfiLoadPeImageProtocolGuid    = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}
 142
 143   ## Print protocol defines six basic print functions to print the format unicode and ascii string.
 144   ## Include/Protocol/Print2.h
 145   gEfiPrint2ProtocolGuid          = { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0x0c, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0x0c }}
 146
 147   ## This protocol defines the generic memory test interfaces in Dxe phase.
 148   ## Include/Protocol/GenericMemoryTest.h
 149   gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}
 150
 151   ## Include/Protocol/NicIp4Config.h
 152   gEfiNicIp4ConfigProtocolGuid   = {0xdca3d4d, 0x12da, 0x4728,  { 0xbf, 0x7e, 0x86, 0xce, 0xb9, 0x28, 0xd0, 0x67 }}
 153
 154   ## Include/Protocol/NicIp4Config.h
 155   gEfiNicIp4ConfigVariableGuid   = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}
 156
 157   ## Include/Protocol/Dpc.h
 158   gEfiDpcProtocolGuid            = {0x480f8ae9, 0xc46, 0x4aa9,  { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}
 159
 160   ## Fault Tolerant Write protocol provides boot-time service to do fault tolerant write capability for block devices.
 161   #  Include/Protocol/FaultTolerantWrite.h
 162   gEfiFaultTolerantWriteProtocolGuid = { 0x3EBD9E82, 0x2C78, 0x4DE6, { 0x97, 0x86, 0x8D, 0x4B, 0xFC, 0xB7, 0xC8, 0x81 }}
 163
 164   ## This protocol is used to abstract the swap operation of boot block and backup block of boot FV.
 165   #  Include/Protocol/SwapAddressRange.h
 166   gEfiSwapAddressRangeProtocolGuid = { 0x1259F60D, 0xB754, 0x468E, { 0xA7, 0x89, 0x4D, 0xB8, 0x5D, 0x55, 0xE8, 0x7E }}
 167
 168 [PcdsFeatureFlag]
 169   ## Indicate whether platform can support update capsule across a system reset
 170   gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d
 171
 172   ## This feature flag can be used to enable or disable all PCD PEIM services.
 173   #  If TRUE, all PCD PPI services will be produced.
 174   ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced.
 175   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020
 176
 177   ## If TRUE, then the Device Path To Text Protocol should be produced by the platform.
 178   #  It can be disabled to save size.
 179   gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathToText|TRUE|BOOLEAN|0x00010037
 180
 181   ## If TRUE, then the Device Path From Text Protocol should be produced by the platform.
 182   #  It can be disabled to save size.
 183   gEfiMdeModulePkgTokenSpaceGuid.PcdDevicePathSupportDevicePathFromText|TRUE|BOOLEAN|0x00010038
 184
 185   ## If TRUE, enable the statistic functionality about variable usage. Such information is
 186   #  stored as a vendor configuration table into the EFI system table.
 187   #  If user wants to get variable usage info, this pcd should be set as TRUE.
 188   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics|FALSE|BOOLEAN|0x0001003f
 189
 190   ## If TRUE, Unicode Collation Protocol will be installed.
 191   gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollationSupport|TRUE|BOOLEAN|0x00010040
 192
 193   ## If TRUE, Unicode Collation 2 Protocol will be installed.
 194   gEfiMdeModulePkgTokenSpaceGuid.PcdUnicodeCollation2Support|TRUE|BOOLEAN|0x00010041
 195
 196   ## If TRUE, Graphics Output Protocol will be installed on virtual handle created by ConsplitterDxe.
 197   #  It could be set FALSE to save size.
 198   gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport|TRUE|BOOLEAN|0x00010042
 199
 200   ## If TRUE, UGA Draw Protocol will be installed on virtual handle created by ConsplitterDxe.
 201   #  It could be set FALSE to save size.
 202   gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport|TRUE|BOOLEAN|0x00010043
 203
 204   ## If TRUE, when PeiCore dispatches a PEI module, PeiCore will first search TE section from this PEIM to load the image.
 205   #  If TE section is not found, then PeiCore will search PE section.
 206   #  If FALSE, PeiCore will first search PE section from PEIM to load the image.
 207   #  This PCD is used to tune Pei phase performance to reduce the search image time.
 208   #  It can be set according to the generated image section type.
 209   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreImageLoaderSearchTeSectionFirst|TRUE|BOOLEAN|0x00010044
 210
 211   ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI
 212   #  interrupt to access usb device in the case of absence of usb stack.
 213   ##
 214   gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047
 215
 216   ## If TRUE, HiiImageProtocol will be installed.
 217   #  FALSE is for size reduction.
 218   gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100
 219
 220   ## If TRUE, USB KeyBoard Driver disables the default keyboard layout.
 221   #  The default keyboard layout serves as the backup when no keyboard layout can be retrieved
 222   #  from HII database.
 223   gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200
 224
 225   ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler.
 226   #  If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.
 227   ## This is used to provide backward compatibility support to Framework HII and Framework FvHob.
 228   gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009
 229
 230   ##
 231   #  If TRUE, HelloWorld Application will print the verbose information.
 232   #  This PCD is a sample to explain FeatureFlag PCD usage.
 233   ##
 234   gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a
 235
 236   ##
 237   #  If TRUE, FULL FTW protocol services (total six APIs) will be produced.
 238   #  If FASLE, only FTW Write service is available.
 239   gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200a
 240
 241 [PcdsFeatureFlag.IA32]
 242   ##
 243   # This feature flag specifies whether DxeIpl switches to long mode to enter DXE phase.
 244   # If it is TRUE, DxeIpl will load a 64-bit DxeCore and switch to long mode to hand over to DxeCore;
 245   # otherwise, DxeIpl will load a 32-bit DxeCore and perform stack switch to hand over to DxeCore.
 246   # It is assumed that 64-bit DxeCore is built in firmware if it is true; otherwise 32-bit DxeCore
 247   # is built in firmware.
 248   #
 249   gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b
 250
 251 [PcdsFixedAtBuild]
 252   ## Dynamic type PCD can be registered callback function for Pcd setting action.
 253   #  PcdMaxPeiPcdCallBackNumberPerPcdEntry indicate maximum number of callback function
 254   #  for a dynamic PCD used in PEI phase.
 255   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPcdCallBackNumberPerPcdEntry|0x08|UINT32|0x0001000f
 256
 257   ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress
 258   #  to store PCD value.
 259   #
 260   gEfiMdeModulePkgTokenSpaceGuid.PcdVpdBaseAddress|0x0|UINT32|0x00010010
 261
 262   ## Maximum number of FV is supported by PeiCore's dispatching.
 263   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxFvSupported|6|UINT32|0x00010030
 264
 265   ## Maximum PEIM count in every FV is supported by PeiCore's dispatching.
 266   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeimPerFv|32|UINT32|0x00010031
 267
 268   ## Maximum stack size for PeiCore.
 269   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPeiStackSize|0x20000|UINT32|0x00010032
 270
 271   ## Maximum PPI count is supported by PeiCore's PPI database.
 272   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033
 273
 274   ## Size of the NV variable range. Note that this value should less than or equal to PcdFlashNvStorageFtwSpareSize
 275   # The root cause is that variable driver will use FTW protocol to reclaim variable region.
 276   # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
 277   # be reflushed through the manner of fault tolerant write.
 278   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002
 279
 280   ## The maximum size of single common variable, that is non-HwErr type varible.
 281   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003
 282
 283   ## The maximum size of single hardware error record variable.
 284   # In IA32/X64 platforms, this value should be larger than 1KB.
 285   # In IA64 platforms, this value should be larger than 128KB.
 286   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004
 287
 288   ## The size of reserved HwErr variable space. This space is located at NV variable range.
 289   # HwErr type variable is stored with common non-volatile variables in NV region.
 290   # this value is used to guarantee the space of HwErr type variable and not populated by common variable.
 291   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize|0x8000|UINT32|0x30000006
 292
 293   ## The size of volatile buffer. This buffer is used to store VOLATILE attribute variable.
 294   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize|0x10000|UINT32|0x30000005
 295
 296   ## Size of the FTW spare block range. Note that this value should larger than PcdFlashNvStorageVariableSize
 297   # The root cause is that variable driver will use FTW protocol to reclaim variable region.
 298   # If the length of variable region is larger than FTW spare size, it means the whole variable region can not
 299   # be reflushed through the manner of fault tolerant write.
 300   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize|0x0|UINT32|0x30000014
 301
 302   ## Size of the FTW working block range.
 303   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize|0x0|UINT32|0x30000011
 304
 305   ## FFS filename to find the ACPI tables
 306   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile|{ 0x25, 0x4e, 0x37, 0x7e, 0x01, 0x8e, 0xee, 0x4f, 0x87, 0xf2, 0x39, 0xc, 0x23, 0xc6, 0x6, 0xcd }|VOID*|16
 307
 308 [PcdsFixedAtBuild,PcdsPatchableInModule]
 309   ## Maximun number of performance log entries during PEI phase.
 310   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f
 311
 312   ## RTC Update Timeout Value
 313   gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034
 314
 315 [PcdsPatchableInModule,PcdsDynamic]
 316   ##
 317   #  This PCD defines the Console output column and the default value is 25 according to UEFI spec
 318   ##
 319   gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006
 320
 321   ##
 322   #  This PCD defines the Console output row and the default value is 80 according to UEFI spec
 323   ##
 324   gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007
 325
 326 [PcdsFixedAtBuild,PcdsDynamic]
 327   ## Base address of the NV variable range in flash device
 328   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase|0x0|UINT32|0x30000001
 329
 330   ## Base address of the FTW spare block range in flash device.
 331   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase|0x0|UINT32|0x30000013
 332
 333   ## Base address of the FTW working block range in flash device.
 334   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010
 335
 336   ##
 337   #  This PCD defines the print string.
 338   #  This PCD is a sample to explain String typed PCD usage.
 339   ##
 340   gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004
 341
 342 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]
 343   ##
 344   #  This PCD defines the times to print hello world string.
 345   #  This PCD is a sample to explain FixedAtBuild UINT32 PCD usage.
 346   ##
 347   gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005
 348
 349   ## Indicate the max size of the populated capsule image that the platform can support.
 350   #  The default max size is 100MB (0x6400000) for more than one large capsule images.
 351   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizePopulateCapsule|0x6400000|UINT32|0x0001001e
 352
 353   ## Indicate the max size of the non-populated capsule image that the platform can support.
 354   #  The default max size is 10MB (0xa00000) for the casule image without populated flag setting.
 355   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxSizeNonPopulateCapsule|0xa00000|UINT32|0x0001001f