From: Julien Grall <julien.grall@linaro.org>
To: star.zeng@intel.com, eric.dong@intel.com, pankaj.bansal@nxp.com,
lersek@redhat.com, leif.lindholm@linaro.org
Cc: edk2-devel@lists.01.org, Julien Grall <julien.grall@linaro.org>
Subject: [PATCH v3 1/3] MdeModulePkg/SerialDxe: Describe correctly EFI_DEVICE_ERROR for SetAttributes
Date: Wed, 29 Nov 2017 17:28:21 +0000 [thread overview]
Message-ID: <20171129172823.2906-2-julien.grall@linaro.org> (raw)
In-Reply-To: <20171129172823.2906-1-julien.grall@linaro.org>
Per the UEFIv2.7 spec, EFI_DEVICE_ERROR is returned when the serial
device is not functioning correctly. Update the description to avoid
confusion.
Contributed-under: Tianocore Contribution Agreement 1.1
Signed-off-by: Julien Grall <julien.grall@linaro.org>
Reviewed-by: Star Zeng <star.zeng@intel.com>
---
Star, I found a prototype for SetAttributes in SerialIo.c as well
and updated the description there. I decided to keep the Reviewed-by
even with that change. Let me know whether it is fine for you.
Changes in v3:
- Modify description of EFI_DEVICE_ERROR above the prototypes
for SetAttributes as well.
- Add Star reviewed-by
---
MdeModulePkg/Universal/SerialDxe/SerialIo.c | 4 ++--
MdePkg/Include/Protocol/SerialIo.h | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/MdeModulePkg/Universal/SerialDxe/SerialIo.c b/MdeModulePkg/Universal/SerialDxe/SerialIo.c
index 964d0329f4..19fc889c25 100644
--- a/MdeModulePkg/Universal/SerialDxe/SerialIo.c
+++ b/MdeModulePkg/Universal/SerialDxe/SerialIo.c
@@ -67,7 +67,7 @@ SerialReset (
stop bits.
@retval EFI_SUCCESS The device was reset.
- @retval EFI_DEVICE_ERROR The serial device could not be reset.
+ @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/
EFI_STATUS
@@ -265,7 +265,7 @@ SerialReset (
stop bits.
@retval EFI_SUCCESS The device was reset.
- @retval EFI_DEVICE_ERROR The serial device could not be reset.
+ @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/
EFI_STATUS
diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 31cd46614e..84cb34364d 100644
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -126,7 +126,7 @@ EFI_STATUS
stop bits.
@retval EFI_SUCCESS The device was reset.
- @retval EFI_DEVICE_ERROR The serial device could not be reset.
+ @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/
typedef
--
2.11.0
next prev parent reply other threads:[~2017-11-29 17:24 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-29 17:28 [PATCH v3 0/3] MdeModulePkg/SerialDxe: Do not fail reset when SetAttributes is not supported Julien Grall
2017-11-29 17:28 ` Julien Grall [this message]
2017-11-29 17:28 ` [PATCH v3 2/3] MdeModulePkg/SerialDxe: Fix return valued in SerialSetAttributes Julien Grall
2017-11-29 18:24 ` Laszlo Ersek
2017-11-29 17:28 ` [PATCH v3 3/3] MdeModulePkg/SerialDxe: Do not fail reset when SetAttributes is not supported Julien Grall
2017-11-30 1:15 ` [PATCH v3 0/3] " Zeng, Star
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=20171129172823.2906-2-julien.grall@linaro.org \
--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