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