2 * COPYRIGHT: See COPYING.ARM in the top level directory
3 * PROJECT: ReactOS UEFI Boot Library
4 * FILE: boot/environ/include/bl.h
5 * PURPOSE: Main Boot Library Header
6 * PROGRAMMER: Alex Ionescu (alex.ionescu@reactos.org)
12 /* INCLUDES ******************************************************************/
25 /* NT SafeInt Header */
26 #include <ntintsafe.h>
32 #include <drivers/acpi/acpi.h>
36 #include <DevicePath.h>
37 #include <LoadedImage.h>
38 #include <GraphicsOutput.h>
42 #include <GlobalVariable.h>
44 /* Registry Headers */
48 /* DEFINES *******************************************************************/
50 DEFINE_GUID(BadMemoryGuid
, 0x54B8275B, 0xD431, 0x473F, 0xAC, 0xFB, 0xE5, 0x36, 0xA0, 0x84, 0x94, 0xA3);
52 #define BL_APPLICATION_FLAG_CONVERTED_FROM_EFI 0x01
54 #define BL_APP_ENTRY_SIGNATURE "BTAPENT"
56 #define BOOT_APPLICATION_SIGNATURE_1 'TOOB'
57 #define BOOT_APPLICATION_SIGNATURE_2 ' PPA'
59 #define BOOT_MEMORY_TRANSLATION_TYPE_PHYSICAL 0
60 #define BOOT_MEMORY_TRANSLATION_TYPE_VIRTUAL 1
62 #define BOOT_APPLICATION_VERSION 2
63 #define BL_MEMORY_DATA_VERSION 1
64 #define BL_RETURN_ARGUMENTS_VERSION 1
65 #define BL_FIRMWARE_DESCRIPTOR_VERSION 2
67 #define BL_RETURN_ARGUMENTS_NO_PAE_FLAG 0x40
69 #define BL_APPLICATION_ENTRY_FLAG_NO_GUID 0x01
70 #define BL_APPLICATION_ENTRY_BCD_OPTIONS_INTERNAL 0x02
71 #define BL_APPLICATION_ENTRY_WINLOAD 0x04
72 #define BL_APPLICATION_ENTRY_STARTUP 0x08
73 #define BL_APPLICATION_ENTRY_REBOOT_ON_ERROR 0x20
74 #define BL_APPLICATION_ENTRY_NTLDR 0x40
75 #define BL_APPLICATION_ENTRY_BCD_OPTIONS_EXTERNAL 0x80
76 #define BL_APPLICATION_ENTRY_WINRESUME 0x100
77 #define BL_APPLICATION_ENTRY_SETUPLDR 0x200
78 #define BL_APPLICATION_ENTRY_BOOTSECTOR 0x400
79 #define BL_APPLICATION_ENTRY_BOOTMGR 0x1000
80 #define BL_APPLICATION_ENTRY_DISPLAY_ORDER 0x800000
81 #define BL_APPLICATION_ENTRY_FIXED_SEQUENCE 0x20000000
82 #define BL_APPLICATION_ENTRY_RECOVERY 0x40000000
84 #define BL_CONTEXT_PAGING_ON 1
85 #define BL_CONTEXT_INTERRUPTS_ON 2
87 #define BL_MM_FLAG_USE_FIRMWARE_FOR_MEMORY_MAP_BUFFERS 0x01
88 #define BL_MM_FLAG_REQUEST_COALESCING 0x02
90 #define BL_MM_ADD_DESCRIPTOR_COALESCE_FLAG 0x01
91 #define BL_MM_ADD_DESCRIPTOR_TRUNCATE_FLAG 0x02
92 #define BL_MM_ADD_DESCRIPTOR_NEVER_COALESCE_FLAG 0x10
93 #define BL_MM_ADD_DESCRIPTOR_NEVER_TRUNCATE_FLAG 0x20
94 #define BL_MM_ADD_DESCRIPTOR_ALLOCATE_FLAG 0x1000
95 #define BL_MM_ADD_DESCRIPTOR_UPDATE_LIST_POINTER_FLAG 0x2000
97 #define BL_MM_INCLUDE_MAPPED_ALLOCATED 0x01
98 #define BL_MM_INCLUDE_MAPPED_UNALLOCATED 0x02
99 #define BL_MM_INCLUDE_UNMAPPED_ALLOCATED 0x04
100 #define BL_MM_INCLUDE_UNMAPPED_UNALLOCATED 0x08
101 #define BL_MM_INCLUDE_RESERVED_ALLOCATED 0x10
102 #define BL_MM_INCLUDE_BAD_MEMORY 0x20
103 #define BL_MM_INCLUDE_FIRMWARE_MEMORY 0x40
104 #define BL_MM_INCLUDE_TRUNCATED_MEMORY 0x80
105 #define BL_MM_INCLUDE_PERSISTENT_MEMORY 0x100
106 #define BL_MM_INCLUDE_FIRMWARE_MEMORY_2 0x200
108 #define BL_MM_INCLUDE_NO_FIRMWARE_MEMORY (BL_MM_INCLUDE_PERSISTENT_MEMORY | \
109 BL_MM_INCLUDE_TRUNCATED_MEMORY | \
110 BL_MM_INCLUDE_BAD_MEMORY | \
111 BL_MM_INCLUDE_RESERVED_ALLOCATED | \
112 BL_MM_INCLUDE_UNMAPPED_UNALLOCATED | \
113 BL_MM_INCLUDE_UNMAPPED_ALLOCATED | \
114 BL_MM_INCLUDE_MAPPED_UNALLOCATED | \
115 BL_MM_INCLUDE_MAPPED_ALLOCATED)
116 C_ASSERT(BL_MM_INCLUDE_NO_FIRMWARE_MEMORY
== 0x1BF);
118 #define BL_MM_INCLUDE_ONLY_FIRMWARE_MEMORY (BL_MM_INCLUDE_FIRMWARE_MEMORY_2 | \
119 BL_MM_INCLUDE_FIRMWARE_MEMORY)
120 C_ASSERT(BL_MM_INCLUDE_ONLY_FIRMWARE_MEMORY
== 0x240);
122 #define BL_MM_REQUEST_DEFAULT_TYPE 1
123 #define BL_MM_REQUEST_TOP_DOWN_TYPE 2
125 #define BL_MM_REMOVE_PHYSICAL_REGION_FLAG 0x40000000
126 #define BL_MM_REMOVE_VIRTUAL_REGION_FLAG 0x80000000
128 #define BL_LIBRARY_FLAG_NO_DISPLAY 0x01
129 #define BL_LIBRARY_FLAG_REINITIALIZE 0x02
130 #define BL_LIBRARY_FLAG_REINITIALIZE_ALL 0x04
131 #define BL_LIBRARY_FLAG_ZERO_HEAP_ALLOCATIONS_ON_FREE 0x10
132 #define BL_LIBRARY_FLAG_INITIALIZATION_COMPLETED 0x20
133 #define BL_LIBRARY_FLAG_NO_GRAPHICS_CONSOLE 0x800
135 #define BL_DISPLAY_GRAPHICS_FORCED_VIDEO_MODE_FLAG 0x01
136 #define BL_DISPLAY_GRAPHICS_FORCED_HIGH_RES_MODE_FLAG 0x02
138 #define BL_HT_VALUE_IS_INLINE 0x01
140 #define BL_FS_REGISTER_AT_HEAD_FLAG 1
142 #define BL_BLOCK_DEVICE_REMOVABLE_FLAG 0x01
143 #define BL_BLOCK_DEVICE_PRESENT_FLAG 0x02
144 #define BL_BLOCK_DEVICE_VIRTUAL_FLAG 0x04
146 #define BL_MEMORY_CLASS_SHIFT 28
148 #define BL_FILE_READ_ACCESS 0x01
149 #define BL_FILE_WRITE_ACCESS 0x02
150 #define BL_DIRECTORY_ACCESS 0x04
151 #define BL_UNKNOWN_ACCESS 0x10
153 #define BL_DEVICE_READ_ACCESS 0x01
154 #define BL_DEVICE_WRITE_ACCESS 0x02
156 #define BL_DEVICE_ENTRY_OPENED 0x01
157 #define BL_DEVICE_ENTRY_READ_ACCESS 0x02
158 #define BL_DEVICE_ENTRY_WRITE_ACCESS 0x04
160 #define BL_FILE_ENTRY_OPENED 0x01
161 #define BL_FILE_ENTRY_READ_ACCESS 0x02
162 #define BL_FILE_ENTRY_WRITE_ACCESS 0x04
163 #define BL_FILE_ENTRY_UNKNOWN_ACCESS 0x10
164 #define BL_FILE_ENTRY_DIRECTORY 0x10000
166 #define BL_ETFS_FILE_ENTRY_DIRECTORY 0x01
168 #define BL_IMG_VALID_FILE 0x01
169 #define BL_IMG_MEMORY_FILE 0x02
170 #define BL_IMG_REMOTE_FILE 0x04
172 #define BL_LOAD_IMG_VIRTUAL_BUFFER 0x01
173 #define BL_LOAD_IMG_EXISTING_BUFFER 0x04
174 #define BL_LOAD_IMG_UNKNOWN_BUFFER_FLAG 0x08
175 #define BL_LOAD_IMG_COMPUTE_SIGNATURE 0x10
176 #define BL_LOAD_IMG_COMPUTE_HASH 0x40000
178 #define BL_LOAD_PE_IMG_VIRTUAL_BUFFER BL_LOAD_IMG_VIRTUAL_BUFFER
179 #define BL_LOAD_PE_IMG_CHECK_MACHINE 0x02
180 #define BL_LOAD_PE_IMG_EXISTING_BUFFER BL_LOAD_IMG_EXISTING_BUFFER
181 #define BL_LOAD_PE_IMG_COMPUTE_HASH 0x10
182 #define BL_LOAD_PE_IMG_CHECK_SUBSYSTEM 0x80
183 #define BL_LOAD_PE_IMG_SKIP_RELOCATIONS 0x100
184 #define BL_LOAD_PE_IMG_CHECK_FORCED_INTEGRITY 0x200
185 #define BL_LOAD_PE_IMG_IGNORE_CHECKSUM_MISMATCH 0x10000
186 #define BL_LOAD_PE_IMG_VALIDATE_ORIGINAL_FILENAME 0x400000
188 #define BL_UTL_CHECKSUM_COMPLEMENT 0x10000
189 #define BL_UTL_CHECKSUM_ROTATE 0x20000
190 #define BL_UTL_CHECKSUM_NEGATE 0x40000
191 #define BL_UTL_CHECKSUM_UCHAR_BUFFER 0x01
192 #define BL_UTL_CHECKSUM_USHORT_BUFFER 0x02
194 /* ENUMERATIONS **************************************************************/
196 typedef enum _BL_COLOR
214 } BL_COLOR
, *PBL_COLOR
;
216 typedef enum _BL_MENU_POLICY
218 MenuPolicyLegacy
= 0,
219 MenuPolicyStandard
= 1
222 typedef enum _BL_MEMORY_DESCRIPTOR_TYPE
227 } BL_MEMORY_DESCRIPTOR_TYPE
;
229 typedef enum _BL_TRANSLATION_TYPE
235 } BL_TRANSLATION_TYPE
;
237 typedef enum _BL_ARCH_MODE
246 typedef enum _BL_DEVICE_TYPE
249 LegacyPartitionDevice
= 2,
258 // Local Device Types
260 typedef enum _BL_LOCAL_DEVICE_TYPE
267 VirtualDiskDevice
= 6
268 } BL_LOCAL_DEVICE_TYPE
;
273 typedef enum _BL_PARTITION_TYPE
283 typedef enum _BL_PATH_TYPE
292 typedef enum _BL_MEMORY_CLASS
302 typedef enum _BL_MEMORY_TYPE
307 BlLoaderMemory
= 0xD0000002,
308 BlLoaderDeviceMemory
= 0xD0000004,
309 BlLoaderHeap
= 0xD0000005,
310 BlLoaderPageDirectory
= 0xD0000006,
311 BlLoaderReferencePage
= 0xD0000007,
312 BlLoaderRamDisk
= 0xD0000008,
313 BlLoaderArchData
= 0xD0000009,
314 BlLoaderData
= 0xD000000A,
315 BlLoaderRegistry
= 0xD000000B,
316 BlLoaderBlockMemory
= 0xD000000C,
317 BlLoaderSelfMap
= 0xD000000F,
320 // Application Memory
322 BlApplicationReserved
= 0xE0000001,
323 BlApplicationData
= 0xE0000004,
328 BlConventionalMemory
= 0xF0000001,
329 BlUnusableMemory
= 0xF0000002,
330 BlReservedMemory
= 0xF0000003,
331 BlEfiBootMemory
= 0xF0000004,
332 BlConventionalZeroedMemory
= 0xF000005,
333 BlEfiRuntimeCodeMemory
= 0xF0000006,
334 BlAcpiReclaimMemory
= 0xF0000008,
335 BlAcpiNvsMemory
= 0xF0000009,
336 BlDeviceIoMemory
= 0xF000000A,
337 BlDevicePortMemory
= 0xF000000B,
338 BlPalMemory
= 0xF000000C,
339 BlEfiRuntimeDataMemory
= 0xF000000E,
342 typedef enum _BL_MEMORY_ATTR
345 // Memory Caching Attributes
347 BlMemoryUncached
= 0x00000001,
348 BlMemoryWriteCombined
= 0x00000002,
349 BlMemoryWriteThrough
= 0x00000004,
350 BlMemoryWriteBack
= 0x00000008,
351 BlMemoryUncachedExported
= 0x00000010,
352 BlMemoryValidCacheAttributes
= BlMemoryUncached
| BlMemoryWriteCombined
| BlMemoryWriteThrough
| BlMemoryWriteBack
| BlMemoryUncachedExported
,
353 BlMemoryValidCacheAttributeMask
= 0x000000FF,
356 // Memory Protection Attributes
358 BlMemoryWriteProtected
= 0x00000100,
359 BlMemoryReadProtected
= 0x00000200,
360 BlMemoryExecuteProtected
= 0x00000400,
361 BlMemoryValidProtectionAttributes
= BlMemoryWriteProtected
| BlMemoryReadProtected
| BlMemoryExecuteProtected
,
362 BlMemoryValidProtectionAttributeMask
= 0x0000FF00,
365 // Memory Allocation Attributes
367 BlMemoryLargePages
= 0x00010000,
368 BlMemoryKernelRange
= 0x00020000,
369 BlMemoryFixed
= 0x00040000,
370 BlMemoryBelow1MB
= 0x00080000,
371 BlMemoryValidAllocationAttributes
= BlMemoryKernelRange
| BlMemoryFixed
| BlMemoryBelow1MB
| BlMemoryLargePages
,
372 BlMemoryValidAllocationAttributeMask
= 0x00FF0000,
375 // Memory Type Attributes
377 BlMemoryRuntime
= 0x01000000,
378 BlMemoryCoalesced
= 0x02000000,
379 BlMemoryUpdate
= 0x04000000,
380 BlMemoryNonFirmware
= 0x08000000,
381 BlMemoryPersistent
= 0x10000000,
382 BlMemorySpecial
= 0x20000000,
383 BlMemoryFirmware
= 0x80000000,
384 BlMemoryValidTypeAttributes
= BlMemoryRuntime
| BlMemoryCoalesced
| BlMemoryUpdate
| BlMemoryNonFirmware
| BlMemoryPersistent
| BlMemorySpecial
| BlMemoryFirmware
,
385 BlMemoryValidTypeAttributeMask
= 0xFF000000,
388 /* CALLBACKS *****************************************************************/
390 struct _BL_FILE_ENTRY
;
391 struct _BL_FILE_INFORMATION
;
395 _In_
struct _BL_FILE_ENTRY
* Directory
,
396 _In_ PWCHAR FileName
,
398 _Out_
struct _BL_FILE_ENTRY
** FileEntry
404 _In_
struct _BL_FILE_ENTRY
* FileEntry
410 _In_
struct _BL_FILE_ENTRY
* FileEntry
,
413 _Out_opt_ PULONG BytesRead
424 (*PBL_FILE_GET_NEXT
) (
430 (*PBL_FILE_GET_INFO
) (
431 _In_
struct _BL_FILE_ENTRY
* FileEntry
,
432 _Out_
struct _BL_FILE_INFORMATION
* FileInfo
437 (*PBL_FILE_SET_INFO
) (
438 _In_
struct _BL_FILE_ENTRY
* FileEntry
,
439 _In_
struct _BL_FILE_INFORMATION
* FileInfo
444 (*PBL_FS_INIT_CALLBACK
) (
450 (*PBL_FS_DESTROY_CALLBACK
) (
456 (*PBL_FS_MOUNT_CALLBACK
) (
459 _Out_
struct _BL_FILE_ENTRY
** FileEntry
464 (*PBL_FS_PURGE_CALLBACK
) (
470 (*PBL_FILE_DESTROY_CALLBACK
) (
474 struct _BL_TEXT_CONSOLE
;
475 struct _BL_DISPLAY_STATE
;
476 struct _BL_DISPLAY_MODE
;
477 struct _BL_INPUT_CONSOLE
;
478 struct _BL_REMOTE_CONSOLE
;
479 struct _BL_GRAPHICS_CONSOLE
;
482 (*PCONSOLE_DESTRUCT
) (
483 _In_
struct _BL_TEXT_CONSOLE
* Console
488 (*PCONSOLE_REINITIALIZE
) (
489 _In_
struct _BL_TEXT_CONSOLE
* Console
494 (*PCONSOLE_GET_TEXT_STATE
) (
495 _In_
struct _BL_TEXT_CONSOLE
* Console
,
496 _Out_
struct _BL_DISPLAY_STATE
* TextState
501 (*PCONSOLE_SET_TEXT_STATE
) (
502 _In_
struct _BL_TEXT_CONSOLE
* Console
,
504 _In_
struct _BL_DISPLAY_STATE
* TextState
509 (*PCONSOLE_GET_TEXT_RESOLUTION
) (
510 _In_
struct _BL_TEXT_CONSOLE
* Console
,
511 _Out_ PULONG TextResolution
516 (*PCONSOLE_SET_TEXT_RESOLUTION
) (
517 _In_
struct _BL_TEXT_CONSOLE
* Console
,
518 _In_ ULONG NewTextResolution
,
519 _Out_ PULONG OldTextResolution
524 (*PCONSOLE_CLEAR_TEXT
) (
525 _In_
struct _BL_TEXT_CONSOLE
* Console
,
526 _In_ BOOLEAN LineOnly
531 (*PCONSOLE_IS_ENABLED
) (
532 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
537 (*PCONSOLE_GET_GRAPHICAL_RESOLUTION
) (
538 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
539 _Out_
struct _BL_DISPLAY_MODE
* DisplayMode
544 (*PCONSOLE_SET_GRAPHICAL_RESOLUTION
) (
545 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
546 _In_
struct _BL_DISPLAY_MODE DisplayMode
552 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
558 (*PCONSOLE_WRITE_TEXT
) (
559 _In_
struct _BL_TEXT_CONSOLE
* Console
,
566 (*PBL_TBL_LOOKUP_ROUTINE
) (
568 _In_ PVOID Argument1
,
569 _In_ PVOID Argument2
,
570 _In_ PVOID Argument3
,
576 (*PBL_TBL_MAP_ROUTINE
) (
578 _In_ ULONG EntryIndex
583 (*PBL_TBL_SET_ROUTINE
) (
589 (*PBL_IO_DESTROY_ROUTINE
) (
593 struct _BL_HASH_ENTRY
;
596 (*PBL_HASH_TABLE_COMPARE_FUNCTION
) (
597 _In_
struct _BL_HASH_ENTRY
* Entry1
,
598 _In_
struct _BL_HASH_ENTRY
* Entry2
603 (*PBL_HASH_TABLE_HASH_FUNCTION
) (
604 _In_
struct _BL_HASH_ENTRY
* Entry
,
608 struct _BL_DEVICE_ENTRY
;
609 struct _BL_DEVICE_DESCRIPTOR
;
610 struct _BL_DEVICE_INFORMATION
;
614 (*PBL_DEVICE_ENUMERATE_DEVICE_CLASS
) (
621 _In_
struct _BL_DEVICE_DESCRIPTOR
* Device
,
622 _In_
struct _BL_DEVICE_ENTRY
* DeviceEntry
627 (*PBL_DEVICE_CLOSE
) (
628 _In_
struct _BL_DEVICE_ENTRY
* DeviceEntry
634 _In_
struct _BL_DEVICE_ENTRY
* DeviceEntry
,
637 _Out_ PULONG BytesRead
642 (*PBL_DEVICE_WRITE
) (
648 (*PBL_DEVICE_GET_INFORMATION
) (
649 _In_
struct _BL_DEVICE_ENTRY
* DeviceEntry
,
650 _Out_
struct _BL_DEVICE_INFORMATION
* DeviceInformation
655 (*PBL_DEVICE_SET_INFORMATION
) (
656 _In_
struct _BL_DEVICE_ENTRY
* DeviceEntry
,
657 _In_
struct _BL_DEVICE_INFORMATION
* DeviceInformation
662 (*PBL_DEVICE_RESET
) (
668 (*PBL_DEVICE_FLUSH
) (
674 (*PBL_DEVICE_CREATE
) (
678 /* DATA STRUCTURES ***********************************************************/
680 typedef struct _BL_LIBRARY_PARAMETERS
683 ULONG TranslationType
;
684 ULONG MinimumAllocationCount
;
685 ULONG MinimumHeapSize
;
686 ULONG HeapAllocationAttributes
;
687 PWCHAR ApplicationBaseDirectory
;
688 ULONG DescriptorCount
;
689 PWCHAR FontBaseDirectory
;
690 } BL_LIBRARY_PARAMETERS
, *PBL_LIBRARY_PARAMETERS
;
692 /* This should eventually go into a more public header */
693 typedef struct _BOOT_APPLICATION_PARAMETER_BLOCK
695 /* This header tells the library what image we're dealing with */
700 ULONG MemoryTranslationType
;
702 /* Where is the image located */
706 /* Offset to BL_MEMORY_DATA */
707 ULONG MemoryDataOffset
;
709 /* Offset to BL_APPLICATION_ENTRY */
710 ULONG AppEntryOffset
;
712 /* Offset to BL_DEVICE_DESCRPIPTOR */
713 ULONG BootDeviceOffset
;
715 /* Offset to BL_FIRMWARE_PARAMETERS */
716 ULONG FirmwareParametersOffset
;
718 /* Offset to BL_RETURN_ARGUMENTS */
719 ULONG ReturnArgumentsOffset
;
720 } BOOT_APPLICATION_PARAMETER_BLOCK
, *PBOOT_APPLICATION_PARAMETER_BLOCK
;
722 typedef struct _BL_MEMORY_DATA
726 ULONG DescriptorCount
;
727 ULONG DescriptorSize
;
728 ULONG DescriptorOffset
;
729 } BL_MEMORY_DATA
, *PBL_MEMORY_DATA
;
731 typedef struct _BL_FIRMWARE_DESCRIPTOR
735 EFI_HANDLE ImageHandle
;
736 EFI_SYSTEM_TABLE
*SystemTable
;
737 } BL_FIRMWARE_DESCRIPTOR
, *PBL_FIRMWARE_DESCRIPTOR
;
739 typedef struct _BL_RETURN_ARGUMENTS
746 } BL_RETURN_ARGUMENTS
, *PBL_RETURN_ARGUMENTS
;
748 typedef struct _BL_MEMORY_DESCRIPTOR
750 LIST_ENTRY ListEntry
;
756 ULONGLONG VirtualPage
;
760 ULONGLONG BaseAddress
;
761 ULONGLONG VirtualAddress
;
767 } BL_MEMORY_DESCRIPTOR
, *PBL_MEMORY_DESCRIPTOR
;
769 typedef struct _BL_BCD_OPTION
775 ULONG NextEntryOffset
;
777 } BL_BCD_OPTION
, *PBL_BCD_OPTION
;
779 typedef struct _BL_APPLICATION_ENTRY
785 BL_BCD_OPTION BcdData
;
786 } BL_APPLICATION_ENTRY
, *PBL_APPLICATION_ENTRY
;
788 typedef struct _BL_LOADED_APPLICATION_ENTRY
792 PBL_BCD_OPTION BcdData
;
793 } BL_LOADED_APPLICATION_ENTRY
, *PBL_LOADED_APPLICATION_ENTRY
;
795 typedef struct _BL_MENU_STATUS
802 ULONG AdvancedOptions
: 1;
803 ULONG BootOptions
: 1;
812 } BL_MENU_STATUS
, *PL_MENU_STATUS
;
814 typedef enum _BL_BOOT_ERROR_STATUS
824 } BL_BOOT_ERROR_STATUS
;
826 typedef struct _BL_HARDDISK_DEVICE
833 ULONG PartitionSignature
;
838 GUID PartitionSignature
;
846 } BL_HARDDISK_DEVICE
;
848 typedef struct _BL_LOCAL_DEVICE
858 BL_HARDDISK_DEVICE HardDisk
;
862 PHYSICAL_ADDRESS ImageBase
;
863 LARGE_INTEGER ImageSize
;
867 ULONG File
; // unknown for now
869 } BL_LOCAL_DEVICE
, *PBL_LOCAL_DEVICE
;
871 typedef struct _BL_DEVICE_DESCRIPTOR
873 DEVICE_TYPE DeviceType
;
879 BL_LOCAL_DEVICE Local
;
890 ULONG PartitionNumber
;
898 BL_LOCAL_DEVICE Disk
;
901 } BL_DEVICE_DESCRIPTOR
, *PBL_DEVICE_DESCRIPTOR
;
903 typedef struct _BL_FILE_PATH_DESCRIPTOR
908 UCHAR Path
[ANYSIZE_ARRAY
];
909 } BL_FILE_PATH_DESCRIPTOR
, *PBL_FILE_PATH_DESCRIPTOR
;
911 typedef struct _BL_WINDOWS_LOAD_OPTIONS
917 WCHAR LoadOptions
[ANYSIZE_ARRAY
];
918 } BL_WINDOWS_LOAD_OPTIONS
, *PBL_WINDOWS_LOAD_OPTIONS
;
920 typedef struct _BL_ARCH_CONTEXT
923 BL_TRANSLATION_TYPE TranslationType
;
925 } BL_ARCH_CONTEXT
, *PBL_ARCH_CONTEXT
;
927 typedef struct _BL_MEMORY_DESCRIPTOR_LIST
933 } BL_MEMORY_DESCRIPTOR_LIST
, *PBL_MEMORY_DESCRIPTOR_LIST
;
935 typedef struct _BL_ADDRESS_RANGE
939 } BL_ADDRESS_RANGE
, *PBL_ADDRESS_RANGE
;
941 typedef struct _BL_FILE_INFORMATION
947 } BL_FILE_INFORMATION
, *PBL_FILE_INFORMATION
;
949 typedef struct _BL_FILE_CALLBACKS
952 PBL_FILE_CLOSE Close
;
954 PBL_FILE_WRITE Write
;
955 PBL_FILE_GET_NEXT GetNext
;
956 PBL_FILE_GET_INFO GetInfo
;
957 PBL_FILE_SET_INFO SetInfo
;
958 } BL_FILE_CALLBACKS
, *PBL_FILE_CALLBACKS
;
960 typedef struct _BL_FILE_ENTRY
966 ULONG ReferenceCount
;
968 ULONGLONG TotalBytesRead
;
970 BL_FILE_CALLBACKS Callbacks
;
971 PVOID FsSpecificData
;
972 } BL_FILE_ENTRY
, *PBL_FILE_ENTRY
;
974 typedef struct _BL_FILE_SYSTEM_ENTRY
976 LIST_ENTRY ListEntry
;
977 PBL_FS_INIT_CALLBACK InitCallback
;
978 PBL_FS_DESTROY_CALLBACK DestroyCallback
;
979 PBL_FS_MOUNT_CALLBACK MountCallback
;
980 PBL_FS_PURGE_CALLBACK PurgeCallback
;
981 } BL_FILE_SYSTEM_ENTRY
, *PBL_FILE_SYSTEM_ENTRY
;
983 typedef struct _BL_FILE_SYSTEM_REGISTRATION_TABLE
985 PBL_FS_INIT_CALLBACK Init
;
986 PBL_FS_DESTROY_CALLBACK Destroy
;
987 PBL_FS_MOUNT_CALLBACK Mount
;
988 PBL_FS_PURGE_CALLBACK Purge
;
989 } BL_FILE_SYSTEM_REGISTRATION_TABLE
;
991 typedef struct _BL_DISPLAY_STATE
998 } BL_DISPLAY_STATE
, *PBL_DISPLAY_STATE
;
1000 typedef struct _BL_DISPLAY_MODE
1005 } BL_DISPLAY_MODE
, *PBL_DISPLAY_MODE
;
1007 typedef struct _BL_TEXT_CONSOLE_VTABLE
1009 PCONSOLE_DESTRUCT Destruct
;
1010 PCONSOLE_REINITIALIZE Reinitialize
;
1011 PCONSOLE_GET_TEXT_STATE GetTextState
;
1012 PCONSOLE_SET_TEXT_STATE SetTextState
;
1013 PCONSOLE_GET_TEXT_RESOLUTION GetTextResolution
;
1014 PCONSOLE_SET_TEXT_RESOLUTION SetTextResolution
;
1015 PCONSOLE_CLEAR_TEXT ClearText
;
1016 PCONSOLE_WRITE_TEXT WriteText
;
1017 } BL_TEXT_CONSOLE_VTABLE
, *PBL_TEXT_CONSOLE_VTABLE
;
1019 typedef struct _BL_GRAPHICS_CONSOLE_VTABLE
1021 BL_TEXT_CONSOLE_VTABLE Text
;
1022 PCONSOLE_IS_ENABLED IsEnabled
;
1023 PCONSOLE_ENABLE Enable
;
1024 PVOID GetConsoleResolution
;
1025 PCONSOLE_GET_GRAPHICAL_RESOLUTION GetGraphicalResolution
;
1026 PCONSOLE_GET_GRAPHICAL_RESOLUTION GetOriginalResolution
;
1027 PCONSOLE_SET_GRAPHICAL_RESOLUTION SetOriginalResolution
;
1028 /// more for graphics ///
1029 } BL_GRAPHICS_CONSOLE_VTABLE
, *PBL_GRAPHICS_CONSOLE_VTABLE
;
1031 typedef struct _BL_TEXT_CONSOLE
1033 PBL_TEXT_CONSOLE_VTABLE Callbacks
;
1034 BL_DISPLAY_STATE State
;
1035 BL_DISPLAY_MODE DisplayMode
;
1037 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
* Protocol
;
1039 EFI_SIMPLE_TEXT_OUTPUT_MODE OldMode
;
1040 } BL_TEXT_CONSOLE
, *PBL_TEXT_CONSOLE
;
1042 typedef struct _BL_INPUT_CONSOLE_VTABLE
1044 PCONSOLE_DESTRUCT Destruct
;
1045 PCONSOLE_REINITIALIZE Reinitialize
;
1046 //PCONSOLE_IS_KEY_PENDING IsKeyPending;
1047 //PCONSOLE_READ_INPUT ReadInput;
1048 //PCONSOLE_ERASE_BUFFER EraseBuffer;
1049 //PCONSOLE_FILL_BUFFER FillBuffer;
1050 } BL_INPUT_CONSOLE_VTABLE
, *PBL_INPUT_CONSOLE_VTABLE
;
1052 typedef struct _BL_INPUT_CONSOLE
1054 PBL_INPUT_CONSOLE_VTABLE Callbacks
;
1059 } BL_INPUT_CONSOLE
, *PBL_INPUT_CONSOLE
;
1061 typedef enum _BL_GRAPHICS_CONSOLE_TYPE
1065 } BL_GRAPHICS_CONSOLE_TYPE
;
1067 typedef struct _BL_GRAPHICS_CONSOLE
1069 BL_TEXT_CONSOLE TextConsole
;
1070 BL_DISPLAY_MODE DisplayMode
;
1074 BL_DISPLAY_MODE OldDisplayMode
;
1075 ULONG OldPixelDepth
;
1077 BL_GRAPHICS_CONSOLE_TYPE Type
;
1078 EFI_GRAPHICS_OUTPUT_PROTOCOL
* Protocol
;
1080 ULONG FrameBufferSize
;
1081 ULONG PixelsPerScanLine
;
1084 } BL_GRAPHICS_CONSOLE
, *PBL_GRAPHICS_CONSOLE
;
1086 typedef struct _BL_REMOTE_CONSOLE
1088 BL_TEXT_CONSOLE TextConsole
;
1089 } BL_REMOTE_CONSOLE
, *PBL_REMOTE_CONSOLE
;
1091 typedef struct _BL_HASH_TABLE
1093 PLIST_ENTRY HashLinks
;
1095 PBL_HASH_TABLE_COMPARE_FUNCTION CompareFunction
;
1096 PBL_HASH_TABLE_HASH_FUNCTION HashFunction
;
1097 } BL_HASH_TABLE
, *PBL_HASH_TABLE
;
1099 typedef struct _BL_HASH_ENTRY
1104 } BL_HASH_ENTRY
, *PBL_HASH_ENTRY
;
1106 typedef struct _BL_HASH_VALUE
1110 } BL_HASH_VALUE
, *PBL_HASH_VALUE
;
1112 typedef struct _BL_HASH_NODE
1114 LIST_ENTRY ListEntry
;
1115 BL_HASH_ENTRY Entry
;
1116 BL_HASH_VALUE Value
;
1117 } BL_HASH_NODE
, *PBL_HASH_NODE
;
1119 typedef struct _BL_BLOCK_DEVICE_INFORMATION
1121 BL_LOCAL_DEVICE_TYPE Type
;
1124 BL_PARTITION_TYPE PartitionType
;
1127 ULONGLONG LastBlock
;
1144 } BL_BLOCK_DEVICE_INFORMATION
, *PBL_BLOCK_DEVICE_INFORMATION
;
1146 typedef struct _BL_DEVICE_INFORMATION
1148 BL_DEVICE_TYPE DeviceType
;
1151 BL_BLOCK_DEVICE_INFORMATION BlockDeviceInfo
;
1153 } BL_DEVICE_INFORMATION
, *PBL_DEVICE_INFORMATION
;
1155 typedef struct _BL_BLOCK_DEVICE
1157 BL_BLOCK_DEVICE_INFORMATION
;
1158 ULONGLONG StartOffset
;
1159 EFI_BLOCK_IO
* Protocol
;
1161 } BL_BLOCK_DEVICE
, *PBL_BLOCK_DEVICE
;
1163 typedef struct _BL_PROTOCOL_HANDLE
1167 } BL_PROTOCOL_HANDLE
, *PBL_PROTOCOL_HANDLE
;
1169 typedef struct _BL_DEVICE_CALLBACKS
1171 PBL_DEVICE_ENUMERATE_DEVICE_CLASS EnumerateDeviceClass
;
1172 PBL_DEVICE_OPEN Open
;
1173 PBL_DEVICE_CLOSE Close
;
1174 PBL_DEVICE_READ Read
;
1175 PBL_DEVICE_WRITE Write
;
1176 PBL_DEVICE_GET_INFORMATION GetInformation
;
1177 PBL_DEVICE_SET_INFORMATION SetInformation
;
1178 PBL_DEVICE_RESET Reset
;
1179 PBL_DEVICE_FLUSH Flush
;
1180 PBL_DEVICE_CREATE Create
;
1181 } BL_DEVICE_CALLBACKS
, *PBL_DEVICE_CALLBACKS
;
1183 typedef struct _BL_DEVICE_ENTRY
1188 ULONG ReferenceCount
;
1189 BL_DEVICE_CALLBACKS Callbacks
;
1190 PVOID DeviceSpecificData
;
1191 PBL_DEVICE_DESCRIPTOR DeviceDescriptor
;
1192 } BL_DEVICE_ENTRY
, *PBL_DEVICE_ENTRY
;
1194 typedef struct _BL_IMG_FILE
1204 } BL_IMG_FILE
, *PBL_IMG_FILE
;
1206 typedef struct _BL_IMAGE_APPLICATION_ENTRY
1208 PBL_APPLICATION_ENTRY AppEntry
;
1211 } BL_IMAGE_APPLICATION_ENTRY
, *PBL_IMAGE_APPLICATION_ENTRY
;
1213 typedef struct _BL_IMAGE_PARAMETERS
1218 } BL_IMAGE_PARAMETERS
, *PBL_IMAGE_PARAMETERS
;
1220 typedef struct _BL_DEFERRED_FONT_FILE
1222 LIST_ENTRY ListEntry
;
1224 PBL_DEVICE_DESCRIPTOR Device
;
1226 } BL_DEFERRED_FONT_FILE
, *PBL_DEFERRED_FONT_FILE
;
1230 typedef struct _BMP_HEADER
1236 } BMP_HEADER
, *PBMP_HEADER
;
1238 typedef struct _DIB_HEADER
1247 ULONG XPelsPerMeter
;
1248 ULONG YPelsPerMEter
;
1251 } DIB_HEADER
, *PDIB_HEADER
;
1253 typedef struct _BITMAP
1255 BMP_HEADER BmpHeader
;
1256 DIB_HEADER DibHeader
;
1260 typedef struct _COORD
1266 typedef struct _BL_PD_DATA_BLOB
1271 } BL_PD_DATA_BLOB
, *PBL_PD_DATA_BLOB
;
1273 /* INLINE ROUTINES ***********************************************************/
1277 BlSetupDefaultParameters (
1278 _Out_ PBL_LIBRARY_PARAMETERS LibraryParameters
1281 BL_LIBRARY_PARAMETERS DefaultParameters
=
1293 /* Copy the defaults */
1294 RtlCopyMemory(LibraryParameters
, &DefaultParameters
, sizeof(*LibraryParameters
));
1299 MmMdInitializeListHead (
1300 _In_ PBL_MEMORY_DESCRIPTOR_LIST List
1303 /* Initialize the list */
1304 InitializeListHead(&List
->ListHead
);
1305 List
->First
= &List
->ListHead
;
1310 /* INITIALIZATION ROUTINES ***************************************************/
1313 BlInitializeLibrary(
1314 _In_ PBOOT_APPLICATION_PARAMETER_BLOCK BootAppParameters
,
1315 _In_ PBL_LIBRARY_PARAMETERS LibraryParameters
1326 _In_ PBL_FIRMWARE_DESCRIPTOR FirmwareParameters
1331 _In_ PBL_MEMORY_DATA MemoryData
,
1332 _In_ BL_TRANSLATION_TYPE TranslationType
,
1333 _In_ PBL_LIBRARY_PARAMETERS LibraryParameters
1343 _In_ PBL_MEMORY_DATA MemoryData
,
1344 _In_ ULONG MinimumPages
1350 _In_ PBL_MEMORY_DATA MemoryData
,
1351 _In_ BL_TRANSLATION_TYPE TranslationType
,
1352 _In_ BL_TRANSLATION_TYPE LibraryTranslationType
1357 _In_ ULONG HeapSize
,
1358 _In_ ULONG HeapAttributes
1364 _In_ PBL_LIBRARY_PARAMETERS LibraryParameters
1368 BlpDeviceInitialize (
1383 BlpDisplayInitialize (
1388 BlpDisplayReinitialize (
1402 /* FIRMWARE ROUTINES *********************************************************/
1412 _In_ PBL_FIRMWARE_DESCRIPTOR Parameters
1416 BlFwEnumerateDevice (
1417 _In_ PBL_DEVICE_DESCRIPTOR Device
1424 _Inout_ EFI_PHYSICAL_ADDRESS
* Memory
1429 _In_ ULONG StallTime
1443 EfiConOutOutputString (
1444 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1449 EfiConOutQueryMode (
1450 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1452 _In_ UINTN
* Columns
,
1458 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1463 EfiConOutReadCurrentMode (
1464 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1465 _Out_ EFI_SIMPLE_TEXT_OUTPUT_MODE
* Mode
1469 EfiConOutSetAttribute (
1470 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1471 _In_ ULONG Attribute
1475 EfiConOutSetCursorPosition (
1476 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1482 EfiConOutEnableCursor (
1483 _In_ SIMPLE_TEXT_OUTPUT_INTERFACE
*TextInterface
,
1484 _In_ BOOLEAN Visible
1488 EfiLocateHandleBuffer (
1489 _In_ EFI_LOCATE_SEARCH_TYPE SearchType
,
1490 _In_ EFI_GUID
*Protocol
,
1491 _Inout_ PULONG HandleCount
,
1492 _Inout_ EFI_HANDLE
** Buffer
1497 _In_ EFI_HANDLE Handle
,
1498 _In_ EFI_GUID
*Protocol
,
1499 _Out_ PVOID
* Interface
1504 _In_ EFI_HANDLE Handle
,
1505 _In_ EFI_GUID
*Protocol
1509 EfiGopGetCurrentMode (
1510 _In_ EFI_GRAPHICS_OUTPUT_PROTOCOL
*GopInterface
,
1512 _Out_ EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Information
1517 _In_ EFI_GRAPHICS_OUTPUT_PROTOCOL
*GopInterface
,
1522 EfiGopGetFrameBuffer (
1523 _In_ EFI_GRAPHICS_OUTPUT_PROTOCOL
*GopInterface
,
1524 _Out_ PHYSICAL_ADDRESS
* FrameBuffer
,
1525 _Out_ UINTN
*FrameBufferSize
1530 _In_ EFI_RESET_TYPE ResetType
1535 _In_ EFI_DEVICE_PATH
*DevicePath
1539 EfiIsDevicePathParent (
1540 _In_ EFI_DEVICE_PATH
*DevicePath1
,
1541 _In_ EFI_DEVICE_PATH
*DevicePath2
1546 _Out_ PPHYSICAL_ADDRESS FoundRsdt
1552 _In_ EFI_PHYSICAL_ADDRESS PhysicalAddress
1555 /* PLATFORM TIMER ROUTINES ***************************************************/
1558 BlpTimeCalibratePerformanceCounter (
1563 BlTimeQueryPerformanceCounter (
1564 _Out_opt_ PLARGE_INTEGER Frequency
1568 BlArchGetPerformanceCounter (
1572 /* RESOURCE LOCALE INTERNATIONALIZATION ROUTINES *****************************/
1575 BlpDisplayRegisterLocale (
1579 /* FONT ROUTINES *************************************************************/
1582 BfiFreeDeferredFontFile (
1583 _In_ PBL_DEFERRED_FONT_FILE DeferredFontFile
1588 _In_ PBL_DEVICE_DESCRIPTOR Device
,
1589 _In_ PWCHAR FontPath
1593 BfLoadDeferredFontFiles (
1599 _In_ PBL_GRAPHICS_CONSOLE Console
1603 BfClearToEndOfLine (
1604 _In_ PBL_GRAPHICS_CONSOLE Console
1607 /* FILESYSTEM ROUTINES *******************************************************/
1616 _In_ ULONG DeviceId
,
1618 _Out_ PBL_FILE_ENTRY
* FileEntry
1628 _In_ ULONG DeviceId
,
1630 _Out_ PBL_FILE_ENTRY
* FileEntry
1633 /* DEBUG ROUTINES ************************************************************/
1637 BlBdDebuggerEnabled (
1642 BlBdPullRemoteFile (
1643 _In_ PWCHAR FilePath
,
1644 _Out_ PVOID BaseAddress
,
1645 _Out_ PULONGLONG FileSize
1656 _In_ ULONG ErrorCode
,
1657 _In_ ULONG Parameter1
,
1658 _In_ ULONG_PTR Parameter2
,
1659 _In_ ULONG_PTR Parameter3
,
1660 _In_ ULONG_PTR Parameter4
1663 /* UTILITY ROUTINES **********************************************************/
1667 _In_ ULONG Function
,
1668 _In_ ULONG SubFunction
,
1673 BlArchIsCpuIdFunctionSupported (
1678 BlUtlUpdateProgress (
1679 _In_ ULONG Percentage
,
1680 _Out_opt_ PBOOLEAN Completed
1685 _Out_ PVOID
* TableAddress
,
1686 _In_ ULONG Signature
1695 BlUtlRegisterProgressRoutine (
1701 _In_ ULONG PartialSum
,
1708 BlGetApplicationBaseAndSize (
1709 _Out_ PVOID
* ImageBase
,
1710 _Out_ PULONG ImageSize
1714 BlDestroyBootEntry (
1715 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
1720 _In_
const GUID
* DataGuid
,
1722 _Inout_ PBL_PD_DATA_BLOB DataBlob
1725 /* FIRMWARE UTILITY ROUTINES *************************************************/
1728 EfiGetEfiStatusCode(
1729 _In_ NTSTATUS Status
1733 EfiGetNtStatusCode (
1734 _In_ EFI_STATUS EfiStatus
1744 _In_ ULONG BasePage
,
1745 _In_ ULONG PageCount
1749 BlGetApplicationIdentifier (
1754 BlpSecureBootEFIIsEnabled (
1759 BlSecureBootIsEnabled (
1760 _Out_ PBOOLEAN SecureBootEnabled
1764 BlSecureBootCheckForFactoryReset (
1768 /* RESOURCE ROUTINES *********************************************************/
1771 BlResourceFindMessage (
1776 BlResourceFindHtml (
1781 BlpResourceInitialize (
1785 /* TABLE ROUTINES ************************************************************/
1791 _In_ PBL_TBL_MAP_ROUTINE MapCallback
1798 _Out_ PULONG EntryIndex
,
1799 _In_ PBL_TBL_LOOKUP_ROUTINE Callback
,
1800 _In_ PVOID Argument1
,
1801 _In_ PVOID Argument2
,
1802 _In_ PVOID Argument3
,
1803 _In_ PVOID Argument4
1808 _Inout_ PVOID
** Table
,
1809 _Inout_ PULONG Count
,
1811 _Out_ PULONG EntryIndex
,
1812 _In_ PBL_TBL_SET_ROUTINE Callback
1816 TblDoNotPurgeEntry (
1820 /* HASH TABLE ROUTINES *******************************************************/
1825 _In_ PBL_HASH_ENTRY Entry
,
1833 _In_ PBL_HASH_ENTRY Entry
,
1834 _Out_ PBL_HASH_VALUE
*Value
1840 _In_ PBL_HASH_TABLE_HASH_FUNCTION HashFunction
,
1841 _In_ PBL_HASH_TABLE_COMPARE_FUNCTION CompareFunction
,
1845 /* BCD OPTION ROUTINES *******************************************************/
1849 _In_ PBL_BCD_OPTION List
,
1854 BlGetBootOptionListSize (
1855 _In_ PBL_BCD_OPTION BcdOption
1859 BlGetBootOptionSize (
1860 _In_ PBL_BCD_OPTION BcdOption
1864 BlGetBootOptionString (
1865 _In_ PBL_BCD_OPTION List
,
1871 BlGetBootOptionInteger (
1872 _In_ PBL_BCD_OPTION List
,
1874 _Out_ PULONGLONG Value
1878 BlGetBootOptionBoolean (
1879 _In_ PBL_BCD_OPTION List
,
1881 _Out_ PBOOLEAN Value
1885 BlpGetBootOptionIntegerList (
1886 _In_ PBL_BCD_OPTION List
,
1888 _Out_ PULONGLONG
* Value
,
1889 _Out_ PULONGLONG Count
,
1894 BlGetBootOptionDevice (
1895 _In_ PBL_BCD_OPTION List
,
1897 _Out_ PBL_DEVICE_DESCRIPTOR
* Value
,
1898 _In_opt_ PBL_BCD_OPTION
* ExtraOptions
1902 BlGetBootOptionGuid (
1903 _In_ PBL_BCD_OPTION List
,
1909 BlGetBootOptionGuidList (
1910 _In_ PBL_BCD_OPTION List
,
1918 _In_ PBL_BCD_OPTION OptionList
,
1919 _Out_ PBL_BCD_OPTION
*CopiedOptions
1923 BlAppendBootOptionBoolean (
1924 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
,
1929 BlAppendBootOptionInteger (
1930 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
,
1931 _In_ ULONG OptionId
,
1932 _In_ ULONGLONG Value
1936 BlAppendBootOptionString (
1937 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
,
1938 _In_ PWCHAR OptionString
1942 BlAppendBootOptions (
1943 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
,
1944 _In_ PBL_BCD_OPTION Options
1948 BlRemoveBootOption (
1949 _In_ PBL_BCD_OPTION List
,
1954 BlReplaceBootOptions (
1955 _In_ PBL_LOADED_APPLICATION_ENTRY AppEntry
,
1956 _In_ PBL_BCD_OPTION NewOptions
1959 /* BOOT REGISTRY ROUTINES ****************************************************/
1963 _In_ HANDLE KeyHandle
1968 _In_ HANDLE ParentHandle
,
1969 _In_ PWCHAR KeyName
,
1970 _Out_ PHANDLE Handle
1975 _In_ PBL_FILE_PATH_DESCRIPTOR FilePath
,
1976 _Out_ PHANDLE HiveHandle
1980 BiGetRegistryValue (
1981 _In_ HANDLE KeyHandle
,
1982 _In_ PWCHAR ValueName
,
1984 _Out_ PVOID
* Buffer
,
1985 _Out_ PULONG ValueLength
1989 BiEnumerateSubKeys (
1990 _In_ HANDLE KeyHandle
,
1991 _Out_ PWCHAR
** SubKeyList
,
1992 _Out_ PULONG SubKeyCount
1997 _In_ HANDLE KeyHandle
2002 _In_ HANDLE KeyHandle
2005 /* CONTEXT ROUTINES **********************************************************/
2008 BlpArchSwitchContext (
2009 _In_ BL_ARCH_MODE NewMode
2013 BlpArchEnableTranslation (
2018 Archx86TransferTo32BitApplicationAsm (
2022 /* MEMORY DESCRIPTOR ROUTINES ************************************************/
2026 _In_ PBL_MEMORY_DESCRIPTOR_LIST DescriptorList
,
2027 _In_opt_ ULONG MaxCount
2031 MmMdInitializeList (
2032 _In_ PBL_MEMORY_DESCRIPTOR_LIST DescriptorList
,
2034 _In_ PLIST_ENTRY ListHead
2037 PBL_MEMORY_DESCRIPTOR
2038 MmMdFindDescriptor (
2039 _In_ ULONG WhichList
,
2044 PBL_MEMORY_DESCRIPTOR
2045 MmMdFindDescriptorFromMdl (
2046 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
,
2053 _In_ PBL_MEMORY_DESCRIPTOR_LIST DestinationList
,
2054 _In_ PBL_MEMORY_DESCRIPTOR_LIST SourceList
,
2055 _In_opt_ PBL_MEMORY_DESCRIPTOR ListDescriptor
,
2056 _Out_ PULONG ActualCount
,
2063 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
2068 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
2071 PBL_MEMORY_DESCRIPTOR
2072 MmMdInitByteGranularDescriptor (
2074 _In_ BL_MEMORY_TYPE Type
,
2075 _In_ ULONGLONG BasePage
,
2076 _In_ ULONGLONG VirtualPage
,
2077 _In_ ULONGLONG PageCount
2081 MmMdFreeGlobalDescriptors (
2086 MmMdAddDescriptorToList (
2087 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
,
2088 _In_ PBL_MEMORY_DESCRIPTOR MemoryDescriptor
,
2093 MmMdTruncateDescriptors (
2094 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
,
2095 _In_ PBL_MEMORY_DESCRIPTOR_LIST NewList
,
2096 _In_ ULONGLONG BasePage
2100 MmMdRemoveDescriptorFromList (
2101 _In_ PBL_MEMORY_DESCRIPTOR_LIST MdList
,
2102 _In_ PBL_MEMORY_DESCRIPTOR Entry
2106 MmMdFindSatisfyingRegion (
2107 _In_ PBL_MEMORY_DESCRIPTOR Descriptor
,
2108 _Out_ PBL_MEMORY_DESCRIPTOR NewDescriptor
,
2109 _In_ ULONGLONG Pages
,
2110 _In_ PBL_ADDRESS_RANGE BaseRange
,
2111 _In_ PBL_ADDRESS_RANGE VirtualRange
,
2112 _In_ BOOLEAN TopDown
,
2113 _In_ BL_MEMORY_TYPE MemoryType
,
2115 _In_ ULONG Alignment
2119 MmMdRemoveRegionFromMdlEx (
2120 __in PBL_MEMORY_DESCRIPTOR_LIST MdList
,
2122 __in ULONGLONG BasePage
,
2123 __in ULONGLONG PageCount
,
2124 __in PBL_MEMORY_DESCRIPTOR_LIST NewMdList
2128 MmMdFreeDescriptor (
2129 _In_ PBL_MEMORY_DESCRIPTOR MemoryDescriptor
2132 /* PAGE ALLOCATOR ROUTINES ***************************************************/
2135 MmPaTruncateMemory (
2136 _In_ ULONGLONG BasePage
2140 BlMmAllocatePhysicalPages(
2141 _Inout_ PPHYSICAL_ADDRESS Address
,
2142 _In_ BL_MEMORY_TYPE MemoryType
,
2143 _In_ ULONGLONG PageCount
,
2144 _In_ ULONG Attributes
,
2145 _In_ ULONG Alignment
2149 MmPapAllocatePhysicalPagesInRange (
2150 _Inout_ PPHYSICAL_ADDRESS BaseAddress
,
2151 _In_ BL_MEMORY_TYPE MemoryType
,
2152 _In_ ULONGLONG Pages
,
2153 _In_ ULONG Attributes
,
2154 _In_ ULONG Alignment
,
2155 _In_ PBL_MEMORY_DESCRIPTOR_LIST NewList
,
2156 _In_opt_ PBL_ADDRESS_RANGE Range
,
2157 _In_ ULONG RangeType
2161 MmPaReleaseSelfMapPages (
2162 _In_ PHYSICAL_ADDRESS Address
2166 MmPaReserveSelfMapPages (
2167 _Inout_ PPHYSICAL_ADDRESS PhysicalAddress
,
2168 _In_ ULONG Alignment
,
2169 _In_ ULONG PageCount
2172 BlMmFreePhysicalPages (
2173 _In_ PHYSICAL_ADDRESS Address
2179 _In_ ULONG WhichList
2183 MmPapAllocatePagesInRange (
2184 _Inout_ PVOID
* PhysicalAddress
,
2185 _In_ BL_MEMORY_TYPE MemoryType
,
2186 _In_ ULONGLONG Pages
,
2187 _In_ ULONG Attributes
,
2188 _In_ ULONG Alignment
,
2189 _In_opt_ PBL_ADDRESS_RANGE Range
,
2195 _Out_ PBL_MEMORY_DESCRIPTOR_LIST MemoryMap
,
2200 BlpMmInitializeConstraints (
2205 BlMmRemoveBadMemory (
2211 _In_ PLIST_ENTRY MemoryMap
,
2212 _In_ PBL_IMAGE_PARAMETERS MemoryParameters
,
2213 _In_ ULONG WhichTypes
,
2217 /* VIRTUAL MEMORY ROUTINES ***************************************************/
2220 MmSelectMappingAddress (
2221 _Out_ PVOID
* MappingAddress
,
2222 _In_ PVOID PreferredAddress
,
2223 _In_ ULONGLONG Size
,
2224 _In_ ULONG AllocationAttributes
,
2226 _In_ PHYSICAL_ADDRESS PhysicalAddress
2230 MmMapPhysicalAddress (
2231 _Inout_ PPHYSICAL_ADDRESS PhysicalAddress
,
2232 _Out_ PVOID
* VirtualAddress
,
2233 _Inout_ PULONGLONG Size
,
2234 _In_ ULONG CacheAttributes
2238 MmUnmapVirtualAddress (
2239 _Inout_ PVOID
* VirtualAddress
,
2240 _Inout_ PULONGLONG Size
2244 BlMmMapPhysicalAddressEx (
2245 _In_ PVOID
* VirtualAddress
,
2246 _In_ ULONG Attributes
,
2247 _In_ ULONGLONG Size
,
2248 _In_ PHYSICAL_ADDRESS PhysicalAddress
2252 BlMmUnmapVirtualAddressEx (
2253 _In_ PVOID VirtualAddress
,
2258 BlMmTranslateVirtualAddress (
2259 _In_ PVOID VirtualAddress
,
2260 _Out_ PPHYSICAL_ADDRESS PhysicalAddress
2264 MmArchTranslateVirtualAddress (
2265 _In_ PVOID VirtualAddress
,
2266 _Out_opt_ PPHYSICAL_ADDRESS PhysicalAddress
,
2267 _Out_opt_ PULONG CachingFlags
2270 /* BLOCK ALLOCATOR ROUTINES **************************************************/
2273 BlpMmCreateBlockAllocator (
2277 /* HEAP ALLOCATOR ROUTINES ***************************************************/
2289 /* DISPLAY ROUTINES **********************************************************/
2292 BlDisplayGetTextCellResolution (
2293 _Out_ PULONG TextWidth
,
2294 _Out_ PULONG TextHeight
2298 BlDisplaySetScreenResolution (
2303 BlDisplayGetScreenResolution (
2309 BlDisplayInvalidateOemBitmap (
2314 BlDisplayGetOemBitmap (
2315 _Out_ PCOORD Offset
,
2316 _Out_opt_ PULONG Flags
2320 BlDisplayValidOemBitmap (
2325 BlDisplayClearScreen (
2330 BlDisplaySetCursorType (
2334 /* I/O ROUTINES **************************************************************/
2337 BlpIoRegisterDestroyRoutine (
2338 _In_ PBL_IO_DESTROY_ROUTINE DestroyRoutine
2348 _In_ PBL_DEVICE_DESCRIPTOR Device
,
2351 _Out_ PULONG DeviceId
2355 BlDeviceGetInformation (
2356 _In_ ULONG DeviceId
,
2357 _Out_ PBL_DEVICE_INFORMATION DeviceInformation
2361 BlDeviceSetInformation (
2362 _In_ ULONG DeviceId
,
2363 _In_ PBL_DEVICE_INFORMATION DeviceInformation
2367 BlDeviceReadAtOffset (
2368 _In_ ULONG DeviceId
,
2370 _In_ ULONGLONG Offset
,
2372 _Out_ PULONG BytesRead
2375 /* IMAGE ROUTINES ************************************************************/
2378 BlImgLoadImageWithProgress2 (
2379 _In_ ULONG DeviceId
,
2380 _In_ BL_MEMORY_TYPE MemoryType
,
2381 _In_ PWCHAR FileName
,
2382 _Inout_ PVOID
* MappedBase
,
2383 _Inout_ PULONG MappedSize
,
2384 _In_ ULONG ImageFlags
,
2385 _In_ BOOLEAN ShowProgress
,
2386 _Out_opt_ PUCHAR
* HashBuffer
,
2387 _Out_opt_ PULONG HashSize
2390 PIMAGE_SECTION_HEADER
2392 _In_ PVOID ImageBase
,
2393 _In_ ULONG ImageSize
2397 BlImgLoadBootApplication (
2398 _In_ PBL_LOADED_APPLICATION_ENTRY BootEntry
,
2399 _Out_ PULONG AppHandle
2403 BlImgStartBootApplication (
2404 _In_ ULONG AppHandle
,
2405 _Inout_ PBL_RETURN_ARGUMENTS ReturnArguments
2409 BlImgUnloadBootApplication (
2410 _In_ ULONG AppHandle
2414 BlImgQueryCodeIntegrityBootOptions (
2415 _In_ PBL_LOADED_APPLICATION_ENTRY ApplicationEntry
,
2416 _Out_ PBOOLEAN IntegrityChecksDisabled
,
2417 _Out_ PBOOLEAN TestSigning
2420 /* FILE I/O ROUTINES *********************************************************/
2428 BlFileReadAtOffsetEx (
2431 _In_ ULONGLONG ByteOffset
,
2433 _Out_ PULONG BytesReturned
,
2438 BlFileGetInformation (
2440 _In_ PBL_FILE_INFORMATION FileInfo
2445 _In_ ULONG DeviceId
,
2446 _In_ PWCHAR FileName
,
2451 /* BLOCK I/O ROUTINES *******************************************************/
2454 BlockIoEfiCompareDevice (
2455 _In_ PBL_DEVICE_DESCRIPTOR Device
,
2456 _In_ EFI_HANDLE Handle
2459 /* INPUT CONSOLE ROUTINES ****************************************************/
2462 ConsoleInputLocalDestruct (
2463 _In_
struct _BL_INPUT_CONSOLE
* Console
2467 ConsoleInputBaseReinitialize (
2468 _In_
struct _BL_INPUT_CONSOLE
* Console
2472 ConsoleCreateLocalInputCnsole (
2476 /* TEXT CONSOLE ROUTINES *****************************************************/
2479 ConsoleGraphicalDestruct (
2480 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
2484 ConsoleGraphicalClearText (
2485 _In_ PBL_GRAPHICS_CONSOLE Console
,
2486 _In_ BOOLEAN LineOnly
2490 ConsoleGraphicalClearPixels (
2491 _In_ PBL_GRAPHICS_CONSOLE Console
,
2496 ConsoleGraphicalReinitialize (
2497 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
2501 ConsoleGraphicalSetTextState (
2502 _In_ PBL_GRAPHICS_CONSOLE Console
,
2504 _In_ PBL_DISPLAY_STATE TextState
2508 ConsoleGraphicalIsEnabled (
2509 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
2513 ConsoleGraphicalGetGraphicalResolution (
2514 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
2515 _In_ PBL_DISPLAY_MODE DisplayMode
2519 ConsoleGraphicalGetOriginalResolution (
2520 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
2521 _In_ PBL_DISPLAY_MODE DisplayMode
2525 ConsoleGraphicalEnable (
2526 _In_
struct _BL_GRAPHICS_CONSOLE
* Console
,
2531 ConsoleTextLocalDestruct (
2532 _In_
struct _BL_TEXT_CONSOLE
* Console
2536 ConsoleTextLocalReinitialize (
2537 _In_
struct _BL_TEXT_CONSOLE
* Console
2541 ConsoleTextBaseGetTextState (
2542 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2543 _Out_ PBL_DISPLAY_STATE TextState
2547 ConsoleTextLocalSetTextState (
2548 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2550 _In_ PBL_DISPLAY_STATE TextState
2554 ConsoleTextBaseGetTextResolution (
2555 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2556 _Out_ PULONG TextResolution
2560 ConsoleTextLocalSetTextResolution (
2561 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2562 _In_ ULONG NewTextResolution
,
2563 _Out_ PULONG OldTextResolution
2567 ConsoleTextLocalClearText (
2568 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2569 _In_ BOOLEAN LineOnly
2573 ConsoleTextLocalWriteText (
2574 _In_
struct _BL_TEXT_CONSOLE
* Console
,
2576 _In_ ULONG Attribute
2580 ConsoleTextLocalConstruct (
2581 _In_ PBL_TEXT_CONSOLE TextConsole
,
2582 _In_ BOOLEAN Activate
2586 ConsolepFindResolution (
2587 _In_ PBL_DISPLAY_MODE Mode
,
2588 _In_ PBL_DISPLAY_MODE List
,
2593 ConsoleFirmwareTextClear (
2594 _In_ PBL_TEXT_CONSOLE Console
,
2595 _In_ BOOLEAN LineOnly
2599 ConsoleFirmwareTextClose (
2600 _In_ PBL_TEXT_CONSOLE TextConsole
2604 ConsoleFirmwareTextOpen (
2605 _In_ PBL_TEXT_CONSOLE TextConsole
2609 ConsoleFirmwareTextSetState (
2610 _In_ PBL_TEXT_CONSOLE TextConsole
,
2612 _In_ PBL_DISPLAY_STATE State
2616 ConsoleGraphicalConstruct (
2617 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2621 ConsoleCreateRemoteConsole (
2622 _In_ PBL_TEXT_CONSOLE
* TextConsole
2626 ConsoleEfiGraphicalOpenProtocol (
2627 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
,
2628 _In_ BL_GRAPHICS_CONSOLE_TYPE Type
2632 ConsoleFirmwareGraphicalClose (
2633 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2637 ConsoleFirmwareGraphicalDisable (
2638 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2642 ConsoleFirmwareGraphicalClear (
2643 _In_ PBL_GRAPHICS_CONSOLE Console
,
2648 ConsoleFirmwareGraphicalEnable (
2649 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2654 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2658 ConsoleEfiUgaClose (
2659 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2663 ConsoleEfiGopClose (
2664 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2669 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2673 ConsoleEfiGopEnable (
2674 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
2678 ConsoleEfiUgaSetResolution (
2679 _In_ PBL_GRAPHICS_CONSOLE GraphicsConsole
,
2680 _In_ PBL_DISPLAY_MODE DisplayMode
,
2681 _In_ ULONG DisplayModeCount
2685 ConsoleCreateLocalInputConsole (
2690 ConsoleInputLocalEraseBuffer (
2691 _In_ PBL_INPUT_CONSOLE Console
,
2692 _In_opt_ PULONG ValueToFill
2696 ConsolepClearBuffer (
2697 _In_ PUCHAR FrameBuffer
,
2699 _In_ PUCHAR FillColor
,
2701 _In_ ULONG ScanlineWidth
,
2702 _In_ ULONG PixelDepth
2706 ConsolepConvertColorToPixel (
2707 _In_ BL_COLOR Color
,
2711 extern ULONG MmDescriptorCallTreeCount
;
2712 extern ULONG BlpApplicationFlags
;
2713 extern BL_LIBRARY_PARAMETERS BlpLibraryParameters
;
2714 extern BL_TRANSLATION_TYPE MmTranslationType
;
2715 extern PBL_ARCH_CONTEXT CurrentExecutionContext
;
2716 extern PBL_DEVICE_DESCRIPTOR BlpBootDevice
;
2717 extern BL_LOADED_APPLICATION_ENTRY BlpApplicationEntry
;
2718 extern EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*EfiConOut
;
2719 extern EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*EfiConInEx
;
2720 extern EFI_GUID EfiGraphicsOutputProtocol
;
2721 extern EFI_GUID EfiUgaDrawProtocol
;
2722 extern EFI_GUID EfiLoadedImageProtocol
;
2723 extern EFI_GUID EfiDevicePathProtocol
;
2724 extern EFI_GUID EfiBlockIoProtocol
;
2725 extern EFI_GUID EfiSimpleTextInputExProtocol
;
2726 extern EFI_GUID EfiRootAcpiTableGuid
;
2727 extern EFI_GUID EfiRootAcpiTable10Guid
;
2728 extern EFI_GUID EfiGlobalVariable
;
2729 extern ULONG ConsoleGraphicalResolutionListFlags
;
2730 extern BL_DISPLAY_MODE ConsoleGraphicalResolutionList
[];
2731 extern BL_DISPLAY_MODE ConsoleTextResolutionList
[];
2732 extern ULONG ConsoleGraphicalResolutionListSize
;
2733 extern PVOID DspRemoteInputConsole
;
2734 extern PVOID DspLocalInputConsole
;
2735 extern WCHAR BlScratchBuffer
[8192];
2736 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlMappedAllocated
;
2737 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlMappedUnallocated
;
2738 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlFwAllocationTracker
;
2739 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlUnmappedAllocated
;
2740 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlUnmappedUnallocated
;
2741 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlReservedAllocated
;
2742 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlBadMemory
;
2743 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlTruncatedMemory
;
2744 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlPersistentMemory
;
2745 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlCompleteBadMemory
;
2746 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlFreeVirtual
;
2747 extern BL_MEMORY_DESCRIPTOR_LIST MmMdlMappingTrackers
;
2748 extern ULONGLONG BlpTimePerformanceFrequency
;
2749 extern LIST_ENTRY RegisteredFileSystems
;
2750 extern BL_ADDRESS_RANGE MmArchKsegAddressRange
;
2751 extern ULONG_PTR MmArchTopOfApplicationAddressSpace
;