You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
de527ff606
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
92 lines
2.2 KiB
C
92 lines
2.2 KiB
C
/** @file
|
|
Basic serial IO abstraction for GDB
|
|
|
|
Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
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
|
|
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
|
|
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 configured.
|
|
|
|
**/
|
|
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 available
|
|
@return FALSE - Character not available
|
|
|
|
**/
|
|
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
|
|
);
|