/*      $NetBSD: disklabel_gpt.h,v 1.18 2025/10/11 18:55:31 thorpej Exp $       */

/*
 * Copyright (c) 2002 Marcel Moolenaar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/sys/gpt.h,v 1.7 2004/08/02 18:46:52 marcel Exp $
 */

#ifndef _SYS_DISKLABEL_GPT_H_
#define _SYS_DISKLABEL_GPT_H_

/*
 * Definitions for the EFI GUID Partition Table disk partitioning scheme.
 *
 * NOTE: As EFI is an Intel specification, all fields are stored in
 * little-endian byte-order.
 */

/*
 * GUID Partition Table Header
 */
struct gpt_hdr {
        int8_t          hdr_sig[8];     /* identifies GUID Partition Table */
        uint32_t        hdr_revision;   /* GPT specification revision */
        uint32_t        hdr_size;       /* size of GPT Header */
        uint32_t        hdr_crc_self;   /* CRC32 of GPT Header */
        uint32_t        hdr__rsvd0;     /* must be zero */
        uint64_t        hdr_lba_self;   /* LBA that contains this Header */
        uint64_t        hdr_lba_alt;    /* LBA of backup GPT Header */
        uint64_t        hdr_lba_start;  /* first LBA usable for partitions */
        uint64_t        hdr_lba_end;    /* last LBA usable for partitions */
        uint8_t         hdr_guid[16];   /* GUID to identify the disk */
        uint64_t        hdr_lba_table;  /* first LBA of GPE array */
        uint32_t        hdr_entries;    /* number of entries in GPE array */
        uint32_t        hdr_entsz;      /* size of each GPE */
        uint32_t        hdr_crc_table;  /* CRC32 of GPE array */
        /*
         * The remainder of the block that contains the GPT Header
         * is reserved by EFI for future GPT Header expansion, and
         * must be zero.
         */
};

#define GPT_HDR_SIG             "EFI PART"
#define GPT_HDR_REVISION        0x00010000      /* 1.0 */

#define GPT_HDR_BLKNO           1

#define GPT_HDR_SIZE            0x5c

/*
 * GUID Partition Entry
 */
struct gpt_ent {
        uint8_t         ent_type[16];   /* partition type GUID */
        uint8_t         ent_guid[16];   /* unique partition GUID */
        uint64_t        ent_lba_start;  /* start of partition */
        uint64_t        ent_lba_end;    /* end of partition */
        uint64_t        ent_attr;       /* partition attributes */
        uint16_t        ent_name[36];   /* partition name in UCS-2 */
};

#define GPT_ENT_ATTR_REQUIRED_PARTITION         (1ULL << 0)
                                        /* required for platform to function */
#define GPT_ENT_ATTR_NO_BLOCK_IO_PROTOCOL       (1ULL << 1)
                                        /* UEFI won't recognize file system */
#define GPT_ENT_ATTR_LEGACY_BIOS_BOOTABLE       (1ULL << 2)
                                        /* legacy BIOS boot partition */
/* The following three entries are from FreeBSD. */
#define GPT_ENT_ATTR_BOOTME                     (1ULL << 59)
                                        /* indicates a bootable partition */
#define GPT_ENT_ATTR_BOOTONCE                   (1ULL << 58)
                                /* attempt to boot this partition only once */
#define GPT_ENT_ATTR_BOOTFAILED                 (1ULL << 57)
                /* partition that was marked bootonce but failed to boot */

/*
 * Partition types defined by the EFI specification:
 *
 *      GPT_ENT_TYPE_UNUSED             Unused Entry
 *      GPT_ENT_TYPE_EFI                EFI System Partition
 *      GPT_ENT_TYPE_MBR                Partition containing legacy MBR
 */
#define GPT_ENT_TYPE_UNUSED             \
        {0x00000000,0x0000,0x0000,0x00,0x00,{0x00,0x00,0x00,0x00,0x00,0x00}}
#define GPT_ENT_TYPE_EFI                \
        {0xc12a7328,0xf81f,0x11d2,0xba,0x4b,{0x00,0xa0,0xc9,0x3e,0xc9,0x3b}}
#define GPT_ENT_TYPE_MBR                \
        {0x024dee41,0x33e7,0x11d3,0x9d,0x69,{0x00,0x08,0xc7,0x81,0xf3,0x9f}}

/*
 * Partition types defined by other operating systems.
 */
