From: Star Zeng <star.zeng@intel.com>
To: edk2-devel@lists.01.org
Cc: Star Zeng <star.zeng@intel.com>,
Jian J Wang <jian.j.wang@intel.com>,
Jiewen Yao <jiewen.yao@intel.com>
Subject: [PATCH 1/2] MdeModulePkg SmmMemoryAttribute.h: Refine some comments
Date: Tue, 3 Apr 2018 09:52:06 +0800 [thread overview]
Message-ID: <1522720327-68812-2-git-send-email-star.zeng@intel.com> (raw)
In-Reply-To: <1522720327-68812-1-git-send-email-star.zeng@intel.com>
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>
---
MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h b/MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h
index 0700eb51d6e1..012fa2aaec6e 100644
--- a/MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h
+++ b/MdeModulePkg/Include/Protocol/SmmMemoryAttribute.h
@@ -2,7 +2,7 @@
SMM Memory Attribute Protocol provides retrieval and update service
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
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
@@ -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
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.
@@ -64,17 +64,17 @@ EFI_STATUS
@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 clear for the memory region.
@retval EFI_INVALID_PARAMETER Length is zero.
Attributes specified an illegal combination of
attributes that cannot be set 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.
@@ -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
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
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.
**/
typedef
--
2.7.0.windows.1
next prev parent reply other threads:[~2018-04-03 1:52 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-03 1:52 [PATCH 0/2] Refine some comments about SmmMemoryAttribute Star Zeng
2018-04-03 1:52 ` Star Zeng [this message]
2018-04-03 11:36 ` [PATCH 1/2] MdeModulePkg SmmMemoryAttribute.h: Refine some comments Laszlo Ersek
2018-04-04 0:42 ` Zeng, Star
2018-04-03 1:52 ` [PATCH 2/2] UefiCpuPkg PiSmmCpuDxeSmm: Refine some comments about SmmMemoryAttribute Star Zeng
2018-04-03 11:42 ` Laszlo Ersek
2018-04-03 1:54 ` [PATCH 0/2] " Wang, Jian J
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1522720327-68812-2-git-send-email-star.zeng@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox