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 #include "efi.h"
  49 #include "efilib.h"
  50
  51 #include "libeg.h"
  52
  53 #define REFIT_DEBUG (0)
  54
  55 // Tag classifications; used in various ways.
  56 #define TAG_ABOUT    (1)
  57 #define TAG_REBOOT   (2)
  58 #define TAG_SHUTDOWN (3)
  59 #define TAG_TOOL     (4)
  60 #define TAG_LOADER   (5)
  61 #define TAG_LEGACY   (6)
  62 #define TAG_EXIT     (7)
  63 #define TAG_SHELL    (8)
  64 #define TAG_GPTSYNC  (9)
  65 #define NUM_TOOLS    (9)
  66
  67 #define NUM_SCAN_OPTIONS 10
  68
  69 #define DEFAULT_ICONS_DIR L"icons"
  70
  71 //
  72 // global definitions
  73 //
  74
  75 // global types
  76
  77 typedef struct {
  78    UINT8 Flags;
  79    UINT8 StartCHS1;
  80    UINT8 StartCHS2;
  81    UINT8 StartCHS3;
  82    UINT8 Type;
  83    UINT8 EndCHS1;
  84    UINT8 EndCHS2;
  85    UINT8 EndCHS3;
  86    UINT32 StartLBA;
  87    UINT32 Size;
  88 } MBR_PARTITION_INFO;
  89
  90 typedef struct {
  91    EFI_DEVICE_PATH     *DevicePath;
  92    EFI_HANDLE          DeviceHandle;
  93    EFI_FILE            *RootDir;
  94    CHAR16              *VolName;
  95    EG_IMAGE            *VolIconImage;
  96    EG_IMAGE            *VolBadgeImage;
  97    UINTN               DiskKind;
  98    BOOLEAN             IsAppleLegacy;
  99    BOOLEAN             HasBootCode;
 100    CHAR16              *OSIconName;
 101    CHAR16              *OSName;
 102    BOOLEAN             IsMbrPartition;
 103    UINTN               MbrPartitionIndex;
 104    EFI_BLOCK_IO        *BlockIO;
 105    UINT64              BlockIOOffset;
 106    EFI_BLOCK_IO        *WholeDiskBlockIO;
 107    EFI_DEVICE_PATH     *WholeDiskDevicePath;
 108    MBR_PARTITION_INFO  *MbrPartitionTable;
 109    BOOLEAN             IsReadable;
 110 } REFIT_VOLUME;
 111
 112 typedef struct _refit_menu_entry {
 113    CHAR16      *Title;
 114    UINTN       Tag;
 115    UINTN       Row;
 116    CHAR16      ShortcutDigit;
 117    CHAR16      ShortcutLetter;
 118    EG_IMAGE    *Image;
 119    EG_IMAGE    *BadgeImage;
 120    struct _refit_menu_screen *SubScreen;
 121 } REFIT_MENU_ENTRY;
 122
 123 typedef struct _refit_menu_screen {
 124    CHAR16      *Title;
 125    EG_IMAGE    *TitleImage;
 126    UINTN       InfoLineCount;
 127    CHAR16      **InfoLines;
 128    UINTN       EntryCount;     // total number of entries registered
 129    REFIT_MENU_ENTRY **Entries;
 130    UINTN       TimeoutSeconds;
 131    CHAR16      *TimeoutText;
 132 } REFIT_MENU_SCREEN;
 133
 134 typedef struct {
 135    REFIT_MENU_ENTRY me;
 136    CHAR16           *Title;
 137    CHAR16           *LoaderPath;
 138    CHAR16           *VolName;
 139    EFI_DEVICE_PATH  *DevicePath;
 140    BOOLEAN          UseGraphicsMode;
 141    BOOLEAN          Enabled;
 142    CHAR16           *LoadOptions;
 143    CHAR16           *InitrdPath; // Linux stub loader only
 144    CHAR8            OSType;
 145 } LOADER_ENTRY;
 146
 147 typedef struct {
 148    REFIT_MENU_ENTRY me;
 149    REFIT_VOLUME     *Volume;
 150    CHAR16           *LoadOptions;
 151    BOOLEAN          Enabled;
 152 } LEGACY_ENTRY;
 153
 154 typedef struct {
 155    BOOLEAN     TextOnly;
 156    BOOLEAN     ScanAllLinux;
 157    UINTN       RequestedScreenWidth;
 158    UINTN       RequestedScreenHeight;
 159    UINTN       Timeout;
 160    UINTN       HideUIFlags;
 161    UINTN       MaxTags;     // max. number of OS entries to show simultaneously in graphics mode
 162    CHAR16      *BannerFileName;
 163    CHAR16      *SelectionSmallFileName;
 164    CHAR16      *SelectionBigFileName;
 165    CHAR16      *DefaultSelection;
 166    CHAR16      *AlsoScan;
 167    CHAR16      *DontScan;
 168    CHAR16      *DriverDirs;
 169    CHAR16      *IconsDir;
 170    UINTN       ShowTools[NUM_TOOLS];
 171    CHAR8       ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
 172 } REFIT_CONFIG;
 173
 174 // Global variables
 175
 176 extern EFI_HANDLE       SelfImageHandle;
 177 extern EFI_LOADED_IMAGE *SelfLoadedImage;
 178 extern EFI_FILE         *SelfRootDir;
 179 extern EFI_FILE         *SelfDir;
 180 extern CHAR16           *SelfDirPath;
 181
 182 extern REFIT_VOLUME     *SelfVolume;
 183 extern REFIT_VOLUME     **Volumes;
 184 extern UINTN            VolumesCount;
 185
 186 extern REFIT_CONFIG     GlobalConfig;
 187
 188 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
 189 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
 190 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume);
 191 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
 192 LOADER_ENTRY * AddLoaderEntry(IN CHAR16 *LoaderPath, IN CHAR16 *LoaderTitle, IN REFIT_VOLUME *Volume);
 193 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
 194 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
 195
 196 #endif
 197
 198 /* EOF */