The firmware file related definitions in PI. More...

Data Structures
union	EFI_FFS_INTEGRITY_CHECK
	Used to verify the integrity of the file. More...
struct	EFI_FFS_FILE_HEADER
	Each file begins with the header that describe the contents and state of the files. More...
struct	EFI_FFS_FILE_HEADER2
struct	EFI_COMMON_SECTION_HEADER
	Common section header. More...
struct	EFI_COMMON_SECTION_HEADER2
struct	EFI_COMPRESSION_SECTION
	An encapsulation section type in which the section data is compressed. More...
struct	EFI_COMPRESSION_SECTION2
struct	EFI_FREEFORM_SUBTYPE_GUID_SECTION
	The leaf section which contains a single GUID. More...
struct	EFI_FREEFORM_SUBTYPE_GUID_SECTION2
struct	EFI_GUID_DEFINED_SECTION
	The leaf section which is encapsulation defined by specific GUID. More...
struct	EFI_GUID_DEFINED_SECTION2
struct	EFI_USER_INTERFACE_SECTION
	The leaf section which contains a unicode string that is human readable file name. More...
struct	EFI_USER_INTERFACE_SECTION2
struct	EFI_VERSION_SECTION
	The leaf section which contains a numeric build number and an optional unicode string that represents the file revision. More...
struct	EFI_VERSION_SECTION2

Macros
#define	__PI_FIRMWARE_FILE_H__
#define	FFS_FIXED_CHECKSUM 0xAA
	FFS_FIXED_CHECKSUM is the checksum value used when the FFS_ATTRIB_CHECKSUM attribute bit is clear.
#define	EFI_FV_FILETYPE_ALL 0x00
	File Types Definitions.
#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_MM 0x0A
#define	EFI_FV_FILETYPE_SMM EFI_FV_FILETYPE_MM
#define	EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
#define	EFI_FV_FILETYPE_COMBINED_MM_DXE 0x0C
#define	EFI_FV_FILETYPE_COMBINED_SMM_DXE EFI_FV_FILETYPE_COMBINED_MM_DXE
#define	EFI_FV_FILETYPE_MM_CORE 0x0D
#define	EFI_FV_FILETYPE_SMM_CORE EFI_FV_FILETYPE_MM_CORE
#define	EFI_FV_FILETYPE_MM_STANDALONE 0x0E
#define	EFI_FV_FILETYPE_MM_CORE_STANDALONE 0x0F
#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
#define	FFS_ATTRIB_LARGE_FILE 0x01
	FFS File Attributes.
#define	FFS_ATTRIB_DATA_ALIGNMENT_2 0x02
#define	FFS_ATTRIB_FIXED 0x04
#define	FFS_ATTRIB_DATA_ALIGNMENT 0x38
#define	FFS_ATTRIB_CHECKSUM 0x40
#define	EFI_FILE_HEADER_CONSTRUCTION 0x01
	FFS File State Bits.
#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
#define	IS_FFS_FILE2(FfsFileHeaderPtr)
#define	FFS_FILE_SIZE(FfsFileHeaderPtr)
	The argument passed as the FfsFileHeaderPtr parameter to the FFS_FILE_SIZE() function-like macro below must not have side effects: FfsFileHeaderPtr is evaluated multiple times.
#define	FFS_FILE2_SIZE(FfsFileHeaderPtr)
#define	EFI_SECTION_ALL 0x00
	Pseudo type.
#define	EFI_SECTION_COMPRESSION 0x01
	Encapsulation section Type values.
#define	EFI_SECTION_GUID_DEFINED 0x02
#define	EFI_SECTION_DISPOSABLE 0x03
#define	EFI_SECTION_PE32 0x10
	Leaf section Type values.
#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_MM_DEPEX 0x1C
#define	EFI_SECTION_SMM_DEPEX EFI_SECTION_MM_DEPEX
#define	EFI_NOT_COMPRESSED 0x00
	CompressionType of EFI_COMPRESSION_SECTION.
#define	EFI_STANDARD_COMPRESSION 0x01
#define	EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
	Attributes of EFI_GUID_DEFINED_SECTION.
#define	EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
#define	SECTION_SIZE(SectionHeaderPtr)
	The argument passed as the SectionHeaderPtr parameter to the SECTION_SIZE() and IS_SECTION2() function-like macros below must not have side effects: SectionHeaderPtr is evaluated multiple times.
#define	IS_SECTION2(SectionHeaderPtr)
#define	SECTION2_SIZE(SectionHeaderPtr)

Typedefs
typedef UINT8	EFI_FV_FILETYPE
typedef UINT8	EFI_FFS_FILE_ATTRIBUTES
typedef UINT8	EFI_FFS_FILE_STATE
typedef UINT8	EFI_SECTION_TYPE
typedef EFI_COMMON_SECTION_HEADER	EFI_COMPATIBILITY16_SECTION
	Leaf section type that contains an IA-32 16-bit executable image.
typedef EFI_COMMON_SECTION_HEADER2	EFI_COMPATIBILITY16_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_DISPOSABLE_SECTION
	An encapsulation section type in which the section data is disposable.
typedef EFI_COMMON_SECTION_HEADER2	EFI_DISPOSABLE_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_DXE_DEPEX_SECTION
	The leaf section which could be used to determine the dispatch order of DXEs.
typedef EFI_COMMON_SECTION_HEADER2	EFI_DXE_DEPEX_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_FIRMWARE_VOLUME_IMAGE_SECTION
	The leaf section which contains a PI FV.
typedef EFI_COMMON_SECTION_HEADER2	EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_PE32_SECTION
	The leaf section which contains PE32+ image.
typedef EFI_COMMON_SECTION_HEADER2	EFI_PE32_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_PEI_DEPEX_SECTION
	The leaf section used to determine the dispatch order of PEIMs.
typedef EFI_COMMON_SECTION_HEADER2	EFI_PEI_DEPEX_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_PIC_SECTION
	A leaf section type that contains a position-independent-code (PIC) image.
typedef EFI_COMMON_SECTION_HEADER2	EFI_PIC_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_TE_SECTION
	The leaf section which constains the position-independent-code image.
typedef EFI_COMMON_SECTION_HEADER2	EFI_TE_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_RAW_SECTION
	The leaf section which contains an array of zero or more bytes.
typedef EFI_COMMON_SECTION_HEADER2	EFI_RAW_SECTION2
typedef EFI_COMMON_SECTION_HEADER	EFI_SMM_DEPEX_SECTION
	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.
typedef EFI_COMMON_SECTION_HEADER2	EFI_SMM_DEPEX_SECTION2

Functions
	FILE_LICENCE (BSD2_PATENT)
	FILE_SECBOOT (PERMITTED)

Detailed Description

The firmware file related definitions in PI.

Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:: PI Version 1.6.

Definition in file PiFirmwareFile.h.

Macro Definition Documentation

◆ __PI_FIRMWARE_FILE_H__

#define __PI_FIRMWARE_FILE_H__

Definition at line 18 of file PiFirmwareFile.h.

◆ FFS_FIXED_CHECKSUM

#define FFS_FIXED_CHECKSUM 0xAA

FFS_FIXED_CHECKSUM is the checksum value used when the FFS_ATTRIB_CHECKSUM attribute bit is clear.

Definition at line 53 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_ALL

#define EFI_FV_FILETYPE_ALL 0x00

File Types Definitions.

Definition at line 62 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_RAW

#define EFI_FV_FILETYPE_RAW 0x01

Definition at line 63 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_FREEFORM

#define EFI_FV_FILETYPE_FREEFORM 0x02

Definition at line 64 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_SECURITY_CORE

#define EFI_FV_FILETYPE_SECURITY_CORE 0x03

Definition at line 65 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_PEI_CORE

#define EFI_FV_FILETYPE_PEI_CORE 0x04

Definition at line 66 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_DXE_CORE

