GRUB2/MOD_SRC/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     ventoy_fs_fat,       /* 5: FAT */
  39
  40     ventoy_fs_max
  41 }ventoy_fs_type;
  42
  43 #pragma pack(1)
  44
  45 typedef struct ventoy_guid
  46 {
  47     grub_uint32_t   data1;
  48     grub_uint16_t   data2;
  49     grub_uint16_t   data3;
  50     grub_uint8_t    data4[8];
  51 }ventoy_guid;
  52
  53
  54 typedef struct ventoy_image_disk_region
  55 {
  56     grub_uint32_t   image_sector_count; /* image sectors contained in this region (in 2048) */
  57     grub_uint32_t   image_start_sector; /* image sector start (in 2048) */
  58     grub_uint64_t   disk_start_sector;  /* disk sector start (in 512) */
  59 }ventoy_image_disk_region;
  60
  61 typedef struct ventoy_image_location
  62 {
  63     ventoy_guid  guid;
  64
  65     /* image sector size, currently this value is always 2048 */
  66     grub_uint32_t   image_sector_size;
  67
  68     /* disk sector size, normally the value is 512 */
  69     grub_uint32_t   disk_sector_size;
  70
  71     grub_uint32_t   region_count;
  72
  73     /*
  74      * disk region data (region_count)
  75      * If the image file has more than one fragments in disk,
  76      * there will be more than one region data here.
  77      *
  78      */
  79     ventoy_image_disk_region regions[1];
  80
  81     /* ventoy_image_disk_region regions[2~region_count-1] */
  82 }ventoy_image_location;
  83
  84
  85 typedef struct ventoy_os_param
  86 {
  87     ventoy_guid    guid;                  // VENTOY_GUID
  88     grub_uint8_t   chksum;                // checksum
  89
  90     grub_uint8_t   vtoy_disk_guid[16];
  91     grub_uint64_t  vtoy_disk_size;       // disk size in bytes
  92     grub_uint16_t  vtoy_disk_part_id;    // begin with 1
  93     grub_uint16_t  vtoy_disk_part_type;  // 0:exfat   1:ntfs  other: reserved
  94     char           vtoy_img_path[384];   // It seems to be enough, utf-8 format
  95     grub_uint64_t  vtoy_img_size;        // image file size in bytes
  96
  97     /*
  98      * Ventoy will write a copy of ventoy_image_location data into runtime memory
  99      * this is the physically address and length of that memory.
 100      * Address 0 means no such data exist.
 101      * Address will be aligned by 4KB.
 102      *
 103      */
 104     grub_uint64_t  vtoy_img_location_addr;
 105     grub_uint32_t  vtoy_img_location_len;
 106
 107     /*
 108      * These 32 bytes are reserved by ventoy.
 109      *
 110      * vtoy_reserved[0]: vtoy_break_level
 111      * vtoy_reserved[1]: vtoy_debug_level
 112      *
 113      */
 114     grub_uint8_t   vtoy_reserved[32];    // Internal use by ventoy
 115
 116     grub_uint8_t   reserved[31];
 117 }ventoy_os_param;
 118
 119
 120 typedef struct ventoy_windows_data
 121 {
 122     char auto_install_script[384];
 123     grub_uint8_t reserved[128];
 124 }ventoy_windows_data;
 125
 126
 127
 128 #pragma pack()
 129
 130 // compile assert check : sizeof(ventoy_os_param) must be 512
 131 COMPILE_ASSERT(sizeof(ventoy_os_param) == 512);
 132
 133
 134
 135
 136
 137
 138
 139 #pragma pack(4)
 140
 141 typedef struct ventoy_chain_head
 142 {
 143     ventoy_os_param os_param;
 144
 145     grub_uint32_t disk_drive;
 146     grub_uint32_t drive_map;
 147     grub_uint32_t disk_sector_size;
 148
 149     grub_uint64_t real_img_size_in_bytes;
 150     grub_uint64_t virt_img_size_in_bytes;
 151     grub_uint32_t boot_catalog;
 152     grub_uint8_t  boot_catalog_sector[2048];
 153
 154     grub_uint32_t img_chunk_offset;
 155     grub_uint32_t img_chunk_num;
 156
 157     grub_uint32_t override_chunk_offset;
 158     grub_uint32_t override_chunk_num;
 159
 160     grub_uint32_t virt_chunk_offset;
 161     grub_uint32_t virt_chunk_num;
 162 }ventoy_chain_head;
 163
 164 typedef struct ventoy_img_chunk
 165 {
 166     grub_uint32_t img_start_sector; // sector size: 2KB
 167     grub_uint32_t img_end_sector;   // included
 168
 169     grub_uint64_t disk_start_sector; // in disk_sector_size
 170     grub_uint64_t disk_end_sector;   // included
 171 }ventoy_img_chunk;
 172
 173
 174 typedef struct ventoy_override_chunk
 175 {
 176     grub_uint64_t img_offset;
 177     grub_uint32_t override_size;
 178     grub_uint8_t  override_data[512];
 179 }ventoy_override_chunk;
 180
 181 typedef struct ventoy_virt_chunk
 182 {
 183     grub_uint32_t mem_sector_start;
 184     grub_uint32_t mem_sector_end;
 185     grub_uint32_t mem_sector_offset;
 186     grub_uint32_t remap_sector_start;
 187     grub_uint32_t remap_sector_end;
 188     grub_uint32_t org_sector_start;
 189 }ventoy_virt_chunk;
 190
 191 #define DEFAULT_CHUNK_NUM   1024
 192 typedef struct ventoy_img_chunk_list
 193 {
 194     grub_uint32_t max_chunk;
 195     grub_uint32_t cur_chunk;
 196     ventoy_img_chunk *chunk;
 197 }ventoy_img_chunk_list;
 198
 199
 200 #pragma pack()
 201
 202 #define ventoy_filt_register grub_file_filter_register
 203
 204 typedef const char * (*grub_env_get_pf)(const char *name);
 205
 206 #pragma pack(1)
 207
 208 #define GRUB_FILE_REPLACE_MAGIC  0x1258BEEF
 209
 210 typedef struct ventoy_grub_param_file_replace
 211 {
 212     grub_uint32_t magic;
 213     char old_file_name[4][256];
 214     grub_uint32_t old_name_cnt;
 215     grub_uint32_t new_file_virtual_id;
 216 }ventoy_grub_param_file_replace;
 217
 218 typedef struct ventoy_grub_param
 219 {
 220     grub_env_get_pf grub_env_get;
 221
 222     ventoy_grub_param_file_replace file_replace;
 223 }ventoy_grub_param;
 224
 225 #pragma pack()
 226
 227
 228 int grub_ext_get_file_chunk(grub_uint64_t part_start, grub_file_t file, ventoy_img_chunk_list *chunk_list);
 229 int grub_fat_get_file_chunk(grub_uint64_t part_start, grub_file_t file, ventoy_img_chunk_list *chunk_list);
 230 grub_uint64_t grub_iso9660_get_last_read_pos(grub_file_t file);
 231 grub_uint64_t grub_iso9660_get_last_file_dirent_pos(grub_file_t file);
 232 grub_uint64_t grub_udf_get_file_offset(grub_file_t file);
 233 grub_uint64_t grub_udf_get_last_pd_size_offset(void);
 234 grub_uint64_t grub_udf_get_last_file_attr_offset
 235 (
 236     grub_file_t file,
 237     grub_uint32_t *startBlock,
 238     grub_uint64_t *fe_entry_size_offset
 239 );
 240 int ventoy_is_efi_os(void);
 241
 242 #endif /* __VENTOY_H__ */
 243