2 Variable operation that will be used by bootmaint
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 Delete Boot Option that represent a Deleted state in BootOptionMenu.
19 After deleting this boot option, call Var_ChangeBootOrder to
20 make sure BootOrder is in valid state.
22 @retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
23 BM_LOAD_CONTEXT marked for deletion is deleted.
24 @retval EFI_NOT_FOUND If can not find the boot option want to be deleted.
25 @return Others If failed to update the "BootOrder" variable after deletion.
33 BM_MENU_ENTRY
*NewMenuEntry
;
34 BM_LOAD_CONTEXT
*NewLoadContext
;
35 UINT16 BootString
[10];
42 for (Index
= 0; Index
< BootOptionMenu
.MenuNumber
; Index
++) {
43 NewMenuEntry
= BOpt_GetMenuEntry (&BootOptionMenu
, (Index
- Index2
));
44 if (NULL
== NewMenuEntry
) {
48 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
49 if (!NewLoadContext
->Deleted
) {
57 NewMenuEntry
->OptionNumber
60 EfiLibDeleteVariable (BootString
, &gEfiGlobalVariableGuid
);
63 // If current Load Option is the same as BootNext,
64 // must delete BootNext in order to make sure
65 // there will be no panic on next boot
67 if (NewLoadContext
->IsBootNext
) {
68 EfiLibDeleteVariable (L
"BootNext", &gEfiGlobalVariableGuid
);
71 RemoveEntryList (&NewMenuEntry
->Link
);
72 BOpt_DestroyMenuEntry (NewMenuEntry
);
76 BootOptionMenu
.MenuNumber
-= Index2
;
78 Status
= Var_ChangeBootOrder ();
83 After any operation on Boot####, there will be a discrepancy in BootOrder.
84 Since some are missing but in BootOrder, while some are present but are
85 not reflected by BootOrder. Then a function rebuild BootOrder from
86 scratch by content from BootOptionMenu is needed.
91 @retval EFI_SUCCESS The boot order is updated successfully.
92 @return EFI_STATUS other than EFI_SUCCESS if failed to
93 Set the "BootOrder" EFI Variable.
103 BM_MENU_ENTRY
*NewMenuEntry
;
104 UINT16
*BootOrderList
;
105 UINT16
*BootOrderListPtr
;
106 UINTN BootOrderListSize
;
109 BootOrderList
= NULL
;
110 BootOrderListSize
= 0;
113 // First check whether BootOrder is present in current configuration
115 BootOrderList
= BdsLibGetVariableAndSize (
117 &gEfiGlobalVariableGuid
,
122 // If exists, delete it to hold new BootOrder
124 if (BootOrderList
!= NULL
) {
125 EfiLibDeleteVariable (L
"BootOrder", &gEfiGlobalVariableGuid
);
126 FreePool (BootOrderList
);
127 BootOrderList
= NULL
;
130 // Maybe here should be some check method to ensure that
131 // no new added boot options will be added
132 // but the setup engine now will give only one callback
133 // that is to say, user are granted only one chance to
134 // decide whether the boot option will be added or not
135 // there should be no indictor to show whether this
136 // is a "new" boot option
138 BootOrderListSize
= BootOptionMenu
.MenuNumber
;
140 if (BootOrderListSize
> 0) {
141 BootOrderList
= AllocateZeroPool (BootOrderListSize
* sizeof (UINT16
));
142 ASSERT (BootOrderList
!= NULL
);
143 BootOrderListPtr
= BootOrderList
;
146 // Get all current used Boot#### from BootOptionMenu.
147 // OptionNumber in each BM_LOAD_OPTION is really its
150 for (Index
= 0; Index
< BootOrderListSize
; Index
++) {
151 NewMenuEntry
= BOpt_GetMenuEntry (&BootOptionMenu
, Index
);
152 *BootOrderList
= (UINT16
) NewMenuEntry
->OptionNumber
;
156 BootOrderList
= BootOrderListPtr
;
159 // After building the BootOrderList, write it back
161 Status
= gRT
->SetVariable (
163 &gEfiGlobalVariableGuid
,
165 BootOrderListSize
* sizeof (UINT16
),
168 if (EFI_ERROR (Status
)) {
176 Delete Load Option that represent a Deleted state in BootOptionMenu.
177 After deleting this Driver option, call Var_ChangeDriverOrder to
178 make sure DriverOrder is in valid state.
180 @retval EFI_SUCCESS Load Option is successfully updated.
181 @retval EFI_NOT_FOUND Fail to find the driver option want to be deleted.
182 @return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
187 Var_DelDriverOption (
191 BM_MENU_ENTRY
*NewMenuEntry
;
192 BM_LOAD_CONTEXT
*NewLoadContext
;
193 UINT16 DriverString
[12];
198 Status
= EFI_SUCCESS
;
200 for (Index
= 0; Index
< DriverOptionMenu
.MenuNumber
; Index
++) {
201 NewMenuEntry
= BOpt_GetMenuEntry (&DriverOptionMenu
, (Index
- Index2
));
202 if (NULL
== NewMenuEntry
) {
203 return EFI_NOT_FOUND
;
206 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
207 if (!NewLoadContext
->Deleted
) {
213 sizeof (DriverString
),
215 NewMenuEntry
->OptionNumber
218 EfiLibDeleteVariable (DriverString
, &gEfiGlobalVariableGuid
);
221 RemoveEntryList (&NewMenuEntry
->Link
);
222 BOpt_DestroyMenuEntry (NewMenuEntry
);
226 DriverOptionMenu
.MenuNumber
-= Index2
;
228 Status
= Var_ChangeDriverOrder ();
233 After any operation on Driver####, there will be a discrepancy in
234 DriverOrder. Since some are missing but in DriverOrder, while some
235 are present but are not reflected by DriverOrder. Then a function
236 rebuild DriverOrder from scratch by content from DriverOptionMenu is
239 @retval EFI_SUCCESS The driver order is updated successfully.
240 @return Other status than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
244 Var_ChangeDriverOrder (
249 BM_MENU_ENTRY
*NewMenuEntry
;
250 UINT16
*DriverOrderList
;
251 UINT16
*DriverOrderListPtr
;
252 UINTN DriverOrderListSize
;
255 DriverOrderList
= NULL
;
256 DriverOrderListSize
= 0;
259 // First check whether DriverOrder is present in current configuration
261 DriverOrderList
= BdsLibGetVariableAndSize (
263 &gEfiGlobalVariableGuid
,
268 // If exists, delete it to hold new DriverOrder
270 if (DriverOrderList
!= NULL
) {
271 EfiLibDeleteVariable (L
"DriverOrder", &gEfiGlobalVariableGuid
);
272 FreePool (DriverOrderList
);
273 DriverOrderList
= NULL
;
276 DriverOrderListSize
= DriverOptionMenu
.MenuNumber
;
278 if (DriverOrderListSize
> 0) {
279 DriverOrderList
= AllocateZeroPool (DriverOrderListSize
* sizeof (UINT16
));
280 ASSERT (DriverOrderList
!= NULL
);
281 DriverOrderListPtr
= DriverOrderList
;
284 // Get all current used Driver#### from DriverOptionMenu.
285 // OptionNumber in each BM_LOAD_OPTION is really its
288 for (Index
= 0; Index
< DriverOrderListSize
; Index
++) {
289 NewMenuEntry
= BOpt_GetMenuEntry (&DriverOptionMenu
, Index
);
290 *DriverOrderList
= (UINT16
) NewMenuEntry
->OptionNumber
;
294 DriverOrderList
= DriverOrderListPtr
;
297 // After building the DriverOrderList, write it back
299 Status
= gRT
->SetVariable (
301 &gEfiGlobalVariableGuid
,
303 DriverOrderListSize
* sizeof (UINT16
),
306 if (EFI_ERROR (Status
)) {
314 Update the device path of "ConOut", "ConIn" and "ErrOut"
315 based on the new BaudRate, Data Bits, parity and Stop Bits
320 Var_UpdateAllConsoleOption (
324 EFI_DEVICE_PATH_PROTOCOL
*OutDevicePath
;
325 EFI_DEVICE_PATH_PROTOCOL
*InpDevicePath
;
326 EFI_DEVICE_PATH_PROTOCOL
*ErrDevicePath
;
329 OutDevicePath
= EfiLibGetVariable (L
"ConOut", &gEfiGlobalVariableGuid
);
330 InpDevicePath
= EfiLibGetVariable (L
"ConIn", &gEfiGlobalVariableGuid
);
331 ErrDevicePath
= EfiLibGetVariable (L
"ErrOut", &gEfiGlobalVariableGuid
);
332 if (OutDevicePath
!= NULL
) {
333 ChangeVariableDevicePath (OutDevicePath
);
334 Status
= gRT
->SetVariable (
336 &gEfiGlobalVariableGuid
,
338 GetDevicePathSize (OutDevicePath
),
341 ASSERT (!EFI_ERROR (Status
));
344 if (InpDevicePath
!= NULL
) {
345 ChangeVariableDevicePath (InpDevicePath
);
346 Status
= gRT
->SetVariable (
348 &gEfiGlobalVariableGuid
,
350 GetDevicePathSize (InpDevicePath
),
353 ASSERT (!EFI_ERROR (Status
));
356 if (ErrDevicePath
!= NULL
) {
357 ChangeVariableDevicePath (ErrDevicePath
);
358 Status
= gRT
->SetVariable (
360 &gEfiGlobalVariableGuid
,
362 GetDevicePathSize (ErrDevicePath
),
365 ASSERT (!EFI_ERROR (Status
));
370 This function delete and build multi-instance device path for
371 specified type of console device.
373 This function clear the EFI variable defined by ConsoleName and
374 gEfiGlobalVariableGuid. It then build the multi-instance device
375 path by appending the device path of the Console (In/Out/Err) instance
376 in ConsoleMenu. Then it scan all corresponding console device by
377 scanning Terminal (built from device supporting Serial I/O instances)
378 devices in TerminalMenu. At last, it save a EFI variable specifed
379 by ConsoleName and gEfiGlobalVariableGuid.
381 @param ConsoleName The name for the console device type. They are
382 usually "ConIn", "ConOut" and "ErrOut".
383 @param ConsoleMenu The console memu which is a list of console devices.
384 @param UpdatePageId The flag specifying which type of console device
387 @retval EFI_SUCCESS The function complete successfully.
388 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
392 Var_UpdateConsoleOption (
393 IN UINT16
*ConsoleName
,
394 IN BM_MENU_OPTION
*ConsoleMenu
,
395 IN UINT16 UpdatePageId
398 EFI_DEVICE_PATH_PROTOCOL
*ConDevicePath
;
399 BM_MENU_ENTRY
*NewMenuEntry
;
400 BM_CONSOLE_CONTEXT
*NewConsoleContext
;
401 BM_TERMINAL_CONTEXT
*NewTerminalContext
;
403 VENDOR_DEVICE_PATH Vendor
;
404 EFI_DEVICE_PATH_PROTOCOL
*TerminalDevicePath
;
407 ConDevicePath
= EfiLibGetVariable (ConsoleName
, &gEfiGlobalVariableGuid
);
408 if (ConDevicePath
!= NULL
) {
409 EfiLibDeleteVariable (ConsoleName
, &gEfiGlobalVariableGuid
);
410 FreePool (ConDevicePath
);
411 ConDevicePath
= NULL
;
415 // First add all console input device from console input menu
417 for (Index
= 0; Index
< ConsoleMenu
->MenuNumber
; Index
++) {
418 NewMenuEntry
= BOpt_GetMenuEntry (ConsoleMenu
, Index
);
420 NewConsoleContext
= (BM_CONSOLE_CONTEXT
*) NewMenuEntry
->VariableContext
;
421 if (NewConsoleContext
->IsActive
) {
422 ConDevicePath
= AppendDevicePathInstance (
424 NewConsoleContext
->DevicePath
429 for (Index
= 0; Index
< TerminalMenu
.MenuNumber
; Index
++) {
430 NewMenuEntry
= BOpt_GetMenuEntry (&TerminalMenu
, Index
);
432 NewTerminalContext
= (BM_TERMINAL_CONTEXT
*) NewMenuEntry
->VariableContext
;
433 if (((NewTerminalContext
->IsConIn
!= 0) && (UpdatePageId
== FORM_CON_IN_ID
)) ||
434 ((NewTerminalContext
->IsConOut
!= 0) && (UpdatePageId
== FORM_CON_OUT_ID
)) ||
435 ((NewTerminalContext
->IsStdErr
!= 0) && (UpdatePageId
== FORM_CON_ERR_ID
))
437 Vendor
.Header
.Type
= MESSAGING_DEVICE_PATH
;
438 Vendor
.Header
.SubType
= MSG_VENDOR_DP
;
440 ASSERT (NewTerminalContext
->TerminalType
< (sizeof (TerminalTypeGuid
) / sizeof (TerminalTypeGuid
[0])));
443 &TerminalTypeGuid
[NewTerminalContext
->TerminalType
],
446 SetDevicePathNodeLength (&Vendor
.Header
, sizeof (VENDOR_DEVICE_PATH
));
447 TerminalDevicePath
= AppendDevicePathNode (
448 NewTerminalContext
->DevicePath
,
449 (EFI_DEVICE_PATH_PROTOCOL
*) &Vendor
451 ASSERT (TerminalDevicePath
!= NULL
);
452 ChangeTerminalDevicePath (TerminalDevicePath
, TRUE
);
453 ConDevicePath
= AppendDevicePathInstance (
460 if (ConDevicePath
!= NULL
) {
461 Status
= gRT
->SetVariable (
463 &gEfiGlobalVariableGuid
,
465 GetDevicePathSize (ConDevicePath
),
468 if (EFI_ERROR (Status
)) {
478 This function delete and build multi-instance device path ConIn
481 @retval EFI_SUCCESS The function complete successfully.
482 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
485 Var_UpdateConsoleInpOption (
489 return Var_UpdateConsoleOption (L
"ConIn", &ConsoleInpMenu
, FORM_CON_IN_ID
);
493 This function delete and build multi-instance device path ConOut
496 @retval EFI_SUCCESS The function complete successfully.
497 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
500 Var_UpdateConsoleOutOption (
504 return Var_UpdateConsoleOption (L
"ConOut", &ConsoleOutMenu
, FORM_CON_OUT_ID
);
508 This function delete and build multi-instance device path ErrOut
511 @retval EFI_SUCCESS The function complete successfully.
512 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
515 Var_UpdateErrorOutOption (
519 return Var_UpdateConsoleOption (L
"ErrOut", &ConsoleErrMenu
, FORM_CON_ERR_ID
);
523 This function create a currently loaded Drive Option from
524 the BMM. It then appends this Driver Option to the end of
525 the "DriverOrder" list. It append this Driver Opotion to the end
528 @param CallbackData The BMM context data.
529 @param HiiHandle The HII handle associated with the BMM formset.
530 @param DescriptionData The description of this driver option.
531 @param OptionalData The optional load option.
532 @param ForceReconnect If to force reconnect.
534 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
535 @retval EFI_SUCCESS If function completes successfully.
539 Var_UpdateDriverOption (
540 IN BMM_CALLBACK_DATA
*CallbackData
,
541 IN EFI_HII_HANDLE HiiHandle
,
542 IN UINT16
*DescriptionData
,
543 IN UINT16
*OptionalData
,
544 IN UINT8 ForceReconnect
548 UINT16
*DriverOrderList
;
549 UINT16
*NewDriverOrderList
;
550 UINT16 DriverString
[12];
551 UINTN DriverOrderListSize
;
555 BM_MENU_ENTRY
*NewMenuEntry
;
556 BM_LOAD_CONTEXT
*NewLoadContext
;
557 BOOLEAN OptionalDataExist
;
560 OptionalDataExist
= FALSE
;
562 Index
= BOpt_GetDriverOptionNumber ();
565 sizeof (DriverString
),
570 if (*DescriptionData
== 0x0000) {
571 StrCpy (DescriptionData
, DriverString
);
574 BufferSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (DescriptionData
);
575 BufferSize
+= GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
577 if (*OptionalData
!= 0x0000) {
578 OptionalDataExist
= TRUE
;
579 BufferSize
+= StrSize (OptionalData
);
582 Buffer
= AllocateZeroPool (BufferSize
);
583 if (NULL
== Buffer
) {
584 return EFI_OUT_OF_RESOURCES
;
587 NewMenuEntry
= BOpt_CreateMenuEntry (BM_LOAD_CONTEXT_SELECT
);
588 if (NULL
== NewMenuEntry
) {
590 return EFI_OUT_OF_RESOURCES
;
593 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
594 NewLoadContext
->Deleted
= FALSE
;
595 NewLoadContext
->LoadOptionSize
= BufferSize
;
596 Ptr
= (UINT8
*) Buffer
;
597 NewLoadContext
->LoadOption
= Ptr
;
598 *((UINT32
*) Ptr
) = LOAD_OPTION_ACTIVE
| (ForceReconnect
<< 1);
599 NewLoadContext
->Attributes
= *((UINT32
*) Ptr
);
600 NewLoadContext
->IsActive
= TRUE
;
601 NewLoadContext
->ForceReconnect
= (BOOLEAN
) (NewLoadContext
->Attributes
& LOAD_OPTION_FORCE_RECONNECT
);
603 Ptr
+= sizeof (UINT32
);
604 *((UINT16
*) Ptr
) = (UINT16
) GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
605 NewLoadContext
->FilePathListLength
= *((UINT16
*) Ptr
);
607 Ptr
+= sizeof (UINT16
);
611 StrSize (DescriptionData
)
614 NewLoadContext
->Description
= AllocateZeroPool (StrSize (DescriptionData
));
615 ASSERT (NewLoadContext
->Description
!= NULL
);
616 NewMenuEntry
->DisplayString
= NewLoadContext
->Description
;
618 NewLoadContext
->Description
,
620 StrSize (DescriptionData
)
623 Ptr
+= StrSize (DescriptionData
);
626 CallbackData
->LoadContext
->FilePathList
,
627 GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
)
630 NewLoadContext
->FilePathList
= AllocateZeroPool (GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
));
631 ASSERT (NewLoadContext
->FilePathList
!= NULL
);
634 NewLoadContext
->FilePathList
,
636 GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
)
639 NewMenuEntry
->HelpString
= DevicePathToStr (NewLoadContext
->FilePathList
);
640 NewMenuEntry
->OptionNumber
= Index
;
641 NewMenuEntry
->DisplayStringToken
= GetStringTokenFromDepository (
643 DriverOptionStrDepository
645 NewMenuEntry
->DisplayStringToken
= HiiSetString (HiiHandle
, 0, NewMenuEntry
->DisplayString
, NULL
);
647 NewMenuEntry
->HelpStringToken
= GetStringTokenFromDepository (
649 DriverOptionHelpStrDepository
651 NewMenuEntry
->HelpStringToken
= HiiSetString (HiiHandle
, 0, NewMenuEntry
->HelpString
, NULL
);
653 if (OptionalDataExist
) {
654 Ptr
+= (UINT8
) GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
659 StrSize (OptionalData
)
663 Status
= gRT
->SetVariable (
665 &gEfiGlobalVariableGuid
,
670 ASSERT_EFI_ERROR (Status
);
671 DriverOrderList
= BdsLibGetVariableAndSize (
673 &gEfiGlobalVariableGuid
,
676 NewDriverOrderList
= AllocateZeroPool (DriverOrderListSize
+ sizeof (UINT16
));
677 ASSERT (NewDriverOrderList
!= NULL
);
678 CopyMem (NewDriverOrderList
, DriverOrderList
, DriverOrderListSize
);
679 NewDriverOrderList
[DriverOrderListSize
/ sizeof (UINT16
)] = Index
;
680 if (DriverOrderList
!= NULL
) {
681 EfiLibDeleteVariable (L
"DriverOrder", &gEfiGlobalVariableGuid
);
684 Status
= gRT
->SetVariable (
686 &gEfiGlobalVariableGuid
,
688 DriverOrderListSize
+ sizeof (UINT16
),
691 ASSERT_EFI_ERROR (Status
);
692 if (DriverOrderList
!= NULL
) {
693 FreePool (DriverOrderList
);
695 DriverOrderList
= NULL
;
696 FreePool (NewDriverOrderList
);
697 InsertTailList (&DriverOptionMenu
.Head
, &NewMenuEntry
->Link
);
698 DriverOptionMenu
.MenuNumber
++;
700 *DescriptionData
= 0x0000;
701 *OptionalData
= 0x0000;
706 This function create a currently loaded Boot Option from
707 the BMM. It then appends this Boot Option to the end of
708 the "BootOrder" list. It also append this Boot Opotion to the end
711 @param CallbackData The BMM context data.
712 @param NvRamMap The file explorer formset internal state.
714 @retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
715 @retval EFI_SUCCESS If function completes successfully.
719 Var_UpdateBootOption (
720 IN BMM_CALLBACK_DATA
*CallbackData
,
721 IN FILE_EXPLORER_NV_DATA
*NvRamMap
724 UINT16
*BootOrderList
;
725 UINT16
*NewBootOrderList
;
726 UINTN BootOrderListSize
;
727 UINT16 BootString
[10];
732 BM_MENU_ENTRY
*NewMenuEntry
;
733 BM_LOAD_CONTEXT
*NewLoadContext
;
734 BOOLEAN OptionalDataExist
;
737 OptionalDataExist
= FALSE
;
739 Index
= BOpt_GetBootOptionNumber () ;
740 UnicodeSPrint (BootString
, sizeof (BootString
), L
"Boot%04x", Index
);
742 if (NvRamMap
->DescriptionData
[0] == 0x0000) {
743 StrCpy (NvRamMap
->DescriptionData
, BootString
);
746 BufferSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (NvRamMap
->DescriptionData
);
747 BufferSize
+= GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
749 if (NvRamMap
->OptionalData
[0] != 0x0000) {
750 OptionalDataExist
= TRUE
;
751 BufferSize
+= StrSize (NvRamMap
->OptionalData
);
754 Buffer
= AllocateZeroPool (BufferSize
);
755 if (NULL
== Buffer
) {
756 return EFI_OUT_OF_RESOURCES
;
759 NewMenuEntry
= BOpt_CreateMenuEntry (BM_LOAD_CONTEXT_SELECT
);
760 if (NULL
== NewMenuEntry
) {
761 return EFI_OUT_OF_RESOURCES
;
764 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
765 NewLoadContext
->Deleted
= FALSE
;
766 NewLoadContext
->LoadOptionSize
= BufferSize
;
767 Ptr
= (UINT8
*) Buffer
;
768 NewLoadContext
->LoadOption
= Ptr
;
769 *((UINT32
*) Ptr
) = LOAD_OPTION_ACTIVE
;
770 NewLoadContext
->Attributes
= *((UINT32
*) Ptr
);
771 NewLoadContext
->IsActive
= TRUE
;
772 NewLoadContext
->ForceReconnect
= (BOOLEAN
) (NewLoadContext
->Attributes
& LOAD_OPTION_FORCE_RECONNECT
);
774 Ptr
+= sizeof (UINT32
);
775 *((UINT16
*) Ptr
) = (UINT16
) GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
776 NewLoadContext
->FilePathListLength
= *((UINT16
*) Ptr
);
777 Ptr
+= sizeof (UINT16
);
781 NvRamMap
->DescriptionData
,
782 StrSize (NvRamMap
->DescriptionData
)
785 NewLoadContext
->Description
= AllocateZeroPool (StrSize (NvRamMap
->DescriptionData
));
786 ASSERT (NewLoadContext
->Description
!= NULL
);
788 NewMenuEntry
->DisplayString
= NewLoadContext
->Description
;
790 NewLoadContext
->Description
,
792 StrSize (NvRamMap
->DescriptionData
)
795 Ptr
+= StrSize (NvRamMap
->DescriptionData
);
798 CallbackData
->LoadContext
->FilePathList
,
799 GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
)
802 NewLoadContext
->FilePathList
= AllocateZeroPool (GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
));
803 ASSERT (NewLoadContext
->FilePathList
!= NULL
);
806 NewLoadContext
->FilePathList
,
808 GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
)
811 NewMenuEntry
->HelpString
= DevicePathToStr (NewLoadContext
->FilePathList
);
812 NewMenuEntry
->OptionNumber
= Index
;
813 NewMenuEntry
->DisplayStringToken
= GetStringTokenFromDepository (
815 BootOptionStrDepository
817 NewMenuEntry
->DisplayStringToken
= HiiSetString (CallbackData
->FeHiiHandle
, 0, NewMenuEntry
->DisplayString
, NULL
);
819 NewMenuEntry
->HelpStringToken
= GetStringTokenFromDepository (
821 BootOptionHelpStrDepository
823 NewMenuEntry
->HelpStringToken
= HiiSetString (CallbackData
->FeHiiHandle
, 0, NewMenuEntry
->HelpString
, NULL
);
825 if (OptionalDataExist
) {
826 Ptr
+= (UINT8
) GetDevicePathSize (CallbackData
->LoadContext
->FilePathList
);
828 CopyMem (Ptr
, NvRamMap
->OptionalData
, StrSize (NvRamMap
->OptionalData
));
831 Status
= gRT
->SetVariable (
833 &gEfiGlobalVariableGuid
,
838 ASSERT_EFI_ERROR (Status
);
840 BootOrderList
= BdsLibGetVariableAndSize (
842 &gEfiGlobalVariableGuid
,
846 NewBootOrderList
= AllocateZeroPool (BootOrderListSize
+ sizeof (UINT16
));
847 ASSERT (NewBootOrderList
!= NULL
);
848 CopyMem (NewBootOrderList
, BootOrderList
, BootOrderListSize
);
849 NewBootOrderList
[BootOrderListSize
/ sizeof (UINT16
)] = Index
;
851 if (BootOrderList
!= NULL
) {
852 EfiLibDeleteVariable (L
"BootOrder", &gEfiGlobalVariableGuid
);
853 FreePool (BootOrderList
);
856 Status
= gRT
->SetVariable (
858 &gEfiGlobalVariableGuid
,
860 BootOrderListSize
+ sizeof (UINT16
),
863 ASSERT_EFI_ERROR (Status
);
865 FreePool (NewBootOrderList
);
866 NewBootOrderList
= NULL
;
867 InsertTailList (&BootOptionMenu
.Head
, &NewMenuEntry
->Link
);
868 BootOptionMenu
.MenuNumber
++;
870 NvRamMap
->DescriptionData
[0] = 0x0000;
871 NvRamMap
->OptionalData
[0] = 0x0000;
876 This function update the "BootNext" EFI Variable. If there is
877 no "BootNext" specified in BMM, this EFI Variable is deleted.
878 It also update the BMM context data specified the "BootNext"
881 @param CallbackData The BMM context data.
883 @retval EFI_SUCCESS The function complete successfully.
884 @return The EFI variable can be saved. See gRT->SetVariable
885 for detail return information.
890 IN BMM_CALLBACK_DATA
*CallbackData
893 BM_MENU_ENTRY
*NewMenuEntry
;
894 BM_LOAD_CONTEXT
*NewLoadContext
;
895 BMM_FAKE_NV_DATA
*CurrentFakeNVMap
;
899 Status
= EFI_SUCCESS
;
900 CurrentFakeNVMap
= &CallbackData
->BmmFakeNvData
;
901 for (Index
= 0; Index
< BootOptionMenu
.MenuNumber
; Index
++) {
902 NewMenuEntry
= BOpt_GetMenuEntry (&BootOptionMenu
, Index
);
903 ASSERT (NULL
!= NewMenuEntry
);
905 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
906 NewLoadContext
->IsBootNext
= FALSE
;
909 if (CurrentFakeNVMap
->BootNext
== BootOptionMenu
.MenuNumber
) {
910 EfiLibDeleteVariable (L
"BootNext", &gEfiGlobalVariableGuid
);
914 NewMenuEntry
= BOpt_GetMenuEntry (
916 CurrentFakeNVMap
->BootNext
918 ASSERT (NewMenuEntry
!= NULL
);
920 NewLoadContext
= (BM_LOAD_CONTEXT
*) NewMenuEntry
->VariableContext
;
921 Status
= gRT
->SetVariable (
923 &gEfiGlobalVariableGuid
,
926 &NewMenuEntry
->OptionNumber
928 NewLoadContext
->IsBootNext
= TRUE
;
929 CallbackData
->BmmOldFakeNVData
.BootNext
= CurrentFakeNVMap
->BootNext
;
934 This function update the "BootOrder" EFI Variable based on
935 BMM Formset's NV map. It then refresh BootOptionMenu
936 with the new "BootOrder" list.
938 @param CallbackData The BMM context data.
940 @retval EFI_SUCCESS The function complete successfully.
941 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
942 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
946 Var_UpdateBootOrder (
947 IN BMM_CALLBACK_DATA
*CallbackData
952 UINT16
*BootOrderList
;
953 UINT16
*NewBootOrderList
;
954 UINTN BootOrderListSize
;
956 BootOrderList
= NULL
;
957 BootOrderListSize
= 0;
960 // First check whether BootOrder is present in current configuration
962 BootOrderList
= BdsLibGetVariableAndSize (
964 &gEfiGlobalVariableGuid
,
968 NewBootOrderList
= AllocateZeroPool (BootOrderListSize
);
969 if (NewBootOrderList
== NULL
) {
970 return EFI_OUT_OF_RESOURCES
;
974 // If exists, delete it to hold new BootOrder
976 if (BootOrderList
!= NULL
) {
977 EfiLibDeleteVariable (L
"BootOrder", &gEfiGlobalVariableGuid
);
978 FreePool (BootOrderList
);
981 ASSERT (BootOptionMenu
.MenuNumber
<= (sizeof (CallbackData
->BmmFakeNvData
.OptionOrder
) / sizeof (CallbackData
->BmmFakeNvData
.OptionOrder
[0])));
982 for (Index
= 0; Index
< BootOptionMenu
.MenuNumber
; Index
++) {
983 NewBootOrderList
[Index
] = (UINT16
) (CallbackData
->BmmFakeNvData
.OptionOrder
[Index
] - 1);
986 Status
= gRT
->SetVariable (
988 &gEfiGlobalVariableGuid
,
993 FreePool (NewBootOrderList
);
994 if (EFI_ERROR (Status
)) {
998 BOpt_FreeMenu (&BootOptionMenu
);
999 BOpt_GetBootOptions (CallbackData
);
1006 This function update the "DriverOrder" EFI Variable based on
1007 BMM Formset's NV map. It then refresh DriverOptionMenu
1008 with the new "DriverOrder" list.
1010 @param CallbackData The BMM context data.
1012 @retval EFI_SUCCESS The function complete successfully.
1013 @retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
1014 @return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
1018 Var_UpdateDriverOrder (
1019 IN BMM_CALLBACK_DATA
*CallbackData
1024 UINT16
*DriverOrderList
;
1025 UINT16
*NewDriverOrderList
;
1026 UINTN DriverOrderListSize
;
1028 DriverOrderList
= NULL
;
1029 DriverOrderListSize
= 0;
1032 // First check whether DriverOrder is present in current configuration
1034 DriverOrderList
= BdsLibGetVariableAndSize (
1036 &gEfiGlobalVariableGuid
,
1037 &DriverOrderListSize
1040 NewDriverOrderList
= AllocateZeroPool (DriverOrderListSize
);
1042 if (NewDriverOrderList
== NULL
) {
1043 return EFI_OUT_OF_RESOURCES
;
1046 // If exists, delete it to hold new DriverOrder
1048 if (DriverOrderList
!= NULL
) {
1049 EfiLibDeleteVariable (L
"DriverOrder", &gEfiGlobalVariableGuid
);
1050 FreePool (DriverOrderList
);
1053 ASSERT (DriverOrderListSize
<= (sizeof (CallbackData
->BmmFakeNvData
.OptionOrder
) / sizeof (CallbackData
->BmmFakeNvData
.OptionOrder
[0])));
1054 for (Index
= 0; Index
< DriverOrderListSize
; Index
++) {
1055 NewDriverOrderList
[Index
] = (UINT16
) (CallbackData
->BmmFakeNvData
.OptionOrder
[Index
] - 1);
1058 Status
= gRT
->SetVariable (
1060 &gEfiGlobalVariableGuid
,
1062 DriverOrderListSize
,
1065 if (EFI_ERROR (Status
)) {
1069 BOpt_FreeMenu (&DriverOptionMenu
);
1070 BOpt_GetDriverOptions (CallbackData
);
1075 Update the legacy BBS boot option. L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable
1076 is udpated with the new Legacy Boot order. The EFI Variable of "Boot####" and gEfiGlobalVariableGuid
1079 @param CallbackData The context data for BMM.
1081 @return EFI_SUCCESS The function completed successfully.
1082 @retval EFI_NOT_FOUND If L"LegacyDevOrder" and EfiLegacyDevOrderGuid EFI Variable can be found.
1083 @retval EFI_OUT_OF_RESOURCES Fail to allocate memory resource
1086 Var_UpdateBBSOption (
1087 IN BMM_CALLBACK_DATA
*CallbackData
1092 VOID
*BootOptionVar
;
1093 CHAR16 VarName
[100];
1097 CHAR16 DescString
[100];
1098 CHAR8 DescAsciiString
[100];
1099 UINTN NewOptionSize
;
1100 UINT8
*NewOptionPtr
;
1103 BM_MENU_OPTION
*OptionMenu
;
1104 BM_LEGACY_DEVICE_CONTEXT
*LegacyDeviceContext
;
1108 BM_MENU_ENTRY
*NewMenuEntry
;
1109 BM_LEGACY_DEV_ORDER_CONTEXT
*DevOrder
;
1117 LegacyDeviceContext
= NULL
;
1121 if (FORM_SET_FD_ORDER_ID
== CallbackData
->BmmPreviousPageId
) {
1122 OptionMenu
= (BM_MENU_OPTION
*) &LegacyFDMenu
;
1123 LegacyDev
= CallbackData
->BmmFakeNvData
.LegacyFD
;
1124 CallbackData
->BbsType
= BBS_FLOPPY
;
1126 if (FORM_SET_HD_ORDER_ID
== CallbackData
->BmmPreviousPageId
) {
1127 OptionMenu
= (BM_MENU_OPTION
*) &LegacyHDMenu
;
1128 LegacyDev
= CallbackData
->BmmFakeNvData
.LegacyHD
;
1129 CallbackData
->BbsType
= BBS_HARDDISK
;
1131 if (FORM_SET_CD_ORDER_ID
== CallbackData
->BmmPreviousPageId
) {
1132 OptionMenu
= (BM_MENU_OPTION
*) &LegacyCDMenu
;
1133 LegacyDev
= CallbackData
->BmmFakeNvData
.LegacyCD
;
1134 CallbackData
->BbsType
= BBS_CDROM
;
1136 if (FORM_SET_NET_ORDER_ID
== CallbackData
->BmmPreviousPageId
) {
1137 OptionMenu
= (BM_MENU_OPTION
*) &LegacyNETMenu
;
1138 LegacyDev
= CallbackData
->BmmFakeNvData
.LegacyNET
;
1139 CallbackData
->BbsType
= BBS_EMBED_NETWORK
;
1141 OptionMenu
= (BM_MENU_OPTION
*) &LegacyBEVMenu
;
1142 LegacyDev
= CallbackData
->BmmFakeNvData
.LegacyBEV
;
1143 CallbackData
->BbsType
= BBS_BEV_DEVICE
;
1149 DisMap
= CallbackData
->BmmOldFakeNVData
.DisableMap
;
1150 Status
= EFI_SUCCESS
;
1153 // Find the first device's context
1154 // If all devices are disabled( 0xFF == LegacyDev[0]), LegacyDeviceContext can be set to any VariableContext
1155 // because we just use it to fill the desc string, and user can not see the string in UI
1157 for (Index
= 0; Index
< OptionMenu
->MenuNumber
; Index
++) {
1158 NewMenuEntry
= BOpt_GetMenuEntry (OptionMenu
, Index
);
1159 LegacyDeviceContext
= (BM_LEGACY_DEVICE_CONTEXT
*) NewMenuEntry
->VariableContext
;
1160 if (0xFF != LegacyDev
[0] && LegacyDev
[0] == LegacyDeviceContext
->Index
) {
1161 DEBUG ((DEBUG_ERROR
, "DescStr: %s\n", LegacyDeviceContext
->Description
));
1166 // Update the Variable "LegacyDevOrder"
1168 VarData
= (UINT8
*) BdsLibGetVariableAndSize (
1169 VAR_LEGACY_DEV_ORDER
,
1170 &EfiLegacyDevOrderGuid
,
1174 if (VarData
== NULL
) {
1175 return EFI_NOT_FOUND
;
1178 OriginalPtr
= VarData
;
1179 DevOrder
= (BM_LEGACY_DEV_ORDER_CONTEXT
*) VarData
;
1181 while (VarData
< VarData
+ VarSize
) {
1182 if (DevOrder
->BbsType
== CallbackData
->BbsType
) {
1186 VarData
+= sizeof (BBS_TYPE
);
1187 VarData
+= *(UINT16
*) VarData
;
1188 DevOrder
= (BM_LEGACY_DEV_ORDER_CONTEXT
*) VarData
;
1191 if (VarData
>= VarData
+ VarSize
) {
1192 FreePool (OriginalPtr
);
1193 return EFI_NOT_FOUND
;
1196 NewOrder
= (UINT16
*) AllocateZeroPool (DevOrder
->Length
- sizeof (UINT16
));
1197 if (NewOrder
== NULL
) {
1199 return EFI_OUT_OF_RESOURCES
;
1202 for (Index
= 0; Index
< OptionMenu
->MenuNumber
; Index
++) {
1203 if (0xFF == LegacyDev
[Index
]) {
1207 NewOrder
[Index
] = LegacyDev
[Index
];
1210 // Only the enable/disable state of each boot device with same device type can be changed,
1211 // so we can count on the index information in DevOrder.
1212 // DisMap bit array is the only reliable source to check a device's en/dis state,
1213 // so we use DisMap to set en/dis state of each item in NewOrder array
1215 for (Index2
= 0; Index2
< OptionMenu
->MenuNumber
; Index2
++) {
1216 Tmp
= *(UINT16
*) ((UINT8
*) DevOrder
+ sizeof (BBS_TYPE
) + sizeof (UINT16
) + Index2
* sizeof (UINT16
));
1219 Bit
= 7 - (Tmp
% 8);
1220 if ((DisMap
[Pos
] & (1 << Bit
)) != 0) {
1221 NewOrder
[Index
] = (UINT16
) (0xFF00 | Tmp
);
1227 (UINT8
*) DevOrder
+ sizeof (BBS_TYPE
) + sizeof (UINT16
),
1229 DevOrder
->Length
- sizeof (UINT16
)
1231 FreePool (NewOrder
);
1233 Status
= gRT
->SetVariable (
1234 VAR_LEGACY_DEV_ORDER
,
1235 &EfiLegacyDevOrderGuid
,
1241 FreePool (OriginalPtr
);
1244 // Update Optional Data of Boot####
1246 BootOptionVar
= GetLegacyBootOptionVar (CallbackData
->BbsType
, &Index
, &OptionSize
);
1248 if (BootOptionVar
!= NULL
) {
1251 LegacyDeviceContext
->Description
,
1252 StrSize (LegacyDeviceContext
->Description
)
1255 UnicodeStrToAsciiStr((CONST CHAR16
*)&DescString
, (CHAR8
*)&DescAsciiString
);
1257 NewOptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (DescString
) +
1258 sizeof (BBS_BBS_DEVICE_PATH
);
1259 NewOptionSize
+= AsciiStrLen (DescAsciiString
) +
1260 END_DEVICE_PATH_LENGTH
+ sizeof (BBS_TABLE
) + sizeof (UINT16
);
1262 UnicodeSPrint (VarName
, 100, L
"Boot%04x", Index
);
1264 Ptr
= BootOptionVar
;
1266 Attribute
= (UINT32
*) Ptr
;
1267 *Attribute
|= LOAD_OPTION_ACTIVE
;
1268 if (LegacyDev
[0] == 0xFF) {
1270 // Disable this legacy boot option
1272 *Attribute
&= ~LOAD_OPTION_ACTIVE
;
1275 Ptr
+= sizeof (UINT32
);
1277 Ptr
+= sizeof (UINT16
);
1278 Ptr
+= StrSize ((CHAR16
*) Ptr
);
1280 NewOptionPtr
= AllocateZeroPool (NewOptionSize
);
1281 if (NewOptionPtr
== NULL
) {
1282 return EFI_OUT_OF_RESOURCES
;
1285 TempPtr
= NewOptionPtr
;
1296 TempPtr
+= sizeof (UINT32
);
1299 // BBS device path Length
1301 *((UINT16
*) TempPtr
) = (UINT16
) (sizeof (BBS_BBS_DEVICE_PATH
) +
1302 AsciiStrLen (DescAsciiString
) +
1303 END_DEVICE_PATH_LENGTH
);
1305 TempPtr
+= sizeof (UINT16
);
1308 // Description string
1313 StrSize (DescString
)
1316 TempPtr
+= StrSize (DescString
);
1324 sizeof (BBS_BBS_DEVICE_PATH
)
1328 ((BBS_BBS_DEVICE_PATH
*) TempPtr
)->String
,
1330 AsciiStrSize (DescAsciiString
)
1333 SetDevicePathNodeLength (
1334 (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
,
1335 sizeof (BBS_BBS_DEVICE_PATH
) + AsciiStrLen (DescAsciiString
)
1338 TempPtr
+= sizeof (BBS_BBS_DEVICE_PATH
) + AsciiStrLen (DescAsciiString
);
1346 END_DEVICE_PATH_LENGTH
1348 TempPtr
+= END_DEVICE_PATH_LENGTH
;
1351 // Now TempPtr point to optional data, i.e. Bbs Table
1355 LegacyDeviceContext
->BbsTable
,
1360 // Now TempPtr point to BBS index
1362 TempPtr
+= sizeof (BBS_TABLE
);
1363 *((UINT16
*) TempPtr
) = (UINT16
) LegacyDeviceContext
->Index
;
1365 Status
= gRT
->SetVariable (
1367 &gEfiGlobalVariableGuid
,
1373 FreePool (NewOptionPtr
);
1374 FreePool (BootOptionVar
);
1377 BOpt_GetBootOptions (CallbackData
);
1382 Update the Text Mode of Console.
1384 @param CallbackData The context data for BMM.
1386 @retval EFI_SUCCSS If the Text Mode of Console is updated.
1387 @return Other value if the Text Mode of Console is not updated.
1392 IN BMM_CALLBACK_DATA
*CallbackData
1397 CONSOLE_OUT_MODE ModeInfo
;
1399 Mode
= CallbackData
->BmmFakeNvData
.ConsoleOutMode
;
1401 Status
= gST
->ConOut
->QueryMode (gST
->ConOut
, Mode
, &(ModeInfo
.Column
), &(ModeInfo
.Row
));
1402 if (!EFI_ERROR(Status
)) {
1403 PcdSet32 (PcdConOutColumn
, (UINT32
) ModeInfo
.Column
);
1404 PcdSet32 (PcdConOutRow
, (UINT32
) ModeInfo
.Row
);