iPXE
Data Structures | Macros | Typedefs | Functions
PiFirmwareVolume.h File Reference

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

Go to the source code of this file.

Data Structures

struct  EFI_FV_BLOCK_MAP_ENTRY
 
struct  EFI_FIRMWARE_VOLUME_HEADER
 Describes the features and layout of the firmware volume. More...
 
struct  EFI_FIRMWARE_VOLUME_EXT_HEADER
 Extension header pointed by ExtHeaderOffset of volume header. More...
 
struct  EFI_FIRMWARE_VOLUME_EXT_ENTRY
 Entry struture for describing FV extension header. More...
 
struct  EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE
 This extension header provides a mapping between a GUID and an OEM file type. More...
 
struct  EFI_FIRMWARE_VOLUME_EXT_ENTRY_GUID_TYPE
 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. More...
 
struct  EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE
 The EFI_FIRMWARE_VOLUME_EXT_ENTRY_USED_SIZE_TYPE can be used to find out how many EFI_FVB2_ERASE_POLARITY bytes are at the end of the FV. More...
 

Macros

#define EFI_FV_FILE_ATTRIB_ALIGNMENT   0x0000001F
 
#define EFI_FV_FILE_ATTRIB_FIXED   0x00000100
 
#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED   0x00000200
 
#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
 
#define EFI_FVH_SIGNATURE   SIGNATURE_32 ('_', 'F', 'V', 'H')
 
#define EFI_FVH_REVISION   0x02
 Firmware Volume Header Revision definition. More...
 
#define EFI_FV_EXT_TYPE_OEM_TYPE   0x01
 
#define EFI_FV_EXT_TYPE_GUID_TYPE   0x0002
 
#define EFI_FV_EXT_TYPE_USED_SIZE_TYPE   0x03
 

Typedefs

typedef UINT32 EFI_FV_FILE_ATTRIBUTES
 EFI_FV_FILE_ATTRIBUTES. More...
 
typedef UINT32 EFI_FVB_ATTRIBUTES_2
 type of EFI FVB attribute More...
 

Functions

 FILE_LICENCE (BSD2_PATENT)
 

Detailed Description

The firmware volume 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 PiFirmwareVolume.h.

Macro Definition Documentation

◆ EFI_FV_FILE_ATTRIB_ALIGNMENT

#define EFI_FV_FILE_ATTRIB_ALIGNMENT   0x0000001F

Definition at line 25 of file PiFirmwareVolume.h.

◆ EFI_FV_FILE_ATTRIB_FIXED

#define EFI_FV_FILE_ATTRIB_FIXED   0x00000100

Definition at line 26 of file PiFirmwareVolume.h.

◆ EFI_FV_FILE_ATTRIB_MEMORY_MAPPED

#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED   0x00000200

Definition at line 27 of file PiFirmwareVolume.h.

◆ EFI_FVB2_READ_DISABLED_CAP

#define EFI_FVB2_READ_DISABLED_CAP   0x00000001

Definition at line 37 of file PiFirmwareVolume.h.

◆ EFI_FVB2_READ_ENABLED_CAP

#define EFI_FVB2_READ_ENABLED_CAP   0x00000002

Definition at line 38 of file PiFirmwareVolume.h.

◆ EFI_FVB2_READ_STATUS

#define EFI_FVB2_READ_STATUS   0x00000004

Definition at line 39 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WRITE_DISABLED_CAP

#define EFI_FVB2_WRITE_DISABLED_CAP   0x00000008

Definition at line 40 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WRITE_ENABLED_CAP

#define EFI_FVB2_WRITE_ENABLED_CAP   0x00000010

Definition at line 41 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WRITE_STATUS

#define EFI_FVB2_WRITE_STATUS   0x00000020

Definition at line 42 of file PiFirmwareVolume.h.

◆ EFI_FVB2_LOCK_CAP

#define EFI_FVB2_LOCK_CAP   0x00000040

Definition at line 43 of file PiFirmwareVolume.h.

◆ EFI_FVB2_LOCK_STATUS

#define EFI_FVB2_LOCK_STATUS   0x00000080

Definition at line 44 of file PiFirmwareVolume.h.

◆ EFI_FVB2_STICKY_WRITE

#define EFI_FVB2_STICKY_WRITE   0x00000200

Definition at line 45 of file PiFirmwareVolume.h.

◆ EFI_FVB2_MEMORY_MAPPED

#define EFI_FVB2_MEMORY_MAPPED   0x00000400

Definition at line 46 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ERASE_POLARITY

#define EFI_FVB2_ERASE_POLARITY   0x00000800

Definition at line 47 of file PiFirmwareVolume.h.

◆ EFI_FVB2_READ_LOCK_CAP

#define EFI_FVB2_READ_LOCK_CAP   0x00001000

Definition at line 48 of file PiFirmwareVolume.h.

◆ EFI_FVB2_READ_LOCK_STATUS

#define EFI_FVB2_READ_LOCK_STATUS   0x00002000

Definition at line 49 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WRITE_LOCK_CAP

#define EFI_FVB2_WRITE_LOCK_CAP   0x00004000

Definition at line 50 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WRITE_LOCK_STATUS

#define EFI_FVB2_WRITE_LOCK_STATUS   0x00008000

