MdePkg/SerialIo: Fix inaccurate header comment.

[edk2] [PATCH] MdePkg/SerialIo: Fix inaccurate header comment.

Marvin Häuser posted 1 patch 5 years, 10 months ago

Download mbox

Failed in applying to current master (apply log)

MdePkg/Include/Protocol/SerialIo.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

Expand all Fold all

[edk2] [PATCH] MdePkg/SerialIo: Fix inaccurate header comment.

Posted by Marvin Häuser 5 years, 10 months ago

EFI_SERIAL_READ currently has comments suggesting a write function.
Update those comments to express it being the Read function.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marvin Haeuser <Marvin.Haeuser@outlook.com>
---
 MdePkg/Include/Protocol/SerialIo.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 1263dc4fe973..b155a19cac8b 100644
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -199,7 +199,7 @@ EFI_STATUS
   );
 
 /**
-  Writes data to a serial device.
+  Reads data from a serial device.
 
   @param  This              Protocol instance pointer.
   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
@@ -208,7 +208,7 @@ EFI_STATUS
 
   @retval EFI_SUCCESS       The data was read.
   @retval EFI_DEVICE_ERROR  The device reported an error.
-  @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
+  @retval EFI_TIMEOUT       The data read was stopped due to a timeout.
 
 **/
 typedef
-- 
2.17.1.windows.2

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel