/** @file\r
Implementation for EFI_HII_DATABASE_PROTOCOL.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2016, 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
\r
#include "HiiDatabase.h"\r
\r
-//\r
-// Global variables\r
-//\r
-EFI_GUID mHiiDatabaseNotifyGuid = HII_DATABASE_NOTIFY_GUID;\r
-\r
+EFI_HII_PACKAGE_LIST_HEADER *gRTDatabaseInfoBuffer = NULL;\r
+EFI_STRING gRTConfigRespBuffer = NULL;\r
+UINTN gDatabaseInfoSize = 0;\r
+UINTN gConfigRespSize = 0;\r
+BOOLEAN gExportConfigResp = TRUE;\r
\r
/**\r
This function generates a HII_DATABASE_RECORD node and adds into hii database.\r
@param NotifyType The type of change concerning the database.\r
@param PackageList Pointer to a package list which will be inserted\r
to.\r
- @param Package Created GUID pacakge\r
+ @param Package Created GUID package\r
\r
@retval EFI_SUCCESS Guid Package is inserted successfully.\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary resources for the new\r
PackageList->PackageListHdr.PackageLength -= Package->FormPkgHdr.Length;\r
FreePool (Package->IfrData);\r
FreePool (Package);\r
-\r
+ //\r
+ // If Hii runtime support feature is enabled,\r
+ // will export Hii info for runtime use after ReadyToBoot event triggered.\r
+ // If some driver add/update/remove packages from HiiDatabase after ReadyToBoot,\r
+ // will need to export the content of HiiDatabase.\r
+ // But if form packages removed, also need to export the ConfigResp string\r
+ //\r
+ if (gExportAfterReadyToBoot) {\r
+ gExportConfigResp = TRUE;\r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
if (Language == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
- AsciiStrCpy (Language, (CHAR8 *) PackageHdr + HeaderSize - LanguageSize);\r
+ AsciiStrCpyS (Language, LanguageSize / sizeof (CHAR8), (CHAR8 *) PackageHdr + HeaderSize - LanguageSize);\r
for (Link = PackageList->StringPkgHdr.ForwardLink; Link != &PackageList->StringPkgHdr; Link = Link->ForwardLink) {\r
StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
if (HiiCompareLanguage (Language, StringPackage->StringPkgHdr->Language)) {\r
//\r
// Collect all font block info\r
//\r
- Status = FindStringBlock (Private, StringPackage, (EFI_STRING_ID) (-1), NULL, NULL, NULL, &StringPackage->MaxStringId);\r
+ Status = FindStringBlock (Private, StringPackage, (EFI_STRING_ID) (-1), NULL, NULL, NULL, &StringPackage->MaxStringId, NULL);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
@param PackageList Pointer to a package list which will be adjusted.\r
\r
@retval EFI_SUCCESS Adjust all string packages successfully.\r
- @retval others Can't adjust string packges.\r
+ @retval others Can't adjust string packages.\r
\r
**/\r
EFI_STATUS\r
}\r
FontInfo->FontStyle = FontPkgHdr->FontStyle;\r
FontInfo->FontSize = FontPkgHdr->Cell.Height;\r
- StrCpy (FontInfo->FontName, FontPkgHdr->FontFamily);\r
+ StrCpyS (FontInfo->FontName, (FontInfoSize - OFFSET_OF(EFI_FONT_INFO,FontName)) / sizeof (CHAR16), FontPkgHdr->FontFamily);\r
\r
if (IsFontInfoExisted (Private, FontInfo, NULL, NULL, NULL)) {\r
Status = EFI_UNSUPPORTED;\r
if (ImageInfoOffset != 0) {\r
ImageSize = ImagePackage->ImagePkgHdr.Header.Length -\r
sizeof (EFI_HII_IMAGE_PACKAGE_HDR) - PaletteSize;\r
- ImagePackage->ImageBlock = (UINT8 *) AllocateZeroPool (ImageSize);\r
+ ImagePackage->ImageBlock = AllocateZeroPool (ImageSize);\r
if (ImagePackage->ImageBlock == NULL) {\r
FreePool (ImagePackage->PaletteBlock);\r
FreePool (ImagePackage);\r
//\r
// Initialize Variables\r
//\r
- StringPkgIsAdd = FALSE;\r
- FontPackage = NULL;\r
+ StringPkgIsAdd = FALSE;\r
+ FontPackage = NULL;\r
+ StringPackage = NULL;\r
+ GuidPackage = NULL;\r
+ FormPackage = NULL;\r
+ ImagePackage = NULL;\r
+ SimpleFontPackage = NULL;\r
+ KeyboardLayoutPackage = NULL;\r
\r
//\r
// Process the package list header\r
(UINT8) (PackageHeader.Type),\r
DatabaseRecord->Handle\r
);\r
+ //\r
+ // If Hii runtime support feature is enabled,\r
+ // will export Hii info for runtime use after ReadyToBoot event triggered.\r
+ // If some driver add/update/remove packages from HiiDatabase after ReadyToBoot,\r
+ // will need to export the content of HiiDatabase.\r
+ // But if form packages added/updated, also need to export the ConfigResp string.\r
+ //\r
+ if (gExportAfterReadyToBoot) {\r
+ gExportConfigResp = TRUE;\r
+ }\r
break;\r
case EFI_HII_PACKAGE_KEYBOARD_LAYOUT:\r
Status = InsertKeyboardLayoutPackage (\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
+ ASSERT (StringPackage != NULL);\r
Status = InvokeRegisteredFunction (\r
Private,\r
NotifyType,\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+This function mainly use to get and update ConfigResp string.\r
+\r
+@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
+\r
+@retval EFI_SUCCESS Get the information successfully.\r
+@retval EFI_OUT_OF_RESOURCES Not enough memory to store the Configuration Setting data.\r
+\r
+**/\r
+EFI_STATUS\r
+HiiGetConfigRespInfo(\r
+ IN CONST EFI_HII_DATABASE_PROTOCOL *This\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ HII_DATABASE_PRIVATE_DATA *Private;\r
+ EFI_STRING ConfigAltResp;\r
+ UINTN ConfigSize;\r
+\r
+ ConfigAltResp = NULL;\r
+ ConfigSize = 0;\r
+\r
+ Private = HII_DATABASE_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
+\r
+ //\r
+ // Get ConfigResp string\r
+ //\r
+ Status = HiiConfigRoutingExportConfig(&Private->ConfigRouting,&ConfigAltResp);\r
+\r
+ if (!EFI_ERROR (Status)){\r
+ ConfigSize = StrSize(ConfigAltResp);\r
+ if (ConfigSize > gConfigRespSize){\r
+ gConfigRespSize = ConfigSize;\r
+ if (gRTConfigRespBuffer != NULL){\r
+ FreePool(gRTConfigRespBuffer);\r
+ }\r
+ gRTConfigRespBuffer = (EFI_STRING)AllocateRuntimeZeroPool(ConfigSize);\r
+ if (gRTConfigRespBuffer == NULL){\r
+ FreePool(ConfigAltResp);\r
+ DEBUG ((DEBUG_ERROR, "Not enough memory resource to get the ConfigResp string.\n"));\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ } else {\r
+ ZeroMem(gRTConfigRespBuffer,gConfigRespSize);\r
+ }\r
+ CopyMem(gRTConfigRespBuffer,ConfigAltResp,ConfigSize);\r
+ gBS->InstallConfigurationTable (&gEfiHiiConfigRoutingProtocolGuid, gRTConfigRespBuffer);\r
+ FreePool(ConfigAltResp);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+\r
+}\r
+\r
+/**\r
+This is an internal function,mainly use to get HiiDatabase information.\r
+\r
+@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
+\r
+@retval EFI_SUCCESS Get the information successfully.\r
+@retval EFI_OUT_OF_RESOURCES Not enough memory to store the Hiidatabase data.\r
+\r
+**/\r
+EFI_STATUS\r
+HiiGetDatabaseInfo(\r
+ IN CONST EFI_HII_DATABASE_PROTOCOL *This\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HII_PACKAGE_LIST_HEADER *DatabaseInfo;\r
+ UINTN DatabaseInfoSize;\r
+\r
+ DatabaseInfo = NULL;\r
+ DatabaseInfoSize = 0;\r
+\r
+ //\r
+ // Get HiiDatabase information.\r
+ //\r
+ Status = HiiExportPackageLists(This, NULL, &DatabaseInfoSize, DatabaseInfo);\r
+\r
+ ASSERT(Status == EFI_BUFFER_TOO_SMALL);\r
+\r
+ if(DatabaseInfoSize > gDatabaseInfoSize ) {\r
+ gDatabaseInfoSize = DatabaseInfoSize;\r
+ if (gRTDatabaseInfoBuffer != NULL){\r
+ FreePool(gRTDatabaseInfoBuffer);\r
+ }\r
+ gRTDatabaseInfoBuffer = AllocateRuntimeZeroPool(DatabaseInfoSize);\r
+ if (gRTDatabaseInfoBuffer == NULL){\r
+ DEBUG ((DEBUG_ERROR, "Not enough memory resource to get the HiiDatabase info.\n"));\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ } else {\r
+ ZeroMem(gRTDatabaseInfoBuffer,gDatabaseInfoSize);\r
+ }\r
+ Status = HiiExportPackageLists(This, NULL, &DatabaseInfoSize, gRTDatabaseInfoBuffer);\r
+ ASSERT_EFI_ERROR (Status);\r
+ gBS->InstallConfigurationTable (&gEfiHiiDatabaseProtocolGuid, gRTDatabaseInfoBuffer);\r
+\r
+ return EFI_SUCCESS;\r
+\r
+}\r
+\r
+/**\r
+This function mainly use to get and update configuration settings information.\r
+\r
+@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
+\r
+@retval EFI_SUCCESS Get the information successfully.\r
+@retval EFI_OUT_OF_RESOURCES Not enough memory to store the Configuration Setting data.\r
+\r
+**/\r
+EFI_STATUS\r
+HiiGetConfigurationSetting(\r
+ IN CONST EFI_HII_DATABASE_PROTOCOL *This\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ //\r
+ // Get the HiiDatabase info.\r
+ //\r
+ Status = HiiGetDatabaseInfo(This);\r
+\r
+ //\r
+ // Get ConfigResp string\r
+ //\r
+ if (gExportConfigResp) {\r
+ Status = HiiGetConfigRespInfo (This);\r
+ gExportConfigResp = FALSE;\r
+ }\r
+ return Status;\r
+\r
+}\r
+\r
\r
/**\r
This function adds the packages in the package list to the database and returns a handle. If there is a\r
}\r
\r
*Handle = DatabaseRecord->Handle;\r
+\r
+ //\r
+ // Check whether need to get the Database and configuration setting info.\r
+ // Only after ReadyToBoot, need to do the export.\r
+ //\r
+ if (gExportAfterReadyToBoot) {\r
+ HiiGetConfigurationSetting(This);\r
+ }\r
+\r
return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
- This function removes the package list that is associated with a handle Handle\r
+ This function removes the package list that is associated with Handle\r
from the HII database. Before removing the package, any registered functions\r
with the notification type REMOVE_PACK and the same package type will be called.\r
\r
\r
@retval EFI_SUCCESS The data associated with the Handle was removed\r
from the HII database.\r
- @retval EFI_NOT_FOUND The specified andle is not in database.\r
+ @retval EFI_NOT_FOUND The specified handle is not in database.\r
@retval EFI_INVALID_PARAMETER The Handle was not valid.\r
\r
**/\r
FreePool (Node->PackageList);\r
FreePool (Node);\r
\r
+ //\r
+ // Check whether need to get the Database and configuration setting info.\r
+ // Only after ReadyToBoot, need to do the export.\r
+ //\r
+ if (gExportAfterReadyToBoot) {\r
+ HiiGetConfigurationSetting(This);\r
+ }\r
return EFI_SUCCESS;\r
}\r
}\r
//\r
// Add all of the packages within the new package list\r
//\r
- return AddPackages (Private, EFI_HII_DATABASE_NOTIFY_ADD_PACK, PackageList, Node);\r
+ Status = AddPackages (Private, EFI_HII_DATABASE_NOTIFY_ADD_PACK, PackageList, Node);\r
+\r
+ //\r
+ // Check whether need to get the Database and configuration setting info.\r
+ // Only after ReadyToBoot, need to do the export.\r
+ //\r
+ if (gExportAfterReadyToBoot) {\r
+ if (Status == EFI_SUCCESS){\r
+ HiiGetConfigurationSetting(This);\r
+ }\r
+ }\r
+\r
+ return Status;\r
}\r
}\r
\r
buffer that is required for the handles found.\r
@param Handle An array of EFI_HII_HANDLE instances returned.\r
\r
- @retval EFI_SUCCESS The matching handles are outputed successfully.\r
- HandleBufferLength is updated with the actual length.\r
+ @retval EFI_SUCCESS The matching handles are outputted successfully.\r
+ HandleBufferLength is updated with the actual length.\r
@retval EFI_BUFFER_TO_SMALL The HandleBufferLength parameter indicates that\r
Handle is too small to support the number of\r
handles. HandleBufferLength is updated with a\r
value that will enable the data to fit.\r
@retval EFI_NOT_FOUND No matching handle could not be found in database.\r
- @retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.\r
- \r
+ @retval EFI_INVALID_PARAMETER HandleBufferLength was NULL.\r
+ @retval EFI_INVALID_PARAMETER The value referenced by HandleBufferLength was not\r
+ zero and Handle was NULL.\r
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
- PackageGuid is not NULL, PackageType is a EFI_HII_\r
- PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
+ PackageGuid is not NULL, PackageType is a EFI_HII_\r
+ PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
\r
**/\r
EFI_STATUS\r
}\r
break;\r
//\r
- // Pesudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package handles\r
+ // Pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package handles\r
// to be listed.\r
//\r
case EFI_HII_PACKAGE_TYPE_ALL:\r
Handle is too small to support the number of\r
handles. HandleBufferLength is updated with a\r
value that will enable the data to fit.\r
- @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the\r
+ @retval EFI_NOT_FOUND The specified Handle could not be found in the\r
current database.\r
- @retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL.\r
+ @retval EFI_INVALID_PARAMETER BufferSize was NULL.\r
+ @retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero \r
+ and Buffer was NULL.\r
\r
**/\r
EFI_STATUS\r
HII_DATABASE_RECORD *Node;\r
UINTN UsedSize;\r
\r
- if (This == NULL || BufferSize == NULL || Handle == NULL) {\r
+ if (This == NULL || BufferSize == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
if (*BufferSize > 0 && Buffer == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- if (!IsHiiHandleValid (Handle)) {\r
+ if ((Handle != NULL) && (!IsHiiHandleValid (Handle))) {\r
return EFI_NOT_FOUND;\r
}\r
\r
//\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
&Notify->NotifyHandle,\r
- &mHiiDatabaseNotifyGuid,\r
+ &gEfiCallerIdGuid,\r
NULL,\r
NULL\r
);\r
\r
Status = gBS->OpenProtocol (\r
NotificationHandle,\r
- &mHiiDatabaseNotifyGuid,\r
+ &gEfiCallerIdGuid,\r
NULL,\r
NULL,\r
NULL,\r
RemoveEntryList (&Notify->DatabaseNotifyEntry);\r
Status = gBS->UninstallMultipleProtocolInterfaces (\r
Notify->NotifyHandle,\r
- &mHiiDatabaseNotifyGuid,\r
+ &gEfiCallerIdGuid,\r
NULL,\r
NULL\r
);\r
number of GUIDs. KeyGuidBufferLength is\r
updated with a value that will enable the data to\r
fit.\r
- @retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was NULL.\r
+ @retval EFI_INVALID_PARAMETER The KeyGuidBufferLength is NULL.\r
+ @retval EFI_INVALID_PARAMETER The value referenced by KeyGuidBufferLength is not\r
+ zero and KeyGuidBuffer is NULL.\r
@retval EFI_NOT_FOUND There was no keyboard layout.\r
\r
**/\r