vendorcode/intel: Add EDK2 header files
As the first step in adding support for FSP 1.1, add common header files for EDK2. Internally FSP is based upon EDK2 and uses the defines and data structures within these files for its interface. These files come from revision 16227 of the open source EDK2 tree at https://svn.code.sf.net/p/edk2/code/trunk/edk2. These files are provided in an EDK2 style tree to allow direct comparison with the EDK2 tree. Updates may be done manually to these files but only to support FSP 1.1 on UEFI 2.4. A uefi_2.5 tree should be added in the future as FSP binaries migrate to UEFI 2.5. Note: All the files were modified to use Linux line termination. BRANCH=none BUG=None TEST=Build for Braswell or Skylake boards using FSP 1.1. Change-Id: Ide5684b7eb6392e12f9f2f24215f5370c2d47c70 Signed-off-by: Lee Leahy <leroy.p.leahy@intel.com> Reviewed-on: http://review.coreboot.org/9943 Tested-by: build bot (Jenkins) Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
This commit is contained in:
parent
405bd698a6
commit
c95ebccd9a
src/vendorcode/intel/edk2/uefi_2.4
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,40 @@
|
||||||
|
/** @file
|
||||||
|
Guid used to define the Firmware File System 2.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
GUIDs introduced in PI Version 1.0.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __FIRMWARE_FILE_SYSTEM2_GUID_H__
|
||||||
|
#define __FIRMWARE_FILE_SYSTEM2_GUID_H__
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The firmware volume header contains a data field for
|
||||||
|
/// the file system GUID
|
||||||
|
///
|
||||||
|
#define EFI_FIRMWARE_FILE_SYSTEM2_GUID \
|
||||||
|
{ 0x8c8ce578, 0x8a3d, 0x4f1c, { 0x99, 0x35, 0x89, 0x61, 0x85, 0xc3, 0x2d, 0xd3 } }
|
||||||
|
|
||||||
|
///
|
||||||
|
/// A Volume Top File (VTF) is a file that must be
|
||||||
|
/// located such that the last byte of the file is
|
||||||
|
/// also the last byte of the firmware volume
|
||||||
|
///
|
||||||
|
#define EFI_FFS_VOLUME_TOP_FILE_GUID \
|
||||||
|
{ 0x1BA0062E, 0xC779, 0x4582, { 0x85, 0x66, 0x33, 0x6A, 0xE8, 0xF7, 0x8F, 0x9 } }
|
||||||
|
|
||||||
|
|
||||||
|
extern EFI_GUID gEfiFirmwareFileSystem2Guid;
|
||||||
|
extern EFI_GUID gEfiFirmwareVolumeTopFileGuid;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,128 @@
|
||||||
|
/** @file
|
||||||
|
GUID for UEFI WIN_CERTIFICATE structure.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
GUID defined in UEFI 2.0 spec.
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __EFI_WIN_CERTIFICATE_H__
|
||||||
|
#define __EFI_WIN_CERTIFICATE_H__
|
||||||
|
|
||||||
|
//
|
||||||
|
// _WIN_CERTIFICATE.wCertificateType
|
||||||
|
//
|
||||||
|
#define WIN_CERT_TYPE_PKCS_SIGNED_DATA 0x0002
|
||||||
|
#define WIN_CERT_TYPE_EFI_PKCS115 0x0EF0
|
||||||
|
#define WIN_CERT_TYPE_EFI_GUID 0x0EF1
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The WIN_CERTIFICATE structure is part of the PE/COFF specification.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The length of the entire certificate,
|
||||||
|
/// including the length of the header, in bytes.
|
||||||
|
///
|
||||||
|
UINT32 dwLength;
|
||||||
|
///
|
||||||
|
/// The revision level of the WIN_CERTIFICATE
|
||||||
|
/// structure. The current revision level is 0x0200.
|
||||||
|
///
|
||||||
|
UINT16 wRevision;
|
||||||
|
///
|
||||||
|
/// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI
|
||||||
|
/// certificate types. The UEFI specification reserves the range of
|
||||||
|
/// certificate type values from 0x0EF0 to 0x0EFF.
|
||||||
|
///
|
||||||
|
UINT16 wCertificateType;
|
||||||
|
///
|
||||||
|
/// The following is the actual certificate. The format of
|
||||||
|
/// the certificate depends on wCertificateType.
|
||||||
|
///
|
||||||
|
/// UINT8 bCertificate[ANYSIZE_ARRAY];
|
||||||
|
///
|
||||||
|
} WIN_CERTIFICATE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// WIN_CERTIFICATE_UEFI_GUID.CertType
|
||||||
|
///
|
||||||
|
#define EFI_CERT_TYPE_RSA2048_SHA256_GUID \
|
||||||
|
{0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf } }
|
||||||
|
|
||||||
|
///
|
||||||
|
/// WIN_CERTIFICATE_UEFI_GUID.CertData
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
EFI_GUID HashType;
|
||||||
|
UINT8 PublicKey[256];
|
||||||
|
UINT8 Signature[256];
|
||||||
|
} EFI_CERT_BLOCK_RSA_2048_SHA256;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Certificate which encapsulates a GUID-specific digital signature
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// This is the standard WIN_CERTIFICATE header, where
|
||||||
|
/// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID.
|
||||||
|
///
|
||||||
|
WIN_CERTIFICATE Hdr;
|
||||||
|
///
|
||||||
|
/// This is the unique id which determines the
|
||||||
|
/// format of the CertData. .
|
||||||
|
///
|
||||||
|
EFI_GUID CertType;
|
||||||
|
///
|
||||||
|
/// The following is the certificate data. The format of
|
||||||
|
/// the data is determined by the CertType.
|
||||||
|
/// If CertType is EFI_CERT_TYPE_RSA2048_SHA256_GUID,
|
||||||
|
/// the CertData will be EFI_CERT_BLOCK_RSA_2048_SHA256 structure.
|
||||||
|
///
|
||||||
|
UINT8 CertData[1];
|
||||||
|
} WIN_CERTIFICATE_UEFI_GUID;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital signature.
|
||||||
|
///
|
||||||
|
/// The WIN_CERTIFICATE_UEFI_PKCS1_15 structure is derived from
|
||||||
|
/// WIN_CERTIFICATE and encapsulate the information needed to
|
||||||
|
/// implement the RSASSA-PKCS1-v1_5 digital signature algorithm as
|
||||||
|
/// specified in RFC2437.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// This is the standard WIN_CERTIFICATE header, where
|
||||||
|
/// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15.
|
||||||
|
///
|
||||||
|
WIN_CERTIFICATE Hdr;
|
||||||
|
///
|
||||||
|
/// This is the hashing algorithm which was performed on the
|
||||||
|
/// UEFI executable when creating the digital signature.
|
||||||
|
///
|
||||||
|
EFI_GUID HashAlgorithm;
|
||||||
|
///
|
||||||
|
/// The following is the actual digital signature. The
|
||||||
|
/// size of the signature is the same size as the key
|
||||||
|
/// (1024-bit key is 128 bytes) and can be determined by
|
||||||
|
/// subtracting the length of the other parts of this header
|
||||||
|
/// from the total length of the certificate as found in
|
||||||
|
/// Hdr.dwLength.
|
||||||
|
///
|
||||||
|
/// UINT8 Signature[];
|
||||||
|
///
|
||||||
|
} WIN_CERTIFICATE_EFI_PKCS1_15;
|
||||||
|
|
||||||
|
extern EFI_GUID gEfiCertTypeRsa2048Sha256Guid;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,292 @@
|
||||||
|
/** @file
|
||||||
|
Processor or Compiler specific defines and types for IA-32 architecture.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials are licensed and made available under
|
||||||
|
the terms and conditions of the BSD License that accompanies this distribution.
|
||||||
|
The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PROCESSOR_BIND_H__
|
||||||
|
#define __PROCESSOR_BIND_H__
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Define the processor type so other code can make processor based choices.
|
||||||
|
///
|
||||||
|
#define MDE_CPU_IA32
|
||||||
|
|
||||||
|
//
|
||||||
|
// Make sure we are using the correct packing rules per EFI specification
|
||||||
|
//
|
||||||
|
#if !defined(__GNUC__)
|
||||||
|
#pragma pack()
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__INTEL_COMPILER)
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #869: "Parameter" was never referenced warning.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with -Wall
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 869 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #1418: external function definition with no prior declaration.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 1418 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #1419: external declaration in primary source file
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 1419 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #593: "Variable" was set but never used.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 593 )
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(_MSC_EXTENSIONS)
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable warning that make it impossible to compile at /W4
|
||||||
|
// This only works for Microsoft* tools
|
||||||
|
//
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disabling bitfield type checking warnings.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4214 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disabling the unreferenced formal parameter warnings.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4100 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable slightly different base types warning as CHAR8 * can not be set
|
||||||
|
// to a constant string.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4057 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4127 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// This warning is caused by functions defined but not used. For precompiled header only.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4505 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// This warning is caused by empty (after preprocessing) source file. For precompiled header only.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4206 )
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(_MSC_EXTENSIONS)
|
||||||
|
|
||||||
|
//
|
||||||
|
// use Microsoft C complier dependent integer width types
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 8-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned __int64 UINT64;
|
||||||
|
///
|
||||||
|
/// 8-byte signed value.
|
||||||
|
///
|
||||||
|
typedef __int64 INT64;
|
||||||
|
///
|
||||||
|
/// 4-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned __int32 UINT32;
|
||||||
|
///
|
||||||
|
/// 4-byte signed value.
|
||||||
|
///
|
||||||
|
typedef __int32 INT32;
|
||||||
|
///
|
||||||
|
/// 2-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned short UINT16;
|
||||||
|
///
|
||||||
|
/// 2-byte Character. Unless otherwise specified all strings are stored in the
|
||||||
|
/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
|
||||||
|
///
|
||||||
|
typedef unsigned short CHAR16;
|
||||||
|
///
|
||||||
|
/// 2-byte signed value.
|
||||||
|
///
|
||||||
|
typedef short INT16;
|
||||||
|
///
|
||||||
|
/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
|
||||||
|
/// values are undefined.
|
||||||
|
///
|
||||||
|
typedef unsigned char BOOLEAN;
|
||||||
|
///
|
||||||
|
/// 1-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned char UINT8;
|
||||||
|
///
|
||||||
|
/// 1-byte Character.
|
||||||
|
///
|
||||||
|
typedef char CHAR8;
|
||||||
|
///
|
||||||
|
/// 1-byte signed value.
|
||||||
|
///
|
||||||
|
typedef signed char INT8;
|
||||||
|
#else
|
||||||
|
///
|
||||||
|
/// 8-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned long long UINT64;
|
||||||
|
///
|
||||||
|
/// 8-byte signed value.
|
||||||
|
///
|
||||||
|
typedef long long INT64;
|
||||||
|
///
|
||||||
|
/// 4-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned int UINT32;
|
||||||
|
///
|
||||||
|
/// 4-byte signed value.
|
||||||
|
///
|
||||||
|
typedef int INT32;
|
||||||
|
///
|
||||||
|
/// 2-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned short UINT16;
|
||||||
|
///
|
||||||
|
/// 2-byte Character. Unless otherwise specified all strings are stored in the
|
||||||
|
/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
|
||||||
|
///
|
||||||
|
typedef unsigned short CHAR16;
|
||||||
|
///
|
||||||
|
/// 2-byte signed value.
|
||||||
|
///
|
||||||
|
typedef short INT16;
|
||||||
|
///
|
||||||
|
/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
|
||||||
|
/// values are undefined.
|
||||||
|
///
|
||||||
|
typedef unsigned char BOOLEAN;
|
||||||
|
///
|
||||||
|
/// 1-byte unsigned value.
|
||||||
|
///
|
||||||
|
typedef unsigned char UINT8;
|
||||||
|
///
|
||||||
|
/// 1-byte Character
|
||||||
|
///
|
||||||
|
typedef char CHAR8;
|
||||||
|
///
|
||||||
|
/// 1-byte signed value
|
||||||
|
///
|
||||||
|
typedef signed char INT8;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions;
|
||||||
|
/// 8 bytes on supported 64-bit processor instructions.)
|
||||||
|
///
|
||||||
|
typedef UINT32 UINTN;
|
||||||
|
///
|
||||||
|
/// Signed value of native width. (4 bytes on supported 32-bit processor instructions;
|
||||||
|
/// 8 bytes on supported 64-bit processor instructions.)
|
||||||
|
///
|
||||||
|
typedef INT32 INTN;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Processor specific defines
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// A value of native width with the highest bit set.
|
||||||
|
///
|
||||||
|
#define MAX_BIT 0x80000000
|
||||||
|
///
|
||||||
|
/// A value of native width with the two highest bits set.
|
||||||
|
///
|
||||||
|
#define MAX_2_BITS 0xC0000000
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Maximum legal IA-32 address.
|
||||||
|
///
|
||||||
|
#define MAX_ADDRESS 0xFFFFFFFF
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Maximum legal IA-32 INTN and UINTN values.
|
||||||
|
///
|
||||||
|
#define MAX_INTN ((INTN)0x7FFFFFFF)
|
||||||
|
#define MAX_UINTN ((UINTN)0xFFFFFFFF)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The stack alignment required for IA-32.
|
||||||
|
///
|
||||||
|
#define CPU_STACK_ALIGNMENT sizeof(UINTN)
|
||||||
|
|
||||||
|
//
|
||||||
|
// Modifier to ensure that all protocol member functions and EFI intrinsics
|
||||||
|
// use the correct C calling convention. All protocol member functions and
|
||||||
|
// EFI intrinsics are required to modify their member functions with EFIAPI.
|
||||||
|
//
|
||||||
|
#ifdef EFIAPI
|
||||||
|
///
|
||||||
|
/// If EFIAPI is already defined, then we use that definition.
|
||||||
|
///
|
||||||
|
#elif defined(_MSC_EXTENSIONS)
|
||||||
|
///
|
||||||
|
/// Microsoft* compiler specific method for EFIAPI calling convention.
|
||||||
|
///
|
||||||
|
#define EFIAPI __cdecl
|
||||||
|
#elif defined(__GNUC__)
|
||||||
|
///
|
||||||
|
/// GCC specific method for EFIAPI calling convention.
|
||||||
|
///
|
||||||
|
#define EFIAPI __attribute__((cdecl))
|
||||||
|
#else
|
||||||
|
///
|
||||||
|
/// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
|
||||||
|
/// is the standard.
|
||||||
|
///
|
||||||
|
#define EFIAPI
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__GNUC__)
|
||||||
|
///
|
||||||
|
/// For GNU assembly code, .global or .globl can declare global symbols.
|
||||||
|
/// Define this macro to unify the usage.
|
||||||
|
///
|
||||||
|
#define ASM_GLOBAL .globl
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
Return the pointer to the first instruction of a function given a function pointer.
|
||||||
|
On IA-32 CPU architectures, these two pointer values are the same,
|
||||||
|
so the implementation of this macro is very simple.
|
||||||
|
|
||||||
|
@param FunctionPointer A pointer to a function.
|
||||||
|
|
||||||
|
@return The pointer to the first instruction of a function given a function pointer.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)
|
||||||
|
|
||||||
|
#ifndef __USER_LABEL_PREFIX__
|
||||||
|
#define __USER_LABEL_PREFIX__ _
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
@ -0,0 +1,756 @@
|
||||||
|
/** @file
|
||||||
|
EFI image format for PE32, PE32+ and TE. Please note some data structures are
|
||||||
|
different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and
|
||||||
|
EFI_IMAGE_NT_HEADERS64 is for PE32+.
|
||||||
|
|
||||||
|
This file is coded to the Visual Studio, Microsoft Portable Executable and
|
||||||
|
Common Object File Format Specification, Revision 8.3 - February 6, 2013.
|
||||||
|
This file also includes some definitions in PI Specification, Revision 1.0.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
||||||
|
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PE_IMAGE_H__
|
||||||
|
#define __PE_IMAGE_H__
|
||||||
|
|
||||||
|
//
|
||||||
|
// PE32+ Subsystem type for EFI images
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION 10
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13 ///< defined PI Specification, 1.0
|
||||||
|
|
||||||
|
|
||||||
|
//
|
||||||
|
// PE32+ Machine type for EFI images
|
||||||
|
//
|
||||||
|
#define IMAGE_FILE_MACHINE_I386 0x014c
|
||||||
|
#define IMAGE_FILE_MACHINE_IA64 0x0200
|
||||||
|
#define IMAGE_FILE_MACHINE_EBC 0x0EBC
|
||||||
|
#define IMAGE_FILE_MACHINE_X64 0x8664
|
||||||
|
#define IMAGE_FILE_MACHINE_ARMTHUMB_MIXED 0x01c2
|
||||||
|
#define IMAGE_FILE_MACHINE_ARM64 0xAA64
|
||||||
|
|
||||||
|
//
|
||||||
|
// EXE file formats
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_DOS_SIGNATURE SIGNATURE_16('M', 'Z')
|
||||||
|
#define EFI_IMAGE_OS2_SIGNATURE SIGNATURE_16('N', 'E')
|
||||||
|
#define EFI_IMAGE_OS2_SIGNATURE_LE SIGNATURE_16('L', 'E')
|
||||||
|
#define EFI_IMAGE_NT_SIGNATURE SIGNATURE_32('P', 'E', '\0', '\0')
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE images can start with an optional DOS header, so if an image is run
|
||||||
|
/// under DOS it can print an error message.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 e_magic; ///< Magic number.
|
||||||
|
UINT16 e_cblp; ///< Bytes on last page of file.
|
||||||
|
UINT16 e_cp; ///< Pages in file.
|
||||||
|
UINT16 e_crlc; ///< Relocations.
|
||||||
|
UINT16 e_cparhdr; ///< Size of header in paragraphs.
|
||||||
|
UINT16 e_minalloc; ///< Minimum extra paragraphs needed.
|
||||||
|
UINT16 e_maxalloc; ///< Maximum extra paragraphs needed.
|
||||||
|
UINT16 e_ss; ///< Initial (relative) SS value.
|
||||||
|
UINT16 e_sp; ///< Initial SP value.
|
||||||
|
UINT16 e_csum; ///< Checksum.
|
||||||
|
UINT16 e_ip; ///< Initial IP value.
|
||||||
|
UINT16 e_cs; ///< Initial (relative) CS value.
|
||||||
|
UINT16 e_lfarlc; ///< File address of relocation table.
|
||||||
|
UINT16 e_ovno; ///< Overlay number.
|
||||||
|
UINT16 e_res[4]; ///< Reserved words.
|
||||||
|
UINT16 e_oemid; ///< OEM identifier (for e_oeminfo).
|
||||||
|
UINT16 e_oeminfo; ///< OEM information; e_oemid specific.
|
||||||
|
UINT16 e_res2[10]; ///< Reserved words.
|
||||||
|
UINT32 e_lfanew; ///< File address of new exe header.
|
||||||
|
} EFI_IMAGE_DOS_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// COFF File Header (Object and Image).
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 Machine;
|
||||||
|
UINT16 NumberOfSections;
|
||||||
|
UINT32 TimeDateStamp;
|
||||||
|
UINT32 PointerToSymbolTable;
|
||||||
|
UINT32 NumberOfSymbols;
|
||||||
|
UINT16 SizeOfOptionalHeader;
|
||||||
|
UINT16 Characteristics;
|
||||||
|
} EFI_IMAGE_FILE_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_FILE_HEADER.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20
|
||||||
|
|
||||||
|
//
|
||||||
|
// Characteristics
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_FILE_RELOCS_STRIPPED BIT0 ///< 0x0001 Relocation info stripped from file.
|
||||||
|
#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE BIT1 ///< 0x0002 File is executable (i.e. no unresolved externel references).
|
||||||
|
#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED BIT2 ///< 0x0004 Line nunbers stripped from file.
|
||||||
|
#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED BIT3 ///< 0x0008 Local symbols stripped from file.
|
||||||
|
#define EFI_IMAGE_FILE_BYTES_REVERSED_LO BIT7 ///< 0x0080 Bytes of machine word are reversed.
|
||||||
|
#define EFI_IMAGE_FILE_32BIT_MACHINE BIT8 ///< 0x0100 32 bit word machine.
|
||||||
|
#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file.
|
||||||
|
#define EFI_IMAGE_FILE_SYSTEM BIT12 ///< 0x1000 System File.
|
||||||
|
#define EFI_IMAGE_FILE_DLL BIT13 ///< 0x2000 File is a DLL.
|
||||||
|
#define EFI_IMAGE_FILE_BYTES_REVERSED_HI BIT15 ///< 0x8000 Bytes of machine word are reversed.
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Header Data Directories.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 VirtualAddress;
|
||||||
|
UINT32 Size;
|
||||||
|
} EFI_IMAGE_DATA_DIRECTORY;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Directory Entries
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT 0
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT 1
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE 2
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION 3
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY 4
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC 5
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG 6
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT 7
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR 8
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_TLS 9
|
||||||
|
#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG 10
|
||||||
|
|
||||||
|
#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES 16
|
||||||
|
|
||||||
|
///
|
||||||
|
/// @attention
|
||||||
|
/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and
|
||||||
|
/// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary
|
||||||
|
/// after NT additional fields.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Optional Header Standard Fields for PE32.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Standard fields.
|
||||||
|
///
|
||||||
|
UINT16 Magic;
|
||||||
|
UINT8 MajorLinkerVersion;
|
||||||
|
UINT8 MinorLinkerVersion;
|
||||||
|
UINT32 SizeOfCode;
|
||||||
|
UINT32 SizeOfInitializedData;
|
||||||
|
UINT32 SizeOfUninitializedData;
|
||||||
|
UINT32 AddressOfEntryPoint;
|
||||||
|
UINT32 BaseOfCode;
|
||||||
|
UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.
|
||||||
|
///
|
||||||
|
/// Optional Header Windows-Specific Fields.
|
||||||
|
///
|
||||||
|
UINT32 ImageBase;
|
||||||
|
UINT32 SectionAlignment;
|
||||||
|
UINT32 FileAlignment;
|
||||||
|
UINT16 MajorOperatingSystemVersion;
|
||||||
|
UINT16 MinorOperatingSystemVersion;
|
||||||
|
UINT16 MajorImageVersion;
|
||||||
|
UINT16 MinorImageVersion;
|
||||||
|
UINT16 MajorSubsystemVersion;
|
||||||
|
UINT16 MinorSubsystemVersion;
|
||||||
|
UINT32 Win32VersionValue;
|
||||||
|
UINT32 SizeOfImage;
|
||||||
|
UINT32 SizeOfHeaders;
|
||||||
|
UINT32 CheckSum;
|
||||||
|
UINT16 Subsystem;
|
||||||
|
UINT16 DllCharacteristics;
|
||||||
|
UINT32 SizeOfStackReserve;
|
||||||
|
UINT32 SizeOfStackCommit;
|
||||||
|
UINT32 SizeOfHeapReserve;
|
||||||
|
UINT32 SizeOfHeapCommit;
|
||||||
|
UINT32 LoaderFlags;
|
||||||
|
UINT32 NumberOfRvaAndSizes;
|
||||||
|
EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
|
||||||
|
} EFI_IMAGE_OPTIONAL_HEADER32;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// @attention
|
||||||
|
/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and
|
||||||
|
/// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary
|
||||||
|
/// after NT additional fields.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Optional Header Standard Fields for PE32+.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Standard fields.
|
||||||
|
///
|
||||||
|
UINT16 Magic;
|
||||||
|
UINT8 MajorLinkerVersion;
|
||||||
|
UINT8 MinorLinkerVersion;
|
||||||
|
UINT32 SizeOfCode;
|
||||||
|
UINT32 SizeOfInitializedData;
|
||||||
|
UINT32 SizeOfUninitializedData;
|
||||||
|
UINT32 AddressOfEntryPoint;
|
||||||
|
UINT32 BaseOfCode;
|
||||||
|
///
|
||||||
|
/// Optional Header Windows-Specific Fields.
|
||||||
|
///
|
||||||
|
UINT64 ImageBase;
|
||||||
|
UINT32 SectionAlignment;
|
||||||
|
UINT32 FileAlignment;
|
||||||
|
UINT16 MajorOperatingSystemVersion;
|
||||||
|
UINT16 MinorOperatingSystemVersion;
|
||||||
|
UINT16 MajorImageVersion;
|
||||||
|
UINT16 MinorImageVersion;
|
||||||
|
UINT16 MajorSubsystemVersion;
|
||||||
|
UINT16 MinorSubsystemVersion;
|
||||||
|
UINT32 Win32VersionValue;
|
||||||
|
UINT32 SizeOfImage;
|
||||||
|
UINT32 SizeOfHeaders;
|
||||||
|
UINT32 CheckSum;
|
||||||
|
UINT16 Subsystem;
|
||||||
|
UINT16 DllCharacteristics;
|
||||||
|
UINT64 SizeOfStackReserve;
|
||||||
|
UINT64 SizeOfStackCommit;
|
||||||
|
UINT64 SizeOfHeapReserve;
|
||||||
|
UINT64 SizeOfHeapCommit;
|
||||||
|
UINT32 LoaderFlags;
|
||||||
|
UINT32 NumberOfRvaAndSizes;
|
||||||
|
EFI_IMAGE_DATA_DIRECTORY DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
|
||||||
|
} EFI_IMAGE_OPTIONAL_HEADER64;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// @attention
|
||||||
|
/// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Signature;
|
||||||
|
EFI_IMAGE_FILE_HEADER FileHeader;
|
||||||
|
EFI_IMAGE_OPTIONAL_HEADER32 OptionalHeader;
|
||||||
|
} EFI_IMAGE_NT_HEADERS32;
|
||||||
|
|
||||||
|
#define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// @attention
|
||||||
|
/// EFI_IMAGE_HEADERS64 is for use ONLY by tools.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Signature;
|
||||||
|
EFI_IMAGE_FILE_HEADER FileHeader;
|
||||||
|
EFI_IMAGE_OPTIONAL_HEADER64 OptionalHeader;
|
||||||
|
} EFI_IMAGE_NT_HEADERS64;
|
||||||
|
|
||||||
|
#define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER sizeof (EFI_IMAGE_NT_HEADERS64)
|
||||||
|
|
||||||
|
//
|
||||||
|
// Other Windows Subsystem Values
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_UNKNOWN 0
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_NATIVE 1
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI 2
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI 3
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_OS2_CUI 5
|
||||||
|
#define EFI_IMAGE_SUBSYSTEM_POSIX_CUI 7
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Length of ShortName.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_SHORT_NAME 8
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Section Table. This table immediately follows the optional header.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
|
||||||
|
union {
|
||||||
|
UINT32 PhysicalAddress;
|
||||||
|
UINT32 VirtualSize;
|
||||||
|
} Misc;
|
||||||
|
UINT32 VirtualAddress;
|
||||||
|
UINT32 SizeOfRawData;
|
||||||
|
UINT32 PointerToRawData;
|
||||||
|
UINT32 PointerToRelocations;
|
||||||
|
UINT32 PointerToLinenumbers;
|
||||||
|
UINT16 NumberOfRelocations;
|
||||||
|
UINT16 NumberOfLinenumbers;
|
||||||
|
UINT32 Characteristics;
|
||||||
|
} EFI_IMAGE_SECTION_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_SECTION_HEADER.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40
|
||||||
|
|
||||||
|
//
|
||||||
|
// Section Flags Values
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SCN_TYPE_NO_PAD BIT3 ///< 0x00000008 ///< Reserved.
|
||||||
|
#define EFI_IMAGE_SCN_CNT_CODE BIT5 ///< 0x00000020
|
||||||
|
#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA BIT6 ///< 0x00000040
|
||||||
|
#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA BIT7 ///< 0x00000080
|
||||||
|
|
||||||
|
#define EFI_IMAGE_SCN_LNK_OTHER BIT8 ///< 0x00000100 ///< Reserved.
|
||||||
|
#define EFI_IMAGE_SCN_LNK_INFO BIT9 ///< 0x00000200 ///< Section contains comments or some other type of information.
|
||||||
|
#define EFI_IMAGE_SCN_LNK_REMOVE BIT11 ///< 0x00000800 ///< Section contents will not become part of image.
|
||||||
|
#define EFI_IMAGE_SCN_LNK_COMDAT BIT12 ///< 0x00001000
|
||||||
|
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_1BYTES BIT20 ///< 0x00100000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_2BYTES BIT21 ///< 0x00200000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_4BYTES (BIT20|BIT21) ///< 0x00300000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_8BYTES BIT22 ///< 0x00400000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_16BYTES (BIT20|BIT22) ///< 0x00500000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_32BYTES (BIT21|BIT22) ///< 0x00600000
|
||||||
|
#define EFI_IMAGE_SCN_ALIGN_64BYTES (BIT20|BIT21|BIT22) ///< 0x00700000
|
||||||
|
|
||||||
|
#define EFI_IMAGE_SCN_MEM_DISCARDABLE BIT25 ///< 0x02000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_NOT_CACHED BIT26 ///< 0x04000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_NOT_PAGED BIT27 ///< 0x08000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_SHARED BIT28 ///< 0x10000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_EXECUTE BIT29 ///< 0x20000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_READ BIT30 ///< 0x40000000
|
||||||
|
#define EFI_IMAGE_SCN_MEM_WRITE BIT31 ///< 0x80000000
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of a Symbol Table Record.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_SYMBOL 18
|
||||||
|
|
||||||
|
//
|
||||||
|
// Symbols have a section number of the section in which they are
|
||||||
|
// defined. Otherwise, section numbers have the following meanings:
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SYM_UNDEFINED (UINT16) 0 ///< Symbol is undefined or is common.
|
||||||
|
#define EFI_IMAGE_SYM_ABSOLUTE (UINT16) -1 ///< Symbol is an absolute value.
|
||||||
|
#define EFI_IMAGE_SYM_DEBUG (UINT16) -2 ///< Symbol is a special debug item.
|
||||||
|
|
||||||
|
//
|
||||||
|
// Symbol Type (fundamental) values.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_NULL 0 ///< no type.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_VOID 1 ///< no valid type.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_CHAR 2 ///< type character.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_SHORT 3 ///< type short integer.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_INT 4
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_LONG 5
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_FLOAT 6
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_DOUBLE 7
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_STRUCT 8
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_UNION 9
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_ENUM 10 ///< enumeration.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_MOE 11 ///< member of enumeration.
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_BYTE 12
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_WORD 13
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_UINT 14
|
||||||
|
#define EFI_IMAGE_SYM_TYPE_DWORD 15
|
||||||
|
|
||||||
|
//
|
||||||
|
// Symbol Type (derived) values.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SYM_DTYPE_NULL 0 ///< no derived type.
|
||||||
|
#define EFI_IMAGE_SYM_DTYPE_POINTER 1
|
||||||
|
#define EFI_IMAGE_SYM_DTYPE_FUNCTION 2
|
||||||
|
#define EFI_IMAGE_SYM_DTYPE_ARRAY 3
|
||||||
|
|
||||||
|
//
|
||||||
|
// Storage classes.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION ((UINT8) -1)
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_NULL 0
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_AUTOMATIC 1
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_EXTERNAL 2
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_STATIC 3
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_REGISTER 4
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF 5
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_LABEL 6
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL 7
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT 8
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_ARGUMENT 9
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_STRUCT_TAG 10
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION 11
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_UNION_TAG 12
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION 13
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC 14
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_ENUM_TAG 15
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM 16
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM 17
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_BIT_FIELD 18
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_BLOCK 100
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_FUNCTION 101
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT 102
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_FILE 103
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_SECTION 104
|
||||||
|
#define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL 105
|
||||||
|
|
||||||
|
//
|
||||||
|
// type packing constants
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_N_BTMASK 017
|
||||||
|
#define EFI_IMAGE_N_TMASK 060
|
||||||
|
#define EFI_IMAGE_N_TMASK1 0300
|
||||||
|
#define EFI_IMAGE_N_TMASK2 0360
|
||||||
|
#define EFI_IMAGE_N_BTSHFT 4
|
||||||
|
#define EFI_IMAGE_N_TSHIFT 2
|
||||||
|
|
||||||
|
//
|
||||||
|
// Communal selection types.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES 1
|
||||||
|
#define EFI_IMAGE_COMDAT_SELECT_ANY 2
|
||||||
|
#define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE 3
|
||||||
|
#define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH 4
|
||||||
|
#define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE 5
|
||||||
|
|
||||||
|
//
|
||||||
|
// the following values only be referred in PeCoff, not defined in PECOFF.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
|
||||||
|
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2
|
||||||
|
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Relocation format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 VirtualAddress;
|
||||||
|
UINT32 SymbolTableIndex;
|
||||||
|
UINT16 Type;
|
||||||
|
} EFI_IMAGE_RELOCATION;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_RELOCATION
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_RELOCATION 10
|
||||||
|
|
||||||
|
//
|
||||||
|
// I386 relocation types.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary.
|
||||||
|
#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address.
|
||||||
|
#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.
|
||||||
|
#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address.
|
||||||
|
#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.
|
||||||
|
#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.
|
||||||
|
#define EFI_IMAGE_REL_I386_SECTION 0x000A
|
||||||
|
#define EFI_IMAGE_REL_I386_SECREL 0x000B
|
||||||
|
#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.
|
||||||
|
|
||||||
|
//
|
||||||
|
// x64 processor relocation types.
|
||||||
|
//
|
||||||
|
#define IMAGE_REL_AMD64_ABSOLUTE 0x0000
|
||||||
|
#define IMAGE_REL_AMD64_ADDR64 0x0001
|
||||||
|
#define IMAGE_REL_AMD64_ADDR32 0x0002
|
||||||
|
#define IMAGE_REL_AMD64_ADDR32NB 0x0003
|
||||||
|
#define IMAGE_REL_AMD64_REL32 0x0004
|
||||||
|
#define IMAGE_REL_AMD64_REL32_1 0x0005
|
||||||
|
#define IMAGE_REL_AMD64_REL32_2 0x0006
|
||||||
|
#define IMAGE_REL_AMD64_REL32_3 0x0007
|
||||||
|
#define IMAGE_REL_AMD64_REL32_4 0x0008
|
||||||
|
#define IMAGE_REL_AMD64_REL32_5 0x0009
|
||||||
|
#define IMAGE_REL_AMD64_SECTION 0x000A
|
||||||
|
#define IMAGE_REL_AMD64_SECREL 0x000B
|
||||||
|
#define IMAGE_REL_AMD64_SECREL7 0x000C
|
||||||
|
#define IMAGE_REL_AMD64_TOKEN 0x000D
|
||||||
|
#define IMAGE_REL_AMD64_SREL32 0x000E
|
||||||
|
#define IMAGE_REL_AMD64_PAIR 0x000F
|
||||||
|
#define IMAGE_REL_AMD64_SSPAN32 0x0010
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Based relocation format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 VirtualAddress;
|
||||||
|
UINT32 SizeOfBlock;
|
||||||
|
} EFI_IMAGE_BASE_RELOCATION;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_BASE_RELOCATION.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8
|
||||||
|
|
||||||
|
//
|
||||||
|
// Based relocation types.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_REL_BASED_ABSOLUTE 0
|
||||||
|
#define EFI_IMAGE_REL_BASED_HIGH 1
|
||||||
|
#define EFI_IMAGE_REL_BASED_LOW 2
|
||||||
|
#define EFI_IMAGE_REL_BASED_HIGHLOW 3
|
||||||
|
#define EFI_IMAGE_REL_BASED_HIGHADJ 4
|
||||||
|
#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR 5
|
||||||
|
#define EFI_IMAGE_REL_BASED_ARM_MOV32A 5
|
||||||
|
#define EFI_IMAGE_REL_BASED_ARM_MOV32T 7
|
||||||
|
#define EFI_IMAGE_REL_BASED_IA64_IMM64 9
|
||||||
|
#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR16 9
|
||||||
|
#define EFI_IMAGE_REL_BASED_DIR64 10
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Line number format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
union {
|
||||||
|
UINT32 SymbolTableIndex; ///< Symbol table index of function name if Linenumber is 0.
|
||||||
|
UINT32 VirtualAddress; ///< Virtual address of line number.
|
||||||
|
} Type;
|
||||||
|
UINT16 Linenumber; ///< Line number.
|
||||||
|
} EFI_IMAGE_LINENUMBER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_LINENUMBER.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_LINENUMBER 6
|
||||||
|
|
||||||
|
//
|
||||||
|
// Archive format.
|
||||||
|
//
|
||||||
|
#define EFI_IMAGE_ARCHIVE_START_SIZE 8
|
||||||
|
#define EFI_IMAGE_ARCHIVE_START "!<arch>\n"
|
||||||
|
#define EFI_IMAGE_ARCHIVE_END "`\n"
|
||||||
|
#define EFI_IMAGE_ARCHIVE_PAD "\n"
|
||||||
|
#define EFI_IMAGE_ARCHIVE_LINKER_MEMBER "/ "
|
||||||
|
#define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER "// "
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Archive Member Headers
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Name[16]; ///< File member name - `/' terminated.
|
||||||
|
UINT8 Date[12]; ///< File member date - decimal.
|
||||||
|
UINT8 UserID[6]; ///< File member user id - decimal.
|
||||||
|
UINT8 GroupID[6]; ///< File member group id - decimal.
|
||||||
|
UINT8 Mode[8]; ///< File member mode - octal.
|
||||||
|
UINT8 Size[10]; ///< File member size - decimal.
|
||||||
|
UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).
|
||||||
|
} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60
|
||||||
|
|
||||||
|
|
||||||
|
//
|
||||||
|
// DLL Support
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Export Directory Table.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Characteristics;
|
||||||
|
UINT32 TimeDateStamp;
|
||||||
|
UINT16 MajorVersion;
|
||||||
|
UINT16 MinorVersion;
|
||||||
|
UINT32 Name;
|
||||||
|
UINT32 Base;
|
||||||
|
UINT32 NumberOfFunctions;
|
||||||
|
UINT32 NumberOfNames;
|
||||||
|
UINT32 AddressOfFunctions;
|
||||||
|
UINT32 AddressOfNames;
|
||||||
|
UINT32 AddressOfNameOrdinals;
|
||||||
|
} EFI_IMAGE_EXPORT_DIRECTORY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Hint/Name Table.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 Hint;
|
||||||
|
UINT8 Name[1];
|
||||||
|
} EFI_IMAGE_IMPORT_BY_NAME;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Import Address Table RVA (Thunk Table).
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
union {
|
||||||
|
UINT32 Function;
|
||||||
|
UINT32 Ordinal;
|
||||||
|
EFI_IMAGE_IMPORT_BY_NAME *AddressOfData;
|
||||||
|
} u1;
|
||||||
|
} EFI_IMAGE_THUNK_DATA;
|
||||||
|
|
||||||
|
#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32.
|
||||||
|
#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
|
||||||
|
#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Import Directory Table
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Characteristics;
|
||||||
|
UINT32 TimeDateStamp;
|
||||||
|
UINT32 ForwarderChain;
|
||||||
|
UINT32 Name;
|
||||||
|
EFI_IMAGE_THUNK_DATA *FirstThunk;
|
||||||
|
} EFI_IMAGE_IMPORT_DESCRIPTOR;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Debug Directory Format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Characteristics;
|
||||||
|
UINT32 TimeDateStamp;
|
||||||
|
UINT16 MajorVersion;
|
||||||
|
UINT16 MinorVersion;
|
||||||
|
UINT32 Type;
|
||||||
|
UINT32 SizeOfData;
|
||||||
|
UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base.
|
||||||
|
UINT32 FileOffset; ///< The file pointer to the debug data.
|
||||||
|
} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;
|
||||||
|
|
||||||
|
#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Debug Data Structure defined in Microsoft C++.
|
||||||
|
///
|
||||||
|
#define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Signature; ///< "NB10"
|
||||||
|
UINT32 Unknown;
|
||||||
|
UINT32 Unknown2;
|
||||||
|
UINT32 Unknown3;
|
||||||
|
//
|
||||||
|
// Filename of .PDB goes here
|
||||||
|
//
|
||||||
|
} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Debug Data Structure defined in Microsoft C++.
|
||||||
|
///
|
||||||
|
#define CODEVIEW_SIGNATURE_RSDS SIGNATURE_32('R', 'S', 'D', 'S')
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Signature; ///< "RSDS".
|
||||||
|
UINT32 Unknown;
|
||||||
|
UINT32 Unknown2;
|
||||||
|
UINT32 Unknown3;
|
||||||
|
UINT32 Unknown4;
|
||||||
|
UINT32 Unknown5;
|
||||||
|
//
|
||||||
|
// Filename of .PDB goes here
|
||||||
|
//
|
||||||
|
} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Debug Data Structure defined by Apple Mach-O to Coff utility.
|
||||||
|
///
|
||||||
|
#define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C')
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Signature; ///< "MTOC".
|
||||||
|
GUID MachOUuid;
|
||||||
|
//
|
||||||
|
// Filename of .DLL (Mach-O with debug info) goes here
|
||||||
|
//
|
||||||
|
} EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Resource format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 Characteristics;
|
||||||
|
UINT32 TimeDateStamp;
|
||||||
|
UINT16 MajorVersion;
|
||||||
|
UINT16 MinorVersion;
|
||||||
|
UINT16 NumberOfNamedEntries;
|
||||||
|
UINT16 NumberOfIdEntries;
|
||||||
|
//
|
||||||
|
// Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.
|
||||||
|
//
|
||||||
|
} EFI_IMAGE_RESOURCE_DIRECTORY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Resource directory entry format.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
union {
|
||||||
|
struct {
|
||||||
|
UINT32 NameOffset:31;
|
||||||
|
UINT32 NameIsString:1;
|
||||||
|
} s;
|
||||||
|
UINT32 Id;
|
||||||
|
} u1;
|
||||||
|
union {
|
||||||
|
UINT32 OffsetToData;
|
||||||
|
struct {
|
||||||
|
UINT32 OffsetToDirectory:31;
|
||||||
|
UINT32 DataIsDirectory:1;
|
||||||
|
} s;
|
||||||
|
} u2;
|
||||||
|
} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Resource directory entry for string.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 Length;
|
||||||
|
CHAR16 String[1];
|
||||||
|
} EFI_IMAGE_RESOURCE_DIRECTORY_STRING;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Resource directory entry for data array.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT32 OffsetToData;
|
||||||
|
UINT32 Size;
|
||||||
|
UINT32 CodePage;
|
||||||
|
UINT32 Reserved;
|
||||||
|
} EFI_IMAGE_RESOURCE_DATA_ENTRY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Header format for TE images, defined in the PI Specification, 1.0.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 Signature; ///< The signature for TE format = "VZ".
|
||||||
|
UINT16 Machine; ///< From the original file header.
|
||||||
|
UINT8 NumberOfSections; ///< From the original file header.
|
||||||
|
UINT8 Subsystem; ///< From original optional header.
|
||||||
|
UINT16 StrippedSize; ///< Number of bytes we removed from the header.
|
||||||
|
UINT32 AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.
|
||||||
|
UINT32 BaseOfCode; ///< From original image -- required for ITP debug.
|
||||||
|
UINT64 ImageBase; ///< From original file header.
|
||||||
|
EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< Only base relocation and debug directory.
|
||||||
|
} EFI_TE_IMAGE_HEADER;
|
||||||
|
|
||||||
|
|
||||||
|
#define EFI_TE_IMAGE_HEADER_SIGNATURE SIGNATURE_16('V', 'Z')
|
||||||
|
|
||||||
|
//
|
||||||
|
// Data directory indexes in our TE image header
|
||||||
|
//
|
||||||
|
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC 0
|
||||||
|
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG 1
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Union of PE32, PE32+, and TE headers.
|
||||||
|
///
|
||||||
|
typedef union {
|
||||||
|
EFI_IMAGE_NT_HEADERS32 Pe32;
|
||||||
|
EFI_IMAGE_NT_HEADERS64 Pe32Plus;
|
||||||
|
EFI_TE_IMAGE_HEADER Te;
|
||||||
|
} EFI_IMAGE_OPTIONAL_HEADER_UNION;
|
||||||
|
|
||||||
|
typedef union {
|
||||||
|
EFI_IMAGE_NT_HEADERS32 *Pe32;
|
||||||
|
EFI_IMAGE_NT_HEADERS64 *Pe32Plus;
|
||||||
|
EFI_TE_IMAGE_HEADER *Te;
|
||||||
|
EFI_IMAGE_OPTIONAL_HEADER_UNION *Union;
|
||||||
|
} EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,506 @@
|
||||||
|
/** @file
|
||||||
|
Provides services to create and parse HOBs. Only available for PEI
|
||||||
|
and DXE module types.
|
||||||
|
|
||||||
|
The HOB Library supports the efficient creation and searching of HOBs
|
||||||
|
defined in the PI Specification.
|
||||||
|
A HOB is a Hand-Off Block, defined in the Framework architecture, that
|
||||||
|
allows the PEI phase to pass information to the DXE phase. HOBs are position
|
||||||
|
independent and can be relocated easily to different memory memory locations.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __HOB_LIB_H__
|
||||||
|
#define __HOB_LIB_H__
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the pointer to the HOB list.
|
||||||
|
|
||||||
|
This function returns the pointer to first HOB in the list.
|
||||||
|
For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer
|
||||||
|
to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through
|
||||||
|
the EFI System Table by looking up theHOB list GUID in the System Configuration Table.
|
||||||
|
Since the System Configuration Table does not exist that the time the DXE Core is
|
||||||
|
launched, the DXE Core uses a global variable from the DXE Core Entry Point Library
|
||||||
|
to manage the pointer to the HOB list.
|
||||||
|
|
||||||
|
If the pointer to the HOB list is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@return The pointer to the HOB list.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
GetHobList (
|
||||||
|
VOID
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the next instance of a HOB type from the starting HOB.
|
||||||
|
|
||||||
|
This function searches the first instance of a HOB type from the starting HOB pointer.
|
||||||
|
If there does not exist such HOB type from the starting HOB pointer, it will return NULL.
|
||||||
|
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
|
||||||
|
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
|
||||||
|
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
|
||||||
|
|
||||||
|
If HobStart is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@param Type The HOB type to return.
|
||||||
|
@param HobStart The starting HOB pointer to search from.
|
||||||
|
|
||||||
|
@return The next instance of a HOB type from the starting HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
GetNextHob (
|
||||||
|
IN UINT16 Type,
|
||||||
|
IN CONST VOID *HobStart
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the first instance of a HOB type among the whole HOB list.
|
||||||
|
|
||||||
|
This function searches the first instance of a HOB type among the whole HOB list.
|
||||||
|
If there does not exist such HOB type in the HOB list, it will return NULL.
|
||||||
|
|
||||||
|
If the pointer to the HOB list is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@param Type The HOB type to return.
|
||||||
|
|
||||||
|
@return The next instance of a HOB type from the starting HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
GetFirstHob (
|
||||||
|
IN UINT16 Type
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the next instance of the matched GUID HOB from the starting HOB.
|
||||||
|
|
||||||
|
This function searches the first instance of a HOB from the starting HOB pointer.
|
||||||
|
Such HOB should satisfy two conditions:
|
||||||
|
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
|
||||||
|
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
|
||||||
|
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
|
||||||
|
to extract the data section and its size info respectively.
|
||||||
|
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
|
||||||
|
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
|
||||||
|
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
|
||||||
|
|
||||||
|
If Guid is NULL, then ASSERT().
|
||||||
|
If HobStart is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@param Guid The GUID to match with in the HOB list.
|
||||||
|
@param HobStart A pointer to a Guid.
|
||||||
|
|
||||||
|
@return The next instance of the matched GUID HOB from the starting HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
GetNextGuidHob (
|
||||||
|
IN CONST EFI_GUID *Guid,
|
||||||
|
IN CONST VOID *HobStart
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the first instance of the matched GUID HOB among the whole HOB list.
|
||||||
|
|
||||||
|
This function searches the first instance of a HOB among the whole HOB list.
|
||||||
|
Such HOB should satisfy two conditions:
|
||||||
|
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
|
||||||
|
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
|
||||||
|
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
|
||||||
|
to extract the data section and its size info respectively.
|
||||||
|
|
||||||
|
If the pointer to the HOB list is NULL, then ASSERT().
|
||||||
|
If Guid is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@param Guid The GUID to match with in the HOB list.
|
||||||
|
|
||||||
|
@return The first instance of the matched GUID HOB among the whole HOB list.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
GetFirstGuidHob (
|
||||||
|
IN CONST EFI_GUID *Guid
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Get the system boot mode from the HOB list.
|
||||||
|
|
||||||
|
This function returns the system boot mode information from the
|
||||||
|
PHIT HOB in HOB list.
|
||||||
|
|
||||||
|
If the pointer to the HOB list is NULL, then ASSERT().
|
||||||
|
|
||||||
|
@param VOID
|
||||||
|
|
||||||
|
@return The Boot Mode.
|
||||||
|
|
||||||
|
**/
|
||||||
|
EFI_BOOT_MODE
|
||||||
|
EFIAPI
|
||||||
|
GetBootModeHob (
|
||||||
|
VOID
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB for a loaded PE32 module.
|
||||||
|
|
||||||
|
This function builds a HOB for a loaded PE32 module.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If ModuleName is NULL, then ASSERT().
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param ModuleName The GUID File Name of the module.
|
||||||
|
@param MemoryAllocationModule The 64 bit physical address of the module.
|
||||||
|
@param ModuleLength The length of the module in bytes.
|
||||||
|
@param EntryPoint The 64 bit physical address of the module entry point.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildModuleHob (
|
||||||
|
IN CONST EFI_GUID *ModuleName,
|
||||||
|
IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule,
|
||||||
|
IN UINT64 ModuleLength,
|
||||||
|
IN EFI_PHYSICAL_ADDRESS EntryPoint
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB that describes a chunk of system memory.
|
||||||
|
|
||||||
|
This function builds a HOB that describes a chunk of system memory.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param ResourceType The type of resource described by this HOB.
|
||||||
|
@param ResourceAttribute The resource attributes of the memory described by this HOB.
|
||||||
|
@param PhysicalStart The 64 bit physical address of memory described by this HOB.
|
||||||
|
@param NumberOfBytes The length of the memory described by this HOB in bytes.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildResourceDescriptorHob (
|
||||||
|
IN EFI_RESOURCE_TYPE ResourceType,
|
||||||
|
IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,
|
||||||
|
IN EFI_PHYSICAL_ADDRESS PhysicalStart,
|
||||||
|
IN UINT64 NumberOfBytes
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a customized HOB tagged with a GUID for identification and returns
|
||||||
|
the start address of GUID HOB data.
|
||||||
|
|
||||||
|
This function builds a customized HOB tagged with a GUID for identification
|
||||||
|
and returns the start address of GUID HOB data so that caller can fill the customized data.
|
||||||
|
The HOB Header and Name field is already stripped.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If Guid is NULL, then ASSERT().
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
|
||||||
|
HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.
|
||||||
|
|
||||||
|
@param Guid The GUID to tag the customized HOB.
|
||||||
|
@param DataLength The size of the data payload for the GUID HOB.
|
||||||
|
|
||||||
|
@retval NULL The GUID HOB could not be allocated.
|
||||||
|
@retval others The start address of GUID HOB data.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
BuildGuidHob (
|
||||||
|
IN CONST EFI_GUID *Guid,
|
||||||
|
IN UINTN DataLength
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB
|
||||||
|
data field, and returns the start address of the GUID HOB data.
|
||||||
|
|
||||||
|
This function builds a customized HOB tagged with a GUID for identification and copies the input
|
||||||
|
data to the HOB data field and returns the start address of the GUID HOB data. It can only be
|
||||||
|
invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
The HOB Header and Name field is already stripped.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If Guid is NULL, then ASSERT().
|
||||||
|
If Data is NULL and DataLength > 0, then ASSERT().
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
|
||||||
|
HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.
|
||||||
|
|
||||||
|
@param Guid The GUID to tag the customized HOB.
|
||||||
|
@param Data The data to be copied into the data field of the GUID HOB.
|
||||||
|
@param DataLength The size of the data payload for the GUID HOB.
|
||||||
|
|
||||||
|
@retval NULL The GUID HOB could not be allocated.
|
||||||
|
@retval others The start address of GUID HOB data.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID *
|
||||||
|
EFIAPI
|
||||||
|
BuildGuidDataHob (
|
||||||
|
IN CONST EFI_GUID *Guid,
|
||||||
|
IN VOID *Data,
|
||||||
|
IN UINTN DataLength
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a Firmware Volume HOB.
|
||||||
|
|
||||||
|
This function builds a Firmware Volume HOB.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The base address of the Firmware Volume.
|
||||||
|
@param Length The size of the Firmware Volume in bytes.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildFvHob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a EFI_HOB_TYPE_FV2 HOB.
|
||||||
|
|
||||||
|
This function builds a EFI_HOB_TYPE_FV2 HOB.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The base address of the Firmware Volume.
|
||||||
|
@param Length The size of the Firmware Volume in bytes.
|
||||||
|
@param FvName The name of the Firmware Volume.
|
||||||
|
@param FileName The name of the file.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildFv2Hob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length,
|
||||||
|
IN CONST EFI_GUID *FvName,
|
||||||
|
IN CONST EFI_GUID *FileName
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a Capsule Volume HOB.
|
||||||
|
|
||||||
|
This function builds a Capsule Volume HOB.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If the platform does not support Capsule Volume HOBs, then ASSERT().
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The base address of the Capsule Volume.
|
||||||
|
@param Length The size of the Capsule Volume in bytes.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildCvHob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB for the CPU.
|
||||||
|
|
||||||
|
This function builds a HOB for the CPU.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param SizeOfMemorySpace The maximum physical memory addressability of the processor.
|
||||||
|
@param SizeOfIoSpace The maximum physical I/O addressability of the processor.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildCpuHob (
|
||||||
|
IN UINT8 SizeOfMemorySpace,
|
||||||
|
IN UINT8 SizeOfIoSpace
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB for the Stack.
|
||||||
|
|
||||||
|
This function builds a HOB for the stack.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The 64 bit physical address of the Stack.
|
||||||
|
@param Length The length of the stack in bytes.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildStackHob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB for the BSP store.
|
||||||
|
|
||||||
|
This function builds a HOB for BSP store.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The 64 bit physical address of the BSP.
|
||||||
|
@param Length The length of the BSP store in bytes.
|
||||||
|
@param MemoryType Type of memory allocated by this HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildBspStoreHob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length,
|
||||||
|
IN EFI_MEMORY_TYPE MemoryType
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Builds a HOB for the memory allocation.
|
||||||
|
|
||||||
|
This function builds a HOB for the memory allocation.
|
||||||
|
It can only be invoked during PEI phase;
|
||||||
|
for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
|
||||||
|
|
||||||
|
If there is no additional space for HOB creation, then ASSERT().
|
||||||
|
|
||||||
|
@param BaseAddress The 64 bit physical address of the memory.
|
||||||
|
@param Length The length of the memory allocation in bytes.
|
||||||
|
@param MemoryType Type of memory allocated by this HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
VOID
|
||||||
|
EFIAPI
|
||||||
|
BuildMemoryAllocationHob (
|
||||||
|
IN EFI_PHYSICAL_ADDRESS BaseAddress,
|
||||||
|
IN UINT64 Length,
|
||||||
|
IN EFI_MEMORY_TYPE MemoryType
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the type of a HOB.
|
||||||
|
|
||||||
|
This macro returns the HobType field from the HOB header for the
|
||||||
|
HOB specified by HobStart.
|
||||||
|
|
||||||
|
@param HobStart A pointer to a HOB.
|
||||||
|
|
||||||
|
@return HobType.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define GET_HOB_TYPE(HobStart) \
|
||||||
|
((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobType)
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the length, in bytes, of a HOB.
|
||||||
|
|
||||||
|
This macro returns the HobLength field from the HOB header for the
|
||||||
|
HOB specified by HobStart.
|
||||||
|
|
||||||
|
@param HobStart A pointer to a HOB.
|
||||||
|
|
||||||
|
@return HobLength.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define GET_HOB_LENGTH(HobStart) \
|
||||||
|
((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobLength)
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns a pointer to the next HOB in the HOB list.
|
||||||
|
|
||||||
|
This macro returns a pointer to HOB that follows the
|
||||||
|
HOB specified by HobStart in the HOB List.
|
||||||
|
|
||||||
|
@param HobStart A pointer to a HOB.
|
||||||
|
|
||||||
|
@return A pointer to the next HOB in the HOB list.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define GET_NEXT_HOB(HobStart) \
|
||||||
|
(VOID *)(*(UINT8 **)&(HobStart) + GET_HOB_LENGTH (HobStart))
|
||||||
|
|
||||||
|
/**
|
||||||
|
Determines if a HOB is the last HOB in the HOB list.
|
||||||
|
|
||||||
|
This macro determine if the HOB specified by HobStart is the
|
||||||
|
last HOB in the HOB list. If HobStart is last HOB in the HOB list,
|
||||||
|
then TRUE is returned. Otherwise, FALSE is returned.
|
||||||
|
|
||||||
|
@param HobStart A pointer to a HOB.
|
||||||
|
|
||||||
|
@retval TRUE The HOB specified by HobStart is the last HOB in the HOB list.
|
||||||
|
@retval FALSE The HOB specified by HobStart is not the last HOB in the HOB list.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define END_OF_HOB_LIST(HobStart) (GET_HOB_TYPE (HobStart) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||||
|
|
||||||
|
This macro returns a pointer to the data buffer in a HOB specified by HobStart.
|
||||||
|
HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||||
|
|
||||||
|
@param GuidHob A pointer to a HOB.
|
||||||
|
|
||||||
|
@return A pointer to the data buffer in a HOB.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define GET_GUID_HOB_DATA(HobStart) \
|
||||||
|
(VOID *)(*(UINT8 **)&(HobStart) + sizeof (EFI_HOB_GUID_TYPE))
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns the size of the data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||||
|
|
||||||
|
This macro returns the size, in bytes, of the data buffer in a HOB specified by HobStart.
|
||||||
|
HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.
|
||||||
|
|
||||||
|
@param GuidHob A pointer to a HOB.
|
||||||
|
|
||||||
|
@return The size of the data buffer.
|
||||||
|
**/
|
||||||
|
#define GET_GUID_HOB_DATA_SIZE(HobStart) \
|
||||||
|
(UINT16)(GET_HOB_LENGTH (HobStart) - sizeof (EFI_HOB_GUID_TYPE))
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,42 @@
|
||||||
|
/** @file
|
||||||
|
Present the boot mode values in PI.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
PI Version 1.2.1A
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PI_BOOT_MODE_H__
|
||||||
|
#define __PI_BOOT_MODE_H__
|
||||||
|
|
||||||
|
///
|
||||||
|
/// EFI boot mode
|
||||||
|
///
|
||||||
|
typedef UINT32 EFI_BOOT_MODE;
|
||||||
|
|
||||||
|
//
|
||||||
|
// 0x21 - 0xf..f are reserved.
|
||||||
|
//
|
||||||
|
#define BOOT_WITH_FULL_CONFIGURATION 0x00
|
||||||
|
#define BOOT_WITH_MINIMAL_CONFIGURATION 0x01
|
||||||
|
#define BOOT_ASSUMING_NO_CONFIGURATION_CHANGES 0x02
|
||||||
|
#define BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS 0x03
|
||||||
|
#define BOOT_WITH_DEFAULT_SETTINGS 0x04
|
||||||
|
#define BOOT_ON_S4_RESUME 0x05
|
||||||
|
#define BOOT_ON_S5_RESUME 0x06
|
||||||
|
#define BOOT_WITH_MFG_MODE_SETTINGS 0x07
|
||||||
|
#define BOOT_ON_S2_RESUME 0x10
|
||||||
|
#define BOOT_ON_S3_RESUME 0x11
|
||||||
|
#define BOOT_ON_FLASH_UPDATE 0x12
|
||||||
|
#define BOOT_IN_RECOVERY_MODE 0x20
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,494 @@
|
||||||
|
/** @file
|
||||||
|
The firmware file related definitions in PI.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials are licensed and made available under
|
||||||
|
the terms and conditions of the BSD License that accompanies this distribution.
|
||||||
|
The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
PI Version 1.2.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef __PI_FIRMWARE_FILE_H__
|
||||||
|
#define __PI_FIRMWARE_FILE_H__
|
||||||
|
|
||||||
|
#pragma pack(1)
|
||||||
|
///
|
||||||
|
/// Used to verify the integrity of the file.
|
||||||
|
///
|
||||||
|
typedef union {
|
||||||
|
struct {
|
||||||
|
///
|
||||||
|
/// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file
|
||||||
|
/// header. The State and IntegrityCheck.Checksum.File fields are assumed
|
||||||
|
/// to be zero and the checksum is calculated such that the entire header sums to zero.
|
||||||
|
///
|
||||||
|
UINT8 Header;
|
||||||
|
///
|
||||||
|
/// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes
|
||||||
|
/// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit
|
||||||
|
/// checksum of the file data.
|
||||||
|
/// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero,
|
||||||
|
/// the IntegrityCheck.Checksum.File field must be initialized with a value of
|
||||||
|
/// 0xAA. The IntegrityCheck.Checksum.File field is valid any time the
|
||||||
|
/// EFI_FILE_DATA_VALID bit is set in the State field.
|
||||||
|
///
|
||||||
|
UINT8 File;
|
||||||
|
} Checksum;
|
||||||
|
///
|
||||||
|
/// This is the full 16 bits of the IntegrityCheck field.
|
||||||
|
///
|
||||||
|
UINT16 Checksum16;
|
||||||
|
} EFI_FFS_INTEGRITY_CHECK;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// FFS_FIXED_CHECKSUM is the checksum value used when the
|
||||||
|
/// FFS_ATTRIB_CHECKSUM attribute bit is clear.
|
||||||
|
///
|
||||||
|
#define FFS_FIXED_CHECKSUM 0xAA
|
||||||
|
|
||||||
|
typedef UINT8 EFI_FV_FILETYPE;
|
||||||
|
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;
|
||||||
|
typedef UINT8 EFI_FFS_FILE_STATE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// File Types Definitions
|
||||||
|
///
|
||||||
|
#define EFI_FV_FILETYPE_ALL 0x00
|
||||||
|
#define EFI_FV_FILETYPE_RAW 0x01
|
||||||
|
#define EFI_FV_FILETYPE_FREEFORM 0x02
|
||||||
|
#define EFI_FV_FILETYPE_SECURITY_CORE 0x03
|
||||||
|
#define EFI_FV_FILETYPE_PEI_CORE 0x04
|
||||||
|
#define EFI_FV_FILETYPE_DXE_CORE 0x05
|
||||||
|
#define EFI_FV_FILETYPE_PEIM 0x06
|
||||||
|
#define EFI_FV_FILETYPE_DRIVER 0x07
|
||||||
|
#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08
|
||||||
|
#define EFI_FV_FILETYPE_APPLICATION 0x09
|
||||||
|
#define EFI_FV_FILETYPE_SMM 0x0A
|
||||||
|
#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
|
||||||
|
#define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C
|
||||||
|
#define EFI_FV_FILETYPE_SMM_CORE 0x0D
|
||||||
|
#define EFI_FV_FILETYPE_OEM_MIN 0xc0
|
||||||
|
#define EFI_FV_FILETYPE_OEM_MAX 0xdf
|
||||||
|
#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0
|
||||||
|
#define EFI_FV_FILETYPE_DEBUG_MAX 0xef
|
||||||
|
#define EFI_FV_FILETYPE_FFS_MIN 0xf0
|
||||||
|
#define EFI_FV_FILETYPE_FFS_MAX 0xff
|
||||||
|
#define EFI_FV_FILETYPE_FFS_PAD 0xf0
|
||||||
|
///
|
||||||
|
/// FFS File Attributes.
|
||||||
|
///
|
||||||
|
#define FFS_ATTRIB_LARGE_FILE 0x01
|
||||||
|
#define FFS_ATTRIB_FIXED 0x04
|
||||||
|
#define FFS_ATTRIB_DATA_ALIGNMENT 0x38
|
||||||
|
#define FFS_ATTRIB_CHECKSUM 0x40
|
||||||
|
|
||||||
|
///
|
||||||
|
/// FFS File State Bits.
|
||||||
|
///
|
||||||
|
#define EFI_FILE_HEADER_CONSTRUCTION 0x01
|
||||||
|
#define EFI_FILE_HEADER_VALID 0x02
|
||||||
|
#define EFI_FILE_DATA_VALID 0x04
|
||||||
|
#define EFI_FILE_MARKED_FOR_UPDATE 0x08
|
||||||
|
#define EFI_FILE_DELETED 0x10
|
||||||
|
#define EFI_FILE_HEADER_INVALID 0x20
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Each file begins with the header that describe the
|
||||||
|
/// contents and state of the files.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// This GUID is the file name. It is used to uniquely identify the file.
|
||||||
|
///
|
||||||
|
EFI_GUID Name;
|
||||||
|
///
|
||||||
|
/// Used to verify the integrity of the file.
|
||||||
|
///
|
||||||
|
EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
|
||||||
|
///
|
||||||
|
/// Identifies the type of file.
|
||||||
|
///
|
||||||
|
EFI_FV_FILETYPE Type;
|
||||||
|
///
|
||||||
|
/// Declares various file attribute bits.
|
||||||
|
///
|
||||||
|
EFI_FFS_FILE_ATTRIBUTES Attributes;
|
||||||
|
///
|
||||||
|
/// The length of the file in bytes, including the FFS header.
|
||||||
|
///
|
||||||
|
UINT8 Size[3];
|
||||||
|
///
|
||||||
|
/// Used to track the state of the file throughout the life of the file from creation to deletion.
|
||||||
|
///
|
||||||
|
EFI_FFS_FILE_STATE State;
|
||||||
|
} EFI_FFS_FILE_HEADER;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// This GUID is the file name. It is used to uniquely identify the file. There may be only
|
||||||
|
/// one instance of a file with the file name GUID of Name in any given firmware
|
||||||
|
/// volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD.
|
||||||
|
///
|
||||||
|
EFI_GUID Name;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Used to verify the integrity of the file.
|
||||||
|
///
|
||||||
|
EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Identifies the type of file.
|
||||||
|
///
|
||||||
|
EFI_FV_FILETYPE Type;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Declares various file attribute bits.
|
||||||
|
///
|
||||||
|
EFI_FFS_FILE_ATTRIBUTES Attributes;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The length of the file in bytes, including the FFS header.
|
||||||
|
/// The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a
|
||||||
|
/// zero-length file has a Size of 24 bytes, which is sizeof(EFI_FFS_FILE_HEADER).
|
||||||
|
/// Size is not required to be a multiple of 8 bytes. Given a file F, the next file header is
|
||||||
|
/// located at the next 8-byte aligned firmware volume offset following the last byte of the file F.
|
||||||
|
///
|
||||||
|
UINT8 Size[3];
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Used to track the state of the file throughout the life of the file from creation to deletion.
|
||||||
|
///
|
||||||
|
EFI_FFS_FILE_STATE State;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.
|
||||||
|
/// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.
|
||||||
|
///
|
||||||
|
UINT32 ExtendedSize;
|
||||||
|
} EFI_FFS_FILE_HEADER2;
|
||||||
|
|
||||||
|
#define IS_FFS_FILE2(FfsFileHeaderPtr) \
|
||||||
|
(((((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Attributes) & FFS_ATTRIB_LARGE_FILE) == FFS_ATTRIB_LARGE_FILE)
|
||||||
|
|
||||||
|
#define FFS_FILE_SIZE(FfsFileHeaderPtr) \
|
||||||
|
((UINT32) (*((UINT32 *) ((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Size) & 0x00ffffff))
|
||||||
|
|
||||||
|
#define FFS_FILE2_SIZE(FfsFileHeaderPtr) \
|
||||||
|
(((EFI_FFS_FILE_HEADER2 *) (UINTN) FfsFileHeaderPtr)->ExtendedSize)
|
||||||
|
|
||||||
|
typedef UINT8 EFI_SECTION_TYPE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Pseudo type. It is used as a wild card when retrieving sections.
|
||||||
|
/// The section type EFI_SECTION_ALL matches all section types.
|
||||||
|
///
|
||||||
|
#define EFI_SECTION_ALL 0x00
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Encapsulation section Type values.
|
||||||
|
///
|
||||||
|
#define EFI_SECTION_COMPRESSION 0x01
|
||||||
|
|
||||||
|
#define EFI_SECTION_GUID_DEFINED 0x02
|
||||||
|
|
||||||
|
#define EFI_SECTION_DISPOSABLE 0x03
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Leaf section Type values.
|
||||||
|
///
|
||||||
|
#define EFI_SECTION_PE32 0x10
|
||||||
|
#define EFI_SECTION_PIC 0x11
|
||||||
|
#define EFI_SECTION_TE 0x12
|
||||||
|
#define EFI_SECTION_DXE_DEPEX 0x13
|
||||||
|
#define EFI_SECTION_VERSION 0x14
|
||||||
|
#define EFI_SECTION_USER_INTERFACE 0x15
|
||||||
|
#define EFI_SECTION_COMPATIBILITY16 0x16
|
||||||
|
#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
|
||||||
|
#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
|
||||||
|
#define EFI_SECTION_RAW 0x19
|
||||||
|
#define EFI_SECTION_PEI_DEPEX 0x1B
|
||||||
|
#define EFI_SECTION_SMM_DEPEX 0x1C
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Common section header.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// A 24-bit unsigned integer that contains the total size of the section in bytes,
|
||||||
|
/// including the EFI_COMMON_SECTION_HEADER.
|
||||||
|
///
|
||||||
|
UINT8 Size[3];
|
||||||
|
EFI_SECTION_TYPE Type;
|
||||||
|
///
|
||||||
|
/// Declares the section type.
|
||||||
|
///
|
||||||
|
} EFI_COMMON_SECTION_HEADER;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// A 24-bit unsigned integer that contains the total size of the section in bytes,
|
||||||
|
/// including the EFI_COMMON_SECTION_HEADER.
|
||||||
|
///
|
||||||
|
UINT8 Size[3];
|
||||||
|
|
||||||
|
EFI_SECTION_TYPE Type;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If
|
||||||
|
/// Size is not equal to 0xFFFFFF, then this field does not exist.
|
||||||
|
///
|
||||||
|
UINT32 ExtendedSize;
|
||||||
|
} EFI_COMMON_SECTION_HEADER2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Leaf section type that contains an
|
||||||
|
/// IA-32 16-bit executable image.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// CompressionType of EFI_COMPRESSION_SECTION.
|
||||||
|
///
|
||||||
|
#define EFI_NOT_COMPRESSED 0x00
|
||||||
|
#define EFI_STANDARD_COMPRESSION 0x01
|
||||||
|
///
|
||||||
|
/// An encapsulation section type in which the
|
||||||
|
/// section data is compressed.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER CommonHeader;
|
||||||
|
///
|
||||||
|
/// The UINT32 that indicates the size of the section data after decompression.
|
||||||
|
///
|
||||||
|
UINT32 UncompressedLength;
|
||||||
|
///
|
||||||
|
/// Indicates which compression algorithm is used.
|
||||||
|
///
|
||||||
|
UINT8 CompressionType;
|
||||||
|
} EFI_COMPRESSION_SECTION;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER2 CommonHeader;
|
||||||
|
///
|
||||||
|
/// UINT32 that indicates the size of the section data after decompression.
|
||||||
|
///
|
||||||
|
UINT32 UncompressedLength;
|
||||||
|
///
|
||||||
|
/// Indicates which compression algorithm is used.
|
||||||
|
///
|
||||||
|
UINT8 CompressionType;
|
||||||
|
} EFI_COMPRESSION_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// An encapsulation section type in which the section data is disposable.
|
||||||
|
/// A disposable section is an encapsulation section in which the section data may be disposed of during
|
||||||
|
/// the process of creating or updating a firmware image without significant impact on the usefulness of
|
||||||
|
/// the file. The Type field in the section header is set to EFI_SECTION_DISPOSABLE. This
|
||||||
|
/// allows optional or descriptive data to be included with the firmware file which can be removed in
|
||||||
|
/// order to conserve space. The contents of this section are implementation specific, but might contain
|
||||||
|
/// debug data or detailed integration instructions.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which could be used to determine the dispatch order of DXEs.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains a PI FV.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains a single GUID.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER CommonHeader;
|
||||||
|
///
|
||||||
|
/// This GUID is defined by the creator of the file. It is a vendor-defined file type.
|
||||||
|
///
|
||||||
|
EFI_GUID SubTypeGuid;
|
||||||
|
} EFI_FREEFORM_SUBTYPE_GUID_SECTION;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER2 CommonHeader;
|
||||||
|
///
|
||||||
|
/// This GUID is defined by the creator of the file. It is a vendor-defined file type.
|
||||||
|
///
|
||||||
|
EFI_GUID SubTypeGuid;
|
||||||
|
} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Attributes of EFI_GUID_DEFINED_SECTION.
|
||||||
|
///
|
||||||
|
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
|
||||||
|
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
|
||||||
|
///
|
||||||
|
/// The leaf section which is encapsulation defined by specific GUID.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER CommonHeader;
|
||||||
|
///
|
||||||
|
/// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
|
||||||
|
///
|
||||||
|
EFI_GUID SectionDefinitionGuid;
|
||||||
|
///
|
||||||
|
/// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
|
||||||
|
///
|
||||||
|
UINT16 DataOffset;
|
||||||
|
///
|
||||||
|
/// The bit field that declares some specific characteristics of the section contents.
|
||||||
|
///
|
||||||
|
UINT16 Attributes;
|
||||||
|
} EFI_GUID_DEFINED_SECTION;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
|
||||||
|
///
|
||||||
|
EFI_COMMON_SECTION_HEADER2 CommonHeader;
|
||||||
|
///
|
||||||
|
/// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
|
||||||
|
///
|
||||||
|
EFI_GUID SectionDefinitionGuid;
|
||||||
|
///
|
||||||
|
/// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
|
||||||
|
///
|
||||||
|
UINT16 DataOffset;
|
||||||
|
///
|
||||||
|
/// The bit field that declares some specific characteristics of the section contents.
|
||||||
|
///
|
||||||
|
UINT16 Attributes;
|
||||||
|
} EFI_GUID_DEFINED_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains PE32+ image.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section used to determine the dispatch order of PEIMs.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// A leaf section type that contains a position-independent-code (PIC) image.
|
||||||
|
/// A PIC image section is a leaf section that contains a position-independent-code (PIC) image.
|
||||||
|
/// In addition to normal PE32+ images that contain relocation information, PEIM executables may be
|
||||||
|
/// PIC and are referred to as PIC images. A PIC image is the same as a PE32+ image except that all
|
||||||
|
/// relocation information has been stripped from the image and the image can be moved and will
|
||||||
|
/// execute correctly without performing any relocation or other fix-ups. EFI_PIC_SECTION2 must
|
||||||
|
/// be used if the section is 16MB or larger.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which constains the position-independent-code image.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains an array of zero or more bytes.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The SMM dependency expression section is a leaf section that contains a dependency expression that
|
||||||
|
/// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the
|
||||||
|
/// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform
|
||||||
|
/// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.
|
||||||
|
/// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol
|
||||||
|
/// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.
|
||||||
|
///
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION;
|
||||||
|
typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains a unicode string that
|
||||||
|
/// is human readable file name.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
EFI_COMMON_SECTION_HEADER CommonHeader;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Array of unicode string.
|
||||||
|
///
|
||||||
|
CHAR16 FileNameString[1];
|
||||||
|
} EFI_USER_INTERFACE_SECTION;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
EFI_COMMON_SECTION_HEADER2 CommonHeader;
|
||||||
|
CHAR16 FileNameString[1];
|
||||||
|
} EFI_USER_INTERFACE_SECTION2;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The leaf section which contains a numeric build number and
|
||||||
|
/// an optional unicode string that represents the file revision.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
EFI_COMMON_SECTION_HEADER CommonHeader;
|
||||||
|
UINT16 BuildNumber;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Array of unicode string.
|
||||||
|
///
|
||||||
|
CHAR16 VersionString[1];
|
||||||
|
} EFI_VERSION_SECTION;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
EFI_COMMON_SECTION_HEADER2 CommonHeader;
|
||||||
|
///
|
||||||
|
/// A UINT16 that represents a particular build. Subsequent builds have monotonically
|
||||||
|
/// increasing build numbers relative to earlier builds.
|
||||||
|
///
|
||||||
|
UINT16 BuildNumber;
|
||||||
|
CHAR16 VersionString[1];
|
||||||
|
} EFI_VERSION_SECTION2;
|
||||||
|
|
||||||
|
#define IS_SECTION2(SectionHeaderPtr) \
|
||||||
|
((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) (UINTN) SectionHeaderPtr)->Size) & 0x00ffffff) == 0x00ffffff)
|
||||||
|
|
||||||
|
#define SECTION_SIZE(SectionHeaderPtr) \
|
||||||
|
((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) (UINTN) SectionHeaderPtr)->Size) & 0x00ffffff))
|
||||||
|
|
||||||
|
#define SECTION2_SIZE(SectionHeaderPtr) \
|
||||||
|
(((EFI_COMMON_SECTION_HEADER2 *) (UINTN) SectionHeaderPtr)->ExtendedSize)
|
||||||
|
|
||||||
|
#pragma pack()
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
@ -0,0 +1,234 @@
|
||||||
|
/** @file
|
||||||
|
The firmware volume related definitions in PI.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
PI Version 1.3
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PI_FIRMWAREVOLUME_H__
|
||||||
|
#define __PI_FIRMWAREVOLUME_H__
|
||||||
|
|
||||||
|
///
|
||||||
|
/// EFI_FV_FILE_ATTRIBUTES
|
||||||
|
///
|
||||||
|
typedef UINT32 EFI_FV_FILE_ATTRIBUTES;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Value of EFI_FV_FILE_ATTRIBUTES.
|
||||||
|
//
|
||||||
|
#define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F
|
||||||
|
#define EFI_FV_FILE_ATTRIB_FIXED 0x00000100
|
||||||
|
#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200
|
||||||
|
|
||||||
|
///
|
||||||
|
/// type of EFI FVB attribute
|
||||||
|
///
|
||||||
|
typedef UINT32 EFI_FVB_ATTRIBUTES_2;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Attributes bit definitions
|
||||||
|
//
|
||||||
|
#define EFI_FVB2_READ_DISABLED_CAP 0x00000001
|
||||||
|
#define EFI_FVB2_READ_ENABLED_CAP 0x00000002
|
||||||
|
#define EFI_FVB2_READ_STATUS 0x00000004
|
||||||
|
#define EFI_FVB2_WRITE_DISABLED_CAP 0x00000008
|
||||||
|
#define EFI_FVB2_WRITE_ENABLED_CAP 0x00000010
|
||||||
|
#define EFI_FVB2_WRITE_STATUS 0x00000020
|
||||||
|
#define EFI_FVB2_LOCK_CAP 0x00000040
|
||||||
|
#define EFI_FVB2_LOCK_STATUS 0x00000080
|
||||||
|
#define EFI_FVB2_STICKY_WRITE 0x00000200
|
||||||
|
#define EFI_FVB2_MEMORY_MAPPED 0x00000400
|
||||||
|
#define EFI_FVB2_ERASE_POLARITY 0x00000800
|
||||||
|
#define EFI_FVB2_READ_LOCK_CAP 0x00001000
|
||||||
|
#define EFI_FVB2_READ_LOCK_STATUS 0x00002000
|
||||||
|
#define EFI_FVB2_WRITE_LOCK_CAP 0x00004000
|
||||||
|
#define EFI_FVB2_WRITE_LOCK_STATUS 0x00008000
|
||||||
|
#define EFI_FVB2_ALIGNMENT 0x001F0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_1 0x00000000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_2 0x00010000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_4 0x00020000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_8 0x00030000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_16 0x00040000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_32 0x00050000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_64 0x00060000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_128 0x00070000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_256 0x00080000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_512 0x00090000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_1K 0x000A0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_2K 0x000B0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_4K 0x000C0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_8K 0x000D0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_16K 0x000E0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_32K 0x000F0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_64K 0x00100000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_128K 0x00110000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_256K 0x00120000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_512K 0x00130000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_1M 0x00140000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_2M 0x00150000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_4M 0x00160000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_8M 0x00170000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_16M 0x00180000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_32M 0x00190000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_64M 0x001A0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_128M 0x001B0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_256M 0x001C0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_512M 0x001D0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_1G 0x001E0000
|
||||||
|
#define EFI_FVB2_ALIGNMENT_2G 0x001F0000
|
||||||
|
#define EFI_FVB2_WEAK_ALIGNMENT 0x80000000
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The number of sequential blocks which are of the same size.
|
||||||
|
///
|
||||||
|
UINT32 NumBlocks;
|
||||||
|
///
|
||||||
|
/// The size of the blocks.
|
||||||
|
///
|
||||||
|
UINT32 Length;
|
||||||
|
} EFI_FV_BLOCK_MAP_ENTRY;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes the features and layout of the firmware volume.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The first 16 bytes are reserved to allow for the reset vector of
|
||||||
|
/// processors whose reset vector is at address 0.
|
||||||
|
///
|
||||||
|
UINT8 ZeroVector[16];
|
||||||
|
///
|
||||||
|
/// Declares the file system with which the firmware volume is formatted.
|
||||||
|
///
|
||||||
|
EFI_GUID FileSystemGuid;
|
||||||
|
///
|
||||||
|
/// Length in bytes of the complete firmware volume, including the header.
|
||||||
|
///
|
||||||
|
UINT64 FvLength;
|
||||||
|
///
|
||||||
|
/// Set to EFI_FVH_SIGNATURE
|
||||||
|
///
|
||||||
|
UINT32 Signature;
|
||||||
|
///
|
||||||
|
/// Declares capabilities and power-on defaults for the firmware volume.
|
||||||
|
///
|
||||||
|
EFI_FVB_ATTRIBUTES_2 Attributes;
|
||||||
|
///
|
||||||
|
/// Length in bytes of the complete firmware volume header.
|
||||||
|
///
|
||||||
|
UINT16 HeaderLength;
|
||||||
|
///
|
||||||
|
/// A 16-bit checksum of the firmware volume header. A valid header sums to zero.
|
||||||
|
///
|
||||||
|
UINT16 Checksum;
|
||||||
|
///
|
||||||
|
/// Offset, relative to the start of the header, of the extended header
|
||||||
|
/// (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is no extended header.
|
||||||
|
///
|
||||||
|
UINT16 ExtHeaderOffset;
|
||||||
|
///
|
||||||
|
/// This field must always be set to zero.
|
||||||
|
///
|
||||||
|
UINT8 Reserved[1];
|
||||||
|
///
|
||||||
|
/// Set to 2. Future versions of this specification may define new header fields and will
|
||||||
|
/// increment the Revision field accordingly.
|
||||||
|
///
|
||||||
|
UINT8 Revision;
|
||||||
|
///
|
||||||
|
/// An array of run-length encoded FvBlockMapEntry structures. The array is
|
||||||
|
/// terminated with an entry of {0,0}.
|
||||||
|
///
|
||||||
|
EFI_FV_BLOCK_MAP_ENTRY BlockMap[1];
|
||||||
|
} EFI_FIRMWARE_VOLUME_HEADER;
|
||||||
|
|
||||||
|
#define EFI_FVH_SIGNATURE SIGNATURE_32 ('_', 'F', 'V', 'H')
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Firmware Volume Header Revision definition
|
||||||
|
///
|
||||||
|
#define EFI_FVH_REVISION 0x02
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Extension header pointed by ExtHeaderOffset of volume header.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Firmware volume name.
|
||||||
|
///
|
||||||
|
EFI_GUID FvName;
|
||||||
|
///
|
||||||
|
/// Size of the rest of the extension header, including this structure.
|
||||||
|
///
|
||||||
|
UINT32 ExtHeaderSize;
|
||||||
|
} EFI_FIRMWARE_VOLUME_EXT_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Entry struture for describing FV extension header
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Size of this header extension.
|
||||||
|
///
|
||||||
|
UINT16 ExtEntrySize;
|
||||||
|
///
|
||||||
|
/// Type of the header.
|
||||||
|
///
|
||||||
|
UINT16 ExtEntryType;
|
||||||
|
} EFI_FIRMWARE_VOLUME_EXT_ENTRY;
|
||||||
|
|
||||||
|
#define EFI_FV_EXT_TYPE_OEM_TYPE 0x01
|
||||||
|
///
|
||||||
|
/// This extension header provides a mapping between a GUID and an OEM file type.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.
|
||||||
|
///
|
||||||
|
EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;
|
||||||
|
///
|
||||||
|
/// A bit mask, one bit for each file type between 0xC0 (bit 0) and 0xDF (bit 31). If a bit
|
||||||
|
/// is '1', then the GUID entry exists in Types. If a bit is '0' then no GUID entry exists in Types.
|
||||||
|
///
|
||||||
|
UINT32 TypeMask;
|
||||||
|
///
|
||||||
|
/// An array of GUIDs, each GUID representing an OEM file type.
|
||||||
|
///
|
||||||
|
/// EFI_GUID Types[1];
|
||||||
|
///
|
||||||
|
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;
|
||||||
|
|
||||||
|
#define EFI_FV_EXT_TYPE_GUID_TYPE 0x0002
|
||||||
|
|
||||||
|
///
|
||||||
|
/// This extension header EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE provides a vendor specific
|
||||||
|
/// GUID FormatType type which includes a length and a successive series of data bytes.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.
|
||||||
|
///
|
||||||
|
EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;
|
||||||
|
///
|
||||||
|
/// Vendor-specific GUID.
|
||||||
|
///
|
||||||
|
EFI_GUID FormatType;
|
||||||
|
///
|
||||||
|
/// An arry of bytes of length Length.
|
||||||
|
///
|
||||||
|
/// UINT8 Data[1];
|
||||||
|
///
|
||||||
|
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,452 @@
|
||||||
|
/** @file
|
||||||
|
HOB related definitions in PI.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials are licensed and made available under
|
||||||
|
the terms and conditions of the BSD License that accompanies this distribution.
|
||||||
|
The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
@par Revision Reference:
|
||||||
|
PI Version 1.0
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PI_HOB_H__
|
||||||
|
#define __PI_HOB_H__
|
||||||
|
|
||||||
|
//
|
||||||
|
// HobType of EFI_HOB_GENERIC_HEADER.
|
||||||
|
//
|
||||||
|
#define EFI_HOB_TYPE_HANDOFF 0x0001
|
||||||
|
#define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
|
||||||
|
#define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
|
||||||
|
#define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
|
||||||
|
#define EFI_HOB_TYPE_FV 0x0005
|
||||||
|
#define EFI_HOB_TYPE_CPU 0x0006
|
||||||
|
#define EFI_HOB_TYPE_MEMORY_POOL 0x0007
|
||||||
|
#define EFI_HOB_TYPE_FV2 0x0009
|
||||||
|
#define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A
|
||||||
|
#define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B
|
||||||
|
#define EFI_HOB_TYPE_UNUSED 0xFFFE
|
||||||
|
#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes the format and size of the data inside the HOB.
|
||||||
|
/// All HOBs must contain this generic HOB header.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Identifies the HOB data structure type.
|
||||||
|
///
|
||||||
|
UINT16 HobType;
|
||||||
|
///
|
||||||
|
/// The length in bytes of the HOB.
|
||||||
|
///
|
||||||
|
UINT16 HobLength;
|
||||||
|
///
|
||||||
|
/// This field must always be set to zero.
|
||||||
|
///
|
||||||
|
UINT32 Reserved;
|
||||||
|
} EFI_HOB_GENERIC_HEADER;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
|
||||||
|
///
|
||||||
|
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Contains general state information used by the HOB producer phase.
|
||||||
|
/// This HOB must be the first one in the HOB list.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// The version number pertaining to the PHIT HOB definition.
|
||||||
|
/// This value is four bytes in length to provide an 8-byte aligned entry
|
||||||
|
/// when it is combined with the 4-byte BootMode.
|
||||||
|
///
|
||||||
|
UINT32 Version;
|
||||||
|
///
|
||||||
|
/// The system boot mode as determined during the HOB producer phase.
|
||||||
|
///
|
||||||
|
EFI_BOOT_MODE BootMode;
|
||||||
|
///
|
||||||
|
/// The highest address location of memory that is allocated for use by the HOB producer
|
||||||
|
/// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EfiMemoryTop;
|
||||||
|
///
|
||||||
|
/// The lowest address location of memory that is allocated for use by the HOB producer phase.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EfiMemoryBottom;
|
||||||
|
///
|
||||||
|
/// The highest address location of free memory that is currently available
|
||||||
|
/// for use by the HOB producer phase.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop;
|
||||||
|
///
|
||||||
|
/// The lowest address location of free memory that is available for use by the HOB producer phase.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom;
|
||||||
|
///
|
||||||
|
/// The end of the HOB list.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EfiEndOfHobList;
|
||||||
|
} EFI_HOB_HANDOFF_INFO_TABLE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
|
||||||
|
/// various attributes of the logical memory allocation. The type field will be used for
|
||||||
|
/// subsequent inclusion in the UEFI memory map.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// A GUID that defines the memory allocation region's type and purpose, as well as
|
||||||
|
/// other fields within the memory allocation HOB. This GUID is used to define the
|
||||||
|
/// additional data within the HOB that may be present for the memory allocation HOB.
|
||||||
|
/// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
|
||||||
|
/// specification.
|
||||||
|
///
|
||||||
|
EFI_GUID Name;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The base address of memory allocated by this HOB. Type
|
||||||
|
/// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
|
||||||
|
/// specification.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS MemoryBaseAddress;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The length in bytes of memory allocated by this HOB.
|
||||||
|
///
|
||||||
|
UINT64 MemoryLength;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Defines the type of memory allocated by this HOB. The memory type definition
|
||||||
|
/// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
|
||||||
|
/// in AllocatePages() in the UEFI 2.0 specification.
|
||||||
|
///
|
||||||
|
EFI_MEMORY_TYPE MemoryType;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Padding for Itanium processor family
|
||||||
|
///
|
||||||
|
UINT8 Reserved[4];
|
||||||
|
} EFI_HOB_MEMORY_ALLOCATION_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes all memory ranges used during the HOB producer
|
||||||
|
/// phase that exist outside the HOB list. This HOB type
|
||||||
|
/// describes how memory is used, not the physical attributes of memory.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
||||||
|
/// various attributes of the logical memory allocation.
|
||||||
|
///
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
||||||
|
//
|
||||||
|
// Additional data pertaining to the "Name" Guid memory
|
||||||
|
// may go here.
|
||||||
|
//
|
||||||
|
} EFI_HOB_MEMORY_ALLOCATION;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes the memory stack that is produced by the HOB producer
|
||||||
|
/// phase and upon which all post-memory-installed executable
|
||||||
|
/// content in the HOB producer phase is executing.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
||||||
|
/// various attributes of the logical memory allocation.
|
||||||
|
///
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
||||||
|
} EFI_HOB_MEMORY_ALLOCATION_STACK;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Defines the location of the boot-strap
|
||||||
|
/// processor (BSP) BSPStore ("Backing Store Pointer Store").
|
||||||
|
/// This HOB is valid for the Itanium processor family only
|
||||||
|
/// register overflow store.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
||||||
|
/// various attributes of the logical memory allocation.
|
||||||
|
///
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
||||||
|
} EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Defines the location and entry point of the HOB consumer phase.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
||||||
|
/// various attributes of the logical memory allocation.
|
||||||
|
///
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;
|
||||||
|
///
|
||||||
|
/// The GUID specifying the values of the firmware file system name
|
||||||
|
/// that contains the HOB consumer phase component.
|
||||||
|
///
|
||||||
|
EFI_GUID ModuleName;
|
||||||
|
///
|
||||||
|
/// The address of the memory-mapped firmware volume
|
||||||
|
/// that contains the HOB consumer phase firmware file.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS EntryPoint;
|
||||||
|
} EFI_HOB_MEMORY_ALLOCATION_MODULE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The resource type.
|
||||||
|
///
|
||||||
|
typedef UINT32 EFI_RESOURCE_TYPE;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
|
||||||
|
//
|
||||||
|
#define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
|
||||||
|
#define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
|
||||||
|
#define EFI_RESOURCE_IO 0x00000002
|
||||||
|
#define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
|
||||||
|
#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
|
||||||
|
#define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
|
||||||
|
#define EFI_RESOURCE_IO_RESERVED 0x00000006
|
||||||
|
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
|
||||||
|
|
||||||
|
///
|
||||||
|
/// A type of recount attribute type.
|
||||||
|
///
|
||||||
|
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
|
||||||
|
|
||||||
|
//
|
||||||
|
// These types can be ORed together as needed.
|
||||||
|
//
|
||||||
|
// The following attributes are used to describe settings
|
||||||
|
//
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
|
||||||
|
//
|
||||||
|
// The rest of the attributes are used to describe capabilities
|
||||||
|
//
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
|
||||||
|
#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes the resource properties of all fixed,
|
||||||
|
/// nonrelocatable resource ranges found on the processor
|
||||||
|
/// host bus during the HOB producer phase.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// A GUID representing the owner of the resource. This GUID is used by HOB
|
||||||
|
/// consumer phase components to correlate device ownership of a resource.
|
||||||
|
///
|
||||||
|
EFI_GUID Owner;
|
||||||
|
///
|
||||||
|
/// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
|
||||||
|
///
|
||||||
|
EFI_RESOURCE_TYPE ResourceType;
|
||||||
|
///
|
||||||
|
/// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
|
||||||
|
///
|
||||||
|
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
|
||||||
|
///
|
||||||
|
/// The physical start address of the resource region.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS PhysicalStart;
|
||||||
|
///
|
||||||
|
/// The number of bytes of the resource region.
|
||||||
|
///
|
||||||
|
UINT64 ResourceLength;
|
||||||
|
} EFI_HOB_RESOURCE_DESCRIPTOR;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Allows writers of executable content in the HOB producer phase to
|
||||||
|
/// maintain and manage HOBs with specific GUID.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// A GUID that defines the contents of this HOB.
|
||||||
|
///
|
||||||
|
EFI_GUID Name;
|
||||||
|
//
|
||||||
|
// Guid specific data goes here
|
||||||
|
//
|
||||||
|
} EFI_HOB_GUID_TYPE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Details the location of firmware volumes that contain firmware files.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// The physical memory-mapped base address of the firmware volume.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
||||||
|
///
|
||||||
|
/// The length in bytes of the firmware volume.
|
||||||
|
///
|
||||||
|
UINT64 Length;
|
||||||
|
} EFI_HOB_FIRMWARE_VOLUME;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Details the location of a firmware volume that was extracted
|
||||||
|
/// from a file within another firmware volume.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// The physical memory-mapped base address of the firmware volume.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
||||||
|
///
|
||||||
|
/// The length in bytes of the firmware volume.
|
||||||
|
///
|
||||||
|
UINT64 Length;
|
||||||
|
///
|
||||||
|
/// The name of the firmware volume.
|
||||||
|
///
|
||||||
|
EFI_GUID FvName;
|
||||||
|
///
|
||||||
|
/// The name of the firmware file that contained this firmware volume.
|
||||||
|
///
|
||||||
|
EFI_GUID FileName;
|
||||||
|
} EFI_HOB_FIRMWARE_VOLUME2;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes processor information, such as address space and I/O space capabilities.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
///
|
||||||
|
/// Identifies the maximum physical memory addressability of the processor.
|
||||||
|
///
|
||||||
|
UINT8 SizeOfMemorySpace;
|
||||||
|
///
|
||||||
|
/// Identifies the maximum physical I/O addressability of the processor.
|
||||||
|
///
|
||||||
|
UINT8 SizeOfIoSpace;
|
||||||
|
///
|
||||||
|
/// This field will always be set to zero.
|
||||||
|
///
|
||||||
|
UINT8 Reserved[6];
|
||||||
|
} EFI_HOB_CPU;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Describes pool memory allocations.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
} EFI_HOB_MEMORY_POOL;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
|
||||||
|
/// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
|
||||||
|
/// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
|
||||||
|
/// sometime after the UEFI UpdateCapsule service invocation with the
|
||||||
|
/// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
|
||||||
|
///
|
||||||
|
EFI_HOB_GENERIC_HEADER Header;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The physical memory-mapped base address of an UEFI capsule. This value is set to
|
||||||
|
/// point to the base of the contiguous memory of the UEFI capsule.
|
||||||
|
/// The length of the contiguous memory in bytes.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
||||||
|
UINT64 Length;
|
||||||
|
} EFI_HOB_UEFI_CAPSULE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Union of all the possible HOB Types.
|
||||||
|
///
|
||||||
|
typedef union {
|
||||||
|
EFI_HOB_GENERIC_HEADER *Header;
|
||||||
|
EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION *MemoryAllocation;
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_STACK *MemoryAllocationStack;
|
||||||
|
EFI_HOB_MEMORY_ALLOCATION_MODULE *MemoryAllocationModule;
|
||||||
|
EFI_HOB_RESOURCE_DESCRIPTOR *ResourceDescriptor;
|
||||||
|
EFI_HOB_GUID_TYPE *Guid;
|
||||||
|
EFI_HOB_FIRMWARE_VOLUME *FirmwareVolume;
|
||||||
|
EFI_HOB_FIRMWARE_VOLUME2 *FirmwareVolume2;
|
||||||
|
EFI_HOB_CPU *Cpu;
|
||||||
|
EFI_HOB_MEMORY_POOL *Pool;
|
||||||
|
EFI_HOB_UEFI_CAPSULE *Capsule;
|
||||||
|
UINT8 *Raw;
|
||||||
|
} EFI_PEI_HOB_POINTERS;
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,276 @@
|
||||||
|
/** @file
|
||||||
|
Graphics Output Protocol from the UEFI 2.0 specification.
|
||||||
|
|
||||||
|
Abstraction of a very simple graphics device.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __GRAPHICS_OUTPUT_H__
|
||||||
|
#define __GRAPHICS_OUTPUT_H__
|
||||||
|
|
||||||
|
#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
|
||||||
|
{ \
|
||||||
|
0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
|
||||||
|
}
|
||||||
|
|
||||||
|
typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
UINT32 RedMask;
|
||||||
|
UINT32 GreenMask;
|
||||||
|
UINT32 BlueMask;
|
||||||
|
UINT32 ReservedMask;
|
||||||
|
} EFI_PIXEL_BITMASK;
|
||||||
|
|
||||||
|
typedef enum {
|
||||||
|
///
|
||||||
|
/// A pixel is 32-bits and byte zero represents red, byte one represents green,
|
||||||
|
/// byte two represents blue, and byte three is reserved. This is the definition
|
||||||
|
/// for the physical frame buffer. The byte values for the red, green, and blue
|
||||||
|
/// components represent the color intensity. This color intensity value range
|
||||||
|
/// from a minimum intensity of 0 to maximum intensity of 255.
|
||||||
|
///
|
||||||
|
PixelRedGreenBlueReserved8BitPerColor,
|
||||||
|
///
|
||||||
|
/// A pixel is 32-bits and byte zero represents blue, byte one represents green,
|
||||||
|
/// byte two represents red, and byte three is reserved. This is the definition
|
||||||
|
/// for the physical frame buffer. The byte values for the red, green, and blue
|
||||||
|
/// components represent the color intensity. This color intensity value range
|
||||||
|
/// from a minimum intensity of 0 to maximum intensity of 255.
|
||||||
|
///
|
||||||
|
PixelBlueGreenRedReserved8BitPerColor,
|
||||||
|
///
|
||||||
|
/// The Pixel definition of the physical frame buffer.
|
||||||
|
///
|
||||||
|
PixelBitMask,
|
||||||
|
///
|
||||||
|
/// This mode does not support a physical frame buffer.
|
||||||
|
///
|
||||||
|
PixelBltOnly,
|
||||||
|
///
|
||||||
|
/// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.
|
||||||
|
///
|
||||||
|
PixelFormatMax
|
||||||
|
} EFI_GRAPHICS_PIXEL_FORMAT;
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The version of this data structure. A value of zero represents the
|
||||||
|
/// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.
|
||||||
|
///
|
||||||
|
UINT32 Version;
|
||||||
|
///
|
||||||
|
/// The size of video screen in pixels in the X dimension.
|
||||||
|
///
|
||||||
|
UINT32 HorizontalResolution;
|
||||||
|
///
|
||||||
|
/// The size of video screen in pixels in the Y dimension.
|
||||||
|
///
|
||||||
|
UINT32 VerticalResolution;
|
||||||
|
///
|
||||||
|
/// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly
|
||||||
|
/// implies that a linear frame buffer is not available for this mode.
|
||||||
|
///
|
||||||
|
EFI_GRAPHICS_PIXEL_FORMAT PixelFormat;
|
||||||
|
///
|
||||||
|
/// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask.
|
||||||
|
/// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.
|
||||||
|
///
|
||||||
|
EFI_PIXEL_BITMASK PixelInformation;
|
||||||
|
///
|
||||||
|
/// Defines the number of pixel elements per video memory line.
|
||||||
|
///
|
||||||
|
UINT32 PixelsPerScanLine;
|
||||||
|
} EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Returns information for an available graphics mode that the graphics device
|
||||||
|
and the set of active video output devices supports.
|
||||||
|
|
||||||
|
@param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
|
||||||
|
@param ModeNumber The mode number to return information on.
|
||||||
|
@param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
|
||||||
|
@param Info A pointer to callee allocated buffer that returns information about ModeNumber.
|
||||||
|
|
||||||
|
@retval EFI_SUCCESS Valid mode information was returned.
|
||||||
|
@retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
|
||||||
|
@retval EFI_INVALID_PARAMETER ModeNumber is not valid.
|
||||||
|
|
||||||
|
**/
|
||||||
|
typedef
|
||||||
|
EFI_STATUS
|
||||||
|
(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE)(
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
|
||||||
|
IN UINT32 ModeNumber,
|
||||||
|
OUT UINTN *SizeOfInfo,
|
||||||
|
OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Set the video device into the specified mode and clears the visible portions of
|
||||||
|
the output display to black.
|
||||||
|
|
||||||
|
@param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
|
||||||
|
@param ModeNumber Abstraction that defines the current video mode.
|
||||||
|
|
||||||
|
@retval EFI_SUCCESS The graphics mode specified by ModeNumber was selected.
|
||||||
|
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
|
||||||
|
@retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
|
||||||
|
|
||||||
|
**/
|
||||||
|
typedef
|
||||||
|
EFI_STATUS
|
||||||
|
(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE)(
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
|
||||||
|
IN UINT32 ModeNumber
|
||||||
|
);
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Blue;
|
||||||
|
UINT8 Green;
|
||||||
|
UINT8 Red;
|
||||||
|
UINT8 Reserved;
|
||||||
|
} EFI_GRAPHICS_OUTPUT_BLT_PIXEL;
|
||||||
|
|
||||||
|
typedef union {
|
||||||
|
EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel;
|
||||||
|
UINT32 Raw;
|
||||||
|
} EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// actions for BltOperations
|
||||||
|
///
|
||||||
|
typedef enum {
|
||||||
|
///
|
||||||
|
/// Write data from the BltBuffer pixel (0, 0)
|
||||||
|
/// directly to every pixel of the video display rectangle
|
||||||
|
/// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
|
||||||
|
/// Only one pixel will be used from the BltBuffer. Delta is NOT used.
|
||||||
|
///
|
||||||
|
EfiBltVideoFill,
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Read data from the video display rectangle
|
||||||
|
/// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
|
||||||
|
/// the BltBuffer rectangle (DestinationX, DestinationY )
|
||||||
|
/// (DestinationX + Width, DestinationY + Height). If DestinationX or
|
||||||
|
/// DestinationY is not zero then Delta must be set to the length in bytes
|
||||||
|
/// of a row in the BltBuffer.
|
||||||
|
///
|
||||||
|
EfiBltVideoToBltBuffer,
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Write data from the BltBuffer rectangle
|
||||||
|
/// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
|
||||||
|
/// video display rectangle (DestinationX, DestinationY)
|
||||||
|
/// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
|
||||||
|
/// not zero then Delta must be set to the length in bytes of a row in the
|
||||||
|
/// BltBuffer.
|
||||||
|
///
|
||||||
|
EfiBltBufferToVideo,
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Copy from the video display rectangle (SourceX, SourceY)
|
||||||
|
/// (SourceX + Width, SourceY + Height) to the video display rectangle
|
||||||
|
/// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
|
||||||
|
/// The BltBuffer and Delta are not used in this mode.
|
||||||
|
///
|
||||||
|
EfiBltVideoToVideo,
|
||||||
|
|
||||||
|
EfiGraphicsOutputBltOperationMax
|
||||||
|
} EFI_GRAPHICS_OUTPUT_BLT_OPERATION;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.
|
||||||
|
|
||||||
|
@param This Protocol instance pointer.
|
||||||
|
@param BltBuffer The data to transfer to the graphics screen.
|
||||||
|
Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).
|
||||||
|
@param BltOperation The operation to perform when copying BltBuffer on to the graphics screen.
|
||||||
|
@param SourceX The X coordinate of source for the BltOperation.
|
||||||
|
@param SourceY The Y coordinate of source for the BltOperation.
|
||||||
|
@param DestinationX The X coordinate of destination for the BltOperation.
|
||||||
|
@param DestinationY The Y coordinate of destination for the BltOperation.
|
||||||
|
@param Width The width of a rectangle in the blt rectangle in pixels.
|
||||||
|
@param Height The height of a rectangle in the blt rectangle in pixels.
|
||||||
|
@param Delta Not used for EfiBltVideoFill or the EfiBltVideoToVideo operation.
|
||||||
|
If a Delta of zero is used, the entire BltBuffer is being operated on.
|
||||||
|
If a subrectangle of the BltBuffer is being used then Delta
|
||||||
|
represents the number of bytes in a row of the BltBuffer.
|
||||||
|
|
||||||
|
@retval EFI_SUCCESS BltBuffer was drawn to the graphics screen.
|
||||||
|
@retval EFI_INVALID_PARAMETER BltOperation is not valid.
|
||||||
|
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
|
||||||
|
|
||||||
|
**/
|
||||||
|
typedef
|
||||||
|
EFI_STATUS
|
||||||
|
(EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT)(
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
|
||||||
|
IN UINTN SourceX,
|
||||||
|
IN UINTN SourceY,
|
||||||
|
IN UINTN DestinationX,
|
||||||
|
IN UINTN DestinationY,
|
||||||
|
IN UINTN Width,
|
||||||
|
IN UINTN Height,
|
||||||
|
IN UINTN Delta OPTIONAL
|
||||||
|
);
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// The number of modes supported by QueryMode() and SetMode().
|
||||||
|
///
|
||||||
|
UINT32 MaxMode;
|
||||||
|
///
|
||||||
|
/// Current Mode of the graphics device. Valid mode numbers are 0 to MaxMode -1.
|
||||||
|
///
|
||||||
|
UINT32 Mode;
|
||||||
|
///
|
||||||
|
/// Pointer to read-only EFI_GRAPHICS_OUTPUT_MODE_INFORMATION data.
|
||||||
|
///
|
||||||
|
EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
|
||||||
|
///
|
||||||
|
/// Size of Info structure in bytes.
|
||||||
|
///
|
||||||
|
UINTN SizeOfInfo;
|
||||||
|
///
|
||||||
|
/// Base address of graphics linear frame buffer.
|
||||||
|
/// Offset zero in FrameBufferBase represents the upper left pixel of the display.
|
||||||
|
///
|
||||||
|
EFI_PHYSICAL_ADDRESS FrameBufferBase;
|
||||||
|
///
|
||||||
|
/// Amount of frame buffer needed to support the active mode as defined by
|
||||||
|
/// PixelsPerScanLine xVerticalResolution x PixelElementSize.
|
||||||
|
///
|
||||||
|
UINTN FrameBufferSize;
|
||||||
|
} EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Provides a basic abstraction to set video modes and copy pixels to and from
|
||||||
|
/// the graphics controller's frame buffer. The linear address of the hardware
|
||||||
|
/// frame buffer is also exposed so software can write directly to the video hardware.
|
||||||
|
///
|
||||||
|
struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {
|
||||||
|
EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE QueryMode;
|
||||||
|
EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE SetMode;
|
||||||
|
EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT Blt;
|
||||||
|
///
|
||||||
|
/// Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.
|
||||||
|
///
|
||||||
|
EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode;
|
||||||
|
};
|
||||||
|
|
||||||
|
extern EFI_GUID gEfiGraphicsOutputProtocolGuid;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,301 @@
|
||||||
|
/** @file
|
||||||
|
Defines data types and constants introduced in UEFI.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
|
Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>
|
||||||
|
|
||||||
|
This program and the accompanying materials are licensed and made available under
|
||||||
|
the terms and conditions of the BSD License that accompanies this distribution.
|
||||||
|
The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __UEFI_BASETYPE_H__
|
||||||
|
#define __UEFI_BASETYPE_H__
|
||||||
|
|
||||||
|
#include <Base.h>
|
||||||
|
|
||||||
|
//
|
||||||
|
// Basic data type definitions introduced in UEFI.
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 128-bit buffer containing a unique identifier value.
|
||||||
|
///
|
||||||
|
typedef GUID EFI_GUID;
|
||||||
|
///
|
||||||
|
/// Function return status for EFI API.
|
||||||
|
///
|
||||||
|
typedef RETURN_STATUS EFI_STATUS;
|
||||||
|
///
|
||||||
|
/// A collection of related interfaces.
|
||||||
|
///
|
||||||
|
typedef VOID *EFI_HANDLE;
|
||||||
|
///
|
||||||
|
/// Handle to an event structure.
|
||||||
|
///
|
||||||
|
typedef VOID *EFI_EVENT;
|
||||||
|
///
|
||||||
|
/// Task priority level.
|
||||||
|
///
|
||||||
|
typedef UINTN EFI_TPL;
|
||||||
|
///
|
||||||
|
/// Logical block address.
|
||||||
|
///
|
||||||
|
typedef UINT64 EFI_LBA;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 64-bit physical memory address.
|
||||||
|
///
|
||||||
|
typedef UINT64 EFI_PHYSICAL_ADDRESS;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 64-bit virtual memory address.
|
||||||
|
///
|
||||||
|
typedef UINT64 EFI_VIRTUAL_ADDRESS;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// EFI Time Abstraction:
|
||||||
|
/// Year: 1900 - 9999
|
||||||
|
/// Month: 1 - 12
|
||||||
|
/// Day: 1 - 31
|
||||||
|
/// Hour: 0 - 23
|
||||||
|
/// Minute: 0 - 59
|
||||||
|
/// Second: 0 - 59
|
||||||
|
/// Nanosecond: 0 - 999,999,999
|
||||||
|
/// TimeZone: -1440 to 1440 or 2047
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT16 Year;
|
||||||
|
UINT8 Month;
|
||||||
|
UINT8 Day;
|
||||||
|
UINT8 Hour;
|
||||||
|
UINT8 Minute;
|
||||||
|
UINT8 Second;
|
||||||
|
UINT8 Pad1;
|
||||||
|
UINT32 Nanosecond;
|
||||||
|
INT16 TimeZone;
|
||||||
|
UINT8 Daylight;
|
||||||
|
UINT8 Pad2;
|
||||||
|
} EFI_TIME;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 4-byte buffer. An IPv4 internet protocol address.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Addr[4];
|
||||||
|
} EFI_IPv4_ADDRESS;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 16-byte buffer. An IPv6 internet protocol address.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Addr[16];
|
||||||
|
} EFI_IPv6_ADDRESS;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 32-byte buffer containing a network Media Access Control address.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
UINT8 Addr[32];
|
||||||
|
} EFI_MAC_ADDRESS;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 16-byte buffer aligned on a 4-byte boundary.
|
||||||
|
/// An IPv4 or IPv6 internet protocol address.
|
||||||
|
///
|
||||||
|
typedef union {
|
||||||
|
UINT32 Addr[4];
|
||||||
|
EFI_IPv4_ADDRESS v4;
|
||||||
|
EFI_IPv6_ADDRESS v6;
|
||||||
|
} EFI_IP_ADDRESS;
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Enumeration of EFI_STATUS.
|
||||||
|
///@{
|
||||||
|
#define EFI_SUCCESS RETURN_SUCCESS
|
||||||
|
#define EFI_LOAD_ERROR RETURN_LOAD_ERROR
|
||||||
|
#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER
|
||||||
|
#define EFI_UNSUPPORTED RETURN_UNSUPPORTED
|
||||||
|
#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE
|
||||||
|
#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL
|
||||||
|
#define EFI_NOT_READY RETURN_NOT_READY
|
||||||
|
#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR
|
||||||
|
#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED
|
||||||
|
#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES
|
||||||
|
#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED
|
||||||
|
#define EFI_VOLUME_FULL RETURN_VOLUME_FULL
|
||||||
|
#define EFI_NO_MEDIA RETURN_NO_MEDIA
|
||||||
|
#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED
|
||||||
|
#define EFI_NOT_FOUND RETURN_NOT_FOUND
|
||||||
|
#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED
|
||||||
|
#define EFI_NO_RESPONSE RETURN_NO_RESPONSE
|
||||||
|
#define EFI_NO_MAPPING RETURN_NO_MAPPING
|
||||||
|
#define EFI_TIMEOUT RETURN_TIMEOUT
|
||||||
|
#define EFI_NOT_STARTED RETURN_NOT_STARTED
|
||||||
|
#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED
|
||||||
|
#define EFI_ABORTED RETURN_ABORTED
|
||||||
|
#define EFI_ICMP_ERROR RETURN_ICMP_ERROR
|
||||||
|
#define EFI_TFTP_ERROR RETURN_TFTP_ERROR
|
||||||
|
#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR
|
||||||
|
#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION
|
||||||
|
#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION
|
||||||
|
#define EFI_CRC_ERROR RETURN_CRC_ERROR
|
||||||
|
#define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA
|
||||||
|
#define EFI_END_OF_FILE RETURN_END_OF_FILE
|
||||||
|
#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
|
||||||
|
#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA
|
||||||
|
|
||||||
|
#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
|
||||||
|
#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
|
||||||
|
#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
|
||||||
|
#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
|
||||||
|
#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Define macro to encode the status code.
|
||||||
|
///
|
||||||
|
#define EFIERR(_a) ENCODE_ERROR(_a)
|
||||||
|
|
||||||
|
#define EFI_ERROR(A) RETURN_ERROR(A)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// ICMP error definitions
|
||||||
|
///@{
|
||||||
|
#define EFI_NETWORK_UNREACHABLE EFIERR(100)
|
||||||
|
#define EFI_HOST_UNREACHABLE EFIERR(101)
|
||||||
|
#define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
|
||||||
|
#define EFI_PORT_UNREACHABLE EFIERR(103)
|
||||||
|
///@}
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Tcp connection status definitions
|
||||||
|
///@{
|
||||||
|
#define EFI_CONNECTION_FIN EFIERR(104)
|
||||||
|
#define EFI_CONNECTION_RESET EFIERR(105)
|
||||||
|
#define EFI_CONNECTION_REFUSED EFIERR(106)
|
||||||
|
///@}
|
||||||
|
|
||||||
|
//
|
||||||
|
// The EFI memory allocation functions work in units of EFI_PAGEs that are
|
||||||
|
// 4KB. This should in no way be confused with the page size of the processor.
|
||||||
|
// An EFI_PAGE is just the quanta of memory in EFI.
|
||||||
|
//
|
||||||
|
#define EFI_PAGE_SIZE SIZE_4KB
|
||||||
|
#define EFI_PAGE_MASK 0xFFF
|
||||||
|
#define EFI_PAGE_SHIFT 12
|
||||||
|
|
||||||
|
/**
|
||||||
|
Macro that converts a size, in bytes, to a number of EFI_PAGESs.
|
||||||
|
|
||||||
|
@param Size A size in bytes. This parameter is assumed to be type UINTN.
|
||||||
|
Passing in a parameter that is larger than UINTN may produce
|
||||||
|
unexpected results.
|
||||||
|
|
||||||
|
@return The number of EFI_PAGESs associated with the number of bytes specified
|
||||||
|
by Size.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))
|
||||||
|
|
||||||
|
/**
|
||||||
|
Macro that converts a number of EFI_PAGEs to a size in bytes.
|
||||||
|
|
||||||
|
@param Pages The number of EFI_PAGES. This parameter is assumed to be
|
||||||
|
type UINTN. Passing in a parameter that is larger than
|
||||||
|
UINTN may produce unexpected results.
|
||||||
|
|
||||||
|
@return The number of bytes associated with the number of EFI_PAGEs specified
|
||||||
|
by Pages.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for IA32 UEFI images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_IA32 0x014C
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for IA64 UEFI images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_IA64 0x0200
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for EBC UEFI images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_EBC 0x0EBC
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for X64 UEFI images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_X64 0x8664
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
|
||||||
|
|
||||||
|
///
|
||||||
|
/// PE32+ Machine type for AARCH64 A64 images.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_AARCH64 0xAA64
|
||||||
|
|
||||||
|
|
||||||
|
#if defined (MDE_CPU_IA32)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
|
||||||
|
(((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
|
||||||
|
|
||||||
|
#elif defined (MDE_CPU_IPF)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
|
||||||
|
(((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
|
||||||
|
|
||||||
|
#elif defined (MDE_CPU_X64)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
|
||||||
|
(((Machine) == EFI_IMAGE_MACHINE_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
|
||||||
|
|
||||||
|
#elif defined (MDE_CPU_ARM)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
|
||||||
|
(((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
|
||||||
|
|
||||||
|
#elif defined (MDE_CPU_AARCH64)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
|
||||||
|
(((Machine) == EFI_IMAGE_MACHINE_AARCH64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
|
||||||
|
|
||||||
|
#elif defined (MDE_CPU_EBC)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// This is just to make sure you can cross compile with the EBC compiler.
|
||||||
|
/// It does not make sense to have a PE loader coded in EBC.
|
||||||
|
///
|
||||||
|
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
|
||||||
|
|
||||||
|
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
|
||||||
|
|
||||||
|
#else
|
||||||
|
#error Unknown Processor Type
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,193 @@
|
||||||
|
/** @file
|
||||||
|
This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials are licensed and made available under
|
||||||
|
the terms and conditions of the BSD License that accompanies this distribution.
|
||||||
|
The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php.
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __UEFI_MULTIPHASE_H__
|
||||||
|
#define __UEFI_MULTIPHASE_H__
|
||||||
|
|
||||||
|
#include <Guid/WinCertificate.h>
|
||||||
|
///
|
||||||
|
/// Enumeration of memory types introduced in UEFI.
|
||||||
|
///
|
||||||
|
typedef enum {
|
||||||
|
///
|
||||||
|
/// Not used.
|
||||||
|
///
|
||||||
|
EfiReservedMemoryType,
|
||||||
|
///
|
||||||
|
/// The code portions of a loaded application.
|
||||||
|
/// (Note that UEFI OS loaders are UEFI applications.)
|
||||||
|
///
|
||||||
|
EfiLoaderCode,
|
||||||
|
///
|
||||||
|
/// The data portions of a loaded application and the default data allocation
|
||||||
|
/// type used by an application to allocate pool memory.
|
||||||
|
///
|
||||||
|
EfiLoaderData,
|
||||||
|
///
|
||||||
|
/// The code portions of a loaded Boot Services Driver.
|
||||||
|
///
|
||||||
|
EfiBootServicesCode,
|
||||||
|
///
|
||||||
|
/// The data portions of a loaded Boot Serves Driver, and the default data
|
||||||
|
/// allocation type used by a Boot Services Driver to allocate pool memory.
|
||||||
|
///
|
||||||
|
EfiBootServicesData,
|
||||||
|
///
|
||||||
|
/// The code portions of a loaded Runtime Services Driver.
|
||||||
|
///
|
||||||
|
EfiRuntimeServicesCode,
|
||||||
|
///
|
||||||
|
/// The data portions of a loaded Runtime Services Driver and the default
|
||||||
|
/// data allocation type used by a Runtime Services Driver to allocate pool memory.
|
||||||
|
///
|
||||||
|
EfiRuntimeServicesData,
|
||||||
|
///
|
||||||
|
/// Free (unallocated) memory.
|
||||||
|
///
|
||||||
|
EfiConventionalMemory,
|
||||||
|
///
|
||||||
|
/// Memory in which errors have been detected.
|
||||||
|
///
|
||||||
|
EfiUnusableMemory,
|
||||||
|
///
|
||||||
|
/// Memory that holds the ACPI tables.
|
||||||
|
///
|
||||||
|
EfiACPIReclaimMemory,
|
||||||
|
///
|
||||||
|
/// Address space reserved for use by the firmware.
|
||||||
|
///
|
||||||
|
EfiACPIMemoryNVS,
|
||||||
|
///
|
||||||
|
/// Used by system firmware to request that a memory-mapped IO region
|
||||||
|
/// be mapped by the OS to a virtual address so it can be accessed by EFI runtime services.
|
||||||
|
///
|
||||||
|
EfiMemoryMappedIO,
|
||||||
|
///
|
||||||
|
/// System memory-mapped IO region that is used to translate memory
|
||||||
|
/// cycles to IO cycles by the processor.
|
||||||
|
///
|
||||||
|
EfiMemoryMappedIOPortSpace,
|
||||||
|
///
|
||||||
|
/// Address space reserved by the firmware for code that is part of the processor.
|
||||||
|
///
|
||||||
|
EfiPalCode,
|
||||||
|
EfiMaxMemoryType
|
||||||
|
} EFI_MEMORY_TYPE;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Data structure that precedes all of the standard EFI table types.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// A 64-bit signature that identifies the type of table that follows.
|
||||||
|
/// Unique signatures have been generated for the EFI System Table,
|
||||||
|
/// the EFI Boot Services Table, and the EFI Runtime Services Table.
|
||||||
|
///
|
||||||
|
UINT64 Signature;
|
||||||
|
///
|
||||||
|
/// The revision of the EFI Specification to which this table
|
||||||
|
/// conforms. The upper 16 bits of this field contain the major
|
||||||
|
/// revision value, and the lower 16 bits contain the minor revision
|
||||||
|
/// value. The minor revision values are limited to the range of 00..99.
|
||||||
|
///
|
||||||
|
UINT32 Revision;
|
||||||
|
///
|
||||||
|
/// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.
|
||||||
|
///
|
||||||
|
UINT32 HeaderSize;
|
||||||
|
///
|
||||||
|
/// The 32-bit CRC for the entire table. This value is computed by
|
||||||
|
/// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.
|
||||||
|
///
|
||||||
|
UINT32 CRC32;
|
||||||
|
///
|
||||||
|
/// Reserved field that must be set to 0.
|
||||||
|
///
|
||||||
|
UINT32 Reserved;
|
||||||
|
} EFI_TABLE_HEADER;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Attributes of variable.
|
||||||
|
///
|
||||||
|
#define EFI_VARIABLE_NON_VOLATILE 0x00000001
|
||||||
|
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
|
||||||
|
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
|
||||||
|
///
|
||||||
|
/// This attribute is identified by the mnemonic 'HR'
|
||||||
|
/// elsewhere in this specification.
|
||||||
|
///
|
||||||
|
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
|
||||||
|
///
|
||||||
|
/// Attributes of Authenticated Variable
|
||||||
|
///
|
||||||
|
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
|
||||||
|
#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020
|
||||||
|
#define EFI_VARIABLE_APPEND_WRITE 0x00000040
|
||||||
|
|
||||||
|
|
||||||
|
///
|
||||||
|
/// AuthInfo is a WIN_CERTIFICATE using the wCertificateType
|
||||||
|
/// WIN_CERTIFICATE_UEFI_GUID and the CertType
|
||||||
|
/// EFI_CERT_TYPE_RSA2048_SHA256_GUID. If the attribute specifies
|
||||||
|
/// authenticated access, then the Data buffer should begin with an
|
||||||
|
/// authentication descriptor prior to the data payload and DataSize
|
||||||
|
/// should reflect the the data.and descriptor size. The caller
|
||||||
|
/// shall digest the Monotonic Count value and the associated data
|
||||||
|
/// for the variable update using the SHA-256 1-way hash algorithm.
|
||||||
|
/// The ensuing the 32-byte digest will be signed using the private
|
||||||
|
/// key associated w/ the public/private 2048-bit RSA key-pair. The
|
||||||
|
/// WIN_CERTIFICATE shall be used to describe the signature of the
|
||||||
|
/// Variable data *Data. In addition, the signature will also
|
||||||
|
/// include the MonotonicCount value to guard against replay attacks.
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// Included in the signature of
|
||||||
|
/// AuthInfo.Used to ensure freshness/no
|
||||||
|
/// replay. Incremented during each
|
||||||
|
/// "Write" access.
|
||||||
|
///
|
||||||
|
UINT64 MonotonicCount;
|
||||||
|
///
|
||||||
|
/// Provides the authorization for the variable
|
||||||
|
/// access. It is a signature across the
|
||||||
|
/// variable data and the Monotonic Count
|
||||||
|
/// value. Caller uses Private key that is
|
||||||
|
/// associated with a public key that has been
|
||||||
|
/// provisioned via the key exchange.
|
||||||
|
///
|
||||||
|
WIN_CERTIFICATE_UEFI_GUID AuthInfo;
|
||||||
|
} EFI_VARIABLE_AUTHENTICATION;
|
||||||
|
|
||||||
|
///
|
||||||
|
/// When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is
|
||||||
|
/// set, then the Data buffer shall begin with an instance of a complete (and serialized)
|
||||||
|
/// EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new
|
||||||
|
/// variable value and DataSize shall reflect the combined size of the descriptor and the new
|
||||||
|
/// variable value. The authentication descriptor is not part of the variable data and is not
|
||||||
|
/// returned by subsequent calls to GetVariable().
|
||||||
|
///
|
||||||
|
typedef struct {
|
||||||
|
///
|
||||||
|
/// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and
|
||||||
|
/// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.
|
||||||
|
///
|
||||||
|
EFI_TIME TimeStamp;
|
||||||
|
///
|
||||||
|
/// Only a CertType of EFI_CERT_TYPE_PKCS7_GUID is accepted.
|
||||||
|
///
|
||||||
|
WIN_CERTIFICATE_UEFI_GUID AuthInfo;
|
||||||
|
} EFI_VARIABLE_AUTHENTICATION_2;
|
||||||
|
|
||||||
|
#endif
|
|
@ -0,0 +1,298 @@
|
||||||
|
/** @file
|
||||||
|
Processor or Compiler specific defines and types x64 (Intel 64, AMD64).
|
||||||
|
|
||||||
|
Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
|
||||||
|
This program and the accompanying materials
|
||||||
|
are licensed and made available under the terms and conditions of the BSD License
|
||||||
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
http://opensource.org/licenses/bsd-license.php
|
||||||
|
|
||||||
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __PROCESSOR_BIND_H__
|
||||||
|
#define __PROCESSOR_BIND_H__
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Define the processor type so other code can make processor based choices
|
||||||
|
///
|
||||||
|
#define MDE_CPU_X64
|
||||||
|
|
||||||
|
//
|
||||||
|
// Make sure we are using the correct packing rules per EFI specification
|
||||||
|
//
|
||||||
|
#if !defined(__GNUC__)
|
||||||
|
#pragma pack()
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(__INTEL_COMPILER)
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #869: "Parameter" was never referenced warning.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with -Wall
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 869 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #1418: external function definition with no prior declaration.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 1418 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #1419: external declaration in primary source file
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 1419 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable ICC's remark #593: "Variable" was set but never used.
|
||||||
|
// This is legal ANSI C code so we disable the remark that is turned on with /W4
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 593 )
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(_MSC_EXTENSIONS)
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable warning that make it impossible to compile at /W4
|
||||||
|
// This only works for Microsoft* tools
|
||||||
|
//
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disabling bitfield type checking warnings.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4214 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disabling the unreferenced formal parameter warnings.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4100 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// Disable slightly different base types warning as CHAR8 * can not be set
|
||||||
|
// to a constant string.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4057 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4127 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// This warning is caused by functions defined but not used. For precompiled header only.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4505 )
|
||||||
|
|
||||||
|
//
|
||||||
|
// This warning is caused by empty (after preprocessing) source file. For precompiled header only.
|
||||||
|
//
|
||||||
|
#pragma warning ( disable : 4206 )
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if defined(_MSC_EXTENSIONS)
|
||||||
|
//
|
||||||
|
// use Microsoft C complier dependent integer width types
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// 8-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned __int64 UINT64;
|
||||||
|
///
|
||||||
|
/// 8-byte signed value
|
||||||
|
///
|
||||||
|
typedef __int64 INT64;
|
||||||
|
///
|
||||||
|
/// 4-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned __int32 UINT32;
|
||||||
|
///
|
||||||
|
/// 4-byte signed value
|
||||||
|
///
|
||||||
|
typedef __int32 INT32;
|
||||||
|
///
|
||||||
|
/// 2-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned short UINT16;
|
||||||
|
///
|
||||||
|
/// 2-byte Character. Unless otherwise specified all strings are stored in the
|
||||||
|
/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
|
||||||
|
///
|
||||||
|
typedef unsigned short CHAR16;
|
||||||
|
///
|
||||||
|
/// 2-byte signed value
|
||||||
|
///
|
||||||
|
typedef short INT16;
|
||||||
|
///
|
||||||
|
/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
|
||||||
|
/// values are undefined.
|
||||||
|
///
|
||||||
|
typedef unsigned char BOOLEAN;
|
||||||
|
///
|
||||||
|
/// 1-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned char UINT8;
|
||||||
|
///
|
||||||
|
/// 1-byte Character
|
||||||
|
///
|
||||||
|
typedef char CHAR8;
|
||||||
|
///
|
||||||
|
/// 1-byte signed value
|
||||||
|
///
|
||||||
|
typedef signed char INT8;
|
||||||
|
#else
|
||||||
|
///
|
||||||
|
/// 8-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned long long UINT64;
|
||||||
|
///
|
||||||
|
/// 8-byte signed value
|
||||||
|
///
|
||||||
|
typedef long long INT64;
|
||||||
|
///
|
||||||
|
/// 4-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned int UINT32;
|
||||||
|
///
|
||||||
|
/// 4-byte signed value
|
||||||
|
///
|
||||||
|
typedef int INT32;
|
||||||
|
///
|
||||||
|
/// 2-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned short UINT16;
|
||||||
|
///
|
||||||
|
/// 2-byte Character. Unless otherwise specified all strings are stored in the
|
||||||
|
/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
|
||||||
|
///
|
||||||
|
typedef unsigned short CHAR16;
|
||||||
|
///
|
||||||
|
/// 2-byte signed value
|
||||||
|
///
|
||||||
|
typedef short INT16;
|
||||||
|
///
|
||||||
|
/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
|
||||||
|
/// values are undefined.
|
||||||
|
///
|
||||||
|
typedef unsigned char BOOLEAN;
|
||||||
|
///
|
||||||
|
/// 1-byte unsigned value
|
||||||
|
///
|
||||||
|
typedef unsigned char UINT8;
|
||||||
|
///
|
||||||
|
/// 1-byte Character
|
||||||
|
///
|
||||||
|
typedef char CHAR8;
|
||||||
|
///
|
||||||
|
/// 1-byte signed value
|
||||||
|
///
|
||||||
|
typedef signed char INT8;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
|
||||||
|
/// 8 bytes on supported 64-bit processor instructions)
|
||||||
|
///
|
||||||
|
typedef UINT64 UINTN;
|
||||||
|
///
|
||||||
|
/// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
|
||||||
|
/// 8 bytes on supported 64-bit processor instructions)
|
||||||
|
///
|
||||||
|
typedef INT64 INTN;
|
||||||
|
|
||||||
|
|
||||||
|
//
|
||||||
|
// Processor specific defines
|
||||||
|
//
|
||||||
|
|
||||||
|
///
|
||||||
|
/// A value of native width with the highest bit set.
|
||||||
|
///
|
||||||
|
#define MAX_BIT 0x8000000000000000ULL
|
||||||
|
///
|
||||||
|
/// A value of native width with the two highest bits set.
|
||||||
|
///
|
||||||
|
#define MAX_2_BITS 0xC000000000000000ULL
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Maximum legal x64 address
|
||||||
|
///
|
||||||
|
#define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Maximum legal x64 INTN and UINTN values.
|
||||||
|
///
|
||||||
|
#define MAX_INTN ((INTN)0x7FFFFFFFFFFFFFFFULL)
|
||||||
|
#define MAX_UINTN ((UINTN)0xFFFFFFFFFFFFFFFFULL)
|
||||||
|
|
||||||
|
///
|
||||||
|
/// The stack alignment required for x64
|
||||||
|
///
|
||||||
|
#define CPU_STACK_ALIGNMENT 16
|
||||||
|
|
||||||
|
//
|
||||||
|
// Modifier to ensure that all protocol member functions and EFI intrinsics
|
||||||
|
// use the correct C calling convention. All protocol member functions and
|
||||||
|
// EFI intrinsics are required to modify their member functions with EFIAPI.
|
||||||
|
//
|
||||||
|
#ifdef EFIAPI
|
||||||
|
///
|
||||||
|
/// If EFIAPI is already defined, then we use that definition.
|
||||||
|
///
|
||||||
|
#elif defined(_MSC_EXTENSIONS)
|
||||||
|
///
|
||||||
|
/// Microsoft* compiler specific method for EFIAPI calling convension
|
||||||
|
///
|
||||||
|
#define EFIAPI __cdecl
|
||||||
|
#elif defined(__GNUC__)
|
||||||
|
///
|
||||||
|
/// Define the standard calling convention reguardless of optimization level.
|
||||||
|
/// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
|
||||||
|
/// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
|
||||||
|
/// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
|
||||||
|
/// x64. Warning the assembly code in the MDE x64 does not follow the correct
|
||||||
|
/// ABI for the standard x64 (x86-64) GCC.
|
||||||
|
///
|
||||||
|
#define EFIAPI
|
||||||
|
#else
|
||||||
|
///
|
||||||
|
/// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
|
||||||
|
/// is the standard.
|
||||||
|
///
|
||||||
|
#define EFIAPI
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__GNUC__)
|
||||||
|
///
|
||||||
|
/// For GNU assembly code, .global or .globl can declare global symbols.
|
||||||
|
/// Define this macro to unify the usage.
|
||||||
|
///
|
||||||
|
#define ASM_GLOBAL .globl
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
Return the pointer to the first instruction of a function given a function pointer.
|
||||||
|
On x64 CPU architectures, these two pointer values are the same,
|
||||||
|
so the implementation of this macro is very simple.
|
||||||
|
|
||||||
|
@param FunctionPointer A pointer to a function.
|
||||||
|
|
||||||
|
@return The pointer to the first instruction of a function given a function pointer.
|
||||||
|
|
||||||
|
**/
|
||||||
|
#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)
|
||||||
|
|
||||||
|
#ifndef __USER_LABEL_PREFIX__
|
||||||
|
#define __USER_LABEL_PREFIX__
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
@ -0,0 +1,124 @@
|
||||||
|
/**
|
||||||
|
|
||||||
|
Copyright (C) 2013, Intel Corporation
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification,
|
||||||
|
are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer in the documentation and/or
|
||||||
|
other materials provided with the distribution.
|
||||||
|
* Neither the name of Intel Corporation nor the names of its contributors may
|
||||||
|
be used to endorse or promote products derived from this software without
|
||||||
|
specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
||||||
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||||
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||||
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||||
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||||
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||||
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
||||||
|
THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef __UEFI_TYPES_H__
|
||||||
|
#define __UEFI_TYPES_H__
|
||||||
|
|
||||||
|
//
|
||||||
|
// Set the UEFI types and attributes
|
||||||
|
//
|
||||||
|
#define __APPLE__ 0
|
||||||
|
#include <stdlib.h>
|
||||||
|
#include <Uefi/UefiBaseType.h>
|
||||||
|
#include <MdePkg/Include/Pi/PiBootMode.h>
|
||||||
|
#include <MdePkg/Include/Pi/PiFirmwareFile.h>
|
||||||
|
#include <MdePkg/Include/Pi/PiFirmwareVolume.h>
|
||||||
|
#include <MdePkg/Include/Uefi/UefiMultiPhase.h>
|
||||||
|
#include <MdePkg/Include/Pi/PiHob.h>
|
||||||
|
#include <MdePkg/Include/Protocol/GraphicsOutput.h>
|
||||||
|
#include <MdePkg/Include/Library/HobLib.h>
|
||||||
|
#include <MdePkg/Include/Guid/FirmwareFileSystem2.h>
|
||||||
|
#include <MdePkg/Include/IndustryStandard/PeImage.h>
|
||||||
|
|
||||||
|
///
|
||||||
|
/// For GNU assembly code, .global or .globl can declare global symbols.
|
||||||
|
/// Define this macro to unify the usage.
|
||||||
|
///
|
||||||
|
#if defined(ASM_GLOBAL)
|
||||||
|
#undef ASM_GLOBAL
|
||||||
|
#endif
|
||||||
|
#define ASM_GLOBAL .global
|
||||||
|
|
||||||
|
//
|
||||||
|
// Define the ASSERT support
|
||||||
|
//
|
||||||
|
static inline void debug_dead_loop(void)
|
||||||
|
{
|
||||||
|
for (;;)
|
||||||
|
;
|
||||||
|
}
|
||||||
|
|
||||||
|
#define _ASSERT(expression) debug_dead_loop()
|
||||||
|
#define ASSERT(expression) \
|
||||||
|
do { \
|
||||||
|
if (!(expression)) { \
|
||||||
|
_ASSERT(expression); \
|
||||||
|
} \
|
||||||
|
} while (FALSE)
|
||||||
|
|
||||||
|
//
|
||||||
|
// Contents of the PEI_GRAPHICS_INFO_HOB
|
||||||
|
//
|
||||||
|
typedef struct {
|
||||||
|
EFI_PHYSICAL_ADDRESS FrameBufferBase;
|
||||||
|
UINT64 FrameBufferSize;
|
||||||
|
EFI_GRAPHICS_OUTPUT_MODE_INFORMATION GraphicsMode;
|
||||||
|
} EFI_PEI_GRAPHICS_INFO_HOB;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Define the known GUIDs
|
||||||
|
//
|
||||||
|
#define EFI_PEI_GRAPHICS_INFO_HOB_GUID \
|
||||||
|
{ \
|
||||||
|
0x39f62cce, 0x6825, 0x4669, \
|
||||||
|
{ 0xbb, 0x56, 0x54, 0x1a, 0xba, 0x75, 0x3a, 0x07 } \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define FSP_BOOTLOADER_TEMP_MEMORY_HOB_GUID \
|
||||||
|
{ \
|
||||||
|
0xbbcff46c, 0xc8d3, 0x4113, \
|
||||||
|
{0x89, 0x85, 0xb9, 0xd4, 0xf3, 0xb3, 0xf6, 0x4e} \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define FSP_BOOTLOADER_TOLUM_HOB_GUID \
|
||||||
|
{ \
|
||||||
|
0x73ff4f56, 0xaa8e, 0x4451, \
|
||||||
|
{ 0xb3, 0x16, 0x36, 0x35, 0x36, 0x67, 0xad, 0x44 } \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define FSP_INFO_HEADER_GUID \
|
||||||
|
{ \
|
||||||
|
0x912740BE, 0x2284, 0x4734, \
|
||||||
|
{0xB9, 0x71, 0x84, 0xB0, 0x27, 0x35, 0x3F, 0x0C} \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define FSP_NON_VOLATILE_STORAGE_HOB_GUID \
|
||||||
|
{ \
|
||||||
|
0x721acf02, 0x4d77, 0x4c2a, \
|
||||||
|
{0xb3, 0xdc, 0x27, 0x0b, 0x7b, 0xa9, 0xe4, 0xb0} \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define FSP_RESERVED_MEMORY_RESOURCE_HOB_GUID \
|
||||||
|
{ \
|
||||||
|
0x69a79759, 0x1373, 0x4367, \
|
||||||
|
{ 0xa6, 0xc4, 0xc7, 0xf5, 0x9e, 0xfd, 0x98, 0x6e } \
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif /* __UEFI_TYPES_H__*/
|
Loading…
Reference in New Issue