-/** @file
- Basic serial IO abstaction for GDB
-
- Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
-
- 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.
-
-**/
-
-#ifndef __GDB_SERIAL_LIB_H__
-#define __GDB_SERIAL_LIB_H__
-
-
-
-/**
- Sets the baud rate, receive FIFO depth, transmit/receice 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
- 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.
- @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.
-
-**/
-RETURN_STATUS
-EFIAPI
-GdbSerialInit (
- 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
-
-**/
-BOOLEAN
-EFIAPI
-GdbIsCharAvailable (
- VOID
- );
-
-/**
- Get a character from GDB. This function must be able to run in interrupt context.
-
- @return A character from GDB
-
-**/
-CHAR8
-EFIAPI
-GdbGetChar (
- VOID
- );
-
-
-/**
- Send a character to GDB. This function must be able to run in interrupt context.
-
-
- @param Char Send a character to GDB
-
-**/
-
-VOID
-EFIAPI
-GdbPutChar (
- IN CHAR8 Char
- );
-
-
-/**
- Send an ASCII string to GDB. This function must be able to run in interrupt context.
-
-
- @param String Send a string to GDB
-
-**/
-
-VOID
-GdbPutString (
- IN CHAR8 *String
- );
-
-
-#endif
-
+/** @file\r
+ Basic serial IO abstaction 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
+\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
+ 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
+ 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
+ @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
+\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
+\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 available\r
+ @return FALSE - Character not available\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GdbIsCharAvailable (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ 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
+CHAR8\r
+EFIAPI\r
+GdbGetChar (\r
+ VOID\r
+ );\r
+\r
+\r
+/**\r
+ Send a character to GDB. This function must be able to run in interrupt context.\r
+\r
+\r
+ @param Char Send a character to GDB\r
+\r
+**/\r
+\r
+VOID\r
+EFIAPI\r
+GdbPutChar (\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
+\r
+ @param String Send a string to GDB\r
+\r
+**/\r
+\r
+VOID\r
+GdbPutString (\r
+ IN CHAR8 *String\r
+ );\r
+\r
+\r
+#endif\r
+\r
projects / mirror_edk2.git / blobdiff