xref: /titanic_41/usr/src/uts/common/sys/efi_partition.h (revision 99d5e173470cf967aa87653364ed614299e7b511)
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  */
24 
25 #ifndef	_SYS_EFI_PARTITION_H
26 #define	_SYS_EFI_PARTITION_H
27 
28 #include <sys/uuid.h>
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 /*
35  * GUID Partition Table Header
36  */
37 
38 #define	EFI_LABEL_SIZE	512
39 #define	LEN_EFI_PAD	(EFI_LABEL_SIZE - \
40 			    ((5 * sizeof (diskaddr_t)) + \
41 			    (7 * sizeof (uint_t)) + \
42 			    (8 * sizeof (char)) + \
43 			    (1 * (sizeof (struct uuid)))))
44 
45 #define	EFI_SIGNATURE	0x5452415020494645ULL
46 
47 /* EFI Guid Partition Table Header -- little endian on-disk format */
48 typedef struct efi_gpt {
49 	uint64_t	efi_gpt_Signature;
50 	uint_t		efi_gpt_Revision;
51 	uint_t		efi_gpt_HeaderSize;
52 	uint_t		efi_gpt_HeaderCRC32;
53 	uint_t		efi_gpt_Reserved1;
54 	diskaddr_t	efi_gpt_MyLBA;
55 	diskaddr_t	efi_gpt_AlternateLBA;
56 	diskaddr_t	efi_gpt_FirstUsableLBA;
57 	diskaddr_t	efi_gpt_LastUsableLBA;
58 	struct uuid	efi_gpt_DiskGUID;
59 	diskaddr_t	efi_gpt_PartitionEntryLBA;
60 	uint_t		efi_gpt_NumberOfPartitionEntries;
61 	uint_t		efi_gpt_SizeOfPartitionEntry;
62 	uint_t		efi_gpt_PartitionEntryArrayCRC32;
63 	char		efi_gpt_Reserved2[LEN_EFI_PAD];
64 } efi_gpt_t;
65 
66 /* EFI Guid Partition Entry Attributes -- little endian format */
67 typedef struct efi_gpe_Attrs {
68 	uint32_t	PartitionAttrs		:16,
69 			Reserved2		:16;
70 	uint32_t	Reserved1		:31,
71 			RequiredPartition	:1;
72 } efi_gpe_Attrs_t;
73 
74 /*
75  * 6a96237f-1dd2-11b2-99a6-080020736631	V_UNASSIGNED (not used as such)
76  * 6a82cb45-1dd2-11b2-99a6-080020736631	V_BOOT
77  * 6a85cf4d-1dd2-11b2-99a6-080020736631	V_ROOT
78  * 6a87c46f-1dd2-11b2-99a6-080020736631	V_SWAP
79  * 6a898cc3-1dd2-11b2-99a6-080020736631	V_USR
80  * 6a8b642b-1dd2-11b2-99a6-080020736631	V_BACKUP
81  * 6a8d2ac7-1dd2-11b2-99a6-080020736631	V_STAND (not used)
82  * 6a8ef2e9-1dd2-11b2-99a6-080020736631	V_VAR
83  * 6a90ba39-1dd2-11b2-99a6-080020736631	V_HOME
84  * 6a9283a5-1dd2-11b2-99a6-080020736631	V_ALTSCTR
85  * 6a945a3b-1dd2-11b2-99a6-080020736631	V_CACHE
86  */
87 
88 #define	EFI_UNUSED	{ 0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
89 			    { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
90 #define	EFI_RESV1	{ 0x6a96237f, 0x1dd2, 0x11b2, 0x99, 0xa6, \
91 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
92 #define	EFI_BOOT	{ 0x6a82cb45, 0x1dd2, 0x11b2, 0x99, 0xa6, \
93 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
94 #define	EFI_ROOT	{ 0x6a85cf4d, 0x1dd2, 0x11b2, 0x99, 0xa6, \
95 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
96 #define	EFI_SWAP	{ 0x6a87c46f, 0x1dd2, 0x11b2, 0x99, 0xa6, \
97 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
98 #define	EFI_USR		{ 0x6a898cc3, 0x1dd2, 0x11b2, 0x99, 0xa6, \
99 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
100 #define	EFI_BACKUP	{ 0x6a8b642b, 0x1dd2, 0x11b2, 0x99, 0xa6, \
101 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
102 #define	EFI_RESV2	{ 0x6a8d2ac7, 0x1dd2, 0x11b2, 0x99, 0xa6, \
103 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
104 #define	EFI_VAR		{ 0x6a8ef2e9, 0x1dd2, 0x11b2, 0x99, 0xa6, \
105 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
106 #define	EFI_HOME	{ 0x6a90ba39, 0x1dd2, 0x11b2, 0x99, 0xa6, \
107 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
108 #define	EFI_ALTSCTR	{ 0x6a9283a5, 0x1dd2, 0x11b2, 0x99, 0xa6, \
109 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
110 #define	EFI_RESERVED	{ 0x6a945a3b, 0x1dd2, 0x11b2, 0x99, 0xa6, \
111 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
112 #define	EFI_SYSTEM	{ 0xC12A7328, 0xF81F, 0x11d2, 0xBA, 0x4B, \
113 			    { 0x00, 0xA0, 0xC9, 0x3E, 0xC9, 0x3B } }
114 #define	EFI_LEGACY_MBR	{ 0x024DEE41, 0x33E7, 0x11d3, 0x9D, 0x69, \
115 			    { 0x00, 0x08, 0xC7, 0x81, 0xF3, 0x9F } }
116 #define	EFI_SYMC_PUB	{ 0x6a9630d1, 0x1dd2, 0x11b2, 0x99, 0xa6, \
117 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
118 #define	EFI_SYMC_CDS	{ 0x6a980767, 0x1dd2, 0x11b2, 0x99, 0xa6, \
119 			    { 0x08, 0x00, 0x20, 0x73, 0x66, 0x31 } }
120 #define	EFI_MSFT_RESV	{ 0xE3C9E316, 0x0B5C, 0x4DB8, 0x81, 0x7D, \
121 			    { 0xF9, 0x2D, 0xF0, 0x02, 0x15, 0xAE } }
122 #define	EFI_DELL_BASIC	{ 0xebd0a0a2, 0xb9e5, 0x4433, 0x87, 0xc0, \
123 			    { 0x68, 0xb6, 0xb7, 0x26, 0x99, 0xc7 } }
124 #define	EFI_DELL_RAID	{ 0xa19d880f, 0x05fc, 0x4d3b, 0xa0, 0x06, \
125 			    { 0x74, 0x3f, 0x0f, 0x84, 0x91, 0x1e } }
126 #define	EFI_DELL_SWAP	{ 0x0657fd6d, 0xa4ab, 0x43c4, 0x84, 0xe5, \
127 			    { 0x09, 0x33, 0xc8, 0x4b, 0x4f, 0x4f } }
128 #define	EFI_DELL_LVM	{ 0xe6d6d379, 0xf507, 0x44c2, 0xa2, 0x3c, \
129 			    { 0x23, 0x8f, 0x2a, 0x3d, 0xf9, 0x28 } }
130 #define	EFI_DELL_RESV	{ 0x8da63339, 0x0007, 0x60c0, 0xc4, 0x36, \
131 			    { 0x08, 0x3a, 0xc8, 0x23, 0x09, 0x08 } }
132 #define	EFI_AAPL_HFS	{ 0x48465300, 0x0000, 0x11aa, 0xaa, 0x11, \
133 			    { 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
134 #define	EFI_AAPL_UFS	{ 0x55465300, 0x0000, 0x11aa, 0xaa, 0x11, \
135 			    { 0x00, 0x30, 0x65, 0x43, 0xec, 0xac } }
136 
137 /* minimum # of bytes for partition table entires, per EFI spec */
138 #define	EFI_MIN_ARRAY_SIZE	(16 * 1024)
139 
140 #define	EFI_PART_NAME_LEN	36
141 
142 /* size of the "reserved" partition, in blocks */
143 #define	EFI_MIN_RESV_SIZE	(16 * 1024)
144 
145 /* EFI Guid Partition Entry */
146 typedef struct efi_gpe {
147 	struct uuid	efi_gpe_PartitionTypeGUID;
148 	struct uuid	efi_gpe_UniquePartitionGUID;
149 	diskaddr_t	efi_gpe_StartingLBA;
150 	diskaddr_t	efi_gpe_EndingLBA;
151 	efi_gpe_Attrs_t	efi_gpe_Attributes;
152 	ushort_t	efi_gpe_PartitionName[EFI_PART_NAME_LEN];
153 } efi_gpe_t;
154 
155 /*
156  * passed to the useful (we hope) routines (efi_alloc_and_read and
157  * efi_write) that take this VTOC-like struct.  These routines handle
158  * converting this struct into the EFI struct, generate UUIDs and
159  * checksums, and perform any necessary byte-swapping to the on-disk
160  * format.
161  */
162 /* Solaris library abstraction for EFI partitons */
163 typedef struct dk_part	{
164 	diskaddr_t	p_start;	/* starting LBA */
165 	diskaddr_t	p_size;		/* size in blocks */
166 	struct uuid	p_guid;		/* partion type GUID */
167 	ushort_t	p_tag;		/* converted to part'n type GUID */
168 	ushort_t	p_flag;		/* attributes */
169 	char		p_name[EFI_PART_NAME_LEN]; /* partition name */
170 	struct uuid	p_uguid;	/* unique partition GUID */
171 	uint_t		p_resv[8];	/* future use - set to zero */
172 } dk_part_t;
173 
174 /* Solaris library abstraction for an EFI GPT */
175 #define	EFI_VERSION102		0x00010002
176 #define	EFI_VERSION100		0x00010000
177 #define	EFI_VERSION_CURRENT	EFI_VERSION100
178 typedef struct dk_gpt {
179 	uint_t		efi_version;	/* set to EFI_VERSION_CURRENT */
180 	uint_t		efi_nparts;	/* number of partitions below */
181 	uint_t		efi_part_size;	/* size of each partition entry */
182 					/* efi_part_size is unused */
183 	uint_t		efi_lbasize;	/* size of block in bytes */
184 	diskaddr_t	efi_last_lba;	/* last block on the disk */
185 	diskaddr_t	efi_first_u_lba; /* first block after labels */
186 	diskaddr_t	efi_last_u_lba;	/* last block before backup labels */
187 	struct uuid	efi_disk_uguid;	/* unique disk GUID */
188 	uint_t		efi_flags;
189 	uint_t		efi_reserved1;	/* future use - set to zero */
190 	diskaddr_t	efi_altern_lba;	/* lba of alternate GPT header */
191 	uint_t		efi_reserved[12]; /* future use - set to zero */
192 	struct dk_part	efi_parts[1];	/* array of partitions */
193 } dk_gpt_t;
194 
195 /* possible values for "efi_flags" */
196 #define	EFI_GPT_PRIMARY_CORRUPT	0x1	/* primary label corrupt */
197 
198 /* the private ioctl between libefi and the driver */
199 typedef struct dk_efi {
200 	diskaddr_t	 dki_lba;	/* starting block */
201 	len_t		 dki_length;	/* length in bytes */
202 	union {
203 		efi_gpt_t 	*_dki_data;
204 		uint64_t	_dki_data_64;
205 	} dki_un;
206 #define	dki_data	dki_un._dki_data
207 #define	dki_data_64	dki_un._dki_data_64
208 } dk_efi_t;
209 
210 struct partition64 {
211 	struct uuid	p_type;
212 	uint_t		p_partno;
213 	uint_t		p_resv1;
214 	diskaddr_t	p_start;
215 	diskaddr_t	p_size;
216 };
217 
218 /*
219  * Number of EFI partitions
220  */
221 #define	EFI_NUMPAR	9
222 
223 #ifndef _KERNEL
224 extern	int	efi_alloc_and_init(int, uint32_t, struct dk_gpt **);
225 extern	int	efi_alloc_and_read(int, struct dk_gpt **);
226 extern	int	efi_write(int, struct dk_gpt *);
227 extern	void	efi_free(struct dk_gpt *);
228 extern	int	efi_type(int);
229 extern	void	efi_err_check(struct dk_gpt *);
230 extern	int	efi_auto_sense(int fd, struct dk_gpt **);
231 extern	int	efi_use_whole_disk(int fd);
232 #endif
233 
234 #ifdef __cplusplus
235 }
236 #endif
237 
238 #endif /* _SYS_EFI_PARTITION_H */
239