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

/** @file\r
  Serial IO protocol as defined in the UEFI 2.0 specification.\r
\r
  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
  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
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __SERIAL_IO_PROTOCOL_H__\r
#define __SERIAL_IO_PROTOCOL_H__\r
\r
#define EFI_SERIAL_IO_PROTOCOL_GUID \\r
  { \\r
    0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \\r
  }\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
typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
\r
//\r
// Serial IO Data structures\r
//\r
typedef enum {\r
  DefaultParity,\r
  NoParity,\r
  EvenParity,\r
  OddParity,\r
  MarkParity,\r
  SpaceParity\r
} EFI_PARITY_TYPE;\r
\r
typedef enum {\r
  DefaultStopBits,\r
  OneStopBit,\r
  OneFiveStopBits,\r
  TwoStopBits\r
} EFI_STOP_BITS_TYPE;\r
\r
//\r
// define for Control bits, grouped by read only, write only, and read write\r
//\r
//\r
// Read Only\r
//\r
#define EFI_SERIAL_CLEAR_TO_SEND        0x00000010\r
#define EFI_SERIAL_DATA_SET_READY       0x00000020\r
#define EFI_SERIAL_RING_INDICATE        0x00000040\r
#define EFI_SERIAL_CARRIER_DETECT       0x00000080\r
#define EFI_SERIAL_INPUT_BUFFER_EMPTY   0x00000100\r
#define EFI_SERIAL_OUTPUT_BUFFER_EMPTY  0x00000200\r
\r
//\r
// Write Only\r
//\r
#define EFI_SERIAL_REQUEST_TO_SEND      0x00000002\r
#define EFI_SERIAL_DATA_TERMINAL_READY  0x00000001\r
\r
//\r
// Read Write\r
//\r
#define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE     0x00001000\r
#define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE     0x00002000\r
#define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x00004000\r
\r
//\r
// Serial IO Member Functions\r
//\r
/**\r
  Reset the serial device.\r
\r
  @param  This              Protocol instance pointer.\r
                            \r
  @retval EFI_SUCCESS       The device was reset.\r
  @retval EFI_DEVICE_ERROR  The serial device could not be reset.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_RESET)(\r
  IN EFI_SERIAL_IO_PROTOCOL *This\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
\r
  @param  This             Protocol instance pointer.\r
  @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the 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
  @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
                           out value.\r
  @param  Parity           The type of parity to use on this serial device. A Parity value of\r
                           DefaultParity will use the device's default parity value.\r
  @param  DataBits         The number of data bits to use on the serial device. A DataBits\r
                           vaule of 0 will use the device's default data bit setting.\r
  @param  StopBits         The number of stop bits to use on this serial device. A StopBits\r
                           value of DefaultStopBits will use the device's default number of\r
                           stop bits.\r
\r
  @retval EFI_SUCCESS      The device was reset.\r
  @retval EFI_DEVICE_ERROR The serial device could not be reset.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_SET_ATTRIBUTES)(\r
  IN EFI_SERIAL_IO_PROTOCOL         *This,\r
  IN UINT64                         BaudRate,\r
  IN UINT32                         ReceiveFifoDepth,\r
  IN UINT32                         Timeout,\r
  IN EFI_PARITY_TYPE                Parity,\r
  IN UINT8                          DataBits,\r
  IN EFI_STOP_BITS_TYPE             StopBits\r
  )\r
;\r
\r
/**\r
  Set the control bits on a serial device\r
\r
  @param  This             Protocol instance pointer.\r
  @param  Control          Set the bits of Control that are settable.\r
\r
  @retval EFI_SUCCESS      The new control bits were set on the serial device.\r
  @retval EFI_UNSUPPORTED  The serial device does not support this operation.\r
  @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(\r
  IN EFI_SERIAL_IO_PROTOCOL         *This,\r
  IN UINT32                         Control\r
  )\r
;\r
\r
/**\r
  Retrieves the status of thecontrol bits on a serial device\r
\r
  @param  This              Protocol instance pointer.\r
  @param  Control           A pointer to return the current Control signals from the serial device.\r
                            \r
  @retval EFI_SUCCESS       The control bits were read from the serial device.\r
  @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(\r
  IN EFI_SERIAL_IO_PROTOCOL         *This,\r
  OUT UINT32                        *Control\r
  )\r
;\r
\r
/**\r
  Writes data to a serial device.\r
\r
  @param  This              Protocol instance pointer.\r
  @param  BufferSize        On input, the size of the Buffer. On output, the amount of\r
                            data actually written.\r
  @param  Buffer            The buffer of data to write\r
\r
  @retval EFI_SUCCESS       The data was written.\r
  @retval EFI_DEVICE_ERROR  The device reported an error.\r
  @retval EFI_TIMEOUT       The data write was stopped due to a timeout.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_WRITE)(\r
  IN EFI_SERIAL_IO_PROTOCOL         *This,\r
  IN OUT UINTN                      *BufferSize,\r
  IN VOID                           *Buffer\r
  )\r
;\r
\r
/**\r
  Writes data to a serial device.\r
\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
\r
  @retval EFI_SUCCESS       The data was read.\r
  @retval EFI_DEVICE_ERROR  The device reported an error.\r
  @retval EFI_TIMEOUT       The data write was stopped due to a timeout.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SERIAL_READ)(\r
  IN EFI_SERIAL_IO_PROTOCOL         *This,\r
  IN OUT UINTN                      *BufferSize,\r
  OUT VOID                          *Buffer\r
  )\r
;\r
\r
/**\r
  @par Data Structure Description:\r
  The data values in SERIAL_IO_MODE are read-only and are updated by the code \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
  must always support the Input Buffer Empty control bit.\r
  \r
  @param TimeOut\r
  If applicable, the number of microseconds to wait before timing out\r
  a Read or Write operation.\r
  \r
  @param BaudRate\r
  If applicable, the current baud rate setting of the device; otherwise,\r
  baud rate has the value of zero to indicate that device runs at the\r
  device's designed speed.\r
  \r
  @param ReceiveFifoDepth\r
  The number of characters the device will buffer on input\r
  \r
  @param DataBits\r
  The number of characters the device will buffer on input\r
  \r
  @param Parity\r
  If applicable, this is the EFI_PARITY_TYPE that is computed or \r
  checked as each character is transmitted or reveived. If the device\r
  does not support parity the value is the default parity value.\r
  \r
  @param StopBits\r
  If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\r
  character. If the device does not support stop bits the value is\r
  the default stop bit values.\r
\r
**/\r
typedef struct {\r
  UINT32  ControlMask;\r
\r
  //\r
  // current Attributes\r
  //\r
  UINT32  Timeout;\r
  UINT64  BaudRate;\r
  UINT32  ReceiveFifoDepth;\r
  UINT32  DataBits;\r
  UINT32  Parity;\r
  UINT32  StopBits;\r
} EFI_SERIAL_IO_MODE;\r
\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
struct _EFI_SERIAL_IO_PROTOCOL {\r
  UINT32                      Revision;\r
  EFI_SERIAL_RESET            Reset;\r
  EFI_SERIAL_SET_ATTRIBUTES   SetAttributes;\r
  EFI_SERIAL_SET_CONTROL_BITS SetControl;\r
  EFI_SERIAL_GET_CONTROL_BITS GetControl;\r
  EFI_SERIAL_WRITE            Write;\r
  EFI_SERIAL_READ             Read;\r
\r
  EFI_SERIAL_IO_MODE          *Mode;\r
};\r
\r
extern EFI_GUID gEfiSerialIoProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
d1f95000	1	/** @file\r
8a7d75b0	2	Serial IO protocol as defined in the UEFI 2.0 specification.\r
d1f95000	3	\r
	4	Abstraction of a basic serial device. Targeted at 16550 UART, but\r
	5	could be much more generic.\r
	6	\r
4ca9b6c4	7	Copyright (c) 2006 - 2008, Intel Corporation \r
d1f95000	8	All rights reserved. This program and the accompanying materials \r
	9	are licensed and made available under the terms and conditions of the BSD License \r
	10	which accompanies this distribution. The full text of the license may be found at \r
	11	http://opensource.org/licenses/bsd-license.php \r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	15	\r
d1f95000	16	**/\r
	17	\r
	18	#ifndef __SERIAL_IO_PROTOCOL_H__\r
	19	#define __SERIAL_IO_PROTOCOL_H__\r
	20	\r
	21	#define EFI_SERIAL_IO_PROTOCOL_GUID \\r
	22	{ \\r
	23	0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \\r
	24	}\r
	25	\r
