2 Serial IO protocol as defined in the UEFI 2.0 specification.
4 Abstraction of a basic serial device. Targeted at 16550 UART, but
5 could be much more generic.
7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
8 SPDX-License-Identifier: BSD-2-Clause-Patent
12 #ifndef __SERIAL_IO_PROTOCOL_H__
13 #define __SERIAL_IO_PROTOCOL_H__
15 #define EFI_SERIAL_IO_PROTOCOL_GUID \
17 0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \
21 /// Protocol GUID defined in EFI1.1.
23 #define SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL_GUID
25 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL
;
29 /// Backward-compatible with EFI1.1.
31 typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE
;
34 /// Parity type that is computed or checked as each character is transmitted or received. If the
35 /// device does not support parity, the value is the default parity value.
57 // define for Control bits, grouped by read only, write only, and read write
62 #define EFI_SERIAL_CLEAR_TO_SEND 0x00000010
63 #define EFI_SERIAL_DATA_SET_READY 0x00000020
64 #define EFI_SERIAL_RING_INDICATE 0x00000040
65 #define EFI_SERIAL_CARRIER_DETECT 0x00000080
66 #define EFI_SERIAL_INPUT_BUFFER_EMPTY 0x00000100
67 #define EFI_SERIAL_OUTPUT_BUFFER_EMPTY 0x00000200
72 #define EFI_SERIAL_REQUEST_TO_SEND 0x00000002
73 #define EFI_SERIAL_DATA_TERMINAL_READY 0x00000001
78 #define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE 0x00001000
79 #define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE 0x00002000
80 #define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x00004000
83 // Serial IO Member Functions
86 Reset the serial device.
88 @param This Protocol instance pointer.
90 @retval EFI_SUCCESS The device was reset.
91 @retval EFI_DEVICE_ERROR The serial device could not be reset.
96 (EFIAPI
*EFI_SERIAL_RESET
)(
97 IN EFI_SERIAL_IO_PROTOCOL
*This
101 Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
102 data bits, and stop bits on a serial device.
104 @param This Protocol instance pointer.
105 @param BaudRate The requested baud rate. A BaudRate value of 0 will use the
106 device's default interface speed.
107 @param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the
108 serial interface. A ReceiveFifoDepth value of 0 will use
109 the device's default FIFO depth.
110 @param Timeout The requested time out for a single character in microseconds.
111 This timeout applies to both the transmit and receive side of the
112 interface. A Timeout value of 0 will use the device's default time
114 @param Parity The type of parity to use on this serial device. A Parity value of
115 DefaultParity will use the device's default parity value.
116 @param DataBits The number of data bits to use on the serial device. A DataBits
117 vaule of 0 will use the device's default data bit setting.
118 @param StopBits The number of stop bits to use on this serial device. A StopBits
119 value of DefaultStopBits will use the device's default number of
122 @retval EFI_SUCCESS The device was reset.
123 @retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.
124 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
129 (EFIAPI
*EFI_SERIAL_SET_ATTRIBUTES
)(
130 IN EFI_SERIAL_IO_PROTOCOL
*This
,
132 IN UINT32 ReceiveFifoDepth
,
134 IN EFI_PARITY_TYPE Parity
,
136 IN EFI_STOP_BITS_TYPE StopBits
140 Set the control bits on a serial device
142 @param This Protocol instance pointer.
143 @param Control Set the bits of Control that are settable.
145 @retval EFI_SUCCESS The new control bits were set on the serial device.
146 @retval EFI_UNSUPPORTED The serial device does not support this operation.
147 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
152 (EFIAPI
*EFI_SERIAL_SET_CONTROL_BITS
)(
153 IN EFI_SERIAL_IO_PROTOCOL
*This
,
158 Retrieves the status of thecontrol bits on a serial device
160 @param This Protocol instance pointer.
161 @param Control A pointer to return the current Control signals from the serial device.
163 @retval EFI_SUCCESS The control bits were read from the serial device.
164 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
169 (EFIAPI
*EFI_SERIAL_GET_CONTROL_BITS
)(
170 IN EFI_SERIAL_IO_PROTOCOL
*This
,
175 Writes data to a serial device.
177 @param This Protocol instance pointer.
178 @param BufferSize On input, the size of the Buffer. On output, the amount of
179 data actually written.
180 @param Buffer The buffer of data to write
182 @retval EFI_SUCCESS The data was written.
183 @retval EFI_DEVICE_ERROR The device reported an error.
184 @retval EFI_TIMEOUT The data write was stopped due to a timeout.
189 (EFIAPI
*EFI_SERIAL_WRITE
)(
190 IN EFI_SERIAL_IO_PROTOCOL
*This
,
191 IN OUT UINTN
*BufferSize
,
196 Writes data to a serial device.
198 @param This Protocol instance pointer.
199 @param BufferSize On input, the size of the Buffer. On output, the amount of
200 data returned in Buffer.
201 @param Buffer The buffer to return the data into.
203 @retval EFI_SUCCESS The data was read.
204 @retval EFI_DEVICE_ERROR The device reported an error.
205 @retval EFI_TIMEOUT The data write was stopped due to a timeout.
210 (EFIAPI
*EFI_SERIAL_READ
)(
211 IN EFI_SERIAL_IO_PROTOCOL
*This
,
212 IN OUT UINTN
*BufferSize
,
217 @par Data Structure Description:
218 The data values in SERIAL_IO_MODE are read-only and are updated by the code
219 that produces the SERIAL_IO_PROTOCOL member functions.
222 A mask for the Control bits that the device supports. The device
223 must always support the Input Buffer Empty control bit.
226 If applicable, the number of microseconds to wait before timing out
227 a Read or Write operation.
230 If applicable, the current baud rate setting of the device; otherwise,
231 baud rate has the value of zero to indicate that device runs at the
232 device's designed speed.
234 @param ReceiveFifoDepth
235 The number of characters the device will buffer on input
238 The number of characters the device will buffer on input
241 If applicable, this is the EFI_PARITY_TYPE that is computed or
242 checked as each character is transmitted or reveived. If the device
243 does not support parity the value is the default parity value.
246 If applicable, the EFI_STOP_BITS_TYPE number of stop bits per
247 character. If the device does not support stop bits the value is
248 the default stop bit values.
255 // current Attributes
259 UINT32 ReceiveFifoDepth
;
263 } EFI_SERIAL_IO_MODE
;
265 #define EFI_SERIAL_IO_PROTOCOL_REVISION 0x00010000
266 #define SERIAL_IO_INTERFACE_REVISION EFI_SERIAL_IO_PROTOCOL_REVISION
269 /// The Serial I/O protocol is used to communicate with UART-style serial devices.
270 /// These can be standard UART serial ports in PC-AT systems, serial ports attached
271 /// to a USB interface, or potentially any character-based I/O device.
273 struct _EFI_SERIAL_IO_PROTOCOL
{
275 /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions
276 /// must be backwards compatible. If a future version is not backwards compatible,
277 /// it is not the same GUID.
280 EFI_SERIAL_RESET Reset
;
281 EFI_SERIAL_SET_ATTRIBUTES SetAttributes
;
282 EFI_SERIAL_SET_CONTROL_BITS SetControl
;
283 EFI_SERIAL_GET_CONTROL_BITS GetControl
;
284 EFI_SERIAL_WRITE Write
;
285 EFI_SERIAL_READ Read
;
287 /// Pointer to SERIAL_IO_MODE data.
289 EFI_SERIAL_IO_MODE
*Mode
;
292 extern EFI_GUID gEfiSerialIoProtocolGuid
;