code.delx.au - refind/blob - refind/global.h

   1 /*
   2  * refit/global.h
   3  * Global header file
   4  *
   5  * Copyright (c) 2006-2009 Christoph Pfisterer
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are
  10  * met:
  11  *
  12  *  * Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  *  * Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  *  * Neither the name of Christoph Pfisterer nor the names of the
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36 /*
  37  * Modifications copyright (c) 2012-2014 Roderick W. Smith
  38  *
  39  * Modifications distributed under the terms of the GNU General Public
  40  * License (GPL) version 3 (GPLv3), a copy of which must be distributed
  41  * with this source code or binaries made from it.
  42  *
  43  */
  44
  45 #ifndef __GLOBAL_H_
  46 #define __GLOBAL_H_
  47
  48 #ifdef __MAKEWITH_GNUEFI
  49 #include <efi.h>
  50 #include <efilib.h>
  51 #else
  52 #include "../include/tiano_includes.h"
  53 #endif
  54 #include "../EfiLib/GenericBdsLib.h"
  55
  56 #include "libeg.h"
  57
  58 #define REFIT_DEBUG (0)
  59
  60 // Tag classifications; used in various ways.
  61 #define TAG_ABOUT            (1)
  62 #define TAG_REBOOT           (2)
  63 #define TAG_SHUTDOWN         (3)
  64 #define TAG_TOOL             (4)
  65 #define TAG_LOADER           (5)
  66 #define TAG_LEGACY           (6)
  67 #define TAG_EXIT             (7)
  68 #define TAG_SHELL            (8)
  69 #define TAG_GPTSYNC          (9)
  70 #define TAG_LEGACY_UEFI      (10)
  71 #define TAG_APPLE_RECOVERY   (11)
  72 #define TAG_WINDOWS_RECOVERY (12)
  73 #define TAG_MOK_TOOL         (13)
  74 #define TAG_FIRMWARE         (14)
  75 #define TAG_MEMTEST          (15)
  76 #define TAG_GDISK            (16)
  77 #define NUM_TOOLS            (17)
  78
  79 #define NUM_SCAN_OPTIONS 10
  80
  81 #define DEFAULT_ICONS_DIR L"icons"
  82
  83 // OS bit codes; used in GlobalConfig.GraphicsOn
  84 #define GRAPHICS_FOR_OSX        1
  85 #define GRAPHICS_FOR_LINUX      2
  86 #define GRAPHICS_FOR_ELILO      4
  87 #define GRAPHICS_FOR_GRUB       8
  88 #define GRAPHICS_FOR_WINDOWS   16
  89
  90 // Type of legacy (BIOS) boot support detected
  91 #define LEGACY_TYPE_NONE 0
  92 #define LEGACY_TYPE_MAC  1
  93 #define LEGACY_TYPE_UEFI 2
  94
  95 #ifdef __MAKEWITH_GNUEFI
  96 //
  97 // define BBS Device Types
  98 //
  99 #define BBS_FLOPPY        0x01
 100 #define BBS_HARDDISK      0x02
 101 #define BBS_CDROM         0x03
 102 #define BBS_PCMCIA        0x04
 103 #define BBS_USB           0x05
 104 #define BBS_EMBED_NETWORK 0x06
 105 #define BBS_BEV_DEVICE    0x80
 106 #define BBS_UNKNOWN       0xff
 107 #endif
 108
 109 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
 110 #define DEVICE_TYPE_HW         0x01
 111 #define DEVICE_TYPE_ACPI       0x02 /* returned by UEFI boot loader on USB */
 112 #define DEVICE_TYPE_MESSAGING  0x03
 113 #define DEVICE_TYPE_MEDIA      0x04 /* returned by EFI boot loaders on hard disk */
 114 #define DEVICE_TYPE_BIOS       0x05 /* returned by legacy (BIOS) boot loaders */
 115 #define DEVICE_TYPE_END        0x75 /* end of path */
 116
 117 // Filesystem type identifiers. Not all are yet used....
 118 #define FS_TYPE_UNKNOWN        0
 119 #define FS_TYPE_FAT            1
 120 #define FS_TYPE_EXT2           2
 121 #define FS_TYPE_EXT3           3
 122 #define FS_TYPE_EXT4           4
 123 #define FS_TYPE_HFSPLUS        5
 124 #define FS_TYPE_REISERFS       6
 125 #define FS_TYPE_BTRFS          7
 126 #define FS_TYPE_ISO9660        8
 127
 128 // How to scale banner images
 129 #define BANNER_NOSCALE         0
 130 #define BANNER_FILLSCREEN      1
 131
 132 // Sizes of the default icons; badges are 1/4 the big icon size
 133 #define DEFAULT_SMALL_ICON_SIZE 48
 134 #define DEFAULT_BIG_ICON_SIZE   128
 135
 136 // Codes for types of icon sizes; used for indexing into GlobalConfig.IconSizes[]
 137 #define ICON_SIZE_BADGE 0
 138 #define ICON_SIZE_SMALL 1
 139 #define ICON_SIZE_BIG   2
 140
 141 // Names of binaries that can manage MOKs....
 142 #define MOK_NAMES               L"MokManager.efi,HashTool.efi,HashTool-signed.efi"
 143 // Directories to search for these MOK-managing programs. Note that SelfDir is
 144 // searched in addition to these locations....
 145 #define MOK_LOCATIONS           L"\\,EFI\\tools,EFI\\fedora,EFI\\redhat,EFI\\ubuntu,EFI\\suse,EFI\\opensuse,EFI\\altlinux"
 146 // Directories to search for memtest86....
 147 #define MEMTEST_LOCATIONS       L"EFI\\tools,EFI\\tools\\memtest86,EFI\\tools\\memtest,EFI\\memtest86,EFI\\memtest"
 148 // Files that may be Windows recovery files
 149 #define WINDOWS_RECOVERY_FILES  L"EFI\\Microsoft\\Boot\\LrsBootmgr.efi"
 150
 151 #define NULL_GUID_VALUE { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} };
 152 #define REFIND_GUID_VALUE { 0x36D08FA7, 0xCF0B, 0x42F5, {0x8F, 0x14, 0x68, 0xDF, 0x73, 0xED, 0x37, 0x40} };
 153
 154 //
 155 // global definitions
 156 //
 157
 158 // global types
 159
 160 typedef struct {
 161    UINT8 Flags;
 162    UINT8 StartCHS1;
 163    UINT8 StartCHS2;
 164    UINT8 StartCHS3;
 165    UINT8 Type;
 166    UINT8 EndCHS1;
 167    UINT8 EndCHS2;
 168    UINT8 EndCHS3;
 169    UINT32 StartLBA;
 170    UINT32 Size;
 171 } MBR_PARTITION_INFO;
 172
 173 typedef struct {
 174    EFI_DEVICE_PATH     *DevicePath;
 175    EFI_HANDLE          DeviceHandle;
 176    EFI_FILE            *RootDir;
 177    CHAR16              *VolName;
 178    CHAR16              *PartName;
 179    EFI_GUID            VolUuid;
 180    EFI_GUID            PartGuid;
 181    UINTN               VolNumber;
 182    EG_IMAGE            *VolIconImage;
 183    EG_IMAGE            *VolBadgeImage;
 184    UINTN               DiskKind;
 185    BOOLEAN             IsAppleLegacy;
 186    BOOLEAN             HasBootCode;
 187    CHAR16              *OSIconName;
 188    CHAR16              *OSName;
 189    BOOLEAN             IsMbrPartition;
 190    UINTN               MbrPartitionIndex;
 191    EFI_BLOCK_IO        *BlockIO;
 192    UINT64              BlockIOOffset;
 193    EFI_BLOCK_IO        *WholeDiskBlockIO;
 194    EFI_DEVICE_PATH     *WholeDiskDevicePath;
 195    MBR_PARTITION_INFO  *MbrPartitionTable;
 196    BOOLEAN             IsReadable;
 197    UINT32              FSType;
 198 } REFIT_VOLUME;
 199
 200 typedef struct _refit_menu_entry {
 201    CHAR16      *Title;
 202    UINTN       Tag;
 203    UINTN       Row;
 204    CHAR16      ShortcutDigit;
 205    CHAR16      ShortcutLetter;
 206    EG_IMAGE    *Image;
 207    EG_IMAGE    *BadgeImage;
 208    struct _refit_menu_screen *SubScreen;
 209 } REFIT_MENU_ENTRY;
 210
 211 typedef struct _refit_menu_screen {
 212    CHAR16      *Title;
 213    EG_IMAGE    *TitleImage;
 214    UINTN       InfoLineCount;
 215    CHAR16      **InfoLines;
 216    UINTN       EntryCount;     // total number of entries registered
 217    REFIT_MENU_ENTRY **Entries;
 218    UINTN       TimeoutSeconds;
 219    CHAR16      *TimeoutText;
 220    CHAR16      *Hint1;
 221    CHAR16      *Hint2;
 222 } REFIT_MENU_SCREEN;
 223
 224 typedef struct {
 225    REFIT_MENU_ENTRY me;
 226    CHAR16           *Title;
 227    CHAR16           *LoaderPath;
 228    CHAR16           *VolName;
 229    EFI_DEVICE_PATH  *DevicePath;
 230    BOOLEAN          UseGraphicsMode;
 231    BOOLEAN          Enabled;
 232    CHAR16           *LoadOptions;
 233    CHAR16           *InitrdPath; // Linux stub loader only
 234    CHAR8            OSType;
 235 } LOADER_ENTRY;
 236
 237 typedef struct {
 238    REFIT_MENU_ENTRY  me;
 239    REFIT_VOLUME      *Volume;
 240 //#ifndef __MAKEWITH_GNUEFI
 241    BDS_COMMON_OPTION *BdsOption;
 242 //#endif
 243    CHAR16            *LoadOptions;
 244    BOOLEAN           Enabled;
 245 } LEGACY_ENTRY;
 246
 247 typedef struct {
 248    BOOLEAN     TextOnly;
 249    BOOLEAN     ScanAllLinux;
 250    BOOLEAN     DeepLegacyScan;
 251    UINTN       RequestedScreenWidth;
 252    UINTN       RequestedScreenHeight;
 253    UINTN       BannerBottomEdge;
 254    UINTN       RequestedTextMode;
 255    UINTN       Timeout;
 256    UINTN       HideUIFlags;
 257    UINTN       MaxTags;     // max. number of OS entries to show simultaneously in graphics mode
 258    UINTN       GraphicsFor;
 259    UINTN       LegacyType;
 260    UINTN       ScanDelay;
 261    UINTN       ScreensaverTime;
 262    UINTN       IconSizes[3];
 263    UINTN       BannerScale;
 264    CHAR16      *BannerFileName;
 265    EG_IMAGE    *ScreenBackground;
 266    CHAR16      *ConfigFilename;
 267    CHAR16      *SelectionSmallFileName;
 268    CHAR16      *SelectionBigFileName;
 269    CHAR16      *DefaultSelection;
 270    CHAR16      *AlsoScan;
 271    CHAR16      *DontScanVolumes;
 272    CHAR16      *DontScanDirs;
 273    CHAR16      *DontScanFiles;
 274    CHAR16      *WindowsRecoveryFiles;
 275    CHAR16      *DriverDirs;
 276    CHAR16      *IconsDir;
 277    UINTN       ShowTools[NUM_TOOLS];
 278    CHAR8       ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
 279 } REFIT_CONFIG;
 280
 281 // Global variables
 282
 283 extern EFI_HANDLE       SelfImageHandle;
 284 extern EFI_LOADED_IMAGE *SelfLoadedImage;
 285 extern EFI_FILE         *SelfRootDir;
 286 extern EFI_FILE         *SelfDir;
 287 extern CHAR16           *SelfDirPath;
 288
 289 extern REFIT_VOLUME     *SelfVolume;
 290 extern REFIT_VOLUME     **Volumes;
 291 extern UINTN            VolumesCount;
 292
 293 extern REFIT_CONFIG     GlobalConfig;
 294
 295 extern EFI_GUID gEfiLegacyBootProtocolGuid;
 296 extern EFI_GUID gEfiGlobalVariableGuid;
 297
 298 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
 299 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
 300 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume);
 301 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
 302 LOADER_ENTRY * AddLoaderEntry(IN CHAR16 *LoaderPath, IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume);
 303 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
 304 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
 305
 306 #endif
 307
 308 /* EOF */