mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
6181c85fa9
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>
140 lines
5.2 KiB
C
140 lines
5.2 KiB
C
/** @file
|
|
Definitions of RedfishPlatformConfigLib
|
|
|
|
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
|
|
Copyright (c) 2022-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Protocol/EdkIIRedfishPlatformConfig.h>
|
|
|
|
/**
|
|
Get Redfish value with the given Schema and Configure Language.
|
|
|
|
@param[in] Schema The Redfish schema to query.
|
|
@param[in] Version The Redfish version to query.
|
|
@param[in] ConfigureLang The target value which match this configure Language.
|
|
@param[out] Value The returned value.
|
|
|
|
@retval EFI_SUCCESS Value is returned successfully.
|
|
@retval EFI_NOT_READY Redfish Platform Config protocol is not ready.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RedfishPlatformConfigGetValue (
|
|
IN CHAR8 *Schema,
|
|
IN CHAR8 *Version,
|
|
IN EFI_STRING ConfigureLang,
|
|
OUT EDKII_REDFISH_VALUE *Value
|
|
);
|
|
|
|
/**
|
|
Set Redfish value with the given Schema and Configure Language.
|
|
|
|
@param[in] Schema The Redfish schema to query.
|
|
@param[in] Version The Redfish version to query.
|
|
@param[in] ConfigureLang The target value which match this configure Language.
|
|
@param[in] Value Pointer to the Redfish value to set.
|
|
|
|
@retval EFI_SUCCESS Value is returned successfully.
|
|
@retval EFI_NOT_READY Redfish Platform Config protocol is not ready.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RedfishPlatformConfigSetValue (
|
|
IN CHAR8 *Schema,
|
|
IN CHAR8 *Version,
|
|
IN EFI_STRING ConfigureLang,
|
|
IN EDKII_REDFISH_VALUE *Value
|
|
);
|
|
|
|
/**
|
|
Get the list of Configure Language from platform configuration by the given Schema and Pattern.
|
|
|
|
@param[in] Schema The Redfish schema to query.
|
|
@param[in] Version The Redfish version to query.
|
|
@param[in] Pattern The target Configure Language pattern.
|
|
@param[out] ConfigureLangList The list of Configure Language.
|
|
@param[out] Count The number of Configure Language in ConfigureLangList.
|
|
|
|
@retval EFI_SUCCESS ConfigureLangList is returned successfully.
|
|
@retval EFI_NOT_READY Redfish Platform Config protocol is not ready.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RedfishPlatformConfigGetConfigureLang (
|
|
IN CHAR8 *Schema,
|
|
IN CHAR8 *Version,
|
|
IN EFI_STRING Pattern,
|
|
OUT EFI_STRING **ConfigureLangList,
|
|
OUT UINTN *Count
|
|
);
|
|
|
|
/**
|
|
Get the list of supported Redfish schema from platform configuration.
|
|
|
|
@param[out] SupportedSchema The supported schema list which is separated by ';'.
|
|
For example: "x-UEFI-redfish-Memory.v1_7_1;x-UEFI-redfish-Boot.v1_0_1"
|
|
The SupportedSchema is allocated by the callee. It's caller's
|
|
responsibility to free this buffer using FreePool().
|
|
|
|
@retval EFI_SUCCESS Schema is returned successfully.
|
|
@retval EFI_NOT_READY Redfish Platform Config protocol is not ready.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
RedfishPlatformConfigGetSupportedSchema (
|
|
OUT CHAR8 **SupportedSchema
|
|
);
|
|
|
|
/**
|
|
Get Redfish attribute value with the given Schema and Configure Language.
|
|
|
|
@param[in] Schema The Redfish schema to query.
|
|
@param[in] Version The Redfish version to query.
|
|
@param[in] ConfigureLang The target value which match this configure Language.
|
|
@param[out] AttributeValue The attribute value.
|
|
|
|
@retval EFI_SUCCESS Value is returned successfully.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RedfishPlatformConfigGetAttribute (
|
|
IN CHAR8 *Schema,
|
|
IN CHAR8 *Version,
|
|
IN EFI_STRING ConfigureLang,
|
|
OUT EDKII_REDFISH_ATTRIBUTE *AttributeValue
|
|
);
|
|
|
|
/**
|
|
Get Redfish default value with the given Schema and Configure Language.
|
|
|
|
@param[in] Schema The Redfish schema to query.
|
|
@param[in] Version The Redfish version to query.
|
|
@param[in] ConfigureLang The target value which match this configure Language.
|
|
@param[in] DefaultClass The UEFI defined default class.
|
|
Please refer to UEFI spec. 33.2.5.8 "defaults" for details.
|
|
@param[out] Value The returned value.
|
|
|
|
@retval EFI_SUCCESS Value is returned successfully.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
RedfishPlatformConfigGetDefaultValue (
|
|
IN CHAR8 *Schema,
|
|
IN CHAR8 *Version,
|
|
IN EFI_STRING ConfigureLang,
|
|
IN UINT16 DefaultClass,
|
|
OUT EDKII_REDFISH_VALUE *Value
|
|
);
|