#define GPT_ENT_TYPE_NETBSD_SWAP        \
        {0x49f48d32,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
#define GPT_ENT_TYPE_NETBSD_FFS         \
        {0x49f48d5a,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
#define GPT_ENT_TYPE_NETBSD_LFS         \
        {0x49f48d82,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
#define GPT_ENT_TYPE_NETBSD_RAIDFRAME   \
        {0x49f48daa,0xb10e,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
#define GPT_ENT_TYPE_NETBSD_CCD \
        {0x2db519c4,0xb10f,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}
#define GPT_ENT_TYPE_NETBSD_CGD \
        {0x2db519ec,0xb10f,0x11dc,0xb9,0x9b,{0x00,0x19,0xd1,0x87,0x96,0x48}}

#define GPT_ENT_TYPE_FREEBSD            \
        {0x516e7cb4,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
#define GPT_ENT_TYPE_FREEBSD_SWAP       \
        {0x516e7cb5,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
#define GPT_ENT_TYPE_FREEBSD_UFS        \
        {0x516e7cb6,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
#define GPT_ENT_TYPE_FREEBSD_VINUM      \
        {0x516e7cb8,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
#define GPT_ENT_TYPE_FREEBSD_ZFS        \
        {0x516e7cba,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}

#define GPT_ENT_TYPE_OPENBSD_DATA       \
        {0x824CC7A0,0x36A8,0x11E3,0x89,0x0A,{0x95,0x25,0x19,0xAD,0x3F,0x61}}

/*
 * The following are unused but documented here to avoid reuse.
 *
 *      GPT_ENT_TYPE_FREEBSD_UFS2       \
 *      {0x516e7cb7,0x6ecf,0x11d6,0x8f,0xf8,{0x00,0x02,0x2d,0x09,0x71,0x2b}}
 */

#define GPT_ENT_TYPE_MS_RESERVED        \
        {0xe3c9e316,0x0b5c,0x4db8,0x81,0x7d,{0xf9,0x2d,0xf0,0x02,0x15,0xae}}
#define GPT_ENT_TYPE_MS_BASIC_DATA      \
        {0xebd0a0a2,0xb9e5,0x4433,0x87,0xc0,{0x68,0xb6,0xb7,0x26,0x99,0xc7}}
#define GPT_ENT_TYPE_MS_RECOVERY        \
        {0xde94bba4,0x06d1,0x4d40,0xa1,0x6a,{0xbf,0xd5,0x01,0x79,0xd6,0xac}}
#define GPT_ENT_TYPE_MS_LDM_METADATA    \
        {0x5808c8aa,0x7e8f,0x42e0,0x85,0xd2,{0xe1,0xe9,0x04,0x34,0xcf,0xb3}}
#define GPT_ENT_TYPE_MS_LDM_DATA        \
        {0xaf9b60a0,0x1431,0x4f62,0xbc,0x68,{0x33,0x11,0x71,0x4a,0x69,0xad}}

/*
 * Linux originally used GPT_ENT_TYPE_MS_BASIC_DATA in place of
 * GPT_ENT_TYPE_LINUX_DATA.
 */
#define GPT_ENT_TYPE_LINUX_DATA         \
        {0x0fc63daf,0x8483,0x4772,0x8e,0x79,{0x3d,0x69,0xd8,0x47,0x7d,0xe4}}
#define GPT_ENT_TYPE_LINUX_RAID         \
        {0xa19d880f,0x05fc,0x4d3b,0xa0,0x06,{0x74,0x3f,0x0f,0x84,0x91,0x1e}}
#define GPT_ENT_TYPE_LINUX_SWAP         \
        {0x0657fd6d,0xa4ab,0x43c4,0x84,0xe5,{0x09,0x33,0xc8,0x4b,0x4f,0x4f}}
#define GPT_ENT_TYPE_LINUX_LVM          \
        {0xe6d6d379,0xf507,0x44c2,0xa2,0x3c,{0x23,0x8f,0x2a,0x3d,0xf9,0x28}}
#define GPT_ENT_TYPE_LINUX_XBOOTLDR     \
        {0xbc13c2ff,0x59e6,0x4262,0xa3,0x52,{0xb2,0x75,0xfd,0x6f,0x71,0x72}}

#define GPT_ENT_TYPE_APPLE_HFS          \
        {0x48465300,0x0000,0x11aa,0xaa,0x11,{0x00,0x30,0x65,0x43,0xec,0xac}}
#define GPT_ENT_TYPE_APPLE_UFS          \
        {0x55465300,0x0000,0x11aa,0xaa,0x11,{0x00,0x30,0x65,0x43,0xec,0xac}}

/*
 * Used by GRUB 2.
 */
#define GPT_ENT_TYPE_BIOS               \
        {0x21686148,0x6449,0x6e6f,0x74,0x4e,{0x65,0x65,0x64,0x45,0x46,0x49}}

/*
 * VMware types.
 */
#define GPT_ENT_TYPE_VMWARE_VMKCORE     \
        {0x9D275380,0x40AD,0x11DB,0xBF,0x97,{0x00,0x0C,0x29,0x11,0xD1,0xB8}}
#define GPT_ENT_TYPE_VMWARE_VMFS        \
        {0xAA31E02A,0x400F,0x11DB,0x95,0x90,{0x00,0x0C,0x29,0x11,0xD1,0xB8}}
#define GPT_ENT_TYPE_VMWARE_RESERVED    \
        {0x9198EFFC,0x31C0,0x11DB,0x8F,0x78,{0x00,0x0C,0x29,0x11,0xD1,0xB8}}

/*
 * Used by SiFive and StarFive RISC-V mask ROMs to find the boot
 * loader.
 */
#define GPT_ENT_TYPE_SIFIVE_BBL         \
        {0x2e54b353,0x1271,0x4842,0x80,0x6f,{0xe4,0x36,0xd6,0xaf,0x69,0x85}}

#endif /* _SYS_DISKLABEL_GPT_H_ */