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 #ifndef __MAKEWITH_TIANO
  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 //TODO: may want to make this configurable via config file
 114 //static UINT16 SupportedLegacyDevices[] = {BBS_HARDDISK, BBS_CDROM, BBS_USB};
 115
 116 //
 117 // global definitions
 118 //
 119
 120 // global types
 121
 122 typedef struct {
 123    UINT8 Flags;
 124    UINT8 StartCHS1;
 125    UINT8 StartCHS2;
 126    UINT8 StartCHS3;
 127    UINT8 Type;
 128    UINT8 EndCHS1;
 129    UINT8 EndCHS2;
 130    UINT8 EndCHS3;
 131    UINT32 StartLBA;
 132    UINT32 Size;
 133 } MBR_PARTITION_INFO;
 134
 135 typedef struct {
 136    EFI_DEVICE_PATH     *DevicePath;
 137    EFI_HANDLE          DeviceHandle;
 138    EFI_FILE            *RootDir;
 139    CHAR16              *VolName;
 140    EG_IMAGE            *VolIconImage;
 141    EG_IMAGE            *VolBadgeImage;
 142    UINTN               DiskKind;
 143    BOOLEAN             IsAppleLegacy;
 144    BOOLEAN             HasBootCode;
 145    CHAR16              *OSIconName;
 146    CHAR16              *OSName;
 147    BOOLEAN             IsMbrPartition;
 148    UINTN               MbrPartitionIndex;
 149    EFI_BLOCK_IO        *BlockIO;
 150    UINT64              BlockIOOffset;
 151    EFI_BLOCK_IO        *WholeDiskBlockIO;
 152    EFI_DEVICE_PATH     *WholeDiskDevicePath;
 153    MBR_PARTITION_INFO  *MbrPartitionTable;
 154    BOOLEAN             IsReadable;
 155 } REFIT_VOLUME;
 156
 157 typedef struct _refit_menu_entry {
 158    CHAR16      *Title;
 159    UINTN       Tag;
 160    UINTN       Row;
 161    CHAR16      ShortcutDigit;
 162    CHAR16      ShortcutLetter;
 163    EG_IMAGE    *Image;
 164    EG_IMAGE    *BadgeImage;
 165    struct _refit_menu_screen *SubScreen;
 166 } REFIT_MENU_ENTRY;
 167
 168 typedef struct _refit_menu_screen {
 169    CHAR16      *Title;
 170    EG_IMAGE    *TitleImage;
 171    UINTN       InfoLineCount;
 172    CHAR16      **InfoLines;
 173    UINTN       EntryCount;     // total number of entries registered
 174    REFIT_MENU_ENTRY **Entries;
 175    UINTN       TimeoutSeconds;
 176    CHAR16      *TimeoutText;
 177 } REFIT_MENU_SCREEN;
 178
 179 typedef struct {
 180    REFIT_MENU_ENTRY me;
 181    CHAR16           *Title;
 182    CHAR16           *LoaderPath;
 183    CHAR16           *VolName;
 184    EFI_DEVICE_PATH  *DevicePath;
 185    BOOLEAN          UseGraphicsMode;
 186    BOOLEAN          Enabled;
 187    CHAR16           *LoadOptions;
 188    CHAR16           *InitrdPath; // Linux stub loader only
 189    CHAR8            OSType;
 190 } LOADER_ENTRY;
 191
 192 typedef struct {
 193    REFIT_MENU_ENTRY  me;
 194    REFIT_VOLUME      *Volume;
 195 #ifdef __MAKEWITH_TIANO
 196    BDS_COMMON_OPTION *BdsOption;
 197 #endif // __MAKEWITH_TIANO
 198    CHAR16            *LoadOptions;
 199    BOOLEAN           Enabled;
 200 } LEGACY_ENTRY;
 201
 202 typedef struct {
 203    BOOLEAN     TextOnly;
 204    BOOLEAN     ScanAllLinux;
 205    UINTN       RequestedScreenWidth;
 206    UINTN       RequestedScreenHeight;
 207    UINTN       RequestedTextMode;
 208    UINTN       Timeout;
 209    UINTN       HideUIFlags;
 210    UINTN       MaxTags;     // max. number of OS entries to show simultaneously in graphics mode
 211    UINTN       GraphicsFor;
 212    UINTN       LegacyType;
 213    UINTN       ScanDelay;
 214    CHAR16      *BannerFileName;
 215    CHAR16      *SelectionSmallFileName;
 216    CHAR16      *SelectionBigFileName;
 217    CHAR16      *DefaultSelection;
 218    CHAR16      *AlsoScan;
 219    CHAR16      *DontScanVolumes;
 220    CHAR16      *DontScanDirs;
 221    CHAR16      *DontScanFiles;
 222    CHAR16      *DriverDirs;
 223    CHAR16      *IconsDir;
 224    UINTN       ShowTools[NUM_TOOLS];
 225    CHAR8       ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
 226 } REFIT_CONFIG;
 227
 228 // Global variables
 229
 230 extern EFI_HANDLE       SelfImageHandle;
 231 extern EFI_LOADED_IMAGE *SelfLoadedImage;
 232 extern EFI_FILE         *SelfRootDir;
 233 extern EFI_FILE         *SelfDir;
 234 extern CHAR16           *SelfDirPath;
 235
 236 extern REFIT_VOLUME     *SelfVolume;
 237 extern REFIT_VOLUME     **Volumes;
 238 extern UINTN            VolumesCount;
 239
 240 extern REFIT_CONFIG     GlobalConfig;
 241
 242 extern EFI_GUID gEfiLegacyBootProtocolGuid;
 243 extern EFI_GUID gEfiGlobalVariableGuid;
 244
 245 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
 246 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
 247 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume);
 248 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
 249 LOADER_ENTRY * AddLoaderEntry(IN CHAR16 *LoaderPath, IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume);
 250 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
 251 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
 252
 253 #endif
 254
 255 /* EOF */