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-2014 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 NUM_TOOLS (17)
79 #define NUM_SCAN_OPTIONS 10
81 #define DEFAULT_ICONS_DIR L"icons"
83 // OS bit codes; used in GlobalConfig.GraphicsOn
84 #define GRAPHICS_FOR_OSX 1
85 #define GRAPHICS_FOR_LINUX 2
86 #define GRAPHICS_FOR_ELILO 4
87 #define GRAPHICS_FOR_GRUB 8
88 #define GRAPHICS_FOR_WINDOWS 16
90 // Type of legacy (BIOS) boot support detected
91 #define LEGACY_TYPE_NONE 0
92 #define LEGACY_TYPE_MAC 1
93 #define LEGACY_TYPE_UEFI 2
95 #ifdef __MAKEWITH_GNUEFI
97 // define BBS Device Types
99 #define BBS_FLOPPY 0x01
100 #define BBS_HARDDISK 0x02
101 #define BBS_CDROM 0x03
102 #define BBS_PCMCIA 0x04
104 #define BBS_EMBED_NETWORK 0x06
105 #define BBS_BEV_DEVICE 0x80
106 #define BBS_UNKNOWN 0xff
109 // BIOS Boot Specification (BBS) device types, as returned in DevicePath->Type field
110 #define DEVICE_TYPE_HW 0x01
111 #define DEVICE_TYPE_ACPI 0x02 /* returned by UEFI boot loader on USB */
112 #define DEVICE_TYPE_MESSAGING 0x03
113 #define DEVICE_TYPE_MEDIA 0x04 /* returned by EFI boot loaders on hard disk */
114 #define DEVICE_TYPE_BIOS 0x05 /* returned by legacy (BIOS) boot loaders */
115 #define DEVICE_TYPE_END 0x75 /* end of path */
117 // Filesystem type identifiers. Not all are yet used....
118 #define FS_TYPE_UNKNOWN 0
119 #define FS_TYPE_FAT 1
120 #define FS_TYPE_EXT2 2
121 #define FS_TYPE_EXT3 3
122 #define FS_TYPE_EXT4 4
123 #define FS_TYPE_HFSPLUS 5
124 #define FS_TYPE_REISERFS 6
125 #define FS_TYPE_BTRFS 7
126 #define FS_TYPE_ISO9660 8
128 // How to scale banner images
129 #define BANNER_NOSCALE 0
130 #define BANNER_FILLSCREEN 1
132 // Sizes of the default icons; badges are 1/4 the big icon size
133 #define DEFAULT_SMALL_ICON_SIZE 48
134 #define DEFAULT_BIG_ICON_SIZE 128
136 // Codes for types of icon sizes; used for indexing into GlobalConfig.IconSizes[]
137 #define ICON_SIZE_BADGE 0
138 #define ICON_SIZE_SMALL 1
139 #define ICON_SIZE_BIG 2
141 // Names of binaries that can manage MOKs....
142 #define MOK_NAMES L"MokManager.efi,HashTool.efi,HashTool-signed.efi"
143 // Directories to search for these MOK-managing programs. Note that SelfDir is
144 // searched in addition to these locations....
145 #define MOK_LOCATIONS L"\\,EFI\\tools,EFI\\fedora,EFI\\redhat,EFI\\ubuntu,EFI\\suse,EFI\\opensuse,EFI\\altlinux"
146 // Directories to search for memtest86....
147 #define MEMTEST_LOCATIONS L"EFI\\tools,EFI\\tools\\memtest86,EFI\\tools\\memtest,EFI\\memtest86,EFI\\memtest"
148 // Files that may be Windows recovery files
149 #define WINDOWS_RECOVERY_FILES L"EFI\\Microsoft\\Boot\\LrsBootmgr.efi,Recovery:\\EFI\\BOOT\\bootx64.efi,Recovery:\\EFI\\BOOT\\bootia32.efi"
151 #define NULL_GUID_VALUE { 0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} };
152 #define REFIND_GUID_VALUE { 0x36D08FA7, 0xCF0B, 0x42F5, {0x8F, 0x14, 0x68, 0xDF, 0x73, 0xED, 0x37, 0x40} };
155 // global definitions
171 } MBR_PARTITION_INFO
;
174 EFI_DEVICE_PATH
*DevicePath
;
175 EFI_HANDLE DeviceHandle
;
182 EG_IMAGE
*VolIconImage
;
183 EG_IMAGE
*VolBadgeImage
;
185 BOOLEAN IsAppleLegacy
;
189 BOOLEAN IsMbrPartition
;
190 UINTN MbrPartitionIndex
;
191 EFI_BLOCK_IO
*BlockIO
;
192 UINT64 BlockIOOffset
;
193 EFI_BLOCK_IO
*WholeDiskBlockIO
;
194 EFI_DEVICE_PATH
*WholeDiskDevicePath
;
195 MBR_PARTITION_INFO
*MbrPartitionTable
;
200 typedef struct _refit_menu_entry
{
204 CHAR16 ShortcutDigit
;
205 CHAR16 ShortcutLetter
;
207 EG_IMAGE
*BadgeImage
;
208 struct _refit_menu_screen
*SubScreen
;
211 typedef struct _refit_menu_screen
{
213 EG_IMAGE
*TitleImage
;
216 UINTN EntryCount
; // total number of entries registered
217 REFIT_MENU_ENTRY
**Entries
;
218 UINTN TimeoutSeconds
;
229 EFI_DEVICE_PATH
*DevicePath
;
230 BOOLEAN UseGraphicsMode
;
233 CHAR16
*InitrdPath
; // Linux stub loader only
239 REFIT_VOLUME
*Volume
;
240 BDS_COMMON_OPTION
*BdsOption
;
247 BOOLEAN ScanAllLinux
;
248 BOOLEAN DeepLegacyScan
;
249 BOOLEAN EnableAndLockVMX
;
250 UINTN RequestedScreenWidth
;
251 UINTN RequestedScreenHeight
;
252 UINTN BannerBottomEdge
;
253 UINTN RequestedTextMode
;
256 UINTN MaxTags
; // max. number of OS entries to show simultaneously in graphics mode
260 UINTN ScreensaverTime
;
263 CHAR16
*BannerFileName
;
264 EG_IMAGE
*ScreenBackground
;
265 CHAR16
*ConfigFilename
;
266 CHAR16
*SelectionSmallFileName
;
267 CHAR16
*SelectionBigFileName
;
268 CHAR16
*DefaultSelection
;
270 CHAR16
*DontScanVolumes
;
271 CHAR16
*DontScanDirs
;
272 CHAR16
*DontScanFiles
;
273 CHAR16
*WindowsRecoveryFiles
;
276 UINTN ShowTools
[NUM_TOOLS
];
277 CHAR8 ScanFor
[NUM_SCAN_OPTIONS
]; // codes of types of loaders for which to scan
282 extern EFI_HANDLE SelfImageHandle
;
283 extern EFI_LOADED_IMAGE
*SelfLoadedImage
;
284 extern EFI_FILE
*SelfRootDir
;
285 extern EFI_FILE
*SelfDir
;
286 extern CHAR16
*SelfDirPath
;
288 extern REFIT_VOLUME
*SelfVolume
;
289 extern REFIT_VOLUME
**Volumes
;
290 extern UINTN VolumesCount
;
292 extern REFIT_CONFIG GlobalConfig
;
294 extern EFI_GUID gEfiLegacyBootProtocolGuid
;
295 extern EFI_GUID gEfiGlobalVariableGuid
;
297 LOADER_ENTRY
*InitializeLoaderEntry(IN LOADER_ENTRY
*Entry
);
298 REFIT_MENU_SCREEN
*InitializeSubScreen(IN LOADER_ENTRY
*Entry
);
299 VOID
GenerateSubScreen(LOADER_ENTRY
*Entry
, IN REFIT_VOLUME
*Volume
);
300 LOADER_ENTRY
* MakeGenericLoaderEntry(VOID
);
301 LOADER_ENTRY
* AddLoaderEntry(IN CHAR16
*LoaderPath
, IN CHAR16
*LoaderTitle
, IN REFIT_VOLUME
*Volume
);
302 VOID
SetLoaderDefaults(LOADER_ENTRY
*Entry
, CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
);
303 LOADER_ENTRY
* AddPreparedLoaderEntry(LOADER_ENTRY
*Entry
);