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>
107 lines
2.4 KiB
C
107 lines
2.4 KiB
C
/** @file
|
|
Arm FF-A ns common library Header file
|
|
|
|
Copyright (c) 2024, Arm Limited. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Glossary:
|
|
- FF-A - Firmware Framework for Arm A-profile
|
|
- spmc - Secure Partition Manager Core
|
|
- spmd - Secure Partition Manager Dispatcher
|
|
|
|
@par Reference(s):
|
|
- Arm Firmware Framework for Arm A-Profile [https://developer.arm.com/documentation/den0077/latest]
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/ArmFfaRxTxBufferInfo.h>
|
|
|
|
/**
|
|
Mapping Rx/Tx buffers.
|
|
This function is only called in ArmFfaLibConstructor because
|
|
Rx/Tx buffer is registered only once per partition.
|
|
|
|
@retval EFI_SUCCESS
|
|
@retval EFI_ALREADY_STARTED Rx/Tx buffer already mapped in PEI phase
|
|
@retval EFI_OUT_OF_RESOURCE Out of memory
|
|
@retval EFI_INVALID_PARAMETER Invalid alignment of Rx/Tx buffer
|
|
@retval Others Error
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
ArmFfaLibRxTxMap (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Unmap Rx/Tx buffer.
|
|
This function is only called in Exit boot service because
|
|
Rx/Tx buffer is registered only once per partition.
|
|
|
|
@retval EFI_SUCCESS
|
|
@retval EFI_INVALID_PARAMETERS Already unregistered
|
|
@retval EFI_UNSUPPORTED Not supported
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
ArmFfaLibRxTxUnmap (
|
|
IN VOID
|
|
);
|
|
|
|
/**
|
|
Update Rx/TX buffer information.
|
|
|
|
@param BufferInfo Rx/Tx buffer information.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UpdateRxTxBufferInfo (
|
|
OUT ARM_FFA_RX_TX_BUFFER_INFO *BufferInfo
|
|
);
|
|
|
|
/**
|
|
Find Rx/TX buffer memory allocation hob.
|
|
|
|
@param UseGuid Find MemoryAllocationHob using Guid.
|
|
|
|
@retval MemoryAllocationHob
|
|
@retval NULL No memory allocation hob related to Rx/Tx buffer
|
|
|
|
**/
|
|
EFI_HOB_MEMORY_ALLOCATION *
|
|
EFIAPI
|
|
FindRxTxBufferAllocationHob (
|
|
IN BOOLEAN UseGuid
|
|
);
|
|
|
|
/**
|
|
Remap Rx/TX buffer with converted Rx/Tx Buffer address after
|
|
using permanent memory.
|
|
|
|
@param[out] BufferInfo BufferInfo
|
|
|
|
@retval EFI_SUCCESS Success
|
|
@retval EFI_NOT_FOUND No memory allocation hob related to Rx/Tx buffer
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
RemapFfaRxTxBuffer (
|
|
IN OUT ARM_FFA_RX_TX_BUFFER_INFO *BufferInfo
|
|
);
|
|
|
|
/**
|
|
Callback for when Unmap is called to handle any post unmap
|
|
functionality.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UnmapCallback (
|
|
IN VOID
|
|
);
|