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 NUM_TOOLS    (10)
  73
  74 #define NUM_SCAN_OPTIONS 10
  75
  76 #define DEFAULT_ICONS_DIR L"icons"
  77
  78 // OS bit codes; used in GlobalConfig.GraphicsOn
  79 #define GRAPHICS_FOR_OSX        1
  80 #define GRAPHICS_FOR_LINUX      2
  81 #define GRAPHICS_FOR_ELILO      4
  82 #define GRAPHICS_FOR_GRUB       8
  83 #define GRAPHICS_FOR_WINDOWS   16
  84
  85 // Type of legacy (BIOS) boot support detected
  86 #define LEGACY_TYPE_NONE 0
  87 #define LEGACY_TYPE_MAC  1
  88 #define LEGACY_TYPE_UEFI 2
  89
  90 #ifndef __MAKEWITH_TIANO
  91 //
  92 // define BBS Device Types
  93 //
  94 #define BBS_FLOPPY        0x01
  95 #define BBS_HARDDISK      0x02
  96 #define BBS_CDROM         0x03
  97 #define BBS_PCMCIA        0x04
  98 #define BBS_USB           0x05
  99 #define BBS_EMBED_NETWORK 0x06
 100 #define BBS_BEV_DEVICE    0x80
 101 #define BBS_UNKNOWN       0xff
 102 #endif
 103
 104 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
 105 #define DEVICE_TYPE_HW         0x01
 106 #define DEVICE_TYPE_ACPI       0x02 /* returned by UEFI boot loader on USB */
 107 #define DEVICE_TYPE_MESSAGING  0x03
 108 #define DEVICE_TYPE_MEDIA      0x04 /* returned by EFI boot loaders on hard disk */
 109 #define DEVICE_TYPE_BIOS       0x05 /* returned by legacy (BIOS) boot loaders */
 110 #define DEVICE_TYPE_END        0x75 /* end of path */
 111
 112 //TODO: may want to make this configurable via config file
 113 //static UINT16 SupportedLegacyDevices[] = {BBS_HARDDISK, BBS_CDROM, BBS_USB};
 114
 115 //
 116 // global definitions
 117 //
 118
 119 // global types
 120
 121 typedef struct {
 122    UINT8 Flags;
 123    UINT8 StartCHS1;
 124    UINT8 StartCHS2;
 125    UINT8 StartCHS3;
 126    UINT8 Type;
 127    UINT8 EndCHS1;
 128    UINT8 EndCHS2;
 129    UINT8 EndCHS3;
 130    UINT32 StartLBA;
 131    UINT32 Size;
 132 } MBR_PARTITION_INFO;
 133
 134 typedef struct {
 135    EFI_DEVICE_PATH     *DevicePath;
 136    EFI_HANDLE          DeviceHandle;
 137    EFI_FILE            *RootDir;
 138    CHAR16              *VolName;
 139    EG_IMAGE            *VolIconImage;
 140    EG_IMAGE            *VolBadgeImage;
 141    UINTN               DiskKind;
 142    BOOLEAN             IsAppleLegacy;
 143    BOOLEAN             HasBootCode;
 144    CHAR16              *OSIconName;
 145    CHAR16              *OSName;
 146    BOOLEAN             IsMbrPartition;
 147    UINTN               MbrPartitionIndex;
 148    EFI_BLOCK_IO        *BlockIO;
 149    UINT64              BlockIOOffset;
 150    EFI_BLOCK_IO        *WholeDiskBlockIO;
 151    EFI_DEVICE_PATH     *WholeDiskDevicePath;
 152    MBR_PARTITION_INFO  *MbrPartitionTable;
 153    BOOLEAN             IsReadable;
 154 } REFIT_VOLUME;
 155
 156 typedef struct _refit_menu_entry {
 157    CHAR16      *Title;
 158    UINTN       Tag;
 159    UINTN       Row;
 160    CHAR16      ShortcutDigit;
 161    CHAR16      ShortcutLetter;
 162    EG_IMAGE    *Image;
 163    EG_IMAGE    *BadgeImage;
 164    struct _refit_menu_screen *SubScreen;
 165 } REFIT_MENU_ENTRY;
 166
 167 typedef struct _refit_menu_screen {
 168    CHAR16      *Title;
 169    EG_IMAGE    *TitleImage;
 170    UINTN       InfoLineCount;
 171    CHAR16      **InfoLines;
 172    UINTN       EntryCount;     // total number of entries registered
 173    REFIT_MENU_ENTRY **Entries;
 174    UINTN       TimeoutSeconds;
 175    CHAR16      *TimeoutText;
 176 } REFIT_MENU_SCREEN;
 177
 178 typedef struct {
 179    REFIT_MENU_ENTRY me;
 180    CHAR16           *Title;
 181    CHAR16           *LoaderPath;
 182    CHAR16           *VolName;
 183    EFI_DEVICE_PATH  *DevicePath;
 184    BOOLEAN          UseGraphicsMode;
 185    BOOLEAN          Enabled;
 186    CHAR16           *LoadOptions;
 187    CHAR16           *InitrdPath; // Linux stub loader only
 188    CHAR8            OSType;
 189 } LOADER_ENTRY;
 190
 191 typedef struct {
 192    REFIT_MENU_ENTRY  me;
 193    REFIT_VOLUME      *Volume;
 194 #ifdef __MAKEWITH_TIANO
 195    BDS_COMMON_OPTION *BdsOption;
 196 #endif // __MAKEWITH_TIANO
 197    CHAR16            *LoadOptions;
 198    BOOLEAN           Enabled;
 199 } LEGACY_ENTRY;
 200
 201 typedef struct {
 202    BOOLEAN     TextOnly;
 203    BOOLEAN     ScanAllLinux;
 204    UINTN       RequestedScreenWidth;
 205    UINTN       RequestedScreenHeight;
 206    UINTN       Timeout;
 207    UINTN       HideUIFlags;
 208    UINTN       MaxTags;     // max. number of OS entries to show simultaneously in graphics mode
 209    UINTN       GraphicsFor;
 210    UINTN       LegacyType;
 211    UINTN       ScanDelay;
 212    CHAR16      *BannerFileName;
 213    CHAR16      *SelectionSmallFileName;
 214    CHAR16      *SelectionBigFileName;
 215    CHAR16      *DefaultSelection;
 216    CHAR16      *AlsoScan;
 217    CHAR16      *DontScan;
 218    CHAR16      *DriverDirs;
 219    CHAR16      *IconsDir;
 220    UINTN       ShowTools[NUM_TOOLS];
 221    CHAR8       ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
 222 } REFIT_CONFIG;
 223
 224 // Global variables
 225
 226 extern EFI_HANDLE       SelfImageHandle;
 227 extern EFI_LOADED_IMAGE *SelfLoadedImage;
 228 extern EFI_FILE         *SelfRootDir;
 229 extern EFI_FILE         *SelfDir;
 230 extern CHAR16           *SelfDirPath;
 231
 232 extern REFIT_VOLUME     *SelfVolume;
 233 extern REFIT_VOLUME     **Volumes;
 234 extern UINTN            VolumesCount;
 235
 236 extern REFIT_CONFIG     GlobalConfig;
 237
 238 extern EFI_GUID gEfiLegacyBootProtocolGuid;
 239 extern EFI_GUID gEfiGlobalVariableGuid;
 240
 241 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
 242 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
 243 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume);
 244 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
 245 LOADER_ENTRY * AddLoaderEntry(IN CHAR16 *LoaderPath, IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume);
 246 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
 247 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
 248
 249 #endif
 250
 251 /* EOF */