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
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel