lib/libefi/include/sys/efi_partition.h

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