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
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
- 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
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
(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
(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
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
@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
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
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
- @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, 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 backwards compatible, \r
+ /// it is not the same GUID.\r
+ ///\r
UINT32 Revision;\r
EFI_SERIAL_RESET Reset;\r
EFI_SERIAL_SET_ATTRIBUTES SetAttributes;\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
projects / mirror_edk2.git / blobdiff