Abstraction of a basic serial device. Targeted at 16550 UART, but\r
could be much more generic.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
+ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+ 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
http://opensource.org/licenses/bsd-license.php \r
typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE;\r
\r
///\r
-/// Serial IO Data structures\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
SpaceParity\r
} EFI_PARITY_TYPE;\r
\r
+///\r
+/// Stop bits type\r
+///\r
typedef enum {\r
DefaultStopBits,\r
OneStopBit,\r
data buts, and stop bits on a serial device.\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
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
#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
+///\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
+ /// must be backwards compatible. If a future version is not backwards compatible, \r
/// it is not the same GUID.\r
///\r
UINT32 Revision;\r
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