2 Header file for boot maintenance module.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 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_
20 #include <Guid/TtyTerm.h>
21 #include <Guid/MdeModuleHii.h>
22 #include <Guid/FileSystemVolumeLabelInfo.h>
23 #include <Guid/GlobalVariable.h>
24 #include <Guid/HiiBootMaintenanceFormset.h>
26 #include <Protocol/LoadFile.h>
27 #include <Protocol/HiiConfigAccess.h>
28 #include <Protocol/SimpleFileSystem.h>
29 #include <Protocol/SerialIo.h>
30 #include <Protocol/DevicePathToText.h>
32 #include <Library/PrintLib.h>
33 #include <Library/DebugLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/UefiBootServicesTableLib.h>
36 #include <Library/UefiLib.h>
37 #include <Library/MemoryAllocationLib.h>
38 #include <Library/UefiRuntimeServicesTableLib.h>
39 #include <Library/DevicePathLib.h>
40 #include <Library/HiiLib.h>
41 #include <Library/UefiHiiServicesLib.h>
42 #include <Library/UefiBootManagerLib.h>
43 #include <Library/FileExplorerLib.h>
44 #include "BootMaintenanceManagerCustomizedUi.h"
49 /// HII specific Vendor Device Path definition.
52 VENDOR_DEVICE_PATH VendorDevicePath
;
53 EFI_DEVICE_PATH_PROTOCOL End
;
54 } HII_VENDOR_DEVICE_PATH
;
58 // Constants which are variable names used to access variables
61 #define VAR_CON_OUT_MODE L"ConOutMode"
64 // Variable created with this flag will be "Efi:...."
66 #define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
68 extern EFI_GUID mBootMaintGuid
;
69 extern CHAR16 mBootMaintStorageName
[];
71 // These are the VFR compiler generated data representing our VFR data.
73 extern UINT8 BootMaintenanceManagerBin
[];
76 // Below are the number of options in Baudrate, Databits,
77 // Parity and Stopbits selection for serial ports.
79 #define BM_COM_ATTR_BUADRATE 19
80 #define BM_COM_ATTR_DATABITS 4
81 #define BM_COM_ATTR_PARITY 5
82 #define BM_COM_ATTR_STOPBITS 3
85 // Callback function helper
87 #define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')
88 #define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
91 // Enumeration type definition
93 typedef UINT8 BBS_TYPE
;
95 typedef enum _TYPE_OF_TERMINAL
{
96 TerminalTypePcAnsi
= 0,
98 TerminalTypeVt100Plus
,
104 // All of the signatures that will be used in list structure
106 #define BM_MENU_OPTION_SIGNATURE SIGNATURE_32 ('m', 'e', 'n', 'u')
107 #define BM_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('l', 'o', 'a', 'd')
108 #define BM_CONSOLE_OPTION_SIGNATURE SIGNATURE_32 ('c', 'n', 's', 'l')
109 #define BM_FILE_OPTION_SIGNATURE SIGNATURE_32 ('f', 'i', 'l', 'e')
110 #define BM_HANDLE_OPTION_SIGNATURE SIGNATURE_32 ('h', 'n', 'd', 'l')
111 #define BM_TERMINAL_OPTION_SIGNATURE SIGNATURE_32 ('t', 'r', 'm', 'l')
112 #define BM_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('e', 'n', 't', 'r')
114 #define BM_LOAD_CONTEXT_SELECT 0x0
115 #define BM_CONSOLE_CONTEXT_SELECT 0x1
116 #define BM_FILE_CONTEXT_SELECT 0x2
117 #define BM_HANDLE_CONTEXT_SELECT 0x3
118 #define BM_TERMINAL_CONTEXT_SELECT 0x5
120 #define BM_CONSOLE_IN_CONTEXT_SELECT 0x6
121 #define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7
122 #define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8
125 // Buffer size for update data
127 #define UPDATE_DATA_SIZE 0x100000
130 // Namespace of callback keys used in display and file system navigation
132 #define MAX_BBS_OFFSET 0xE000
133 #define NET_OPTION_OFFSET 0xD800
134 #define BEV_OPTION_OFFSET 0xD000
135 #define FD_OPTION_OFFSET 0xC000
136 #define HD_OPTION_OFFSET 0xB000
137 #define CD_OPTION_OFFSET 0xA000
138 #define FILE_OPTION_OFFSET 0x8000
139 #define FILE_OPTION_MASK 0x7FFF
140 #define HANDLE_OPTION_OFFSET 0x7000
141 #define CONSOLE_OPTION_OFFSET 0x6000
142 #define TERMINAL_OPTION_OFFSET 0x5000
143 #define CONFIG_OPTION_OFFSET 0x1200
144 #define KEY_VALUE_OFFSET 0x1100
145 #define FORM_ID_OFFSET 0x1000
148 // VarOffset that will be used to create question
149 // all these values are computed from the structure
152 #define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))
155 // Question Id of Zero is invalid, so add an offset to it
157 #define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)
159 #define BOOT_TIME_OUT_VAR_OFFSET VAR_OFFSET (BootTimeOut)
160 #define BOOT_NEXT_VAR_OFFSET VAR_OFFSET (BootNext)
161 #define COM1_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM1BaudRate)
162 #define COM1_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM1DataRate)
163 #define COM1_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM1StopBits)
164 #define COM1_PARITY_VAR_OFFSET VAR_OFFSET (COM1Parity)
165 #define COM1_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
166 #define COM2_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM2BaudRate)
167 #define COM2_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM2DataRate)
168 #define COM2_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM2StopBits)
169 #define COM2_PARITY_VAR_OFFSET VAR_OFFSET (COM2Parity)
170 #define COM2_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
171 #define DRV_ADD_HANDLE_DESC_VAR_OFFSET VAR_OFFSET (DriverAddHandleDesc)
172 #define DRV_ADD_ACTIVE_VAR_OFFSET VAR_OFFSET (DriverAddActive)
173 #define DRV_ADD_RECON_VAR_OFFSET VAR_OFFSET (DriverAddForceReconnect)
174 #define CON_IN_COM1_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM1)
175 #define CON_IN_COM2_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM2)
176 #define CON_OUT_COM1_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM1)
177 #define CON_OUT_COM2_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM2)
178 #define CON_ERR_COM1_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM1)
179 #define CON_ERR_COM2_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM2)
180 #define CON_MODE_VAR_OFFSET VAR_OFFSET (ConsoleOutMode)
181 #define CON_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleCheck)
182 #define CON_IN_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleInCheck)
183 #define CON_OUT_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleOutCheck)
184 #define CON_ERR_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleErrCheck)
185 #define BOOT_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (BootOptionOrder)
186 #define DRIVER_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (DriverOptionOrder)
187 #define BOOT_OPTION_DEL_VAR_OFFSET VAR_OFFSET (BootOptionDel)
188 #define DRIVER_OPTION_DEL_VAR_OFFSET VAR_OFFSET (DriverOptionDel)
189 #define DRIVER_ADD_OPTION_VAR_OFFSET VAR_OFFSET (DriverAddHandleOptionalData)
190 #define COM_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COMBaudRate)
191 #define COM_DATA_RATE_VAR_OFFSET VAR_OFFSET (COMDataRate)
192 #define COM_STOP_BITS_VAR_OFFSET VAR_OFFSET (COMStopBits)
193 #define COM_PARITY_VAR_OFFSET VAR_OFFSET (COMParity)
194 #define COM_TERMINAL_VAR_OFFSET VAR_OFFSET (COMTerminalType)
195 #define COM_FLOWCONTROL_VAR_OFFSET VAR_OFFSET (COMFlowControl)
197 #define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)
198 #define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)
199 #define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)
200 #define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)
201 #define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)
202 #define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)
203 #define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
204 #define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)
205 #define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)
206 #define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)
207 #define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)
208 #define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
209 #define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)
210 #define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)
211 #define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)
212 #define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)
213 #define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)
214 #define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)
215 #define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)
216 #define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)
217 #define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)
218 #define CON_MODE_QUESTION_ID QUESTION_ID (ConsoleOutMode)
219 #define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)
220 #define CON_IN_DEVICE_QUESTION_ID QUESTION_ID (ConsoleInCheck)
221 #define CON_OUT_DEVICE_QUESTION_ID QUESTION_ID (ConsoleOutCheck)
222 #define CON_ERR_DEVICE_QUESTION_ID QUESTION_ID (ConsoleErrCheck)
223 #define BOOT_OPTION_ORDER_QUESTION_ID QUESTION_ID (BootOptionOrder)
224 #define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionOrder)
225 #define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)
226 #define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)
227 #define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)
228 #define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)
229 #define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)
230 #define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)
231 #define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)
232 #define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)
233 #define COM_FLOWCONTROL_QUESTION_ID QUESTION_ID (COMFlowControl)
235 #define STRING_DEPOSITORY_NUMBER 8
237 #define NONE_BOOTNEXT_VALUE (0xFFFF + 1)
240 /// Serial Ports attributes, first one is the value for
241 /// return from callback function, stringtoken is used to
242 /// display the value properly
267 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
268 } BM_TERMINAL_CONTEXT
;
277 UINT16 FilePathListLength
;
279 EFI_DEVICE_PATH_PROTOCOL
*FilePathList
;
289 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
290 } BM_CONSOLE_CONTEXT
;
299 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
300 EFI_FILE_HANDLE FHandle
;
302 EFI_FILE_SYSTEM_VOLUME_LABEL
*Info
;
306 BOOLEAN IsRemovableMedia
;
308 BOOLEAN IsBootLegacy
;
313 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
326 UINT16
*DisplayString
;
328 EFI_STRING_ID DisplayStringToken
;
329 EFI_STRING_ID HelpStringToken
;
330 UINTN ContextSelection
;
331 VOID
*VariableContext
;
338 EFI_HII_HANDLE BmmHiiHandle
;
339 EFI_HANDLE BmmDriverHandle
;
341 /// Boot Maintenance Manager Produced protocols
343 EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess
;
344 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
346 BM_MENU_ENTRY
*MenuEntry
;
347 BM_HANDLE_CONTEXT
*HandleContext
;
348 BM_FILE_CONTEXT
*FileContext
;
349 BM_LOAD_CONTEXT
*LoadContext
;
350 BM_TERMINAL_CONTEXT
*TerminalContext
;
351 UINTN CurrentTerminal
;
355 // BMM main formset callback data.
358 EFI_FORM_ID BmmCurrentPageId
;
359 EFI_FORM_ID BmmPreviousPageId
;
360 BOOLEAN BmmAskSaveOrNot
;
361 BMM_FAKE_NV_DATA BmmFakeNvData
;
362 BMM_FAKE_NV_DATA BmmOldFakeNVData
;
368 Find drivers that will be added as Driver#### variables from handles
369 in current system environment
370 All valid handles in the system except those consume SimpleFs, LoadFile
371 are stored in DriverMenu for future use.
373 @retval EFI_SUCCESS The function complets successfully.
374 @return Other value if failed to build the DriverMenu.
384 Build the BootOptionMenu according to BootOrder Variable.
385 This Routine will access the Boot#### to get EFI_LOAD_OPTION.
387 @param CallbackData The BMM context data.
389 @return The number of the Var Boot####.
393 BOpt_GetBootOptions (
394 IN BMM_CALLBACK_DATA
*CallbackData
399 Build up all DriverOptionMenu
401 @param CallbackData The BMM context data.
403 @return EFI_SUCESS The functin completes successfully.
404 @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.
409 BOpt_GetDriverOptions (
410 IN BMM_CALLBACK_DATA
*CallbackData
414 Free resources allocated in Allocate Rountine.
416 @param FreeMenu Menu to be freed
421 BM_MENU_OPTION
*FreeMenu
426 Get the Option Number that has not been allocated for use.
428 @param Type The type of Option.
430 @return The available Option Number.
434 BOpt_GetOptionNumber (
440 Get the Option Number for Boot#### that does not used.
442 @return The available Option Number.
446 BOpt_GetBootOptionNumber (
452 Get the Option Number for Driver#### that does not used.
454 @return The unused Option Number.
458 BOpt_GetDriverOptionNumber (
463 Create a menu entry give a Menu type.
465 @param MenuType The Menu type to be created.
468 @retval NULL If failed to create the menu.
473 BOpt_CreateMenuEntry (
478 Free up all resource allocated for a BM_MENU_ENTRY.
480 @param MenuEntry A pointer to BM_MENU_ENTRY.
484 BOpt_DestroyMenuEntry (
485 BM_MENU_ENTRY
*MenuEntry
489 Get the Menu Entry from the list in Menu Entry List.
491 If MenuNumber is great or equal to the number of Menu
492 Entry in the list, then ASSERT.
494 @param MenuOption The Menu Entry List to read the menu entry.
495 @param MenuNumber The index of Menu Entry.
497 @return The Menu Entry.
502 BM_MENU_OPTION
*MenuOption
,
507 Get option number according to Boot#### and BootOrder variable.
508 The value is saved as #### + 1.
510 @param CallbackData The BMM context data.
514 IN BMM_CALLBACK_DATA
*CallbackData
518 Get driver option order from globalc DriverOptionMenu.
520 @param CallbackData The BMM context data.
525 IN BMM_CALLBACK_DATA
*CallbackData
529 // Locate all serial io devices for console
532 Build a list containing all serial devices.
534 @retval EFI_SUCCESS The function complete successfully.
535 @retval EFI_UNSUPPORTED No serial ports present.
544 // Initializing Console menu
547 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
549 @retval EFI_SUCCESS The function always complete successfully.
558 // Get current mode information
561 Get mode number according to column and row
563 @param CallbackData The BMM context data.
567 IN BMM_CALLBACK_DATA
*CallbackData
571 // Cleaning up console menu
574 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
576 @retval EFI_SUCCESS The function always complete successfully.
584 Update the device path that describing a terminal device
585 based on the new BaudRate, Data Bits, parity and Stop Bits
588 @param DevicePath The devicepath protocol instance wanted to be updated.
592 ChangeVariableDevicePath (
593 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
597 Update the multi-instance device path of Terminal Device based on
598 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal
599 device path in the Terminal Device in TerminalMenu is also updated.
601 @param DevicePath The multi-instance device path.
602 @param ChangeTerminal TRUE, then device path in the Terminal Device
603 in TerminalMenu is also updated; FALSE, no update.
605 @return EFI_SUCCESS The function completes successfully.
609 ChangeTerminalDevicePath (
610 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
611 IN BOOLEAN ChangeTerminal
615 // Variable operation by menu selection
618 This function create a currently loaded Boot Option from
619 the BMM. It then appends this Boot Option to the end of
620 the "BootOrder" list. It also append this Boot Opotion to the end
623 @param CallbackData The BMM context data.
625 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
626 @retval EFI_SUCCESS If function completes successfully.
630 Var_UpdateBootOption (
631 IN BMM_CALLBACK_DATA
*CallbackData
635 Delete Boot Option that represent a Deleted state in BootOptionMenu.
636 After deleting this boot option, call Var_ChangeBootOrder to
637 make sure BootOrder is in valid state.
639 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
640 BM_LOAD_CONTEXT marked for deletion is deleted
641 @return Others If failed to update the "BootOrder" variable after deletion.
650 After any operation on Boot####, there will be a discrepancy in BootOrder.
651 Since some are missing but in BootOrder, while some are present but are
652 not reflected by BootOrder. Then a function rebuild BootOrder from
653 scratch by content from BootOptionMenu is needed.
655 @retval EFI_SUCCESS The boot order is updated successfully.
656 @return other than EFI_SUCCESS if failed to change the "BootOrder" EFI Variable.
660 Var_ChangeBootOrder (
665 This function create a currently loaded Drive Option from
666 the BMM. It then appends this Driver Option to the end of
667 the "DriverOrder" list. It append this Driver Opotion to the end
670 @param CallbackData The BMM context data.
671 @param HiiHandle The HII handle associated with the BMM formset.
672 @param DescriptionData The description of this driver option.
673 @param OptionalData The optional load option.
674 @param ForceReconnect If to force reconnect.
676 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
677 @retval EFI_SUCCESS If function completes successfully.
681 Var_UpdateDriverOption (
682 IN BMM_CALLBACK_DATA
*CallbackData
,
683 IN EFI_HII_HANDLE HiiHandle
,
684 IN UINT16
*DescriptionData
,
685 IN UINT16
*OptionalData
,
686 IN UINT8 ForceReconnect
690 Delete Load Option that represent a Deleted state in BootOptionMenu.
691 After deleting this Driver option, call Var_ChangeDriverOrder to
692 make sure DriverOrder is in valid state.
694 @retval EFI_SUCCESS Load Option is successfully updated.
695 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
700 Var_DelDriverOption (
705 After any operation on Driver####, there will be a discrepancy in
706 DriverOrder. Since some are missing but in DriverOrder, while some
707 are present but are not reflected by DriverOrder. Then a function
708 rebuild DriverOrder from scratch by content from DriverOptionMenu is
711 @retval EFI_SUCCESS The driver order is updated successfully.
712 @return other than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
716 Var_ChangeDriverOrder (
721 This function delete and build multi-instance device path ConIn
724 @retval EFI_SUCCESS The function complete successfully.
725 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
728 Var_UpdateConsoleInpOption (
733 This function delete and build multi-instance device path ConOut console device.
735 @retval EFI_SUCCESS The function complete successfully.
736 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
739 Var_UpdateConsoleOutOption (
744 This function delete and build multi-instance device path ErrOut console device.
746 @retval EFI_SUCCESS The function complete successfully.
747 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
750 Var_UpdateErrorOutOption (
755 This function delete and build Out of Band console device.
757 @param MenuIndex Menu index which user select in the terminal menu list.
759 @retval EFI_SUCCESS The function complete successfully.
760 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
763 Var_UpdateOutOfBandOption (
768 This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM,
769 this EFI Variable is deleted.
770 It also update the BMM context data specified the "BootNext" value.
772 @param CallbackData The BMM context data.
774 @retval EFI_SUCCESS The function complete successfully.
775 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
780 IN BMM_CALLBACK_DATA
*CallbackData
784 This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh
785 BootOptionMenu with the new "BootOrder" list.
787 @param CallbackData The BMM context data.
789 @retval EFI_SUCCESS The function complete successfully.
790 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
791 @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.
795 Var_UpdateBootOrder (
796 IN BMM_CALLBACK_DATA
*CallbackData
800 This function update the "DriverOrder" EFI Variable based on
801 BMM Formset's NV map. It then refresh DriverOptionMenu
802 with the new "DriverOrder" list.
804 @param CallbackData The BMM context data.
806 @retval EFI_SUCCESS The function complete successfully.
807 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
808 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
812 Var_UpdateDriverOrder (
813 IN BMM_CALLBACK_DATA
*CallbackData
817 Update the Text Mode of Console.
819 @param CallbackData The context data for BMM.
821 @retval EFI_SUCCSS If the Text Mode of Console is updated.
822 @return Other value if the Text Mode of Console is not updated.
827 IN BMM_CALLBACK_DATA
*CallbackData
831 // Following are page create and refresh functions
834 Create the global UpdateData structure.
843 Refresh the global UpdateData structure.
852 Clean up the dynamic opcode at label and form specified by
855 @param LabelId It is both the Form ID and Label ID for
857 @param CallbackData The BMM context data.
863 IN BMM_CALLBACK_DATA
*CallbackData
867 Create a lit of boot option from global BootOptionMenu. It
868 allow user to delete the boot option.
870 @param CallbackData The BMM context data.
875 IN BMM_CALLBACK_DATA
*CallbackData
879 Create a lit of driver option from global DriverMenu.
881 @param CallbackData The BMM context data.
884 UpdateDrvAddHandlePage (
885 IN BMM_CALLBACK_DATA
*CallbackData
889 Create a lit of driver option from global DriverOptionMenu. It
890 allow user to delete the driver option.
892 @param CallbackData The BMM context data.
896 IN BMM_CALLBACK_DATA
*CallbackData
900 Prepare the page to allow user to add description for a Driver Option.
902 @param CallbackData The BMM context data.
905 UpdateDriverAddHandleDescPage (
906 IN BMM_CALLBACK_DATA
*CallbackData
910 Dispatch the correct update page function to call based on the UpdatePageId.
912 @param UpdatePageId The form ID.
913 @param CallbackData The BMM context data.
917 IN UINT16 UpdatePageId
,
918 IN BMM_CALLBACK_DATA
*CallbackData
922 Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,
923 Parity, Stop Bits, Terminal Type.
925 @param CallbackData The BMM context data.
929 IN BMM_CALLBACK_DATA
*CallbackData
933 Refresh the text mode page
935 @param CallbackData The BMM context data.
939 IN BMM_CALLBACK_DATA
*CallbackData
943 Create a list of Goto Opcode for all terminal devices logged
944 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.
946 @param CallbackData The BMM context data.
950 IN BMM_CALLBACK_DATA
*CallbackData
954 Update add boot/driver option page.
956 @param CallbackData The BMM context data.
957 @param FormId The form ID to be updated.
958 @param DevicePath Device path.
963 IN BMM_CALLBACK_DATA
*CallbackData
,
964 IN EFI_FORM_ID FormId
,
965 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
969 Function deletes the variable specified by VarName and VarGuid.
972 @param VarName A Null-terminated Unicode string that is
973 the name of the vendor's variable.
975 @param VarGuid A unique identifier for the vendor.
977 @retval EFI_SUCCESS The variable was found and removed
978 @retval EFI_UNSUPPORTED The variable store was inaccessible
979 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available
980 @retval EFI_NOT_FOUND The variable was not found
984 EfiLibDeleteVariable (
990 Function is used to determine the number of device path instances
991 that exist in a device path.
994 @param DevicePath A pointer to a device path data structure.
996 @return This function counts and returns the number of device path instances
1001 EfiDevicePathInstanceCount (
1002 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1006 Get a string from the Data Hub record based on
1009 @param DevPath The device Path.
1011 @return A string located from the Data Hub records based on
1013 @retval NULL If failed to get the String from Data Hub.
1017 EfiLibStrFromDatahub (
1018 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1022 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type
1023 specified by DeviceType.
1025 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,
1027 @param OptionIndex Returns the index number (#### in Boot####).
1028 @param OptionSize Return the size of the Boot### variable.
1032 GetLegacyBootOptionVar (
1033 IN UINTN DeviceType
,
1034 OUT UINTN
*OptionIndex
,
1035 OUT UINTN
*OptionSize
1039 Discard all changes done to the BMM pages such as Boot Order change,
1040 Driver order change.
1042 @param Private The BMM context data.
1043 @param CurrentFakeNVMap The current Fack NV Map.
1047 DiscardChangeHandler (
1048 IN BMM_CALLBACK_DATA
*Private
,
1049 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
1053 Dispatch the display to the next page based on NewPageId.
1055 @param Private The BMM context data.
1056 @param NewPageId The original page ID.
1061 BMM_CALLBACK_DATA
*Private
,
1066 Remove the installed BootMaint and FileExplorer HiiPackages.
1075 Install BootMaint and FileExplorer HiiPackages.
1079 InitBootMaintenance(
1085 Initialize console input device check box to ConsoleInCheck[MAX_MENU_NUMBER]
1086 in BMM_FAKE_NV_DATA structure.
1088 @param CallbackData The BMM context data.
1093 IN BMM_CALLBACK_DATA
*CallbackData
1098 Initialize console output device check box to ConsoleOutCheck[MAX_MENU_NUMBER]
1099 in BMM_FAKE_NV_DATA structure.
1101 @param CallbackData The BMM context data.
1105 GetConsoleOutCheck (
1106 IN BMM_CALLBACK_DATA
*CallbackData
1111 Initialize standard error output device check box to ConsoleErrCheck[MAX_MENU_NUMBER]
1112 in BMM_FAKE_NV_DATA structure.
1114 @param CallbackData The BMM context data.
1118 GetConsoleErrCheck (
1119 IN BMM_CALLBACK_DATA
*CallbackData
1124 Initialize terminal attributes (baudrate, data rate, stop bits, parity and terminal type)
1125 to BMM_FAKE_NV_DATA structure.
1127 @param CallbackData The BMM context data.
1131 GetTerminalAttribute (
1132 IN BMM_CALLBACK_DATA
*CallbackData
1136 This function will change video resolution and text mode
1137 according to defined setup mode or defined boot mode
1139 @param IsSetupMode Indicate mode is changed to setup mode or boot mode.
1141 @retval EFI_SUCCESS Mode is changed successfully.
1142 @retval Others Mode failed to be changed.
1147 BmmBdsSetConsoleMode (
1153 This function converts an input device structure to a Unicode string.
1155 @param DevPath A pointer to the device path structure.
1157 @return A new allocated Unicode string that represents the device path.
1162 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1166 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.
1167 The caller is responsible for freeing the allocated buffer using FreePool().
1169 @param DevicePath Device path.
1171 @return A new allocated string that represents the file name.
1175 ExtractFileNameFromDevicePath (
1176 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1180 This function allows a caller to extract the current configuration for one
1181 or more named elements from the target driver.
1183 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1184 @param Request A null-terminated Unicode string in <ConfigRequest> format.
1185 @param Progress On return, points to a character in the Request string.
1186 Points to the string's null terminator if request was successful.
1187 Points to the most recent '&' before the first failing name/value
1188 pair (or the beginning of the string if the failure is in the
1189 first name/value pair) if the request was not successful.
1190 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
1191 has all values filled in for the names in the Request string.
1192 String to be allocated by the called function.
1194 @retval EFI_SUCCESS The Results is filled with the requested values.
1195 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
1196 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
1197 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
1202 BootMaintExtractConfig (
1203 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1204 IN CONST EFI_STRING Request
,
1205 OUT EFI_STRING
*Progress
,
1206 OUT EFI_STRING
*Results
1210 This function applies changes in a driver's configuration.
1211 Input is a Configuration, which has the routing data for this
1212 driver followed by name / value configuration pairs. The driver
1213 must apply those pairs to its configurable storage. If the
1214 driver's configuration is stored in a linear block of data
1215 and the driver's name / value pairs are in <BlockConfig>
1216 format, it may use the ConfigToBlock helper function (above) to
1217 simplify the job. Currently not implemented.
1219 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1220 @param[in] Configuration A null-terminated Unicode string in
1221 <ConfigString> format.
1222 @param[out] Progress A pointer to a string filled in with the
1223 offset of the most recent '&' before the
1224 first failing name / value pair (or the
1225 beginn ing of the string if the failure
1226 is in the first name / value pair) or
1227 the terminating NULL if all was
1230 @retval EFI_SUCCESS The results have been distributed or are
1231 awaiting distribution.
1232 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1233 parts of the results that must be
1234 stored awaiting possible future
1236 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
1237 Results parameter would result
1238 in this type of error.
1239 @retval EFI_NOT_FOUND Target for the specified routing data
1244 BootMaintRouteConfig (
1245 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1246 IN CONST EFI_STRING Configuration
,
1247 OUT EFI_STRING
*Progress
1251 This function processes the results of changes in configuration.
1254 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1255 @param Action Specifies the type of action taken by the browser.
1256 @param QuestionId A unique value which is sent to the original exporting driver
1257 so that it can identify the type of data to expect.
1258 @param Type The type of value for the question.
1259 @param Value A pointer to the data being sent to the original exporting driver.
1260 @param ActionRequest On return, points to the action requested by the callback function.
1262 @retval EFI_SUCCESS The callback successfully handled the action.
1263 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1264 @retval EFI_DEVICE_ERROR The variable could not be saved.
1265 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
1266 @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.
1271 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1272 IN EFI_BROWSER_ACTION Action
,
1273 IN EFI_QUESTION_ID QuestionId
,
1275 IN EFI_IFR_TYPE_VALUE
*Value
,
1276 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1280 Create boot option base on the input file path info.
1282 @param FilePath Point to the file path.
1284 @retval TRUE Exit caller function.
1285 @retval FALSE Not exit caller function.
1290 CreateBootOptionFromFile (
1291 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1295 Create driver option base on the input file path info.
1297 @param FilePath Point to the file path.
1299 @retval TRUE Exit caller function.
1300 @retval FALSE Not exit caller function.
1304 CreateDriverOptionFromFile (
1305 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1309 Boot the file specified by the input file path info.
1311 @param FilePath Point to the file path.
1313 @retval TRUE Exit caller function.
1314 @retval FALSE Not exit caller function.
1320 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1324 // Global variable in this program (defined in data.c)
1326 extern BM_MENU_OPTION BootOptionMenu
;
1327 extern BM_MENU_OPTION DriverOptionMenu
;
1328 extern BM_MENU_OPTION ConsoleInpMenu
;
1329 extern BM_MENU_OPTION ConsoleOutMenu
;
1330 extern BM_MENU_OPTION ConsoleErrMenu
;
1331 extern BM_MENU_OPTION DriverMenu
;
1332 extern BM_MENU_OPTION TerminalMenu
;
1333 extern UINT16 TerminalType
[5];
1334 extern COM_ATTR BaudRateList
[19];
1335 extern COM_ATTR DataBitsList
[4];
1336 extern COM_ATTR ParityList
[5];
1337 extern COM_ATTR StopBitsList
[3];
1338 extern EFI_GUID TerminalTypeGuid
[5];
1339 extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath
[];
1340 extern UINT16 mFlowControlType
[2];
1341 extern UINT32 mFlowControlValue
[2];
1344 // Shared IFR form update data
1346 extern VOID
*mStartOpCodeHandle
;
1347 extern VOID
*mEndOpCodeHandle
;
1348 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
1349 extern EFI_IFR_GUID_LABEL
*mEndLabel
;
1350 extern BMM_CALLBACK_DATA gBootMaintenancePrivate
;
1351 extern BMM_CALLBACK_DATA
*mBmmCallbackInfo
;