GdbSerialLib.h File Reference

Functions
RETURN_STATUS EFIAPI	GdbSerialInit (IN UINT64 BaudRate, IN UINT8 Parity, IN UINT8 DataBits, IN UINT8 StopBits)
BOOLEAN EFIAPI	GdbIsCharAvailable (VOID)
CHAR8 EFIAPI	GdbGetChar (VOID)
VOID EFIAPI	GdbPutChar (IN CHAR8 Char)
VOID	GdbPutString (IN CHAR8 *String)

Detailed Description

Basic serial IO abstraction for GDB

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

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

Function Documentation

CHAR8 EFIAPI GdbGetChar

(

VOID

)

Get a character from GDB. This function must be able to run in interrupt context.

Returns

A character from GDB

BOOLEAN EFIAPI GdbIsCharAvailable

(

VOID

)

Check to see if a character is available from GDB. Do not read the character as that is done via GdbGetChar().

Returns

TRUE - Character available

FALSE - Character not available

VOID EFIAPI GdbPutChar

(

IN CHAR8

Char

)

Send a character to GDB. This function must be able to run in interrupt context.

Parameters

Char	Send a character to GDB

VOID GdbPutString

(

IN CHAR8 *

String

)

Send an ASCII string to GDB. This function must be able to run in interrupt context.

Parameters

String

Send a string to GDB

RETURN_STATUS EFIAPI GdbSerialInit	(	IN UINT64	BaudRate,
		IN UINT8	Parity,
		IN UINT8	DataBits,
		IN UINT8	StopBits
	)

Sets the baud rate, receive FIFO depth, transmit/receive time out, parity, data buts, and stop bits on a serial device. This call is optional as the serial port will be set up with defaults base on PCD values.

Parameters

BaudRate	The requested baud rate. A BaudRate value of 0 will use the the device's default interface speed.
Parity	The type of parity to use on this serial device. A Parity value of DefaultParity will use the device's default parity value.
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.
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.

Return values

EFI_SUCCESS	The device was configured.
EFI_DEVICE_ERROR	The serial device could not be configured.