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
;
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 EFI_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 EFI_SIGNATURE_32 ('m', 'e', 'n', 'u')
148 #define BM_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('l', 'o', 'a', 'd')
149 #define BM_CONSOLE_OPTION_SIGNATURE EFI_SIGNATURE_32 ('c', 'n', 's', 'l')
150 #define BM_FILE_OPTION_SIGNATURE EFI_SIGNATURE_32 ('f', 'i', 'l', 'e')
151 #define BM_HANDLE_OPTION_SIGNATURE EFI_SIGNATURE_32 ('h', 'n', 'd', 'l')
152 #define BM_TERMINAL_OPTION_SIGNATURE EFI_SIGNATURE_32 ('t', 'r', 'm', 'l')
153 #define BM_MENU_ENTRY_SIGNATURE EFI_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().
543 @retval EFI_SUCCESS The function complete successfully.
544 @retval EFI_OUT_OF_RESOURCES No enough memory to complete this function.
548 BOpt_GetLegacyOptions (
553 Free out resouce allocated from Legacy Boot Options.
561 BOpt_FreeLegacyOptions (
566 Free resources allocated in Allocate Rountine.
568 @param FreeMenu Menu to be freed
575 BM_MENU_OPTION
*FreeMenu
581 Append file name to existing file name.
583 @param Str1 The existing file name
584 @param Str2 The file name to be appended
586 @return Allocate a new string to hold the appended result.
587 Caller is responsible to free the returned string.
591 BOpt_AppendFileName (
598 Check whether current FileName point to a valid
601 @param FileName File need to be checked.
603 @retval TRUE Is Efi Image
604 @retval FALSE Not a valid Efi Image
608 BOpt_IsEfiImageName (
614 Check whether current FileName point to a valid Efi Application
616 @param Dir Pointer to current Directory
617 @param FileName Pointer to current File name.
619 @retval TRUE Is a valid Efi Application
620 @retval FALSE not a valid Efi Application
625 IN EFI_FILE_HANDLE Dir
,
631 Get the Option Number that has not been allocated for use.
633 @return The available Option Number.
637 BOpt_GetBootOptionNumber (
643 Get the Option Number that is not in use.
645 @return The unused Option Number.
649 BOpt_GetDriverOptionNumber (
654 Create a menu entry give a Menu type.
656 @param MenuType The Menu type to be created.
659 @retval NULL If failed to create the menu.
664 BOpt_CreateMenuEntry (
669 Free up all resource allocated for a BM_MENU_ENTRY.
671 @param MenuEntry A pointer to BM_MENU_ENTRY.
675 BOpt_DestroyMenuEntry (
676 BM_MENU_ENTRY
*MenuEntry
680 Get the Menu Entry from the list in Menu Entry List.
682 If MenuNumber is great or equal to the number of Menu
683 Entry in the list, then ASSERT.
685 @param MenuOption The Menu Entry List to read the menu entry.
686 @param MenuNumber The index of Menu Entry.
688 @return The Menu Entry.
693 BM_MENU_OPTION
*MenuOption
,
698 // Locate all serial io devices for console
701 Build a list containing all serial devices.
704 @retval EFI_SUCCESS The function complete successfully.
705 @retval EFI_UNSUPPORTED No serial ports present.
714 // Initializing Console menu
717 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
722 @retval EFI_SUCCESS The function always complete successfully.
731 // Get current mode information
734 Get mode number according to column and row
737 @param CallbackData The BMM context data.
744 IN BMM_CALLBACK_DATA
*CallbackData
748 // Cleaning up console menu
751 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
754 EDES_TODO: Add parameter description
756 @retval EFI_SUCCESS The function always complete successfully.
764 Update the device path that describing a terminal device
765 based on the new BaudRate, Data Bits, parity and Stop Bits
774 ChangeVariableDevicePath (
775 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
779 Update the multi-instance device path of Terminal Device based on
780 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal
781 device path in the Terminal Device in TerminalMenu is also updated.
783 @param DevicePath The multi-instance device path.
784 @param ChangeTerminal TRUE, then device path in the Terminal Device
785 in TerminalMenu is also updated; FALSE, no update.
787 @return EFI_SUCCESS The function completes successfully.
791 ChangeTerminalDevicePath (
792 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
793 IN BOOLEAN ChangeTerminal
796 // Variable operation by menu selection
799 This function create a currently loaded Boot Option from
800 the BMM. It then appends this Boot Option to the end of
801 the "BootOrder" list. It also append this Boot Opotion to the end
804 @param CallbackData The BMM context data.
805 @param NvRamMap The file explorer formset internal state.
807 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
808 @retval EFI_SUCCESS If function completes successfully.
812 Var_UpdateBootOption (
813 IN BMM_CALLBACK_DATA
*CallbackData
,
814 IN FILE_EXPLORER_NV_DATA
*NvRamMap
818 Delete Boot Option that represent a Deleted state in BootOptionMenu.
819 After deleting this boot option, call Var_ChangeBootOrder to
820 make sure BootOrder is in valid state.
823 EDES_TODO: Add parameter description
825 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
826 BM_LOAD_CONTEXT marked for deletion is deleted
827 @return Others If failed to update the "BootOrder" variable after deletion.
836 After any operation on Boot####, there will be a discrepancy in BootOrder.
837 Since some are missing but in BootOrder, while some are present but are
838 not reflected by BootOrder. Then a function rebuild BootOrder from
839 scratch by content from BootOptionMenu is needed.
844 @retval EFI_SUCCESS The boot order is updated successfully.
845 @return EFI_STATUS other than EFI_SUCCESS if failed to
846 Set the "BootOrder" EFI Variable.
850 Var_ChangeBootOrder (
855 This function create a currently loaded Drive Option from
856 the BMM. It then appends this Driver Option to the end of
857 the "DriverOrder" list. It append this Driver Opotion to the end
860 @param CallbackData The BMM context data.
861 @param HiiHandle The HII handle associated with the BMM formset.
862 @param DescriptionData The description of this driver option.
863 @param OptionalData The optional load option.
864 @param ForceReconnect EDES_TODO: Add parameter description
866 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
867 @retval EFI_SUCCESS If function completes successfully.
871 Var_UpdateDriverOption (
872 IN BMM_CALLBACK_DATA
*CallbackData
,
873 IN EFI_HII_HANDLE HiiHandle
,
874 IN UINT16
*DescriptionData
,
875 IN UINT16
*OptionalData
,
876 IN UINT8 ForceReconnect
880 Delete Load Option that represent a Deleted state in BootOptionMenu.
881 After deleting this Driver option, call Var_ChangeDriverOrder to
882 make sure DriverOrder is in valid state.
887 @retval EFI_SUCCESS Load Option is successfully updated.
888 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
893 Var_DelDriverOption (
898 After any operation on Driver####, there will be a discrepancy in
899 DriverOrder. Since some are missing but in DriverOrder, while some
900 are present but are not reflected by DriverOrder. Then a function
901 rebuild DriverOrder from scratch by content from DriverOptionMenu is
907 @retval EFI_SUCCESS The driver order is updated successfully.
908 @return EFI_STATUS other than EFI_SUCCESS if failed to
909 Set the "DriverOrder" EFI Variable.
913 Var_ChangeDriverOrder (
918 This function delete and build multi-instance device path ConIn
924 @retval EFI_SUCCESS The function complete successfully.
925 @return The EFI variable can be saved. See gRT->SetVariable
926 for detail return information.
929 Var_UpdateConsoleInpOption (
934 This function delete and build multi-instance device path ConOut
940 @retval EFI_SUCCESS The function complete successfully.
941 @return The EFI variable can be saved. See gRT->SetVariable
942 for detail return information.
945 Var_UpdateConsoleOutOption (
950 This function delete and build multi-instance device path ErrOut
956 @retval EFI_SUCCESS The function complete successfully.
957 @return The EFI variable can be saved. See gRT->SetVariable
958 for detail return information.
961 Var_UpdateErrorOutOption (
966 Update the device path of "ConOut", "ConIn" and "ErrOut"
967 based on the new BaudRate, Data Bits, parity and Stop Bits
976 Var_UpdateAllConsoleOption (
981 This function update the "BootNext" EFI Variable. If there is
982 no "BootNex" specified in BMM, this EFI Variable is deleted.
983 It also update the BMM context data specified the "BootNext"
986 @param CallbackData The BMM context data.
988 @retval EFI_SUCCESS The function complete successfully.
989 @return The EFI variable can be saved. See gRT->SetVariable
990 for detail return information.
995 IN BMM_CALLBACK_DATA
*CallbackData
999 This function update the "BootOrder" EFI Variable based on
1000 BMM Formset's NV map. It then refresh BootOptionMenu
1001 with the new "BootOrder" list.
1003 @param CallbackData The BMM context data.
1005 @retval EFI_SUCCESS The function complete successfully.
1006 @retval EFI_SUCCESS Not enough memory to complete the function.
1007 @return The EFI variable can be saved. See gRT->SetVariable
1008 for detail return information.
1012 Var_UpdateBootOrder (
1013 IN BMM_CALLBACK_DATA
*CallbackData
1017 This function update the "DriverOrder" EFI Variable based on
1018 BMM Formset's NV map. It then refresh DriverOptionMenu
1019 with the new "DriverOrder" list.
1021 @param CallbackData The BMM context data.
1023 @retval EFI_SUCCESS The function complete successfully.
1024 @retval EFI_SUCCESS Not enough memory to complete the function.
1025 @return The EFI variable can be saved. See gRT->SetVariable
1026 for detail return information.
1030 Var_UpdateDriverOrder (
1031 IN BMM_CALLBACK_DATA
*CallbackData
1035 Update the legacy BBS boot option. L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable
1036 is udpated with the new Legacy Boot order. The EFI Variable of "Boot####" and gEfiGlobalVariableGuid
1039 @param CallbackData The context data for BMM.
1041 @return EFI_SUCCESS The function completed successfully.
1042 @retval EFI_NOT_FOUND If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can be found.
1046 Var_UpdateBBSOption (
1047 IN BMM_CALLBACK_DATA
*CallbackData
1051 Update the Text Mode of Console.
1053 @param CallbackData The context data for BMM.
1055 @retval EFI_SUCCSS If the Text Mode of Console is updated.
1056 @return Other value if the Text Mode of Console is not updated.
1061 IN BMM_CALLBACK_DATA
*CallbackData
1065 // Following are page create and refresh functions
1068 Refresh the global UpdateData structure.
1081 Clean up the dynamic opcode at label and form specified by
1084 @param LabelId It is both the Form ID and Label ID for
1086 @param CallbackData The BMM context data.
1094 IN BMM_CALLBACK_DATA
*CallbackData
1098 Create a lit of boot option from global BootOptionMenu. It
1099 allow user to delete the boot option.
1101 @param CallbackData The BMM context data.
1108 IN BMM_CALLBACK_DATA
*CallbackData
1112 Create a lit of driver option from global DriverMenu.
1114 @param CallbackData The BMM context data.
1120 UpdateDrvAddHandlePage (
1121 IN BMM_CALLBACK_DATA
*CallbackData
1125 Create a lit of driver option from global DriverOptionMenu. It
1126 allow user to delete the driver option.
1129 @param CallbackData The BMM context data.
1136 IN BMM_CALLBACK_DATA
*CallbackData
1140 Prepare the page to allow user to add description for
1143 @param CallbackData The BMM context data.
1149 UpdateDriverAddHandleDescPage (
1150 IN BMM_CALLBACK_DATA
*CallbackData
1154 Dispatch the correct update page function to call based on
1157 @param UpdatePageId The form ID.
1158 @param CallbackData The BMM context data.
1165 IN UINT16 UpdatePageId
,
1166 IN BMM_CALLBACK_DATA
*CallbackData
1170 Create the dynamic page to allow user to set
1171 the "BootNext" vaule.
1173 @param CallbackData The BMM context data.
1179 UpdateBootNextPage (
1180 IN BMM_CALLBACK_DATA
*CallbackData
1184 Create the dynamic page to allow user to set
1185 the "TimeOut" vaule.
1187 @param CallbackData The BMM context data.
1194 IN BMM_CALLBACK_DATA
*CallbackData
1198 Create the dynamic page which allows user to
1199 set the property such as Baud Rate, Data Bits,
1200 Parity, Stop Bits, Terminal Type.
1202 @param CallbackData The BMM context data.
1208 UpdateTerminalPage (
1209 IN BMM_CALLBACK_DATA
*CallbackData
1213 Refresh the text mode page
1216 @param CallbackData The BMM context data.
1223 IN BMM_CALLBACK_DATA
*CallbackData
1227 Create a list of Goto Opcode for all terminal devices logged
1228 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.
1230 @param CallbackData The BMM context data.
1237 IN BMM_CALLBACK_DATA
*CallbackData
1241 Create a dynamic page so that Legacy Device boot order
1242 can be set for specified device type.
1244 @param UpdatePageId The form ID. It also spefies the legacy device type.
1245 @param CallbackData The BMM context data.
1251 UpdateSetLegacyDeviceOrderPage (
1252 IN UINT16 UpdatePageId
,
1253 IN BMM_CALLBACK_DATA
*CallbackData
1259 Function opens and returns a file handle to the root directory of a volume.
1262 @param DeviceHandle - A handle for a device
1264 @return A valid file handle or NULL is returned
1269 IN EFI_HANDLE DeviceHandle
1274 Function gets the file system information from an open file descriptor,
1275 and stores it in a buffer allocated from pool.
1278 @param FHand The file handle.
1280 @return A pointer to a buffer with file information.
1281 @retval NULL is returned if failed to get Vaolume Label Info.
1284 EFI_FILE_SYSTEM_VOLUME_LABEL
*
1285 EfiLibFileSystemVolumeLabelInfo (
1286 IN EFI_FILE_HANDLE FHand
1291 Function gets the file information from an open file descriptor, and stores it
1292 in a buffer allocated from pool.
1294 @param FHand File Handle.
1296 @return A pointer to a buffer with file information or NULL is returned
1301 IN EFI_FILE_HANDLE FHand
1305 This function converts an input device structure to a Unicode string.
1307 @param DevPath A pointer to the device path structure.
1309 @return A new allocated Unicode string that represents the device path.
1314 EFI_DEVICE_PATH_PROTOCOL
*DevPath
1319 Find the first instance of this Protocol
1320 in the system and return it's interface.
1323 @param ProtocolGuid Provides the protocol to search for
1324 @param Interface On return, a pointer to the first interface
1325 that matches ProtocolGuid
1327 @retval EFI_SUCCESS A protocol instance matching ProtocolGuid was found
1328 @retval EFI_NOT_FOUND No protocol instances were found that match ProtocolGuid
1332 EfiLibLocateProtocol (
1333 IN EFI_GUID
*ProtocolGuid
,
1334 OUT VOID
**Interface
1338 Adjusts the size of a previously allocated buffer.
1341 @param OldPool - A pointer to the buffer whose size is being adjusted.
1342 @param OldSize - The size of the current buffer.
1343 @param NewSize - The size of the new buffer.
1345 @return The newly allocated buffer.
1346 @retval NULL Allocation failed.
1357 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
1358 buffer, and the size of the buffer. If failure return NULL.
1360 @param Name String part of EFI variable name
1361 @param VendorGuid GUID part of EFI variable name
1362 @param VarSize Returns the size of the EFI variable that was read
1364 @return Dynamically allocated memory that contains a copy of the EFI variable.
1365 @return Caller is responsible freeing the buffer.
1366 @retval NULL Variable was not read
1370 BdsLibGetVariableAndSize (
1372 IN EFI_GUID
*VendorGuid
,
1377 Function deletes the variable specified by VarName and VarGuid.
1380 @param VarName - A Null-terminated Unicode string that is
1381 the name of the vendor's variable.
1383 @param VarGuid - A unique identifier for the vendor.
1385 @retval EFI_SUCCESS The variable was found and removed
1386 @retval EFI_UNSUPPORTED The variable store was inaccessible
1387 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available
1388 @retval EFI_NOT_FOUND The variable was not found
1392 EfiLibDeleteVariable (
1394 IN EFI_GUID
*VarGuid
1400 @param Src The source.
1402 @return A new string which is duplicated copy of the source.
1403 @retval NULL If there is not enough memory.
1412 Function is used to determine the number of device path instances
1413 that exist in a device path.
1416 @param DevicePath A pointer to a device path data structure.
1418 @return This function counts and returns the number of device path instances
1423 EfiDevicePathInstanceCount (
1424 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1428 Create string tokens for a menu from its help strings and display strings
1431 @param CallbackData The BMM context data.
1432 @param HiiHandle Hii Handle of the package to be updated.
1433 @param MenuOption The Menu whose string tokens need to be created
1435 @retval EFI_SUCCESS string tokens created successfully
1436 @retval others contain some errors
1440 CreateMenuStringToken (
1441 IN BMM_CALLBACK_DATA
*CallbackData
,
1442 IN EFI_HII_HANDLE HiiHandle
,
1443 IN BM_MENU_OPTION
*MenuOption
1447 Get a string from the Data Hub record based on
1450 @param DevPath The device Path.
1452 @return A string located from the Data Hub records based on
1454 @retval NULL If failed to get the String from Data Hub.
1458 EfiLibStrFromDatahub (
1459 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1463 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type
1464 specified by DeviceType.
1466 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,
1468 @param OptionIndex Returns the index number (#### in Boot####).
1469 @param OptionSize Return the size of the Boot### variable.
1475 GetLegacyBootOptionVar (
1476 IN UINTN DeviceType
,
1477 OUT UINTN
*OptionIndex
,
1478 OUT UINTN
*OptionSize
1482 Initialize the Boot Maintenance Utitliy.
1484 @retval EFI_SUCCESS utility ended successfully.
1485 @retval others contain some errors.
1494 Start boot maintenance manager
1499 @retval EFI_SUCCESS If BMM is invoked successfully.
1500 @return Other value if BMM return unsuccessfully.
1509 Intialize all the string depositories.
1513 InitializeStringDepository (
1518 Fetch a usable string node from the string depository and return the string token.
1521 @param CallbackData EDES_TODO: Add parameter description
1522 @param StringDepository - Pointer of the string depository.
1524 @retval EFI_STRING_ID String token.
1528 GetStringTokenFromDepository (
1529 IN BMM_CALLBACK_DATA
*CallbackData
,
1530 IN STRING_DEPOSITORY
*StringDepository
1534 Reclaim string depositories by moving the current node pointer to list head..
1537 ReclaimStringDepository (
1542 Release resource for all the string depositories.
1546 CleanUpStringDepository (
1551 Function handling request to apply changes for BMM pages.
1554 @param Private - Pointer to callback data buffer.
1555 @param CurrentFakeNVMap - Pointer to buffer holding data of various values used by BMM
1556 @param FormId - ID of the form which has sent the request to apply change.
1558 @retval EFI_SUCCESS Change successfully applied.
1559 @retval Other Error occurs while trying to apply changes.
1563 ApplyChangeHandler (
1564 IN BMM_CALLBACK_DATA
*Private
,
1565 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
,
1566 IN EFI_FORM_ID FormId
1570 Discard all changes done to the BMM pages such as Boot Order change,
1571 Driver order change.
1573 @param Private The BMM context data.
1574 @param CurrentFakeNVMap The current Fack NV Map.
1578 DiscardChangeHandler (
1579 IN BMM_CALLBACK_DATA
*Private
,
1580 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
1584 Dispatch the display to the next page based on NewPageId.
1586 @param Private The BMM context data.
1587 @param NewPageId The original page ID.
1592 BMM_CALLBACK_DATA
*Private
,
1597 Boot a file selected by user at File Expoloer of BMM.
1599 @param FileContext The file context data, which contains the device path
1600 of the file to be boot from.
1602 @retval EFI_SUCCESS The function completed successfull.
1603 @return Other value if the boot from the file fails.
1608 IN BM_FILE_CONTEXT
*FileContext
1612 Update the file explower page with the refershed file system.
1615 @param CallbackData BMM context data
1616 @param KeyValue Key value to identify the type of data to expect.
1618 @retval TRUE Inform the caller to create a callback packet to exit file explorer.
1619 @retval FALSE Indicate that there is no need to exit file explorer.
1623 UpdateFileExplorer (
1624 IN BMM_CALLBACK_DATA
*CallbackData
,
1629 This function processes the results of changes in configuration.
1630 When user select a interactive opcode, this callback will be triggered.
1631 Based on the Question(QuestionId) that triggers the callback, the corresponding
1632 actions is performed. It handles:
1634 1) the addition of boot option.
1635 2) the addition of driver option.
1636 3) exit from file browser
1637 4) update of file content if a dir is selected.
1638 5) boot the file if a file is selected in "boot from file"
1641 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1642 @param Action Specifies the type of action taken by the browser.
1643 @param QuestionId A unique value which is sent to the original exporting driver
1644 so that it can identify the type of data to expect.
1645 @param Type The type of value for the question.
1646 @param Value A pointer to the data being sent to the original exporting driver.
1647 @param ActionRequest On return, points to the action requested by the callback function.
1649 @retval EFI_SUCCESS The callback successfully handled the action.
1650 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1651 @retval EFI_DEVICE_ERROR The variable could not be saved.
1652 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
1657 FileExplorerCallback (
1658 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1659 IN EFI_BROWSER_ACTION Action
,
1660 IN EFI_QUESTION_ID QuestionId
,
1662 IN EFI_IFR_TYPE_VALUE
*Value
,
1663 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1667 Dispatch BMM formset and FileExplorer formset.
1670 @param CallbackData The BMM context data.
1672 @retval EFI_SUCCESS If function complete successfully.
1673 @return Other value if the Setup Browser process BMM's pages and
1674 return unsuccessfully.
1679 IN BMM_CALLBACK_DATA
*CallbackData
1683 Function returns the value of the specified variable.
1685 @param Name A Null-terminated Unicode string that is
1686 the name of the vendor's variable.
1687 @param VendorGuid A unique identifier for the vendor.
1689 @return The payload of the variable.
1690 @retval NULL If the variable can't be read.
1696 IN EFI_GUID
*VendorGuid
1700 // Global variable in this program (defined in data.c)
1702 extern BM_MENU_OPTION BootOptionMenu
;
1703 extern BM_MENU_OPTION DriverOptionMenu
;
1704 extern BM_MENU_OPTION FsOptionMenu
;
1705 extern BM_MENU_OPTION ConsoleInpMenu
;
1706 extern BM_MENU_OPTION ConsoleOutMenu
;
1707 extern BM_MENU_OPTION ConsoleErrMenu
;
1708 extern BM_MENU_OPTION DirectoryMenu
;
1709 extern BM_MENU_OPTION DriverMenu
;
1710 extern BM_MENU_OPTION TerminalMenu
;
1711 extern BM_MENU_OPTION LegacyFDMenu
;
1712 extern BM_MENU_OPTION LegacyHDMenu
;
1713 extern BM_MENU_OPTION LegacyCDMenu
;
1714 extern BM_MENU_OPTION LegacyNETMenu
;
1715 extern BM_MENU_OPTION LegacyBEVMenu
;
1716 extern UINT16 TerminalType
[];
1717 extern COM_ATTR BaudRateList
[19];
1718 extern COM_ATTR DataBitsList
[4];
1719 extern COM_ATTR ParityList
[5];
1720 extern COM_ATTR StopBitsList
[3];
1721 extern EFI_GUID TerminalTypeGuid
[4];
1722 extern EFI_HII_UPDATE_DATA gUpdateData
;
1723 extern STRING_DEPOSITORY
*FileOptionStrDepository
;
1724 extern STRING_DEPOSITORY
*ConsoleOptionStrDepository
;
1725 extern STRING_DEPOSITORY
*BootOptionStrDepository
;
1726 extern STRING_DEPOSITORY
*BootOptionHelpStrDepository
;
1727 extern STRING_DEPOSITORY
*DriverOptionStrDepository
;
1728 extern STRING_DEPOSITORY
*DriverOptionHelpStrDepository
;
1729 extern STRING_DEPOSITORY
*TerminalStrDepository
;
1730 extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath
[];
1731 extern EFI_GUID EfiLegacyDevOrderGuid
;