#include <Uefi/UefiBaseType.h>
#include <Protocol/SerialIo.h>

Functions
RETURN_STATUS EFIAPI	SerialPortInitialize (VOID)

UINTN EFIAPI	SerialPortWrite (IN UINT8 *Buffer, IN UINTN NumberOfBytes)

UINTN EFIAPI	SerialPortRead (OUT UINT8 *Buffer, IN UINTN NumberOfBytes)

BOOLEAN EFIAPI	SerialPortPoll (VOID)

RETURN_STATUS EFIAPI	SerialPortSetControl (IN UINT32 Control)

RETURN_STATUS EFIAPI	SerialPortGetControl (OUT UINT32 *Control)

RETURN_STATUS EFIAPI	SerialPortSetAttributes (IN OUT UINT64 BaudRate, IN OUT UINT32 ReceiveFifoDepth, IN OUT UINT32 Timeout, IN OUT EFI_PARITY_TYPE Parity, IN OUT UINT8 DataBits, IN OUT EFI_STOP_BITS_TYPE StopBits)

Detailed Description

This library class provides common serial I/O port functions.

Definition in file SerialPortLib.h.

Function Documentation

◆ SerialPortGetControl()

RETURN_STATUS EFIAPI SerialPortGetControl ( OUT UINT32 * Control )

Retrieve the status of the control bits on a serial device.

Parameters

Control A pointer to return the current control signals from the serial device.

Return values

RETURN_SUCCESS	The control bits were read from the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Retrieve the status of the control bits on a serial device.

Parameters

[out]

Control

Status of the control bits on a serial device :

                  . EFI_SERIAL_DATA_CLEAR_TO_SEND,
                    EFI_SERIAL_DATA_SET_READY,
                    EFI_SERIAL_RING_INDICATE,
                    EFI_SERIAL_CARRIER_DETECT,
                    EFI_SERIAL_REQUEST_TO_SEND,
                    EFI_SERIAL_DATA_TERMINAL_READY
                    are all related to the DTE (Data Terminal Equipment)
                    and DCE (Data Communication Equipment) modes of
                    operation of the serial device.
                  . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the
                    receive buffer is empty, 0 otherwise.
                  . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the
                    transmit buffer is empty, 0 otherwise.
                  . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if
                    the hardware loopback is enabled (the output feeds
                    the receive buffer), 0 otherwise.
                  . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one
                    if a loopback is accomplished by software, else 0.
                  . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to
                    one if the hardware flow control based on CTS (Clear
                    To Send) and RTS (Ready To Send) control signals is
                    enabled, 0 otherwise.

Return values

RETURN_SUCCESS The control bits were read from the device.

Retrieve the status of the control bits on a serial device.

Parameters

[out] Control A pointer to return the current control signals from the serial device.

Return values

RETURN_SUCCESS	The control bits were read from the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Retrieve the status of the control bits on a serial device.

Parameters

Control A pointer to return the current control signals from the serial device.

Return values

RETURN_SUCCESS The control bits were read from the serial device.

Definition at line 233 of file PL011SerialPortLib.c.

◆ SerialPortInitialize()

RETURN_STATUS EFIAPI SerialPortInitialize ( VOID )

Initialize the serial device hardware.

If no initialization is required, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS. If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.

Return values

RETURN_SUCCESS	The serial device was initialized.
RETURN_DEVICE_ERROR	The serial device could not be initialized.

Initialise the serial device hardware with default settings.

Return values

RETURN_SUCCESS	The serial device was initialised.
RETURN_INVALID_PARAMETER	One or more of the default settings has an unsupported value.

Program hardware of Serial port

Return values

RETURN_SUCCESS	If the serial port was initialized successfully by this call, or an earlier call, to SerialPortInitialize().
RETURN_NOT_FOUND	If no PL011 base address could be found.

Returns: Error codes forwarded from PL011UartInitializePort().

Initialize the serial device hardware.

If no initialization is required, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS.

Return values

RETURN_SUCCESS The serial device was initialized.

Definition at line 25 of file SerialPortLib.c.

◆ SerialPortPoll()

BOOLEAN EFIAPI SerialPortPoll ( VOID )

Polls a serial device to see if there is any data waiting to be read.

Polls a serial device to see if there is any data waiting to be read. If there is data waiting to be read from the serial device, then TRUE is returned. If there is no data waiting to be read from the serial device, then FALSE is returned.

Return values

TRUE	Data is waiting to be read from the serial device.
FALSE	There is no data waiting to be read from the serial device.

Check to see if any data is available to be read from the debug device.

Return values

TRUE	At least one byte of data is available to be read
FALSE	No data is available to be read

Polls a serial device to see if there is any data waiting to be read.

Polls aserial device to see if there is any data waiting to be read. If there is data waiting to be read from the serial device, then TRUE is returned. If there is no data waiting to be read from the serial device, then FALSE is returned.

Return values

TRUE	Data is waiting to be read from the serial device.
FALSE	There is no data waiting to be read from the serial device.

