mirror of https://github.com/acidanthera/audk.git
155 lines
5.0 KiB
C
155 lines
5.0 KiB
C
/** @file
|
|
The firmware volume related definitions in PI.
|
|
|
|
Copyright (c) 2006 - 2007, 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.
|
|
|
|
@par Revision Reference:
|
|
Version 1.0.
|
|
|
|
**/
|
|
|
|
#ifndef __PI_FIRMWAREVOLUME_H__
|
|
#define __PI_FIRMWAREVOLUME_H__
|
|
|
|
#include <ProcessorBind.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_ALIGNMNET_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
|
|
|
|
|
|
typedef struct {
|
|
UINT32 NumBlocks;
|
|
UINT32 Length;
|
|
} EFI_FV_BLOCK_MAP_ENTRY;
|
|
|
|
///
|
|
/// Describes the features and layout of the firmware volume.
|
|
///
|
|
typedef struct {
|
|
UINT8 ZeroVector[16];
|
|
EFI_GUID FileSystemGuid;
|
|
UINT64 FvLength;
|
|
UINT32 Signature;
|
|
EFI_FVB_ATTRIBUTES_2 Attributes;
|
|
UINT16 HeaderLength;
|
|
UINT16 Checksum;
|
|
UINT16 ExtHeaderOffset;
|
|
UINT8 Reserved[1];
|
|
UINT8 Revision;
|
|
EFI_FV_BLOCK_MAP_ENTRY BlockMap[1];
|
|
} EFI_FIRMWARE_VOLUME_HEADER;
|
|
|
|
#define EFI_FVH_SIGNATURE EFI_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 {
|
|
EFI_GUID FvName;
|
|
UINT32 ExtHeaderSize;
|
|
} EFI_FIRMWARE_VOLUME_EXT_HEADER;
|
|
|
|
///
|
|
/// Entry struture for describing FV extension header
|
|
///
|
|
typedef struct {
|
|
UINT16 ExtEntrySize;
|
|
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 {
|
|
EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;
|
|
UINT32 TypeMask;
|
|
|
|
//
|
|
// Array of GUIDs.
|
|
// Each GUID represents an OEM file type.
|
|
//
|
|
EFI_GUID Types[1];
|
|
} EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;
|
|
|
|
|
|
#endif
|