mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
a536e5d699
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.
Note: Headers taken directly from external projects, such as those
in OvmfPkg/Include/IndustryStandard/Xen/ were not modified since they
may be periodically re-synced and do not follow other edk2 coding
stadards.
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>
60 lines
1.7 KiB
C
60 lines
1.7 KiB
C
/** @file
|
|
Macro and type definitions corresponding to the QEMU TPM interface.
|
|
|
|
Refer to "docs/specs/tpm.txt" in the QEMU source directory.
|
|
|
|
Copyright (C) 2018, Red Hat, Inc.
|
|
Copyright (c) 2018, IBM Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Base.h>
|
|
|
|
//
|
|
// whether function is blocked by BIOS settings; bits 0, 1, 2
|
|
//
|
|
#define QEMU_TPM_PPI_FUNC_NOT_IMPLEMENTED (0 << 0)
|
|
#define QEMU_TPM_PPI_FUNC_BIOS_ONLY (1 << 0)
|
|
#define QEMU_TPM_PPI_FUNC_BLOCKED (2 << 0)
|
|
#define QEMU_TPM_PPI_FUNC_ALLOWED_USR_REQ (3 << 0)
|
|
#define QEMU_TPM_PPI_FUNC_ALLOWED_USR_NOT_REQ (4 << 0)
|
|
#define QEMU_TPM_PPI_FUNC_MASK (7 << 0)
|
|
|
|
//
|
|
// The following structure is shared between firmware and ACPI.
|
|
//
|
|
#pragma pack (1)
|
|
typedef struct {
|
|
UINT8 Func[256]; // func
|
|
UINT8 In; // ppin
|
|
UINT32 Ip; // ppip
|
|
UINT32 Response; // pprp
|
|
UINT32 Request; // pprq
|
|
UINT32 RequestParameter; // pprm
|
|
UINT32 LastRequest; // lppr
|
|
UINT32 FRet; // fret
|
|
UINT8 Res1[0x40]; // res1
|
|
UINT8 NextStep; // next_step
|
|
} QEMU_TPM_PPI;
|
|
#pragma pack ()
|
|
|
|
//
|
|
// The following structure is for the fw_cfg etc/tpm/config file.
|
|
//
|
|
#pragma pack (1)
|
|
typedef struct {
|
|
UINT32 PpiAddress;
|
|
UINT8 TpmVersion;
|
|
UINT8 PpiVersion;
|
|
} QEMU_FWCFG_TPM_CONFIG;
|
|
#pragma pack ()
|
|
|
|
#define QEMU_TPM_VERSION_UNSPEC 0
|
|
#define QEMU_TPM_VERSION_1_2 1
|
|
#define QEMU_TPM_VERSION_2 2
|
|
|
|
#define QEMU_TPM_PPI_VERSION_NONE 0
|
|
#define QEMU_TPM_PPI_VERSION_1_30 1
|