OvmfPkg: Skip initrd command on Xcode toolchain

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

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 31cd46614ed0e8e90e00e482900b690174137625..51eaa53809590262385a5ae227d16be968d0fd5a 100644 (file)
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -4,14 +4,8 @@
   Abstraction of a basic serial device. Targeted at 16550 UART, but\r
   could be much more generic.\r
 \r
   Abstraction of a basic serial device. Targeted at 16550 UART, but\r
   could be much more generic.\r
 \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
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -25,7 +19,7 @@
 \r
 ///\r
 /// Protocol GUID defined in EFI1.1.\r
 \r
 ///\r
 /// Protocol GUID defined in EFI1.1.\r

-/// \r
+///\r

 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r
 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r


@@ -33,7 +27,7 @@ typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;
 \r
 ///\r
 /// Backward-compatible with EFI1.1.\r
 \r
 ///\r
 /// Backward-compatible with EFI1.1.\r

-/// \r
+///\r

 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
 \r
 ///\r
 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
 \r
 ///\r


@@ -92,7 +86,7 @@ typedef enum {
   Reset the serial device.\r
 \r
   @param  This              Protocol instance pointer.\r
   Reset the serial device.\r
 \r
   @param  This              Protocol instance pointer.\r

-                            \r
+\r

   @retval EFI_SUCCESS       The device was reset.\r
   @retval EFI_DEVICE_ERROR  The serial device could not be reset.\r
 \r
   @retval EFI_SUCCESS       The device was reset.\r
   @retval EFI_DEVICE_ERROR  The serial device could not be reset.\r
 \r


@@ -104,7 +98,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \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
   data bits, and stop bits on a serial device.\r
 \r
   @param  This             Protocol instance pointer.\r


@@ -125,8 +119,9 @@ EFI_STATUS
                            value of DefaultStopBits will use the device's default number of\r
                            stop bits.\r
 \r
                            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
 \r
 **/\r
 typedef\r


@@ -164,7 +159,7 @@ EFI_STATUS
 \r
   @param  This              Protocol instance pointer.\r
   @param  Control           A pointer to return the current Control signals from the serial device.\r
 \r
   @param  This              Protocol instance pointer.\r
   @param  Control           A pointer to return the current Control signals from the serial device.\r

-                            \r
+\r

   @retval EFI_SUCCESS       The control bits were read from the serial device.\r
   @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.\r
 \r
   @retval EFI_SUCCESS       The control bits were read from the serial device.\r
   @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.\r
 \r


@@ -220,33 +215,33 @@ EFI_STATUS
 \r
 /**\r
   @par Data Structure Description:\r
 \r
 /**\r
   @par Data Structure Description:\r

-  The data values in SERIAL_IO_MODE are read-only and are updated by the code \r
+  The data values in SERIAL_IO_MODE are read-only and are updated by the code\r

   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
   @param ControlMask\r
   A mask for the Control bits that the device supports. The device\r
   must always support the Input Buffer Empty control bit.\r
   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
   @param ControlMask\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
+\r

   @param TimeOut\r
   If applicable, the number of microseconds to wait before timing out\r
   a Read or Write operation.\r
   @param TimeOut\r
   If applicable, the number of microseconds to wait before timing out\r
   a Read or Write operation.\r

-  \r
+\r

   @param BaudRate\r
   If applicable, the current baud rate setting of the device; otherwise,\r
   baud rate has the value of zero to indicate that device runs at the\r
   device's designed speed.\r
   @param BaudRate\r
   If applicable, the current baud rate setting of the device; otherwise,\r
   baud rate has the value of zero to indicate that device runs at the\r
   device's designed speed.\r

-  \r
+\r

   @param ReceiveFifoDepth\r
   The number of characters the device will buffer on input\r
   @param ReceiveFifoDepth\r
   The number of characters the device will buffer on input\r

-  \r
+\r

   @param DataBits\r
   The number of characters the device will buffer on input\r
   @param DataBits\r
   The number of characters the device will buffer on input\r

-  \r
+\r

   @param Parity\r
   @param Parity\r

-  If applicable, this is the EFI_PARITY_TYPE that is computed or \r
+  If applicable, this is the EFI_PARITY_TYPE that is computed or\r

   checked as each character is transmitted or reveived. If the device\r
   does not support parity the value is the default parity value.\r
   checked as each character is transmitted or reveived. If the device\r
   does not support parity the value is the default parity value.\r

-  \r
+\r

   @param StopBits\r
   If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\r
   character. If the device does not support stop bits the value is\r
   @param StopBits\r
   If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\r
   character. If the device does not support stop bits the value is\r


@@ -271,14 +266,14 @@ typedef struct {
 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION\r
 \r
 ///\r
 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION\r
 \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, serial ports attached \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, 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
 /// to a USB interface, or potentially any character-based I/O device.\r
 ///\r
 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 backwards compatible, \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 backwards compatible,\r

   /// it is not the same GUID.\r
   ///\r
   UINT32                      Revision;\r
   /// it is not the same GUID.\r
   ///\r
   UINT32                      Revision;\r