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>
41 lines
1.7 KiB
C
41 lines
1.7 KiB
C
/** @file
|
|
This library abstract how to access IPMI device via IPMI command.
|
|
|
|
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Uefi.h>
|
|
#include <IndustryStandard/Ipmi.h>
|
|
|
|
/**
|
|
This service enables submitting commands via Ipmi.
|
|
|
|
@param[in] NetFunction Net function of the command.
|
|
@param[in] Command IPMI Command.
|
|
@param[in] RequestData Command Request Data.
|
|
@param[in] RequestDataSize Size of Command Request Data.
|
|
@param[out] ResponseData Command Response Data. The completion code is the first byte of response data.
|
|
@param[in, out] ResponseDataSize Size of Command Response Data.
|
|
|
|
@retval EFI_SUCCESS The command byte stream was successfully submit to the device and a response was successfully received.
|
|
@retval EFI_NOT_FOUND The command was not successfully sent to the device or a response was not successfully received from the device.
|
|
@retval EFI_NOT_READY Ipmi Device is not ready for Ipmi command access.
|
|
@retval EFI_DEVICE_ERROR Ipmi Device hardware error.
|
|
@retval EFI_TIMEOUT The command time out.
|
|
@retval EFI_UNSUPPORTED The command was not successfully sent to the device.
|
|
@retval EFI_OUT_OF_RESOURCES The resource allcation is out of resource or data size error.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
IpmiSubmitCommand (
|
|
IN UINT8 NetFunction,
|
|
IN UINT8 Command,
|
|
IN UINT8 *RequestData,
|
|
IN UINT32 RequestDataSize,
|
|
OUT UINT8 *ResponseData,
|
|
IN OUT UINT32 *ResponseDataSize
|
|
);
|