iPXE
UefiGpt.h
Go to the documentation of this file.
1 /** @file
2  EFI Guid Partition Table Format Definition.
3 
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
9 
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 
13 **/
14 
15 #ifndef __UEFI_GPT_H__
16 #define __UEFI_GPT_H__
17 
18 FILE_LICENCE ( BSD3 );
19 
20 ///
21 /// The primary GUID Partition Table Header must be
22 /// located in LBA 1 (i.e., the second logical block).
23 ///
24 #define PRIMARY_PART_HEADER_LBA 1
25 ///
26 /// EFI Partition Table Signature: "EFI PART".
27 ///
28 #define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T')
29 
30 #pragma pack(1)
31 
32 ///
33 /// GPT Partition Table Header.
34 ///
35 typedef struct {
36  ///
37  /// The table header for the GPT partition Table.
38  /// This header contains EFI_PTAB_HEADER_ID.
39  ///
41  ///
42  /// The LBA that contains this data structure.
43  ///
45  ///
46  /// LBA address of the alternate GUID Partition Table Header.
47  ///
49  ///
50  /// The first usable logical block that may be used
51  /// by a partition described by a GUID Partition Entry.
52  ///
54  ///
55  /// The last usable logical block that may be used
56  /// by a partition described by a GUID Partition Entry.
57  ///
59  ///
60  /// GUID that can be used to uniquely identify the disk.
61  ///
63  ///
64  /// The starting LBA of the GUID Partition Entry array.
65  ///
67  ///
68  /// The number of Partition Entries in the GUID Partition Entry array.
69  ///
71  ///
72  /// The size, in bytes, of each the GUID Partition
73  /// Entry structures in the GUID Partition Entry
74  /// array. This field shall be set to a value of 128 x 2^n where n is
75  /// an integer greater than or equal to zero (e.g., 128, 256, 512, etc.).
76  ///
78  ///
79  /// The CRC32 of the GUID Partition Entry array.
80  /// Starts at PartitionEntryLBA and is
81  /// computed over a byte length of
82  /// NumberOfPartitionEntries * SizeOfPartitionEntry.
83  ///
86 
87 ///
88 /// GPT Partition Entry.
89 ///
90 typedef struct {
91  ///
92  /// Unique ID that defines the purpose and type of this Partition. A value of
93  /// zero defines that this partition entry is not being used.
94  ///
96  ///
97  /// GUID that is unique for every partition entry. Every partition ever
98  /// created will have a unique GUID.
99  /// This GUID must be assigned when the GUID Partition Entry is created.
100  ///
102  ///
103  /// Starting LBA of the partition defined by this entry
104  ///
106  ///
107  /// Ending LBA of the partition defined by this entry.
108  ///
110  ///
111  /// Attribute bits, all bits reserved by UEFI
112  /// Bit 0: If this bit is set, the partition is required for the platform to function. The owner/creator of the
113  /// partition indicates that deletion or modification of the contents can result in loss of platform
114  /// features or failure for the platform to boot or operate. The system cannot function normally if
115  /// this partition is removed, and it should be considered part of the hardware of the system.
116  /// Actions such as running diagnostics, system recovery, or even OS install or boot, could
117  /// potentially stop working if this partition is removed. Unless OS software or firmware
118  /// recognizes this partition, it should never be removed or modified as the UEFI firmware or
119  /// platform hardware may become non-functional.
120  /// Bit 1: If this bit is set, then firmware must not produce an EFI_BLOCK_IO_PROTOCOL device for
121  /// this partition. By not producing an EFI_BLOCK_IO_PROTOCOL partition, file system
122  /// mappings will not be created for this partition in UEFI.
123  /// Bit 2: This bit is set aside to let systems with traditional PC-AT BIOS firmware implementations
124  /// inform certain limited, special-purpose software running on these systems that a GPT
125  /// partition may be bootable. The UEFI boot manager must ignore this bit when selecting
126  /// a UEFI-compliant application, e.g., an OS loader.
127  /// Bits 3-47: Undefined and must be zero. Reserved for expansion by future versions of the UEFI
128  /// specification.
129  /// Bits 48-63: Reserved for GUID specific use. The use of these bits will vary depending on the
130  /// PartitionTypeGUID. Only the owner of the PartitionTypeGUID is allowed
131  /// to modify these bits. They must be preserved if Bits 0-47 are modified..
132  ///
134  ///
135  /// Null-terminated name of the partition.
136  ///
137  CHAR16 PartitionName[36];
139 
140 #pragma pack()
141 #endif
142 
143 
EFI_LBA EndingLBA
Ending LBA of the partition defined by this entry.
Definition: UefiGpt.h:109
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
GPT Partition Entry.
Definition: UefiGpt.h:90
unsigned int UINT32
Definition: ProcessorBind.h:56
unsigned short CHAR16
Definition: ProcessorBind.h:59
EFI_LBA MyLBA
The LBA that contains this data structure.
Definition: UefiGpt.h:44
FILE_LICENCE(BSD3)
GPT Partition Table Header.
Definition: UefiGpt.h:35
UINT64 EFI_LBA
Logical block address.
Definition: UefiBaseType.h:51
EFI_LBA AlternateLBA
LBA address of the alternate GUID Partition Table Header.
Definition: UefiGpt.h:48
EFI_TABLE_HEADER Header
The table header for the GPT partition Table.
Definition: UefiGpt.h:40
EFI_GUID UniquePartitionGUID
GUID that is unique for every partition entry.
Definition: UefiGpt.h:101
EFI_GUID PartitionTypeGUID
Unique ID that defines the purpose and type of this Partition.
Definition: UefiGpt.h:95
unsigned long long UINT64
Definition: ProcessorBind.h:54
EFI_LBA StartingLBA
Starting LBA of the partition defined by this entry.
Definition: UefiGpt.h:105
EFI_LBA LastUsableLBA
The last usable logical block that may be used by a partition described by a GUID Partition Entry.
Definition: UefiGpt.h:58
UINT32 SizeOfPartitionEntry
The size, in bytes, of each the GUID Partition Entry structures in the GUID Partition Entry array.
Definition: UefiGpt.h:77
EFI_LBA PartitionEntryLBA
The starting LBA of the GUID Partition Entry array.
Definition: UefiGpt.h:66
UINT32 NumberOfPartitionEntries
The number of Partition Entries in the GUID Partition Entry array.
Definition: UefiGpt.h:70
UINT64 Attributes
Attribute bits, all bits reserved by UEFI Bit 0: If this bit is set, the partition is required for th...
Definition: UefiGpt.h:133
UINT32 PartitionEntryArrayCRC32
The CRC32 of the GUID Partition Entry array.
Definition: UefiGpt.h:84
EFI_GUID DiskGUID
GUID that can be used to uniquely identify the disk.
Definition: UefiGpt.h:62
Data structure that precedes all of the standard EFI table types.
EFI_LBA FirstUsableLBA
The first usable logical block that may be used by a partition described by a GUID Partition Entry.
Definition: UefiGpt.h:53