a6508c05	26	//\r
	27	// Protocol GUID defined in EFI1.1.\r
	28	// \r
	29	#define SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL_GUID\r
	30	\r
d1f95000	31	typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r
d1f95000	32	\r
a6508c05	33	\r
	34	//\r
	35	// Backward-compatible with EFI1.1.\r
	36	// \r
	37	typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE;\r
	38	\r
d1f95000	39	//\r
	40	// Serial IO Data structures\r
	41	//\r
	42	typedef enum {\r
	43	DefaultParity,\r
	44	NoParity,\r
	45	EvenParity,\r
	46	OddParity,\r
	47	MarkParity,\r
	48	SpaceParity\r
	49	} EFI_PARITY_TYPE;\r
	50	\r
	51	typedef enum {\r
	52	DefaultStopBits,\r
	53	OneStopBit,\r
	54	OneFiveStopBits,\r
	55	TwoStopBits\r
	56	} EFI_STOP_BITS_TYPE;\r
	57	\r
	58	//\r
	59	// define for Control bits, grouped by read only, write only, and read write\r
	60	//\r
	61	//\r
	62	// Read Only\r
	63	//\r
	64	#define EFI_SERIAL_CLEAR_TO_SEND 0x00000010\r
	65	#define EFI_SERIAL_DATA_SET_READY 0x00000020\r
	66	#define EFI_SERIAL_RING_INDICATE 0x00000040\r
	67	#define EFI_SERIAL_CARRIER_DETECT 0x00000080\r
	68	#define EFI_SERIAL_INPUT_BUFFER_EMPTY 0x00000100\r
	69	#define EFI_SERIAL_OUTPUT_BUFFER_EMPTY 0x00000200\r
	70	\r
	71	//\r
	72	// Write Only\r
	73	//\r
	74	#define EFI_SERIAL_REQUEST_TO_SEND 0x00000002\r
	75	#define EFI_SERIAL_DATA_TERMINAL_READY 0x00000001\r
	76	\r
	77	//\r
	78	// Read Write\r
	79	//\r
	80	#define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE 0x00001000\r
	81	#define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE 0x00002000\r
	82	#define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x00004000\r
	83	\r
	84	//\r
	85	// Serial IO Member Functions\r
	86	//\r
	87	/**\r
	88	Reset the serial device.\r
	89	\r
	90	@param This Protocol instance pointer.\r
	91	\r
	92	@retval EFI_SUCCESS The device was reset.\r
	93	@retval EFI_DEVICE_ERROR The serial device could not be reset.\r
	94	\r
	95	**/\r
	96	typedef\r
	97	EFI_STATUS\r
