MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC

[mirror_edk2.git] / MdePkg / Include / Protocol / SerialIo.h

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 4fbfe027ebf37f616ea68a9a47073a87ef5dc1d0..1263dc4fe9731b285fab0a60683742290f2491ff 100644 (file)
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -4,8 +4,8 @@
   Abstraction of a basic serial device. Targeted at 16550 UART, but\r
   could be much more generic.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -104,13 +104,8 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Sets the following attributes for a serial device:\r
-  * baud rate\r
-  * receive FIFO depth\r
-  * transmit/receive time out\r
-  * parity \r
-  * data bits\r
-  * stop bits\r
+  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
+  data bits, and stop bits on a serial device.\r
 \r
   @param  This             Protocol instance pointer.\r
   @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the\r
@@ -130,8 +125,9 @@ EFI_STATUS
                            value of DefaultStopBits will use the device's default number of\r
                            stop bits.\r
 \r
-  @retval EFI_SUCCESS      The device was reset.\r
-  @retval EFI_DEVICE_ERROR The serial device could not be reset.\r
+  @retval EFI_SUCCESS           The device was reset.\r
+  @retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.\r
+  @retval EFI_DEVICE_ERROR      The serial device is not functioning correctly.\r
 \r
 **/\r
 typedef\r
@@ -208,7 +204,7 @@ EFI_STATUS
   @param  This              Protocol instance pointer.\r
   @param  BufferSize        On input, the size of the Buffer. On output, the amount of\r
                             data returned in Buffer.\r
-  @param  Buffer            The buffer to which to return the data.\r
+  @param  Buffer            The buffer to return the data into.\r
 \r
   @retval EFI_SUCCESS       The data was read.\r
   @retval EFI_DEVICE_ERROR  The device reported an error.\r
@@ -277,8 +273,8 @@ typedef struct {
 \r
 ///\r
 /// The Serial I/O protocol is used to communicate with UART-style serial devices. \r
-/// These can be standard UART serial ports in PC-AT systems, or serial ports attached \r
-/// to a USB interface or any character-based I/O device.\r
+/// These can be standard UART serial ports in PC-AT systems, serial ports attached \r
+/// to a USB interface, or potentially any character-based I/O device.\r
 ///\r
 struct _EFI_SERIAL_IO_PROTOCOL {\r
   ///\r