]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SerialIo.h
Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...
[mirror_edk2.git] / MdePkg / Include / Protocol / SerialIo.h
index 32415ca144fea751f152a9aed138ce5ee7085d6a..4fbfe027ebf37f616ea68a9a47073a87ef5dc1d0 100644 (file)
@@ -104,15 +104,20 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
-  data buts, and stop bits on a serial device.\r
+  Sets the following attributes for a serial device:\r
+  * baud rate\r
+  * receive FIFO depth\r
+  * transmit/receive time out\r
+  * parity \r
+  * data bits\r
+  * stop bits\r
 \r
   @param  This             Protocol instance pointer.\r
-  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the the\r
+  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the\r
                            device's default interface speed.\r
   @param  ReveiveFifoDepth The requested depth of the FIFO on the receive side of the\r
                            serial interface. A ReceiveFifoDepth value of 0 will use\r
-                           the device's dfault FIFO depth.\r
+                           the device's default FIFO depth.\r
   @param  Timeout          The requested time out for a single character in microseconds.\r
                            This timeout applies to both the transmit and receive side of the\r
                            interface. A Timeout value of 0 will use the device's default time\r
@@ -203,7 +208,7 @@ EFI_STATUS
   @param  This              Protocol instance pointer.\r
   @param  BufferSize        On input, the size of the Buffer. On output, the amount of\r
                             data returned in Buffer.\r
-  @param  Buffer            The buffer to return the data into.\r
+  @param  Buffer            The buffer to which to return the data.\r
 \r
   @retval EFI_SUCCESS       The data was read.\r
   @retval EFI_DEVICE_ERROR  The device reported an error.\r
@@ -224,7 +229,7 @@ EFI_STATUS
   that produces the SERIAL_IO_PROTOCOL member functions.\r
 \r
   @param ControlMask\r
-  A mask fo the Control bits that the device supports. The device\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
   @param TimeOut\r
@@ -272,13 +277,13 @@ typedef struct {
 \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
+/// These can be standard UART serial ports in PC-AT systems, or serial ports attached \r
+/// to a USB interface or 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
+  /// must be backwards compatible. If a future version is not backwards compatible, \r
   /// it is not the same GUID.\r
   ///\r
   UINT32                      Revision;\r