8b13229b	98	(EFIAPI *EFI_SERIAL_RESET)(\r
d1f95000	99	IN EFI_SERIAL_IO_PROTOCOL *This\r
	100	)\r
	101	;\r
	102	\r
	103	/**\r
	104	Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
	105	data buts, and stop bits on a serial device.\r
	106	\r
	107	@param This Protocol instance pointer.\r
	108	@param BaudRate The requested baud rate. A BaudRate value of 0 will use the the\r
	109	device's default interface speed.\r
	110	@param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the\r
	111	serial interface. A ReceiveFifoDepth value of 0 will use\r
	112	the device's dfault FIFO depth.\r
	113	@param Timeout The requested time out for a single character in microseconds.\r
	114	This timeout applies to both the transmit and receive side of the\r
	115	interface. A Timeout value of 0 will use the device's default time\r
	116	out value.\r
	117	@param Parity The type of parity to use on this serial device. A Parity value of\r
	118	DefaultParity will use the device's default parity value.\r
	119	@param DataBits The number of data bits to use on the serial device. A DataBits\r
	120	vaule of 0 will use the device's default data bit setting.\r
	121	@param StopBits The number of stop bits to use on this serial device. A StopBits\r
	122	value of DefaultStopBits will use the device's default number of\r
	123	stop bits.\r
	124	\r
	125	@retval EFI_SUCCESS The device was reset.\r
	126	@retval EFI_DEVICE_ERROR The serial device could not be reset.\r
	127	\r
	128	**/\r
	129	typedef\r
	130	EFI_STATUS\r
