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>
This commit is contained in:
Ruiyu Ni 2018-01-18 13:59:09 +08:00
parent 5986cf382e
commit 8b2eb7b3f6
2 changed files with 13 additions and 5 deletions

View File

@ -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

View File

@ -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