3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 BDS library definition, include the file and data structure
25 extern EFI_HANDLE mBdsImageHandle
;
28 // Constants which are variable names used to access variables
30 #define VarLegacyDevOrder L"LegacyDevOrder"
33 // Data structures and defines
35 #define FRONT_PAGE_QUESTION_ID 0x0000
36 #define FRONT_PAGE_DATA_WIDTH 0x01
41 #define CONSOLE_OUT 0x00000001
42 #define STD_ERROR 0x00000002
43 #define CONSOLE_IN 0x00000004
44 #define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)
47 // Load Option Attributes defined in EFI Specification
49 #define LOAD_OPTION_ACTIVE 0x00000001
50 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
51 #define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)
54 // Define Maxmim characters that will be accepted
57 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
59 #define MIN_ALIGNMENT_SIZE 4
60 #define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)
63 // Define maximum characters for boot option variable "BootXXXX"
65 #define BOOT_OPTION_MAX_CHAR 10
68 // This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.
70 #define BDS_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'C', 'O')
77 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
85 UINT32 LoadOptionsSize
;
90 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
92 } BDS_CONSOLE_CONNECT_ENTRY
;
99 // Bds boot relate lib functions
102 BdsLibUpdateBootOrderList (
103 IN LIST_ENTRY
*BdsOptionList
,
104 IN CHAR16
*VariableName
113 BdsLibBootViaBootOption (
114 IN BDS_COMMON_OPTION
* Option
,
115 IN EFI_DEVICE_PATH_PROTOCOL
* DevicePath
,
116 OUT UINTN
*ExitDataSize
,
117 OUT CHAR16
**ExitData OPTIONAL
121 BdsLibEnumerateAllBootOption (
122 IN OUT LIST_ENTRY
*BdsBootOptionList
126 BdsLibBuildOptionFromHandle (
127 IN EFI_HANDLE Handle
,
128 IN LIST_ENTRY
*BdsBootOptionList
132 BdsLibBuildOptionFromShell (
133 IN EFI_HANDLE Handle
,
134 IN LIST_ENTRY
*BdsBootOptionList
138 // Bds misc lib functions
147 OUT EFI_BOOT_MODE
*BootMode
152 IN LIST_ENTRY
*BdsDriverLists
156 BdsLibBuildOptionFromVar (
157 IN LIST_ENTRY
*BdsCommonOptionList
,
158 IN CHAR16
*VariableName
162 BdsLibGetVariableAndSize (
164 IN EFI_GUID
*VendorGuid
,
165 OUT UINTN
*VariableSize
169 BdsLibOutputStrings (
170 IN EFI_SIMPLE_TEXT_OUT_PROTOCOL
*ConOut
,
175 BdsLibVariableToOption (
176 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
177 IN CHAR16
*VariableName
181 BdsLibRegisterNewOption (
182 IN LIST_ENTRY
*BdsOptionList
,
183 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
185 IN CHAR16
*VariableName
189 // Bds connect or disconnect driver lib funcion
192 BdsLibConnectAllDriversToAllControllers (
202 BdsLibConnectDevicePath (
203 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
207 BdsLibConnectAllEfi (
212 BdsLibDisconnectAllEfi (
217 // Bds console relate lib functions
220 BdsLibConnectAllConsoles (
225 BdsLibConnectAllDefaultConsoles (
230 BdsLibUpdateConsoleVariable (
231 IN CHAR16
*ConVarName
,
232 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
233 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
237 BdsLibConnectConsoleVariable (
238 IN CHAR16
*ConVarName
242 // Bds device path relate lib functions
244 EFI_DEVICE_PATH_PROTOCOL
*
245 BdsLibUnpackDevicePath (
246 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
250 BdsLibMatchDevicePaths (
251 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
252 IN EFI_DEVICE_PATH_PROTOCOL
*Single
257 EFI_DEVICE_PATH_PROTOCOL
*DevPath
263 IN EFI_GUID
*VendorGuid
267 // Internal definitions
278 VOID (*Function
) (POOL_PRINT
*, VOID
*);
279 } DEVICE_PATH_STRING_TABLE
;
282 // Internal functions
285 BdsBootByDiskSignatureAndPartition (
286 IN BDS_COMMON_OPTION
* Option
,
287 IN HARDDRIVE_DEVICE_PATH
* HardDriveDevicePath
,
288 IN UINT32 LoadOptionsSize
,
289 IN VOID
*LoadOptions
,
290 OUT UINTN
*ExitDataSize
,
291 OUT CHAR16
**ExitData OPTIONAL
295 // Notes: EFI 64 shadow all option rom
298 #define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();
300 ShadowAllOptionRom();
302 #define EFI64_SHADOW_ALL_LEGACY_ROM()
306 // BBS support macros and functions
309 #define REFRESH_LEGACY_BOOT_OPTIONS \
310 BdsDeleteAllInvalidLegacyBootOptions ();\
311 BdsAddNonExistingLegacyBootOptions (); \
312 BdsUpdateLegacyDevOrder ()
314 #define REFRESH_LEGACY_BOOT_OPTIONS
318 BdsDeleteAllInvalidLegacyBootOptions (
323 BdsAddNonExistingLegacyBootOptions (
328 BdsUpdateLegacyDevOrder (
333 BdsRefreshBbsTableForBoot (
334 IN BDS_COMMON_OPTION
*Entry
338 BdsDeleteBootOption (
339 IN UINTN OptionNumber
,
340 IN OUT UINT16
*BootOrder
,
341 IN OUT UINTN
*BootOrderSize
345 //The interface functions relate with Setup Browser Reset Reminder feature
348 EnableResetReminderFeature (
353 DisableResetReminderFeature (
358 EnableResetRequired (
363 DisableResetRequired (
368 IsResetReminderFeatureEnable (
382 #endif // _BDS_LIB_H_