mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
7835e5802a
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>
50 lines
2 KiB
C
50 lines
2 KiB
C
/** @file
|
|
This file contains the boot script definitions that are shared between the
|
|
Boot Script Executor PPI and the Boot Script Save Protocol.
|
|
|
|
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
// *******************************************
|
|
// EFI Boot Script Opcode definitions
|
|
// *******************************************
|
|
#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00
|
|
#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01
|
|
#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02
|
|
#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05
|
|
#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06
|
|
#define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07
|
|
#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08
|
|
#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x09
|
|
#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C
|
|
#define EFI_BOOT_SCRIPT_IO_POLL_OPCODE 0x0D
|
|
#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x0E
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE 0x0F
|
|
#define EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE 0x10
|
|
|
|
// *******************************************
|
|
// EFI_BOOT_SCRIPT_WIDTH
|
|
// *******************************************
|
|
typedef enum {
|
|
EfiBootScriptWidthUint8,
|
|
EfiBootScriptWidthUint16,
|
|
EfiBootScriptWidthUint32,
|
|
EfiBootScriptWidthUint64,
|
|
EfiBootScriptWidthFifoUint8,
|
|
EfiBootScriptWidthFifoUint16,
|
|
EfiBootScriptWidthFifoUint32,
|
|
EfiBootScriptWidthFifoUint64,
|
|
EfiBootScriptWidthFillUint8,
|
|
EfiBootScriptWidthFillUint16,
|
|
EfiBootScriptWidthFillUint32,
|
|
EfiBootScriptWidthFillUint64,
|
|
EfiBootScriptWidthMaximum
|
|
} EFI_BOOT_SCRIPT_WIDTH;
|