#include <Base.h>
#include <Library/IoLib.h>
#include <Library/PcdLib.h>
#include <Library/PL011UartClockLib.h>
#include <Library/PL011UartLib.h>
#include <Library/SerialPortLib.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	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)

RETURN_STATUS EFIAPI	SerialPortSetControl (IN UINT32 Control)

RETURN_STATUS EFIAPI	SerialPortGetControl (OUT UINT32 *Control)

Detailed Description

Serial I/O Port library functions with no library constructor/destructor

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PL011SerialPortLib.c.

Function Documentation

◆ SerialPortGetControl()

RETURN_STATUS EFIAPI SerialPortGetControl ( OUT UINT32 * Control )

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.

Definition at line 233 of file PL011SerialPortLib.c.

◆ SerialPortInitialize()

RETURN_STATUS EFIAPI SerialPortInitialize ( VOID )

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.

Definition at line 28 of file PL011SerialPortLib.c.

◆ SerialPortPoll()

BOOLEAN EFIAPI SerialPortPoll ( VOID )

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

Definition at line 104 of file PL011SerialPortLib.c.

◆ SerialPortRead()

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

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.

Definition at line 87 of file PL011SerialPortLib.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
	)

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.

Definition at line 144 of file PL011SerialPortLib.c.

◆ SerialPortSetControl()

RETURN_STATUS EFIAPI SerialPortSetControl ( IN UINT32 Control )

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.

Definition at line 192 of file PL011SerialPortLib.c.

◆ SerialPortWrite()

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

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.

Definition at line 67 of file PL011SerialPortLib.c.

Functions

Detailed Description

Function Documentation

◆ SerialPortGetControl()

◆ SerialPortInitialize()

◆ SerialPortPoll()

◆ SerialPortRead()

◆ SerialPortSetAttributes()

◆ SerialPortSetControl()

◆ SerialPortWrite()