2 Header file for boot maintenance module.
4 Copyright (c) 2004 - 2015, 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>
48 /// HII specific Vendor Device Path definition.
51 VENDOR_DEVICE_PATH VendorDevicePath
;
52 EFI_DEVICE_PATH_PROTOCOL End
;
53 } HII_VENDOR_DEVICE_PATH
;
57 // Constants which are variable names used to access variables
60 #define VAR_CON_OUT_MODE L"ConOutMode"
63 // Variable created with this flag will be "Efi:...."
65 #define VAR_FLAG EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE
67 extern EFI_GUID mBootMaintGuid
;
68 extern CHAR16 mBootMaintStorageName
[];
70 // These are the VFR compiler generated data representing our VFR data.
72 extern UINT8 BootMaintenanceManagerBin
[];
75 // Below are the number of options in Baudrate, Databits,
76 // Parity and Stopbits selection for serial ports.
78 #define BM_COM_ATTR_BUADRATE 19
79 #define BM_COM_ATTR_DATABITS 4
80 #define BM_COM_ATTR_PARITY 5
81 #define BM_COM_ATTR_STOPBITS 3
84 // Callback function helper
86 #define BMM_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('C', 'b', 'c', 'k')
87 #define BMM_CALLBACK_DATA_FROM_THIS(a) CR (a, BMM_CALLBACK_DATA, BmmConfigAccess, BMM_CALLBACK_DATA_SIGNATURE)
90 // Enumeration type definition
92 typedef UINT8 BBS_TYPE
;
94 typedef enum _TYPE_OF_TERMINAL
{
95 TerminalTypePcAnsi
= 0,
97 TerminalTypeVt100Plus
,
103 // All of the signatures that will be used in list structure
105 #define BM_MENU_OPTION_SIGNATURE SIGNATURE_32 ('m', 'e', 'n', 'u')
106 #define BM_LOAD_OPTION_SIGNATURE SIGNATURE_32 ('l', 'o', 'a', 'd')
107 #define BM_CONSOLE_OPTION_SIGNATURE SIGNATURE_32 ('c', 'n', 's', 'l')
108 #define BM_FILE_OPTION_SIGNATURE SIGNATURE_32 ('f', 'i', 'l', 'e')
109 #define BM_HANDLE_OPTION_SIGNATURE SIGNATURE_32 ('h', 'n', 'd', 'l')
110 #define BM_TERMINAL_OPTION_SIGNATURE SIGNATURE_32 ('t', 'r', 'm', 'l')
111 #define BM_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('e', 'n', 't', 'r')
113 #define BM_LOAD_CONTEXT_SELECT 0x0
114 #define BM_CONSOLE_CONTEXT_SELECT 0x1
115 #define BM_FILE_CONTEXT_SELECT 0x2
116 #define BM_HANDLE_CONTEXT_SELECT 0x3
117 #define BM_TERMINAL_CONTEXT_SELECT 0x5
119 #define BM_CONSOLE_IN_CONTEXT_SELECT 0x6
120 #define BM_CONSOLE_OUT_CONTEXT_SELECT 0x7
121 #define BM_CONSOLE_ERR_CONTEXT_SELECT 0x8
124 // Buffer size for update data
126 #define UPDATE_DATA_SIZE 0x100000
129 // Namespace of callback keys used in display and file system navigation
131 #define MAX_BBS_OFFSET 0xE000
132 #define NET_OPTION_OFFSET 0xD800
133 #define BEV_OPTION_OFFSET 0xD000
134 #define FD_OPTION_OFFSET 0xC000
135 #define HD_OPTION_OFFSET 0xB000
136 #define CD_OPTION_OFFSET 0xA000
137 #define FILE_OPTION_OFFSET 0x8000
138 #define FILE_OPTION_MASK 0x7FFF
139 #define HANDLE_OPTION_OFFSET 0x7000
140 #define CONSOLE_OPTION_OFFSET 0x6000
141 #define TERMINAL_OPTION_OFFSET 0x5000
142 #define CONFIG_OPTION_OFFSET 0x1200
143 #define KEY_VALUE_OFFSET 0x1100
144 #define FORM_ID_OFFSET 0x1000
147 // VarOffset that will be used to create question
148 // all these values are computed from the structure
151 #define VAR_OFFSET(Field) ((UINT16) ((UINTN) &(((BMM_FAKE_NV_DATA *) 0)->Field)))
154 // Question Id of Zero is invalid, so add an offset to it
156 #define QUESTION_ID(Field) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET)
158 #define BOOT_TIME_OUT_VAR_OFFSET VAR_OFFSET (BootTimeOut)
159 #define BOOT_NEXT_VAR_OFFSET VAR_OFFSET (BootNext)
160 #define COM1_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM1BaudRate)
161 #define COM1_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM1DataRate)
162 #define COM1_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM1StopBits)
163 #define COM1_PARITY_VAR_OFFSET VAR_OFFSET (COM1Parity)
164 #define COM1_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
165 #define COM2_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COM2BaudRate)
166 #define COM2_DATA_RATE_VAR_OFFSET VAR_OFFSET (COM2DataRate)
167 #define COM2_STOP_BITS_VAR_OFFSET VAR_OFFSET (COM2StopBits)
168 #define COM2_PARITY_VAR_OFFSET VAR_OFFSET (COM2Parity)
169 #define COM2_TERMINAL_VAR_OFFSET VAR_OFFSET (COM2TerminalType)
170 #define DRV_ADD_HANDLE_DESC_VAR_OFFSET VAR_OFFSET (DriverAddHandleDesc)
171 #define DRV_ADD_ACTIVE_VAR_OFFSET VAR_OFFSET (DriverAddActive)
172 #define DRV_ADD_RECON_VAR_OFFSET VAR_OFFSET (DriverAddForceReconnect)
173 #define CON_IN_COM1_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM1)
174 #define CON_IN_COM2_VAR_OFFSET VAR_OFFSET (ConsoleInputCOM2)
175 #define CON_OUT_COM1_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM1)
176 #define CON_OUT_COM2_VAR_OFFSET VAR_OFFSET (ConsoleOutputCOM2)
177 #define CON_ERR_COM1_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM1)
178 #define CON_ERR_COM2_VAR_OFFSET VAR_OFFSET (ConsoleErrorCOM2)
179 #define CON_MODE_VAR_OFFSET VAR_OFFSET (ConsoleOutMode)
180 #define CON_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleCheck)
181 #define CON_IN_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleInCheck)
182 #define CON_OUT_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleOutCheck)
183 #define CON_ERR_DEVICE_VAR_OFFSET VAR_OFFSET (ConsoleErrCheck)
184 #define BOOT_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (BootOptionOrder)
185 #define DRIVER_OPTION_ORDER_VAR_OFFSET VAR_OFFSET (DriverOptionOrder)
186 #define BOOT_OPTION_DEL_VAR_OFFSET VAR_OFFSET (BootOptionDel)
187 #define DRIVER_OPTION_DEL_VAR_OFFSET VAR_OFFSET (DriverOptionDel)
188 #define DRIVER_ADD_OPTION_VAR_OFFSET VAR_OFFSET (DriverAddHandleOptionalData)
189 #define COM_BAUD_RATE_VAR_OFFSET VAR_OFFSET (COMBaudRate)
190 #define COM_DATA_RATE_VAR_OFFSET VAR_OFFSET (COMDataRate)
191 #define COM_STOP_BITS_VAR_OFFSET VAR_OFFSET (COMStopBits)
192 #define COM_PARITY_VAR_OFFSET VAR_OFFSET (COMParity)
193 #define COM_TERMINAL_VAR_OFFSET VAR_OFFSET (COMTerminalType)
194 #define COM_FLOWCONTROL_VAR_OFFSET VAR_OFFSET (COMFlowControl)
196 #define BOOT_TIME_OUT_QUESTION_ID QUESTION_ID (BootTimeOut)
197 #define BOOT_NEXT_QUESTION_ID QUESTION_ID (BootNext)
198 #define COM1_BAUD_RATE_QUESTION_ID QUESTION_ID (COM1BaudRate)
199 #define COM1_DATA_RATE_QUESTION_ID QUESTION_ID (COM1DataRate)
200 #define COM1_STOP_BITS_QUESTION_ID QUESTION_ID (COM1StopBits)
201 #define COM1_PARITY_QUESTION_ID QUESTION_ID (COM1Parity)
202 #define COM1_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
203 #define COM2_BAUD_RATE_QUESTION_ID QUESTION_ID (COM2BaudRate)
204 #define COM2_DATA_RATE_QUESTION_ID QUESTION_ID (COM2DataRate)
205 #define COM2_STOP_BITS_QUESTION_ID QUESTION_ID (COM2StopBits)
206 #define COM2_PARITY_QUESTION_ID QUESTION_ID (COM2Parity)
207 #define COM2_TERMINAL_QUESTION_ID QUESTION_ID (COM2TerminalType)
208 #define DRV_ADD_HANDLE_DESC_QUESTION_ID QUESTION_ID (DriverAddHandleDesc)
209 #define DRV_ADD_ACTIVE_QUESTION_ID QUESTION_ID (DriverAddActive)
210 #define DRV_ADD_RECON_QUESTION_ID QUESTION_ID (DriverAddForceReconnect)
211 #define CON_IN_COM1_QUESTION_ID QUESTION_ID (ConsoleInputCOM1)
212 #define CON_IN_COM2_QUESTION_ID QUESTION_ID (ConsoleInputCOM2)
213 #define CON_OUT_COM1_QUESTION_ID QUESTION_ID (ConsoleOutputCOM1)
214 #define CON_OUT_COM2_QUESTION_ID QUESTION_ID (ConsoleOutputCOM2)
215 #define CON_ERR_COM1_QUESTION_ID QUESTION_ID (ConsoleErrorCOM1)
216 #define CON_ERR_COM2_QUESTION_ID QUESTION_ID (ConsoleErrorCOM2)
217 #define CON_MODE_QUESTION_ID QUESTION_ID (ConsoleOutMode)
218 #define CON_DEVICE_QUESTION_ID QUESTION_ID (ConsoleCheck)
219 #define CON_IN_DEVICE_QUESTION_ID QUESTION_ID (ConsoleInCheck)
220 #define CON_OUT_DEVICE_QUESTION_ID QUESTION_ID (ConsoleOutCheck)
221 #define CON_ERR_DEVICE_QUESTION_ID QUESTION_ID (ConsoleErrCheck)
222 #define BOOT_OPTION_ORDER_QUESTION_ID QUESTION_ID (BootOptionOrder)
223 #define DRIVER_OPTION_ORDER_QUESTION_ID QUESTION_ID (DriverOptionOrder)
224 #define BOOT_OPTION_DEL_QUESTION_ID QUESTION_ID (BootOptionDel)
225 #define DRIVER_OPTION_DEL_QUESTION_ID QUESTION_ID (DriverOptionDel)
226 #define DRIVER_ADD_OPTION_QUESTION_ID QUESTION_ID (DriverAddHandleOptionalData)
227 #define COM_BAUD_RATE_QUESTION_ID QUESTION_ID (COMBaudRate)
228 #define COM_DATA_RATE_QUESTION_ID QUESTION_ID (COMDataRate)
229 #define COM_STOP_BITS_QUESTION_ID QUESTION_ID (COMStopBits)
230 #define COM_PARITY_QUESTION_ID QUESTION_ID (COMParity)
231 #define COM_TERMINAL_QUESTION_ID QUESTION_ID (COMTerminalType)
232 #define COM_FLOWCONTROL_QUESTION_ID QUESTION_ID (COMFlowControl)
234 #define STRING_DEPOSITORY_NUMBER 8
237 /// Serial Ports attributes, first one is the value for
238 /// return from callback function, stringtoken is used to
239 /// display the value properly
264 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
265 } BM_TERMINAL_CONTEXT
;
269 BOOLEAN LoadOptionModified
;
274 BOOLEAN ForceReconnect
;
275 UINTN OptionalDataSize
;
277 UINTN LoadOptionSize
;
281 UINT16 FilePathListLength
;
283 EFI_DEVICE_PATH_PROTOCOL
*FilePathList
;
295 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
296 } BM_CONSOLE_CONTEXT
;
305 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
306 EFI_FILE_HANDLE FHandle
;
308 EFI_FILE_SYSTEM_VOLUME_LABEL
*Info
;
312 BOOLEAN IsRemovableMedia
;
314 BOOLEAN IsBootLegacy
;
319 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
332 UINT16
*DisplayString
;
334 EFI_STRING_ID DisplayStringToken
;
335 EFI_STRING_ID HelpStringToken
;
336 UINTN ContextSelection
;
337 VOID
*VariableContext
;
344 EFI_HII_HANDLE BmmHiiHandle
;
345 EFI_HANDLE BmmDriverHandle
;
347 /// Boot Maintenance Manager Produced protocols
349 EFI_HII_CONFIG_ACCESS_PROTOCOL BmmConfigAccess
;
350 EFI_FORM_BROWSER2_PROTOCOL
*FormBrowser2
;
352 BM_MENU_ENTRY
*MenuEntry
;
353 BM_HANDLE_CONTEXT
*HandleContext
;
354 BM_FILE_CONTEXT
*FileContext
;
355 BM_LOAD_CONTEXT
*LoadContext
;
356 BM_TERMINAL_CONTEXT
*TerminalContext
;
357 UINTN CurrentTerminal
;
361 // BMM main formset callback data.
364 EFI_FORM_ID BmmCurrentPageId
;
365 EFI_FORM_ID BmmPreviousPageId
;
366 BOOLEAN BmmAskSaveOrNot
;
367 BMM_FAKE_NV_DATA BmmFakeNvData
;
368 BMM_FAKE_NV_DATA BmmOldFakeNVData
;
374 Find drivers that will be added as Driver#### variables from handles
375 in current system environment
376 All valid handles in the system except those consume SimpleFs, LoadFile
377 are stored in DriverMenu for future use.
379 @retval EFI_SUCCESS The function complets successfully.
380 @return Other value if failed to build the DriverMenu.
390 Build the BootOptionMenu according to BootOrder Variable.
391 This Routine will access the Boot#### to get EFI_LOAD_OPTION.
393 @param CallbackData The BMM context data.
395 @return The number of the Var Boot####.
399 BOpt_GetBootOptions (
400 IN BMM_CALLBACK_DATA
*CallbackData
405 Build up all DriverOptionMenu
407 @param CallbackData The BMM context data.
409 @return EFI_SUCESS The functin completes successfully.
410 @retval EFI_OUT_OF_RESOURCES Not enough memory to compete the operation.
415 BOpt_GetDriverOptions (
416 IN BMM_CALLBACK_DATA
*CallbackData
420 Free resources allocated in Allocate Rountine.
422 @param FreeMenu Menu to be freed
427 BM_MENU_OPTION
*FreeMenu
432 Get the Option Number that has not been allocated for use.
434 @param Type The type of Option.
436 @return The available Option Number.
440 BOpt_GetOptionNumber (
446 Get the Option Number for Boot#### that does not used.
448 @return The available Option Number.
452 BOpt_GetBootOptionNumber (
458 Get the Option Number for Driver#### that does not used.
460 @return The unused Option Number.
464 BOpt_GetDriverOptionNumber (
469 Create a menu entry give a Menu type.
471 @param MenuType The Menu type to be created.
474 @retval NULL If failed to create the menu.
479 BOpt_CreateMenuEntry (
484 Free up all resource allocated for a BM_MENU_ENTRY.
486 @param MenuEntry A pointer to BM_MENU_ENTRY.
490 BOpt_DestroyMenuEntry (
491 BM_MENU_ENTRY
*MenuEntry
495 Get the Menu Entry from the list in Menu Entry List.
497 If MenuNumber is great or equal to the number of Menu
498 Entry in the list, then ASSERT.
500 @param MenuOption The Menu Entry List to read the menu entry.
501 @param MenuNumber The index of Menu Entry.
503 @return The Menu Entry.
508 BM_MENU_OPTION
*MenuOption
,
513 Get option number according to Boot#### and BootOrder variable.
514 The value is saved as #### + 1.
516 @param CallbackData The BMM context data.
520 IN BMM_CALLBACK_DATA
*CallbackData
524 Get driver option order from globalc DriverOptionMenu.
526 @param CallbackData The BMM context data.
531 IN BMM_CALLBACK_DATA
*CallbackData
535 // Locate all serial io devices for console
538 Build a list containing all serial devices.
540 @retval EFI_SUCCESS The function complete successfully.
541 @retval EFI_UNSUPPORTED No serial ports present.
550 // Initializing Console menu
553 Build up ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
555 @retval EFI_SUCCESS The function always complete successfully.
564 // Get current mode information
567 Get mode number according to column and row
569 @param CallbackData The BMM context data.
573 IN BMM_CALLBACK_DATA
*CallbackData
577 // Cleaning up console menu
580 Free ConsoleOutMenu, ConsoleInpMenu and ConsoleErrMenu
582 @retval EFI_SUCCESS The function always complete successfully.
590 Update the device path that describing a terminal device
591 based on the new BaudRate, Data Bits, parity and Stop Bits
594 @param DevicePath The devicepath protocol instance wanted to be updated.
598 ChangeVariableDevicePath (
599 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
603 Update the multi-instance device path of Terminal Device based on
604 the global TerminalMenu. If ChangeTernimal is TRUE, the terminal
605 device path in the Terminal Device in TerminalMenu is also updated.
607 @param DevicePath The multi-instance device path.
608 @param ChangeTerminal TRUE, then device path in the Terminal Device
609 in TerminalMenu is also updated; FALSE, no update.
611 @return EFI_SUCCESS The function completes successfully.
615 ChangeTerminalDevicePath (
616 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
617 IN BOOLEAN ChangeTerminal
621 // Variable operation by menu selection
624 This function create a currently loaded Boot Option from
625 the BMM. It then appends this Boot Option to the end of
626 the "BootOrder" list. It also append this Boot Opotion to the end
629 @param CallbackData The BMM context data.
631 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
632 @retval EFI_SUCCESS If function completes successfully.
636 Var_UpdateBootOption (
637 IN BMM_CALLBACK_DATA
*CallbackData
641 Delete Boot Option that represent a Deleted state in BootOptionMenu.
642 After deleting this boot option, call Var_ChangeBootOrder to
643 make sure BootOrder is in valid state.
645 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
646 BM_LOAD_CONTEXT marked for deletion is deleted
647 @return Others If failed to update the "BootOrder" variable after deletion.
656 After any operation on Boot####, there will be a discrepancy in BootOrder.
657 Since some are missing but in BootOrder, while some are present but are
658 not reflected by BootOrder. Then a function rebuild BootOrder from
659 scratch by content from BootOptionMenu is needed.
661 @retval EFI_SUCCESS The boot order is updated successfully.
662 @return other than EFI_SUCCESS if failed to change the "BootOrder" EFI Variable.
666 Var_ChangeBootOrder (
671 This function create a currently loaded Drive Option from
672 the BMM. It then appends this Driver Option to the end of
673 the "DriverOrder" list. It append this Driver Opotion to the end
676 @param CallbackData The BMM context data.
677 @param HiiHandle The HII handle associated with the BMM formset.
678 @param DescriptionData The description of this driver option.
679 @param OptionalData The optional load option.
680 @param ForceReconnect If to force reconnect.
682 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
683 @retval EFI_SUCCESS If function completes successfully.
687 Var_UpdateDriverOption (
688 IN BMM_CALLBACK_DATA
*CallbackData
,
689 IN EFI_HII_HANDLE HiiHandle
,
690 IN UINT16
*DescriptionData
,
691 IN UINT16
*OptionalData
,
692 IN UINT8 ForceReconnect
696 Delete Load Option that represent a Deleted state in BootOptionMenu.
697 After deleting this Driver option, call Var_ChangeDriverOrder to
698 make sure DriverOrder is in valid state.
700 @retval EFI_SUCCESS Load Option is successfully updated.
701 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
706 Var_DelDriverOption (
711 After any operation on Driver####, there will be a discrepancy in
712 DriverOrder. Since some are missing but in DriverOrder, while some
713 are present but are not reflected by DriverOrder. Then a function
714 rebuild DriverOrder from scratch by content from DriverOptionMenu is
717 @retval EFI_SUCCESS The driver order is updated successfully.
718 @return other than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
722 Var_ChangeDriverOrder (
727 This function delete and build multi-instance device path ConIn
730 @retval EFI_SUCCESS The function complete successfully.
731 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
734 Var_UpdateConsoleInpOption (
739 This function delete and build multi-instance device path ConOut console device.
741 @retval EFI_SUCCESS The function complete successfully.
742 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
745 Var_UpdateConsoleOutOption (
750 This function delete and build multi-instance device path ErrOut console device.
752 @retval EFI_SUCCESS The function complete successfully.
753 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
756 Var_UpdateErrorOutOption (
761 This function delete and build Out of Band console device.
763 @param MenuIndex Menu index which user select in the terminal menu list.
765 @retval EFI_SUCCESS The function complete successfully.
766 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
769 Var_UpdateOutOfBandOption (
774 Update the device path of "ConOut", "ConIn" and "ErrOut" based on the new BaudRate, Data Bits,
775 parity and stop Bits set.
779 Var_UpdateAllConsoleOption (
784 This function update the "BootNext" EFI Variable. If there is no "BootNex" specified in BMM,
785 this EFI Variable is deleted.
786 It also update the BMM context data specified the "BootNext" value.
788 @param CallbackData The BMM context data.
790 @retval EFI_SUCCESS The function complete successfully.
791 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
796 IN BMM_CALLBACK_DATA
*CallbackData
800 This function update the "BootOrder" EFI Variable based on BMM Formset's NV map. It then refresh
801 BootOptionMenu with the new "BootOrder" list.
803 @param CallbackData The BMM context data.
805 @retval EFI_SUCCESS The function complete successfully.
806 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
807 @return not The EFI variable can not be saved. See gRT->SetVariable for detail return information.
811 Var_UpdateBootOrder (
812 IN BMM_CALLBACK_DATA
*CallbackData
816 This function update the "DriverOrder" EFI Variable based on
817 BMM Formset's NV map. It then refresh DriverOptionMenu
818 with the new "DriverOrder" list.
820 @param CallbackData The BMM context data.
822 @retval EFI_SUCCESS The function complete successfully.
823 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
824 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
828 Var_UpdateDriverOrder (
829 IN BMM_CALLBACK_DATA
*CallbackData
833 Update the Text Mode of Console.
835 @param CallbackData The context data for BMM.
837 @retval EFI_SUCCSS If the Text Mode of Console is updated.
838 @return Other value if the Text Mode of Console is not updated.
843 IN BMM_CALLBACK_DATA
*CallbackData
847 // Following are page create and refresh functions
850 Create the global UpdateData structure.
859 Refresh the global UpdateData structure.
868 Clean up the dynamic opcode at label and form specified by
871 @param LabelId It is both the Form ID and Label ID for
873 @param CallbackData The BMM context data.
879 IN BMM_CALLBACK_DATA
*CallbackData
883 Create a lit of boot option from global BootOptionMenu. It
884 allow user to delete the boot option.
886 @param CallbackData The BMM context data.
891 IN BMM_CALLBACK_DATA
*CallbackData
895 Create a lit of driver option from global DriverMenu.
897 @param CallbackData The BMM context data.
900 UpdateDrvAddHandlePage (
901 IN BMM_CALLBACK_DATA
*CallbackData
905 Create a lit of driver option from global DriverOptionMenu. It
906 allow user to delete the driver option.
908 @param CallbackData The BMM context data.
912 IN BMM_CALLBACK_DATA
*CallbackData
916 Prepare the page to allow user to add description for a Driver Option.
918 @param CallbackData The BMM context data.
921 UpdateDriverAddHandleDescPage (
922 IN BMM_CALLBACK_DATA
*CallbackData
926 Dispatch the correct update page function to call based on the UpdatePageId.
928 @param UpdatePageId The form ID.
929 @param CallbackData The BMM context data.
933 IN UINT16 UpdatePageId
,
934 IN BMM_CALLBACK_DATA
*CallbackData
938 Create the dynamic page to allow user to set the "BootNext" vaule.
940 @param CallbackData The BMM context data.
944 IN BMM_CALLBACK_DATA
*CallbackData
948 Create the dynamic page to allow user to set the "TimeOut" vaule.
950 @param CallbackData The BMM context data.
954 IN BMM_CALLBACK_DATA
*CallbackData
958 Create the dynamic page which allows user to set the property such as Baud Rate, Data Bits,
959 Parity, Stop Bits, Terminal Type.
961 @param CallbackData The BMM context data.
965 IN BMM_CALLBACK_DATA
*CallbackData
969 Refresh the text mode page
971 @param CallbackData The BMM context data.
975 IN BMM_CALLBACK_DATA
*CallbackData
979 Create a list of Goto Opcode for all terminal devices logged
980 by TerminaMenu. This list will be inserted to form FORM_CON_COM_SETUP_ID.
982 @param CallbackData The BMM context data.
986 IN BMM_CALLBACK_DATA
*CallbackData
990 Update add boot/driver option page.
992 @param CallbackData The BMM context data.
993 @param FormId The form ID to be updated.
994 @param DevicePath Device path.
999 IN BMM_CALLBACK_DATA
*CallbackData
,
1000 IN EFI_FORM_ID FormId
,
1001 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1005 Function deletes the variable specified by VarName and VarGuid.
1008 @param VarName A Null-terminated Unicode string that is
1009 the name of the vendor's variable.
1011 @param VarGuid A unique identifier for the vendor.
1013 @retval EFI_SUCCESS The variable was found and removed
1014 @retval EFI_UNSUPPORTED The variable store was inaccessible
1015 @retval EFI_OUT_OF_RESOURCES The temporary buffer was not available
1016 @retval EFI_NOT_FOUND The variable was not found
1020 EfiLibDeleteVariable (
1022 IN EFI_GUID
*VarGuid
1026 Function is used to determine the number of device path instances
1027 that exist in a device path.
1030 @param DevicePath A pointer to a device path data structure.
1032 @return This function counts and returns the number of device path instances
1037 EfiDevicePathInstanceCount (
1038 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1042 Get a string from the Data Hub record based on
1045 @param DevPath The device Path.
1047 @return A string located from the Data Hub records based on
1049 @retval NULL If failed to get the String from Data Hub.
1053 EfiLibStrFromDatahub (
1054 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1058 Get the index number (#### in Boot####) for the boot option pointed to a BBS legacy device type
1059 specified by DeviceType.
1061 @param DeviceType The legacy device type. It can be floppy, network, harddisk, cdrom,
1063 @param OptionIndex Returns the index number (#### in Boot####).
1064 @param OptionSize Return the size of the Boot### variable.
1068 GetLegacyBootOptionVar (
1069 IN UINTN DeviceType
,
1070 OUT UINTN
*OptionIndex
,
1071 OUT UINTN
*OptionSize
1075 Discard all changes done to the BMM pages such as Boot Order change,
1076 Driver order change.
1078 @param Private The BMM context data.
1079 @param CurrentFakeNVMap The current Fack NV Map.
1083 DiscardChangeHandler (
1084 IN BMM_CALLBACK_DATA
*Private
,
1085 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
1089 Dispatch the display to the next page based on NewPageId.
1091 @param Private The BMM context data.
1092 @param NewPageId The original page ID.
1097 BMM_CALLBACK_DATA
*Private
,
1102 Remove the installed BootMaint and FileExplorer HiiPackages.
1111 Install BootMaint and FileExplorer HiiPackages.
1115 InitBootMaintenance(
1121 Initialize console input device check box to ConsoleInCheck[MAX_MENU_NUMBER]
1122 in BMM_FAKE_NV_DATA structure.
1124 @param CallbackData The BMM context data.
1129 IN BMM_CALLBACK_DATA
*CallbackData
1134 Initialize console output device check box to ConsoleOutCheck[MAX_MENU_NUMBER]
1135 in BMM_FAKE_NV_DATA structure.
1137 @param CallbackData The BMM context data.
1141 GetConsoleOutCheck (
1142 IN BMM_CALLBACK_DATA
*CallbackData
1147 Initialize standard error output device check box to ConsoleErrCheck[MAX_MENU_NUMBER]
1148 in BMM_FAKE_NV_DATA structure.
1150 @param CallbackData The BMM context data.
1154 GetConsoleErrCheck (
1155 IN BMM_CALLBACK_DATA
*CallbackData
1160 Initialize terminal attributes (baudrate, data rate, stop bits, parity and terminal type)
1161 to BMM_FAKE_NV_DATA structure.
1163 @param CallbackData The BMM context data.
1167 GetTerminalAttribute (
1168 IN BMM_CALLBACK_DATA
*CallbackData
1172 This function will change video resolution and text mode
1173 according to defined setup mode or defined boot mode
1175 @param IsSetupMode Indicate mode is changed to setup mode or boot mode.
1177 @retval EFI_SUCCESS Mode is changed successfully.
1178 @retval Others Mode failed to be changed.
1183 BmmBdsSetConsoleMode (
1189 This function converts an input device structure to a Unicode string.
1191 @param DevPath A pointer to the device path structure.
1193 @return A new allocated Unicode string that represents the device path.
1198 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
1202 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.
1203 The caller is responsible for freeing the allocated buffer using FreePool().
1205 @param DevicePath Device path.
1207 @return A new allocated string that represents the file name.
1211 ExtractFileNameFromDevicePath (
1212 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
1216 This function allows a caller to extract the current configuration for one
1217 or more named elements from the target driver.
1219 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1220 @param Request A null-terminated Unicode string in <ConfigRequest> format.
1221 @param Progress On return, points to a character in the Request string.
1222 Points to the string's null terminator if request was successful.
1223 Points to the most recent '&' before the first failing name/value
1224 pair (or the beginning of the string if the failure is in the
1225 first name/value pair) if the request was not successful.
1226 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
1227 has all values filled in for the names in the Request string.
1228 String to be allocated by the called function.
1230 @retval EFI_SUCCESS The Results is filled with the requested values.
1231 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
1232 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
1233 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
1238 BootMaintExtractConfig (
1239 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1240 IN CONST EFI_STRING Request
,
1241 OUT EFI_STRING
*Progress
,
1242 OUT EFI_STRING
*Results
1246 This function applies changes in a driver's configuration.
1247 Input is a Configuration, which has the routing data for this
1248 driver followed by name / value configuration pairs. The driver
1249 must apply those pairs to its configurable storage. If the
1250 driver's configuration is stored in a linear block of data
1251 and the driver's name / value pairs are in <BlockConfig>
1252 format, it may use the ConfigToBlock helper function (above) to
1253 simplify the job. Currently not implemented.
1255 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1256 @param[in] Configuration A null-terminated Unicode string in
1257 <ConfigString> format.
1258 @param[out] Progress A pointer to a string filled in with the
1259 offset of the most recent '&' before the
1260 first failing name / value pair (or the
1261 beginn ing of the string if the failure
1262 is in the first name / value pair) or
1263 the terminating NULL if all was
1266 @retval EFI_SUCCESS The results have been distributed or are
1267 awaiting distribution.
1268 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1269 parts of the results that must be
1270 stored awaiting possible future
1272 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
1273 Results parameter would result
1274 in this type of error.
1275 @retval EFI_NOT_FOUND Target for the specified routing data
1280 BootMaintRouteConfig (
1281 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1282 IN CONST EFI_STRING Configuration
,
1283 OUT EFI_STRING
*Progress
1287 This function processes the results of changes in configuration.
1290 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1291 @param Action Specifies the type of action taken by the browser.
1292 @param QuestionId A unique value which is sent to the original exporting driver
1293 so that it can identify the type of data to expect.
1294 @param Type The type of value for the question.
1295 @param Value A pointer to the data being sent to the original exporting driver.
1296 @param ActionRequest On return, points to the action requested by the callback function.
1298 @retval EFI_SUCCESS The callback successfully handled the action.
1299 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
1300 @retval EFI_DEVICE_ERROR The variable could not be saved.
1301 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
1302 @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.
1307 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1308 IN EFI_BROWSER_ACTION Action
,
1309 IN EFI_QUESTION_ID QuestionId
,
1311 IN EFI_IFR_TYPE_VALUE
*Value
,
1312 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1316 Create boot option base on the input file path info.
1318 @param FilePath Point to the file path.
1320 @retval TRUE Exit caller function.
1321 @retval FALSE Not exit caller function.
1325 CreateBootOptionFromFile (
1326 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1330 Create driver option base on the input file path info.
1332 @param FilePath Point to the file path.
1334 @retval TRUE Exit caller function.
1335 @retval FALSE Not exit caller function.
1338 CreateDriverOptionFromFile (
1339 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1343 Boot the file specified by the input file path info.
1345 @param FilePath Point to the file path.
1347 @retval TRUE Exit caller function.
1348 @retval FALSE Not exit caller function.
1353 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1357 // Global variable in this program (defined in data.c)
1359 extern BM_MENU_OPTION BootOptionMenu
;
1360 extern BM_MENU_OPTION DriverOptionMenu
;
1361 extern BM_MENU_OPTION ConsoleInpMenu
;
1362 extern BM_MENU_OPTION ConsoleOutMenu
;
1363 extern BM_MENU_OPTION ConsoleErrMenu
;
1364 extern BM_MENU_OPTION DriverMenu
;
1365 extern BM_MENU_OPTION TerminalMenu
;
1366 extern UINT16 TerminalType
[5];
1367 extern COM_ATTR BaudRateList
[19];
1368 extern COM_ATTR DataBitsList
[4];
1369 extern COM_ATTR ParityList
[5];
1370 extern COM_ATTR StopBitsList
[3];
1371 extern EFI_GUID TerminalTypeGuid
[5];
1372 extern EFI_DEVICE_PATH_PROTOCOL EndDevicePath
[];
1373 extern UINT16 mFlowControlType
[2];
1374 extern UINT32 mFlowControlValue
[2];
1377 // Shared IFR form update data
1379 extern VOID
*mStartOpCodeHandle
;
1380 extern VOID
*mEndOpCodeHandle
;
1381 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
1382 extern EFI_IFR_GUID_LABEL
*mEndLabel
;
1383 extern BMM_CALLBACK_DATA gBootMaintenancePrivate
;
1384 extern BMM_CALLBACK_DATA
*mBmmCallbackInfo
;