Definition at line 51 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT

#define EFI_FVB2_ALIGNMENT   0x001F0000

Definition at line 52 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_1

#define EFI_FVB2_ALIGNMENT_1   0x00000000

Definition at line 53 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_2

#define EFI_FVB2_ALIGNMENT_2   0x00010000

Definition at line 54 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_4

#define EFI_FVB2_ALIGNMENT_4   0x00020000

Definition at line 55 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_8

#define EFI_FVB2_ALIGNMENT_8   0x00030000

Definition at line 56 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_16

#define EFI_FVB2_ALIGNMENT_16   0x00040000

Definition at line 57 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_32

#define EFI_FVB2_ALIGNMENT_32   0x00050000

Definition at line 58 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_64

#define EFI_FVB2_ALIGNMENT_64   0x00060000

Definition at line 59 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_128

#define EFI_FVB2_ALIGNMENT_128   0x00070000

Definition at line 60 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_256

#define EFI_FVB2_ALIGNMENT_256   0x00080000

Definition at line 61 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_512

#define EFI_FVB2_ALIGNMENT_512   0x00090000

Definition at line 62 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_1K

#define EFI_FVB2_ALIGNMENT_1K   0x000A0000

Definition at line 63 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_2K

#define EFI_FVB2_ALIGNMENT_2K   0x000B0000

Definition at line 64 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_4K

#define EFI_FVB2_ALIGNMENT_4K   0x000C0000

Definition at line 65 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_8K

#define EFI_FVB2_ALIGNMENT_8K   0x000D0000

Definition at line 66 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_16K

#define EFI_FVB2_ALIGNMENT_16K   0x000E0000

Definition at line 67 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_32K

#define EFI_FVB2_ALIGNMENT_32K   0x000F0000

Definition at line 68 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_64K

#define EFI_FVB2_ALIGNMENT_64K   0x00100000

Definition at line 69 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_128K

#define EFI_FVB2_ALIGNMENT_128K   0x00110000

Definition at line 70 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_256K

#define EFI_FVB2_ALIGNMENT_256K   0x00120000

Definition at line 71 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_512K

#define EFI_FVB2_ALIGNMENT_512K   0x00130000

Definition at line 72 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_1M

#define EFI_FVB2_ALIGNMENT_1M   0x00140000

Definition at line 73 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_2M

#define EFI_FVB2_ALIGNMENT_2M   0x00150000

Definition at line 74 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_4M

#define EFI_FVB2_ALIGNMENT_4M   0x00160000

Definition at line 75 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_8M

#define EFI_FVB2_ALIGNMENT_8M   0x00170000

Definition at line 76 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_16M

#define EFI_FVB2_ALIGNMENT_16M   0x00180000

Definition at line 77 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_32M

#define EFI_FVB2_ALIGNMENT_32M   0x00190000

Definition at line 78 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_64M

#define EFI_FVB2_ALIGNMENT_64M   0x001A0000

Definition at line 79 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_128M

#define EFI_FVB2_ALIGNMENT_128M   0x001B0000

Definition at line 80 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_256M

#define EFI_FVB2_ALIGNMENT_256M   0x001C0000

Definition at line 81 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_512M

#define EFI_FVB2_ALIGNMENT_512M   0x001D0000

Definition at line 82 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_1G

#define EFI_FVB2_ALIGNMENT_1G   0x001E0000

Definition at line 83 of file PiFirmwareVolume.h.

◆ EFI_FVB2_ALIGNMENT_2G

#define EFI_FVB2_ALIGNMENT_2G   0x001F0000

Definition at line 84 of file PiFirmwareVolume.h.

◆ EFI_FVB2_WEAK_ALIGNMENT

#define EFI_FVB2_WEAK_ALIGNMENT   0x80000000

Definition at line 85 of file PiFirmwareVolume.h.

◆ EFI_FVH_SIGNATURE

#define EFI_FVH_SIGNATURE   SIGNATURE_32 ('_', 'F', 'V', 'H')

Definition at line 152 of file PiFirmwareVolume.h.

◆ EFI_FVH_REVISION

#define EFI_FVH_REVISION   0x02

Firmware Volume Header Revision definition.

Definition at line 157 of file PiFirmwareVolume.h.

◆ EFI_FV_EXT_TYPE_OEM_TYPE

#define EFI_FV_EXT_TYPE_OEM_TYPE   0x01

Definition at line 187 of file PiFirmwareVolume.h.

◆ EFI_FV_EXT_TYPE_GUID_TYPE

#define EFI_FV_EXT_TYPE_GUID_TYPE   0x0002

Definition at line 208 of file PiFirmwareVolume.h.

◆ EFI_FV_EXT_TYPE_USED_SIZE_TYPE

#define EFI_FV_EXT_TYPE_USED_SIZE_TYPE   0x03

Definition at line 230 of file PiFirmwareVolume.h.

Typedef Documentation

◆ EFI_FV_FILE_ATTRIBUTES

EFI_FV_FILE_ATTRIBUTES.

Definition at line 20 of file PiFirmwareVolume.h.

◆ EFI_FVB_ATTRIBUTES_2

type of EFI FVB attribute

Definition at line 32 of file PiFirmwareVolume.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT  )