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 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 #include "../EfiLib/GenericBdsLib.h"
  54 #endif
  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_MOK_TOOL       (12)
  73 #define NUM_TOOLS          (11)
  74
  75 #define NUM_SCAN_OPTIONS 10
  76
  77 #define DEFAULT_ICONS_DIR L"icons"
  78
  79 // OS bit codes; used in GlobalConfig.GraphicsOn
  80 #define GRAPHICS_FOR_OSX        1
  81 #define GRAPHICS_FOR_LINUX      2
  82 #define GRAPHICS_FOR_ELILO      4
  83 #define GRAPHICS_FOR_GRUB       8
  84 #define GRAPHICS_FOR_WINDOWS   16
  85
  86 // Type of legacy (BIOS) boot support detected
  87 #define LEGACY_TYPE_NONE 0
  88 #define LEGACY_TYPE_MAC  1
  89 #define LEGACY_TYPE_UEFI 2
  90
  91 #ifdef __MAKEWITH_GNUEFI
  92 //
  93 // define BBS Device Types
  94 //
  95 #define BBS_FLOPPY        0x01
  96 #define BBS_HARDDISK      0x02
  97 #define BBS_CDROM         0x03
  98 #define BBS_PCMCIA        0x04
  99 #define BBS_USB           0x05
 100 #define BBS_EMBED_NETWORK 0x06
 101 #define BBS_BEV_DEVICE    0x80
 102 #define BBS_UNKNOWN       0xff
 103 #endif
 104
 105 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
 106 #define DEVICE_TYPE_HW         0x01
 107 #define DEVICE_TYPE_ACPI       0x02 /* returned by UEFI boot loader on USB */
 108 #define DEVICE_TYPE_MESSAGING  0x03
 109 #define DEVICE_TYPE_MEDIA      0x04 /* returned by EFI boot loaders on hard disk */
 110 #define DEVICE_TYPE_BIOS       0x05 /* returned by legacy (BIOS) boot loaders */
 111 #define DEVICE_TYPE_END        0x75 /* end of path */
 112
 113 // Filesystem type identifiers. Not all are yet used....
 114 #define FS_TYPE_UNKNOWN        0
 115 #define FS_TYPE_FAT            1
 116 #define FS_TYPE_EXT2           2
 117 #define FS_TYPE_EXT3           3
 118 #define FS_TYPE_EXT4           4
 119 #define FS_TYPE_HFSPLUS        5
 120 #define FS_TYPE_REISERFS       6
 121 #define FS_TYPE_ISO9660        7
 122
 123 // Names of binaries that can manage MOKs....
 124 #define MOK_NAMES               L"MokManager.efi,HashTool.efi,HashTool-signed.efi"
 125 // Directories to search for these MOK-managing programs. Note that SelfDir is
 126 // searched in addition to these locations....
 127 #define MOK_LOCATIONS           L"\\,EFI\\tools,EFI\\fedora,EFI\\redhat,EFI\\ubuntu,EFI\\suse,EFI\\altlinux"
 128
 129 //
 130 // global definitions
 131 //
 132
 133 // global types
 134
 135 typedef struct {
 136    UINT8 Flags;
 137    UINT8 StartCHS1;
 138    UINT8 StartCHS2;
 139    UINT8 StartCHS3;
 140    UINT8 Type;
 141    UINT8 EndCHS1;
 142    UINT8 EndCHS2;
 143    UINT8 EndCHS3;
 144    UINT32 StartLBA;
 145    UINT32 Size;
 146 } MBR_PARTITION_INFO;
 147
 148 typedef struct {
 149    EFI_DEVICE_PATH     *DevicePath;
 150    EFI_HANDLE          DeviceHandle;
 151    EFI_FILE            *RootDir;
 152    CHAR16              *VolName;
 153    UINTN               VolNumber;
 154    EG_IMAGE            *VolIconImage;
 155    EG_IMAGE            *VolBadgeImage;
 156    UINTN               DiskKind;
 157    BOOLEAN             IsAppleLegacy;
 158    BOOLEAN             HasBootCode;
 159    CHAR16              *OSIconName;
 160    CHAR16              *OSName;
 161    BOOLEAN             IsMbrPartition;
 162    UINTN               MbrPartitionIndex;
 163    EFI_BLOCK_IO        *BlockIO;
 164    UINT64              BlockIOOffset;
 165    EFI_BLOCK_IO        *WholeDiskBlockIO;
 166    EFI_DEVICE_PATH     *WholeDiskDevicePath;
 167    MBR_PARTITION_INFO  *MbrPartitionTable;
 168    BOOLEAN             IsReadable;
 169    UINT32              FSType;
 170 } REFIT_VOLUME;
 171
 172 typedef struct _refit_menu_entry {
 173    CHAR16      *Title;
 174    UINTN       Tag;
 175    UINTN       Row;
 176    CHAR16      ShortcutDigit;
 177    CHAR16      ShortcutLetter;
 178    EG_IMAGE    *Image;
 179    EG_IMAGE    *BadgeImage;
 180    struct _refit_menu_screen *SubScreen;
 181 } REFIT_MENU_ENTRY;
 182
 183 typedef struct _refit_menu_screen {
 184    CHAR16      *Title;
 185    EG_IMAGE    *TitleImage;
 186    UINTN       InfoLineCount;
 187    CHAR16      **InfoLines;
 188    UINTN       EntryCount;     // total number of entries registered
 189    REFIT_MENU_ENTRY **Entries;
 190    UINTN       TimeoutSeconds;
 191    CHAR16      *TimeoutText;
 192    CHAR16      *Hint1;
 193    CHAR16      *Hint2;
 194 } REFIT_MENU_SCREEN;
 195
 196 typedef struct {
 197    REFIT_MENU_ENTRY me;
 198    CHAR16           *Title;
 199    CHAR16           *LoaderPath;
 200    CHAR16           *VolName;
 201    EFI_DEVICE_PATH  *DevicePath;
 202    BOOLEAN          UseGraphicsMode;
 203    BOOLEAN          Enabled;
 204    CHAR16           *LoadOptions;
 205    CHAR16           *InitrdPath; // Linux stub loader only
 206    CHAR8            OSType;
 207 } LOADER_ENTRY;
 208
 209 typedef struct {
 210    REFIT_MENU_ENTRY  me;
 211    REFIT_VOLUME      *Volume;
 212 #ifndef __MAKEWITH_GNUEFI
 213    BDS_COMMON_OPTION *BdsOption;
 214 #endif
 215    CHAR16            *LoadOptions;
 216    BOOLEAN           Enabled;
 217 } LEGACY_ENTRY;
 218
 219 typedef struct {
 220    BOOLEAN     TextOnly;
 221    BOOLEAN     ScanAllLinux;
 222    UINTN       RequestedScreenWidth;
 223    UINTN       RequestedScreenHeight;
 224    UINTN       BannerBottomEdge;
 225    UINTN       RequestedTextMode;
 226    UINTN       Timeout;
 227    UINTN       HideUIFlags;
 228    UINTN       MaxTags;     // max. number of OS entries to show simultaneously in graphics mode
 229    UINTN       GraphicsFor;
 230    UINTN       LegacyType;
 231    UINTN       ScanDelay;
 232    CHAR16      *BannerFileName;
 233    EG_IMAGE    *ScreenBackground;
 234    CHAR16      *SelectionSmallFileName;
 235    CHAR16      *SelectionBigFileName;
 236    CHAR16      *DefaultSelection;
 237    CHAR16      *AlsoScan;
 238    CHAR16      *DontScanVolumes;
 239    CHAR16      *DontScanDirs;
 240    CHAR16      *DontScanFiles;
 241    CHAR16      *DriverDirs;
 242    CHAR16      *IconsDir;
 243    UINTN       ShowTools[NUM_TOOLS];
 244    CHAR8       ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
 245 } REFIT_CONFIG;
 246
 247 // Global variables
 248
 249 extern EFI_HANDLE       SelfImageHandle;
 250 extern EFI_LOADED_IMAGE *SelfLoadedImage;
 251 extern EFI_FILE         *SelfRootDir;
 252 extern EFI_FILE         *SelfDir;
 253 extern CHAR16           *SelfDirPath;
 254
 255 extern REFIT_VOLUME     *SelfVolume;
 256 extern REFIT_VOLUME     **Volumes;
 257 extern UINTN            VolumesCount;
 258
 259 extern REFIT_CONFIG     GlobalConfig;
 260
 261 extern EFI_GUID gEfiLegacyBootProtocolGuid;
 262 extern EFI_GUID gEfiGlobalVariableGuid;
 263
 264 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
 265 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
 266 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume);
 267 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
 268 LOADER_ENTRY * AddLoaderEntry(IN CHAR16 *LoaderPath, IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume);
 269 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
 270 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
 271
 272 #endif
 273
 274 /* EOF */