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>
93 lines
2.8 KiB
C
93 lines
2.8 KiB
C
/** @file
|
|
Macro and type definitions corresponding to the QEMU fw_cfg interface.
|
|
|
|
Refer to "docs/specs/fw_cfg.txt" in the QEMU source directory.
|
|
|
|
Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
|
|
Copyright (C) 2013 - 2017, Red Hat, Inc.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Base.h>
|
|
|
|
//
|
|
// The size, in bytes, of names of firmware configuration files, including at
|
|
// least one terminating NUL byte.
|
|
//
|
|
#define QEMU_FW_CFG_FNAME_SIZE 56
|
|
|
|
//
|
|
// If the following bit is set in the UINT32 fw_cfg revision / feature bitmap
|
|
// -- read from key 0x0001 with the basic IO Port or MMIO method --, then the
|
|
// DMA interface is available.
|
|
//
|
|
#define FW_CFG_F_DMA BIT1
|
|
|
|
//
|
|
// Macros for the FW_CFG_DMA_ACCESS.Control bitmap (in native encoding).
|
|
//
|
|
#define FW_CFG_DMA_CTL_ERROR BIT0
|
|
#define FW_CFG_DMA_CTL_READ BIT1
|
|
#define FW_CFG_DMA_CTL_SKIP BIT2
|
|
#define FW_CFG_DMA_CTL_SELECT BIT3
|
|
#define FW_CFG_DMA_CTL_WRITE BIT4
|
|
|
|
//
|
|
// The fw_cfg registers can be found at these IO Ports
|
|
//
|
|
#define FW_CFG_IO_SELECTOR 0x510
|
|
#define FW_CFG_IO_DATA 0x511
|
|
#define FW_CFG_IO_DMA_ADDRESS 0x514
|
|
|
|
//
|
|
// Numerically defined keys.
|
|
//
|
|
typedef enum {
|
|
QemuFwCfgItemSignature = 0x0000,
|
|
QemuFwCfgItemInterfaceVersion = 0x0001,
|
|
QemuFwCfgItemSystemUuid = 0x0002,
|
|
QemuFwCfgItemRamSize = 0x0003,
|
|
QemuFwCfgItemGraphicsEnabled = 0x0004,
|
|
QemuFwCfgItemSmpCpuCount = 0x0005,
|
|
QemuFwCfgItemMachineId = 0x0006,
|
|
QemuFwCfgItemKernelAddress = 0x0007,
|
|
QemuFwCfgItemKernelSize = 0x0008,
|
|
QemuFwCfgItemKernelCommandLine = 0x0009,
|
|
QemuFwCfgItemInitrdAddress = 0x000a,
|
|
QemuFwCfgItemInitrdSize = 0x000b,
|
|
QemuFwCfgItemBootDevice = 0x000c,
|
|
QemuFwCfgItemNumaData = 0x000d,
|
|
QemuFwCfgItemBootMenu = 0x000e,
|
|
QemuFwCfgItemMaximumCpuCount = 0x000f,
|
|
QemuFwCfgItemKernelEntry = 0x0010,
|
|
QemuFwCfgItemKernelData = 0x0011,
|
|
QemuFwCfgItemInitrdData = 0x0012,
|
|
QemuFwCfgItemCommandLineAddress = 0x0013,
|
|
QemuFwCfgItemCommandLineSize = 0x0014,
|
|
QemuFwCfgItemCommandLineData = 0x0015,
|
|
QemuFwCfgItemKernelSetupAddress = 0x0016,
|
|
QemuFwCfgItemKernelSetupSize = 0x0017,
|
|
QemuFwCfgItemKernelSetupData = 0x0018,
|
|
QemuFwCfgItemFileDir = 0x0019,
|
|
|
|
QemuFwCfgItemX86AcpiTables = 0x8000,
|
|
QemuFwCfgItemX86SmbiosTables = 0x8001,
|
|
QemuFwCfgItemX86Irq0Override = 0x8002,
|
|
QemuFwCfgItemX86E820Table = 0x8003,
|
|
QemuFwCfgItemX86HpetData = 0x8004,
|
|
} FIRMWARE_CONFIG_ITEM;
|
|
|
|
//
|
|
// Communication structure for the DMA access method. All fields are encoded in
|
|
// big endian.
|
|
//
|
|
#pragma pack (1)
|
|
typedef struct {
|
|
UINT32 Control;
|
|
UINT32 Length;
|
|
UINT64 Address;
|
|
} FW_CFG_DMA_ACCESS;
|
|
#pragma pack ()
|