mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
01f75b3927
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>
279 lines
10 KiB
C
279 lines
10 KiB
C
/** @file
|
|
|
|
Copyright (c) 2017 - 2019, ARM Limited. All rights reserved.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Glossary:
|
|
- ACPI - Advanced Configuration and Power Interface
|
|
- SMBIOS - System Management BIOS
|
|
- DT - Device Tree
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <AcpiTableGenerator.h>
|
|
#include <SmbiosTableGenerator.h>
|
|
#include <DeviceTreeTableGenerator.h>
|
|
#include <Library/MetadataObjLib.h>
|
|
|
|
/** This macro defines the Dynamic Table Factory Protocol GUID.
|
|
|
|
GUID: {91D1E327-FE5A-49B8-AB65-0ECE2DDB45EC}
|
|
*/
|
|
#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_GUID \
|
|
{ 0x91d1e327, 0xfe5a, 0x49b8, \
|
|
{ 0xab, 0x65, 0xe, 0xce, 0x2d, 0xdb, 0x45, 0xec } \
|
|
};
|
|
|
|
/** This macro defines the Configuration Manager Protocol Revision.
|
|
*/
|
|
#define EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL_REVISION CREATE_REVISION (1, 0)
|
|
|
|
#pragma pack(1)
|
|
|
|
/**
|
|
Forward declarations:
|
|
*/
|
|
typedef struct DynamicTableFactoryProtocol EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL;
|
|
typedef struct DynamicTableFactoryInfo EDKII_DYNAMIC_TABLE_FACTORY_INFO;
|
|
|
|
/** Return a pointer to the ACPI table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] TableId The ACPI table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested ACPI table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_GET_ACPI_TABLE_GENERATOR)(
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST ACPI_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST ACPI_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
/** Registers an ACPI table generator.
|
|
|
|
@param [in] Generator Pointer to the ACPI table generator.
|
|
|
|
@retval EFI_SUCCESS The Generator was registered
|
|
successfully.
|
|
@retval EFI_INVALID_PARAMETER The Generator ID is invalid or
|
|
the Generator pointer is NULL.
|
|
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
|
|
already registered.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_ACPI_TABLE_GENERATOR)(
|
|
IN CONST ACPI_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Deregister an ACPI table generator.
|
|
|
|
@param [in] Generator Pointer to the ACPI table generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER The generator is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_ACPI_TABLE_GENERATOR)(
|
|
IN CONST ACPI_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Return a pointer to the SMBIOS table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] TableId The SMBIOS table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested SMBIOS table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_GET_SMBIOS_TABLE_GENERATOR)(
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST SMBIOS_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST SMBIOS_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
/** Register a SMBIOS table generator.
|
|
|
|
@param [in] Generator Pointer to the SMBIOS table generator.
|
|
|
|
@retval EFI_SUCCESS The Generator was registered
|
|
successfully.
|
|
@retval EFI_INVALID_PARAMETER The Generator ID is invalid or
|
|
the Generator pointer is NULL.
|
|
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
|
|
already registered.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR)(
|
|
IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Deregister a SMBIOS table generator.
|
|
|
|
@param [in] Generator Pointer to the SMBIOS table generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER The generator is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_SMBIOS_TABLE_GENERATOR)(
|
|
IN CONST SMBIOS_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Return a pointer to the Device Tree table generator.
|
|
|
|
@param [in] This Pointer to the Dynamic Table Factory Protocol.
|
|
@param [in] TableId The Device Tree table generator ID for the
|
|
requested generator.
|
|
@param [out] Generator Pointer to the requested Device Tree table
|
|
generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER A parameter is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_GET_DT_TABLE_GENERATOR)(
|
|
IN CONST EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL *CONST This,
|
|
IN CONST DT_TABLE_GENERATOR_ID GeneratorId,
|
|
OUT CONST DT_TABLE_GENERATOR **CONST Generator
|
|
);
|
|
|
|
/** Register a DT table generator.
|
|
|
|
@param [in] Generator Pointer to the DT table generator.
|
|
|
|
@retval EFI_SUCCESS The Generator was registered
|
|
successfully.
|
|
@retval EFI_INVALID_PARAMETER The Generator ID is invalid or
|
|
the Generator pointer is NULL.
|
|
@retval EFI_ALREADY_STARTED The Generator for the Table ID is
|
|
already registered.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_DT_TABLE_GENERATOR)(
|
|
IN CONST DT_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Deregister a DT table generator.
|
|
|
|
This function is called by the DT table generator to deregister itself
|
|
from the DT table factory.
|
|
|
|
@param [in] Generator Pointer to the DT table generator.
|
|
|
|
@retval EFI_SUCCESS Success.
|
|
@retval EFI_INVALID_PARAMETER The generator is invalid.
|
|
@retval EFI_NOT_FOUND The requested generator is not found
|
|
in the list of registered generators.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_DT_TABLE_GENERATOR)(
|
|
IN CONST DT_TABLE_GENERATOR *CONST Generator
|
|
);
|
|
|
|
/** Get the Root handle of the MetadataObjLib.
|
|
|
|
During the firmware table generation, some Metadata information might be
|
|
generated by different generators. This Metadata might be subject to
|
|
additional validation.
|
|
|
|
@return The Metadata Root handle.
|
|
**/
|
|
typedef
|
|
VOID *
|
|
(EFIAPI *EDKII_DYNAMIC_TABLE_FACTORY_GET_METADATA_ROOT)(
|
|
VOID
|
|
);
|
|
|
|
/** A structure describing the Dynamic Table Factory Protocol interface.
|
|
*/
|
|
typedef struct DynamicTableFactoryProtocol {
|
|
/// The Dynamic Table Factory Protocol revision.
|
|
UINT32 Revision;
|
|
|
|
/// The interface used to request an ACPI Table Generator.
|
|
EDKII_DYNAMIC_TABLE_FACTORY_GET_ACPI_TABLE_GENERATOR GetAcpiTableGenerator;
|
|
|
|
/// Register an ACPI table Generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_ACPI_TABLE_GENERATOR
|
|
RegisterAcpiTableGenerator;
|
|
|
|
/// Deregister an ACPI table Generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_ACPI_TABLE_GENERATOR
|
|
DeregisterAcpiTableGenerator;
|
|
|
|
/// The interface used to request a SMBIOS Table Generator.
|
|
EDKII_DYNAMIC_TABLE_FACTORY_GET_SMBIOS_TABLE_GENERATOR GetSmbiosTableGenerator;
|
|
|
|
/// Register an SMBIOS table Generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR
|
|
RegisterSmbiosTableGenerator;
|
|
|
|
/// Deregister an SMBIOS table Generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_SMBIOS_TABLE_GENERATOR
|
|
DeregisterSmbiosTableGenerator;
|
|
|
|
/// The interface used to request a Device Tree Table Generator.
|
|
EDKII_DYNAMIC_TABLE_FACTORY_GET_DT_TABLE_GENERATOR GetDtTableGenerator;
|
|
|
|
/// Register a DT generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_REGISTER_DT_TABLE_GENERATOR
|
|
RegisterDtTableGenerator;
|
|
|
|
/// Deregister a DT generator
|
|
EDKII_DYNAMIC_TABLE_FACTORY_DEREGISTER_DT_TABLE_GENERATOR
|
|
DeregisterDtTableGenerator;
|
|
|
|
/// Finalization step
|
|
EDKII_DYNAMIC_TABLE_FACTORY_GET_METADATA_ROOT
|
|
GetMetadataRoot;
|
|
|
|
EDKII_DYNAMIC_TABLE_FACTORY_SMBIOS_TABLE_ADD_HANDLE
|
|
AddSmbiosHandle;
|
|
|
|
EDKII_DYNAMIC_TABLE_FACTORY_SMBIOS_TABLE_GET_HANDLE
|
|
GetSmbiosHandle;
|
|
|
|
EDKII_DYNAMIC_TABLE_FACTORY_SMBIOS_TABLE_GET_HANDLE_EX
|
|
GetSmbiosHandleEx;
|
|
|
|
/** Pointer to the data structure that holds the
|
|
list of registered table generators
|
|
*/
|
|
EDKII_DYNAMIC_TABLE_FACTORY_INFO *TableFactoryInfo;
|
|
} EDKII_DYNAMIC_TABLE_FACTORY_PROTOCOL;
|
|
|
|
/** The Dynamic Table Factory Protocol GUID.
|
|
*/
|
|
extern EFI_GUID gEdkiiDynamicTableFactoryProtocolGuid;
|
|
|
|
#pragma pack()
|