Skip to content

Commit

Permalink
MdeModulePkg/HiiDatabaseDxe: Add string question load default support.
Browse files Browse the repository at this point in the history 
Add string question load default support.
load default data from PCD PcdNvStoreDefaultValueBuffer.

Signed-off-by: Longhao Lee <[email protected]>
  • Loading branch information
@poloaegis83
poloaegis83 committed Jan 2, 2025
1 parent 070eadb commit eb97f20
Showing 1 changed file with 172 additions and 0 deletions.
172 changes: 172 additions & 0 deletions MdeModulePkg/Universal/HiiDatabaseDxe/ConfigRouting.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1371,6 +1371,149 @@ GetSupportedLanguages (
return SupportedLanguages;
}

/**
This function create a new string in String Package or updates an existing
string in a String Package. If StringId is 0, then a new string is added to
a String Package. If StringId is not zero, then a string in String Package is
updated. If SupportedLanguages is NULL, then the string is added or updated
for all the languages that the String Package supports. If SupportedLanguages
is not NULL, then the string is added or updated for the set of languages
specified by SupportedLanguages.
If HiiHandle is NULL, then ASSERT().
If String is NULL, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the
HII Database.
@param[in] StringId If zero, then a new string is created in the
String Package associated with HiiHandle. If
non-zero, then the string specified by StringId
is updated in the String Package associated
with HiiHandle.
@param[in] String A pointer to the Null-terminated Unicode string
to add or update in the String Package associated
with HiiHandle.
@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of
language codes. If this parameter is NULL, then
String is added or updated in the String Package
associated with HiiHandle for all the languages
that the String Package supports. If this
parameter is not NULL, then then String is added
or updated in the String Package associated with
HiiHandle for the set oflanguages specified by
SupportedLanguages. The format of
SupportedLanguages must follow the language
format assumed the HII Database.
@retval 0 The string could not be added or updated in the String Package.
@retval Other The EFI_STRING_ID of the newly added or updated string.
**/
EFI_STRING_ID
InternalHiiSetString (
IN EFI_HII_HANDLE HiiHandle,
IN EFI_STRING_ID StringId OPTIONAL,
IN CONST EFI_STRING String,
IN CONST CHAR8 *SupportedLanguages OPTIONAL
)
{
EFI_STATUS Status;
CHAR8 *AllocatedLanguages;
CHAR8 *Supported;
CHAR8 *Language;

ASSERT (HiiHandle != NULL);

if (SupportedLanguages == NULL) {
//
// Retrieve the languages that the package specified by HiiHandle supports
//
AllocatedLanguages = GetSupportedLanguages (HiiHandle);
} else {
//
// Allocate a copy of the SupportLanguages string that passed in
//
AllocatedLanguages = AllocateCopyPool (AsciiStrSize (SupportedLanguages), SupportedLanguages);
}

//
// If there are not enough resources for the supported languages string, then return a StringId of 0
//
if (AllocatedLanguages == NULL) {
return (EFI_STRING_ID)(0);
}

Status = EFI_INVALID_PARAMETER;
//
// Loop through each language that the string supports
//
for (Supported = AllocatedLanguages; *Supported != '\0'; ) {
//
// Cache a pointer to the beginning of the current language in the list of languages
//
Language = Supported;

//
// Search for the next language separator and replace it with a Null-terminator
//
for ( ; *Supported != 0 && *Supported != ';'; Supported++) {
}

if (*Supported != 0) {
*(Supported++) = '\0';
}

if ((SupportedLanguages == NULL) && (AsciiStrnCmp (Language, UEFI_CONFIG_LANG, AsciiStrLen (UEFI_CONFIG_LANG)) == 0)) {
//
// Skip string package used for keyword protocol.
//
continue;
}

//
// If StringId is 0, then call NewString(). Otherwise, call SetString()
//
if (StringId == (EFI_STRING_ID)(0)) {
Status = mPrivate.HiiString.NewString (
&mPrivate.HiiString,
HiiHandle,
&StringId,
Language,
NULL,
String,
NULL
);
} else {
Status = mPrivate.HiiString.SetString (
&mPrivate.HiiString,
HiiHandle,
StringId,
Language,
String,
NULL
);
}

//
// If there was an error, then break out of the loop and return a StringId of 0
//
if (EFI_ERROR (Status)) {
break;
}
}

//
// Free the buffer of supported languages
//
FreePool (AllocatedLanguages);

if (EFI_ERROR (Status)) {
return (EFI_STRING_ID)(0);
} else {
return StringId;
}
}

/**
Retrieves a string from a string package.
Expand Down Expand Up @@ -2202,6 +2345,7 @@ ParseIfrData (
BOOLEAN SmallestIdFromFlag;
BOOLEAN FromOtherDefaultOpcode;
BOOLEAN QuestionReferBitField;
UINT16 *StringData;

Status = EFI_SUCCESS;
BlockData = NULL;
Expand All @@ -2215,6 +2359,7 @@ ParseIfrData (
FromOtherDefaultOpcode = FALSE;
QuestionReferBitField = FALSE;
IfrEfiVarStoreTmp = NULL;
StringData = NULL;

//
// Go through the form package to parse OpCode one by one.
Expand Down Expand Up @@ -2871,6 +3016,29 @@ ParseIfrData (
goto Done;
}

//
// Set default value base on the DefaultId list get from IFR data.
//
NvDefaultStoreSize = PcdGetSize (PcdNvStoreDefaultValueBuffer);
for (LinkData = DefaultIdArray->Entry.ForwardLink; LinkData != &DefaultIdArray->Entry; LinkData = LinkData->ForwardLink) {
DefaultDataPtr = BASE_CR (LinkData, IFR_DEFAULT_DATA, Entry);
DefaultData.DefaultId = DefaultDataPtr->DefaultId;
if (NvDefaultStoreSize > sizeof (PCD_NV_STORE_DEFAULT_BUFFER_HEADER)) {
StringData = AllocateZeroPool (VarWidth*2);
if (StringData == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto Done;
}

FindQuestionDefaultSetting (DefaultData.DefaultId, IfrEfiVarStoreTmp, &(IfrString->Question), StringData, VarWidth, QuestionReferBitField);

Check failure

Code scanning / CodeQL

Returned pointer not checked High

Value may be null; it should be checked before dereferencing.
if ((DefaultData.Value.string != 0) && (StringData != NULL)) {
DefaultData.Value.string = InternalHiiSetString (HiiHandle, 0, StringData, NULL);
InsertDefaultValue (BlockData, &DefaultData);
FreePool (StringData);
}
}
}

break;

case EFI_IFR_PASSWORD_OP:
Expand Down Expand Up @@ -4104,6 +4272,10 @@ GenerateAltConfigResp (
}

CopyMem (TmpBuffer, (UINT8 *)DefaultString, StrSize);
//
// Delete String
//
InternalHiiSetString (HiiHandle, DefaultValueData->Value.string, NULL, NULL);
}
} else {
TmpBuffer = (UINT8 *)&(DefaultValueData->Value);
Expand Down

0 comments on commit eb97f20

Please sign in to comment.