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

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 9542ef1d94..32415ca144 100644
--- 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
   could be much more generic.
 
-  Copyright (c) 2006, Intel Corporation                                                         
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         
   All rights reserved. This program and the accompanying materials                          
   are licensed and made available under the terms and conditions of the BSD License         
   which accompanies this distribution.  The full text of the license may be found at        
@@ -23,22 +23,23 @@
     0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \
   }
 
-//
-// Protocol GUID defined in EFI1.1.
-// 
+///
+/// Protocol GUID defined in EFI1.1.
+/// 
 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID
 
 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;
 
 
-//
-// Backward-compatible with EFI1.1.
-// 
+///
+/// Backward-compatible with EFI1.1.
+/// 
 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,
   NoParity,
@@ -48,6 +49,9 @@ typedef enum {
   SpaceParity
 } EFI_PARITY_TYPE;
 
+///
+/// Stop bits type
+///
 typedef enum {
   DefaultStopBits,
   OneStopBit,
@@ -97,8 +101,7 @@ typedef
 EFI_STATUS
 (EFIAPI *EFI_SERIAL_RESET)(
   IN EFI_SERIAL_IO_PROTOCOL *This
-  )
-;
+  );
 
 /**
   Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, 
@@ -136,8 +139,7 @@ EFI_STATUS
   IN EFI_PARITY_TYPE                Parity,
   IN UINT8                          DataBits,
   IN EFI_STOP_BITS_TYPE             StopBits
-  )
-;
+  );
 
 /**
   Set the control bits on a serial device
@@ -155,8 +157,7 @@ EFI_STATUS
 (EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(
   IN EFI_SERIAL_IO_PROTOCOL         *This,
   IN UINT32                         Control
-  )
-;
+  );
 
 /**
   Retrieves the status of thecontrol bits on a serial device
@@ -173,8 +174,7 @@ EFI_STATUS
 (EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(
   IN EFI_SERIAL_IO_PROTOCOL         *This,
   OUT UINT32                        *Control
-  )
-;
+  );
 
 /**
   Writes data to a serial device.
@@ -195,8 +195,7 @@ EFI_STATUS
   IN EFI_SERIAL_IO_PROTOCOL         *This,
   IN OUT UINTN                      *BufferSize,
   IN VOID                           *Buffer
-  )
-;
+  );
 
 /**
   Writes data to a serial device.
@@ -217,26 +216,39 @@ EFI_STATUS
   IN EFI_SERIAL_IO_PROTOCOL         *This,
   IN OUT UINTN                      *BufferSize,
   OUT VOID                          *Buffer
-  )
-;
+  );
 
 /**
+  @par Data Structure Description:
   The data values in SERIAL_IO_MODE are read-only and are updated by the code 
   that produces the SERIAL_IO_PROTOCOL member functions.
 
-  ControlMask - A mask fo the Control bits that the device supports. The device
+  @param ControlMask
+  A mask fo the Control bits that the device supports. The device
   must always support the Input Buffer Empty control bit.
-  TimeOut  - If applicable, the number of microseconds to wait before timing out
+  
+  @param TimeOut
+  If applicable, the number of microseconds to wait before timing out
   a Read or Write operation.
-  BaudRate - If applicable, the current baud rate setting of the device; otherwise,
+  
+  @param BaudRate
+  If applicable, the current baud rate setting of the device; otherwise,
   baud rate has the value of zero to indicate that device runs at the
   device's designed speed.
-  ReceiveFifoDepth - The number of characters the device will buffer on input
-  DataBits - The number of characters the device will buffer on input
-  Parity   - If applicable, this is the EFI_PARITY_TYPE that is computed or 
+  
+  @param ReceiveFifoDepth
+  The number of characters the device will buffer on input
+  
+  @param DataBits
+  The number of characters the device will buffer on input
+  
+  @param Parity
+  If applicable, this is the EFI_PARITY_TYPE that is computed or 
   checked as each character is transmitted or reveived. If the device
   does not support parity the value is the default parity value.
-  StopBits - If applicable, the EFI_STOP_BITS_TYPE number of stop bits per
+  
+  @param StopBits
+  If applicable, the EFI_STOP_BITS_TYPE number of stop bits per
   character. If the device does not support stop bits the value is
   the default stop bit values.
 
@@ -258,7 +270,17 @@ typedef struct {
 #define EFI_SERIAL_IO_PROTOCOL_REVISION    0x00010000
 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION
 
+///
+/// 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;
@@ -266,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;
 };