/** @file\r
HII Library implementation that uses DXE protocols and services.\r
\r
- Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2006 - 2017, 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
}\r
\r
+/**\r
+ This function allows a caller to extract the form set opcode form the Hii Handle.\r
+ The returned buffer is allocated using AllocatePool().The caller is responsible \r
+ for freeing the allocated buffer using FreePool().\r
+\r
+ @param Handle The HII handle.\r
+ @param Buffer On return, points to a pointer which point to the buffer that contain the formset opcode.\r
+ @param BufferSize On return, points to the length of the buffer.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.\r
+ @retval EFI_NOT_FOUND Can't find the package data for the input Handle.\r
+ @retval EFI_INVALID_PARAMETER The input parameters are not correct.\r
+ @retval EFI_SUCCESS Get the formset opcode from the hii handle successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HiiGetFormSetFromHiiHandle(\r
+ IN EFI_HII_HANDLE Handle,\r
+ OUT EFI_IFR_FORM_SET **Buffer,\r
+ OUT UINTN *BufferSize\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINTN PackageListSize;\r
+ UINTN TempSize;\r
+ EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
+ UINT8 *Package;\r
+ UINT8 *OpCodeData;\r
+ UINT8 *FormSetBuffer;\r
+ UINT8 *TempBuffer;\r
+ UINT32 Offset;\r
+ UINT32 Offset2;\r
+ UINT32 PackageListLength;\r
+ EFI_HII_PACKAGE_HEADER PackageHeader;\r
+\r
+ TempSize = 0;\r
+ FormSetBuffer = NULL;\r
+ TempBuffer = NULL;\r
+\r
+ //\r
+ // Get HII PackageList\r
+ //\r
+ PackageListSize = 0;\r
+ HiiPackageList = NULL;\r
+ Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &PackageListSize, HiiPackageList);\r
+ if (EFI_ERROR (Status) && (Status != EFI_BUFFER_TOO_SMALL)) {\r
+ return Status;\r
+ }\r
+\r
+ HiiPackageList = AllocatePool (PackageListSize);\r
+ if (HiiPackageList == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &PackageListSize, HiiPackageList);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Get Form package from this HII package List\r
+ //\r
+ Status = EFI_NOT_FOUND;\r
+ Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
+ PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);\r
+\r
+ while (Offset < PackageListLength) {\r
+ Package = ((UINT8 *) HiiPackageList) + Offset;\r
+ CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
+ Offset += PackageHeader.Length;\r
+\r
+ if (PackageHeader.Type != EFI_HII_PACKAGE_FORMS) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Search FormSet Opcode in this Form Package\r
+ //\r
+ Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);\r
+ while (Offset2 < PackageHeader.Length) {\r
+ OpCodeData = Package + Offset2;\r
+ Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
+\r
+ if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode != EFI_IFR_FORM_SET_OP) {\r
+ continue;\r
+ }\r
+\r
+ if (FormSetBuffer != NULL){\r
+ TempBuffer = AllocateCopyPool (TempSize + ((EFI_IFR_OP_HEADER *) OpCodeData)->Length, FormSetBuffer);\r
+ FreePool(FormSetBuffer);\r
+ FormSetBuffer = NULL;\r
+ if (TempBuffer == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Done;\r
+ }\r
+ CopyMem (TempBuffer + TempSize, OpCodeData, ((EFI_IFR_OP_HEADER *) OpCodeData)->Length);\r
+ } else {\r
+ TempBuffer = AllocateCopyPool (TempSize + ((EFI_IFR_OP_HEADER *) OpCodeData)->Length, OpCodeData);\r
+ if (TempBuffer == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Done;\r
+ }\r
+ }\r
+ TempSize += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r
+ FormSetBuffer = TempBuffer;\r
+\r
+ Status = EFI_SUCCESS;\r
+ //\r
+ //One form package has one formset, exit current form package to search other form package in the packagelist.\r
+ //\r
+ break;\r
+ }\r
+ }\r
+Done:\r
+ FreePool (HiiPackageList);\r
+\r
+ *BufferSize = TempSize;\r
+ *Buffer = (EFI_IFR_FORM_SET *)FormSetBuffer;\r
+\r
+ return Status;\r
+}\r
+\r
/**\r
Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for \r
hex digits that appear between a '=' and a '&' in a config string.\r
\r
@param[in] Guid Pointer to an EFI_GUID that is the routing information\r
GUID. Each of the 16 bytes in Guid is converted to \r
- a 2 Unicode character hexidecimal string. This is \r
+ a 2 Unicode character hexadecimal string. This is\r
an optional parameter that may be NULL.\r
@param[in] Name Pointer to a Null-terminated Unicode string that is \r
the routing information NAME. This is an optional \r
parameter that may be NULL. Each 16-bit Unicode \r
character in Name is converted to a 4 character Unicode \r
- hexidecimal string. \r
+ hexadecimal string.\r
@param[in] DriverHandle The driver handle which supports a Device Path Protocol\r
that is the routing information PATH. Each byte of\r
the Device Path associated with DriverHandle is converted\r
- to a 2 Unicode character hexidecimal string.\r
+ to a 2 Unicode character hexadecimal string.\r
\r
@retval NULL DriverHandle does not support the Device Path Protocol.\r
@retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string\r
CHAR16 *ReturnString;\r
UINTN Index;\r
UINT8 *Buffer;\r
+ UINTN MaxLen;\r
\r
//\r
// Compute the length of Name in Unicode characters. \r
// GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize <Null>\r
// | 5 | sizeof (EFI_GUID) * 2 | 6 | NameStrLen*4 | 6 | DevicePathSize * 2 | 1 |\r
//\r
- String = AllocateZeroPool ((5 + sizeof (EFI_GUID) * 2 + 6 + NameLength * 4 + 6 + DevicePathSize * 2 + 1) * sizeof (CHAR16));\r
+ MaxLen = 5 + sizeof (EFI_GUID) * 2 + 6 + NameLength * 4 + 6 + DevicePathSize * 2 + 1;\r
+ String = AllocateZeroPool (MaxLen * sizeof (CHAR16));\r
if (String == NULL) {\r
return NULL;\r
}\r
//\r
// Start with L"GUID="\r
//\r
- ReturnString = StrCpy (String, L"GUID=");\r
+ StrCpyS (String, MaxLen, L"GUID=");\r
+ ReturnString = String;\r
String += StrLen (String);\r
\r
if (Guid != NULL) {\r
// Append Guid converted to <HexCh>32\r
//\r
for (Index = 0, Buffer = (UINT8 *)Guid; Index < sizeof (EFI_GUID); Index++) {\r
- String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
+ UnicodeValueToStringS (\r
+ String,\r
+ MaxLen * sizeof (CHAR16) - ((UINTN)String - (UINTN)ReturnString),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ *(Buffer++),\r
+ 2\r
+ );\r
+ String += StrnLenS (String, MaxLen - ((UINTN)String - (UINTN)ReturnString) / sizeof (CHAR16));\r
}\r
}\r
\r
//\r
// Append L"&NAME="\r
//\r
- StrCpy (String, L"&NAME=");\r
+ StrCatS (ReturnString, MaxLen, L"&NAME=");\r
String += StrLen (String);\r
\r
if (Name != NULL) {\r
// Append Name converted to <Char>NameLength\r
//\r
for (; *Name != L'\0'; Name++) {\r
- String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *Name, 4);\r
+ UnicodeValueToStringS (\r
+ String,\r
+ sizeof (CHAR16) * MaxLen - ((UINTN)String - (UINTN)ReturnString),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ *Name,\r
+ 4\r
+ );\r
+ String += StrnLenS (String, MaxLen - ((UINTN)String - (UINTN)ReturnString) / sizeof (CHAR16));\r
}\r
}\r
\r
//\r
// Append L"&PATH="\r
//\r
- StrCpy (String, L"&PATH=");\r
+ StrCatS (ReturnString, MaxLen, L"&PATH=");\r
String += StrLen (String);\r
\r
//\r
// Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize\r
//\r
for (Index = 0, Buffer = (UINT8 *)DevicePath; Index < DevicePathSize; Index++) {\r
- String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
+ UnicodeValueToStringS (\r
+ String,\r
+ sizeof (CHAR16) * MaxLen - ((UINTN)String - (UINTN)ReturnString),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ *(Buffer++),\r
+ 2\r
+ );\r
+ String += StrnLenS (String, MaxLen - ((UINTN)String - (UINTN)ReturnString) / sizeof (CHAR16));\r
}\r
\r
//\r
StringPtr = (CHAR16 *) DataBuffer;\r
ZeroMem (TemStr, sizeof (TemStr));\r
for (Index = 0; Index < Length; Index += 4) {\r
- StrnCpy (TemStr, ConfigHdr + Index, 4);\r
+ StrnCpyS (TemStr, sizeof (TemStr) / sizeof (CHAR16), ConfigHdr + Index, 4);\r
StringPtr[Index/4] = (CHAR16) StrHexToUint64 (TemStr);\r
}\r
//\r
UINT64 VarValue;\r
EFI_IFR_TYPE_VALUE TmpValue;\r
EFI_STATUS Status;\r
- EFI_HII_PACKAGE_HEADER PacakgeHeader;\r
+ EFI_HII_PACKAGE_HEADER PackageHeader;\r
UINT32 PackageOffset;\r
UINT8 *PackageData;\r
UINTN IfrOffset;\r
//\r
PackageOffset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
while (PackageOffset < PackageListLength) {\r
- CopyMem (&PacakgeHeader, (UINT8 *) HiiPackageList + PackageOffset, sizeof (PacakgeHeader));\r
+ CopyMem (&PackageHeader, (UINT8 *) HiiPackageList + PackageOffset, sizeof (PackageHeader));\r
\r
//\r
// Parse IFR opcode from the form package.\r
//\r
- if (PacakgeHeader.Type == EFI_HII_PACKAGE_FORMS) {\r
- IfrOffset = sizeof (PacakgeHeader);\r
+ if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {\r
+ IfrOffset = sizeof (PackageHeader);\r
PackageData = (UINT8 *) HiiPackageList + PackageOffset;\r
- while (IfrOffset < PacakgeHeader.Length) {\r
+ while (IfrOffset < PackageHeader.Length) {\r
IfrOpHdr = (EFI_IFR_OP_HEADER *) (PackageData + IfrOffset);\r
//\r
// Validate current setting to the value built in IFR opcode\r
//\r
// Go to next package.\r
//\r
- PackageOffset += PacakgeHeader.Length;\r
+ PackageOffset += PackageHeader.Length;\r
}\r
\r
return EFI_SUCCESS;\r
//\r
// Check whether VarBuffer is enough\r
//\r
- if ((UINTN) (Offset + Width) > MaxBufferSize) {\r
+ if ((UINT32)Offset + Width > MaxBufferSize) {\r
DataBuffer = ReallocatePool (\r
MaxBufferSize,\r
Offset + Width + HII_LIB_DEFAULT_VARSTORE_SIZE,\r
@param DefaultId Specifies the type of defaults to retrieve only for setting default action.\r
@param ActionType Action supports setting defaults and validate current setting.\r
\r
- @retval TURE Action runs successfully.\r
+ @retval TRUE Action runs successfully.\r
@retval FALSE Action is not valid or Action can't be executed successfully..\r
**/\r
BOOLEAN\r
\r
EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
UINTN PackageListLength;\r
+ UINTN MaxLen;\r
EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
\r
}\r
\r
StringPtr = ConfigAltResp;\r
- \r
- while (StringPtr != L'\0') {\r
+ ASSERT (StringPtr != NULL);\r
+\r
+ while (*StringPtr != L'\0') {\r
//\r
// 1. Find <ConfigHdr> GUID=...&NAME=...&PATH=...\r
//\r
// Construct ConfigAltHdr string "&<ConfigHdr>&ALTCFG=\0" \r
// | 1 | StrLen (ConfigHdr) | 8 | 1 |\r
//\r
- ConfigAltHdr = AllocateZeroPool ((1 + StringPtr - StringHdr + 8 + 1) * sizeof (CHAR16));\r
+ MaxLen = 1 + StringPtr - StringHdr + 8 + 1;\r
+ ConfigAltHdr = AllocateZeroPool ( MaxLen * sizeof (CHAR16));\r
if (ConfigAltHdr == NULL) {\r
Status = EFI_OUT_OF_RESOURCES;\r
goto Done;\r
}\r
- StrCpy (ConfigAltHdr, L"&");\r
- StrnCat (ConfigAltHdr, StringHdr, StringPtr - StringHdr);\r
- StrCat (ConfigAltHdr, L"&ALTCFG=");\r
+ StrCpyS (ConfigAltHdr, MaxLen, L"&");\r
+ StrnCatS (ConfigAltHdr, MaxLen, StringHdr, StringPtr - StringHdr);\r
+ StrCatS (ConfigAltHdr, MaxLen, L"&ALTCFG=");\r
\r
//\r
// Skip all AltResp (AltConfigHdr ConfigBody) for the same ConfigHdr\r
entirety of the current HII database will be reset.\r
@param DefaultId Specifies the type of defaults to retrieve.\r
\r
- @retval TURE The default value is set successfully.\r
+ @retval TRUE The default value is set successfully.\r
@retval FALSE The default value can't be found and set.\r
**/\r
BOOLEAN\r
UINTN BufferSize;\r
UINT8 *UpdateBufferPos;\r
EFI_HII_PACKAGE_HEADER *Package;\r
- EFI_HII_PACKAGE_HEADER *TempPacakge;\r
+ EFI_HII_PACKAGE_HEADER *TempPackage;\r
EFI_HII_PACKAGE_HEADER PackageHeader;\r
BOOLEAN Updated;\r
HII_LIB_OPCODE_BUFFER *OpCodeBufferStart;\r
ASSERT (HiiHandle != NULL);\r
ASSERT (StartOpCodeHandle != NULL);\r
UpdatePackageList = NULL;\r
- TempPacakge = NULL;\r
+ TempPackage = NULL;\r
HiiPackageList = NULL;\r
\r
//\r
//\r
// Allocate temp buffer to store the temp updated package buffer\r
//\r
- TempPacakge = AllocateZeroPool (BufferSize);\r
- if (TempPacakge == NULL) {\r
+ TempPackage = AllocateZeroPool (BufferSize);\r
+ if (TempPackage == NULL) {\r
Status = EFI_OUT_OF_RESOURCES;\r
goto Finish;\r
}\r
//\r
// Check this package is the matched package.\r
//\r
- Status = InternalHiiUpdateFormPackageData (FormSetGuid, FormId, Package, OpCodeBufferStart, OpCodeBufferEnd, TempPacakge);\r
+ Status = InternalHiiUpdateFormPackageData (FormSetGuid, FormId, Package, OpCodeBufferStart, OpCodeBufferEnd, TempPackage);\r
//\r
// The matched package is found. Its package buffer will be updated by the input new data.\r
//\r
//\r
// Add updated package buffer\r
//\r
- Package = TempPacakge;\r
+ Package = TempPackage;\r
}\r
}\r
\r
FreePool (UpdatePackageList);\r
}\r
\r
- if (TempPacakge != NULL) {\r
- FreePool (TempPacakge);\r
+ if (TempPackage != NULL) {\r
+ FreePool (TempPackage);\r
}\r
\r
return Status; \r