2 Header file for boot maintenance module.
4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _BOOT_MAINT_H_
16 #define _BOOT_MAINT_H_
19 #include "BBSsupport.h"
21 #include "FrontPage.h"
24 // Constants which are variable names used to access variables
26 #define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"
28 #define VAR_CON_OUT_MODE L"ConOutMode"
31 /// Guid of a NV Variable which store the information about the
32 /// FD/HD/CD/NET/BEV order
34 #define EFI_LEGACY_DEV_ORDER_VARIABLE_GUID \
36 0xa56074db, 0x65fe, 0x45f7, {0xbd, 0x21, 0x2d, 0x2b, 0xdd, 0x8e, 0x96, 0x52} \
42 #define STR_FLOPPY L"Floppy Drive #%02x"
43 #define STR_HARDDISK L"HardDisk Drive #%02x"
44 #define STR_CDROM L"ATAPI CDROM Drive #%02x"
45 #define STR_NET L"NET Drive #%02x"
46 #define STR_BEV L"BEV Drive #%02x"
47 #define STR_FLOPPY_HELP L"Select Floppy Drive #%02x"
48 #define STR_HARDDISK_HELP L"Select HardDisk Drive #%02x"
49 #define STR_CDROM_HELP L"Select ATAPI CDROM Drive #%02x"
50 #define STR_NET_HELP L"NET Drive #%02x"
51 #define STR_BEV_HELP L"BEV Drive #%02x"
54 // Variable created with this flag will be "Efi:...."
56 #define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
59 // Define Maxmim characters that will be accepted
62 #define MAX_CHAR_SIZE (MAX_CHAR * 2)
64 extern EFI_GUID mBootMaintGuid
;
65 extern EFI_GUID mFileExplorerGuid
;
66 extern CHAR16 mFileExplorerStorageName
[];
68 // These are the VFR compiler generated data representing our VFR data.
74 // Below are the number of options in Baudrate, Databits,
75 // Parity and Stopbits selection for serial ports.
77 #define BM_COM_ATTR_BUADRATE 19
78 #define BM_COM_ATTR_DATABITS 4
79 #define BM_COM_ATTR_PARITY 5
80 #define BM_COM_ATTR_STOPBITS 3
83 // Callback function helper
85 #define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')
86 #define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
88 #define FE_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, FeConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
91 // Enumeration type definition
93 typedef UINT8 BBS_TYPE
;
128 } TYPE_OF_UPATE_MANNER
;
132 BOOT_FROM_FILE_STATE
,
133 ADD_BOOT_OPTION_STATE
,
134 ADD_DRIVER_OPTION_STATE
,
136 } FILE_EXPLORER_STATE
;
142 } FILE_EXPLORER_DISPLAY_CONTEXT
;
145 // All of the signatures that will be used in list structure
147 #define BM_MENU_OPTION_SIGNATURE SIGNATURE_32 ('m', 'e', 'n', 'u')
148 #define BM_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('l', 'o', 'a', 'd')
149 #define BM_CONSOLE_OPTION_SIGNATURE SIGNATURE_32 ('c', 'n', 's', 'l')
150 #define BM_FILE_OPTION_SIGNATURE SIGNATURE_32 ('f', 'i', 'l', 'e')
151 #define BM_HANDLE_OPTION_SIGNATURE SIGNATURE_32 ('h', 'n', 'd', 'l')
152 #define BM_TERMINAL_OPTION_SIGNATURE SIGNATURE_32 ('t', 'r', 'm', 'l')
153 #define BM_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('e', 'n', 't', 'r')
155 #define BM_LOAD_CONTEXT_SELECT 0x0
156 #define BM_CONSOLE_CONTEXT_SELECT 0x1
157 #define BM_FILE_CONTEXT_SELECT 0x2
158 #define BM_HANDLE_CONTEXT_SELECT 0x3
159 #define BM_TERMINAL_CONTEXT_SELECT 0x5
161 #define BM_CONSOLE_IN_CONTEXT_SELECT 0x6
162 #define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7
163 #define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8
164 #define BM_LEGACY_DEV_CONTEXT_SELECT 0x9
167 // Buffer size for update data
169 #define UPDATE_DATA_SIZE 0x100000
172 // Namespace of callback keys used in display and file system navigation
174 #define MAX_BBS_OFFSET 0xE000
175 #define NET_OPTION_OFFSET 0xD800
176 #define BEV_OPTION_OFFSET 0xD000
177 #define FD_OPTION_OFFSET 0xC000
178 #define HD_OPTION_OFFSET 0xB000
179 #define CD_OPTION_OFFSET 0xA000
180 #define FILE_OPTION_OFFSET 0x8000
181 #define FILE_OPTION_MASK 0x7FFF
182 #define HANDLE_OPTION_OFFSET 0x7000
183 #define CONSOLE_OPTION_OFFSET 0x6000
184 #define TERMINAL_OPTION_OFFSET 0x5000
185 #define CONFIG_OPTION_OFFSET 0x1200
186 #define KEY_VALUE_OFFSET 0x1100
187 #define FORM_ID_OFFSET 0x1000
190 // VarOffset that will be used to create question
191 // all these values are computed from the structure
194 #define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))
197 // Question Id of Zero is invalid, so add an offset to it
199 #define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)
201 #define BOOT_TIME_OUT_VAR_OFFSET VAR_OFFSET (BootTimeOut)
202 #define BOOT_NEXT_VAR_OFFSET VAR_OFFSET (BootNext)
203 #define COM1_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM1BaudRate)
204 #define COM1_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM1DataRate)
205 #define COM1_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM1StopBits)
206 #define COM1_PARITY_VAR_OFFSET VAR_OFFSET (COM1Parity)
207 #define COM1_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
208 #define COM2_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM2BaudRate)
209 #define COM2_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM2DataRate)
210 #define COM2_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM2StopBits)
211 #define COM2_PARITY_VAR_OFFSET VAR_OFFSET (COM2Parity)
212 #define COM2_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
213 #define DRV_ADD_HANDLE_DESC_VAR_OFFSET VAR_OFFSET (DriverAddHandleDesc)
214 #define DRV_ADD_ACTIVE_VAR_OFFSET VAR_OFFSET (DriverAddActive)
215 #define DRV_ADD_RECON_VAR_OFFSET VAR_OFFSET (DriverAddForceReconnect)
216 #define CON_IN_COM1_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM1)
217 #define CON_IN_COM2_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM2)
218 #define CON_OUT_COM1_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM1)
219 #define CON_OUT_COM2_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM2)
220 #define CON_ERR_COM1_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM1)
221 #define CON_ERR_COM2_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM2)
222 #define CON_MODE_VAR_OFFSET VAR_OFFSET (ConsoleOutMode)
223 #define CON_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleCheck)
224 #define OPTION_ORDER_VAR_OFFSET VAR_OFFSET (OptionOrder)
225 #define DRIVER_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (DriverOptionToBeDeleted)
226 #define BOOT_OPTION_DEL_VAR_OFFSET VAR_OFFSET (BootOptionDel)
227 #define DRIVER_OPTION_DEL_VAR_OFFSET VAR_OFFSET (DriverOptionDel)
228 #define DRIVER_ADD_OPTION_VAR_OFFSET VAR_OFFSET (DriverAddHandleOptionalData)
229 #define COM_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COMBaudRate)
230 #define COM_DATA_RATE_VAR_OFFSET VAR_OFFSET (COMDataRate)
231 #define COM_STOP_BITS_VAR_OFFSET VAR_OFFSET (COMStopBits)
232 #define COM_PARITY_VAR_OFFSET VAR_OFFSET (COMParity)
233 #define COM_TERMINAL_VAR_OFFSET VAR_OFFSET (COMTerminalType)
234 #define LEGACY_FD_VAR_OFFSET VAR_OFFSET (LegacyFD)
235 #define LEGACY_HD_VAR_OFFSET VAR_OFFSET (LegacyHD)
236 #define LEGACY_CD_VAR_OFFSET VAR_OFFSET (LegacyCD)
237 #define LEGACY_NET_VAR_OFFSET VAR_OFFSET (LegacyNET)
238 #define LEGACY_BEV_VAR_OFFSET VAR_OFFSET (LegacyBEV)
240 #define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)
241 #define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)
242 #define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)
243 #define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)
244 #define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)
245 #define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)
246 #define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
247 #define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)
248 #define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)
249 #define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)
250 #define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)
251 #define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
252 #define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)
253 #define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)
254 #define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)
255 #define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)
256 #define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)
257 #define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)
258 #define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)
259 #define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)
260 #define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)
261 #define CON_MODE_QUESTION_ID QUESTION_ID (ConsoleOutMode)
262 #define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)
263 #define OPTION_ORDER_QUESTION_ID QUESTION_ID (OptionOrder)
264 #define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionToBeDeleted)
265 #define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)
266 #define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)
267 #define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)
268 #define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)
269 #define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)
270 #define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)
271 #define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)
272 #define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)
273 #define LEGACY_FD_QUESTION_ID QUESTION_ID (LegacyFD)
274 #define LEGACY_HD_QUESTION_ID QUESTION_ID (LegacyHD)
275 #define LEGACY_CD_QUESTION_ID QUESTION_ID (LegacyCD)
276 #define LEGACY_NET_QUESTION_ID QUESTION_ID (LegacyNET)
277 #define LEGACY_BEV_QUESTION_ID QUESTION_ID (LegacyBEV)
279 #define STRING_DEPOSITORY_NUMBER 8
282 /// Serial Ports attributes, first one is the value for
283 /// return from callback function, stringtoken is used to
284 /// display the value properly
295 /// Length = sizeof (UINT16) + SIZEOF (Data)
299 } BM_LEGACY_DEV_ORDER_CONTEXT
;
318 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
319 } BM_TERMINAL_CONTEXT
;
323 BOOLEAN LoadOptionModified
;
328 BOOLEAN ForceReconnect
;
329 UINTN OptionalDataSize
;
331 UINTN LoadOptionSize
;
335 UINT16 FilePathListLength
;
337 EFI_DEVICE_PATH_PROTOCOL
*FilePathList
;
348 } BM_LEGACY_DEVICE_CONTEXT
;
356 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
357 } BM_CONSOLE_CONTEXT
;
366 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
367 EFI_FILE_HANDLE FHandle
;
369 EFI_FILE_SYSTEM_VOLUME_LABEL
*Info
;
373 BOOLEAN IsRemovableMedia
;
375 BOOLEAN IsBootLegacy
;
380 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
393 UINT16
*DisplayString
;
395 EFI_STRING_ID DisplayStringToken
;
396 EFI_STRING_ID HelpStringToken
;
397 UINTN ContextSelection
;
398 VOID
*VariableContext
;
403 // Shared callback data.
407 BM_MENU_ENTRY
*MenuEntry
;
408 BM_HANDLE_CONTEXT
*HandleContext
;
409 BM_FILE_CONTEXT
*FileContext
;
410 BM_LOAD_CONTEXT
*LoadContext
;
411 BM_TERMINAL_CONTEXT
*TerminalContext
;
412 UINTN CurrentTerminal
;
416 // BMM main formset callback data.
418 EFI_HII_HANDLE BmmHiiHandle
;
419 EFI_HANDLE BmmDriverHandle
;
420 EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess
;
421 EFI_FORM_ID BmmCurrentPageId
;
422 EFI_FORM_ID BmmPreviousPageId
;
423 BOOLEAN BmmAskSaveOrNot
;
424 BMM_FAKE_NV_DATA BmmFakeNvData
;
425 BMM_FAKE_NV_DATA BmmOldFakeNVData
;
428 // File explorer formset callback data.
430 EFI_HII_HANDLE FeHiiHandle
;
431 EFI_HANDLE FeDriverHandle
;
432 EFI_HII_CONFIG_ACCESS_PROTOCOL FeConfigAccess
;
433 FILE_EXPLORER_STATE FeCurrentState
;
434 FILE_EXPLORER_DISPLAY_CONTEXT FeDisplayContext
;
435 FILE_EXPLORER_NV_DATA FeFakeNvData
;
438 typedef struct _STRING_LIST_NODE
{
439 EFI_STRING_ID StringToken
;
440 struct _STRING_LIST_NODE
*Next
;
443 typedef struct _STRING_DEPOSITORY
{
444 UINTN TotalNodeNumber
;
445 STRING_LIST_NODE
*CurrentNode
;
446 STRING_LIST_NODE
*ListHead
;
452 // For initializing File System menu
456 This function build the FsOptionMenu list which records all
457 available file system in the system. They includes all instances
458 of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM
459 and all type of legacy boot device.
461 @param CallbackData BMM context data
463 @retval EFI_SUCCESS Success find the file system
464 @retval EFI_OUT_OF_RESOURCES Can not create menu entry
468 BOpt_FindFileSystem (
469 IN BMM_CALLBACK_DATA
*CallbackData
473 Find files under current directory
474 All files and sub-directories in current directory
475 will be stored in DirectoryMenu for future use.
477 @param CallbackData The BMM context data.
478 @param MenuEntry The Menu Entry.
480 @retval EFI_SUCCESS Get files from current dir successfully.
481 @return Other value if can't get files from current dir.
486 IN BMM_CALLBACK_DATA
*CallbackData
,
487 IN BM_MENU_ENTRY
*MenuEntry
492 Find drivers that will be added as Driver#### variables from handles
493 in current system environment
494 All valid handles in the system except those consume SimpleFs, LoadFile
495 are stored in DriverMenu for future use.
497 @retval EFI_SUCCESS The function complets successfully.
498 @return Other value if failed to build the DriverMenu.
508 Build the BootOptionMenu according to BootOrder Variable.
509 This Routine will access the Boot#### to get EFI_LOAD_OPTION.
511 @param CallbackData The BMM context data.
513 @return The number of the Var Boot####.
517 BOpt_GetBootOptions (
518 IN BMM_CALLBACK_DATA
*CallbackData
523 Build up all DriverOptionMenu
525 @param CallbackData The BMM context data.
527 @return EFI_SUCESS The functin completes successfully.
528 @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.
533 BOpt_GetDriverOptions (
534 IN BMM_CALLBACK_DATA
*CallbackData
539 Build the LegacyFDMenu LegacyHDMenu LegacyCDMenu according to LegacyBios.GetBbsInfo().
541 @retval EFI_SUCCESS The function complete successfully.
542 @retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.
546 BOpt_GetLegacyOptions (
551 Free out resouce allocated from Legacy Boot Options.
555 BOpt_FreeLegacyOptions (
560 Free resources allocated in Allocate Rountine.
562 @param FreeMenu Menu to be freed
567 BM_MENU_OPTION
*FreeMenu
573 Append file name to existing file name.
575 @param Str1 The existing file name
576 @param Str2 The file name to be appended
578 @return Allocate a new string to hold the appended result.
579 Caller is responsible to free the returned string.
583 BOpt_AppendFileName (
590 Check whether current FileName point to a valid
593 @param FileName File need to be checked.
595 @retval TRUE Is Efi Image
596 @retval FALSE Not a valid Efi Image
600 BOpt_IsEfiImageName (
606 Check whether current FileName point to a valid Efi Application
608 @param Dir Pointer to current Directory
609 @param FileName Pointer to current File name.
611 @retval TRUE Is a valid Efi Application
612 @retval FALSE not a valid Efi Application
617 IN EFI_FILE_HANDLE Dir
,
623 Get the Option Number that has not been allocated for use.
625 @return The available Option Number.
629 BOpt_GetBootOptionNumber (
635 Get the Option Number that is not in use.
637 @return The unused Option Number.
641 BOpt_GetDriverOptionNumber (
646 Create a menu entry give a Menu type.
648 @param MenuType The Menu type to be created.
651 @retval NULL If failed to create the menu.
656 BOpt_CreateMenuEntry (
661 Free up all resource allocated for a BM_MENU_ENTRY.
663 @param MenuEntry A pointer to BM_MENU_ENTRY.
667 BOpt_DestroyMenuEntry (
668 BM_MENU_ENTRY
*MenuEntry
672 Get the Menu Entry from the list in Menu Entry List.
674 If MenuNumber is great or equal to the number of Menu
675 Entry in the list, then ASSERT.
677 @param MenuOption The Menu Entry List to read the menu entry.
678 @param MenuNumber The index of Menu Entry.
680 @return The Menu Entry.
685 BM_MENU_OPTION
*MenuOption
,
690 // Locate all serial io devices for console
693 Build a list containing all serial devices.
695 @retval EFI_SUCCESS The function complete successfully.
696 @retval EFI_UNSUPPORTED No serial ports present.
705 // Initializing Console menu
708 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
710 @retval EFI_SUCCESS The function always complete successfully.
719 // Get current mode information
722 Get mode number according to column and row
724 @param CallbackData The BMM context data.
728 IN BMM_CALLBACK_DATA
*CallbackData
732 // Cleaning up console menu
735 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
737 @retval EFI_SUCCESS The function always complete successfully.
745 Update the device path that describing a terminal device
746 based on the new BaudRate, Data Bits, parity and Stop Bits
749 @param DevicePath The devicepath protocol instance wanted to be updated.
753 ChangeVariableDevicePath (
754 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
758 Update the multi-instance device path of Terminal Device based on
759 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal
760 device path in the Terminal Device in TerminalMenu is also updated.
762 @param DevicePath The multi-instance device path.
763 @param ChangeTerminal TRUE, then device path in the Terminal Device
764 in TerminalMenu is also updated; FALSE, no update.
766 @return EFI_SUCCESS The function completes successfully.
770 ChangeTerminalDevicePath (
771 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
772 IN BOOLEAN ChangeTerminal
776 // Variable operation by menu selection
779 This function create a currently loaded Boot Option from
780 the BMM. It then appends this Boot Option to the end of
781 the "BootOrder" list. It also append this Boot Opotion to the end
784 @param CallbackData The BMM context data.
785 @param NvRamMap The file explorer formset internal state.
787 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
788 @retval EFI_SUCCESS If function completes successfully.
792 Var_UpdateBootOption (
793 IN BMM_CALLBACK_DATA
*CallbackData
,
794 IN FILE_EXPLORER_NV_DATA
*NvRamMap
798 Delete Boot Option that represent a Deleted state in BootOptionMenu.
799 After deleting this boot option, call Var_ChangeBootOrder to
800 make sure BootOrder is in valid state.
802 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
803 BM_LOAD_CONTEXT marked for deletion is deleted
804 @return Others If failed to update the "BootOrder" variable after deletion.
813 After any operation on Boot####, there will be a discrepancy in BootOrder.
814 Since some are missing but in BootOrder, while some are present but are
815 not reflected by BootOrder. Then a function rebuild BootOrder from
816 scratch by content from BootOptionMenu is needed.
818 @retval EFI_SUCCESS The boot order is updated successfully.
819 @return other than EFI_SUCCESS if failed to change the "BootOrder" EFI Variable.
823 Var_ChangeBootOrder (
828 This function create a currently loaded Drive Option from
829 the BMM. It then appends this Driver Option to the end of
830 the "DriverOrder" list. It append this Driver Opotion to the end
833 @param CallbackData The BMM context data.
834 @param HiiHandle The HII handle associated with the BMM formset.
835 @param DescriptionData The description of this driver option.
836 @param OptionalData The optional load option.
837 @param ForceReconnect If to force reconnect.
839 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
840 @retval EFI_SUCCESS If function completes successfully.
844 Var_UpdateDriverOption (
845 IN BMM_CALLBACK_DATA
*CallbackData
,
846 IN EFI_HII_HANDLE HiiHandle
,
847 IN UINT16
*DescriptionData
,
848 IN UINT16
*OptionalData
,
849 IN UINT8 ForceReconnect
853 Delete Load Option that represent a Deleted state in BootOptionMenu.
854 After deleting this Driver option, call Var_ChangeDriverOrder to
855 make sure DriverOrder is in valid state.
857 @retval EFI_SUCCESS Load Option is successfully updated.
858 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
863 Var_DelDriverOption (
868 After any operation on Driver####, there will be a discrepancy in
869 DriverOrder. Since some are missing but in DriverOrder, while some
870 are present but are not reflected by DriverOrder. Then a function
871 rebuild DriverOrder from scratch by content from DriverOptionMenu is
874 @retval EFI_SUCCESS The driver order is updated successfully.
875 @return other than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
879 Var_ChangeDriverOrder (
884 This function delete and build multi-instance device path ConIn
887 @retval EFI_SUCCESS The function complete successfully.
888 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
891 Var_UpdateConsoleInpOption (
896 This function delete and build multi-instance device path ConOut console device.
898 @retval EFI_SUCCESS The function complete successfully.
899 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
902 Var_UpdateConsoleOutOption (
907 This function delete and build multi-instance device path ErrOut console device.
909 @retval EFI_SUCCESS The function complete successfully.
910 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
913 Var_UpdateErrorOutOption (
918 Update the device path of "ConOut", "ConIn" and "ErrOut" based on the new BaudRate, Data Bits,
919 parity and stop Bits set.
923 Var_UpdateAllConsoleOption (
928 This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM,
929 this EFI Variable is deleted.
930 It also update the BMM context data specified the "BootNext" value.
932 @param CallbackData The BMM context data.
934 @retval EFI_SUCCESS The function complete successfully.
935 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
940 IN BMM_CALLBACK_DATA
*CallbackData
944 This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh
945 BootOptionMenu with the new "BootOrder" list.
947 @param CallbackData The BMM context data.
949 @retval EFI_SUCCESS The function complete successfully.
950 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
951 @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.
955 Var_UpdateBootOrder (
956 IN BMM_CALLBACK_DATA
*CallbackData
960 This function update the "DriverOrder" EFI Variable based on
961 BMM Formset's NV map. It then refresh DriverOptionMenu
962 with the new "DriverOrder" list.
964 @param CallbackData The BMM context data.
966 @retval EFI_SUCCESS The function complete successfully.
967 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
968 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
972 Var_UpdateDriverOrder (
973 IN BMM_CALLBACK_DATA
*CallbackData
977 Update the legacy BBS boot option. L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable
978 is udpated with the new Legacy Boot order. The EFI Variable of "Boot####" and gEfiGlobalVariableGuid
981 @param CallbackData The context data for BMM.
983 @return EFI_SUCCESS The function completed successfully.
984 @retval EFI_NOT_FOUND If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can not be found.
988 Var_UpdateBBSOption (
989 IN BMM_CALLBACK_DATA
*CallbackData
993 Update the Text Mode of Console.
995 @param CallbackData The context data for BMM.
997 @retval EFI_SUCCSS If the Text Mode of Console is updated.
998 @return Other value if the Text Mode of Console is not updated.
1003 IN BMM_CALLBACK_DATA
*CallbackData
1007 // Following are page create and refresh functions
1010 Refresh the global UpdateData structure.
1019 Clean up the dynamic opcode at label and form specified by
1022 @param LabelId It is both the Form ID and Label ID for
1024 @param CallbackData The BMM context data.
1030 IN BMM_CALLBACK_DATA
*CallbackData
1034 Create a lit of boot option from global BootOptionMenu. It
1035 allow user to delete the boot option.
1037 @param CallbackData The BMM context data.
1042 IN BMM_CALLBACK_DATA
*CallbackData
1046 Create a lit of driver option from global DriverMenu.
1048 @param CallbackData The BMM context data.
1051 UpdateDrvAddHandlePage (
1052 IN BMM_CALLBACK_DATA
*CallbackData
1056 Create a lit of driver option from global DriverOptionMenu. It
1057 allow user to delete the driver option.
1059 @param CallbackData The BMM context data.
1063 IN BMM_CALLBACK_DATA
*CallbackData
1067 Prepare the page to allow user to add description for a Driver Option.
1069 @param CallbackData The BMM context data.
1072 UpdateDriverAddHandleDescPage (
1073 IN BMM_CALLBACK_DATA
*CallbackData
1077 Dispatch the correct update page function to call based on the UpdatePageId.
1079 @param UpdatePageId The form ID.
1080 @param CallbackData The BMM context data.
1084 IN UINT16 UpdatePageId
,
1085 IN BMM_CALLBACK_DATA
*CallbackData
1089 Create the dynamic page to allow user to set the "BootNext" vaule.
1091 @param CallbackData The BMM context data.
1094 UpdateBootNextPage (
1095 IN BMM_CALLBACK_DATA
*CallbackData
1099 Create the dynamic page to allow user to set the "TimeOut" vaule.
1101 @param CallbackData The BMM context data.
1105 IN BMM_CALLBACK_DATA
*CallbackData
1109 Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,
1110 Parity, Stop Bits, Terminal Type.
1112 @param CallbackData The BMM context data.
1115 UpdateTerminalPage (
1116 IN BMM_CALLBACK_DATA
*CallbackData
1120 Refresh the text mode page
1122 @param CallbackData The BMM context data.
1126 IN BMM_CALLBACK_DATA
*CallbackData
1130 Create a list of Goto Opcode for all terminal devices logged
1131 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.
1133 @param CallbackData The BMM context data.
1137 IN BMM_CALLBACK_DATA
*CallbackData
1141 Create a dynamic page so that Legacy Device boot order
1142 can be set for specified device type.
1144 @param UpdatePageId The form ID. It also spefies the legacy device type.
1145 @param CallbackData The BMM context data.
1148 UpdateSetLegacyDeviceOrderPage (
1149 IN UINT16 UpdatePageId
,
1150 IN BMM_CALLBACK_DATA
*CallbackData
1155 Function opens and returns a file handle to the root directory of a volume.
1157 @param DeviceHandle A handle for a device
1158 @return A valid file handle or NULL is returned
1162 IN EFI_HANDLE DeviceHandle
1166 Function gets the file system information from an open file descriptor,
1167 and stores it in a buffer allocated from pool.
1169 @param FHand The file handle.
1171 @return A pointer to a buffer with file information.
1172 NULL is returned if failed to get Vaolume Label Info.
1174 EFI_FILE_SYSTEM_VOLUME_LABEL
*
1175 EfiLibFileSystemVolumeLabelInfo (
1176 IN EFI_FILE_HANDLE FHand
1181 Function gets the file information from an open file descriptor, and stores it
1182 in a buffer allocated from pool.
1184 @param FHand File Handle.
1186 @return A pointer to a buffer with file information or NULL is returned
1191 IN EFI_FILE_HANDLE FHand
1195 Find the first instance of this Protocol in the system and return it's interface.
1197 @param ProtocolGuid Provides the protocol to search for
1198 @param Interface On return, a pointer to the first interface
1199 that matches ProtocolGuid
1201 @retval EFI_SUCCESS A protocol instance matching ProtocolGuid was found
1202 @retval EFI_NOT_FOUND No protocol instances were found that match ProtocolGuid
1206 EfiLibLocateProtocol (
1207 IN EFI_GUID
*ProtocolGuid
,
1208 OUT VOID
**Interface
1212 Adjusts the size of a previously allocated buffer.
1214 @param OldPool A pointer to the buffer whose size is being adjusted.
1215 @param OldSize The size of the current buffer.
1216 @param NewSize The size of the new buffer.
1218 @return The newly allocated buffer. if NULL, allocation failed.
1229 Function deletes the variable specified by VarName and VarGuid.
1232 @param VarName A Null-terminated Unicode string that is
1233 the name of the vendor's variable.
1235 @param VarGuid A unique identifier for the vendor.
1237 @retval EFI_SUCCESS The variable was found and removed
1238 @retval EFI_UNSUPPORTED The variable store was inaccessible
1239 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available
1240 @retval EFI_NOT_FOUND The variable was not found
1244 EfiLibDeleteVariable (
1246 IN EFI_GUID
*VarGuid
1252 @param Src The source.
1254 @return A new string which is duplicated copy of the source.
1255 @retval NULL If there is not enough memory.
1264 Function is used to determine the number of device path instances
1265 that exist in a device path.
1268 @param DevicePath A pointer to a device path data structure.
1270 @return This function counts and returns the number of device path instances
1275 EfiDevicePathInstanceCount (
1276 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1280 Create string tokens for a menu from its help strings and display strings
1283 @param CallbackData The BMM context data.
1284 @param HiiHandle Hii Handle of the package to be updated.
1285 @param MenuOption The Menu whose string tokens need to be created
1287 @retval EFI_SUCCESS string tokens created successfully
1288 @retval others contain some errors
1292 CreateMenuStringToken (
1293 IN BMM_CALLBACK_DATA
*CallbackData
,
1294 IN EFI_HII_HANDLE HiiHandle
,
1295 IN BM_MENU_OPTION
*MenuOption
1299 Get a string from the Data Hub record based on
1302 @param DevPath The device Path.
1304 @return A string located from the Data Hub records based on
1306 @retval NULL If failed to get the String from Data Hub.
1310 EfiLibStrFromDatahub (
1311 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1315 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type
1316 specified by DeviceType.
1318 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,
1320 @param OptionIndex Returns the index number (#### in Boot####).
1321 @param OptionSize Return the size of the Boot### variable.
1325 GetLegacyBootOptionVar (
1326 IN UINTN DeviceType
,
1327 OUT UINTN
*OptionIndex
,
1328 OUT UINTN
*OptionSize
1332 Initialize the Boot Maintenance Utitliy.
1334 @retval EFI_SUCCESS utility ended successfully.
1335 @retval others contain some errors.
1344 Start boot maintenance manager
1346 @retval EFI_SUCCESS If BMM is invoked successfully.
1347 @return Other value if BMM return unsuccessfully.
1356 Intialize all the string depositories.
1360 InitializeStringDepository (
1365 Fetch a usable string node from the string depository and return the string token.
1368 @param CallbackData The BMM context data.
1369 @param StringDepository Pointer of the string depository.
1371 @retval EFI_STRING_ID String token.
1375 GetStringTokenFromDepository (
1376 IN BMM_CALLBACK_DATA
*CallbackData
,
1377 IN STRING_DEPOSITORY
*StringDepository
1381 Reclaim string depositories by moving the current node pointer to list head..
1384 ReclaimStringDepository (
1389 Release resource for all the string depositories.
1393 CleanUpStringDepository (
1398 Function handling request to apply changes for BMM pages.
1400 @param Private Pointer to callback data buffer.
1401 @param CurrentFakeNVMap Pointer to buffer holding data of various values used by BMM
1402 @param FormId ID of the form which has sent the request to apply change.
1404 @retval EFI_SUCCESS Change successfully applied.
1405 @retval Other Error occurs while trying to apply changes.
1409 ApplyChangeHandler (
1410 IN BMM_CALLBACK_DATA
*Private
,
1411 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
,
1412 IN EFI_FORM_ID FormId
1416 Discard all changes done to the BMM pages such as Boot Order change,
1417 Driver order change.
1419 @param Private The BMM context data.
1420 @param CurrentFakeNVMap The current Fack NV Map.
1424 DiscardChangeHandler (
1425 IN BMM_CALLBACK_DATA
*Private
,
1426 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
1430 Dispatch the display to the next page based on NewPageId.
1432 @param Private The BMM context data.
1433 @param NewPageId The original page ID.
1438 BMM_CALLBACK_DATA
*Private
,
1443 Boot a file selected by user at File Expoloer of BMM.
1445 @param FileContext The file context data, which contains the device path
1446 of the file to be boot from.
1448 @retval EFI_SUCCESS The function completed successfull.
1449 @return Other value if the boot from the file fails.
1454 IN BM_FILE_CONTEXT
*FileContext
1458 Update the file explower page with the refershed file system.
1461 @param CallbackData BMM context data
1462 @param KeyValue Key value to identify the type of data to expect.
1464 @retval TRUE Inform the caller to create a callback packet to exit file explorer.
1465 @retval FALSE Indicate that there is no need to exit file explorer.
1469 UpdateFileExplorer (
1470 IN BMM_CALLBACK_DATA
*CallbackData
,
1475 This function processes the results of changes in configuration.
1476 When user select a interactive opcode, this callback will be triggered.
1477 Based on the Question(QuestionId) that triggers the callback, the corresponding
1478 actions is performed. It handles:
1480 1) the addition of boot option.
1481 2) the addition of driver option.
1482 3) exit from file browser
1483 4) update of file content if a dir is selected.
1484 5) boot the file if a file is selected in "boot from file"
1487 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1488 @param Action Specifies the type of action taken by the browser.
1489 @param QuestionId A unique value which is sent to the original exporting driver
1490 so that it can identify the type of data to expect.
1491 @param Type The type of value for the question.
1492 @param Value A pointer to the data being sent to the original exporting driver.
1493 @param ActionRequest On return, points to the action requested by the callback function.
1495 @retval EFI_SUCCESS The callback successfully handled the action.
1496 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1497 @retval EFI_DEVICE_ERROR The variable could not be saved.
1498 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
1503 FileExplorerCallback (
1504 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1505 IN EFI_BROWSER_ACTION Action
,
1506 IN EFI_QUESTION_ID QuestionId
,
1508 IN EFI_IFR_TYPE_VALUE
*Value
,
1509 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1513 Dispatch BMM formset and FileExplorer formset.
1516 @param CallbackData The BMM context data.
1518 @retval EFI_SUCCESS If function complete successfully.
1519 @return Other value if the Setup Browser process BMM's pages and
1520 return unsuccessfully.
1525 IN BMM_CALLBACK_DATA
*CallbackData
1529 Function returns the value of the specified variable.
1531 @param Name A Null-terminated Unicode string that is
1532 the name of the vendor's variable.
1533 @param VendorGuid A unique identifier for the vendor.
1535 @return The payload of the variable.
1536 @retval NULL If the variable can't be read.
1542 IN EFI_GUID
*VendorGuid
1546 // Global variable in this program (defined in data.c)
1548 extern BM_MENU_OPTION BootOptionMenu
;
1549 extern BM_MENU_OPTION DriverOptionMenu
;
1550 extern BM_MENU_OPTION FsOptionMenu
;
1551 extern BM_MENU_OPTION ConsoleInpMenu
;
1552 extern BM_MENU_OPTION ConsoleOutMenu
;
1553 extern BM_MENU_OPTION ConsoleErrMenu
;
1554 extern BM_MENU_OPTION DirectoryMenu
;
1555 extern BM_MENU_OPTION DriverMenu
;
1556 extern BM_MENU_OPTION TerminalMenu
;
1557 extern BM_MENU_OPTION LegacyFDMenu
;
1558 extern BM_MENU_OPTION LegacyHDMenu
;
1559 extern BM_MENU_OPTION LegacyCDMenu
;
1560 extern BM_MENU_OPTION LegacyNETMenu
;
1561 extern BM_MENU_OPTION LegacyBEVMenu
;
1562 extern UINT16 TerminalType
[];
1563 extern COM_ATTR BaudRateList
[19];
1564 extern COM_ATTR DataBitsList
[4];
1565 extern COM_ATTR ParityList
[5];
1566 extern COM_ATTR StopBitsList
[3];
1567 extern EFI_GUID TerminalTypeGuid
[4];
1568 extern STRING_DEPOSITORY
*FileOptionStrDepository
;
1569 extern STRING_DEPOSITORY
*ConsoleOptionStrDepository
;
1570 extern STRING_DEPOSITORY
*BootOptionStrDepository
;
1571 extern STRING_DEPOSITORY
*BootOptionHelpStrDepository
;
1572 extern STRING_DEPOSITORY
*DriverOptionStrDepository
;
1573 extern STRING_DEPOSITORY
*DriverOptionHelpStrDepository
;
1574 extern STRING_DEPOSITORY
*TerminalStrDepository
;
1575 extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath
[];
1576 extern EFI_GUID EfiLegacyDevOrderGuid
;
1579 // Shared IFR form update data
1581 extern VOID
*mStartOpCodeHandle
;
1582 extern VOID
*mEndOpCodeHandle
;
1583 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
1584 extern EFI_IFR_GUID_LABEL
*mEndLabel
;