PiFirmwareFile.h File Reference

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

#include <gpxe/efi/ProcessorBind.h>

Go to the source code of this file.

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_COMMON_SECTION_HEADER
 Common section header. More...
struct  EFI_COMPRESSION_SECTION
 An encapsulation section type in which the section data is compressed. More...
struct  EFI_FREEFORM_SUBTYPE_GUID_SECTION
 Leaf section which contains a single GUID. More...
struct  EFI_GUID_DEFINED_SECTION
 Leaf section which is encapsulation defined by specific GUID. More...
struct  EFI_USER_INTERFACE_SECTION
 Leaf section which contains a unicode string that is human readable file name. More...
struct  EFI_VERSION_SECTION
 Leaf section which contains a numeric build number and an optional unicode string that represents the file revision. More...

Defines

#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_FIRMWARE_VOLUME_IMAGE   0x0B
#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_FIXED   0x04
 FFS File Attributes.
#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 EFI_SECTION_ALL   0x00
 Pseudo type.
#define EFI_SECTION_COMPRESSION   0x01
 Encapsulation section Type values.
#define EFI_SECTION_GUID_DEFINED   0x02
#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_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)   ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))

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_HEADER EFI_DXE_DEPEX_SECTION
 Leaf section which could be used to determine the dispatch order of DXEs.
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
 Leaf section which contains a PI FV.
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
 Leaf section which contains PE32+ image.
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
 Leaf section which used to determine the dispatch order of PEIMs.
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
 Leaf section which constains the position-independent-code image.
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
 Leaf section which contains an array of zero or more bytes.


Detailed Description

The firmware file related definitions in PI.

Copyright (c) 2006 - 2008, Intel Corporation All rights reserved. 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.

Revision Reference:
PI Version 1.0

Definition in file PiFirmwareFile.h.


Define Documentation

#define EFI_FV_FILETYPE_ALL   0x00

File Types Definitions.

Definition at line 43 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_RAW   0x01

Definition at line 44 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_FREEFORM   0x02

Definition at line 45 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_SECURITY_CORE   0x03

Definition at line 46 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_PEI_CORE   0x04

Definition at line 47 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_DXE_CORE   0x05

Definition at line 48 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_PEIM   0x06

Definition at line 49 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_DRIVER   0x07

Definition at line 50 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER   0x08

Definition at line 51 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_APPLICATION   0x09

Definition at line 52 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE   0x0B

Definition at line 53 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_OEM_MIN   0xc0

Definition at line 54 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_OEM_MAX   0xdf

Definition at line 55 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_DEBUG_MIN   0xe0

Definition at line 56 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_DEBUG_MAX   0xef

Definition at line 57 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_FFS_MIN   0xf0

Definition at line 58 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_FFS_MAX   0xff

Definition at line 59 of file PiFirmwareFile.h.

#define EFI_FV_FILETYPE_FFS_PAD   0xf0

Definition at line 60 of file PiFirmwareFile.h.

#define FFS_ATTRIB_FIXED   0x04

FFS File Attributes.

Definition at line 64 of file PiFirmwareFile.h.

#define FFS_ATTRIB_DATA_ALIGNMENT   0x38

Definition at line 65 of file PiFirmwareFile.h.

#define FFS_ATTRIB_CHECKSUM   0x40

Definition at line 66 of file PiFirmwareFile.h.

#define EFI_FILE_HEADER_CONSTRUCTION   0x01

FFS File State Bits.

Definition at line 71 of file PiFirmwareFile.h.

#define EFI_FILE_HEADER_VALID   0x02

Definition at line 72 of file PiFirmwareFile.h.

#define EFI_FILE_DATA_VALID   0x04

Definition at line 73 of file PiFirmwareFile.h.

#define EFI_FILE_MARKED_FOR_UPDATE   0x08

Definition at line 74 of file PiFirmwareFile.h.

#define EFI_FILE_DELETED   0x10

Definition at line 75 of file PiFirmwareFile.h.

#define EFI_FILE_HEADER_INVALID   0x20

Definition at line 76 of file PiFirmwareFile.h.

#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 100 of file PiFirmwareFile.h.

#define EFI_SECTION_COMPRESSION   0x01

Encapsulation section Type values.

Definition at line 105 of file PiFirmwareFile.h.

#define EFI_SECTION_GUID_DEFINED   0x02

Definition at line 107 of file PiFirmwareFile.h.

#define EFI_SECTION_PE32   0x10

Leaf section Type values.

Definition at line 112 of file PiFirmwareFile.h.

#define EFI_SECTION_PIC   0x11

Definition at line 113 of file PiFirmwareFile.h.

#define EFI_SECTION_TE   0x12

Definition at line 114 of file PiFirmwareFile.h.

#define EFI_SECTION_DXE_DEPEX   0x13

Definition at line 115 of file PiFirmwareFile.h.

#define EFI_SECTION_VERSION   0x14

Definition at line 116 of file PiFirmwareFile.h.

#define EFI_SECTION_USER_INTERFACE   0x15

Definition at line 117 of file PiFirmwareFile.h.

#define EFI_SECTION_COMPATIBILITY16   0x16

Definition at line 118 of file PiFirmwareFile.h.

#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE   0x17

Definition at line 119 of file PiFirmwareFile.h.

#define EFI_SECTION_FREEFORM_SUBTYPE_GUID   0x18

Definition at line 120 of file PiFirmwareFile.h.

#define EFI_SECTION_RAW   0x19

Definition at line 121 of file PiFirmwareFile.h.

#define EFI_SECTION_PEI_DEPEX   0x1B

Definition at line 122 of file PiFirmwareFile.h.

#define EFI_NOT_COMPRESSED   0x00

CompressionType of EFI_COMPRESSION_SECTION.

Definition at line 141 of file PiFirmwareFile.h.

#define EFI_STANDARD_COMPRESSION   0x01

Definition at line 142 of file PiFirmwareFile.h.

#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED   0x01

Attributes of EFI_GUID_DEFINED_SECTION.

Definition at line 174 of file PiFirmwareFile.h.

#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID   0x02

Definition at line 175 of file PiFirmwareFile.h.

#define SECTION_SIZE ( SectionHeaderPtr   )     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))

Definition at line 236 of file PiFirmwareFile.h.


Typedef Documentation

Definition at line 36 of file PiFirmwareFile.h.

Definition at line 37 of file PiFirmwareFile.h.

Definition at line 38 of file PiFirmwareFile.h.

Definition at line 93 of file PiFirmwareFile.h.

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

Definition at line 136 of file PiFirmwareFile.h.

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

Definition at line 156 of file PiFirmwareFile.h.

Leaf section which contains a PI FV.

Definition at line 161 of file PiFirmwareFile.h.

Leaf section which contains PE32+ image.

Definition at line 189 of file PiFirmwareFile.h.

Leaf section which used to determine the dispatch order of PEIMs.

Definition at line 195 of file PiFirmwareFile.h.

Leaf section which constains the position-independent-code image.

Definition at line 200 of file PiFirmwareFile.h.

Leaf section which contains an array of zero or more bytes.

Definition at line 205 of file PiFirmwareFile.h.


Generated on Tue Apr 6 20:01:49 2010 for gPXE by  doxygen 1.5.7.1