-#/** @file\r
-# Mde Module Package Reference Implementations\r
+## @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
-# This module provides headers and libraries that conform to EFI/PI Industry standards.\r
# Copyright (c) 2007 - 2008, 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
+# 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
+# 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
\r
[Defines]\r
\r
\r
[LibraryClasses.common]\r
- ## IpIo layer upon EFI IP4 Protocol.\r
+ ## @libraryclass IpIo layer upon EFI IP4 Protocol.\r
IpIoLib|Include/Library/IpIoLib.h\r
\r
- ## Basic function for UEFI network stack.\r
+ ## @libraryclass Basic function for UEFI network stack.\r
NetLib|Include/Library/NetLib.h\r
\r
- ## Defines a set of methods to reset whole system.\r
+ ## @libraryclass Defines a set of methods to reset whole system.\r
ResetSystemLib|Include/Library/ResetSystemLib.h\r
\r
- ## The helper routines to access UDP service.\r
+ ## @libraryclass The helper routines to access UDP service.\r
UdpIoLib|Include/Library/UdpIoLib.h\r
\r
- ## Defines a set of methods related do S3 mode.\r
+ ## @libraryclass Defines a set of methods related do S3 mode.\r
S3Lib|Include/Library/S3Lib.h\r
\r
- ## Defines a set of methods related recovery mode.\r
+ ## @libraryclass Defines a set of methods related recovery mode.\r
RecoveryLib|Include/Library/RecoveryLib.h\r
\r
- ## Basic platform driver override functions.\r
+ ## @libraryclass Basic platform driver override functions.\r
PlatDriOverLib|Include/Library/PlatDriOverLib.h\r
+\r
+ ## @libraryclass Provides HII related functions.\r
+ HiiLib|Include/Library/HiiLib.h\r
+\r
+ ## @libraryclass Provides a set of interfaces to do IFR opcode creation and interact with a UEFI Form Browser.\r
+ IfrSupportLib|Include/Library/IfrSupportLib.h\r
\r
- ## Includes two extended HII functions to create and destory Hii Package \r
- # by create the virtual Driver Handle.\r
+ ## @libraryclass Includes two extended HII functions to create and destory Hii Package \r
+ # by create the virtual Driver Handle.\r
+ ##\r
ExtendedHiiLib|Include/Library/ExtendedHiiLib.h\r
\r
- ## Defines APIs that is related to IFR operations but specific to EDK II implementation.\r
+ ## @libraryclass Defines APIs that is related to IFR operations but specific to EDK II\r
+ # implementation.\r
+ ##\r
ExtendedIfrSupportLib|Include/Library/ExtendedIfrSupportLib.h\r
\r
- ## Defines a set of interfaces on how to process capusle image update.\r
+ ## @libraryclass Defines a set of interfaces on how to process capusle image update.\r
CapsuleLib|Include/Library/CapsuleLib.h\r
\r
- ## Platform BDS library definition about platform specific behavior.\r
+ ## @libraryclass Platform BDS library definition about platform specific behavior.\r
PlatformBdsLib|Include/Library/PlatformBdsLib.h\r
\r
- ## Generic BDS library definition, include the data structure and function.\r
+ ## @libraryclass Generic BDS library definition, include the data structure and function.\r
GenericBdsLib|Include/Library/GenericBdsLib.h\r
\r
- ## Library for Deferred Procedure Calls.\r
+ ## @libraryclass Library for Deferred Procedure Calls.\r
DpcLib|Include/Library/DpcLib.h\r
\r
+ ## @libraryclass Provides all FVB runtime services defined in PI specification FVB protocol to provide\r
+ # low level control interfaces over block-oriented firmware devices.\r
+ ##\r
+ FvbServiceLib|Include/Library/FvbServiceLib.h\r
+\r
[Guids.common]\r
## MdeModule package token space guid\r
gEfiMdeModulePkgTokenSpaceGuid = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }}\r
\r
## Guid specify the device is the console in device.\r
gEfiConsoleInDeviceGuid = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }}\r
-\r
- ## Guid specify the device is the hot plug device.\r
- gEfiHotPlugDeviceGuid = { 0x220AC432, 0x1D43, 0x49E5, { 0xA7, 0x4F, 0x4C, 0x9D, 0xA6, 0x7A, 0xD2, 0x3B }}\r
\r
## Guid specify the primary console out device.\r
gEfiPrimaryConsoleOutDeviceGuid = { 0x62BDF38A, 0xE3D5, 0x492C, { 0x95, 0x0C, 0x23, 0xA7, 0xF6, 0x6E, 0x67, 0x2E }}\r
## Guid specify the variable list entries put in the EFI system table.\r
gEfiVariableInfoGuid = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }}\r
\r
- ## Guid specify the Simple TextIn Notify handle.\r
- gSimpleTextInExNotifyGuid = { 0x856f2def, 0x4e93, 0x4d6b, { 0x94, 0xce, 0x1c, 0xfe, 0x47, 0x01, 0x3e, 0xa5 }}\r
- \r
## Platform Override Variable guid\r
gEfiOverrideVariableGuid = { 0x8e3d4ad5, 0xf762, 0x438a, { 0xa1, 0xc1, 0x5b, 0x9f, 0xe6, 0x8c, 0x6b, 0x15 }}\r
\r
## Load File protocol provides capability to load and unload EFI image into memory and execute it.\r
gEfiLoadPeImageProtocolGuid = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }}\r
\r
+ ## Print protocol defines only one basic print function.\r
+ gEfiPrintProtocolGuid = { 0xdf2d868e, 0x32fc, 0x4cf0, {0x8e, 0x6b, 0xff, 0xd9, 0x5d, 0x13, 0x43, 0xd0} }\r
+\r
## Print protocol defines six basic print functions to print the format unicode and ascii string.\r
- gEfiPrintProtocolGuid = { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0x0c, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0x0c }}\r
- \r
- ## This protocol defines the EFI generic memory test interfaces in Dxe phase.\r
+ gEfiPrint2ProtocolGuid = { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0x0c, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0x0c }}\r
+\r
+ ## This protocol defines the generic memory test interfaces in Dxe phase.\r
gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}\r
\r
## Disk Info protocol is used to export Inquiry Data for a drive.\r
gEfiDiskInfoProtocolGuid = { 0xD432A67F, 0x14DC, 0x484B, { 0xB3, 0xBB, 0x3F, 0x02, 0x91, 0x84, 0x93, 0x27 }}\r
\r
- ## FVB Extension protocol that extends the FVB Class in a component fashion.\r
+ ## This protocol provides an extended service to erase the specified range of a firmware volume block.\r
gEfiFvbExtensionProtocolGuid = { 0x53A4C71B, 0xB581, 0x4170, { 0x91, 0xB3, 0x8D, 0xB8, 0x7A, 0x4B, 0x5C, 0x46 }}\r
\r
## Fault tolerant write lite protocol defines only one interface to write \r
## This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\r
gEfiConsoleControlProtocolGuid = { 0xF42F7782, 0x012E, 0x4C12, { 0x99, 0x56, 0x49, 0xF9, 0x43, 0x04, 0xF7, 0x21 }}\r
\r
- ## EFI OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
+ ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute.\r
gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
\r
## Performance protocol interfaces to support cross module performance logging.\r
\r
## Tcg addtional services to measure PeImage and ActionString.\r
gEfiTcgPlatformProtocolGuid = { 0x8c4c9a41, 0xbf56, 0x4627, { 0x9e, 0xa, 0xc8, 0x38, 0x6d, 0x66, 0x11, 0x5c }}\r
+ \r
+ ## Protocol Guid specify the Simple TextIn Notify handle.\r
+ gSimpleTextInExNotifyGuid = { 0x856f2def, 0x4e93, 0x4d6b, { 0x94, 0xce, 0x1c, 0xfe, 0x47, 0x01, 0x3e, 0xa5 }} \r
+\r
+ ## Protocol Guid specify the device is the hot plug device.\r
+ gEfiHotPlugDeviceGuid = { 0x220AC432, 0x1D43, 0x49E5, { 0xA7, 0x4F, 0x4C, 0x9D, 0xA6, 0x7A, 0xD2, 0x3B }}\r
\r
[Ppis.common]\r
## Pei memory test PPI used to Perform memory test in PEI phase.\r
gPeiBaseMemoryTestPpiGuid = { 0xB6EC423C, 0x21D2, 0x490D, { 0x85, 0xC6, 0xDD, 0x58, 0x64, 0xEA, 0xA6, 0x74 }}\r
\r
- ## FlashMap PPI abstracts access to FlashMap information.\r
- # gPeiFlashMapPpiGuid will be removed in future.\r
- gPeiFlashMapPpiGuid = { 0xf34c2fa0, 0xde88, 0x4270, {0x84, 0x14, 0x96, 0x12, 0x22, 0xf4, 0x52, 0x1c } }\r
- \r
- ## OperatorPresent PPI responsible for detecting TPM operator presence.\r
- gPeiOperatorPresencePpiGuid = { 0x20a7378c, 0xaa83, 0x4ce1, {0x82, 0x1f, 0x47, 0x40, 0xee, 0x1b, 0x3f, 0x9f } }\r
-\r
[PcdsFeatureFlag.common]\r
## Indicate whether platform can support update capsule across a system reset\r
- gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleRest|FALSE|BOOLEAN|0x0001001d\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdSupportUpdateCapsuleReset|FALSE|BOOLEAN|0x0001001d\r
\r
## This feature flag can be used to enable or disable the Pcd PEIM database \r
# traverse capability. Disable it can reduce the size of final image generated.\r
## If PcdSupportHardwareErrorRecord is TRUE, support hardware error record via variable in BDS.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHardwareErrorRecord|FALSE|BOOLEAN|0x00010045\r
\r
- ## If TRUE, UGA Draw Protocol is still consumed in platform.\r
- gEfiMdeModulePkgTokenSpaceGuid.PcdUgaConsumeSupport|TRUE|BOOLEAN|0x00010046\r
- \r
## If TRUE, Robustnesss improvement such as for DUET. Default is not required.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047\r
\r
# FALSE is for size reduction.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100\r
\r
- ## IF TRUE, Full UEFI Config Routing Protocol will be installed.\r
+ ## If TRUE, Full UEFI Config Routing Protocol will be installed.\r
# FALSE is for size reduction.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdSupportFullConfigRoutingProtocol|TRUE|BOOLEAN|0x00010101\r
\r
- ## IF TRUE, Default Keyboard Layout is disabled in Usb KeyBoard device.\r
+ ## If TRUE, Default Keyboard Layout is disabled in Usb KeyBoard device.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdDisableDefaultKeyboardLayoutInUsbKbDriver|FALSE|BOOLEAN|0x00010200\r
\r
+ ## If TRUE, Framework Hii is supported to provide backward compatibility\r
gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkHiiCompatibilitySupport|TRUE|BOOLEAN|0x00012008\r
\r
- ## IF TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.\r
+ ## If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkFvHobCompatibilitySupport|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
[PcdsFixedAtBuild.common]\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
-\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
## Maximum buffer for the single variable.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize|0x400|UINT32|0x30000003\r
\r
- ## The hardware error record maximum variable size.\r
+ ## Maximum buffer for Hardware error record variable.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize|0x8000|UINT32|0x30000004\r
\r
## Maximum buffer for the total variable store.\r
\r
## Default timeout value for displaying progressing bar in before boot OS.\r
# This value can be changed in BDS.\r
- gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|10|UINT16|0x40000001\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|0xffff|UINT16|0x40000001\r
\r
## Error level for hardware recorder.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r
+ \r
+ ##\r
+ # This PCD defines the print string.\r
+ # This PCD is a sample to explain FixedAtBuild String PCD usage.\r
+ ##\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004\r
+\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
[PcdsFixedAtBuild.IA32]\r
## Default EFI boot path name for IA32 architecture, this path is relative to \r
\r
## Default timeout value for displaying progressing bar in before boot OS.\r
# This value can be changed in BDS.\r
- gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|10|UINT16|0x40000001\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|0xffff|UINT16|0x40000001\r
\r
## Error level for hardware recorder.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r
\r
+ ##\r
+ # This PCD defines the print string.\r
+ # This PCD is a sample to explain Dynamic PCD usage.\r
+ ##\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004\r
+\r
+ ##\r
+ # This PCD defines the times to print hello world string.\r
+ # This PCD is a sample to explain Dynamic UINT32 PCD usage.\r
+ ##\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005\r
+\r
[PcdsPatchableInModule.common]\r
## Maximun number of performance log entries during PEI phase.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxPeiPerformanceLogEntries|40|UINT8|0x0001002f\r
\r
## Default timeout value for displaying progressing bar in before boot OS.\r
# This value can be changed in BDS.\r
- gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|10|UINT16|0x40000001\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdPlatformBootTimeOutDefault|0xffff|UINT16|0x40000001\r
\r
## Error level for hardware recorder.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r
\r
+ ##\r
+ # This PCD defines the times to print hello world string.\r
+ # This PCD is a sample to explain Patchable UINT32 PCD usage.\r
+ ##\r
+ gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005\r
+\r
[PcdsFeatureFlag.IA32]\r
## If TRUE, the DXE IPL will load a 64-bit DxeCore.\r
gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSwitchToLongMode|TRUE|BOOLEAN|0x0001003b\r
projects / mirror_edk2.git / blobdiff