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 4af00fcad9d95ba14b654272ca76a942ca066744..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
@@ -37,7 +37,8 @@ typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;
 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
 \r
 ///\r
-/// Serial IO Data structures\r
+/// Parity type that is computed or checked as each character is transmitted or received. If the\r
+/// device does not support parity, the value is the default parity value.\r
 ///\r
 typedef enum {\r
   DefaultParity,\r
@@ -48,6 +49,9 @@ typedef enum {
   SpaceParity\r
 } EFI_PARITY_TYPE;\r
 \r
+///\r
+/// Stop bits type\r
+///\r
 typedef enum {\r
   DefaultStopBits,\r
   OneStopBit,\r
@@ -101,14 +105,14 @@ EFI_STATUS
 \r
 /**\r
   Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
-  data buts, and stop bits on a serial device.\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 the\r
+  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the\r
                            device's default interface speed.\r
   @param  ReveiveFifoDepth The requested depth of the FIFO on the receive side of the\r
                            serial interface. A ReceiveFifoDepth value of 0 will use\r
-                           the device's dfault FIFO depth.\r
+                           the device's default FIFO depth.\r
   @param  Timeout          The requested time out for a single character in microseconds.\r
                            This timeout applies to both the transmit and receive side of the\r
                            interface. A Timeout value of 0 will use the device's default time\r
@@ -121,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
@@ -220,7 +225,7 @@ EFI_STATUS
   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
   @param ControlMask\r
-  A mask fo the Control bits that the device supports. The device\r
+  A mask for the Control bits that the device supports. The device\r
   must always support the Input Buffer Empty control bit.\r
   \r
   @param TimeOut\r
@@ -274,7 +279,7 @@ typedef struct {
 struct _EFI_SERIAL_IO_PROTOCOL {\r
   ///\r
   /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
-  /// must be backwards compatible. If a future version is not back wards compatible, \r
+  /// must be backwards compatible. If a future version is not backwards compatible, \r
   /// it is not the same GUID.\r
   ///\r
   UINT32                      Revision;\r