2 The functions for Boot Maintainence Main menu.
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 #include "BootMaint.h"
18 #include "FrontPage.h"
20 EFI_DEVICE_PATH_PROTOCOL EndDevicePath
[] = {
23 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
25 END_DEVICE_PATH_LENGTH
,
32 EFI_GUID EfiLegacyDevOrderGuid
= EFI_LEGACY_DEV_ORDER_VARIABLE_GUID
;
33 EFI_GUID mBootMaintGuid
= BOOT_MAINT_FORMSET_GUID
;
34 EFI_GUID mFileExplorerGuid
= FILE_EXPLORE_FORMSET_GUID
;
36 CHAR16 mBootMaintStorageName
[] = L
"BmData";
37 CHAR16 mFileExplorerStorageName
[] = L
"FeData";
42 @param CallbackData The BMM context data.
47 IN BMM_CALLBACK_DATA
*CallbackData
51 Free up all Menu Option list.
60 Create string tokens for a menu from its help strings and display strings
62 @param CallbackData The BMM context data.
63 @param HiiHandle Hii Handle of the package to be updated.
64 @param MenuOption The Menu whose string tokens need to be created
66 @retval EFI_SUCCESS String tokens created successfully
67 @retval others contain some errors
70 CreateMenuStringToken (
71 IN BMM_CALLBACK_DATA
*CallbackData
,
72 IN EFI_HII_HANDLE HiiHandle
,
73 IN BM_MENU_OPTION
*MenuOption
76 BM_MENU_ENTRY
*NewMenuEntry
;
79 for (Index
= 0; Index
< MenuOption
->MenuNumber
; Index
++) {
80 NewMenuEntry
= BOpt_GetMenuEntry (MenuOption
, Index
);
84 &NewMenuEntry
->DisplayStringToken
,
85 NewMenuEntry
->DisplayString
88 if (NULL
== NewMenuEntry
->HelpString
) {
89 NewMenuEntry
->HelpStringToken
= NewMenuEntry
->DisplayStringToken
;
93 &NewMenuEntry
->HelpStringToken
,
94 NewMenuEntry
->HelpString
103 This function allows a caller to extract the current configuration for one
104 or more named elements from the target driver.
107 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
108 @param Request A null-terminated Unicode string in <ConfigRequest> format.
109 @param Progress On return, points to a character in the Request string.
110 Points to the string's null terminator if request was successful.
111 Points to the most recent '&' before the first failing name/value
112 pair (or the beginning of the string if the failure is in the
113 first name/value pair) if the request was not successful.
114 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
115 has all values filled in for the names in the Request string.
116 String to be allocated by the called function.
118 @retval EFI_SUCCESS The Results is filled with the requested values.
119 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
120 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
121 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
126 BootMaintExtractConfig (
127 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
128 IN CONST EFI_STRING Request
,
129 OUT EFI_STRING
*Progress
,
130 OUT EFI_STRING
*Results
135 BMM_CALLBACK_DATA
*Private
;
137 if (Request
== NULL
) {
138 return EFI_INVALID_PARAMETER
;
141 Private
= BMM_CALLBACK_DATA_FROM_THIS (This
);
144 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()
146 BufferSize
= sizeof (BMM_FAKE_NV_DATA
);
147 Status
= gHiiConfigRouting
->BlockToConfig (
150 (UINT8
*) &Private
->BmmFakeNvData
,
159 This function processes the results of changes in configuration.
162 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
163 @param Action Specifies the type of action taken by the browser.
164 @param QuestionId A unique value which is sent to the original exporting driver
165 so that it can identify the type of data to expect.
166 @param Type The type of value for the question.
167 @param Value A pointer to the data being sent to the original exporting driver.
168 @param ActionRequest On return, points to the action requested by the callback function.
170 @retval EFI_SUCCESS The callback successfully handled the action.
171 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
172 @retval EFI_DEVICE_ERROR The variable could not be saved.
173 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
174 @retval EFI_INVALID_PARAMETER The parameter of Value or ActionRequest is invalid.
179 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
180 IN EFI_BROWSER_ACTION Action
,
181 IN EFI_QUESTION_ID QuestionId
,
183 IN EFI_IFR_TYPE_VALUE
*Value
,
184 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
187 BMM_CALLBACK_DATA
*Private
;
188 BM_MENU_ENTRY
*NewMenuEntry
;
189 BMM_FAKE_NV_DATA
*CurrentFakeNVMap
;
205 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
206 return EFI_INVALID_PARAMETER
;
216 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
218 Private
= BMM_CALLBACK_DATA_FROM_THIS (This
);
219 UpdatePageId (Private
, QuestionId
);
222 // Retrive uncommitted data from Form Browser
224 CurrentFakeNVMap
= &Private
->BmmFakeNvData
;
225 BufferSize
= sizeof (BMM_FAKE_NV_DATA
);
226 Status
= GetBrowserData (NULL
, NULL
, &BufferSize
, (UINT8
*) CurrentFakeNVMap
);
227 if (EFI_ERROR (Status
)) {
232 // need to be subtituded.
234 // Update Select FD/HD/CD/NET/BEV Order Form
236 if (FORM_SET_FD_ORDER_ID
== Private
->BmmPreviousPageId
||
237 FORM_SET_HD_ORDER_ID
== Private
->BmmPreviousPageId
||
238 FORM_SET_CD_ORDER_ID
== Private
->BmmPreviousPageId
||
239 FORM_SET_NET_ORDER_ID
== Private
->BmmPreviousPageId
||
240 FORM_SET_BEV_ORDER_ID
== Private
->BmmPreviousPageId
||
241 ((FORM_BOOT_SETUP_ID
== Private
->BmmPreviousPageId
) &&
242 (QuestionId
>= LEGACY_FD_QUESTION_ID
) &&
243 (QuestionId
< (LEGACY_BEV_QUESTION_ID
+ 100)) )
246 DisMap
= Private
->BmmOldFakeNVData
.DisableMap
;
248 FormId
= Private
->BmmPreviousPageId
;
249 if (FormId
== FORM_BOOT_SETUP_ID
) {
250 FormId
= Private
->BmmCurrentPageId
;
254 case FORM_SET_FD_ORDER_ID
:
255 Number
= (UINT16
) LegacyFDMenu
.MenuNumber
;
256 OldLegacyDev
= Private
->BmmOldFakeNVData
.LegacyFD
;
257 NewLegacyDev
= CurrentFakeNVMap
->LegacyFD
;
260 case FORM_SET_HD_ORDER_ID
:
261 Number
= (UINT16
) LegacyHDMenu
.MenuNumber
;
262 OldLegacyDev
= Private
->BmmOldFakeNVData
.LegacyHD
;
263 NewLegacyDev
= CurrentFakeNVMap
->LegacyHD
;
266 case FORM_SET_CD_ORDER_ID
:
267 Number
= (UINT16
) LegacyCDMenu
.MenuNumber
;
268 OldLegacyDev
= Private
->BmmOldFakeNVData
.LegacyCD
;
269 NewLegacyDev
= CurrentFakeNVMap
->LegacyCD
;
272 case FORM_SET_NET_ORDER_ID
:
273 Number
= (UINT16
) LegacyNETMenu
.MenuNumber
;
274 OldLegacyDev
= Private
->BmmOldFakeNVData
.LegacyNET
;
275 NewLegacyDev
= CurrentFakeNVMap
->LegacyNET
;
278 case FORM_SET_BEV_ORDER_ID
:
279 Number
= (UINT16
) LegacyBEVMenu
.MenuNumber
;
280 OldLegacyDev
= Private
->BmmOldFakeNVData
.LegacyBEV
;
281 NewLegacyDev
= CurrentFakeNVMap
->LegacyBEV
;
288 // First, find the different position
289 // if there is change, it should be only one
291 for (Index
= 0; Index
< Number
; Index
++) {
292 if (OldLegacyDev
[Index
] != NewLegacyDev
[Index
]) {
293 OldValue
= OldLegacyDev
[Index
];
294 NewValue
= NewLegacyDev
[Index
];
299 if (Index
!= Number
) {
301 // there is change, now process
303 if (0xFF == NewValue
) {
305 // This item will be disable
306 // Just move the items behind this forward to overlap it
309 Bit
= 7 - (OldValue
% 8);
310 DisMap
[Pos
] = (UINT8
) (DisMap
[Pos
] | (UINT8
) (1 << Bit
));
311 for (Index2
= Index
; Index2
< Number
- 1; Index2
++) {
312 NewLegacyDev
[Index2
] = NewLegacyDev
[Index2
+ 1];
315 NewLegacyDev
[Index2
] = 0xFF;
317 for (Index2
= 0; Index2
< Number
; Index2
++) {
318 if (Index2
== Index
) {
322 if (OldLegacyDev
[Index2
] == NewValue
) {
324 // If NewValue is in OldLegacyDev array
325 // remember its old position
327 NewValuePos
= Index2
;
332 if (Index2
!= Number
) {
334 // We will change current item to an existing item
335 // (It's hard to describe here, please read code, it's like a cycle-moving)
337 for (Index2
= NewValuePos
; Index2
!= Index
;) {
338 if (NewValuePos
< Index
) {
339 NewLegacyDev
[Index2
] = OldLegacyDev
[Index2
+ 1];
342 NewLegacyDev
[Index2
] = OldLegacyDev
[Index2
- 1];
348 // If NewValue is not in OldlegacyDev array, we are changing to a disabled item
349 // so we should modify DisMap to reflect the change
352 Bit
= 7 - (NewValue
% 8);
353 DisMap
[Pos
] = (UINT8
) (DisMap
[Pos
] & (~ (UINT8
) (1 << Bit
)));
354 if (0xFF != OldValue
) {
356 // Because NewValue is a item that was disabled before
357 // so after changing the OldValue should be disabled
358 // actually we are doing a swap of enable-disable states of two items
361 Bit
= 7 - (OldValue
% 8);
362 DisMap
[Pos
] = (UINT8
) (DisMap
[Pos
] | (UINT8
) (1 << Bit
));
367 // To prevent DISABLE appears in the middle of the list
368 // we should perform a re-ordering
371 while (Index
< Number
) {
372 if (0xFF != NewLegacyDev
[Index
]) {
379 while (Index2
< Number
) {
380 if (0xFF != NewLegacyDev
[Index2
]) {
387 if (Index2
< Number
) {
388 NewLegacyDev
[Index
] = NewLegacyDev
[Index2
];
389 NewLegacyDev
[Index2
] = 0xFF;
403 if (QuestionId
< FILE_OPTION_OFFSET
) {
404 if (QuestionId
< CONFIG_OPTION_OFFSET
) {
405 switch (QuestionId
) {
406 case KEY_VALUE_BOOT_FROM_FILE
:
407 Private
->FeCurrentState
= BOOT_FROM_FILE_STATE
;
410 // Exit Bmm main formset to send File Explorer formset.
412 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
415 case FORM_BOOT_ADD_ID
:
416 Private
->FeCurrentState
= ADD_BOOT_OPTION_STATE
;
419 // Exit Bmm main formset to send File Explorer formset.
421 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
424 case FORM_DRV_ADD_FILE_ID
:
425 Private
->FeCurrentState
= ADD_DRIVER_OPTION_STATE
;
428 // Exit Bmm main formset to send File Explorer formset.
430 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
433 case FORM_DRV_ADD_HANDLE_ID
:
434 CleanUpPage (FORM_DRV_ADD_HANDLE_ID
, Private
);
435 UpdateDrvAddHandlePage (Private
);
438 case FORM_BOOT_DEL_ID
:
439 CleanUpPage (FORM_BOOT_DEL_ID
, Private
);
440 UpdateBootDelPage (Private
);
443 case FORM_BOOT_CHG_ID
:
444 case FORM_DRV_CHG_ID
:
445 UpdatePageBody (QuestionId
, Private
);
448 case FORM_DRV_DEL_ID
:
449 CleanUpPage (FORM_DRV_DEL_ID
, Private
);
450 UpdateDrvDelPage (Private
);
453 case FORM_BOOT_NEXT_ID
:
454 CleanUpPage (FORM_BOOT_NEXT_ID
, Private
);
455 UpdateBootNextPage (Private
);
458 case FORM_TIME_OUT_ID
:
459 CleanUpPage (FORM_TIME_OUT_ID
, Private
);
460 UpdateTimeOutPage (Private
);
464 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
465 return EFI_UNSUPPORTED
;
468 case FORM_CON_OUT_ID
:
469 case FORM_CON_ERR_ID
:
470 UpdatePageBody (QuestionId
, Private
);
473 case FORM_CON_MODE_ID
:
474 CleanUpPage (FORM_CON_MODE_ID
, Private
);
475 UpdateConModePage (Private
);
478 case FORM_CON_COM_ID
:
479 CleanUpPage (FORM_CON_COM_ID
, Private
);
480 UpdateConCOMPage (Private
);
483 case FORM_SET_FD_ORDER_ID
:
484 case FORM_SET_HD_ORDER_ID
:
485 case FORM_SET_CD_ORDER_ID
:
486 case FORM_SET_NET_ORDER_ID
:
487 case FORM_SET_BEV_ORDER_ID
:
488 CleanUpPage (QuestionId
, Private
);
489 UpdateSetLegacyDeviceOrderPage (QuestionId
, Private
);
492 case KEY_VALUE_SAVE_AND_EXIT
:
493 case KEY_VALUE_NO_SAVE_AND_EXIT
:
495 if (QuestionId
== KEY_VALUE_SAVE_AND_EXIT
) {
496 Status
= ApplyChangeHandler (Private
, CurrentFakeNVMap
, Private
->BmmPreviousPageId
);
497 if (EFI_ERROR (Status
)) {
500 } else if (QuestionId
== KEY_VALUE_NO_SAVE_AND_EXIT
) {
501 DiscardChangeHandler (Private
, CurrentFakeNVMap
);
505 // Tell browser not to ask for confirmation of changes,
506 // since we have already applied or discarded.
508 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
514 } else if ((QuestionId
>= TERMINAL_OPTION_OFFSET
) && (QuestionId
< CONSOLE_OPTION_OFFSET
)) {
515 Index2
= (UINT16
) (QuestionId
- TERMINAL_OPTION_OFFSET
);
516 Private
->CurrentTerminal
= Index2
;
518 CleanUpPage (FORM_CON_COM_SETUP_ID
, Private
);
519 UpdateTerminalPage (Private
);
521 } else if (QuestionId
>= HANDLE_OPTION_OFFSET
) {
522 Index2
= (UINT16
) (QuestionId
- HANDLE_OPTION_OFFSET
);
524 NewMenuEntry
= BOpt_GetMenuEntry (&DriverMenu
, Index2
);
525 ASSERT (NewMenuEntry
!= NULL
);
526 Private
->HandleContext
= (BM_HANDLE_CONTEXT
*) NewMenuEntry
->VariableContext
;
528 CleanUpPage (FORM_DRV_ADD_HANDLE_DESC_ID
, Private
);
530 Private
->MenuEntry
= NewMenuEntry
;
531 Private
->LoadContext
->FilePathList
= Private
->HandleContext
->DevicePath
;
533 UpdateDriverAddHandleDescPage (Private
);
538 // Pass changed uncommitted data back to Form Browser
540 BufferSize
= sizeof (BMM_FAKE_NV_DATA
);
541 Status
= SetBrowserData (NULL
, NULL
, BufferSize
, (UINT8
*) CurrentFakeNVMap
, NULL
);
547 Function handling request to apply changes for BMM pages.
549 @param Private Pointer to callback data buffer.
550 @param CurrentFakeNVMap Pointer to buffer holding data of various values used by BMM
551 @param FormId ID of the form which has sent the request to apply change.
553 @retval EFI_SUCCESS Change successfully applied.
554 @retval Other Error occurs while trying to apply changes.
559 IN BMM_CALLBACK_DATA
*Private
,
560 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
,
561 IN EFI_FORM_ID FormId
564 BM_CONSOLE_CONTEXT
*NewConsoleContext
;
565 BM_TERMINAL_CONTEXT
*NewTerminalContext
;
566 BM_LOAD_CONTEXT
*NewLoadContext
;
567 BM_MENU_ENTRY
*NewMenuEntry
;
571 Status
= EFI_SUCCESS
;
574 case FORM_SET_FD_ORDER_ID
:
575 case FORM_SET_HD_ORDER_ID
:
576 case FORM_SET_CD_ORDER_ID
:
577 case FORM_SET_NET_ORDER_ID
:
578 case FORM_SET_BEV_ORDER_ID
:
579 Var_UpdateBBSOption (Private
);
582 case FORM_BOOT_DEL_ID
:
583 ASSERT (BootOptionMenu
.MenuNumber
<= (sizeof (CurrentFakeNVMap
->BootOptionDel
) / sizeof (UINT8
)));
584 for (Index
= 0; Index
< BootOptionMenu
.MenuNumber
; Index
++) {
585 NewMenuEntry
= BOpt_GetMenuEntry (&BootOptionMenu
, Index
);
586 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
587 NewLoadContext
->Deleted
= CurrentFakeNVMap
->BootOptionDel
[Index
];
590 Var_DelBootOption ();
593 case FORM_DRV_DEL_ID
:
594 ASSERT (DriverOptionMenu
.MenuNumber
<= (sizeof (CurrentFakeNVMap
->DriverOptionDel
) / sizeof (UINT8
)));
595 for (Index
= 0; Index
< DriverOptionMenu
.MenuNumber
; Index
++) {
596 NewMenuEntry
= BOpt_GetMenuEntry (&DriverOptionMenu
, Index
);
597 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
598 NewLoadContext
->Deleted
= CurrentFakeNVMap
->DriverOptionDel
[Index
];
601 Var_DelDriverOption ();
604 case FORM_BOOT_CHG_ID
:
605 Status
= Var_UpdateBootOrder (Private
);
608 case FORM_DRV_CHG_ID
:
609 Status
= Var_UpdateDriverOrder (Private
);
612 case FORM_TIME_OUT_ID
:
613 PcdSet16 (PcdPlatformBootTimeOut
, CurrentFakeNVMap
->BootTimeOut
);
615 Private
->BmmOldFakeNVData
.BootTimeOut
= CurrentFakeNVMap
->BootTimeOut
;
618 case FORM_BOOT_NEXT_ID
:
619 Status
= Var_UpdateBootNext (Private
);
622 case FORM_CON_MODE_ID
:
623 Status
= Var_UpdateConMode (Private
);
626 case FORM_CON_COM_SETUP_ID
:
627 NewMenuEntry
= BOpt_GetMenuEntry (&TerminalMenu
, Private
->CurrentTerminal
);
629 ASSERT (NewMenuEntry
!= NULL
);
631 NewTerminalContext
= (BM_TERMINAL_CONTEXT
*) NewMenuEntry
->VariableContext
;
633 NewTerminalContext
->BaudRateIndex
= CurrentFakeNVMap
->COMBaudRate
;
634 ASSERT (CurrentFakeNVMap
->COMBaudRate
< (sizeof (BaudRateList
) / sizeof (BaudRateList
[0])));
635 NewTerminalContext
->BaudRate
= BaudRateList
[CurrentFakeNVMap
->COMBaudRate
].Value
;
636 NewTerminalContext
->DataBitsIndex
= CurrentFakeNVMap
->COMDataRate
;
637 ASSERT (CurrentFakeNVMap
->COMDataRate
< (sizeof (DataBitsList
) / sizeof (DataBitsList
[0])));
638 NewTerminalContext
->DataBits
= (UINT8
) DataBitsList
[CurrentFakeNVMap
->COMDataRate
].Value
;
639 NewTerminalContext
->StopBitsIndex
= CurrentFakeNVMap
->COMStopBits
;
640 ASSERT (CurrentFakeNVMap
->COMStopBits
< (sizeof (StopBitsList
) / sizeof (StopBitsList
[0])));
641 NewTerminalContext
->StopBits
= (UINT8
) StopBitsList
[CurrentFakeNVMap
->COMStopBits
].Value
;
642 NewTerminalContext
->ParityIndex
= CurrentFakeNVMap
->COMParity
;
643 ASSERT (CurrentFakeNVMap
->COMParity
< (sizeof (ParityList
) / sizeof (ParityList
[0])));
644 NewTerminalContext
->Parity
= (UINT8
) ParityList
[CurrentFakeNVMap
->COMParity
].Value
;
645 NewTerminalContext
->TerminalType
= CurrentFakeNVMap
->COMTerminalType
;
647 ChangeTerminalDevicePath (
648 NewTerminalContext
->DevicePath
,
652 Var_UpdateConsoleInpOption ();
653 Var_UpdateConsoleOutOption ();
654 Var_UpdateErrorOutOption ();
658 ASSERT ((ConsoleInpMenu
.MenuNumber
+ TerminalMenu
.MenuNumber
) <= (sizeof (CurrentFakeNVMap
->ConsoleCheck
) / sizeof (UINT8
)));
659 for (Index
= 0; Index
< ConsoleInpMenu
.MenuNumber
; Index
++) {
660 NewMenuEntry
= BOpt_GetMenuEntry (&ConsoleInpMenu
, Index
);
661 NewConsoleContext
= (BM_CONSOLE_CONTEXT
*) NewMenuEntry
->VariableContext
;
662 NewConsoleContext
->IsActive
= CurrentFakeNVMap
->ConsoleCheck
[Index
];
665 for (Index
= 0; Index
< TerminalMenu
.MenuNumber
; Index
++) {
666 NewMenuEntry
= BOpt_GetMenuEntry (&TerminalMenu
, Index
);
667 NewTerminalContext
= (BM_TERMINAL_CONTEXT
*) NewMenuEntry
->VariableContext
;
668 NewTerminalContext
->IsConIn
= CurrentFakeNVMap
->ConsoleCheck
[Index
+ ConsoleInpMenu
.MenuNumber
];
671 Var_UpdateConsoleInpOption ();
674 case FORM_CON_OUT_ID
:
675 ASSERT ((ConsoleOutMenu
.MenuNumber
+ TerminalMenu
.MenuNumber
) <= (sizeof (CurrentFakeNVMap
->ConsoleCheck
) / sizeof (UINT8
)));
676 for (Index
= 0; Index
< ConsoleOutMenu
.MenuNumber
; Index
++) {
677 NewMenuEntry
= BOpt_GetMenuEntry (&ConsoleOutMenu
, Index
);
678 NewConsoleContext
= (BM_CONSOLE_CONTEXT
*) NewMenuEntry
->VariableContext
;
679 NewConsoleContext
->IsActive
= CurrentFakeNVMap
->ConsoleCheck
[Index
];
682 for (Index
= 0; Index
< TerminalMenu
.MenuNumber
; Index
++) {
683 NewMenuEntry
= BOpt_GetMenuEntry (&TerminalMenu
, Index
);
684 NewTerminalContext
= (BM_TERMINAL_CONTEXT
*) NewMenuEntry
->VariableContext
;
685 NewTerminalContext
->IsConOut
= CurrentFakeNVMap
->ConsoleCheck
[Index
+ ConsoleOutMenu
.MenuNumber
];
688 Var_UpdateConsoleOutOption ();
691 case FORM_CON_ERR_ID
:
692 ASSERT ((ConsoleErrMenu
.MenuNumber
+ TerminalMenu
.MenuNumber
) <= (sizeof (CurrentFakeNVMap
->ConsoleCheck
) / sizeof (UINT8
)));
693 for (Index
= 0; Index
< ConsoleErrMenu
.MenuNumber
; Index
++) {
694 NewMenuEntry
= BOpt_GetMenuEntry (&ConsoleErrMenu
, Index
);
695 NewConsoleContext
= (BM_CONSOLE_CONTEXT
*) NewMenuEntry
->VariableContext
;
696 NewConsoleContext
->IsActive
= CurrentFakeNVMap
->ConsoleCheck
[Index
];
699 for (Index
= 0; Index
< TerminalMenu
.MenuNumber
; Index
++) {
700 NewMenuEntry
= BOpt_GetMenuEntry (&TerminalMenu
, Index
);
701 NewTerminalContext
= (BM_TERMINAL_CONTEXT
*) NewMenuEntry
->VariableContext
;
702 NewTerminalContext
->IsStdErr
= CurrentFakeNVMap
->ConsoleCheck
[Index
+ ConsoleErrMenu
.MenuNumber
];
705 Var_UpdateErrorOutOption ();
708 case FORM_DRV_ADD_HANDLE_DESC_ID
:
709 Status
= Var_UpdateDriverOption (
711 Private
->BmmHiiHandle
,
712 CurrentFakeNVMap
->DriverAddHandleDesc
,
713 CurrentFakeNVMap
->DriverAddHandleOptionalData
,
714 CurrentFakeNVMap
->DriverAddForceReconnect
716 if (EFI_ERROR (Status
)) {
720 BOpt_GetDriverOptions (Private
);
721 CreateMenuStringToken (Private
, Private
->BmmHiiHandle
, &DriverOptionMenu
);
733 Discard all changes done to the BMM pages such as Boot Order change,
736 @param Private The BMM context data.
737 @param CurrentFakeNVMap The current Fack NV Map.
741 DiscardChangeHandler (
742 IN BMM_CALLBACK_DATA
*Private
,
743 IN BMM_FAKE_NV_DATA
*CurrentFakeNVMap
748 switch (Private
->BmmPreviousPageId
) {
749 case FORM_BOOT_CHG_ID
:
750 case FORM_DRV_CHG_ID
:
751 CopyMem (CurrentFakeNVMap
->OptionOrder
, Private
->BmmOldFakeNVData
.OptionOrder
, 100);
754 case FORM_BOOT_DEL_ID
:
755 ASSERT (BootOptionMenu
.MenuNumber
<= (sizeof (CurrentFakeNVMap
->BootOptionDel
) / sizeof (CurrentFakeNVMap
->BootOptionDel
[0])));
756 for (Index
= 0; Index
< BootOptionMenu
.MenuNumber
; Index
++) {
757 CurrentFakeNVMap
->BootOptionDel
[Index
] = 0x00;
761 case FORM_DRV_DEL_ID
:
762 ASSERT (DriverOptionMenu
.MenuNumber
<= (sizeof (CurrentFakeNVMap
->DriverOptionDel
) / sizeof (CurrentFakeNVMap
->DriverOptionDel
[0])));
763 for (Index
= 0; Index
< DriverOptionMenu
.MenuNumber
; Index
++) {
764 CurrentFakeNVMap
->DriverOptionDel
[Index
] = 0x00;
768 case FORM_BOOT_NEXT_ID
:
769 CurrentFakeNVMap
->BootNext
= Private
->BmmOldFakeNVData
.BootNext
;
772 case FORM_TIME_OUT_ID
:
773 CurrentFakeNVMap
->BootTimeOut
= Private
->BmmOldFakeNVData
.BootTimeOut
;
776 case FORM_DRV_ADD_HANDLE_DESC_ID
:
777 case FORM_DRV_ADD_FILE_ID
:
778 case FORM_DRV_ADD_HANDLE_ID
:
779 CurrentFakeNVMap
->DriverAddHandleDesc
[0] = 0x0000;
780 CurrentFakeNVMap
->DriverAddHandleOptionalData
[0] = 0x0000;
789 Initialize the Boot Maintenance Utitliy.
792 @retval EFI_SUCCESS utility ended successfully
793 @retval others contain some errors
801 EFI_LEGACY_BIOS_PROTOCOL
*LegacyBios
;
802 EFI_HII_PACKAGE_LIST_HEADER
*PackageList
;
803 BMM_CALLBACK_DATA
*BmmCallbackInfo
;
807 Status
= EFI_SUCCESS
;
810 // Create CallbackData structures for Driver Callback
812 BmmCallbackInfo
= AllocateZeroPool (sizeof (BMM_CALLBACK_DATA
));
813 if (BmmCallbackInfo
== NULL
) {
814 return EFI_OUT_OF_RESOURCES
;
818 // Create LoadOption in BmmCallbackInfo for Driver Callback
820 Ptr
= AllocateZeroPool (sizeof (BM_LOAD_CONTEXT
) + sizeof (BM_FILE_CONTEXT
) + sizeof (BM_HANDLE_CONTEXT
) + sizeof (BM_MENU_ENTRY
));
822 FreePool (BmmCallbackInfo
);
823 return EFI_OUT_OF_RESOURCES
;
827 // Initialize Bmm callback data.
829 BmmCallbackInfo
->LoadContext
= (BM_LOAD_CONTEXT
*) Ptr
;
830 Ptr
+= sizeof (BM_LOAD_CONTEXT
);
832 BmmCallbackInfo
->FileContext
= (BM_FILE_CONTEXT
*) Ptr
;
833 Ptr
+= sizeof (BM_FILE_CONTEXT
);
835 BmmCallbackInfo
->HandleContext
= (BM_HANDLE_CONTEXT
*) Ptr
;
836 Ptr
+= sizeof (BM_HANDLE_CONTEXT
);
838 BmmCallbackInfo
->MenuEntry
= (BM_MENU_ENTRY
*) Ptr
;
840 BmmCallbackInfo
->Signature
= BMM_CALLBACK_DATA_SIGNATURE
;
841 BmmCallbackInfo
->BmmConfigAccess
.ExtractConfig
= BootMaintExtractConfig
;
842 BmmCallbackInfo
->BmmConfigAccess
.RouteConfig
= FakeRouteConfig
;
843 BmmCallbackInfo
->BmmConfigAccess
.Callback
= BootMaintCallback
;
844 BmmCallbackInfo
->BmmPreviousPageId
= FORM_MAIN_ID
;
845 BmmCallbackInfo
->BmmCurrentPageId
= FORM_MAIN_ID
;
846 BmmCallbackInfo
->FeConfigAccess
.ExtractConfig
= FakeExtractConfig
;
847 BmmCallbackInfo
->FeConfigAccess
.RouteConfig
= FakeRouteConfig
;
848 BmmCallbackInfo
->FeConfigAccess
.Callback
= FileExplorerCallback
;
849 BmmCallbackInfo
->FeCurrentState
= INACTIVE_STATE
;
850 BmmCallbackInfo
->FeDisplayContext
= UNKNOWN_CONTEXT
;
853 // Create driver handle used by HII database
855 Status
= HiiLibCreateHiiDriverHandle (&BmmCallbackInfo
->BmmDriverHandle
);
856 if (EFI_ERROR (Status
)) {
861 // Install Config Access protocol to driver handle
863 Status
= gBS
->InstallProtocolInterface (
864 &BmmCallbackInfo
->BmmDriverHandle
,
865 &gEfiHiiConfigAccessProtocolGuid
,
866 EFI_NATIVE_INTERFACE
,
867 &BmmCallbackInfo
->BmmConfigAccess
869 if (EFI_ERROR (Status
)) {
874 // Create driver handle used by HII database
876 Status
= HiiLibCreateHiiDriverHandle (&BmmCallbackInfo
->FeDriverHandle
);
877 if (EFI_ERROR (Status
)) {
882 // Install Config Access protocol to driver handle
884 Status
= gBS
->InstallProtocolInterface (
885 &BmmCallbackInfo
->FeDriverHandle
,
886 &gEfiHiiConfigAccessProtocolGuid
,
887 EFI_NATIVE_INTERFACE
,
888 &BmmCallbackInfo
->FeConfigAccess
890 if (EFI_ERROR (Status
)) {
895 // Post our Boot Maint VFR binnary to the HII database.
897 PackageList
= HiiLibPreparePackageList (2, &mBootMaintGuid
, BmBin
, BdsDxeStrings
);
898 ASSERT (PackageList
!= NULL
);
900 Status
= gHiiDatabase
->NewPackageList (
903 BmmCallbackInfo
->BmmDriverHandle
,
904 &BmmCallbackInfo
->BmmHiiHandle
906 FreePool (PackageList
);
909 // Post our File Explorer VFR binary to the HII database.
911 PackageList
= HiiLibPreparePackageList (2, &mFileExplorerGuid
, FEBin
, BdsDxeStrings
);
912 ASSERT (PackageList
!= NULL
);
914 Status
= gHiiDatabase
->NewPackageList (
917 BmmCallbackInfo
->FeDriverHandle
,
918 &BmmCallbackInfo
->FeHiiHandle
920 FreePool (PackageList
);
923 // Allocate space for creation of Buffer
925 gUpdateData
.BufferSize
= UPDATE_DATA_SIZE
;
926 gUpdateData
.Data
= AllocateZeroPool (UPDATE_DATA_SIZE
);
927 if (gUpdateData
.Data
== NULL
) {
928 FreePool (BmmCallbackInfo
->LoadContext
);
929 FreePool (BmmCallbackInfo
);
930 return EFI_OUT_OF_RESOURCES
;
933 InitializeStringDepository ();
935 InitAllMenu (BmmCallbackInfo
);
937 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &ConsoleInpMenu
);
938 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &ConsoleOutMenu
);
939 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &ConsoleErrMenu
);
940 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &BootOptionMenu
);
941 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &DriverOptionMenu
);
942 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &TerminalMenu
);
943 CreateMenuStringToken (BmmCallbackInfo
, BmmCallbackInfo
->BmmHiiHandle
, &DriverMenu
);
945 UpdateBootDelPage (BmmCallbackInfo
);
946 UpdateDrvDelPage (BmmCallbackInfo
);
948 if (TerminalMenu
.MenuNumber
> 0) {
949 BmmCallbackInfo
->CurrentTerminal
= 0;
950 UpdateTerminalPage (BmmCallbackInfo
);
953 Status
= EfiLibLocateProtocol (&gEfiLegacyBiosProtocolGuid
, (VOID
**) &LegacyBios
);
954 if (!EFI_ERROR (Status
)) {
955 RefreshUpdateData ();
958 // If LegacyBios Protocol is installed, add 3 tags about legacy boot option
959 // in BootOption form: legacy FD/HD/CD/NET/BEV
962 FORM_SET_FD_ORDER_ID
,
963 STRING_TOKEN (STR_FORM_SET_FD_ORDER_TITLE
),
964 STRING_TOKEN (STR_FORM_SET_FD_ORDER_TITLE
),
965 EFI_IFR_FLAG_CALLBACK
,
966 FORM_SET_FD_ORDER_ID
,
971 FORM_SET_HD_ORDER_ID
,
972 STRING_TOKEN (STR_FORM_SET_HD_ORDER_TITLE
),
973 STRING_TOKEN (STR_FORM_SET_HD_ORDER_TITLE
),
974 EFI_IFR_FLAG_CALLBACK
,
975 FORM_SET_HD_ORDER_ID
,
980 FORM_SET_CD_ORDER_ID
,
981 STRING_TOKEN (STR_FORM_SET_CD_ORDER_TITLE
),
982 STRING_TOKEN (STR_FORM_SET_CD_ORDER_TITLE
),
983 EFI_IFR_FLAG_CALLBACK
,
984 FORM_SET_CD_ORDER_ID
,
989 FORM_SET_NET_ORDER_ID
,
990 STRING_TOKEN (STR_FORM_SET_NET_ORDER_TITLE
),
991 STRING_TOKEN (STR_FORM_SET_NET_ORDER_TITLE
),
992 EFI_IFR_FLAG_CALLBACK
,
993 FORM_SET_NET_ORDER_ID
,
998 FORM_SET_BEV_ORDER_ID
,
999 STRING_TOKEN (STR_FORM_SET_BEV_ORDER_TITLE
),
1000 STRING_TOKEN (STR_FORM_SET_BEV_ORDER_TITLE
),
1001 EFI_IFR_FLAG_CALLBACK
,
1002 FORM_SET_BEV_ORDER_ID
,
1007 BmmCallbackInfo
->BmmHiiHandle
,
1010 FORM_BOOT_LEGACY_DEVICE_ID
,
1017 // Dispatch BMM main formset and File Explorer formset.
1019 FormSetDispatcher (BmmCallbackInfo
);
1022 // Remove our IFR data from HII database
1024 gHiiDatabase
->RemovePackageList (gHiiDatabase
, BmmCallbackInfo
->BmmHiiHandle
);
1025 gHiiDatabase
->RemovePackageList (gHiiDatabase
, BmmCallbackInfo
->FeHiiHandle
);
1027 CleanUpStringDepository ();
1031 FreePool (BmmCallbackInfo
->LoadContext
);
1032 FreePool (BmmCallbackInfo
);
1033 FreePool (gUpdateData
.Data
);
1034 gUpdateData
.Data
= NULL
;
1040 Initialized all Menu Option List.
1042 @param CallbackData The BMM context data.
1047 IN BMM_CALLBACK_DATA
*CallbackData
1050 InitializeListHead (&BootOptionMenu
.Head
);
1051 InitializeListHead (&DriverOptionMenu
.Head
);
1052 BOpt_GetBootOptions (CallbackData
);
1053 BOpt_GetDriverOptions (CallbackData
);
1054 BOpt_GetLegacyOptions ();
1055 InitializeListHead (&FsOptionMenu
.Head
);
1056 BOpt_FindDrivers ();
1057 InitializeListHead (&DirectoryMenu
.Head
);
1058 InitializeListHead (&ConsoleInpMenu
.Head
);
1059 InitializeListHead (&ConsoleOutMenu
.Head
);
1060 InitializeListHead (&ConsoleErrMenu
.Head
);
1061 InitializeListHead (&TerminalMenu
.Head
);
1067 Free up all Menu Option list.
1075 BOpt_FreeMenu (&DirectoryMenu
);
1076 BOpt_FreeMenu (&FsOptionMenu
);
1077 BOpt_FreeMenu (&BootOptionMenu
);
1078 BOpt_FreeMenu (&DriverOptionMenu
);
1079 BOpt_FreeMenu (&DriverMenu
);
1080 BOpt_FreeLegacyOptions ();
1085 Intialize all the string depositories.
1089 InitializeStringDepository (
1093 STRING_DEPOSITORY
*StringDepository
;
1094 StringDepository
= AllocateZeroPool (sizeof (STRING_DEPOSITORY
) * STRING_DEPOSITORY_NUMBER
);
1095 FileOptionStrDepository
= StringDepository
++;
1096 ConsoleOptionStrDepository
= StringDepository
++;
1097 BootOptionStrDepository
= StringDepository
++;
1098 BootOptionHelpStrDepository
= StringDepository
++;
1099 DriverOptionStrDepository
= StringDepository
++;
1100 DriverOptionHelpStrDepository
= StringDepository
++;
1101 TerminalStrDepository
= StringDepository
;
1105 Fetch a usable string node from the string depository and return the string token.
1107 @param CallbackData The BMM context data.
1108 @param StringDepository The string repository.
1110 @retval EFI_STRING_ID String token.
1114 GetStringTokenFromDepository (
1115 IN BMM_CALLBACK_DATA
*CallbackData
,
1116 IN STRING_DEPOSITORY
*StringDepository
1119 STRING_LIST_NODE
*CurrentListNode
;
1120 STRING_LIST_NODE
*NextListNode
;
1122 CurrentListNode
= StringDepository
->CurrentNode
;
1124 if ((NULL
!= CurrentListNode
) && (NULL
!= CurrentListNode
->Next
)) {
1126 // Fetch one reclaimed node from the list.
1128 NextListNode
= StringDepository
->CurrentNode
->Next
;
1131 // If there is no usable node in the list, update the list.
1133 NextListNode
= AllocateZeroPool (sizeof (STRING_LIST_NODE
));
1134 ASSERT (NextListNode
!= NULL
);
1135 HiiLibNewString (CallbackData
->BmmHiiHandle
, &(NextListNode
->StringToken
), L
" ");
1136 ASSERT (NextListNode
->StringToken
!= 0);
1138 StringDepository
->TotalNodeNumber
++;
1140 if (NULL
== CurrentListNode
) {
1141 StringDepository
->ListHead
= NextListNode
;
1143 CurrentListNode
->Next
= NextListNode
;
1147 StringDepository
->CurrentNode
= NextListNode
;
1149 return StringDepository
->CurrentNode
->StringToken
;
1153 Reclaim string depositories by moving the current node pointer to list head..
1157 ReclaimStringDepository (
1161 UINTN DepositoryIndex
;
1162 STRING_DEPOSITORY
*StringDepository
;
1164 StringDepository
= FileOptionStrDepository
;
1165 for (DepositoryIndex
= 0; DepositoryIndex
< STRING_DEPOSITORY_NUMBER
; DepositoryIndex
++) {
1166 StringDepository
->CurrentNode
= StringDepository
->ListHead
;
1172 Release resource for all the string depositories.
1176 CleanUpStringDepository (
1181 UINTN DepositoryIndex
;
1182 STRING_LIST_NODE
*CurrentListNode
;
1183 STRING_LIST_NODE
*NextListNode
;
1184 STRING_DEPOSITORY
*StringDepository
;
1187 // Release string list nodes.
1189 StringDepository
= FileOptionStrDepository
;
1190 for (DepositoryIndex
= 0; DepositoryIndex
< STRING_DEPOSITORY_NUMBER
; DepositoryIndex
++) {
1191 CurrentListNode
= StringDepository
->ListHead
;
1192 for (NodeIndex
= 0; NodeIndex
< StringDepository
->TotalNodeNumber
; NodeIndex
++) {
1193 NextListNode
= CurrentListNode
->Next
;
1194 FreePool (CurrentListNode
);
1195 CurrentListNode
= NextListNode
;
1201 // Release string depository.
1203 FreePool (FileOptionStrDepository
);
1207 Start boot maintenance manager
1209 @retval EFI_SUCCESS If BMM is invoked successfully.
1210 @return Other value if BMM return unsuccessfully.
1219 LIST_ENTRY BdsBootOptionList
;
1221 InitializeListHead (&BdsBootOptionList
);
1224 // Connect all prior to entering the platform setup menu.
1226 if (!gConnectAllHappened
) {
1227 BdsLibConnectAllDriversToAllControllers ();
1228 gConnectAllHappened
= TRUE
;
1231 // Have chance to enumerate boot device
1233 BdsLibEnumerateAllBootOption (&BdsBootOptionList
);
1238 Status
= InitializeBM ();
1244 Dispatch BMM formset and FileExplorer formset.
1247 @param CallbackData The BMM context data.
1249 @retval EFI_SUCCESS If function complete successfully.
1250 @return Other value if the Setup Browser process BMM's pages and
1251 return unsuccessfully.
1256 IN BMM_CALLBACK_DATA
*CallbackData
1260 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
1263 UpdatePageId (CallbackData
, FORM_MAIN_ID
);
1265 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1266 Status
= gFormBrowser2
->SendForm (
1268 &CallbackData
->BmmHiiHandle
,
1275 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
1276 EnableResetRequired ();
1279 ReclaimStringDepository ();
1282 // When this Formset returns, check if we are going to explore files.
1284 if (INACTIVE_STATE
!= CallbackData
->FeCurrentState
) {
1285 UpdateFileExplorer (CallbackData
, 0);
1287 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
1288 Status
= gFormBrowser2
->SendForm (
1290 &CallbackData
->FeHiiHandle
,
1297 if (ActionRequest
== EFI_BROWSER_ACTION_REQUEST_RESET
) {
1298 EnableResetRequired ();
1301 CallbackData
->FeCurrentState
= INACTIVE_STATE
;
1302 CallbackData
->FeDisplayContext
= UNKNOWN_CONTEXT
;
1303 ReclaimStringDepository ();
1314 Deletete the Boot Option from EFI Variable. The Boot Order Arrray
1317 @param OptionNumber The number of Boot option want to be deleted.
1318 @param BootOrder The Boot Order array.
1319 @param BootOrderSize The size of the Boot Order Array.
1321 @return Other value if the Boot Option specified by OptionNumber is not deleteed succesfully.
1322 @retval EFI_SUCCESS If function return successfully.
1326 BdsDeleteBootOption (
1327 IN UINTN OptionNumber
,
1328 IN OUT UINT16
*BootOrder
,
1329 IN OUT UINTN
*BootOrderSize
1332 UINT16 BootOption
[100];
1337 Status
= EFI_SUCCESS
;
1340 UnicodeSPrint (BootOption
, sizeof (BootOption
), L
"Boot%04x", OptionNumber
);
1341 Status
= EfiLibDeleteVariable (BootOption
, &gEfiGlobalVariableGuid
);
1344 // adjust boot order array
1346 for (Index
= 0; Index
< *BootOrderSize
/ sizeof (UINT16
); Index
++) {
1347 if (BootOrder
[Index
] == OptionNumber
) {
1353 if (Index
!= *BootOrderSize
/ sizeof (UINT16
)) {
1354 for (Index
= 0; Index
< *BootOrderSize
/ sizeof (UINT16
) - 1; Index
++) {
1355 if (Index
>= Index2Del
) {
1356 BootOrder
[Index
] = BootOrder
[Index
+ 1];
1360 *BootOrderSize
-= sizeof (UINT16
);