#define EFI_FV_FILETYPE_DXE_CORE 0x05

Definition at line 67 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_PEIM

#define EFI_FV_FILETYPE_PEIM 0x06

Definition at line 68 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_DRIVER

#define EFI_FV_FILETYPE_DRIVER 0x07

Definition at line 69 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER

#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08

Definition at line 70 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_APPLICATION

#define EFI_FV_FILETYPE_APPLICATION 0x09

Definition at line 71 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_MM

#define EFI_FV_FILETYPE_MM 0x0A

Definition at line 72 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_SMM

#define EFI_FV_FILETYPE_SMM EFI_FV_FILETYPE_MM

Definition at line 73 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE

#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B

Definition at line 74 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_COMBINED_MM_DXE

#define EFI_FV_FILETYPE_COMBINED_MM_DXE 0x0C

Definition at line 75 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_COMBINED_SMM_DXE

#define EFI_FV_FILETYPE_COMBINED_SMM_DXE EFI_FV_FILETYPE_COMBINED_MM_DXE

Definition at line 76 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_MM_CORE

#define EFI_FV_FILETYPE_MM_CORE 0x0D

Definition at line 77 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_SMM_CORE

#define EFI_FV_FILETYPE_SMM_CORE EFI_FV_FILETYPE_MM_CORE

Definition at line 78 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_MM_STANDALONE

#define EFI_FV_FILETYPE_MM_STANDALONE 0x0E

Definition at line 79 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_MM_CORE_STANDALONE

#define EFI_FV_FILETYPE_MM_CORE_STANDALONE 0x0F

Definition at line 80 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_OEM_MIN

#define EFI_FV_FILETYPE_OEM_MIN 0xc0

Definition at line 81 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_OEM_MAX

#define EFI_FV_FILETYPE_OEM_MAX 0xdf

Definition at line 82 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_DEBUG_MIN

#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0

Definition at line 83 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_DEBUG_MAX

#define EFI_FV_FILETYPE_DEBUG_MAX 0xef

Definition at line 84 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_FFS_MIN

#define EFI_FV_FILETYPE_FFS_MIN 0xf0

Definition at line 85 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_FFS_MAX

#define EFI_FV_FILETYPE_FFS_MAX 0xff

Definition at line 86 of file PiFirmwareFile.h.

◆ EFI_FV_FILETYPE_FFS_PAD

#define EFI_FV_FILETYPE_FFS_PAD 0xf0

Definition at line 87 of file PiFirmwareFile.h.

◆ FFS_ATTRIB_LARGE_FILE

#define FFS_ATTRIB_LARGE_FILE 0x01

FFS File Attributes.

Definition at line 91 of file PiFirmwareFile.h.

◆ FFS_ATTRIB_DATA_ALIGNMENT_2

#define FFS_ATTRIB_DATA_ALIGNMENT_2 0x02

Definition at line 92 of file PiFirmwareFile.h.

◆ FFS_ATTRIB_FIXED

#define FFS_ATTRIB_FIXED 0x04

Definition at line 93 of file PiFirmwareFile.h.

◆ FFS_ATTRIB_DATA_ALIGNMENT

#define FFS_ATTRIB_DATA_ALIGNMENT 0x38

Definition at line 94 of file PiFirmwareFile.h.

◆ FFS_ATTRIB_CHECKSUM

#define FFS_ATTRIB_CHECKSUM 0x40

Definition at line 95 of file PiFirmwareFile.h.

◆ EFI_FILE_HEADER_CONSTRUCTION

#define EFI_FILE_HEADER_CONSTRUCTION 0x01

FFS File State Bits.

Definition at line 100 of file PiFirmwareFile.h.

◆ EFI_FILE_HEADER_VALID

#define EFI_FILE_HEADER_VALID 0x02

Definition at line 101 of file PiFirmwareFile.h.

◆ EFI_FILE_DATA_VALID

#define EFI_FILE_DATA_VALID 0x04

Definition at line 102 of file PiFirmwareFile.h.

