]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/MdeModulePkg.dec
sync comments, fix function header, rename variable name to follow coding style.
[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.dec
index c046b3e3638c9d2ab1e6500acaea63e16772131a..267d970f06503f3a7a1c52e6f8c2b182b05b70e3 100644 (file)
@@ -1,19 +1,21 @@
-#/** @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
-  ## 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
 [Guids.common]\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
+  gEfiPrint2ProtocolGuid          = { 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
   gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }}\r
   \r
   \r
   ## This feature flag can be used to enable or disable the PCD service PEIM to handle DynamicEX PCD. \r
   gEfiMdeModulePkgTokenSpaceGuid.PcdPeiPcdDatabaseExEnabled|TRUE|BOOLEAN|0x00010033\r
-  \r
-  ## If this feature is enabled, then the DXE IPL must support decompressing files compressed with the EFI Compression algorithm.\r
-  #  This feature flag is deprecated.\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportEfiDecompress|TRUE|BOOLEAN|0x00010034\r
-  \r
-  ## If this feature is enabled, then the DXE IPL must support decompressing files compressed with the Tiano Compression algorithm.\r
-  #  This feature flag is deprecated.\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportTianoDecompress|TRUE|BOOLEAN|0x00010035\r
-  \r
-  ## If this feature is enabled, then the DXE IPL must support decompressing files compressed with the Custom Compression algorithm.\r
-  #  This feature flag is deprecated.\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportCustomDecompress|TRUE|BOOLEAN|0x00010036\r
-  \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
   ## 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 this feature is enabled, DXE IPL will build a series of HOBs to share code with DXE Core.\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplBuildShareCodeHobs|FALSE|BOOLEAN|0x0001003c\r
-  \r
+    \r
   ## If this PCD is set as TRUE, the code specific to NT emulator will be endabled.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdNtEmulatorEnable|FALSE|BOOLEAN|0x0001003e\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
+  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
 \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