X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=EmbeddedPkg%2FInclude%2FLibrary%2FGdbSerialLib.h;h=b45645ae61168279447109f06123839e6a8c31c6;hp=6e8eeb4e6f32e0ae37bb953e8b0a841aaaae6657;hb=HEAD;hpb=1e57a46299244793beb27e74be171d1540606999 diff --git a/EmbeddedPkg/Include/Library/GdbSerialLib.h b/EmbeddedPkg/Include/Library/GdbSerialLib.h index 6e8eeb4e6f..58c3a5643c 100644 --- a/EmbeddedPkg/Include/Library/GdbSerialLib.h +++ b/EmbeddedPkg/Include/Library/GdbSerialLib.h @@ -1,59 +1,50 @@ /** @file - Basic serial IO abstaction for GDB + Basic serial IO abstraction for GDB Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + SPDX-License-Identifier: BSD-2-Clause-Patent **/ #ifndef __GDB_SERIAL_LIB_H__ #define __GDB_SERIAL_LIB_H__ - - /** - Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, + 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. - @param BaudRate The requested baud rate. A BaudRate value of 0 will use the the + @param BaudRate The requested baud rate. A BaudRate value of 0 will use the device's default interface speed. @param Parity The type of parity to use on this serial device. A Parity value of DefaultParity will use the device's default parity value. @param DataBits The number of data bits to use on the serial device. A DataBits - vaule of 0 will use the device's default data bit setting. + value of 0 will use the device's default data bit setting. @param 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. @retval EFI_SUCCESS The device was configured. - @retval EFI_DEVICE_ERROR The serial device could not be coonfigured. + @retval EFI_DEVICE_ERROR The serial device could not be configured. **/ RETURN_STATUS EFIAPI GdbSerialInit ( - IN UINT64 BaudRate, - IN UINT8 Parity, - IN UINT8 DataBits, - IN UINT8 StopBits - ); - + IN UINT64 BaudRate, + IN UINT8 Parity, + IN UINT8 DataBits, + IN UINT8 StopBits + ); /** Check to see if a character is available from GDB. Do not read the character as that is done via GdbGetChar(). - @return TRUE - Character availible - @return FALSE - Character not availible - + @return TRUE - Character available + @return FALSE - Character not available + **/ BOOLEAN EFIAPI @@ -65,7 +56,7 @@ GdbIsCharAvailable ( Get a character from GDB. This function must be able to run in interrupt context. @return A character from GDB - + **/ CHAR8 EFIAPI @@ -73,7 +64,6 @@ GdbGetChar ( VOID ); - /** Send a character to GDB. This function must be able to run in interrupt context. @@ -85,10 +75,9 @@ GdbGetChar ( VOID EFIAPI GdbPutChar ( - IN CHAR8 Char + IN CHAR8 Char ); - /** Send an ASCII string to GDB. This function must be able to run in interrupt context. @@ -102,6 +91,4 @@ GdbPutString ( IN CHAR8 *String ); - #endif -