◆ EFI_FILE_MARKED_FOR_UPDATE

#define EFI_FILE_MARKED_FOR_UPDATE 0x08

Definition at line 103 of file PiFirmwareFile.h.

◆ EFI_FILE_DELETED

#define EFI_FILE_DELETED 0x10

Definition at line 104 of file PiFirmwareFile.h.

◆ EFI_FILE_HEADER_INVALID

#define EFI_FILE_HEADER_INVALID 0x20

Definition at line 105 of file PiFirmwareFile.h.

◆ IS_FFS_FILE2

#define IS_FFS_FILE2 ( FfsFileHeaderPtr )

Value:

(((((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Attributes) & FFS_ATTRIB_LARGE_FILE) == FFS_ATTRIB_LARGE_FILE)

UINTN

UINT64 UINTN

Unsigned value of native width.

Definition ProcessorBind.h:114

FFS_ATTRIB_LARGE_FILE

#define FFS_ATTRIB_LARGE_FILE

FFS File Attributes.

Definition PiFirmwareFile.h:91

EFI_FFS_FILE_HEADER

Each file begins with the header that describe the contents and state of the files.

Definition PiFirmwareFile.h:111

Definition at line 182 of file PiFirmwareFile.h.

182#define IS_FFS_FILE2(FfsFileHeaderPtr) \

183 (((((EFI_FFS_FILE_HEADER *) (UINTN) FfsFileHeaderPtr)->Attributes) & FFS_ATTRIB_LARGE_FILE) == FFS_ATTRIB_LARGE_FILE)

◆ FFS_FILE_SIZE

#define FFS_FILE_SIZE ( FfsFileHeaderPtr )

Value:

    ((UINT32) (\
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[0]      ) | \
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[1] <<  8) | \
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[2] << 16)))

The argument passed as the FfsFileHeaderPtr parameter to the FFS_FILE_SIZE() function-like macro below must not have side effects: FfsFileHeaderPtr is evaluated multiple times.

Definition at line 190 of file PiFirmwareFile.h.

#define FFS_FILE_SIZE(FfsFileHeaderPtr)  ((UINT32) (\
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[0]      ) | \
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[1] <<  8) | \
    (((EFI_FFS_FILE_HEADER *) (UINTN) (FfsFileHeaderPtr))->Size[2] << 16)))

◆ FFS_FILE2_SIZE

#define FFS_FILE2_SIZE ( FfsFileHeaderPtr )

Value:

((UINT32) (((EFI_FFS_FILE_HEADER2 *) (UINTN) FfsFileHeaderPtr)->ExtendedSize))

EFI_FFS_FILE_HEADER2

Definition PiFirmwareFile.h:138

Definition at line 195 of file PiFirmwareFile.h.

195#define FFS_FILE2_SIZE(FfsFileHeaderPtr) \

196 ((UINT32) (((EFI_FFS_FILE_HEADER2 *) (UINTN) FfsFileHeaderPtr)->ExtendedSize))

◆ EFI_SECTION_ALL

#define EFI_SECTION_ALL 0x00

Pseudo type.

It is used as a wild card when retrieving sections. The section type EFI_SECTION_ALL matches all section types.

Definition at line 204 of file PiFirmwareFile.h.

◆ EFI_SECTION_COMPRESSION

#define EFI_SECTION_COMPRESSION 0x01

Encapsulation section Type values.

Definition at line 209 of file PiFirmwareFile.h.

◆ EFI_SECTION_GUID_DEFINED

#define EFI_SECTION_GUID_DEFINED 0x02

Definition at line 211 of file PiFirmwareFile.h.

◆ EFI_SECTION_DISPOSABLE

#define EFI_SECTION_DISPOSABLE 0x03

Definition at line 213 of file PiFirmwareFile.h.

◆ EFI_SECTION_PE32

#define EFI_SECTION_PE32 0x10

Leaf section Type values.

Definition at line 218 of file PiFirmwareFile.h.

◆ EFI_SECTION_PIC

