You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
7a934d0bef
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>
178 lines
3.6 KiB
C
178 lines
3.6 KiB
C
/** @file
|
|
This file declares the internal Framework Boot Script format used by
|
|
the PI implementation of Script Saver and Executor.
|
|
|
|
Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#pragma pack(1)
|
|
|
|
//
|
|
// Boot Script Opcode Header Structure Definitions
|
|
//
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
} EFI_BOOT_SCRIPT_GENERIC_HEADER;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT16 Version;
|
|
UINT32 TableLength;
|
|
UINT16 Reserved[2];
|
|
} EFI_BOOT_SCRIPT_TABLE_HEADER;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
} EFI_BOOT_SCRIPT_COMMON_HEADER;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT32 Count;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_IO_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_IO_READ_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT32 Count;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_MEM_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_MEM_READ_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT32 Count;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT32 Count;
|
|
UINT64 Address;
|
|
UINT16 Segment;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
UINT16 Segment;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT64 SmBusAddress;
|
|
UINT32 Operation;
|
|
UINT32 DataSize;
|
|
} EFI_BOOT_SCRIPT_SMBUS_EXECUTE;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT64 Duration;
|
|
} EFI_BOOT_SCRIPT_STALL;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
EFI_PHYSICAL_ADDRESS EntryPoint;
|
|
} EFI_BOOT_SCRIPT_DISPATCH;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
EFI_PHYSICAL_ADDRESS EntryPoint;
|
|
EFI_PHYSICAL_ADDRESS Context;
|
|
} EFI_BOOT_SCRIPT_DISPATCH_2;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
UINT64 Duration;
|
|
UINT64 LoopTimes;
|
|
} EFI_BOOT_SCRIPT_MEM_POLL;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 InformationLength;
|
|
// UINT8 InformationData[InformationLength];
|
|
} EFI_BOOT_SCRIPT_INFORMATION;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
UINT64 Delay;
|
|
} EFI_BOOT_SCRIPT_IO_POLL;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
UINT64 Delay;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG_POLL;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
UINT32 Width;
|
|
UINT64 Address;
|
|
UINT16 Segment;
|
|
UINT64 Delay;
|
|
} EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL;
|
|
|
|
typedef struct {
|
|
UINT16 OpCode;
|
|
UINT8 Length;
|
|
} EFI_BOOT_SCRIPT_TERMINATE;
|
|
|
|
#pragma pack()
|
|
|
|
#define BOOT_SCRIPT_NODE_MAX_LENGTH 1024
|
|
|
|
#define BOOT_SCRIPT_TABLE_VERSION 0x0001
|