mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
7a934d0bef
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>
55 lines
2 KiB
C
55 lines
2 KiB
C
/** @file
|
|
Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/NonDiscoverableDevice.h>
|
|
|
|
typedef enum {
|
|
NonDiscoverableDeviceTypeAhci,
|
|
NonDiscoverableDeviceTypeAmba,
|
|
NonDiscoverableDeviceTypeEhci,
|
|
NonDiscoverableDeviceTypeNvme,
|
|
NonDiscoverableDeviceTypeOhci,
|
|
NonDiscoverableDeviceTypeSdhci,
|
|
NonDiscoverableDeviceTypeUfs,
|
|
NonDiscoverableDeviceTypeUhci,
|
|
NonDiscoverableDeviceTypeXhci,
|
|
NonDiscoverableDeviceTypeMax,
|
|
} NON_DISCOVERABLE_DEVICE_TYPE;
|
|
|
|
/**
|
|
Register a non-discoverable MMIO device
|
|
|
|
@param[in] Type The type of non-discoverable device
|
|
@param[in] DmaType Whether the device is DMA coherent
|
|
@param[in] InitFunc Initialization routine to be invoked when
|
|
the device is enabled
|
|
@param[in,out] Handle The handle onto which to install the
|
|
non-discoverable device protocol.
|
|
If Handle is NULL or *Handle is NULL, a
|
|
new handle will be allocated.
|
|
@param[in] NumMmioResources The number of UINTN base/size pairs that
|
|
follow, each describing an MMIO region
|
|
owned by the device
|
|
@param[in] ... The variable argument list which contains the
|
|
info about MmioResources.
|
|
|
|
@retval EFI_SUCCESS The registration succeeded.
|
|
@retval Other The registration failed.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
RegisterNonDiscoverableMmioDevice (
|
|
IN NON_DISCOVERABLE_DEVICE_TYPE Type,
|
|
IN NON_DISCOVERABLE_DEVICE_DMA_TYPE DmaType,
|
|
IN NON_DISCOVERABLE_DEVICE_INIT InitFunc,
|
|
IN OUT EFI_HANDLE *Handle OPTIONAL,
|
|
IN UINTN NumMmioResources,
|
|
...
|
|
);
|