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

Functions
RETURN_STATUS EFIAPI	PL011UartInitializePort (IN UINTN UartBase, IN UINT32 UartClkInHz, IN OUT UINT64 BaudRate, IN OUT UINT32 ReceiveFifoDepth, IN OUT EFI_PARITY_TYPE Parity, IN OUT UINT8 DataBits, IN OUT EFI_STOP_BITS_TYPE *StopBits)

RETURN_STATUS EFIAPI	PL011UartSetControl (IN UINTN UartBase, IN UINT32 Control)

RETURN_STATUS EFIAPI	PL011UartGetControl (IN UINTN UartBase, OUT UINT32 *Control)

UINTN EFIAPI	PL011UartWrite (IN UINTN UartBase, IN UINT8 *Buffer, IN UINTN NumberOfBytes)

UINTN EFIAPI	PL011UartRead (IN UINTN UartBase, OUT UINT8 *Buffer, IN UINTN NumberOfBytes)

BOOLEAN EFIAPI	PL011UartPoll (IN UINTN UartBase)

Detailed Description

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

Definition in file PL011UartLib.h.

Function Documentation

◆ PL011UartGetControl()

RETURN_STATUS EFIAPI PL011UartGetControl	(	IN UINTN	UartBase,
		OUT UINT32 *	Control
	)

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

Parameters

[in] UartBase UART registers base address

[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, 0 otherwise.
                   . 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 serial device.

Definition at line 347 of file PL011UartLib.c.

◆ PL011UartInitializePort()

RETURN_STATUS EFIAPI PL011UartInitializePort	(	IN UINTN	UartBase,
		IN UINT32	UartClkInHz,
		IN OUT UINT64 *	BaudRate,
		IN OUT UINT32 *	ReceiveFifoDepth,
		IN OUT EFI_PARITY_TYPE *	Parity,
		IN OUT UINT8 *	DataBits,
		IN OUT EFI_STOP_BITS_TYPE *	StopBits
	)

Initialise the serial port to the specified settings. All unspecified settings will be set to the default values.

Parameters

[in]	UartBase	The base address of the serial device.
[in]	UartClkInHz	The clock in Hz for the serial device. Ignored if the PCD PL011UartInteger is not 0
[in,out]	BaudRate	The baud rate of the serial device. If the baud rate is not supported, the speed will be reduced to the nearest supported one and the variable's value will be updated accordingly.
[in,out]	ReceiveFifoDepth	The number of characters the device will buffer on input. Value of 0 will use the device's default FIFO depth.
[in,out]	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.
[in,out]	DataBits	The number of data bits in each character.
[in,out]	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

RETURN_SUCCESS	All attributes were set correctly on the serial device.
RETURN_INVALID_PARAMETER	One or more of the attributes has an unsupported value.

Initialise the serial port to the specified settings. The serial port is re-configured only if the specified settings are different from the current settings. All unspecified settings will be set to the default values.

Parameters

UartBase	The base address of the serial device.
UartClkInHz	The clock in Hz for the serial device. Ignored if the PCD PL011UartInteger is not 0
BaudRate	The baud rate of the serial device. If the baud rate is not supported, the speed will be reduced 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. Value of 0 will use the device's default FIFO depth.
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

RETURN_SUCCESS	All attributes were set correctly on the serial device.
RETURN_INVALID_PARAMETER	One or more of the attributes has an unsupported value.

Definition at line 66 of file PL011UartLib.c.

◆ PL011UartPoll()

BOOLEAN EFIAPI PL011UartPoll ( IN UINTN UartBase )

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 475 of file PL011UartLib.c.

◆ PL011UartRead()

UINTN EFIAPI PL011UartRead	(	IN UINTN	UartBase,
		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 448 of file PL011UartLib.c.

◆ PL011UartSetControl()

RETURN_STATUS EFIAPI PL011UartSetControl	(	IN UINTN	UartBase,
		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]	UartBase	UART registers base address
[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 270 of file PL011UartLib.c.

◆ PL011UartWrite()

UINTN EFIAPI PL011UartWrite	(	IN UINTN	UartBase,
		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 417 of file PL011UartLib.c.

Functions

Detailed Description

Function Documentation

◆ PL011UartGetControl()

◆ PL011UartInitializePort()

◆ PL011UartPoll()

◆ PL011UartRead()

◆ PL011UartSetControl()

◆ PL011UartWrite()