diff options
author | Star Zeng <star.zeng@intel.com> | 2018-02-28 13:21:59 +0800 |
---|---|---|
committer | Star Zeng <star.zeng@intel.com> | 2018-04-04 10:49:07 +0800 |
commit | aae02dccf5b0ad07e60d2738f350b3b39df389d7 (patch) | |
tree | 592e0472d179c8c7cc40d0f92da2e337713f52d5 /UefiCpuPkg/PiSmmCpuDxeSmm | |
parent | 5942b32e798f7e49c9c5c2ef10f4ac2ad0647598 (diff) | |
download | edk2-aae02dccf5b0ad07e60d2738f350b3b39df389d7.tar.gz edk2-aae02dccf5b0ad07e60d2738f350b3b39df389d7.tar.bz2 edk2-aae02dccf5b0ad07e60d2738f350b3b39df389d7.zip |
UefiCpuPkg PiSmmCpuDxeSmm: Refine some comments about SmmMemoryAttribute
1. Fix some "support" to "supported".
2. Fix some "set" to "clear" in ClearMemoryAttributes interface.
3. Remove redundant comments for GetMemoryAttributes interface.
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Diffstat (limited to 'UefiCpuPkg/PiSmmCpuDxeSmm')
-rw-r--r-- | UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 15 | ||||
-rw-r--r-- | UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c | 25 |
2 files changed, 17 insertions, 23 deletions
diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h index a2babb9877..f91ddd35d2 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h @@ -1079,7 +1079,7 @@ TransferApToSafeState ( @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
+ The bit mask of attributes is not supported for
the memory resource range specified by
BaseAddress and Length.
@@ -1101,17 +1101,17 @@ EdkiiSmmSetMemoryAttributes ( @param BaseAddress The physical address that is the start address of
a memory region.
@param Length The size in bytes of the memory region.
- @param Attributes The bit mask of attributes to set for the memory
+ @param Attributes The bit mask of attributes to clear for the memory
region.
- @retval EFI_SUCCESS The attributes were set for the memory region.
+ @retval EFI_SUCCESS The attributes were cleared for the memory region.
@retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of
- attributes that cannot be set together.
+ attributes that cannot be cleared together.
@retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
+ The bit mask of attributes is not supported for
the memory resource range specified by
BaseAddress and Length.
@@ -1126,7 +1126,7 @@ EdkiiSmmClearMemoryAttributes ( );
/**
- This function retrieve the attributes of the memory region specified by
+ This function retrieves the attributes of the memory region specified by
BaseAddress and Length. If different attributes are got from different part
of the memory region, EFI_NO_MAPPING will be returned.
@@ -1144,9 +1144,6 @@ EdkiiSmmClearMemoryAttributes ( @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
- the memory resource range specified by
- BaseAddress and Length.
**/
EFI_STATUS
diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c b/UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c index 2a4a298998..85e06b2e6a 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c @@ -552,12 +552,12 @@ SmmSetMemoryAttributesEx ( BaseAddress and Length cannot be modified.
@retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of attributes that
- cannot be set together.
+ cannot be cleared together.
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
the memory resource range.
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
resource range specified by BaseAddress and Length.
- The bit mask of attributes is not support for the memory resource
+ The bit mask of attributes is not supported for the memory resource
range specified by BaseAddress and Length.
**/
@@ -604,7 +604,7 @@ SmmClearMemoryAttributesEx ( the memory resource range.
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
resource range specified by BaseAddress and Length.
- The bit mask of attributes is not support for the memory resource
+ The bit mask of attributes is not supported for the memory resource
range specified by BaseAddress and Length.
**/
@@ -632,12 +632,12 @@ SmmSetMemoryAttributes ( BaseAddress and Length cannot be modified.
@retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of attributes that
- cannot be set together.
+ cannot be cleared together.
@retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
the memory resource range.
@retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
resource range specified by BaseAddress and Length.
- The bit mask of attributes is not support for the memory resource
+ The bit mask of attributes is not supported for the memory resource
range specified by BaseAddress and Length.
**/
@@ -1185,7 +1185,7 @@ IsSmmCommBufferForbiddenAddress ( @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
+ The bit mask of attributes is not supported for
the memory resource range specified by
BaseAddress and Length.
@@ -1210,17 +1210,17 @@ EdkiiSmmSetMemoryAttributes ( @param BaseAddress The physical address that is the start address of
a memory region.
@param Length The size in bytes of the memory region.
- @param Attributes The bit mask of attributes to set for the memory
+ @param Attributes The bit mask of attributes to clear for the memory
region.
- @retval EFI_SUCCESS The attributes were set for the memory region.
+ @retval EFI_SUCCESS The attributes were cleared for the memory region.
@retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of
- attributes that cannot be set together.
+ attributes that cannot be cleared together.
@retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
+ The bit mask of attributes is not supported for
the memory resource range specified by
BaseAddress and Length.
@@ -1238,7 +1238,7 @@ EdkiiSmmClearMemoryAttributes ( }
/**
- This function retrieve the attributes of the memory region specified by
+ This function retrieves the attributes of the memory region specified by
BaseAddress and Length. If different attributes are got from different part
of the memory region, EFI_NO_MAPPING will be returned.
@@ -1256,9 +1256,6 @@ EdkiiSmmClearMemoryAttributes ( @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified
by BaseAddress and Length.
- The bit mask of attributes is not support for
- the memory resource range specified by
- BaseAddress and Length.
**/
EFI_STATUS
|