[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 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\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
#define EFI_SERIAL_TERMINAL_DEVICE_TYPE_GUID \\r
  { \\r
    0X6AD9A60F, 0X5815, 0X4C7C, { 0X8A, 0X10, 0X50, 0X53, 0XD2, 0XBF, 0X7A, 0X1B } \\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
/// Backward-compatible with EFI1.1.\r
///\r
typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE;\r
\r
///\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
  NoParity,\r
  EvenParity,\r
  OddParity,\r
  MarkParity,\r
  SpaceParity\r
} EFI_PARITY_TYPE;\r
\r
///\r
/// Stop bits 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
/**\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
  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,\r
  data bits, 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\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 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
                           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_INVALID_PARAMETER One or more attributes has an unsupported value.\r
  @retval EFI_DEVICE_ERROR      The serial device is not functioning correctly.\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
  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
  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
  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
  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
  @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 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
  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 EFI_SERIAL_IO_PROTOCOL_REVISION1p1  0x00010001\r
#define SERIAL_IO_INTERFACE_REVISION        EFI_SERIAL_IO_PROTOCOL_REVISION\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 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_SET_CONTROL_BITS    SetControl;\r
  EFI_SERIAL_GET_CONTROL_BITS    GetControl;\r
  EFI_SERIAL_WRITE               Write;\r
  EFI_SERIAL_READ                Read;\r
  ///\r
  /// Pointer to SERIAL_IO_MODE data.\r
  ///\r
  EFI_SERIAL_IO_MODE             *Mode;\r
  ///\r
  /// Pointer to a GUID identifying the device connected to the serial port.\r
  /// This field is NULL when the protocol is installed by the serial port\r
  /// driver and may be populated by a platform driver for a serial port\r
  /// with a known device attached. The field will remain NULL if there is\r
  /// no platform serial device identification information available.\r
  ///\r
  CONST EFI_GUID                 *DeviceTypeGuid; // Revision 1.1\r
};\r
\r
extern EFI_GUID  gEfiSerialIoProtocolGuid;\r
extern EFI_GUID  gEfiSerialTerminalDeviceTypeGuid;\r
\r
#endif\r
Commit	Line	Data
	1	/** @file\r
	2	Serial IO protocol as defined in the UEFI 2.0 specification.\r
	3	\r
	4	Abstraction of a basic serial device. Targeted at 16550 UART, but\r
	5	could be much more generic.\r
	6	\r
	7	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
	8	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	9	\r
	10	**/\r
	11	\r
	12	#ifndef __SERIAL_IO_PROTOCOL_H__\r
	13	#define __SERIAL_IO_PROTOCOL_H__\r
	14	\r
	15	#define EFI_SERIAL_IO_PROTOCOL_GUID \\r
	16	{ \\r
	17	0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \\r
	18	}\r
	19	\r
	20	#define EFI_SERIAL_TERMINAL_DEVICE_TYPE_GUID \\r
	21	{ \\r
	22	0X6AD9A60F, 0X5815, 0X4C7C, { 0X8A, 0X10, 0X50, 0X53, 0XD2, 0XBF, 0X7A, 0X1B } \\r
	23	}\r
	24	\r
	25	///\r
	26	/// Protocol GUID defined in EFI1.1.\r
	27	///\r
	28	#define SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL_GUID\r
	29	\r
	30	typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r
	31	\r
	32	///\r
	33	/// Backward-compatible with EFI1.1.\r
	34	///\r
	35	typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE;\r
	36	\r
	37	///\r
	38	/// Parity type that is computed or checked as each character is transmitted or received. If the\r
	39	/// device does not support parity, the value is the default parity value.\r
	40	///\r
	41	typedef enum {\r
	42	DefaultParity,\r
	43	NoParity,\r
	44	EvenParity,\r
	45	OddParity,\r
	46	MarkParity,\r
	47	SpaceParity\r
	48	} EFI_PARITY_TYPE;\r
	49	\r
	50	///\r
	51	/// Stop bits type\r
	52	///\r
	53	typedef enum {\r
	54	DefaultStopBits,\r
	55	OneStopBit,\r
	56	OneFiveStopBits,\r
	57	TwoStopBits\r
	58	} EFI_STOP_BITS_TYPE;\r
	59	\r
	60	//\r
	61	// define for Control bits, grouped by read only, write only, and read write\r
	62	//\r
	63	//\r
	64	// Read Only\r
	65	//\r
	66	#define EFI_SERIAL_CLEAR_TO_SEND 0x00000010\r
	67	#define EFI_SERIAL_DATA_SET_READY 0x00000020\r
	68	#define EFI_SERIAL_RING_INDICATE 0x00000040\r
	69	#define EFI_SERIAL_CARRIER_DETECT 0x00000080\r
	70	#define EFI_SERIAL_INPUT_BUFFER_EMPTY 0x00000100\r
	71	#define EFI_SERIAL_OUTPUT_BUFFER_EMPTY 0x00000200\r
	72	\r
	73	//\r
	74	// Write Only\r
	75	//\r
	76	#define EFI_SERIAL_REQUEST_TO_SEND 0x00000002\r
	77	#define EFI_SERIAL_DATA_TERMINAL_READY 0x00000001\r
	78	\r
	79	//\r
	80	// Read Write\r
	81	//\r
	82	#define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE 0x00001000\r
	83	#define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE 0x00002000\r
	84	#define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x00004000\r
	85	\r
	86	//\r
	87	// Serial IO Member Functions\r
	88	//\r
	89	\r
	90	/**\r
	91	Reset the serial device.\r
	92	\r
	93	@param This Protocol instance pointer.\r
	94	\r
	95	@retval EFI_SUCCESS The device was reset.\r
	96	@retval EFI_DEVICE_ERROR The serial device could not be reset.\r
	97	\r
	98	**/\r
	99	typedef\r
	100	EFI_STATUS\r
	101	(EFIAPI *EFI_SERIAL_RESET)(\r
	102	IN EFI_SERIAL_IO_PROTOCOL *This\r
	103	);\r
	104	\r
	105	/**\r
	106	Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,\r
	107	data bits, and stop bits on a serial device.\r
	108	\r
	109	@param This Protocol instance pointer.\r
	110	@param BaudRate The requested baud rate. A BaudRate value of 0 will use the\r
	111	device's default interface speed.\r
	112	@param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the\r
	113	serial interface. A ReceiveFifoDepth value of 0 will use\r
	114	the device's default FIFO depth.\r
	115	@param Timeout The requested time out for a single character in microseconds.\r
	116	This timeout applies to both the transmit and receive side of the\r
	117	interface. A Timeout value of 0 will use the device's default time\r
	118	out value.\r
	119	@param Parity The type of parity to use on this serial device. A Parity value of\r
	120	DefaultParity will use the device's default parity value.\r
	121	@param DataBits The number of data bits to use on the serial device. A DataBits\r
	122	vaule of 0 will use the device's default data bit setting.\r
	123	@param StopBits The number of stop bits to use on this serial device. A StopBits\r
	124	value of DefaultStopBits will use the device's default number of\r
	125	stop bits.\r
	126	\r
	127	@retval EFI_SUCCESS The device was reset.\r
	128	@retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.\r
	129	@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
	130	\r
	131	**/\r
	132	typedef\r
	133	EFI_STATUS\r
	134	(EFIAPI *EFI_SERIAL_SET_ATTRIBUTES)(\r
	135	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	136	IN UINT64 BaudRate,\r
	137	IN UINT32 ReceiveFifoDepth,\r
	138	IN UINT32 Timeout,\r
	139	IN EFI_PARITY_TYPE Parity,\r
	140	IN UINT8 DataBits,\r
	141	IN EFI_STOP_BITS_TYPE StopBits\r
	142	);\r
	143	\r
	144	/**\r
	145	Set the control bits on a serial device\r
	146	\r
	147	@param This Protocol instance pointer.\r
	148	@param Control Set the bits of Control that are settable.\r
	149	\r
	150	@retval EFI_SUCCESS The new control bits were set on the serial device.\r
	151	@retval EFI_UNSUPPORTED The serial device does not support this operation.\r
	152	@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
	153	\r
	154	**/\r
	155	typedef\r
	156	EFI_STATUS\r
	157	(EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(\r
	158	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	159	IN UINT32 Control\r
	160	);\r
	161	\r
	162	/**\r
	163	Retrieves the status of thecontrol bits on a serial device\r
	164	\r
	165	@param This Protocol instance pointer.\r
	166	@param Control A pointer to return the current Control signals from the serial device.\r
	167	\r
	168	@retval EFI_SUCCESS The control bits were read from the serial device.\r
	169	@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r
	170	\r
	171	**/\r
	172	typedef\r
	173	EFI_STATUS\r
	174	(EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(\r
	175	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	176	OUT UINT32 *Control\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
	194	(EFIAPI *EFI_SERIAL_WRITE)(\r
	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	Writes data to a serial device.\r
	202	\r
	203	@param This Protocol instance pointer.\r
	204	@param BufferSize On input, the size of the Buffer. On output, the amount of\r
	205	data returned in Buffer.\r
	206	@param Buffer The buffer to return the data into.\r
	207	\r
	208	@retval EFI_SUCCESS The data was read.\r
	209	@retval EFI_DEVICE_ERROR The device reported an error.\r
	210	@retval EFI_TIMEOUT The data write was stopped due to a timeout.\r
	211	\r
	212	**/\r
	213	typedef\r
	214	EFI_STATUS\r
	215	(EFIAPI *EFI_SERIAL_READ)(\r
	216	IN EFI_SERIAL_IO_PROTOCOL *This,\r
	217	IN OUT UINTN *BufferSize,\r
	218	OUT VOID *Buffer\r
	219	);\r
	220	\r
	221	/**\r
	222	@par Data Structure Description:\r
	223	The data values in SERIAL_IO_MODE are read-only and are updated by the code\r
	224	that produces the SERIAL_IO_PROTOCOL member functions.\r
	225	\r
	226	@param ControlMask\r
	227	A mask for the Control bits that the device supports. The device\r
	228	must always support the Input Buffer Empty control bit.\r
	229	\r
	230	@param TimeOut\r
	231	If applicable, the number of microseconds to wait before timing out\r
	232	a Read or Write operation.\r
	233	\r
	234	@param BaudRate\r
	235	If applicable, the current baud rate setting of the device; otherwise,\r
	236	baud rate has the value of zero to indicate that device runs at the\r
	237	device's designed speed.\r
	238	\r
	239	@param ReceiveFifoDepth\r
	240	The number of characters the device will buffer on input\r
	241	\r
	242	@param DataBits\r
	243	The number of characters the device will buffer on input\r
	244	\r
	245	@param Parity\r
	246	If applicable, this is the EFI_PARITY_TYPE that is computed or\r
	247	checked as each character is transmitted or reveived. If the device\r
	248	does not support parity the value is the default parity value.\r
	249	\r
	250	@param StopBits\r
	251	If applicable, the EFI_STOP_BITS_TYPE number of stop bits per\r
	252	character. If the device does not support stop bits the value is\r
	253	the default stop bit values.\r
	254	\r
	255	**/\r
	256	typedef struct {\r
	257	UINT32 ControlMask;\r
	258	\r
	259	//\r
	260	// current Attributes\r
	261	//\r
	262	UINT32 Timeout;\r
	263	UINT64 BaudRate;\r
	264	UINT32 ReceiveFifoDepth;\r
	265	UINT32 DataBits;\r
	266	UINT32 Parity;\r
	267	UINT32 StopBits;\r
	268	} EFI_SERIAL_IO_MODE;\r
	269	\r
	270	#define EFI_SERIAL_IO_PROTOCOL_REVISION 0x00010000\r
	271	#define EFI_SERIAL_IO_PROTOCOL_REVISION1p1 0x00010001\r
	272	#define SERIAL_IO_INTERFACE_REVISION EFI_SERIAL_IO_PROTOCOL_REVISION\r
	273	\r
	274	///\r
	275	/// The Serial I/O protocol is used to communicate with UART-style serial devices.\r
	276	/// These can be standard UART serial ports in PC-AT systems, serial ports attached\r
	277	/// to a USB interface, or potentially any character-based I/O device.\r
	278	///\r
	279	struct _EFI_SERIAL_IO_PROTOCOL {\r
	280	///\r
	281	/// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions\r
	282	/// must be backwards compatible. If a future version is not backwards compatible,\r
	283	/// it is not the same GUID.\r
	284	///\r
	285	UINT32 Revision;\r
	286	EFI_SERIAL_RESET Reset;\r
	287	EFI_SERIAL_SET_ATTRIBUTES SetAttributes;\r
	288	EFI_SERIAL_SET_CONTROL_BITS SetControl;\r
	289	EFI_SERIAL_GET_CONTROL_BITS GetControl;\r
	290	EFI_SERIAL_WRITE Write;\r
	291	EFI_SERIAL_READ Read;\r
	292	///\r
	293	/// Pointer to SERIAL_IO_MODE data.\r
	294	///\r
	295	EFI_SERIAL_IO_MODE *Mode;\r
	296	///\r
	297	/// Pointer to a GUID identifying the device connected to the serial port.\r
	298	/// This field is NULL when the protocol is installed by the serial port\r
	299	/// driver and may be populated by a platform driver for a serial port\r
	300	/// with a known device attached. The field will remain NULL if there is\r
	301	/// no platform serial device identification information available.\r
	302	///\r
	303	CONST EFI_GUID *DeviceTypeGuid; // Revision 1.1\r
	304	};\r
	305	\r
	306	extern EFI_GUID gEfiSerialIoProtocolGuid;\r
	307	extern EFI_GUID gEfiSerialTerminalDeviceTypeGuid;\r
	308	\r
	309	#endif\r