Variable.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Variable operation that will be used by bootmaint
Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "BootMaint.h"
/**
Delete Boot Option that represent a Deleted state in BootOptionMenu.
After deleting this boot option, call Var_ChangeBootOrder to
make sure BootOrder is in valid state.
@retval EFI_SUCCESS If all boot load option EFI Variables corresponding to
BM_LOAD_CONTEXT marked for deletion is deleted.
@retval EFI_NOT_FOUND If can not find the boot option want to be deleted.
@return Others If failed to update the "BootOrder" variable after deletion.
**/
)
{
Index2 = 0;
if (NULL == NewMenuEntry) {
return EFI_NOT_FOUND;
}
if (!NewLoadContext->Deleted) {
continue;
}
sizeof (BootString),
L"Boot%04x",
);
Index2++;
//
// If current Load Option is the same as BootNext,
// must delete BootNext in order to make sure
// there will be no panic on next boot
//
if (NewLoadContext->IsBootNext) {
}
NewMenuEntry = NULL;
}
Status = Var_ChangeBootOrder ();
return Status;
}
/**
After any operation on Boot####, there will be a discrepancy in BootOrder.
Since some are missing but in BootOrder, while some are present but are
not reflected by BootOrder. Then a function rebuild BootOrder from
scratch by content from BootOptionMenu is needed.
@retval EFI_SUCCESS The boot order is updated successfully.
@return EFI_STATUS other than EFI_SUCCESS if failed to
Set the "BootOrder" EFI Variable.
**/
)
{
BootOrderListSize = 0;
//
// First check whether BootOrder is present in current configuration
//
L"BootOrder",
);
//
// If exists, delete it to hold new BootOrder
//
if (BootOrderList != NULL) {
}
//
// Maybe here should be some check method to ensure that
// no new added boot options will be added
// but the setup engine now will give only one callback
// that is to say, user are granted only one chance to
// decide whether the boot option will be added or not
// there should be no indictor to show whether this
// is a "new" boot option
//
if (BootOrderListSize > 0) {
//
// Get all current used Boot#### from BootOptionMenu.
// OptionNumber in each BM_LOAD_OPTION is really its
// #### value.
//
}
//
// After building the BootOrderList, write it back
//
L"BootOrder",
BootOrderListSize * sizeof (UINT16),
);
return Status;
}
}
return EFI_SUCCESS;
}
/**
Delete Load Option that represent a Deleted state in BootOptionMenu.
After deleting this Driver option, call Var_ChangeDriverOrder to
make sure DriverOrder is in valid state.
@retval EFI_SUCCESS Load Option is successfully updated.
@retval EFI_NOT_FOUND Fail to find the driver option want to be deleted.
@return Other value than EFI_SUCCESS if failed to update "Driver Order" EFI
Variable.
**/
)
{
Index2 = 0;
if (NULL == NewMenuEntry) {
return EFI_NOT_FOUND;
}
if (!NewLoadContext->Deleted) {
continue;
}
sizeof (DriverString),
L"Driver%04x",
);
Index2++;
NewMenuEntry = NULL;
}
Status = Var_ChangeDriverOrder ();
return Status;
}
/**
After any operation on Driver####, there will be a discrepancy in
DriverOrder. Since some are missing but in DriverOrder, while some
are present but are not reflected by DriverOrder. Then a function
rebuild DriverOrder from scratch by content from DriverOptionMenu is
needed.
@retval EFI_SUCCESS The driver order is updated successfully.
@return Other status than EFI_SUCCESS if failed to set the "DriverOrder" EFI Variable.
**/
)
{
DriverOrderListSize = 0;
//
// First check whether DriverOrder is present in current configuration
//
L"DriverOrder",
);
//
// If exists, delete it to hold new DriverOrder
//
if (DriverOrderList != NULL) {
}
if (DriverOrderListSize > 0) {
//
// Get all current used Driver#### from DriverOptionMenu.
// OptionNumber in each BM_LOAD_OPTION is really its
// #### value.
//
}
//
// After building the DriverOrderList, write it back
//
L"DriverOrder",
DriverOrderListSize * sizeof (UINT16),
);
return Status;
}
}
return EFI_SUCCESS;
}
/**
Update the device path of "ConOut", "ConIn" and "ErrOut"
based on the new BaudRate, Data Bits, parity and Stop Bits
set.
**/
)
{
if (OutDevicePath != NULL) {
L"ConOut",
);
}
if (InpDevicePath != NULL) {
L"ConIn",
);
}
if (ErrDevicePath != NULL) {
L"ErrOut",
);
}
}
/**
This function delete and build multi-instance device path for
specified type of console device.
This function clear the EFI variable defined by ConsoleName and
gEfiGlobalVariableGuid. It then build the multi-instance device
in ConsoleMenu. Then it scan all corresponding console device by
scanning Terminal (built from device supporting Serial I/O instances)
devices in TerminalMenu. At last, it save a EFI variable specifed
by ConsoleName and gEfiGlobalVariableGuid.
@param ConsoleName The name for the console device type. They are
usually "ConIn", "ConOut" and "ErrOut".
@param ConsoleMenu The console memu which is a list of console devices.
@param UpdatePageId The flag specifying which type of console device
to be processed.
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
if (ConDevicePath != NULL) {
};
//
// First add all console input device from console input menu
//
if (NewConsoleContext->IsActive) {
);
}
}
) {
ASSERT (NewTerminalContext->TerminalType < (sizeof (TerminalTypeGuid) / sizeof (TerminalTypeGuid[0])));
CopyMem (
sizeof (EFI_GUID)
);
);
);
}
}
if (ConDevicePath != NULL) {
);
return Status;
}
}
return EFI_SUCCESS;
}
/**
This function delete and build multi-instance device path ConIn
console device.
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
}
/**
This function delete and build multi-instance device path ConOut
console device.
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
}
/**
This function delete and build multi-instance device path ErrOut
console device.
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
}
/**
This function create a currently loaded Drive Option from
the BMM. It then appends this Driver Option to the end of
the "DriverOrder" list. It append this Driver Opotion to the end
of DriverOptionMenu.
@param CallbackData The BMM context data.
@param HiiHandle The HII handle associated with the BMM formset.
@param DescriptionData The description of this driver option.
@param OptionalData The optional load option.
@param ForceReconnect If to force reconnect.
@retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
@retval EFI_SUCCESS If function completes successfully.
**/
)
{
sizeof (DriverString),
L"Driver%04x",
);
if (*DescriptionData == 0x0000) {
}
if (*OptionalData != 0x0000) {
}
return EFI_OUT_OF_RESOURCES;
}
if (NULL == NewMenuEntry) {
return EFI_OUT_OF_RESOURCES;
}
NewLoadContext->ForceReconnect = (BOOLEAN) (NewLoadContext->Attributes & LOAD_OPTION_FORCE_RECONNECT);
CopyMem (
Ptr,
);
CopyMem (
);
CopyMem (
Ptr,
);
NewLoadContext->FilePathList = AllocateZeroPool (GetDevicePathSize (CallbackData->LoadContext->FilePathList));
CopyMem (
);
);
);
if (OptionalDataExist) {
CopyMem (
Ptr,
);
}
);
L"DriverOrder",
);
if (DriverOrderList != NULL) {
}
L"DriverOrder",
DriverOrderListSize + sizeof (UINT16),
);
if (DriverOrderList != NULL) {
}
*DescriptionData = 0x0000;
*OptionalData = 0x0000;
return EFI_SUCCESS;
}
/**
This function create a currently loaded Boot Option from
the BMM. It then appends this Boot Option to the end of
the "BootOrder" list. It also append this Boot Opotion to the end
of BootOptionMenu.
@param CallbackData The BMM context data.
@param NvRamMap The file explorer formset internal state.
@retval EFI_OUT_OF_RESOURCES If not enought memory to complete the operation.
@retval EFI_SUCCESS If function completes successfully.
**/
)
{
Index = BOpt_GetBootOptionNumber () ;
}
}
return EFI_OUT_OF_RESOURCES;
}
if (NULL == NewMenuEntry) {
return EFI_OUT_OF_RESOURCES;
}
NewLoadContext->ForceReconnect = (BOOLEAN) (NewLoadContext->Attributes & LOAD_OPTION_FORCE_RECONNECT);
CopyMem (
Ptr,
);
CopyMem (
);
CopyMem (
Ptr,
);
NewLoadContext->FilePathList = AllocateZeroPool (GetDevicePathSize (CallbackData->LoadContext->FilePathList));
CopyMem (
);
);
NewMenuEntry->DisplayStringToken = HiiSetString (CallbackData->FeHiiHandle, 0, NewMenuEntry->DisplayString, NULL);
);
NewMenuEntry->HelpStringToken = HiiSetString (CallbackData->FeHiiHandle, 0, NewMenuEntry->HelpString, NULL);
if (OptionalDataExist) {
}
);
L"BootOrder",
);
if (BootOrderList != NULL) {
}
L"BootOrder",
BootOrderListSize + sizeof (UINT16),
);
return EFI_SUCCESS;
}
/**
This function update the "BootNext" EFI Variable. If there is
no "BootNext" specified in BMM, this EFI Variable is deleted.
It also update the BMM context data specified the "BootNext"
vaule.
@param CallbackData The BMM context data.
@retval EFI_SUCCESS The function complete successfully.
@return The EFI variable can be saved. See gRT->SetVariable
for detail return information.
**/
)
{
}
return EFI_SUCCESS;
}
);
L"BootNext",
sizeof (UINT16),
);
return Status;
}
/**
This function update the "BootOrder" EFI Variable based on
BMM Formset's NV map. It then refresh BootOptionMenu
with the new "BootOrder" list.
@param CallbackData The BMM context data.
@retval EFI_SUCCESS The function complete successfully.
@retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
BootOrderListSize = 0;
//
// First check whether BootOrder is present in current configuration
//
L"BootOrder",
);
if (BootOrderList == NULL) {
return EFI_OUT_OF_RESOURCES;
}
ASSERT (BootOptionMenu.MenuNumber <= (sizeof (CallbackData->BmmFakeNvData.OptionOrder) / sizeof (CallbackData->BmmFakeNvData.OptionOrder[0])));
for (OrderIndex = 0; (OrderIndex < BootOptionMenu.MenuNumber) && (CallbackData->BmmFakeNvData.OptionOrder[OrderIndex] != 0); OrderIndex++) {
if ((BootOrderList[Index] == (UINT16) (CallbackData->BmmFakeNvData.OptionOrder[OrderIndex] - 1)) && (OrderIndex != Index)) {
CopyMem (&BootOrderList[OrderIndex + 1], &BootOrderList[OrderIndex], (Index - OrderIndex) * sizeof (UINT16));
}
}
}
BootOrderListSize / sizeof (UINT16)
);
L"BootOrder",
);
return Status;
}
/**
This function update the "DriverOrder" EFI Variable based on
BMM Formset's NV map. It then refresh DriverOptionMenu
with the new "DriverOrder" list.
@param CallbackData The BMM context data.
@retval EFI_SUCCESS The function complete successfully.
@retval EFI_OUT_OF_RESOURCES Not enough memory to complete the function.
@return The EFI variable can not be saved. See gRT->SetVariable for detail return information.
**/
)
{
DriverOrderListSize = 0;
//
// First check whether DriverOrder is present in current configuration
//
L"DriverOrder",
);
if (NewDriverOrderList == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// If exists, delete it to hold new DriverOrder
//
if (DriverOrderList != NULL) {
}
ASSERT (DriverOptionMenu.MenuNumber <= (sizeof (CallbackData->BmmFakeNvData.OptionOrder) / sizeof (CallbackData->BmmFakeNvData.OptionOrder[0])));
}
L"DriverOrder",
);
return Status;
}
return EFI_SUCCESS;
}
/**
Update the legacy BBS boot option. VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid EFI Variable
is udpated with the new Legacy Boot order. The EFI Variable of "Boot####" and gEfiGlobalVariableGuid
is also updated.
@param CallbackData The context data for BMM.
@return EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_FOUND If VAR_LEGACY_DEV_ORDER and gEfiLegacyDevOrderVariableGuid EFI Variable can be found.
@retval EFI_OUT_OF_RESOURCES Fail to allocate memory resource
**/
)
{
switch (CallbackData->BmmPreviousPageId) {
case FORM_SET_FD_ORDER_ID:
break;
case FORM_SET_HD_ORDER_ID:
break;
case FORM_SET_CD_ORDER_ID:
break;
case FORM_SET_NET_ORDER_ID:
break;
default:
break;
}
//
// Update the Variable "LegacyDevOrder"
//
);
return EFI_NOT_FOUND;
}
break;
}
}
return EFI_NOT_FOUND;
}
return EFI_OUT_OF_RESOURCES;
}
break;
}
}
//
// so we can count on the index information in DevOrder.
//
Index++;
}
}
CopyMem (
);
);
//
// Update BootOrder and Boot####.Attribute
//
// 1. Re-order the Option Number in BootOrder according to Legacy Dev Order
//
L"BootOrder",
);
);
L"BootOrder",
);
//
// 2. Deactivate the DisBootOption and activate the EnBootOption
//
);
if (BootOptionVar != NULL) {
*Attribute &= ~LOAD_OPTION_ACTIVE;
);
}
}
);
if (BootOptionVar != NULL) {
);
}
}
return Status;
}
/**
Update the Text Mode of Console.
@param CallbackData The context data for BMM.
@retval EFI_SUCCSS If the Text Mode of Console is updated.
@return Other value if the Text Mode of Console is not updated.
**/
)
{
}
return EFI_SUCCESS;
}