Polls a serial device to see if there is any data waiting to be read.

Return values

TRUE	Data is waiting to be read from the serial device.
FALSE	There is no data waiting to be read from the serial device.

Definition at line 127 of file SerialPortLib.c.

◆ SerialPortRead()

UINTN EFIAPI SerialPortRead	(	OUT UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

Read data from serial device and save the datas in buffer.

Reads NumberOfBytes data bytes from a serial device into the buffer specified by Buffer. The number of bytes actually read is returned. If the return value is less than NumberOfBytes, then the rest operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	Pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	Number of bytes which will be read.

Return values

0	Read data failed, no data is to be read.
>0	Actual number of bytes read from serial device.

Read data from serial device and save the datas in buffer.

Parameters

Buffer	Point of data buffer which need to be written.
NumberOfBytes	Number of output bytes which are cached in Buffer.

Return values

0	Read data failed.
!0	Actual number of bytes read from serial device.

Read data from serial device and save the data in buffer.

Parameters

Buffer	Point of data buffer which need to be written.
NumberOfBytes	Number of output bytes which are cached in Buffer.

Return values

0	Read data failed.
!0	Actual number of bytes read from serial device.

Read data from serial device and save the data in buffer.

Parameters

Buffer	Point of data buffer which need to be written.
NumberOfBytes	Size of Buffer[].

Return values

0	Read data failed.
!0	Actual number of bytes read from serial device.

Read data from serial device and save the datas in buffer.

Reads NumberOfBytes data bytes from a serial device into the buffer specified by Buffer. The number of bytes actually read is returned. If the return value is less than NumberOfBytes, then the rest operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	The number of bytes which will be read.

Return values

0	Read data failed; No data is to be read.
>0	The actual number of bytes read from serial device.

Reads data from a serial device into a buffer.

Parameters

Buffer	Pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	Number of bytes to read from the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes read from the serial device. If this value is less than NumberOfBytes, then the read operation failed.

Read data from serial device and save the datas in buffer.

Reads NumberOfBytes data bytes from a serial device into the buffer specified by Buffer. The number of bytes actually read is returned. If the return value is less than NumberOfBytes, then the rest operation failed. If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	The number of bytes which will be read.

Return values

0	Read data failed; No data is to be read.
>0	The actual number of bytes read from serial device.

Read data from serial device and save the datas in buffer.

Reads NumberOfBytes data bytes from a serial device into the buffer specified by Buffer. The number of bytes actually read is returned. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	Pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	Number of bytes which will be read.

Return values

0	Read data failed, no data is to be read.
>0	Actual number of bytes read from serial device.

Definition at line 109 of file SerialPortLib.c.

◆ SerialPortSetAttributes()

RETURN_STATUS EFIAPI SerialPortSetAttributes	(	IN OUT UINT64 *	BaudRate,
		IN OUT UINT32 *	ReceiveFifoDepth,
		IN OUT UINT32 *	Timeout,
		IN OUT EFI_PARITY_TYPE *	Parity,
		IN OUT UINT8 *	DataBits,
		IN OUT EFI_STOP_BITS_TYPE *	StopBits
	)

Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, data bits, and stop bits on a serial device.

Parameters

BaudRate	The requested baud rate. A BaudRate value of 0 will use the device's default interface speed. On output, the value actually set.
ReveiveFifoDepth	The requested depth of the FIFO on the receive side of the serial interface. A ReceiveFifoDepth value of 0 will use the device's default FIFO depth. On output, the value actually set.
Timeout	The requested time out for a single character in microseconds. This timeout applies to both the transmit and receive side of the interface. A Timeout value of 0 will use the device's default time out value. On output, the value actually set.
Parity	The type of parity to use on this serial device. A Parity value of DefaultParity will use the device's default parity value. On output, the value actually set.
DataBits	The number of data bits to use on the serial device. A DataBits vaule of 0 will use the device's default data bit setting. On output, the value actually set.
StopBits	The number of stop bits to use on this serial device. A StopBits value of DefaultStopBits will use the device's default number of stop bits. On output, the value actually set.

Return values

RETURN_SUCCESS	The new attributes were set on the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_INVALID_PARAMETER	One or more of the attributes has an unsupported value.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Set new attributes to PL011.

Parameters

BaudRate	The baud rate of the serial device. If the baud rate is not supported, the speed will be reduced down to the nearest supported one and the variable's value will be updated accordingly.
ReceiveFifoDepth	The number of characters the device will buffer on input. If the specified value is not supported, the variable's value will be reduced down to the nearest supported one.
Timeout	If applicable, the number of microseconds the device will wait before timing out a Read or a Write operation.
Parity	If applicable, this is the EFI_PARITY_TYPE that is computed or checked as each character is transmitted or received. If the device does not support parity, the value is the default parity value.
DataBits	The number of data bits in each character
StopBits	If applicable, the EFI_STOP_BITS_TYPE number of stop bits per character. If the device does not support stop bits, the value is the default stop bit value.

Return values

EFI_SUCCESS	All attributes were set correctly.
EFI_INVALID_PARAMETERS	One or more attributes has an unsupported value.

Sets the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, and stop bits on a serial device.

Parameters

BaudRate	The requested baud rate. A BaudRate value of 0 will use the device's default interface speed. On output, the value actually set.
ReceiveFifoDepth	The requested depth of the FIFO on the receive side of the serial interface. A ReceiveFifoDepth value of 0 will use the device's default FIFO depth. On output, the value actually set.
Timeout	The requested time out for a single character in microseconds. This timeout applies to both the transmit and receive side of the interface. A Timeout value of 0 will use the device's default time out value. On output, the value actually set.
Parity	The type of parity to use on this serial device. A Parity value of DefaultParity will use the device's default parity value. On output, the value actually set.
DataBits	The number of data bits to use on the serial device. A DataBits value of 0 will use the device's default data bit setting. On output, the value actually set.
StopBits	The number of stop bits to use on this serial device. A StopBits value of DefaultStopBits will use the device's default number of stop bits. On output, the value actually set.

Return values

RETURN_SUCCESS	The new attributes were set on the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_INVALID_PARAMETER	One or more of the attributes has an unsupported value.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, data bits, and stop bits on a serial device.

Parameters

BaudRate	The requested baud rate. A BaudRate value of 0 will use the device's default interface speed. On output, the value actually set.
ReveiveFifoDepth	The requested depth of the FIFO on the receive side of the serial interface. A ReceiveFifoDepth value of 0 will use the device's default FIFO depth. On output, the value actually set.
Timeout	The requested time out for a single character in microseconds. This timeout applies to both the transmit and receive side of the interface. A Timeout value of 0 will use the device's default time out value. On output, the value actually set.
Parity	The type of parity to use on this serial device. A Parity value of DefaultParity will use the device's default parity value. On output, the value actually set.
DataBits	The number of data bits to use on the serial device. A DataBits vaule of 0 will use the device's default data bit setting. On output, the value actually set.
StopBits	The number of stop bits to use on this serial device. A StopBits value of DefaultStopBits will use the device's default number of stop bits. On output, the value actually set.

Return values

RETURN_SUCCESS The new attributes were set on the serial device.

Definition at line 144 of file PL011SerialPortLib.c.

◆ SerialPortSetControl()

RETURN_STATUS EFIAPI SerialPortSetControl ( IN UINT32 Control )

Sets the control bits on a serial device.

Parameters

Control Sets the bits of Control that are settable.

Return values

RETURN_SUCCESS	The new control bits were set on the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Assert or deassert the control signals on a serial port. The following control signals are set according their bit settings : . Request to Send . Data Terminal Ready

Parameters

[in] Control The following bits are taken into account : . EFI_SERIAL_REQUEST_TO_SEND : assert/deassert the "Request To Send" control signal if this bit is equal to one/zero. . EFI_SERIAL_DATA_TERMINAL_READY : assert/deassert the "Data Terminal Ready" control signal if this bit is equal to one/zero. . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : enable/disable the hardware loopback if this bit is equal to one/zero. . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : not supported. . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : enable/ disable the hardware flow control based on CTS (Clear To Send) and RTS (Ready To Send) control signals.

Return values

RETURN_SUCCESS	The new control bits were set on the device.
RETURN_UNSUPPORTED	The device does not support this operation.

Sets the control bits on a serial device.

Parameters

[in] Control Sets the bits of Control that are settable.

Return values

RETURN_SUCCESS	The new control bits were set on the serial device.
RETURN_UNSUPPORTED	The serial device does not support this operation.
RETURN_DEVICE_ERROR	The serial device is not functioning correctly.

Sets the control bits on a serial device.

Parameters

Control Sets the bits of Control that are settable.

Return values

RETURN_SUCCESS The new control bits were set on the serial device.

Definition at line 192 of file PL011SerialPortLib.c.

◆ SerialPortWrite()

UINTN EFIAPI SerialPortWrite	(	IN UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	Pointer to the data buffer to be written.
NumberOfBytes	Number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the write operation failed.

Write data to serial device.

Parameters

Buffer	Point of data buffer which need to be written.
NumberOfBytes	Number of output bytes which are cached in Buffer.

Return values

0	Write data failed.
!0	Actual number of bytes written to serial device.

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to be written.
NumberOfBytes	The number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the read operation failed.

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to be written.
NumberOfBytes	The number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the write operation failed.

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to be written.
NumberOfBytes	The number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the write operation failed.

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed.

If Buffer is NULL, then return 0.

If NumberOfBytes is zero, then return 0.

Parameters

Buffer	Pointer to the data buffer to be written.
NumberOfBytes	Number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the write operation failed.

Definition at line 52 of file SerialPortLib.c.

Functions

Detailed Description

Function Documentation

◆ SerialPortGetControl()

◆ SerialPortInitialize()

◆ SerialPortPoll()

◆ SerialPortRead()

◆ SerialPortSetAttributes()

◆ SerialPortSetControl()

◆ SerialPortWrite()