<sys/gpt.h>: Fix a minor comment issue
[dragonfly.git] / sys / sys / gpt.h
1 /*-
2  * Copyright (c) 2002 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/sys/gpt.h,v 1.10 2006/06/22 22:11:12 marcel Exp $
27  */
28
29 #ifndef _SYS_GPT_H_
30 #define _SYS_GPT_H_
31
32 #include <sys/uuid.h>
33
34 struct gpt_hdr {
35         char            hdr_sig[8];
36         uint32_t        hdr_revision;
37         uint32_t        hdr_size;
38         uint32_t        hdr_crc_self;
39         uint32_t        __reserved;
40         uint64_t        hdr_lba_self;
41         uint64_t        hdr_lba_alt;
42         uint64_t        hdr_lba_start;
43         uint64_t        hdr_lba_end;
44         struct uuid     hdr_uuid;
45         uint64_t        hdr_lba_table;
46         uint32_t        hdr_entries;
47         uint32_t        hdr_entsz;
48         uint32_t        hdr_crc_table;
49         /*
50          * The header as defined in the EFI spec is not a multiple of 8 bytes
51          * and given that the alignment requirement is on an 8 byte boundary,
52          * padding will happen. We make the padding explicit so that we can
53          * correct the value returned by sizeof() when we put the size of the
54          * header in field hdr_size, or otherwise use offsetof().
55          */
56         uint32_t        padding;
57 };
58
59 #define GPT_MIN_HDR_SIZE        offsetof(struct gpt_hdr, padding)
60 #define GPT_HDR_SIG             "EFI PART"
61 #define GPT_HDR_REVISION        0x00010000
62
63 struct gpt_ent {
64         struct uuid     ent_type;
65         struct uuid     ent_uuid;
66         uint64_t        ent_lba_start;
67         uint64_t        ent_lba_end;
68         uint64_t        ent_attr;
69         uint16_t        ent_name[36];           /* UTF-16. */
70 };
71
72 #define GPT_ENT_ATTR_PLATFORM           (1ULL << 0)
73 #define GPT_ENT_ATTR_BOOTME             (1ULL << 59)
74 #define GPT_ENT_ATTR_BOOTONCE           (1ULL << 58)
75 #define GPT_ENT_ATTR_BOOTFAILED         (1ULL << 57)
76
77 #define GPT_ENT_TYPE_UNUSED             \
78         {0x00000000,0x0000,0x0000,0x00,0x00,{0x00,0x00,0x00,0x00,0x00,0x00}}
79 #define GPT_ENT_TYPE_EFI                \
80         {0xc12a7328,0xf81f,0x11d2,0xba,0x4b,{0x00,0xa0,0xc9,0x3e,0xc9,0x3b}}
81 #define GPT_ENT_TYPE_MBR                \
82         {0x024dee41,0x33e7,0x11d3,0x9d,0x69,{0x00,0x08,0xc7,0x81,0xf3,0x9f}}
83
84 #define GPT_ENT_TYPE_DRAGONFLY_LABEL32  \
85         {0x9d087404,0x1ca5,0x11dc,0x88,0x17,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
86 #define GPT_ENT_TYPE_DRAGONFLY_SWAP     \
87         {0x9d58fdbd,0x1ca5,0x11dc,0x88,0x17,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
88 #define GPT_ENT_TYPE_DRAGONFLY_UFS1     \
89         {0x9d94ce7c,0x1ca5,0x11dc,0x88,0x17,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
90 #define GPT_ENT_TYPE_DRAGONFLY_VINUM    \
91         {0x9dd4478f,0x1ca5,0x11dc,0x88,0x17,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
92 #define GPT_ENT_TYPE_DRAGONFLY_CCD      \
93         {0xdbd5211b,0x1ca5,0x11dc,0x88,0x17,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
94 #define GPT_ENT_TYPE_DRAGONFLY_LABEL64  \
95         {0x3d48ce54,0x1d16,0x11dc,0x86,0x96,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
96 #define GPT_ENT_TYPE_DRAGONFLY_LEGACY   \
97         {0xbd215ab2,0x1d16,0x11dc,0x86,0x96,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
98 #define GPT_ENT_TYPE_DRAGONFLY_HAMMER   \
99         {0x61dc63ac,0x6e38,0x11dc,0x85,0x13,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
100 #define GPT_ENT_TYPE_DRAGONFLY_HAMMER2  \
101         {0x5cbb9ad1,0x862d,0x11dc,0xa9,0x4d,{0x01,0x30,0x1b,0xb8,0xa9,0xf5}}
102
103 #define GPT_ENT_TYPE_FREEBSD            \
104         {0x516e7cb4,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
105 #define GPT_ENT_TYPE_FREEBSD_BOOT       \
106         {0x83bd6b9d,0x7f41,0x11dc,0xbe,0x0b,{0x00,0x15,0x60,0xb8,0x4f,0x0f}}
107 #define GPT_ENT_TYPE_FREEBSD_NANDFS     \
108         {0x74ba7dd9,0xa689,0x11e1,0xbd,0x04,{0x00,0xe0,0x81,0x28,0x6a,0xcf}}
109 #define GPT_ENT_TYPE_FREEBSD_SWAP       \
110         {0x516e7cb5,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
111 #define GPT_ENT_TYPE_FREEBSD_UFS        \
112         {0x516e7cb6,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
113 #define GPT_ENT_TYPE_FREEBSD_VINUM      \
114         {0x516e7cb8,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
115
116 /*
117  * The following are unused but documented here to avoid reuse.
118  *
119  * GPT_ENT_TYPE_FREEBSD_UFS2    \
120  *      {0x516e7cb7,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
121  */
122
123 /*
124  * Foreign partition types that we're likely to encounter. Note that Linux
125  * apparently choose to share data partitions with MS. I don't see what the
126  * advantage might be. I can see how sharing swap partitions is advantageous
127  * though.
128  */
129 #define GPT_ENT_TYPE_MS_BASIC_DATA      \
130         {0xebd0a0a2,0xb9e5,0x4433,0x87,0xc0,{0x68,0xb6,0xb7,0x26,0x99,0xc7}}
131 #define GPT_ENT_TYPE_MS_LDM_DATA        \
132         {0xaf9b60a0,0x1431,0x4f62,0xbc,0x68,{0x33,0x11,0x71,0x4a,0x69,0xad}}
133 #define GPT_ENT_TYPE_MS_LDM_METADATA    \
134         {0x5808c8aa,0x7e8f,0x42e0,0x85,0xd2,{0xe1,0xe9,0x04,0x34,0xcf,0xb3}}
135 #define GPT_ENT_TYPE_MS_RECOVERY        \
136         {0xde94bba4,0x06d1,0x4d40,0xa1,0x6a,{0xbf,0xd5,0x01,0x79,0xd6,0xac}}
137 #define GPT_ENT_TYPE_MS_RESERVED        \
138         {0xe3c9e316,0x0b5c,0x4db8,0x81,0x7d,{0xf9,0x2d,0xf0,0x02,0x15,0xae}}
139 #define GPT_ENT_TYPE_MS_SPACES  \
140         {0xe75caf8f,0xf680,0x4cee,0xaf,0xa3,{0xb0,0x01,0xe5,0x6e,0xfc,0x2d}}
141
142 #define GPT_ENT_TYPE_LINUX_DATA         \
143         {0x0fc63daf,0x8483,0x4772,0x8e,0x79,{0x3d,0x69,0xd8,0x47,0x7d,0xe4}}
144 #define GPT_ENT_TYPE_LINUX_RAID         \
145         {0xa19d880f,0x05fc,0x4d3b,0xa0,0x06,{0x74,0x3f,0x0f,0x84,0x91,0x1e}}
146 #define GPT_ENT_TYPE_LINUX_SWAP         \
147         {0x0657fd6d,0xa4ab,0x43c4,0x84,0xe5,{0x09,0x33,0xc8,0x4b,0x4f,0x4f}}
148 #define GPT_ENT_TYPE_LINUX_LVM          \
149         {0xe6d6d379,0xf507,0x44c2,0xa2,0x3c,{0x23,0x8f,0x2a,0x3d,0xf9,0x28}}
150
151 #define GPT_ENT_TYPE_VMFS               \
152         {0xaa31e02a,0x400f,0x11db,0x95,0x90,{0x00,0x0c,0x29,0x11,0xd1,0xb8}}
153 #define GPT_ENT_TYPE_VMKDIAG            \
154         {0x9d275380,0x40ad,0x11db,0xbf,0x97,{0x00,0x0c,0x29,0x11,0xd1,0xb8}}
155 #define GPT_ENT_TYPE_VMRESERVED         \
156         {0x9198effc,0x31c0,0x11db,0x8f,0x78,{0x00,0x0c,0x29,0x11,0xd1,0xb8}}
157 #define GPT_ENT_TYPE_VMVSANHDR          \
158         {0x381cfccc,0x7288,0x11e0,0x92,0xee,{0x00,0x0c,0x29,0x11,0xd0,0xb2}}
159
160 #define GPT_ENT_TYPE_APPLE_HFS          \
161         {0x48465300,0x0000,0x11aa,0xaa,0x11,{0x00,0x30,0x65,0x43,0xec,0xac}}
162
163 #define GPT_ENT_TYPE_NETBSD_FFS         \
164         {0x49f48d5a,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
165 #define GPT_ENT_TYPE_NETBSD_LFS         \
166         {0x49f48d82,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
167 #define GPT_ENT_TYPE_NETBSD_SWAP        \
168         {0x49f48d32,0xb10e,0x11dc,0xB9,0x9B,{0x00,0x19,0xd1,0x87,0x96,0x48}}
169 #define GPT_ENT_TYPE_NETBSD_RAID        \
170         {0x49f48daa,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
171 #define GPT_ENT_TYPE_NETBSD_CCD         \
172         {0x2db519c4,0xb10f,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
173 #define GPT_ENT_TYPE_NETBSD_CGD         \
174         {0x2db519ec,0xb10f,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
175
176 #define GPT_ENT_TYPE_CHROMEOS_FIRMWARE  \
177         {0xcab6e88e,0xabf3,0x4102,0xa0,0x7a,{0xd4,0xbb,0x9b,0xe3,0xc1,0xd3}}
178 #define GPT_ENT_TYPE_CHROMEOS_KERNEL    \
179         {0xfe3a2a5d,0x4f32,0x41a7,0xb7,0x25,{0xac,0xcc,0x32,0x85,0xa3,0x09}}
180 #define GPT_ENT_TYPE_CHROMEOS_RESERVED  \
181         {0x2e0a753d,0x9e48,0x43b0,0x83,0x37,{0xb1,0x51,0x92,0xcb,0x1b,0x5e}}
182 #define GPT_ENT_TYPE_CHROMEOS_ROOT      \
183         {0x3cb8e202,0x3b7e,0x47dd,0x8a,0x3c,{0x7f,0xf2,0xa1,0x3c,0xfc,0xec}}
184
185 #define GPT_ENT_TYPE_OPENBSD_DATA       \
186         {0x824cc7a0,0x36a8,0x11e3,0x89,0x0a,{0x95,0x25,0x19,0xad,0x3f,0x61}}
187
188 /*
189  * Boot partition used by GRUB 2.
190  */
191 #define GPT_ENT_TYPE_BIOS_BOOT          \
192         {0x21686148,0x6449,0x6e6f,0x74,0x4e,{0x65,0x65,0x64,0x45,0x46,0x49}}
193
194 #endif /* _SYS_GPT_H_ */