public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH] MdePkg/SerialIo: Fix inaccurate header comment.
@ 2018-06-16 16:15 Marvin Häuser
  0 siblings, 0 replies; only message in thread
From: Marvin Häuser @ 2018-06-16 16:15 UTC (permalink / raw)
  To: edk2-devel@lists.01.org; +Cc: michael.d.kinney@intel.com, liming.gao@intel.com

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



^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2018-06-16 16:15 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-06-16 16:15 [PATCH] MdePkg/SerialIo: Fix inaccurate header comment Marvin Häuser

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox