ArmDbg2Generator.c File Reference

#include <ConfigurationManagerObject.h>
#include <Library/PL011UartLib.h>
#include <Protocol/SerialIo.h>
#include "Dbg2Generator.h"

Go to the source code of this file.

Functions
RETURN_STATUS EFIAPI	Dbg2InitializePort (IN CONST CM_ARCH_COMMON_SERIAL_PORT_INFO *SerialPortInfo, 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)

Detailed Description

Arm DBG2 Table Generator

Copyright (c) 2024, Arm Limited. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Reference(s):

• Microsoft Debug Port Table 2 (DBG2) Specification - December 10, 2015.

Definition in file ArmDbg2Generator.c.

Function Documentation

Dbg2InitializePort()

RETURN_STATUS EFIAPI Dbg2InitializePort	(	IN CONST CM_ARCH_COMMON_SERIAL_PORT_INFO *	SerialPortInfo,
		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. 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

SerialPortInfo	CM_ARCH_COMMON_SERIAL_PORT_INFO object describing the serial port.
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 49 of file ArmDbg2Generator.c.