mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
8472271dae
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>
150 lines
4.2 KiB
C
150 lines
4.2 KiB
C
/** @file
|
|
API for SMBIOS Plug and Play functions, access to SMBIOS table and structures.
|
|
|
|
Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <IndustryStandard/SmBios.h>
|
|
|
|
#define DMI_SUCCESS 0x00
|
|
#define DMI_UNKNOWN_FUNCTION 0x81
|
|
#define DMI_FUNCTION_NOT_SUPPORTED 0x82
|
|
#define DMI_INVALID_HANDLE 0x83
|
|
#define DMI_BAD_PARAMETER 0x84
|
|
#define DMI_INVALID_SUBFUNCTION 0x85
|
|
#define DMI_NO_CHANGE 0x86
|
|
#define DMI_ADD_STRUCTURE_FAILED 0x87
|
|
#define DMI_READ_ONLY 0x8D
|
|
#define DMI_LOCK_NOT_SUPPORTED 0x90
|
|
#define DMI_CURRENTLY_LOCKED 0x91
|
|
#define DMI_INVALID_LOCK 0x92
|
|
|
|
#define INVALID_HANDLE (UINT16) (-1)
|
|
|
|
#define EFI_SMBIOSERR(val) EFIERR (0x30000 | val)
|
|
|
|
#define EFI_SMBIOSERR_FAILURE EFI_SMBIOSERR (1)
|
|
#define EFI_SMBIOSERR_STRUCT_NOT_FOUND EFI_SMBIOSERR (2)
|
|
#define EFI_SMBIOSERR_TYPE_UNKNOWN EFI_SMBIOSERR (3)
|
|
#define EFI_SMBIOSERR_UNSUPPORTED EFI_SMBIOSERR (4)
|
|
|
|
/**
|
|
Init the SMBIOS VIEW API's environment for the 32-bit table..
|
|
|
|
@retval EFI_SUCCESS Successful to init the SMBIOS VIEW Lib.
|
|
**/
|
|
EFI_STATUS
|
|
LibSmbiosInit (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Init the SMBIOS VIEW API's environment for the 64-bit table..
|
|
|
|
@retval EFI_SUCCESS Successful to init the SMBIOS VIEW Lib.
|
|
**/
|
|
EFI_STATUS
|
|
LibSmbios64BitInit (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Cleanup the Smbios information.
|
|
**/
|
|
VOID
|
|
LibSmbiosCleanup (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Cleanup the Smbios information.
|
|
**/
|
|
VOID
|
|
LibSmbios64BitCleanup (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Get the entry point structure for the table.
|
|
|
|
@param[out] EntryPointStructure The pointer to populate.
|
|
**/
|
|
VOID
|
|
LibSmbiosGetEPS (
|
|
OUT SMBIOS_TABLE_ENTRY_POINT **EntryPointStructure
|
|
);
|
|
|
|
/**
|
|
Get the entry point structure for the 64-bit table.
|
|
|
|
@param[out] EntryPointStructure The pointer to populate.
|
|
**/
|
|
VOID
|
|
LibSmbios64BitGetEPS (
|
|
OUT SMBIOS_TABLE_3_0_ENTRY_POINT **EntryPointStructure
|
|
);
|
|
|
|
/**
|
|
Return SMBIOS string for the given string number.
|
|
|
|
@param[in] Smbios Pointer to SMBIOS structure.
|
|
@param[in] StringNumber String number to return. -1 is used to skip all strings and
|
|
point to the next SMBIOS structure.
|
|
|
|
@return Pointer to string, or pointer to next SMBIOS strcuture if StringNumber == -1
|
|
**/
|
|
CHAR8 *
|
|
LibGetSmbiosString (
|
|
IN SMBIOS_STRUCTURE_POINTER *Smbios,
|
|
IN UINT16 StringNumber
|
|
);
|
|
|
|
/**
|
|
Get SMBIOS structure for the given Handle,
|
|
Handle is changed to the next handle or 0xFFFF when the end is
|
|
reached or the handle is not found.
|
|
|
|
@param[in, out] Handle 0xFFFF: get the first structure
|
|
Others: get a structure according to this value.
|
|
@param[out] Buffer The pointer to the pointer to the structure.
|
|
@param[out] Length Length of the structure.
|
|
|
|
@retval DMI_SUCCESS Handle is updated with next structure handle or
|
|
0xFFFF(end-of-list).
|
|
|
|
@retval DMI_INVALID_HANDLE Handle is updated with first structure handle or
|
|
0xFFFF(end-of-list).
|
|
**/
|
|
EFI_STATUS
|
|
LibGetSmbiosStructure (
|
|
IN OUT UINT16 *Handle,
|
|
OUT UINT8 **Buffer,
|
|
OUT UINT16 *Length
|
|
);
|
|
|
|
/**
|
|
Get SMBIOS structure for the given Handle in 64-bit table,
|
|
Handle is changed to the next handle or 0xFFFF when the end is
|
|
reached or the handle is not found.
|
|
|
|
@param[in, out] Handle 0xFFFF: get the first structure
|
|
Others: get a structure according to this value.
|
|
@param[out] Buffer The pointer to the pointer to the structure.
|
|
@param[out] Length Length of the structure.
|
|
|
|
@retval DMI_SUCCESS Handle is updated with next structure handle or
|
|
0xFFFF(end-of-list).
|
|
|
|
@retval DMI_INVALID_HANDLE Handle is updated with first structure handle or
|
|
0xFFFF(end-of-list).
|
|
**/
|
|
EFI_STATUS
|
|
LibGetSmbios64BitStructure (
|
|
IN OUT UINT16 *Handle,
|
|
OUT UINT8 **Buffer,
|
|
OUT UINT16 *Length
|
|
);
|