summaryrefslogtreecommitdiff
path: root/MdeModulePkg
diff options
context:
space:
mode:
authorJian J Wang <jian.j.wang@intel.com>2017-12-21 13:06:24 +0800
committerStar Zeng <star.zeng@intel.com>2017-12-22 14:16:50 +0800
commit3d0ebaa8d88773a116bcbd840128ab25977ec174 (patch)
treeee44cc60f499ec43a9f73eca8631101dcac30648 /MdeModulePkg
parent7155d0a68c37461dcf5f39876d145799be481744 (diff)
downloadedk2-3d0ebaa8d88773a116bcbd840128ab25977ec174.zip
edk2-3d0ebaa8d88773a116bcbd840128ab25977ec174.tar.gz
edk2-3d0ebaa8d88773a116bcbd840128ab25977ec174.tar.bz2
MdeModulePkg: Clarify usage of PcdHeapGuardPropertyMask
Cc: Star Zeng <star.zeng@intel.com> Cc: Eric Dong <eric.dong@intel.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>
Diffstat (limited to 'MdeModulePkg')
-rw-r--r--MdeModulePkg/MdeModulePkg.dec8
-rw-r--r--MdeModulePkg/MdeModulePkg.uni8
2 files changed, 12 insertions, 4 deletions
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 8efad57..d134ec7 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -939,13 +939,17 @@
gEfiMdeModulePkgTokenSpaceGuid.PcdHeapGuardPoolType|0x0|UINT64|0x30001053
## This mask is to control Heap Guard behavior.
+ # Note that due to the limit of pool memory implementation and the alignment
+ # requirement of UEFI spec, BIT7 is a try-best setting which cannot guarantee
+ # that the returned pool is exactly adjacent to head guard page or tail guard
+ # page.
# BIT0 - Enable UEFI page guard.<BR>
# BIT1 - Enable UEFI pool guard.<BR>
# BIT2 - Enable SMM page guard.<BR>
# BIT3 - Enable SMM pool guard.<BR>
# BIT7 - The direction of Guard Page for Pool Guard.
- # 0 - The returned pool is adjacent to the bottom guard page.<BR>
- # 1 - The returned pool is adjacent to the top guard page.<BR>
+ # 0 - The returned pool is near the tail guard page.<BR>
+ # 1 - The returned pool is near the head guard page.<BR>
# @Prompt The Heap Guard feature mask
gEfiMdeModulePkgTokenSpaceGuid.PcdHeapGuardPropertyMask|0x0|UINT8|0x30001054
diff --git a/MdeModulePkg/MdeModulePkg.uni b/MdeModulePkg/MdeModulePkg.uni
index 43dd510..fb45ccb 100644
--- a/MdeModulePkg/MdeModulePkg.uni
+++ b/MdeModulePkg/MdeModulePkg.uni
@@ -1196,13 +1196,17 @@
#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdHeapGuardPropertyMask_PROMPT #language en-US "The Heap Guard feature mask"
#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdHeapGuardPropertyMask_HELP #language en-US "This mask is to control Heap Guard behavior.\n"
+ "Note that due to the limit of pool memory implementation and the alignment\n"
+ "requirement of UEFI spec, BIT7 is a try-best setting which cannot guarantee\n"
+ "that the returned pool is exactly adjacent to head guard page or tail guard\n"
+ "page.\n"
" BIT0 - Enable UEFI page guard.<BR>\n"
" BIT1 - Enable UEFI pool guard.<BR>\n"
" BIT2 - Enable SMM page guard.<BR>\n"
" BIT3 - Enable SMM pool guard.<BR>\n"
" BIT7 - The direction of Guard Page for Pool Guard.\n"
- " 0 - The returned pool is adjacent to the bottom guard page.<BR>\n"
- " 1 - The returned pool is adjacent to the top guard page.<BR>"
+ " 0 - The returned pool is near the tail guard page.<BR>\n"
+ " 1 - The returned pool is near the head guard page.<BR>"
#string STR_gEfiMdeModulePkgTokenSpaceGuid_PcdCpuStackGuard_PROMPT #language en-US "Enable UEFI Stack Guard"