X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FSerialIo.h;h=32415ca144fea751f152a9aed138ce5ee7085d6a;hb=34860f7a069641fb9e14077c01605215aae68a9b;hp=5c69f8996e273a0c0dfe007c92def65e53b95d70;hpb=ed66e1bc0d2be0a185fc47adab4930c3b7e2767f;p=mirror_edk2.git

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 5c69f8996e..32415ca144 100644
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -37,7 +37,8 @@ typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;
 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;
 
 ///
-/// Serial IO Data structures
+/// Parity type that is computed or checked as each character is transmitted or received. If the
+/// device does not support parity, the value is the default parity value.
 ///
 typedef enum {
   DefaultParity,
@@ -48,6 +49,9 @@ typedef enum {
   SpaceParity
 } EFI_PARITY_TYPE;
 
+///
+/// Stop bits type
+///
 typedef enum {
   DefaultStopBits,
   OneStopBit,
@@ -266,44 +270,17 @@ typedef struct {
 #define EFI_SERIAL_IO_PROTOCOL_REVISION    0x00010000
 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION
 
-/**  
-  @par Protocol Description:
-  The Serial I/O protocol is used to communicate with UART-style serial devices. 
-  These can be standard UART serial ports in PC-AT systems, serial ports attached 
-  to a USB interface, or potentially any character-based I/O device.
-
-  @param Revision
-  The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions 
-  must be backwards compatible. If a future version is not back wards compatible, 
-  it is not the same GUID.
-
-  @param Reset
-  Resets the hardware device.
-
-  @param SetAttributes
-  Sets communication parameters for a serial device. These include 
-  the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, 
-  and stop bit attributes.
-
-  @param SetControl
-  Sets the control bits on a serial device. These include Request to 
-  Send and Data Terminal Ready.
-
-  @param GetControl
-  Reads the status of the control bits on a serial device. These include 
-  Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.
-
-  @param Write
-  Sends a buffer of characters to a serial device.
-
-  @param Read
-  Receives a buffer of characters from a serial device.
-
-  @param Mode
-  Pointer to SERIAL_IO_MODE data. 
-  
-**/
+///
+/// The Serial I/O protocol is used to communicate with UART-style serial devices. 
+/// These can be standard UART serial ports in PC-AT systems, serial ports attached 
+/// to a USB interface, or potentially any character-based I/O device.
+///
 struct _EFI_SERIAL_IO_PROTOCOL {
+  ///
+  /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions 
+  /// must be backwards compatible. If a future version is not back wards compatible, 
+  /// it is not the same GUID.
+  ///
   UINT32                      Revision;
   EFI_SERIAL_RESET            Reset;
   EFI_SERIAL_SET_ATTRIBUTES   SetAttributes;
@@ -311,7 +288,9 @@ struct _EFI_SERIAL_IO_PROTOCOL {
   EFI_SERIAL_GET_CONTROL_BITS GetControl;
   EFI_SERIAL_WRITE            Write;
   EFI_SERIAL_READ             Read;
-
+  ///
+  /// Pointer to SERIAL_IO_MODE data.
+  ///
   EFI_SERIAL_IO_MODE          *Mode;
 };