#define EFI_SECTION_PIC 0x11

Definition at line 219 of file PiFirmwareFile.h.

◆ EFI_SECTION_TE

#define EFI_SECTION_TE 0x12

Definition at line 220 of file PiFirmwareFile.h.

◆ EFI_SECTION_DXE_DEPEX

#define EFI_SECTION_DXE_DEPEX 0x13

Definition at line 221 of file PiFirmwareFile.h.

◆ EFI_SECTION_VERSION

#define EFI_SECTION_VERSION 0x14

Definition at line 222 of file PiFirmwareFile.h.

◆ EFI_SECTION_USER_INTERFACE

#define EFI_SECTION_USER_INTERFACE 0x15

Definition at line 223 of file PiFirmwareFile.h.

◆ EFI_SECTION_COMPATIBILITY16

#define EFI_SECTION_COMPATIBILITY16 0x16

Definition at line 224 of file PiFirmwareFile.h.

◆ EFI_SECTION_FIRMWARE_VOLUME_IMAGE

#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17

Definition at line 225 of file PiFirmwareFile.h.

◆ EFI_SECTION_FREEFORM_SUBTYPE_GUID

#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18

Definition at line 226 of file PiFirmwareFile.h.

◆ EFI_SECTION_RAW

#define EFI_SECTION_RAW 0x19

Definition at line 227 of file PiFirmwareFile.h.

◆ EFI_SECTION_PEI_DEPEX

#define EFI_SECTION_PEI_DEPEX 0x1B

Definition at line 228 of file PiFirmwareFile.h.

◆ EFI_SECTION_MM_DEPEX

#define EFI_SECTION_MM_DEPEX 0x1C

Definition at line 229 of file PiFirmwareFile.h.

◆ EFI_SECTION_SMM_DEPEX

#define EFI_SECTION_SMM_DEPEX EFI_SECTION_MM_DEPEX

Definition at line 230 of file PiFirmwareFile.h.

◆ EFI_NOT_COMPRESSED

#define EFI_NOT_COMPRESSED 0x00

CompressionType of EFI_COMPRESSION_SECTION.

Definition at line 273 of file PiFirmwareFile.h.

◆ EFI_STANDARD_COMPRESSION

#define EFI_STANDARD_COMPRESSION 0x01

Definition at line 274 of file PiFirmwareFile.h.

◆ EFI_GUIDED_SECTION_PROCESSING_REQUIRED

#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01

Attributes of EFI_GUID_DEFINED_SECTION.

Definition at line 361 of file PiFirmwareFile.h.

◆ EFI_GUIDED_SECTION_AUTH_STATUS_VALID

#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02

Definition at line 362 of file PiFirmwareFile.h.

◆ SECTION_SIZE

#define SECTION_SIZE ( SectionHeaderPtr )

Value:

    ((UINT32) (\
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[0]      ) | \
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[1] <<  8) | \
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[2] << 16)))

The argument passed as the SectionHeaderPtr parameter to the SECTION_SIZE() and IS_SECTION2() function-like macros below must not have side effects: SectionHeaderPtr is evaluated multiple times.

Definition at line 498 of file PiFirmwareFile.h.

#define SECTION_SIZE(SectionHeaderPtr)  ((UINT32) (\
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[0]      ) | \
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[1] <<  8) | \
    (((EFI_COMMON_SECTION_HEADER *) (UINTN) (SectionHeaderPtr))->Size[2] << 16)))

◆ IS_SECTION2

#define IS_SECTION2 ( SectionHeaderPtr )

Value:

(SECTION_SIZE (SectionHeaderPtr) == 0x00ffffff)

SECTION_SIZE

#define SECTION_SIZE(SectionHeaderPtr)

The argument passed as the SectionHeaderPtr parameter to the SECTION_SIZE() and IS_SECTION2() functio...

Definition PiFirmwareFile.h:498

Definition at line 503 of file PiFirmwareFile.h.

503#define IS_SECTION2(SectionHeaderPtr) \

