git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8576 6f19259b...

[mirror_edk2.git] / IntelFrameworkModulePkg / IntelFrameworkModulePkg.dec

diff --git a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
index 1b346989be64c5280149f02bfad8a297a48338ec..8dde600283a897000525bedeec4e46ad6fb83060 100644 (file)
--- a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
+++ b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
@@ -115,41 +115,53 @@
   gEfiOEMBadgingProtocolGuid     = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
 \r
 [PcdsFeatureFlag]\r
-  ## if required, only one mask PCD to support all features to reduces PCD number.\r
+  ## This PCD specifies whether StatusCode is reported to Serial port.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseSerial|TRUE|BOOLEAN|0x00010022\r
+\r
+  ## This PCD specifies whether StatusCode is stored in memory.\r
+  #  Pei Phase Memory is boot time memory. Dxe Phase memory is runtime memory.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseMemory|FALSE|BOOLEAN|0x00010023\r
+\r
+  ## This PCD specifies whether StatusCode is reported to OEM device.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseOEM|FALSE|BOOLEAN|0x00010024\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseEfiSerial|FALSE|BOOLEAN|0x00010026\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseHardSerial|TRUE|BOOLEAN|0x00010027\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseRuntimeMemory|FALSE|BOOLEAN|0x00010028\r
+\r
+  ## This PCD specifies whether StatusCode is loged into DataHub.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeUseDataHub|FALSE|BOOLEAN|0x00010029\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayInSerial|FALSE|BOOLEAN|0x0001002a\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayInRuntimeMemory|FALSE|BOOLEAN|0x0001002b\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayInDataHub|FALSE|BOOLEAN|0x0001002c\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayInOEM|FALSE|BOOLEAN|0x0001002d\r
+\r
+  ## This PCD specifies whether Peiphase StatusCode is replayed in DxePhase.\r
+  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeReplayIn|FALSE|BOOLEAN|0x0001002d\r
   \r
   ## \r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPciIsaEnable|FALSE|BOOLEAN|0x00010039\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPciVgaEnable|FALSE|BOOLEAN|0x0001003a\r
+  \r
+  ## This PCD specifies whether PciBus supports the hot plug device.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPciBusHotplugDeviceSupport|TRUE|BOOLEAN|0x0001003d\r
   \r
-  ## \r
+  ## ISA bus related PCD can be merged into one.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportDma|TRUE|BOOLEAN|0x00010040\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusOnlySupportSlaveDma|FALSE|BOOLEAN|0x00010041\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportIsaMemory|TRUE|BOOLEAN|0x00010042\r
-  \r
+\r
 [PcdsFixedAtBuild]\r
+  ## PCD marks PCI support incompatible operations: AcpiResource, Read, Write, RegisterUpdate, AccessWidth.\r
+  #  BIT0:AcpiResource, BIT1:Read, BIT2:Write, BIT3:RegisterUpdate, BIT4:AccessWidth\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPciIncompatibleDeviceSupportMask|0|UINT8|0x0001003f\r
 \r
 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]\r
+  ## PcdStatusCodeMemorySize is used when PcdStatusCodeUseMemory is set to true\r
+  #  (PcdStatusCodeMemorySize * KBytes) is the total taken memory size.\r
+  #  The default value in PeiPhase is 1 KBytes.\r
+  #  The default value in DxePhase is 128 KBytes.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeMemorySize|1|UINT16|0x00010025\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdStatusCodeRuntimeMemorySize|128|UINT16|0x0001002e\r
 \r
 [PcdsDynamic]\r
+  ## PCD is used to mark if the machine has complete one boot cycle before.\r
+  #  After the complete boot, the variable BootState will be set to TRUE. \r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootState|TRUE|BOOLEAN|0x0001002f\r
   \r
   ## Timeout value for displaying progressing bar in before boot OS.\r
-  #  According to UEFI 2.0 spec, it should treat the Timeout value as 0xffff.\r
+  #  According to UEFI 2.0 spec, the default TimeOut should be 0xffff.\r
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPlatformBootTimeOut|0xffff|UINT16|0x40000001\r
 \r
   ## Error level for hardware recorder. If value 0, platform does not support feature of hardware error record.\r