5 * Copyright (c) 2006-2009 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
37 * Modifications copyright (c) 2012-2015 Roderick W. Smith
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.
48 #ifdef __MAKEWITH_GNUEFI
52 #include "../include/tiano_includes.h"
54 #include "../EfiLib/GenericBdsLib.h"
58 #define REFIT_DEBUG (0)
60 // Tag classifications; used in various ways.
62 #define TAG_REBOOT (2)
63 #define TAG_SHUTDOWN (3)
65 #define TAG_LOADER (5)
66 #define TAG_LEGACY (6)
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 NUM_TOOLS (18)
80 #define NUM_SCAN_OPTIONS 10
82 #define DEFAULT_ICONS_DIR L"icons"
84 // OS bit codes; used in GlobalConfig.GraphicsOn
85 #define GRAPHICS_FOR_OSX 1
86 #define GRAPHICS_FOR_LINUX 2
87 #define GRAPHICS_FOR_ELILO 4
88 #define GRAPHICS_FOR_GRUB 8
89 #define GRAPHICS_FOR_WINDOWS 16
95 // Type of legacy (BIOS) boot support detected
96 #define LEGACY_TYPE_NONE 0
97 #define LEGACY_TYPE_MAC 1
98 #define LEGACY_TYPE_UEFI 2
100 #ifdef __MAKEWITH_GNUEFI
102 // define BBS Device Types
104 #define BBS_FLOPPY 0x01
105 #define BBS_HARDDISK 0x02
106 #define BBS_CDROM 0x03
107 #define BBS_PCMCIA 0x04
109 #define BBS_EMBED_NETWORK 0x06
110 #define BBS_BEV_DEVICE 0x80
111 #define BBS_UNKNOWN 0xff
114 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
115 #define DEVICE_TYPE_HW 0x01
116 #define DEVICE_TYPE_ACPI 0x02 /* returned by UEFI boot loader on USB */
117 #define DEVICE_TYPE_MESSAGING 0x03
118 #define DEVICE_TYPE_MEDIA 0x04 /* returned by EFI boot loaders on hard disk */
119 #define DEVICE_TYPE_BIOS 0x05 /* returned by legacy (BIOS) boot loaders */
120 #define DEVICE_TYPE_END 0x75 /* end of path */
122 // Filesystem type identifiers. Not all are yet used....
123 #define FS_TYPE_UNKNOWN 0
124 #define FS_TYPE_WHOLEDISK 1
125 #define FS_TYPE_FAT 2
126 #define FS_TYPE_EXFAT 3
127 #define FS_TYPE_NTFS 4
128 #define FS_TYPE_EXT2 5
129 #define FS_TYPE_EXT3 6
130 #define FS_TYPE_EXT4 7
131 #define FS_TYPE_HFSPLUS 8
132 #define FS_TYPE_REISERFS 9
133 #define FS_TYPE_BTRFS 10
134 #define FS_TYPE_XFS 11
135 #define FS_TYPE_ISO9660 12
137 // How to scale banner images
138 #define BANNER_NOSCALE 0
139 #define BANNER_FILLSCREEN 1
141 // Sizes of the default icons; badges are 1/4 the big icon size
142 #define DEFAULT_SMALL_ICON_SIZE 48
143 #define DEFAULT_BIG_ICON_SIZE 128
145 // Codes for types of icon sizes; used for indexing into GlobalConfig.IconSizes[]
146 #define ICON_SIZE_BADGE 0
147 #define ICON_SIZE_SMALL 1
148 #define ICON_SIZE_BIG 2
150 // Names of binaries that can manage MOKs....
151 #define MOK_NAMES L"MokManager.efi,HashTool.efi,HashTool-signed.efi,KeyTool.efi,KeyTool-signed.efi"
152 // Directories to search for these MOK-managing programs. Note that SelfDir is
153 // searched in addition to these locations....
154 #define MOK_LOCATIONS L"\\,EFI\\tools,EFI\\fedora,EFI\\redhat,EFI\\ubuntu,EFI\\suse,EFI\\opensuse,EFI\\altlinux"
155 // Directories to search for memtest86....
156 #define MEMTEST_LOCATIONS L"EFI\\tools,EFI\\tools\\memtest86,EFI\\tools\\memtest,EFI\\memtest86,EFI\\memtest"
157 // Files that may be Windows recovery files
158 #define WINDOWS_RECOVERY_FILES L"EFI\\Microsoft\\Boot\\LrsBootmgr.efi,Recovery:\\EFI\\BOOT\\bootx64.efi,Recovery:\\EFI\\BOOT\\bootia32.efi"
160 // Definitions for the "hideui" option in refind.conf
161 #define HIDEUI_FLAG_NONE (0x0000)
162 #define HIDEUI_FLAG_BANNER (0x0001)
163 #define HIDEUI_FLAG_LABEL (0x0002)
164 #define HIDEUI_FLAG_SINGLEUSER (0x0004)
165 #define HIDEUI_FLAG_HWTEST (0x0008)
166 #define HIDEUI_FLAG_ARROWS (0x0010)
167 #define HIDEUI_FLAG_HINTS (0x0020)
168 #define HIDEUI_FLAG_EDITOR (0x0040)
169 #define HIDEUI_FLAG_SAFEMODE (0x0080)
170 #define HIDEUI_FLAG_BADGES (0x0100)
171 #define HIDEUI_FLAG_ALL ((0xffff))
173 // Default hint text for program-launch submenus
174 #define SUBSCREEN_HINT1 L"Use arrow keys to move cursor; Enter to boot;"
175 #define SUBSCREEN_HINT2 L"Insert or F2 to edit options; Esc to return to main menu"
176 #define SUBSCREEN_HINT2_NO_EDITOR L"Esc to return to main menu"
178 #define NULL_GUID_VALUE { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} };
179 #define REFIND_GUID_VALUE { 0x36D08FA7, 0xCF0B, 0x42F5, {0x8F, 0x14, 0x68, 0xDF, 0x73, 0xED, 0x37, 0x40} };
182 // global definitions
198 } MBR_PARTITION_INFO
;
201 EFI_DEVICE_PATH
*DevicePath
;
202 EFI_HANDLE DeviceHandle
;
208 EFI_GUID PartTypeGuid
;
210 EG_IMAGE
*VolIconImage
;
211 EG_IMAGE
*VolBadgeImage
;
213 BOOLEAN IsAppleLegacy
;
217 BOOLEAN IsMbrPartition
;
218 UINTN MbrPartitionIndex
;
219 EFI_BLOCK_IO
*BlockIO
;
220 UINT64 BlockIOOffset
;
221 EFI_BLOCK_IO
*WholeDiskBlockIO
;
222 EFI_DEVICE_PATH
*WholeDiskDevicePath
;
223 MBR_PARTITION_INFO
*MbrPartitionTable
;
228 typedef struct _refit_menu_entry
{
232 CHAR16 ShortcutDigit
;
233 CHAR16 ShortcutLetter
;
235 EG_IMAGE
*BadgeImage
;
236 struct _refit_menu_screen
*SubScreen
;
239 typedef struct _refit_menu_screen
{
241 EG_IMAGE
*TitleImage
;
244 UINTN EntryCount
; // total number of entries registered
245 REFIT_MENU_ENTRY
**Entries
;
246 UINTN TimeoutSeconds
;
257 EFI_DEVICE_PATH
*DevicePath
;
258 BOOLEAN UseGraphicsMode
;
261 CHAR16
*InitrdPath
; // Linux stub loader only
267 REFIT_VOLUME
*Volume
;
268 BDS_COMMON_OPTION
*BdsOption
;
275 BOOLEAN ScanAllLinux
;
276 BOOLEAN DeepLegacyScan
;
277 BOOLEAN EnableAndLockVMX
;
278 BOOLEAN FoldLinuxKernels
;
279 UINTN RequestedScreenWidth
;
280 UINTN RequestedScreenHeight
;
281 UINTN BannerBottomEdge
;
282 UINTN RequestedTextMode
;
285 UINTN MaxTags
; // max. number of OS entries to show simultaneously in graphics mode
289 UINTN ScreensaverTime
;
292 REFIT_VOLUME
*DiscoveredRoot
;
293 CHAR16
*BannerFileName
;
294 EG_IMAGE
*ScreenBackground
;
295 CHAR16
*ConfigFilename
;
296 CHAR16
*SelectionSmallFileName
;
297 CHAR16
*SelectionBigFileName
;
298 CHAR16
*DefaultSelection
;
300 CHAR16
*DontScanVolumes
;
301 CHAR16
*DontScanDirs
;
302 CHAR16
*DontScanFiles
;
303 CHAR16
*WindowsRecoveryFiles
;
306 UINTN ShowTools
[NUM_TOOLS
];
307 CHAR8 ScanFor
[NUM_SCAN_OPTIONS
]; // codes of types of loaders for which to scan
312 extern EFI_HANDLE SelfImageHandle
;
313 extern EFI_LOADED_IMAGE
*SelfLoadedImage
;
314 extern EFI_FILE
*SelfRootDir
;
315 extern EFI_FILE
*SelfDir
;
316 extern CHAR16
*SelfDirPath
;
318 extern REFIT_VOLUME
*SelfVolume
;
319 extern REFIT_VOLUME
**Volumes
;
320 extern UINTN VolumesCount
;
322 extern REFIT_CONFIG GlobalConfig
;
324 extern EFI_GUID gEfiLegacyBootProtocolGuid
;
325 extern EFI_GUID gEfiGlobalVariableGuid
;
327 EFI_STATUS
StartEFIImageList(IN EFI_DEVICE_PATH
**DevicePaths
,
328 IN CHAR16
*LoadOptions
, IN UINTN LoaderType
,
329 IN CHAR16
*ImageTitle
, IN CHAR8 OSType
,
330 OUT UINTN
*ErrorInStep
,
332 IN BOOLEAN IsDriver
);
333 LOADER_ENTRY
*InitializeLoaderEntry(IN LOADER_ENTRY
*Entry
);
334 REFIT_MENU_SCREEN
*InitializeSubScreen(IN LOADER_ENTRY
*Entry
);
335 VOID
GenerateSubScreen(LOADER_ENTRY
*Entry
, IN REFIT_VOLUME
*Volume
, IN BOOLEAN GenerateReturn
);
336 EG_IMAGE
* GetDiskBadge(IN UINTN DiskType
);
337 LOADER_ENTRY
* MakeGenericLoaderEntry(VOID
);
338 VOID
SetLoaderDefaults(LOADER_ENTRY
*Entry
, CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
);
339 LOADER_ENTRY
* AddPreparedLoaderEntry(LOADER_ENTRY
*Entry
);
340 VOID
StoreLoaderName(IN CHAR16
*Name
);