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