8b13229b	131	(EFIAPI *EFI_SERIAL_SET_ATTRIBUTES)(\r
d1f95000	132	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	133	IN UINT64 BaudRate,\r
	134	IN UINT32 ReceiveFifoDepth,\r
	135	IN UINT32 Timeout,\r
	136	IN EFI_PARITY_TYPE Parity,\r
	137	IN UINT8 DataBits,\r
	138	IN EFI_STOP_BITS_TYPE StopBits\r
	139	)\r
	140	;\r
	141	\r
	142	/**\r
	143	Set the control bits on a serial device\r
	144	\r
	145	@param This Protocol instance pointer.\r
	146	@param Control Set the bits of Control that are settable.\r
	147	\r
	148	@retval EFI_SUCCESS The new control bits were set on the serial device.\r
	149	@retval EFI_UNSUPPORTED The serial device does not support this operation.\r
	150	@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
	151	\r
	152	**/\r
	153	typedef\r
	154	EFI_STATUS\r
8b13229b	155	(EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(\r
d1f95000	156	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	157	IN UINT32 Control\r
	158	)\r
	159	;\r
	160	\r
	161	/**\r
	162	Retrieves the status of thecontrol bits on a serial device\r
	163	\r
	164	@param This Protocol instance pointer.\r
	165	@param Control A pointer to return the current Control signals from the serial device.\r
	166	\r
	167	@retval EFI_SUCCESS The control bits were read from the serial device.\r
	168	@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
	169	\r
	170	**/\r
	171	typedef\r
	172	EFI_STATUS\r
8b13229b	173	(EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(\r
d1f95000	174	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	175	OUT UINT32 *Control\r
	176	)\r
	177	;\r
	178	\r
	179	/**\r
	180	Writes data to a serial device.\r
	181	\r
	182	@param This Protocol instance pointer.\r
	183	@param BufferSize On input, the size of the Buffer. On output, the amount of\r
	184	data actually written.\r
	185	@param Buffer The buffer of data to write\r
	186	\r
	187	@retval EFI_SUCCESS The data was written.\r
	188	@retval EFI_DEVICE_ERROR The device reported an error.\r
	189	@retval EFI_TIMEOUT The data write was stopped due to a timeout.\r
	190	\r
	191	**/\r
	192	typedef\r
	193	EFI_STATUS\r
8b13229b	194	(EFIAPI *EFI_SERIAL_WRITE)(\r
d1f95000	195	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	196	IN OUT UINTN *BufferSize,\r
	197	IN VOID *Buffer\r
	198	)\r
	199	;\r
	200	\r
	201	/**\r
	202	Writes data to a serial device.\r
	203	\r
	204	@param This Protocol instance pointer.\r
	205	@param BufferSize On input, the size of the Buffer. On output, the amount of\r
	206	data returned in Buffer.\r
	207	@param Buffer The buffer to return the data into.\r
	208	\r
	209	@retval EFI_SUCCESS The data was read.\r
	210	@retval EFI_DEVICE_ERROR The device reported an error.\r
	211	@retval EFI_TIMEOUT The data write was stopped due to a timeout.\r
	212	\r
	213	**/\r
	214	typedef\r
	215	EFI_STATUS\r
8b13229b	216	(EFIAPI *EFI_SERIAL_READ)(\r
d1f95000	217	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	218	IN OUT UINTN *BufferSize,\r
	219	OUT VOID *Buffer\r
	220	)\r
	221	;\r
	222	\r
	223	/**\r
4ca9b6c4	224	@par Data Structure Description:\r
d1f95000	225	The data values in SERIAL_IO_MODE are read-only and are updated by the code \r
	226	that produces the SERIAL_IO_PROTOCOL member functions.\r
	227	\r
4ca9b6c4 LG	228	@param ControlMask\r
4ca9b6c4 LG	229	A mask fo the Control bits that the device supports. The device\r
d1f95000	230	must always support the Input Buffer Empty control bit.\r
4ca9b6c4 LG	231	\r
	232	@param TimeOut\r
	233	If applicable, the number of microseconds to wait before timing out\r
d1f95000	234	a Read or Write operation.\r
4ca9b6c4 LG	235	\r
	236	@param BaudRate\r
	237	If applicable, the current baud rate setting of the device; otherwise,\r
d1f95000	238	baud rate has the value of zero to indicate that device runs at the\r
d1f95000	239	device's designed speed.\r
4ca9b6c4 LG	240	\r
	241	@param ReceiveFifoDepth\r
	242	The number of characters the device will buffer on input\r
	243	\r
	244	@param DataBits\r
	245	The number of characters the device will buffer on input\r
	246	\r
	247	@param Parity\r
	248	If applicable, this is the EFI_PARITY_TYPE that is computed or \r
d1f95000	249	checked as each character is transmitted or reveived. If the device\r
d1f95000	250	does not support parity the value is the default parity value.\r
4ca9b6c4 LG	251	\r
	252	@param StopBits\r
	253	If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\r
d1f95000	254	character. If the device does not support stop bits the value is\r
	255	the default stop bit values.\r
	256	\r
	257	**/\r
	258	typedef struct {\r
	259	UINT32 ControlMask;\r
	260	\r
	261	//\r
	262	// current Attributes\r
	263	//\r
	264	UINT32 Timeout;\r
	265	UINT64 BaudRate;\r
	266	UINT32 ReceiveFifoDepth;\r
	267	UINT32 DataBits;\r
	268	UINT32 Parity;\r
	269	UINT32 StopBits;\r
	270	} EFI_SERIAL_IO_MODE;\r
	271	\r
a6508c05	272	#define EFI_SERIAL_IO_PROTOCOL_REVISION 0x00010000\r
a6508c05	273	#define SERIAL_IO_INTERFACE_REVISION EFI_SERIAL_IO_PROTOCOL_REVISION\r
d1f95000	274	\r
4ca9b6c4 LG	275	/** \r
	276	@par Protocol Description:\r
	277	The Serial I/O protocol is used to communicate with UART-style serial devices. \r
	278	These can be standard UART serial ports in PC-AT systems, serial ports attached \r
	279	to a USB interface, or potentially any character-based I/O device.\r
	280	\r
	281	@param Revision\r
	282	The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
	283	must be backwards compatible. If a future version is not back wards compatible, \r
	284	it is not the same GUID.\r
	285	\r
	286	@param Reset\r
	287	Resets the hardware device.\r
	288	\r
	289	@param SetAttributes\r
	290	Sets communication parameters for a serial device. These include \r
	291	the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, \r
	292	and stop bit attributes.\r
	293	\r
	294	@param SetControl\r
	295	Sets the control bits on a serial device. These include Request to \r
	296	Send and Data Terminal Ready.\r
	297	\r
	298	@param GetControl\r
	299	Reads the status of the control bits on a serial device. These include \r
	300	Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.\r
	301	\r
	302	@param Write\r
	303	Sends a buffer of characters to a serial device.\r
	304	\r
	305	@param Read\r
	306	Receives a buffer of characters from a serial device.\r
	307	\r
	308	@param Mode\r
	309	Pointer to SERIAL_IO_MODE data. \r
	310	\r
	311	**/\r
d1f95000	312	struct _EFI_SERIAL_IO_PROTOCOL {\r
	313	UINT32 Revision;\r
	314	EFI_SERIAL_RESET Reset;\r
	315	EFI_SERIAL_SET_ATTRIBUTES SetAttributes;\r
	316	EFI_SERIAL_SET_CONTROL_BITS SetControl;\r
	317	EFI_SERIAL_GET_CONTROL_BITS GetControl;\r
	318	EFI_SERIAL_WRITE Write;\r
	319	EFI_SERIAL_READ Read;\r
	320	\r
	321	EFI_SERIAL_IO_MODE *Mode;\r
	322	};\r
	323	\r
	324	extern EFI_GUID gEfiSerialIoProtocolGuid;\r
	325	\r
	326	#endif\r