Add clarification for PcdAcpiDefault value PCD.
authorYao, Jiewen <jiewen.yao@intel.com>
Thu, 17 Dec 2015 14:06:52 +0000 (14:06 +0000)
committerjyao1 <jyao1@Edk2>
Thu, 17 Dec 2015 14:06:52 +0000 (14:06 +0000)
Add clarification for PcdAcpiDefaultOemTableId, PcdAcpiDefaultOemRevision,
PcdAcpiDefaultCreatorId, PcdAcpiDefaultCreatorRevision.
According to ACPI spec, they are used as special meaning for SSDT,
so we ignore them in updating generic SSDT provided by EDKII.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: "Yao, Jiewen" <jiewen.yao@intel.com>
Reviewed-by: "Zeng, Star" <star.zeng@intel.com>com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19321 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/MdeModulePkg.dec
MdeModulePkg/MdeModulePkg.uni

index 5ec37c5a7d056d5809d5e8c4e1e22f07ca217909..e2e0b75cdb31aaf8ce2bf63d74a908b1956ecf79 100644 (file)
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId|"INTEL "|VOID*|0x30001034\r
 \r
   ## Default OEM Table ID for ACPI table creation, it is "EDK2    ".\r
+  #  Accroding to ACPI specification, this field is particularly useful when\r
+  #  defining a definition block to distinguish definition block functions.\r
+  #  The OEM assigns each dissimilar table a new OEM Table ID.\r
+  #  This PCD is ignored for definition block.\r
   # @Prompt Default OEM Table ID for ACPI table creation.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemTableId|0x20202020324B4445|UINT64|0x30001035\r
 \r
   ## Default OEM Revision for ACPI table creation.\r
+  #  Accroding to ACPI specification, for LoadTable() opcode, the OS can also\r
+  #  check the OEM Table ID and Revision ID against a database for a newer\r
+  #  revision Definition Block of the same OEM Table ID and load it instead.\r
+  #  This PCD is ignored for definition block.\r
   # @Prompt Default OEM Revision for ACPI table creation.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision|0x00000002|UINT32|0x30001036\r
 \r
   ## Default Creator ID for ACPI table creation.\r
+  #  Accroding to ACPI specification, for tables containing Definition Blocks,\r
+  #  this is the ID for the ASL Compiler.\r
+  #  This PCD is ignored for definition block.\r
   # @Prompt Default Creator ID for ACPI table creation.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId|0x20202020|UINT32|0x30001037\r
 \r
   ## Default Creator Revision for ACPI table creation.\r
+  #  Accroding to ACPI specification, for tables containing Definition Blocks,\r
+  #  this is the revision for the ASL Compiler.\r
+  #  This PCD is ignored for definition block.\r
   # @Prompt Default Creator Revision for ACPI table creation.\r
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision|0x01000013|UINT32|0x30001038\r
 \r
index 7ef7d910bf273eaee6099b5cee1cf145f68a5cba..c026f1453416d52e4d7e632ccede1e20032b259d 100644 (file)
 \r
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemTableId_PROMPT  #language en-US "Default OEM Table ID for ACPI table creation"\r
 \r
-#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemTableId_HELP  #language en-US "Default OEM Table ID for ACPI table creation."\r
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemTableId_HELP  #language en-US "Default OEM Table ID for ACPI table creation.<BR><BR>\n"\r
+                                                                                          "Accroding to ACPI specification, this field is particularly useful when\n"\r
+                                                                                          "defining a definition block to distinguish definition block functions.<BR>\n"\r
+                                                                                          "The OEM assigns each dissimilar table a new OEM Table ID.<BR>\n"\r
+                                                                                          "This PCD is ignored for definition block.<BR>"\r
 \r
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemRevision_PROMPT  #language en-US "Default OEM Revision for ACPI table creation"\r
 \r
-#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemRevision_HELP  #language en-US "Default OEM Revision for ACPI table creation."\r
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultOemRevision_HELP  #language en-US "Default OEM Revision for ACPI table creation.<BR><BR>\n"\r
+                                                                                           "Accroding to ACPI specification, for LoadTable() opcode, the OS can also\n"\r
+                                                                                           "check the OEM Table ID and Revision ID against a database for a newer\n"\r
+                                                                                           "revision Definition Block of the same OEM Table ID and load it instead.<BR>\n"\r
+                                                                                           "This PCD is ignored for definition block.<BR>"\r
 \r
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorId_PROMPT  #language en-US "Default Creator ID for ACPI table creation"\r
 \r
-#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorId_HELP  #language en-US "Default Creator ID for ACPI table creation."\r
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorId_HELP  #language en-US "Default Creator ID for ACPI table creation.<BR><BR>\n"\r
+                                                                                         "Accroding to ACPI specification, for tables containing Definition Blocks,\n"\r
+                                                                                         "this is the ID for the ASL Compiler.<BR>\n"\r
+                                                                                         "This PCD is ignored for definition block.<BR>"\r
 \r
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorRevision_PROMPT  #language en-US "Default Creator Revision for ACPI table creation"\r
 \r
-#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorRevision_HELP  #language en-US "Default Creator Revision for ACPI table creation."\r
+#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdAcpiDefaultCreatorRevision_HELP  #language en-US "Default Creator Revision for ACPI table creation.<BR><BR>\n"\r
+                                                                                               "Accroding to ACPI specification, for tables containing Definition Blocks,\n"\r
+                                                                                               "this is the revision for the ASL Compiler.<BR>\n"\r
+                                                                                               "This PCD is ignored for definition block.<BR>"\r
 \r
 #string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdMemoryProfilePropertyMask_PROMPT  #language en-US "Memory Profile Property"\r
 \r