tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdeModulePkg SmmMemoryAttribute.h: Refine some comments 

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>
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>
This commit is contained in:
Star Zeng 2018-02-28 13:20:34 +08:00
parent c4172f8005
commit 5942b32e79
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h
View File

@ -2,7 +2,7 @@
SMM Memory Attribute Protocol provides retrieval and update service SMM Memory Attribute Protocol provides retrieval and update service
for memory attributes in EFI SMM environment. for memory attributes in EFI SMM environment.
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR> Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -42,7 +42,7 @@ typedef struct _EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL EDKII_SMM_MEMORY_ATTRIBUTE_P
@retval EFI_UNSUPPORTED The processor does not support one or more @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified bytes of the memory resource range specified
by BaseAddress and Length. 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 the memory resource range specified by
BaseAddress and Length. BaseAddress and Length.
@ -64,17 +64,17 @@ EFI_STATUS
@param BaseAddress The physical address that is the start address of @param BaseAddress The physical address that is the start address of
a memory region. a memory region.
@param Length The size in bytes of the 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. 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. @retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of 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 @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified bytes of the memory resource range specified
by BaseAddress and Length. 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 the memory resource range specified by
BaseAddress and Length. BaseAddress and Length.
@ -89,7 +89,7 @@ EFI_STATUS
); );
/** /**
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 BaseAddress and Length. If different attributes are got from different part
of the memory region, EFI_NO_MAPPING will be returned. of the memory region, EFI_NO_MAPPING will be returned.
@ -107,9 +107,6 @@ EFI_STATUS
@retval EFI_UNSUPPORTED The processor does not support one or more @retval EFI_UNSUPPORTED The processor does not support one or more
bytes of the memory resource range specified bytes of the memory resource range specified
by BaseAddress and Length. by BaseAddress and Length.
The bit mask of attributes is not support for
the memory resource range specified by
BaseAddress and Length.
**/ **/
typedef typedef