#include <Base.h>
#include <Library/PcdLib.h>
#include <Library/PL011UartLib.h>
#include <Library/SerialPortLib.h>
#include <Library/FdtSerialPortAddressLib.h>

Functions
RETURN_STATUS EFIAPI	SerialPortInitialize (VOID)

STATIC UINT64	SerialPortGetBaseAddress (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

Serial I/O Port library functions with base address discovered from FDT

Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.
Copyright (c) 2012 - 2013, ARM Ltd. All rights reserved.
Copyright (c) 2014, Linaro Ltd. All rights reserved.
Copyright (c) 2015, Intel Corporation. All rights reserved.

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

Definition in file EarlyFdtPL011SerialPortLib.c.

Function Documentation

◆ SerialPortGetBaseAddress()

STATIC UINT64 SerialPortGetBaseAddress ( VOID )

Definition at line 49 of file EarlyFdtPL011SerialPortLib.c.

◆ SerialPortGetControl()

RETURN_STATUS EFIAPI SerialPortGetControl ( OUT UINT32 * Control )

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.

Definition at line 200 of file EarlyFdtPL011SerialPortLib.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.

Definition at line 22 of file EarlyFdtPL011SerialPortLib.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 162 of file EarlyFdtPL011SerialPortLib.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	Size of Buffer[].

Return values

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

Definition at line 145 of file EarlyFdtPL011SerialPortLib.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/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.

Definition at line 242 of file EarlyFdtPL011SerialPortLib.c.

◆ SerialPortSetControl()

RETURN_STATUS EFIAPI SerialPortSetControl ( IN UINT32 Control )

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.

Definition at line 181 of file EarlyFdtPL011SerialPortLib.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 118 of file EarlyFdtPL011SerialPortLib.c.

Functions

Detailed Description

Function Documentation

◆ SerialPortGetBaseAddress()

◆ SerialPortGetControl()

◆ SerialPortInitialize()

◆ SerialPortPoll()

◆ SerialPortRead()

◆ SerialPortSetAttributes()

◆ SerialPortSetControl()

◆ SerialPortWrite()