MdeModulePkg: cleanup Heap Guard pool/page type PCD documentation

This cleanup is meant for avoiding misuse of newly introduced BIT4
(UAF detection) of PCD PcdHeapGuardPropertyMask, because it applies
to all types of physical memory. In another words,
PcdHeapGuardPoolType and PcdHeapGuardPageType don't have effect to
the BIT4 of PcdHeapGuardPropertyMask.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 6037504fa789d4ca96d45bf3a776dd77bc17a909..2009dbc5fd5207e071c27a823412c6fdc180e45f 100644 (file)
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -955,6 +955,8 @@
   # free pages for all of them. The page allocation for the type related to\r
   # cleared bits keeps the same as ususal.\r
   #\r
+  # This PCD is only valid if BIT0 and/or BIT2 are set in PcdHeapGuardPropertyMask.\r
+  #\r
   # Below is bit mask for this PCD: (Order is same as UEFI spec)<BR>\r
   #  EfiReservedMemoryType             0x0000000000000001<BR>\r
   #  EfiLoaderCode                     0x0000000000000002<BR>\r
@@ -984,6 +986,8 @@
   # if there's enough free memory for all of them. The pool allocation for the\r
   # type related to cleared bits keeps the same as ususal.\r
   #\r
+  # This PCD is only valid if BIT1 and/or BIT3 are set in PcdHeapGuardPropertyMask.\r
+  #\r
   # Below is bit mask for this PCD: (Order is same as UEFI spec)<BR>\r
   #  EfiReservedMemoryType             0x0000000000000001<BR>\r
   #  EfiLoaderCode                     0x0000000000000002<BR>\r

diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni
index a6bcb627cf3ba425d075e92c9b7955c95560e53b..9d2e473fa974225c843b5f1e5e801d8a3771c797 100644 (file)
--- a/MdeModulePkg/MdeModulePkg.uni
+++ b/MdeModulePkg/MdeModulePkg.uni
@@ -1171,6 +1171,7 @@
                                                                                         " before and after corresponding type of pages allocated if there's enough\n"\r
                                                                                         " free pages for all of them. The page allocation for the type related to\n"\r
                                                                                         " cleared bits keeps the same as ususal.\n\n"\r
+                                                                                        " This PCD is only valid if BIT0 and/or BIT2 are set in PcdHeapGuardPropertyMask.\n\n"\r
                                                                                         " Below is bit mask for this PCD: (Order is same as UEFI spec)<BR>\n"\r
                                                                                         "  EfiReservedMemoryType             0x0000000000000001\n"\r
                                                                                         "  EfiLoaderCode                     0x0000000000000002\n"\r
@@ -1198,6 +1199,7 @@
                                                                                         " before and after corresponding type of pages which the allocated pool occupies,\n"\r
                                                                                         " if there's enough free memory for all of them. The pool allocation for the\n"\r
                                                                                         " type related to cleared bits keeps the same as ususal.\n\n"\r
+                                                                                        " This PCD is only valid if BIT1 and/or BIT3 are set in PcdHeapGuardPropertyMask.\n\n"\r
                                                                                         " Below is bit mask for this PCD: (Order is same as UEFI spec)<BR>\n"\r
                                                                                         "  EfiReservedMemoryType             0x0000000000000001\n"\r
                                                                                         "  EfiLoaderCode                     0x0000000000000002\n"\r