EDK2/edk2_mod/edk2-edk2-stable201911/MdeModulePkg/Application/Ventoy/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_GUID { 0x77772020, 0x2e77, 0x6576, { 0x6e, 0x74, 0x6f, 0x79, 0x2e, 0x6e, 0x65, 0x74 }}
  27
  28 typedef enum ventoy_chain_type
  29 {
  30     ventoy_chain_linux = 0, /* 0: linux */
  31     ventoy_chain_windows,   /* 1: windows */
  32     ventoy_chain_wim,       /* 2: wim */
  33
  34     ventoy_chain_max
  35 }ventoy_chain_type;
  36
  37 #pragma pack(1)
  38
  39 typedef struct ventoy_guid
  40 {
  41     UINT32   data1;
  42     UINT16   data2;
  43     UINT16   data3;
  44     UINT8    data4[8];
  45 }ventoy_guid;
  46
  47 typedef struct ventoy_image_disk_region
  48 {
  49     UINT32   image_sector_count; /* image sectors contained in this region */
  50     UINT32   image_start_sector; /* image sector start */
  51     UINT64   disk_start_sector;  /* disk sector start */
  52 }ventoy_image_disk_region;
  53
  54 typedef struct ventoy_image_location
  55 {
  56     ventoy_guid  guid;
  57
  58     /* image sector size, currently this value is always 2048 */
  59     UINT32   image_sector_size;
  60
  61     /* disk sector size, normally the value is 512 */
  62     UINT32   disk_sector_size;
  63
  64     UINT32   region_count;
  65
  66     /*
  67      * disk region data
  68      * If the image file has more than one fragments in disk,
  69      * there will be more than one region data here.
  70      *
  71      */
  72     ventoy_image_disk_region regions[1];
  73
  74     /* ventoy_image_disk_region regions[2~region_count-1] */
  75 }ventoy_image_location;
  76
  77 typedef struct ventoy_os_param
  78 {
  79     ventoy_guid    guid;                  // VENTOY_GUID
  80     UINT8   chksum;                // checksum
  81
  82     UINT8   vtoy_disk_guid[16];
  83     UINT64  vtoy_disk_size;       // disk size in bytes
  84     UINT16  vtoy_disk_part_id;    // begin with 1
  85     UINT16  vtoy_disk_part_type;  // 0:exfat   1:ntfs  other: reserved
  86     char    vtoy_img_path[384];   // It seems to be enough, utf-8 format
  87     UINT64  vtoy_img_size;        // image file size in bytes
  88
  89     /*
  90      * Ventoy will write a copy of ventoy_image_location data into runtime memory
  91      * this is the physically address and length of that memory.
  92      * Address 0 means no such data exist.
  93      * Address will be aligned by 4KB.
  94      *
  95      */
  96     UINT64  vtoy_img_location_addr;
  97     UINT32  vtoy_img_location_len;
  98
  99     UINT64  vtoy_reserved[4];     // Internal use by ventoy
 100
 101     UINT8   reserved[31];
 102 }ventoy_os_param;
 103
 104 #pragma pack()
 105
 106 // compile assert to check that size of ventoy_os_param must be 512
 107 COMPILE_ASSERT(sizeof(ventoy_os_param) == 512);
 108
 109
 110
 111 #pragma pack(4)
 112
 113 typedef struct ventoy_chain_head
 114 {
 115     ventoy_os_param os_param;
 116
 117     UINT32 disk_drive;
 118     UINT32 drive_map;
 119     UINT32 disk_sector_size;
 120
 121     UINT64 real_img_size_in_bytes;
 122     UINT64 virt_img_size_in_bytes;
 123     UINT32 boot_catalog;
 124     UINT8  boot_catalog_sector[2048];
 125
 126     UINT32 img_chunk_offset;
 127     UINT32 img_chunk_num;
 128
 129     UINT32 override_chunk_offset;
 130     UINT32 override_chunk_num;
 131
 132     UINT32 virt_chunk_offset;
 133     UINT32 virt_chunk_num;
 134 }ventoy_chain_head;
 135
 136
 137 typedef struct ventoy_img_chunk
 138 {
 139     UINT32 img_start_sector; //2KB
 140     UINT32 img_end_sector;
 141
 142     UINT64 disk_start_sector; // in disk_sector_size
 143     UINT64 disk_end_sector;
 144 }ventoy_img_chunk;
 145
 146
 147 typedef struct ventoy_override_chunk
 148 {
 149     UINT64 img_offset;
 150     UINT32 override_size;
 151     UINT8  override_data[512];
 152 }ventoy_override_chunk;
 153
 154 typedef struct ventoy_virt_chunk
 155 {
 156     UINT32 mem_sector_start;
 157     UINT32 mem_sector_end;
 158     UINT32 mem_sector_offset;
 159     UINT32 remap_sector_start;
 160     UINT32 remap_sector_end;
 161     UINT32 org_sector_start;
 162 }ventoy_virt_chunk;
 163
 164
 165 #pragma pack()
 166
 167
 168 #define VTOY_BLOCK_DEVICE_PATH_GUID                                     \
 169         { 0x37b87ac6, 0xc180, 0x4583, { 0xa7, 0x05, 0x41, 0x4d, 0xa8, 0xf7, 0x7e, 0xd2 }}
 170
 171 #define ISO9660_EFI_DRIVER_PATH  L"\\ventoy\\iso9660_x64.efi"
 172
 173 #define VTOY_BLOCK_DEVICE_PATH_NAME  L"ventoy"
 174
 175 #if   defined (MDE_CPU_IA32)
 176   #define VENTOY_UEFI_DESC   L"IA32 UEFI"
 177 #elif defined (MDE_CPU_X64)
 178   #define VENTOY_UEFI_DESC   L"X64 UEFI"
 179 #elif defined (MDE_CPU_EBC)
 180 #elif defined (MDE_CPU_ARM)
 181   #define VENTOY_UEFI_DESC   L"ARM UEFI"
 182 #elif defined (MDE_CPU_AARCH64)
 183   #define VENTOY_UEFI_DESC   L"ARM64 UEFI"
 184 #else
 185   #error Unknown Processor Type
 186 #endif
 187
 188 typedef struct ventoy_sector_flag
 189 {
 190     UINT8 flag; // 0:init   1:mem  2:remap
 191     UINT64 remap_lba;
 192 }ventoy_sector_flag;
 193
 194
 195 typedef struct vtoy_block_data
 196 {
 197         EFI_HANDLE Handle;
 198         EFI_BLOCK_IO_MEDIA Media;       /* Media descriptor */
 199         EFI_BLOCK_IO_PROTOCOL BlockIo;  /* Block I/O protocol */
 200
 201     UINTN DevicePathCompareLen;
 202         EFI_DEVICE_PATH_PROTOCOL *Path; /* Device path protocol */
 203
 204     EFI_HANDLE RawBlockIoHandle;
 205     EFI_BLOCK_IO_PROTOCOL *pRawBlockIo;
 206     EFI_DEVICE_PATH_PROTOCOL *pDiskDevPath;
 207
 208     /* ventoy disk part2 ESP */
 209     EFI_HANDLE DiskFsHandle;
 210     EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *pDiskFs;
 211     EFI_DEVICE_PATH_PROTOCOL *pDiskFsDevPath;
 212
 213     EFI_HANDLE IsoDriverImage;
 214 }vtoy_block_data;
 215
 216
 217 #define debug(expr, ...) if (gDebugPrint) VtoyDebug("[VTOY] "expr"\r\n", ##__VA_ARGS__)
 218 #define trace(expr, ...) VtoyDebug("[VTOY] "expr"\r\n", ##__VA_ARGS__)
 219 #define sleep(sec) gBS->Stall(1000000 * (sec))
 220
 221 #define ventoy_debug_pause() \
 222 if (gDebugPrint) \
 223 { \
 224     UINTN __Index = 0; \
 225     gST->ConOut->OutputString(gST->ConOut, L"[VTOY] ###### Press Enter to continue... ######\r\n");\
 226     gST->ConIn->Reset(gST->ConIn, FALSE); \
 227     gBS->WaitForEvent(1, &gST->ConIn->WaitForKey, &__Index);\
 228 }
 229
 230 typedef const char * (*grub_env_get_pf)(const char *name);
 231 typedef int (*grub_env_printf_pf)(const char *fmt, ...);
 232
 233 #pragma pack(1)
 234
 235 #define GRUB_FILE_REPLACE_MAGIC  0x1258BEEF
 236
 237 typedef struct ventoy_efi_file_replace
 238 {
 239     UINT64 BlockIoSectorStart;
 240
 241     UINT64 CurPos;
 242     UINT64 FileSizeBytes;
 243
 244     EFI_FILE_PROTOCOL  WrapperHandle;
 245 }ventoy_efi_file_replace;
 246
 247 typedef struct ventoy_grub_param_file_replace
 248 {
 249     UINT32 magic;
 250     char   old_file_name[4][256];
 251     UINT32 old_file_cnt;
 252     UINT32 new_file_virtual_id;
 253 }ventoy_grub_param_file_replace;
 254
 255 typedef struct ventoy_grub_param
 256 {
 257     grub_env_get_pf grub_env_get;
 258     ventoy_grub_param_file_replace file_replace;
 259     grub_env_printf_pf grub_env_printf;
 260 }ventoy_grub_param;
 261
 262 typedef struct ventoy_ram_disk
 263 {
 264     UINT64 PhyAddr;
 265     UINT64 DiskSize;
 266 }ventoy_ram_disk;
 267
 268 typedef struct ventoy_iso9660_override
 269 {
 270     UINT32 first_sector;
 271     UINT32 first_sector_be;
 272     UINT32 size;
 273     UINT32 size_be;
 274 }ventoy_iso9660_override;
 275
 276 #pragma pack()
 277
 278
 279 typedef struct well_known_guid
 280 {
 281         EFI_GUID *guid;
 282         const char *name;
 283 }well_known_guid;
 284
 285 typedef struct ventoy_system_wrapper
 286 {
 287     EFI_LOCATE_PROTOCOL NewLocateProtocol;
 288     EFI_LOCATE_PROTOCOL OriLocateProtocol;
 289
 290     EFI_HANDLE_PROTOCOL NewHandleProtocol;
 291     EFI_HANDLE_PROTOCOL OriHandleProtocol;
 292
 293     EFI_OPEN_PROTOCOL NewOpenProtocol;
 294     EFI_OPEN_PROTOCOL OriOpenProtocol;
 295
 296     EFI_LOCATE_HANDLE_BUFFER NewLocateHandleBuffer;
 297     EFI_LOCATE_HANDLE_BUFFER OriLocateHandleBuffer;
 298
 299     EFI_PROTOCOLS_PER_HANDLE NewProtocolsPerHandle;
 300     EFI_PROTOCOLS_PER_HANDLE OriProtocolsPerHandle;
 301
 302     EFI_LOCATE_HANDLE NewLocateHandle;
 303     EFI_LOCATE_HANDLE OriLocateHandle;
 304
 305     EFI_LOCATE_DEVICE_PATH NewLocateDevicePath;
 306     EFI_LOCATE_DEVICE_PATH OriLocateDevicePath;
 307 } ventoy_system_wrapper;
 308
 309 #define ventoy_wrapper(bs, wrapper, func, newfunc) \
 310 {\
 311     wrapper.Ori##func = bs->func;\
 312     wrapper.New##func = newfunc;\
 313     bs->func = wrapper.New##func;\
 314 }
 315
 316 extern BOOLEAN gDebugPrint;
 317 VOID EFIAPI VtoyDebug(IN CONST CHAR8  *Format, ...);
 318 EFI_STATUS EFIAPI ventoy_wrapper_system(VOID);
 319 EFI_STATUS EFIAPI ventoy_block_io_read
 320 (
 321     IN EFI_BLOCK_IO_PROTOCOL          *This,
 322     IN UINT32                          MediaId,
 323     IN EFI_LBA                         Lba,
 324     IN UINTN                           BufferSize,
 325     OUT VOID                          *Buffer
 326 );
 327
 328
 329 extern ventoy_chain_head *g_chain;
 330 extern ventoy_img_chunk *g_chunk;
 331 extern UINT32 g_img_chunk_num;
 332 extern ventoy_override_chunk *g_override_chunk;
 333 extern UINT32 g_override_chunk_num;
 334 extern ventoy_virt_chunk *g_virt_chunk;
 335 extern UINT32 g_virt_chunk_num;
 336 extern vtoy_block_data gBlockData;
 337 extern ventoy_efi_file_replace g_efi_file_replace;
 338 extern ventoy_sector_flag *g_sector_flag;
 339 extern UINT32 g_sector_flag_num;
 340 extern BOOLEAN gMemdiskMode;
 341 extern UINTN g_iso_buf_size;
 342 extern ventoy_grub_param_file_replace *g_file_replace_list;
 343 extern BOOLEAN g_fixup_iso9660_secover_enable;
 344 extern EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *g_con_simple_input_ex;
 345 extern BOOLEAN g_fix_windows_1st_cdrom_issue;
 346
 347 EFI_STATUS EFIAPI ventoy_wrapper_open_volume
 348 (
 349     IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL     *This,
 350     OUT EFI_FILE_PROTOCOL                 **Root
 351 );
 352 EFI_STATUS EFIAPI ventoy_install_blockio(IN EFI_HANDLE ImageHandle, IN UINT64 ImgSize);
 353 EFI_STATUS EFIAPI ventoy_wrapper_push_openvolume(IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_OPEN_VOLUME OpenVolume);
 354 EFI_STATUS ventoy_hook_keyboard_start(VOID);
 355 EFI_STATUS ventoy_hook_keyboard_stop(VOID);
 356 BOOLEAN ventoy_is_cdrom_dp_exist(VOID);
 357 EFI_STATUS ventoy_hook_1st_cdrom_start(VOID);
 358 EFI_STATUS ventoy_hook_1st_cdrom_stop(VOID);
 359
 360 #endif
 361