Added support for "%v" as a variable for the kernel version number in
[refind] / 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-2015 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 TAG_NETBOOT (17)
78 #define TAG_CSR_ROTATE (18)
79 #define TAG_FWUPDATE_TOOL (19)
80 #define NUM_TOOLS (20)
81
82 #define NUM_SCAN_OPTIONS 10
83
84 #define DEFAULT_ICONS_DIR L"icons"
85
86 // OS bit codes; used in GlobalConfig.GraphicsOn
87 #define GRAPHICS_FOR_OSX 1
88 #define GRAPHICS_FOR_LINUX 2
89 #define GRAPHICS_FOR_ELILO 4
90 #define GRAPHICS_FOR_GRUB 8
91 #define GRAPHICS_FOR_WINDOWS 16
92
93 // Load types
94 #define TYPE_EFI 1
95 #define TYPE_LEGACY 2
96
97 // Type of legacy (BIOS) boot support detected
98 #define LEGACY_TYPE_NONE 0
99 #define LEGACY_TYPE_MAC 1
100 #define LEGACY_TYPE_UEFI 2
101
102 #ifdef __MAKEWITH_GNUEFI
103 //
104 // define BBS Device Types
105 //
106 #define BBS_FLOPPY 0x01
107 #define BBS_HARDDISK 0x02
108 #define BBS_CDROM 0x03
109 #define BBS_PCMCIA 0x04
110 #define BBS_USB 0x05
111 #define BBS_EMBED_NETWORK 0x06
112 #define BBS_BEV_DEVICE 0x80
113 #define BBS_UNKNOWN 0xff
114 #endif
115
116 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
117 #define DEVICE_TYPE_HW 0x01
118 #define DEVICE_TYPE_ACPI 0x02 /* returned by UEFI boot loader on USB */
119 #define DEVICE_TYPE_MESSAGING 0x03
120 #define DEVICE_TYPE_MEDIA 0x04 /* returned by EFI boot loaders on hard disk */
121 #define DEVICE_TYPE_BIOS 0x05 /* returned by legacy (BIOS) boot loaders */
122 #define DEVICE_TYPE_END 0x75 /* end of path */
123
124 // Filesystem type identifiers. Not all are yet used....
125 #define FS_TYPE_UNKNOWN 0
126 #define FS_TYPE_WHOLEDISK 1
127 #define FS_TYPE_FAT 2
128 #define FS_TYPE_EXFAT 3
129 #define FS_TYPE_NTFS 4
130 #define FS_TYPE_EXT2 5
131 #define FS_TYPE_EXT3 6
132 #define FS_TYPE_EXT4 7
133 #define FS_TYPE_HFSPLUS 8
134 #define FS_TYPE_REISERFS 9
135 #define FS_TYPE_BTRFS 10
136 #define FS_TYPE_XFS 11
137 #define FS_TYPE_ISO9660 12
138
139 // How to scale banner images
140 #define BANNER_NOSCALE 0
141 #define BANNER_FILLSCREEN 1
142
143 // Sizes of the default icons; badges are 1/4 the big icon size
144 #define DEFAULT_SMALL_ICON_SIZE 48
145 #define DEFAULT_BIG_ICON_SIZE 128
146
147 // Codes for types of icon sizes; used for indexing into GlobalConfig.IconSizes[]
148 #define ICON_SIZE_BADGE 0
149 #define ICON_SIZE_SMALL 1
150 #define ICON_SIZE_BIG 2
151
152 // Names of binaries that can manage MOKs....
153 #define MOK_NAMES L"MokManager.efi,HashTool.efi,HashTool-signed.efi,KeyTool.efi,KeyTool-signed.efi"
154 // Names of binaries that can update firmware....
155 #if defined (EFIX64)
156 #define FWUPDATE_NAMES L"fwupx64.efi"
157 #elif defined(EFI32)
158 #define FWUPDATE_NAMES L"fwupia32.efi"
159 #elif defined(EFIAARCH64)
160 #define FWUPDATE_NAMES L"fwupaa64.efi"
161 #else
162 #define FWUPDATE_NAMES L"fwup.efi"
163 #endif
164 // Directories to search for these MOK-managing programs. Note that SelfDir is
165 // searched in addition to these locations....
166 #define MOK_LOCATIONS L"\\,EFI\\tools,EFI\\fedora,EFI\\redhat,EFI\\ubuntu,EFI\\suse,EFI\\opensuse,EFI\\altlinux"
167 // Directories to search for memtest86....
168 #define MEMTEST_LOCATIONS L"EFI\\tools,EFI\\tools\\memtest86,EFI\\tools\\memtest,EFI\\memtest86,EFI\\memtest"
169 // Files that may be Windows recovery files
170 #define WINDOWS_RECOVERY_FILES L"EFI\\Microsoft\\Boot\\LrsBootmgr.efi,Recovery:\\EFI\\BOOT\\bootx64.efi,Recovery:\\EFI\\BOOT\\bootia32.efi"
171
172 // Filename patterns that identify EFI boot loaders. Note that a single case (either L"*.efi" or
173 // L"*.EFI") is fine for most systems; but Gigabyte's buggy Hybrid EFI does a case-sensitive
174 // comparison when it should do a case-insensitive comparison, so I'm doubling this up. It does
175 // no harm on other computers, AFAIK. In theory, every case variation should be done for
176 // completeness, but that's ridiculous....
177 #define LOADER_MATCH_PATTERNS L"*.efi,*.EFI"
178
179 // Definitions for the "hideui" option in refind.conf
180 #define HIDEUI_FLAG_NONE (0x0000)
181 #define HIDEUI_FLAG_BANNER (0x0001)
182 #define HIDEUI_FLAG_LABEL (0x0002)
183 #define HIDEUI_FLAG_SINGLEUSER (0x0004)
184 #define HIDEUI_FLAG_HWTEST (0x0008)
185 #define HIDEUI_FLAG_ARROWS (0x0010)
186 #define HIDEUI_FLAG_HINTS (0x0020)
187 #define HIDEUI_FLAG_EDITOR (0x0040)
188 #define HIDEUI_FLAG_SAFEMODE (0x0080)
189 #define HIDEUI_FLAG_BADGES (0x0100)
190 #define HIDEUI_FLAG_ALL ((0xffff))
191
192 // Default hint text for program-launch submenus
193 #define SUBSCREEN_HINT1 L"Use arrow keys to move cursor; Enter to boot;"
194 #define SUBSCREEN_HINT2 L"Insert or F2 to edit options; Esc to return to main menu"
195 #define SUBSCREEN_HINT2_NO_EDITOR L"Esc to return to main menu"
196
197 #define NULL_GUID_VALUE { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} };
198 #define REFIND_GUID_VALUE { 0x36D08FA7, 0xCF0B, 0x42F5, {0x8F, 0x14, 0x68, 0xDF, 0x73, 0xED, 0x37, 0x40} };
199
200 // Configuration file variables
201 #define KERNEL_VERSION L"%v"
202
203 //
204 // global definitions
205 //
206
207 // global types
208
209 typedef struct _uint32_list {
210 UINT32 Value;
211 struct _uint32_list *Next;
212 } UINT32_LIST;
213
214 typedef struct {
215 UINT8 Flags;
216 UINT8 StartCHS1;
217 UINT8 StartCHS2;
218 UINT8 StartCHS3;
219 UINT8 Type;
220 UINT8 EndCHS1;
221 UINT8 EndCHS2;
222 UINT8 EndCHS3;
223 UINT32 StartLBA;
224 UINT32 Size;
225 } MBR_PARTITION_INFO;
226
227 typedef struct {
228 EFI_DEVICE_PATH *DevicePath;
229 EFI_HANDLE DeviceHandle;
230 EFI_FILE *RootDir;
231 CHAR16 *VolName;
232 CHAR16 *PartName;
233 EFI_GUID VolUuid;
234 EFI_GUID PartGuid;
235 EFI_GUID PartTypeGuid;
236 BOOLEAN IsMarkedReadOnly;
237 UINTN VolNumber;
238 EG_IMAGE *VolIconImage;
239 EG_IMAGE *VolBadgeImage;
240 UINTN DiskKind;
241 BOOLEAN IsAppleLegacy;
242 BOOLEAN HasBootCode;
243 CHAR16 *OSIconName;
244 CHAR16 *OSName;
245 BOOLEAN IsMbrPartition;
246 UINTN MbrPartitionIndex;
247 EFI_BLOCK_IO *BlockIO;
248 UINT64 BlockIOOffset;
249 EFI_BLOCK_IO *WholeDiskBlockIO;
250 EFI_DEVICE_PATH *WholeDiskDevicePath;
251 MBR_PARTITION_INFO *MbrPartitionTable;
252 BOOLEAN IsReadable;
253 UINT32 FSType;
254 } REFIT_VOLUME;
255
256 typedef struct _refit_menu_entry {
257 CHAR16 *Title;
258 UINTN Tag;
259 UINTN Row;
260 CHAR16 ShortcutDigit;
261 CHAR16 ShortcutLetter;
262 EG_IMAGE *Image;
263 EG_IMAGE *BadgeImage;
264 struct _refit_menu_screen *SubScreen;
265 } REFIT_MENU_ENTRY;
266
267 typedef struct _refit_menu_screen {
268 CHAR16 *Title;
269 EG_IMAGE *TitleImage;
270 UINTN InfoLineCount;
271 CHAR16 **InfoLines;
272 UINTN EntryCount; // total number of entries registered
273 REFIT_MENU_ENTRY **Entries;
274 UINTN TimeoutSeconds;
275 CHAR16 *TimeoutText;
276 CHAR16 *Hint1;
277 CHAR16 *Hint2;
278 } REFIT_MENU_SCREEN;
279
280 typedef struct {
281 REFIT_MENU_ENTRY me;
282 CHAR16 *Title;
283 CHAR16 *LoaderPath;
284 CHAR16 *VolName;
285 EFI_DEVICE_PATH *DevicePath;
286 BOOLEAN UseGraphicsMode;
287 BOOLEAN Enabled;
288 CHAR16 *LoadOptions;
289 CHAR16 *InitrdPath; // Linux stub loader only
290 CHAR8 OSType;
291 } LOADER_ENTRY;
292
293 typedef struct {
294 REFIT_MENU_ENTRY me;
295 REFIT_VOLUME *Volume;
296 BDS_COMMON_OPTION *BdsOption;
297 CHAR16 *LoadOptions;
298 BOOLEAN Enabled;
299 } LEGACY_ENTRY;
300
301 typedef struct {
302 BOOLEAN TextOnly;
303 BOOLEAN ScanAllLinux;
304 BOOLEAN DeepLegacyScan;
305 BOOLEAN EnableAndLockVMX;
306 BOOLEAN FoldLinuxKernels;
307 BOOLEAN EnableTouch;
308 UINTN RequestedScreenWidth;
309 UINTN RequestedScreenHeight;
310 UINTN BannerBottomEdge;
311 UINTN RequestedTextMode;
312 UINTN Timeout;
313 UINTN HideUIFlags;
314 UINTN MaxTags; // max. number of OS entries to show simultaneously in graphics mode
315 UINTN GraphicsFor;
316 UINTN LegacyType;
317 UINTN ScanDelay;
318 UINTN ScreensaverTime;
319 UINTN IconSizes[3];
320 UINTN BannerScale;
321 REFIT_VOLUME *DiscoveredRoot;
322 EFI_DEVICE_PATH *SelfDevicePath;
323 CHAR16 *BannerFileName;
324 EG_IMAGE *ScreenBackground;
325 CHAR16 *ConfigFilename;
326 CHAR16 *SelectionSmallFileName;
327 CHAR16 *SelectionBigFileName;
328 CHAR16 *DefaultSelection;
329 CHAR16 *AlsoScan;
330 CHAR16 *DontScanVolumes;
331 CHAR16 *DontScanDirs;
332 CHAR16 *DontScanFiles;
333 CHAR16 *WindowsRecoveryFiles;
334 CHAR16 *DriverDirs;
335 CHAR16 *IconsDir;
336 CHAR16 *SpoofOSXVersion;
337 UINT32_LIST *CsrValues;
338 UINTN ShowTools[NUM_TOOLS];
339 CHAR8 ScanFor[NUM_SCAN_OPTIONS]; // codes of types of loaders for which to scan
340 } REFIT_CONFIG;
341
342 // Global variables
343
344 extern EFI_HANDLE SelfImageHandle;
345 extern EFI_LOADED_IMAGE *SelfLoadedImage;
346 extern EFI_FILE *SelfRootDir;
347 extern EFI_FILE *SelfDir;
348 extern CHAR16 *SelfDirPath;
349
350 extern REFIT_VOLUME *SelfVolume;
351 extern REFIT_VOLUME **Volumes;
352 extern UINTN VolumesCount;
353
354 extern REFIT_CONFIG GlobalConfig;
355
356 extern EFI_GUID gEfiLegacyBootProtocolGuid;
357 extern EFI_GUID gEfiGlobalVariableGuid;
358
359 EFI_STATUS StartEFIImageList(IN EFI_DEVICE_PATH **DevicePaths,
360 IN CHAR16 *LoadOptions, IN UINTN LoaderType,
361 IN CHAR16 *ImageTitle, IN CHAR8 OSType,
362 OUT UINTN *ErrorInStep,
363 IN BOOLEAN Verbose,
364 IN BOOLEAN IsDriver);
365 EFI_STATUS StartEFIImage(IN EFI_DEVICE_PATH *DevicePath,
366 IN CHAR16 *LoadOptions, IN UINTN LoaderType,
367 IN CHAR16 *ImageTitle, IN CHAR8 OSType,
368 OUT UINTN *ErrorInStep,
369 IN BOOLEAN Verbose,
370 IN BOOLEAN IsDriver);
371 LOADER_ENTRY *InitializeLoaderEntry(IN LOADER_ENTRY *Entry);
372 REFIT_MENU_SCREEN *InitializeSubScreen(IN LOADER_ENTRY *Entry);
373 VOID GenerateSubScreen(LOADER_ENTRY *Entry, IN REFIT_VOLUME *Volume, IN BOOLEAN GenerateReturn);
374 EG_IMAGE * GetDiskBadge(IN UINTN DiskType);
375 LOADER_ENTRY * MakeGenericLoaderEntry(VOID);
376 VOID SetLoaderDefaults(LOADER_ENTRY *Entry, CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume);
377 LOADER_ENTRY * AddPreparedLoaderEntry(LOADER_ENTRY *Entry);
378 VOID StoreLoaderName(IN CHAR16 *Name);
379
380 #endif
381
382 /* EOF */