-/**@file\r
+/** @file\r
This file implements functions related to Config Access Protocols installed by\r
by HII Thunk Modules. These Config access Protocols are used to thunk UEFI Config \r
Access Callback to Framework HII Callback and EFI Variable Set/Get operations.\r
\r
-Copyright (c) 2008 - 2010, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
return NULL;\r
}\r
\r
-/**\r
- Get the EFI_IFR_VARSTORE based the ID.\r
- \r
- @param FormSet The Form Set.\r
- \r
- @retval FORMSET_STORAGE * The EFI_IFR_VARSTORE with the ID.\r
- @retval NULL If the Form Set does not have EFI_IFR_VARSTORE with such ID.\r
-**/\r
-FORMSET_STORAGE *\r
-GetStorageFromVarStoreId (\r
- IN CONST FORM_BROWSER_FORMSET * FormSet,\r
- IN EFI_VARSTORE_ID VarStoreId\r
- )\r
-{\r
- LIST_ENTRY *StorageList;\r
- FORMSET_STORAGE *Storage;\r
-\r
- StorageList = GetFirstNode (&FormSet->StorageListHead);\r
-\r
- while (!IsNull (&FormSet->StorageListHead, StorageList)) {\r
- Storage = FORMSET_STORAGE_FROM_LINK (StorageList);\r
-\r
- if (VarStoreId == Storage->VarStoreId) {\r
- return Storage;\r
- }\r
-\r
- StorageList = GetNextNode (&FormSet->StorageListHead, StorageList);\r
- }\r
- \r
- return NULL;\r
-}\r
-\r
/**\r
Get the EFI_IFR_VARSTORE based the <ConfigHdr> string in a <ConfigRequest>\r
or a <ConfigResp> string.\r
FORMSET_STORAGE *Storage;\r
CHAR16 *Name;\r
\r
+ if (ConfigString == NULL) {\r
+ return NULL;\r
+ }\r
+\r
StorageList = GetFirstNode (&FormSet->StorageListHead);\r
\r
while (!IsNull (&FormSet->StorageListHead, StorageList)) {\r
StorageList = GetNextNode (&FormSet->StorageListHead, StorageList);\r
}\r
\r
- return NULL;\r
+ return NULL;\r
}\r
\r
/**\r
@retval EFI_INVALID_PARAMETER If the UEFI Variable Get Service return the size information of the data\r
does not match what has been recorded early in he BUFFER_STORAGE_ENTRY.\r
**/\r
-\r
EFI_STATUS\r
GetUefiVariable (\r
IN FORMSET_STORAGE *BufferStorage,\r
OUT EFI_STRING *Results\r
)\r
{\r
- EFI_STATUS Status;\r
- CONFIG_ACCESS_PRIVATE *ConfigAccess;\r
- FORMSET_STORAGE *BufferStorage;\r
- VOID *Data;\r
- UINTN DataSize;\r
-\r
- if (Request == NULL) {\r
+ EFI_STATUS Status;\r
+ CONFIG_ACCESS_PRIVATE *ConfigAccess;\r
+ FORMSET_STORAGE *BufferStorage;\r
+ VOID *Data;\r
+ UINTN DataSize;\r
+ FORM_BROWSER_FORMSET *FormSetContext;\r
+ CHAR16 *VarStoreName;\r
+ EFI_STRING ConfigRequestHdr;\r
+ EFI_STRING ConfigRequest;\r
+ UINTN Size;\r
+ BOOLEAN AllocatedRequest;\r
+ LIST_ENTRY *StorageList;\r
+ EFI_STRING SingleResult;\r
+ EFI_STRING FinalResults;\r
+ EFI_STRING StrPointer;\r
+\r
+ if (Progress == NULL || Results == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ *Progress = Request;\r
+\r
+ Status = EFI_SUCCESS;\r
+ Data = NULL;\r
+ StrPointer = NULL;\r
+ SingleResult = NULL;\r
+ FinalResults = NULL;\r
+ ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r
+ FormSetContext = ConfigAccess->ThunkContext->FormSet;\r
+ if (IsListEmpty (&FormSetContext->StorageListHead)) {\r
+ //\r
+ // No VarStorage does exist in this form.\r
+ //\r
return EFI_NOT_FOUND;\r
}\r
+ StorageList = GetFirstNode (&FormSetContext->StorageListHead);\r
\r
- Data = NULL;\r
- ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r
+ do {\r
+ if (Request != NULL) {\r
+ BufferStorage = GetStorageFromConfigString (ConfigAccess->ThunkContext->FormSet, Request);\r
+ if (BufferStorage == NULL) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ } else {\r
+ if (IsNull (&FormSetContext->StorageListHead, StorageList)) {\r
+ //\r
+ // No Storage to be extracted into the results.\r
+ //\r
+ break;\r
+ }\r
+ BufferStorage = FORMSET_STORAGE_FROM_LINK (StorageList);\r
+ StorageList = GetNextNode (&FormSetContext->StorageListHead, StorageList);\r
+ }\r
+ \r
+ VarStoreName = NULL;\r
+ ConfigRequestHdr = NULL;\r
+ ConfigRequest = NULL;\r
+ Size = 0;\r
+ AllocatedRequest = FALSE;\r
+\r
+ if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r
+ //\r
+ // NvMapOverride is not used. Get the Storage data from EFI Variable or Framework Form Callback.\r
+ //\r
+ if (ConfigAccess->FormCallbackProtocol == NULL ||\r
+ ConfigAccess->FormCallbackProtocol->NvRead == NULL) {\r
+ Status = GetUefiVariable (\r
+ BufferStorage,\r
+ &Data,\r
+ &DataSize\r
+ );\r
+ } else {\r
+ Status = CallFormCallBack (\r
+ BufferStorage,\r
+ ConfigAccess->FormCallbackProtocol,\r
+ &Data,\r
+ &DataSize\r
+ );\r
+ }\r
+ } else {\r
+ //\r
+ // Use the NvMapOverride.\r
+ //\r
+ DataSize = BufferStorage->Size;\r
+ Data = AllocateCopyPool (DataSize, ConfigAccess->ThunkContext->NvMapOverride);\r
+ \r
+ if (Data != NULL) {\r
+ Status = EFI_SUCCESS;\r
+ } else {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ }\r
+ }\r
+ \r
+ if (!EFI_ERROR (Status)) {\r
+ ConfigRequest = Request;\r
+ if (Request == NULL || (StrStr (Request, L"OFFSET") == NULL)) {\r
+ //\r
+ // Request is without any request element, construct full request string.\r
+ //\r
\r
- BufferStorage = GetStorageFromConfigString (ConfigAccess->ThunkContext->FormSet, Request);\r
+ if ((BufferStorage->VarStoreId == FormSetContext->DefaultVarStoreId) && (FormSetContext->OriginalDefaultVarStoreName != NULL)) {\r
+ VarStoreName = FormSetContext->OriginalDefaultVarStoreName;\r
+ } else {\r
+ VarStoreName = BufferStorage->Name;\r
+ }\r
\r
- if (BufferStorage == NULL) {\r
- *Progress = (EFI_STRING) Request;\r
- return EFI_NOT_FOUND;\r
- }\r
+ //\r
+ // First Set ConfigRequestHdr string.\r
+ //\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&BufferStorage->Guid, VarStoreName, ConfigAccess->ThunkContext->UefiHiiDriverHandle);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
\r
- if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r
+ //\r
+ // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r
+ // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
+ //\r
+ Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
+ ConfigRequest = AllocateZeroPool (Size);\r
+ ASSERT (ConfigRequest != NULL);\r
+ AllocatedRequest = TRUE;\r
+ UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)DataSize);\r
+ FreePool (ConfigRequestHdr);\r
+ }\r
+ Status = mHiiConfigRoutingProtocol->BlockToConfig (\r
+ mHiiConfigRoutingProtocol,\r
+ ConfigRequest,\r
+ Data,\r
+ DataSize,\r
+ &SingleResult,\r
+ Progress\r
+ );\r
+ //\r
+ // Free the allocated config request string.\r
+ //\r
+ if (AllocatedRequest) {\r
+ FreePool (ConfigRequest);\r
+ ConfigRequest = NULL;\r
+ }\r
+ }\r
//\r
- // NvMapOverride is not used. Get the Storage data from EFI Variable or Framework Form Callback.\r
+ // Free the allocated Data\r
//\r
- if (ConfigAccess->FormCallbackProtocol == NULL ||\r
- ConfigAccess->FormCallbackProtocol->NvRead == NULL) {\r
- Status = GetUefiVariable (\r
- BufferStorage,\r
- &Data,\r
- &DataSize\r
- );\r
- } else {\r
- Status = CallFormCallBack (\r
- BufferStorage,\r
- ConfigAccess->FormCallbackProtocol,\r
- &Data,\r
- &DataSize\r
- );\r
+ if (Data != NULL) {\r
+ FreePool (Data);\r
}\r
- } else {\r
//\r
- // Use the NvMapOverride.\r
+ // Directly return when meet with error\r
//\r
- DataSize = BufferStorage->Size;\r
- Data = AllocateCopyPool (DataSize, ConfigAccess->ThunkContext->NvMapOverride);\r
- \r
- if (Data != NULL) {\r
- Status = EFI_SUCCESS;\r
+ if (EFI_ERROR (Status)) {\r
+ break;\r
+ }\r
+ //\r
+ // Merge result into the final results.\r
+ //\r
+ if (FinalResults == NULL) {\r
+ FinalResults = SingleResult;\r
+ SingleResult = NULL;\r
} else {\r
- Status = EFI_OUT_OF_RESOURCES;\r
+ Size = StrLen (FinalResults);\r
+ Size = Size + 1;\r
+ Size = Size + StrLen (SingleResult) + 1;\r
+ StrPointer = AllocateZeroPool (Size * sizeof (CHAR16));\r
+ ASSERT (StrPointer != NULL);\r
+ StrCpy (StrPointer, FinalResults);\r
+ FreePool (FinalResults);\r
+ FinalResults = StrPointer;\r
+ StrPointer = StrPointer + StrLen (StrPointer);\r
+ *StrPointer = L'&';\r
+ StrCpy (StrPointer + 1, SingleResult);\r
+ FreePool (SingleResult);\r
}\r
- }\r
- \r
+ } while (Request == NULL);\r
+\r
if (!EFI_ERROR (Status)) {\r
- Status = mHiiConfigRoutingProtocol->BlockToConfig (\r
- mHiiConfigRoutingProtocol,\r
- Request,\r
- Data,\r
- DataSize,\r
- Results,\r
- Progress\r
- );\r
+ *Results = FinalResults;\r
+ } else {\r
+ if (FinalResults != NULL) {\r
+ FreePool (FinalResults);\r
+ }\r
}\r
-\r
- if (Data != NULL) {\r
- FreePool (Data);\r
+ //\r
+ // Set Progress string to the original request string.\r
+ //\r
+ if (Request == NULL) {\r
+ *Progress = NULL;\r
+ } else if (StrStr (Request, L"OFFSET") == NULL) {\r
+ *Progress = Request + StrLen (Request);\r
}\r
+\r
return Status;\r
}\r
\r
\r
ASSERT if the Question Type is not EFI_IFR_TYPE_NUM_SIZE_* or EFI_IFR_TYPE_STRING.\r
\r
- @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL\r
+ @param ConfigAccess Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL\r
@param QuestionId The Question ID.\r
@param Type The Question Type.\r
@param Value The Question Value.\r
break;\r
\r
case EFI_IFR_TYPE_ACTION:\r
+ case EFI_IFR_TYPE_UNDEFINED:\r
Size = 0;\r
break;\r
\r
break;\r
\r
case EFI_IFR_TYPE_ACTION:\r
+ case EFI_IFR_TYPE_UNDEFINED:\r
break;\r
\r
default:\r
EFI_INPUT_KEY Key; \r
BOOLEAN NvMapAllocated;\r
\r
- if ((Action == EFI_BROWSER_ACTION_FORM_OPEN) || (Action == EFI_BROWSER_ACTION_FORM_CLOSE)) {\r
- //\r
- // Ignore UEFI OPEN/CLOSE Action for FrameworkCallback\r
- //\r
- return EFI_SUCCESS;\r
- }\r
+ if (Action == EFI_BROWSER_ACTION_CHANGING) {\r
+ ASSERT (This != NULL);\r
+ ASSERT (Value != NULL);\r
+ ASSERT (ActionRequest != NULL);\r
\r
- ASSERT (This != NULL);\r
- ASSERT (Value != NULL);\r
- ASSERT (ActionRequest != NULL);\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
+ ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r
\r
- ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r
+ FormCallbackProtocol = ConfigAccess->FormCallbackProtocol;\r
+ if (FormCallbackProtocol == NULL) {\r
+ ASSERT (FALSE);\r
+ return EFI_UNSUPPORTED;\r
+ }\r
\r
- FormCallbackProtocol = ConfigAccess->FormCallbackProtocol;\r
- if (FormCallbackProtocol == NULL) {\r
- ASSERT (FALSE);\r
- return EFI_UNSUPPORTED;\r
- }\r
+ //\r
+ // Check if the QuestionId match a OneOfOption.\r
+ //\r
+ OneOfOptionMapEntry = GetOneOfOptionMapEntry (ConfigAccess->ThunkContext, QuestionId, Type, Value);\r
\r
- //\r
- // Check if the QuestionId match a OneOfOption.\r
- //\r
- OneOfOptionMapEntry = GetOneOfOptionMapEntry (ConfigAccess->ThunkContext, QuestionId, Type, Value);\r
+ if (OneOfOptionMapEntry == NULL) {\r
+ //\r
+ // This is not a One-Of-Option opcode. QuestionId is the KeyValue\r
+ //\r
+ KeyValue = QuestionId;\r
+ } else {\r
+ //\r
+ // Otherwise, use the original Key specified in One Of Option in the Framework VFR syntax.\r
+ //\r
+ KeyValue = OneOfOptionMapEntry->FwKey;\r
+ }\r
\r
- if (OneOfOptionMapEntry == NULL) {\r
//\r
- // This is not a One-Of-Option opcode. QuestionId is the KeyValue\r
+ // Build the EFI_IFR_DATA_ARRAY\r
//\r
- KeyValue = QuestionId;\r
- } else {\r
+ Data = CreateIfrDataArray (ConfigAccess, QuestionId, Type, Value, &NvMapAllocated);\r
+\r
+ Status = mHiiDatabase->RegisterPackageNotify (\r
+ mHiiDatabase,\r
+ EFI_HII_PACKAGE_FORMS,\r
+ NULL,\r
+ FormUpdateNotify,\r
+ EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
+ &NotifyHandle\r
+ );\r
//\r
- // Otherwise, use the original Key specified in One Of Option in the Framework VFR syntax.\r
+ //Call the Framework Callback function.\r
//\r
- KeyValue = OneOfOptionMapEntry->FwKey;\r
- }\r
-\r
- //\r
- // Build the EFI_IFR_DATA_ARRAY\r
- //\r
- Data = CreateIfrDataArray (ConfigAccess, QuestionId, Type, Value, &NvMapAllocated);\r
-\r
- Status = mHiiDatabase->RegisterPackageNotify (\r
- mHiiDatabase,\r
- EFI_HII_PACKAGE_FORMS,\r
- NULL,\r
- FormUpdateNotify,\r
- EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
- &NotifyHandle\r
- );\r
- //\r
- //Call the Framework Callback function.\r
- //\r
- Packet = NULL;\r
- Status = FormCallbackProtocol->Callback (\r
- FormCallbackProtocol,\r
- KeyValue,\r
- Data,\r
- &Packet\r
- );\r
- SyncBrowserDataForNvMapOverride (ConfigAccess, QuestionId);\r
+ Packet = NULL;\r
+ Status = FormCallbackProtocol->Callback (\r
+ FormCallbackProtocol,\r
+ KeyValue,\r
+ Data,\r
+ &Packet\r
+ );\r
+ SyncBrowserDataForNvMapOverride (ConfigAccess, QuestionId);\r
\r
- //\r
- // Callback require browser to perform action\r
- //\r
- if (EFI_ERROR (Status)) {\r
- if (Packet != NULL) {\r
- do {\r
- CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, Packet->String, NULL);\r
- } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
- }\r
//\r
- // Error Code in Status is discarded.\r
+ // Callback require browser to perform action\r
//\r
- } else {\r
- if (Packet != NULL) {\r
- if (Packet->DataArray.EntryCount == 1 && Packet->DataArray.NvRamMap == NULL) {\r
- DataEntry = (EFI_IFR_DATA_ENTRY *) ((UINT8 *) Packet + sizeof (EFI_IFR_DATA_ARRAY));\r
- if ((DataEntry->Flags & EXIT_REQUIRED) == EXIT_REQUIRED) {\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
- }\r
-\r
- if ((DataEntry->Flags & SAVE_REQUIRED) == SAVE_REQUIRED) {\r
- Status = ConfigAccess->ConfigAccessProtocol.RouteConfig (\r
- &ConfigAccess->ConfigAccessProtocol,\r
- NULL,\r
- NULL\r
- );\r
+ if (EFI_ERROR (Status)) {\r
+ if (Packet != NULL) {\r
+ do {\r
+ CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, Packet->String, NULL);\r
+ } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
+ }\r
+ //\r
+ // Error Code in Status is discarded.\r
+ //\r
+ } else {\r
+ if (Packet != NULL) {\r
+ if (Packet->DataArray.EntryCount == 1 && Packet->DataArray.NvRamMap == NULL) {\r
+ DataEntry = (EFI_IFR_DATA_ENTRY *) ((UINT8 *) Packet + sizeof (EFI_IFR_DATA_ARRAY));\r
+ if ((DataEntry->Flags & EXIT_REQUIRED) == EXIT_REQUIRED) {\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ }\r
+\r
+ if ((DataEntry->Flags & SAVE_REQUIRED) == SAVE_REQUIRED) {\r
+ Status = ConfigAccess->ConfigAccessProtocol.RouteConfig (\r
+ &ConfigAccess->ConfigAccessProtocol,\r
+ NULL,\r
+ NULL\r
+ );\r
+ }\r
}\r
- }\r
- FreePool (Packet);\r
+ FreePool (Packet);\r
+ }\r
}\r
- }\r
\r
- //\r
- // Unregister notify for Form package update\r
- //\r
- Status = mHiiDatabase->UnregisterPackageNotify (\r
- mHiiDatabase,\r
- NotifyHandle\r
- );\r
- //\r
- // UEFI SetupBrowser behaves differently with Framework SetupBrowser when call back function \r
- // update any forms in HII database. UEFI SetupBrowser will re-parse the displaying form package and load\r
- // the values from variable storages. Framework SetupBrowser will only re-parse the displaying form packages.\r
- // To make sure customer's previous changes is saved and the changing question behaves as expected, we\r
- // issue a EFI_BROWSER_ACTION_REQUEST_SUBMIT to ask UEFI SetupBrowser to save the changes proceed to re-parse\r
- // the form and load all the variable storages.\r
- //\r
- if (*ActionRequest == EFI_BROWSER_ACTION_REQUEST_NONE && mHiiPackageListUpdated) {\r
- mHiiPackageListUpdated= FALSE;\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
- } else {\r
- if (ConfigAccess->ThunkContext->FormSet->SubClass == EFI_FRONT_PAGE_SUBCLASS ||\r
- ConfigAccess->ThunkContext->FormSet->SubClass == EFI_SINGLE_USE_SUBCLASS) {\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ //\r
+ // Unregister notify for Form package update\r
+ //\r
+ Status = mHiiDatabase->UnregisterPackageNotify (\r
+ mHiiDatabase,\r
+ NotifyHandle\r
+ );\r
+ //\r
+ // UEFI SetupBrowser behaves differently with Framework SetupBrowser when call back function \r
+ // update any forms in HII database. UEFI SetupBrowser will re-parse the displaying form package and load\r
+ // the values from variable storages. Framework SetupBrowser will only re-parse the displaying form packages.\r
+ // To make sure customer's previous changes is saved and the changing question behaves as expected, we\r
+ // issue a EFI_BROWSER_ACTION_REQUEST_SUBMIT to ask UEFI SetupBrowser to save the changes proceed to re-parse\r
+ // the form and load all the variable storages.\r
+ //\r
+ if (*ActionRequest == EFI_BROWSER_ACTION_REQUEST_NONE && mHiiPackageListUpdated) {\r
+ mHiiPackageListUpdated= FALSE;\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
+ } else {\r
+ if (ConfigAccess->ThunkContext->FormSet->SubClass == EFI_FRONT_PAGE_SUBCLASS ||\r
+ ConfigAccess->ThunkContext->FormSet->SubClass == EFI_SINGLE_USE_SUBCLASS) {\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ }\r
}\r
- }\r
\r
+ //\r
+ // Clean up.\r
+ //\r
+ DestroyIfrDataArray (Data, NvMapAllocated);\r
+\r
+ return Status;\r
+ }\r
\r
//\r
- // Clean up.\r
+ // All other action return unsupported.\r
//\r
- DestroyIfrDataArray (Data, NvMapAllocated);\r
- \r
- return Status;\r
+ return EFI_UNSUPPORTED;\r
}\r
\r
projects / mirror_edk2.git / blobdiff