summaryrefslogtreecommitdiff
path: root/UefiCpuPkg
diff options
context:
space:
mode:
authorRuiyu Ni <ruiyu.ni@intel.com>2018-01-18 13:59:09 +0800
committerRuiyu Ni <ruiyu.ni@intel.com>2018-01-24 11:13:14 +0800
commit8b2eb7b3f62b1946cdd76e6f7758e106fcf71477 (patch)
tree4e29abd1a4a6182dd23407fd3c7411d479d52ccd /UefiCpuPkg
parent5986cf382e0fd73efc66c1e92d5663b1a468dbd7 (diff)
downloadedk2-8b2eb7b3f62b1946cdd76e6f7758e106fcf71477.zip
edk2-8b2eb7b3f62b1946cdd76e6f7758e106fcf71477.tar.gz
edk2-8b2eb7b3f62b1946cdd76e6f7758e106fcf71477.tar.bz2
UefiCpuPkg/MtrrLib: Update the comments for RETURN_BUFFER_TOO_SMALL
Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com> Reviewed-by: Ming Shao <ming.shao@intel.com>
Diffstat (limited to 'UefiCpuPkg')
-rw-r--r--UefiCpuPkg/Include/Library/MtrrLib.h10
-rw-r--r--UefiCpuPkg/Library/MtrrLib/MtrrLib.c8
2 files changed, 13 insertions, 5 deletions
diff --git a/UefiCpuPkg/Include/Library/MtrrLib.h b/UefiCpuPkg/Include/Library/MtrrLib.h
index 0bf7d8e..d56f105 100644
--- a/UefiCpuPkg/Include/Library/MtrrLib.h
+++ b/UefiCpuPkg/Include/Library/MtrrLib.h
@@ -1,7 +1,7 @@
/** @file
MTRR setting library
- Copyright (c) 2008 - 2017, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -157,7 +157,9 @@ GetFirmwareVariableMtrrCount (
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to
modify the attributes of the memory
resource range.
- @retval RETURN_BUFFER_TOO_SMALL The scratch buffer is too small for MTRR calculation.
+ @retval RETURN_BUFFER_TOO_SMALL The fixed internal scratch buffer is too small for MTRR calculation.
+ Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
+ external scratch buffer.
**/
RETURN_STATUS
EFIAPI
@@ -352,7 +354,9 @@ MtrrGetDefaultMemoryType (
BaseAddress and Length cannot be modified.
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
the memory resource range.
- @retval RETURN_BUFFER_TOO_SMALL The scratch buffer is too small for MTRR calculation.
+ @retval RETURN_BUFFER_TOO_SMALL The fixed internal scratch buffer is too small for MTRR calculation.
+ Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
+ external scratch buffer.
**/
RETURN_STATUS
EFIAPI
diff --git a/UefiCpuPkg/Library/MtrrLib/MtrrLib.c b/UefiCpuPkg/Library/MtrrLib/MtrrLib.c
index 30b0df0..2496d08 100644
--- a/UefiCpuPkg/Library/MtrrLib/MtrrLib.c
+++ b/UefiCpuPkg/Library/MtrrLib/MtrrLib.c
@@ -2513,7 +2513,9 @@ Exit:
BaseAddress and Length cannot be modified.
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
the memory resource range.
- @retval RETURN_BUFFER_TOO_SMALL The scratch buffer is too small for MTRR calculation.
+ @retval RETURN_BUFFER_TOO_SMALL The fixed internal scratch buffer is too small for MTRR calculation.
+ Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
+ external scratch buffer.
**/
RETURN_STATUS
EFIAPI
@@ -2559,7 +2561,9 @@ MtrrSetMemoryAttributeInMtrrSettings (
@retval RETURN_OUT_OF_RESOURCES There are not enough system resources to
modify the attributes of the memory
resource range.
- @retval RETURN_BUFFER_TOO_SMALL The scratch buffer is too small for MTRR calculation.
+ @retval RETURN_BUFFER_TOO_SMALL The fixed internal scratch buffer is too small for MTRR calculation.
+ Caller should use MtrrSetMemoryAttributesInMtrrSettings() to specify
+ external scratch buffer.
**/
RETURN_STATUS
EFIAPI