GRUB2/grub-2.04/include/grub/ventoy.h

   1 /******************************************************************************
   2  * ventoy.h
   3  *
   4  * Copyright (c) 2020, longpanda <admin@ventoy.net>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 3 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 #ifndef __VENTOY_H__
  22 #define __VENTOY_H__
  23
  24 #define COMPILE_ASSERT(expr)  extern char __compile_assert[(expr) ? 1 : -1]
  25
  26 #define VENTOY_COMPATIBLE_STR      "VENTOY COMPATIBLE"
  27 #define VENTOY_COMPATIBLE_STR_LEN  17
  28
  29 #define VENTOY_GUID { 0x77772020, 0x2e77, 0x6576, { 0x6e, 0x74, 0x6f, 0x79, 0x2e, 0x6e, 0x65, 0x74 }}
  30
  31 typedef enum ventoy_fs_type
  32 {
  33     ventoy_fs_exfat = 0, /* 0: exfat */
  34     ventoy_fs_ntfs,      /* 1: NTFS */
  35     ventoy_fs_ext,       /* 2: ext2/ext3/ext4 */
  36     ventoy_fs_xfs,       /* 3: XFS */
  37     ventoy_fs_udf,       /* 4: UDF */
  38
  39     ventoy_fs_max
  40 }ventoy_fs_type;
  41
  42 #pragma pack(1)
  43
  44 typedef struct ventoy_guid
  45 {
  46     grub_uint32_t   data1;
  47     grub_uint16_t   data2;
  48     grub_uint16_t   data3;
  49     grub_uint8_t    data4[8];
  50 }ventoy_guid;
  51
  52
  53 typedef struct ventoy_image_disk_region
  54 {
  55     grub_uint32_t   image_sector_count; /* image sectors contained in this region (in 2048) */
  56     grub_uint32_t   image_start_sector; /* image sector start (in 2048) */
  57     grub_uint64_t   disk_start_sector;  /* disk sector start (in 512) */
  58 }ventoy_image_disk_region;
  59
  60 typedef struct ventoy_image_location
  61 {
  62     ventoy_guid  guid;
  63
  64     /* image sector size, currently this value is always 2048 */
  65     grub_uint32_t   image_sector_size;
  66
  67     /* disk sector size, normally the value is 512 */
  68     grub_uint32_t   disk_sector_size;
  69
  70     grub_uint32_t   region_count;
  71
  72     /*
  73      * disk region data (region_count)
  74      * If the image file has more than one fragments in disk,
  75      * there will be more than one region data here.
  76      *
  77      */
  78     ventoy_image_disk_region regions[1];
  79
  80     /* ventoy_image_disk_region regions[2~region_count-1] */
  81 }ventoy_image_location;
  82
  83
  84 typedef struct ventoy_os_param
  85 {
  86     ventoy_guid    guid;                  // VENTOY_GUID
  87     grub_uint8_t   chksum;                // checksum
  88
  89     grub_uint8_t   vtoy_disk_guid[16];
  90     grub_uint64_t  vtoy_disk_size;       // disk size in bytes
  91     grub_uint16_t  vtoy_disk_part_id;    // begin with 1
  92     grub_uint16_t  vtoy_disk_part_type;  // 0:exfat   1:ntfs  other: reserved
  93     char           vtoy_img_path[384];   // It seems to be enough, utf-8 format
  94     grub_uint64_t  vtoy_img_size;        // image file size in bytes
  95
  96     /*
  97      * Ventoy will write a copy of ventoy_image_location data into runtime memory
  98      * this is the physically address and length of that memory.
  99      * Address 0 means no such data exist.
 100      * Address will be aligned by 4KB.
 101      *
 102      */
 103     grub_uint64_t  vtoy_img_location_addr;
 104     grub_uint32_t  vtoy_img_location_len;
 105
 106     /*
 107      * These 32 bytes are reserved by ventoy.
 108      *
 109      * vtoy_reserved[0]: vtoy_break_level
 110      * vtoy_reserved[1]: vtoy_debug_level
 111      *
 112      */
 113     grub_uint8_t   vtoy_reserved[32];    // Internal use by ventoy
 114
 115     grub_uint8_t   reserved[31];
 116 }ventoy_os_param;
 117
 118
 119 typedef struct ventoy_windows_data
 120 {
 121     char auto_install_script[384];
 122     grub_uint8_t reserved[128];
 123 }ventoy_windows_data;
 124
 125
 126
 127 #pragma pack()
 128
 129 // compile assert check : sizeof(ventoy_os_param) must be 512
 130 COMPILE_ASSERT(sizeof(ventoy_os_param) == 512);
 131
 132
 133
 134
 135
 136
 137
 138 #pragma pack(4)
 139
 140 typedef struct ventoy_chain_head
 141 {
 142     ventoy_os_param os_param;
 143
 144     grub_uint32_t disk_drive;
 145     grub_uint32_t drive_map;
 146     grub_uint32_t disk_sector_size;
 147
 148     grub_uint64_t real_img_size_in_bytes;
 149     grub_uint64_t virt_img_size_in_bytes;
 150     grub_uint32_t boot_catalog;
 151     grub_uint8_t  boot_catalog_sector[2048];
 152
 153     grub_uint32_t img_chunk_offset;
 154     grub_uint32_t img_chunk_num;
 155
 156     grub_uint32_t override_chunk_offset;
 157     grub_uint32_t override_chunk_num;
 158
 159     grub_uint32_t virt_chunk_offset;
 160     grub_uint32_t virt_chunk_num;
 161 }ventoy_chain_head;
 162
 163 typedef struct ventoy_img_chunk
 164 {
 165     grub_uint32_t img_start_sector; // sector size: 2KB
 166     grub_uint32_t img_end_sector;   // included
 167
 168     grub_uint64_t disk_start_sector; // in disk_sector_size
 169     grub_uint64_t disk_end_sector;   // included
 170 }ventoy_img_chunk;
 171
 172
 173 typedef struct ventoy_override_chunk
 174 {
 175     grub_uint64_t img_offset;
 176     grub_uint32_t override_size;
 177     grub_uint8_t  override_data[512];
 178 }ventoy_override_chunk;
 179
 180 typedef struct ventoy_virt_chunk
 181 {
 182     grub_uint32_t mem_sector_start;
 183     grub_uint32_t mem_sector_end;
 184     grub_uint32_t mem_sector_offset;
 185     grub_uint32_t remap_sector_start;
 186     grub_uint32_t remap_sector_end;
 187     grub_uint32_t org_sector_start;
 188 }ventoy_virt_chunk;
 189
 190 #define DEFAULT_CHUNK_NUM   1024
 191 typedef struct ventoy_img_chunk_list
 192 {
 193     grub_uint32_t max_chunk;
 194     grub_uint32_t cur_chunk;
 195     ventoy_img_chunk *chunk;
 196 }ventoy_img_chunk_list;
 197
 198
 199 #pragma pack()
 200
 201 #define ventoy_filt_register grub_file_filter_register
 202
 203 typedef const char * (*grub_env_get_pf)(const char *name);
 204
 205 #pragma pack(1)
 206
 207 #define GRUB_FILE_REPLACE_MAGIC  0x1258BEEF
 208
 209 typedef struct ventoy_grub_param_file_replace
 210 {
 211     grub_uint32_t magic;
 212     char old_file_name[4][256];
 213     grub_uint32_t old_name_cnt;
 214     grub_uint32_t new_file_virtual_id;
 215 }ventoy_grub_param_file_replace;
 216
 217 typedef struct ventoy_grub_param
 218 {
 219     grub_env_get_pf grub_env_get;
 220
 221     ventoy_grub_param_file_replace file_replace;
 222 }ventoy_grub_param;
 223
 224 #pragma pack()
 225
 226
 227
 228 int grub_fat_get_file_chunk(grub_uint64_t part_start, grub_file_t file, ventoy_img_chunk_list *chunk_list);
 229 grub_uint64_t grub_iso9660_get_last_read_pos(grub_file_t file);
 230 grub_uint64_t grub_iso9660_get_last_file_dirent_pos(grub_file_t file);
 231 grub_uint64_t grub_udf_get_file_offset(grub_file_t file);
 232 grub_uint64_t grub_udf_get_last_pd_size_offset(void);
 233 grub_uint64_t grub_udf_get_last_file_attr_offset
 234 (
 235     grub_file_t file,
 236     grub_uint32_t *startBlock,
 237     grub_uint64_t *fe_entry_size_offset
 238 );
 239 int ventoy_is_efi_os(void);
 240
 241 #endif /* __VENTOY_H__ */
 242