Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 9542ef1d94c1d443b468b5236c759f1353d02d12..3cffd930e5e165bb00f8c5583b1aad83253c93fc 100644 (file)
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -4,7 +4,7 @@
   Abstraction of a basic serial device. Targeted at 16550 UART, but\r
   could be much more generic.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -221,22 +221,36 @@ EFI_STATUS
 ;\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
   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
-  ControlMask - A mask fo the Control bits that the device supports. The device\r
+  @param ControlMask\r
+  A mask fo the Control bits that the device supports. The device\r
   must always support the Input Buffer Empty control bit.\r
-  TimeOut  - If applicable, the number of microseconds to wait before timing out\r
+  \r
+  @param TimeOut\r
+  If applicable, the number of microseconds to wait before timing out\r
   a Read or Write operation.\r
-  BaudRate - If applicable, the current baud rate setting of the device; otherwise,\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
-  ReceiveFifoDepth - The number of characters the device will buffer on input\r
-  DataBits - The number of characters the device will buffer on input\r
-  Parity   - If applicable, this is the EFI_PARITY_TYPE that is computed or \r
+  \r
+  @param ReceiveFifoDepth\r
+  The number of characters the device will buffer on input\r
+  \r
+  @param DataBits\r
+  The number of characters the device will buffer on input\r
+  \r
+  @param Parity\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
-  StopBits - If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\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
   the default stop bit values.\r
 \r
@@ -258,6 +272,43 @@ typedef struct {
 #define EFI_SERIAL_IO_PROTOCOL_REVISION    0x00010000\r
 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION\r
 \r
+/**  \r
+  @par Protocol Description:\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
+  @param Revision\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
+  it is not the same GUID.\r
+\r
+  @param Reset\r
+  Resets the hardware device.\r
+\r
+  @param SetAttributes\r
+  Sets communication parameters for a serial device. These include \r
+  the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, \r
+  and stop bit attributes.\r
+\r
+  @param SetControl\r
+  Sets the control bits on a serial device. These include Request to \r
+  Send and Data Terminal Ready.\r
+\r
+  @param GetControl\r
+  Reads the status of the control bits on a serial device. These include \r
+  Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.\r
+\r
+  @param Write\r
+  Sends a buffer of characters to a serial device.\r
+\r
+  @param Read\r
+  Receives a buffer of characters from a serial device.\r
+\r
+  @param Mode\r
+  Pointer to SERIAL_IO_MODE data. \r
+  \r
+**/\r
 struct _EFI_SERIAL_IO_PROTOCOL {\r
   UINT32                      Revision;\r
   EFI_SERIAL_RESET            Reset;\r