xref: /illumos-gate/usr/src/uts/common/sys/efi_partition.h (revision 49ee6bfbbe326d1f0bbc34934ab8b07a000305c4)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2012 Nexenta Systems, Inc.  All rights reserved.
24  * Copyright 2014 Toomas Soome <tsoome@me.com>
25  */
26 
27 #ifndef	_SYS_EFI_PARTITION_H
28 #define	_SYS_EFI_PARTITION_H
29 
30 #include <sys/uuid.h>
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * GUID Partition Table Header
38  */
39 
40 #define	EFI_LABEL_SIZE	512
41 #define	LEN_EFI_PAD	(EFI_LABEL_SIZE - \
42 			    ((5 * sizeof (diskaddr_t)) + \
43 			    (7 * sizeof (uint_t)) + \
44 			    (8 * sizeof (char)) + \
45 			    (1 * (sizeof (struct uuid)))))
46 
47 #define	EFI_SIGNATURE	0x5452415020494645ULL
48 
49 /* EFI Guid Partition Table Header -- little endian on-disk format */
50 typedef struct efi_gpt {
51 	uint64_t	efi_gpt_Signature;
52 	uint_t		efi_gpt_Revision;
53 	uint_t		efi_gpt_HeaderSize;
54 	uint_t		efi_gpt_HeaderCRC32;
55 	uint_t		efi_gpt_Reserved1;
56 	diskaddr_t	efi_gpt_MyLBA;
57 	diskaddr_t	efi_gpt_AlternateLBA;
58 	diskaddr_t	efi_gpt_FirstUsableLBA;
59 	diskaddr_t	efi_gpt_LastUsableLBA;
60 	struct uuid	efi_gpt_DiskGUID;
61 	diskaddr_t	efi_gpt_PartitionEntryLBA;
62 	uint_t		efi_gpt_NumberOfPartitionEntries;
63 	uint_t		efi_gpt_SizeOfPartitionEntry;
64 	uint_t		efi_gpt_PartitionEntryArrayCRC32;
65 	char		efi_gpt_Reserved2[LEN_EFI_PAD];
66 } efi_gpt_t;
67 
68 /* EFI Guid Partition Entry Attributes -- little endian format */
69 typedef struct efi_gpe_Attrs {
70 	uint32_t	PartitionAttrs		:16,
71 			Reserved2		:16;
72 	uint32_t	Reserved1		:31,
73 			RequiredPartition	:1;
74 } efi_gpe_Attrs_t;
75 
76 /*
77  * 6a96237f-1dd2-11b2-99a6-080020736631	V_UNASSIGNED (not used as such)
78  * 6a82cb45-1dd2-11b2-99a6-080020736631	V_BOOT
79  * 6a85cf4d-1dd2-11b2-99a6-080020736631	V_ROOT
80  * 6a87c46f-1dd2-11b2-99a6-080020736631	V_SWAP
81  * 6a898cc3-1dd2-11b2-99a6-080020736631	V_USR
82  * 6a8b642b-1dd2-11b2-99a6-080020736631	V_BACKUP
83  * 6a8d2ac7-1dd2-11b2-99a6-080020736631	V_STAND (not used)
84  * 6a8ef2e9-1dd2-11b2-99a6-080020736631	V_VAR
85  * 6a90ba39-1dd2-11b2-99a6-080020736631	V_HOME
86  * 6a9283a5-1dd2-11b2-99a6-080020736631	V_ALTSCTR
87  * 6a945a3b-1dd2-11b2-99a6-080020736631	V_CACHE
88  */
89 
90 #define	EFI_UNUSED		{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
91 				    { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
92 #define	EFI_RESV1		{ 0x6a96237f, 0x1dd2, 0x11b2, 0x99, 0xa6, \
93 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
94 #define	EFI_BOOT		{ 0x6a82cb45, 0x1dd2, 0x11b2, 0x99, 0xa6, \
95 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
96 #define	EFI_ROOT		{ 0x6a85cf4d, 0x1dd2, 0x11b2, 0x99, 0xa6, \
97 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
98 #define	EFI_SWAP		{ 0x6a87c46f, 0x1dd2, 0x11b2, 0x99, 0xa6, \
99 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
100 #define	EFI_USR			{ 0x6a898cc3, 0x1dd2, 0x11b2, 0x99, 0xa6, \
101 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
102 #define	EFI_BACKUP		{ 0x6a8b642b, 0x1dd2, 0x11b2, 0x99, 0xa6, \
103 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
104 #define	EFI_RESV2		{ 0x6a8d2ac7, 0x1dd2, 0x11b2, 0x99, 0xa6, \
105 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
106 #define	EFI_VAR			{ 0x6a8ef2e9, 0x1dd2, 0x11b2, 0x99, 0xa6, \
107 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
108 #define	EFI_HOME		{ 0x6a90ba39, 0x1dd2, 0x11b2, 0x99, 0xa6, \
109 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
110 #define	EFI_ALTSCTR		{ 0x6a9283a5, 0x1dd2, 0x11b2, 0x99, 0xa6, \
111 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
112 #define	EFI_RESERVED		{ 0x6a945a3b, 0x1dd2, 0x11b2, 0x99, 0xa6, \
113 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
114 #define	EFI_SYSTEM		{ 0xC12A7328, 0xF81F, 0x11d2, 0xBA, 0x4B, \
115 				    { 0x00, 0xA0, 0xC9, 0x3E, 0xC9, 0x3B } }
116 #define	EFI_LEGACY_MBR		{ 0x024DEE41, 0x33E7, 0x11d3, 0x9D, 0x69, \
117 				    { 0x00, 0x08, 0xC7, 0x81, 0xF3, 0x9F } }
118 #define	EFI_SYMC_PUB		{ 0x6a9630d1, 0x1dd2, 0x11b2, 0x99, 0xa6, \
119 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
120 #define	EFI_SYMC_CDS		{ 0x6a980767, 0x1dd2, 0x11b2, 0x99, 0xa6, \
121 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
122 #define	EFI_MSFT_RESV		{ 0xE3C9E316, 0x0B5C, 0x4DB8, 0x81, 0x7D, \
123 				    { 0xF9, 0x2D, 0xF0, 0x02, 0x15, 0xAE } }
124 #define	EFI_DELL_BASIC		{ 0xebd0a0a2, 0xb9e5, 0x4433, 0x87, 0xc0, \
125 				    { 0x68, 0xb6, 0xb7, 0x26, 0x99, 0xc7 } }
126 #define	EFI_DELL_RAID		{ 0xa19d880f, 0x05fc, 0x4d3b, 0xa0, 0x06, \
127 				    { 0x74, 0x3f, 0x0f, 0x84, 0x91, 0x1e } }
128 #define	EFI_DELL_SWAP		{ 0x0657fd6d, 0xa4ab, 0x43c4, 0x84, 0xe5, \
129 				    { 0x09, 0x33, 0xc8, 0x4b, 0x4f, 0x4f } }
130 #define	EFI_DELL_LVM		{ 0xe6d6d379, 0xf507, 0x44c2, 0xa2, 0x3c, \
131 				    { 0x23, 0x8f, 0x2a, 0x3d, 0xf9, 0x28 } }
132 #define	EFI_DELL_RESV		{ 0x8da63339, 0x0007, 0x60c0, 0xc4, 0x36, \
133 				    { 0x08, 0x3a, 0xc8, 0x23, 0x09, 0x08 } }
134 #define	EFI_AAPL_BOOT		{ 0x426F6F74, 0x0000, 0x11aa, 0xaa, 0x11, \
135 				{ 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
136 #define	EFI_AAPL_HFS		{ 0x48465300, 0x0000, 0x11aa, 0xaa, 0x11, \
137 				    { 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
138 #define	EFI_AAPL_UFS		{ 0x55465300, 0x0000, 0x11aa, 0xaa, 0x11, \
139 				    { 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
140 #define	EFI_AAPL_ZFS		{ 0x6a898cc3, 0x1dd2, 0x11b2, 0x99, 0xa6, \
141 				    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
142 #define	EFI_AAPL_APFS		{ 0x7c3457ef, 0x0000, 0x11aa, 0xaa, 0x11, \
143 				    { 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
144 #define	EFI_FREEBSD_BOOT	{ 0x83bd6b9d, 0x7f41, 0x11dc, 0xbe, 0x0b, \
145 				    { 0x00, 0x15, 0x60, 0xb8, 0x4f, 0x0f } }
146 #define	EFI_FREEBSD_NANDFS	{ 0x74ba7dd9, 0xa689, 0x11e1, 0xbd, 0x04, \
147 				    { 0x00, 0xe0, 0x81, 0x28, 0x6a, 0xcf } }
148 #define	EFI_FREEBSD_SWAP	{ 0x516e7cb5, 0x6ecf, 0x11d6, 0x8f, 0xf8, \
149 				    { 0x00, 0x02, 0x2d, 0x09, 0x71, 0x2b } }
150 #define	EFI_FREEBSD_UFS		{ 0x516e7cb6, 0x6ecf, 0x11d6, 0x8f, 0xf8, \
151 				    { 0x00, 0x02, 0x2d, 0x09, 0x71, 0x2b } }
152 #define	EFI_FREEBSD_VINUM	{ 0x516e7cb8, 0x6ecf, 0x11d6, 0x8f, 0xf8, \
153 				    { 0x00, 0x02, 0x2d, 0x09, 0x71, 0x2b } }
154 #define	EFI_FREEBSD_ZFS		{ 0x516e7cba, 0x6ecf, 0x11d6, 0x8f, 0xf8, \
155 				    { 0x00, 0x02, 0x2d, 0x09, 0x71, 0x2b } }
156 #define	EFI_BIOS_BOOT		{ 0x21686148, 0x6449, 0x6e6f, 0x74, 0x4e, \
157 				    { 0x65, 0x65, 0x64, 0x45, 0x46, 0x49 } }
158 
159 /* minimum # of bytes for partition table entires, per EFI spec */
160 #define	EFI_MIN_ARRAY_SIZE	(16 * 1024)
161 
162 #define	EFI_PART_NAME_LEN	36
163 
164 /* size of the "reserved" partition, in blocks */
165 #define	EFI_MIN_RESV_SIZE	(16 * 1024)
166 
167 /* EFI Guid Partition Entry */
168 typedef struct efi_gpe {
169 	struct uuid	efi_gpe_PartitionTypeGUID;
170 	struct uuid	efi_gpe_UniquePartitionGUID;
171 	diskaddr_t	efi_gpe_StartingLBA;
172 	diskaddr_t	efi_gpe_EndingLBA;
173 	efi_gpe_Attrs_t	efi_gpe_Attributes;
174 	ushort_t	efi_gpe_PartitionName[EFI_PART_NAME_LEN];
175 } efi_gpe_t;
176 
177 /*
178  * passed to the useful (we hope) routines (efi_alloc_and_read and
179  * efi_write) that take this VTOC-like struct.  These routines handle
180  * converting this struct into the EFI struct, generate UUIDs and
181  * checksums, and perform any necessary byte-swapping to the on-disk
182  * format.
183  */
184 /* Solaris library abstraction for EFI partitons */
185 typedef struct dk_part	{
186 	diskaddr_t	p_start;	/* starting LBA */
187 	diskaddr_t	p_size;		/* size in blocks */
188 	struct uuid	p_guid;		/* partion type GUID */
189 	ushort_t	p_tag;		/* converted to part'n type GUID */
190 	ushort_t	p_flag;		/* attributes */
191 	char		p_name[EFI_PART_NAME_LEN]; /* partition name */
192 	struct uuid	p_uguid;	/* unique partition GUID */
193 	uint_t		p_resv[8];	/* future use - set to zero */
194 } dk_part_t;
195 
196 /* Solaris library abstraction for an EFI GPT */
197 #define	EFI_VERSION102		0x00010002
198 #define	EFI_VERSION100		0x00010000
199 #define	EFI_VERSION_CURRENT	EFI_VERSION100
200 typedef struct dk_gpt {
201 	uint_t		efi_version;	/* set to EFI_VERSION_CURRENT */
202 	uint_t		efi_nparts;	/* number of partitions below */
203 	uint_t		efi_part_size;	/* size of each partition entry */
204 					/* efi_part_size is unused */
205 	uint_t		efi_lbasize;	/* size of block in bytes */
206 	diskaddr_t	efi_last_lba;	/* last block on the disk */
207 	diskaddr_t	efi_first_u_lba; /* first block after labels */
208 	diskaddr_t	efi_last_u_lba;	/* last block before backup labels */
209 	struct uuid	efi_disk_uguid;	/* unique disk GUID */
210 	uint_t		efi_flags;
211 	uint_t		efi_reserved1;	/* future use - set to zero */
212 	diskaddr_t	efi_altern_lba;	/* lba of alternate GPT header */
213 	uint_t		efi_reserved[12]; /* future use - set to zero */
214 	struct dk_part	efi_parts[1];	/* array of partitions */
215 } dk_gpt_t;
216 
217 /* possible values for "efi_flags" */
218 #define	EFI_GPT_PRIMARY_CORRUPT	0x1	/* primary label corrupt */
219 
220 /* the private ioctl between libefi and the driver */
221 typedef struct dk_efi {
222 	diskaddr_t	 dki_lba;	/* starting block */
223 	len_t		 dki_length;	/* length in bytes */
224 	union {
225 		efi_gpt_t 	*_dki_data;
226 		uint64_t	_dki_data_64;
227 	} dki_un;
228 #define	dki_data	dki_un._dki_data
229 #define	dki_data_64	dki_un._dki_data_64
230 } dk_efi_t;
231 
232 struct partition64 {
233 	struct uuid	p_type;
234 	uint_t		p_partno;
235 	uint_t		p_resv1;
236 	diskaddr_t	p_start;
237 	diskaddr_t	p_size;
238 };
239 
240 /*
241  * Number of EFI partitions
242  */
243 #define	EFI_NUMPAR	9
244 
245 #ifndef _KERNEL
246 extern	int	efi_alloc_and_init(int, uint32_t, struct dk_gpt **);
247 extern	int	efi_alloc_and_read(int, struct dk_gpt **);
248 extern	int	efi_write(int, struct dk_gpt *);
249 extern	void	efi_free(struct dk_gpt *);
250 extern	int	efi_type(int);
251 extern	void	efi_err_check(struct dk_gpt *);
252 extern	int	efi_auto_sense(int fd, struct dk_gpt **);
253 extern	int	efi_use_whole_disk(int fd);
254 #endif
255 
256 #ifdef __cplusplus
257 }
258 #endif
259 
260 #endif /* _SYS_EFI_PARTITION_H */
261