504 (SECTION_SIZE (SectionHeaderPtr) == 0x00ffffff)

◆ SECTION2_SIZE

#define SECTION2_SIZE ( SectionHeaderPtr )

Value:

(((EFI_COMMON_SECTION_HEADER2 *) (UINTN) SectionHeaderPtr)->ExtendedSize)

EFI_COMMON_SECTION_HEADER2

Definition PiFirmwareFile.h:247

Definition at line 506 of file PiFirmwareFile.h.

506#define SECTION2_SIZE(SectionHeaderPtr) \

507 (((EFI_COMMON_SECTION_HEADER2 *) (UINTN) SectionHeaderPtr)->ExtendedSize)

Typedef Documentation

◆ EFI_FV_FILETYPE

typedef UINT8 EFI_FV_FILETYPE

Definition at line 55 of file PiFirmwareFile.h.

◆ EFI_FFS_FILE_ATTRIBUTES

typedef UINT8 EFI_FFS_FILE_ATTRIBUTES

Definition at line 56 of file PiFirmwareFile.h.

◆ EFI_FFS_FILE_STATE

typedef UINT8 EFI_FFS_FILE_STATE

Definition at line 57 of file PiFirmwareFile.h.

◆ EFI_SECTION_TYPE

typedef UINT8 EFI_SECTION_TYPE

Definition at line 198 of file PiFirmwareFile.h.

◆ EFI_COMPATIBILITY16_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION

Leaf section type that contains an IA-32 16-bit executable image.

Definition at line 267 of file PiFirmwareFile.h.

◆ EFI_COMPATIBILITY16_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2

Definition at line 268 of file PiFirmwareFile.h.

◆ EFI_DISPOSABLE_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION

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.

Definition at line 318 of file PiFirmwareFile.h.

◆ EFI_DISPOSABLE_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2

Definition at line 319 of file PiFirmwareFile.h.

◆ EFI_DXE_DEPEX_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION

The leaf section which could be used to determine the dispatch order of DXEs.

Definition at line 324 of file PiFirmwareFile.h.

◆ EFI_DXE_DEPEX_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2

Definition at line 325 of file PiFirmwareFile.h.

◆ EFI_FIRMWARE_VOLUME_IMAGE_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION

The leaf section which contains a PI FV.

Definition at line 330 of file PiFirmwareFile.h.

◆ EFI_FIRMWARE_VOLUME_IMAGE_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2

Definition at line 331 of file PiFirmwareFile.h.

◆ EFI_PE32_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION

The leaf section which contains PE32+ image.

Definition at line 407 of file PiFirmwareFile.h.

◆ EFI_PE32_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2

Definition at line 408 of file PiFirmwareFile.h.

◆ EFI_PEI_DEPEX_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION

The leaf section used to determine the dispatch order of PEIMs.

Definition at line 413 of file PiFirmwareFile.h.

◆ EFI_PEI_DEPEX_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2

Definition at line 414 of file PiFirmwareFile.h.

◆ EFI_PIC_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION

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.

Definition at line 425 of file PiFirmwareFile.h.

◆ EFI_PIC_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2

Definition at line 426 of file PiFirmwareFile.h.

◆ EFI_TE_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION

The leaf section which constains the position-independent-code image.

Definition at line 431 of file PiFirmwareFile.h.

◆ EFI_TE_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2

Definition at line 432 of file PiFirmwareFile.h.

◆ EFI_RAW_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION

The leaf section which contains an array of zero or more bytes.

Definition at line 437 of file PiFirmwareFile.h.

◆ EFI_RAW_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2

Definition at line 438 of file PiFirmwareFile.h.

◆ EFI_SMM_DEPEX_SECTION

typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION

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.

Definition at line 448 of file PiFirmwareFile.h.

◆ EFI_SMM_DEPEX_SECTION2

typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2

Definition at line 449 of file PiFirmwareFile.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ __PI_FIRMWARE_FILE_H__

