Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 3cffd930e5e165bb00f8c5583b1aad83253c93fc..32415ca144fea751f152a9aed138ce5ee7085d6a 100644 (file)
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -23,22 +23,23 @@
     0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r
 \r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
 \r
-//\r
-// Serial IO Data structures\r
-//\r
+///\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
   NoParity,\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
@@ -97,8 +101,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_SERIAL_RESET)(\r
   IN EFI_SERIAL_IO_PROTOCOL *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
@@ -136,8 +139,7 @@ EFI_STATUS
   IN EFI_PARITY_TYPE                Parity,\r
   IN UINT8                          DataBits,\r
   IN EFI_STOP_BITS_TYPE             StopBits\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set the control bits on a serial device\r
@@ -155,8 +157,7 @@ EFI_STATUS
 (EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(\r
   IN EFI_SERIAL_IO_PROTOCOL         *This,\r
   IN UINT32                         Control\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves the status of thecontrol bits on a serial device\r
@@ -173,8 +174,7 @@ EFI_STATUS
 (EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(\r
   IN EFI_SERIAL_IO_PROTOCOL         *This,\r
   OUT UINT32                        *Control\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes data to a serial device.\r
@@ -195,8 +195,7 @@ EFI_STATUS
   IN EFI_SERIAL_IO_PROTOCOL         *This,\r
   IN OUT UINTN                      *BufferSize,\r
   IN VOID                           *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes data to a serial device.\r
@@ -217,8 +216,7 @@ EFI_STATUS
   IN EFI_SERIAL_IO_PROTOCOL         *This,\r
   IN OUT UINTN                      *BufferSize,\r
   OUT VOID                          *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   @par Data Structure Description:\r
@@ -272,44 +270,17 @@ 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
+///\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
+  /// 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
   UINT32                      Revision;\r
   EFI_SERIAL_RESET            Reset;\r
   EFI_SERIAL_SET_ATTRIBUTES   SetAttributes;\r
@@ -317,7 +288,9 @@ struct _EFI_SERIAL_IO_PROTOCOL {
   EFI_SERIAL_GET_CONTROL_BITS GetControl;\r
   EFI_SERIAL_WRITE            Write;\r
   EFI_SERIAL_READ             Read;\r
-\r
+  ///\r
+  /// Pointer to SERIAL_IO_MODE data.\r
+  ///\r
   EFI_SERIAL_IO_MODE          *Mode;\r
 };\r
 \r