sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / MdeModulePkg / MdeModulePkg.dec

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 7dcb1f133b9f047e6d759231d87efb06dca245af..267d970f06503f3a7a1c52e6f8c2b182b05b70e3 100644 (file)
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -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
 #\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
 # 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
 #\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
 \r
 [Defines]\r
 \r
 \r
 [Defines]\r


@@ -27,44 +29,47 @@
 \r
 \r
 [LibraryClasses.common]\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
   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
   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
   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
   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
   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
   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
   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
   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
   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
   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
   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
   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
   DpcLib|Include/Library/DpcLib.h\r
 \r
 [Guids.common]\r


@@ -283,20 +288,21 @@
   #  FALSE is for size reduction.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdSupportHiiImageProtocol|TRUE|BOOLEAN|0x00010100\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
   #  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
   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
   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
   gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkFvHobCompatibilitySupport|FALSE|BOOLEAN|0x00012009\r
   \r
   ##\r

-  #  IF TRUE, HelloWorld Application will print the verbose information.\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
   #  This PCD is a sample to explain FeatureFlag PCD usage.\r
   ##\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a\r


@@ -305,8 +311,8 @@
   ## 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
   ## 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
   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
   ## VPD type PCD allow developer point an absoluted physical address PcdVpdBaseAddress\r
   #  to store PCD value. \r
   #\r


@@ -365,7 +371,7 @@
 \r
   ## Default timeout value for displaying progressing bar in before boot OS.\r
   #  This value can be changed in BDS.\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
   ## Error level for hardware recorder.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r


@@ -423,7 +429,7 @@
 \r
   ## Default timeout value for displaying progressing bar in before boot OS.\r
   #  This value can be changed in BDS.\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
   ## Error level for hardware recorder.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r


@@ -464,7 +470,7 @@
 \r
   ## Default timeout value for displaying progressing bar in before boot OS.\r
   #  This value can be changed in BDS.\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
   ## Error level for hardware recorder.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdHardwareErrorRecordLevel|1|UINT16|0x40000002\r