◆ FFS_FIXED_CHECKSUM

◆ EFI_FV_FILETYPE_ALL

◆ EFI_FV_FILETYPE_RAW

◆ EFI_FV_FILETYPE_FREEFORM

◆ EFI_FV_FILETYPE_SECURITY_CORE

◆ EFI_FV_FILETYPE_PEI_CORE

◆ EFI_FV_FILETYPE_DXE_CORE

◆ EFI_FV_FILETYPE_PEIM

◆ EFI_FV_FILETYPE_DRIVER

◆ EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER

◆ EFI_FV_FILETYPE_APPLICATION

◆ EFI_FV_FILETYPE_MM

◆ EFI_FV_FILETYPE_SMM

◆ EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE

◆ EFI_FV_FILETYPE_COMBINED_MM_DXE

◆ EFI_FV_FILETYPE_COMBINED_SMM_DXE

◆ EFI_FV_FILETYPE_MM_CORE

◆ EFI_FV_FILETYPE_SMM_CORE

◆ EFI_FV_FILETYPE_MM_STANDALONE

◆ EFI_FV_FILETYPE_MM_CORE_STANDALONE

◆ EFI_FV_FILETYPE_OEM_MIN

◆ EFI_FV_FILETYPE_OEM_MAX

◆ EFI_FV_FILETYPE_DEBUG_MIN

◆ EFI_FV_FILETYPE_DEBUG_MAX

◆ EFI_FV_FILETYPE_FFS_MIN

◆ EFI_FV_FILETYPE_FFS_MAX

◆ EFI_FV_FILETYPE_FFS_PAD

◆ FFS_ATTRIB_LARGE_FILE

◆ FFS_ATTRIB_DATA_ALIGNMENT_2

◆ FFS_ATTRIB_FIXED

◆ FFS_ATTRIB_DATA_ALIGNMENT

◆ FFS_ATTRIB_CHECKSUM

◆ EFI_FILE_HEADER_CONSTRUCTION

◆ EFI_FILE_HEADER_VALID

◆ EFI_FILE_DATA_VALID

◆ EFI_FILE_MARKED_FOR_UPDATE

◆ EFI_FILE_DELETED

◆ EFI_FILE_HEADER_INVALID

◆ IS_FFS_FILE2

◆ FFS_FILE_SIZE

◆ FFS_FILE2_SIZE

◆ EFI_SECTION_ALL

◆ EFI_SECTION_COMPRESSION

◆ EFI_SECTION_GUID_DEFINED

◆ EFI_SECTION_DISPOSABLE

◆ EFI_SECTION_PE32

◆ EFI_SECTION_PIC

◆ EFI_SECTION_TE

◆ EFI_SECTION_DXE_DEPEX

◆ EFI_SECTION_VERSION

◆ EFI_SECTION_USER_INTERFACE

◆ EFI_SECTION_COMPATIBILITY16

◆ EFI_SECTION_FIRMWARE_VOLUME_IMAGE

◆ EFI_SECTION_FREEFORM_SUBTYPE_GUID

◆ EFI_SECTION_RAW

◆ EFI_SECTION_PEI_DEPEX

◆ EFI_SECTION_MM_DEPEX

◆ EFI_SECTION_SMM_DEPEX

◆ EFI_NOT_COMPRESSED

◆ EFI_STANDARD_COMPRESSION

◆ EFI_GUIDED_SECTION_PROCESSING_REQUIRED

◆ EFI_GUIDED_SECTION_AUTH_STATUS_VALID

◆ SECTION_SIZE

◆ IS_SECTION2

◆ SECTION2_SIZE

Typedef Documentation

◆ EFI_FV_FILETYPE

◆ EFI_FFS_FILE_ATTRIBUTES

◆ EFI_FFS_FILE_STATE

◆ EFI_SECTION_TYPE

◆ EFI_COMPATIBILITY16_SECTION

◆ EFI_COMPATIBILITY16_SECTION2

◆ EFI_DISPOSABLE_SECTION