/** @file\r
HII Library implementation that uses DXE protocols and services.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2010, 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
/**\r
Registers a list of packages in the HII Database and returns the HII Handle\r
associated with that registration. If an HII Handle has already been registered\r
- with the same PackageListGuid, then NULL is returned. If there are not enough \r
- resources to perform the registration, then NULL is returned. If an empty list \r
- of packages is passed in, then NULL is returned. If the size of the list of \r
- package is 0, then NULL is returned.\r
+ with the same PackageListGuid and DeviceHandle, then NULL is returned. If there\r
+ are not enough resources to perform the registration, then NULL is returned.\r
+ If an empty list of packages is passed in, then NULL is returned. If the size of\r
+ the list of package is 0, then NULL is returned.\r
\r
The variable arguments are pointers which point to package header that defined \r
by UEFI VFR compiler and StringGather tool.\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_HII_HANDLE *HiiHandleBuffer;\r
VA_LIST Args;\r
UINT32 *Package;\r
EFI_HII_PACKAGE_LIST_HEADER *PackageListHeader;\r
\r
ASSERT (PackageListGuid != NULL);\r
\r
- //\r
- // Check to see if an HII Handle has already been registered with the same \r
- // PackageListGuid\r
- //\r
- HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);\r
- if (HiiHandleBuffer != NULL) {\r
- FreePool (HiiHandleBuffer);\r
- return NULL;\r
- }\r
-\r
//\r
// Calculate the length of all the packages in the variable argument list\r
//\r
PackageListHeader = AllocateZeroPool (Length);\r
\r
//\r
- // If the Packahge List can not be allocated, then return a NULL HII Handle\r
+ // If the Package List can not be allocated, then return a NULL HII Handle\r
//\r
if (PackageListHeader == NULL) {\r
return NULL;\r
\r
\r
/**\r
- Retrieves the array of all the HII Handles or the HII handle of a specific\r
- package list in the HII Database.\r
+ Retrieves the array of all the HII Handles or the HII handles of a specific\r
+ package list GUID in the HII Database.\r
This array is terminated with a NULL HII Handle.\r
This function allocates the returned array using AllocatePool().\r
The caller is responsible for freeing the array with FreePool().\r
\r
@param[in] PackageListGuid An optional parameter that is used to request \r
- an HII Handle that is associatd with a specific\r
- Package List GUID. If this parameter is NULL\r
+ HII Handles associated with a specific\r
+ Package List GUID. If this parameter is NULL,\r
then all the HII Handles in the HII Database\r
- are returned. If this parameter is not NULL\r
- then at most 1 HII Handle is returned.\r
+ are returned. If this parameter is not NULL,\r
+ then zero or more HII Handles associated with \r
+ PackageListGuid are returned.\r
\r
@retval NULL No HII handles were found in the HII database\r
@retval NULL The array of HII Handles could not be retrieved\r
EFI_HII_HANDLE TempHiiHandleBuffer;\r
EFI_HII_HANDLE *HiiHandleBuffer;\r
EFI_GUID Guid;\r
- UINTN Index;\r
+ UINTN Index1;\r
+ UINTN Index2;\r
\r
//\r
// Retrieve the size required for the buffer of all HII handles.\r
//\r
return HiiHandleBuffer;\r
} else {\r
- for (Index = 0; HiiHandleBuffer[Index] != NULL; Index++) {\r
- Status = InternalHiiExtractGuidFromHiiHandle (HiiHandleBuffer[Index], &Guid);\r
+ for (Index1 = 0, Index2 = 0; HiiHandleBuffer[Index1] != NULL; Index1++) {\r
+ Status = InternalHiiExtractGuidFromHiiHandle (HiiHandleBuffer[Index1], &Guid);\r
ASSERT_EFI_ERROR (Status);\r
if (CompareGuid (&Guid, PackageListGuid)) {\r
- HiiHandleBuffer[0] = HiiHandleBuffer[Index];\r
- HiiHandleBuffer[1] = NULL;\r
- return HiiHandleBuffer;\r
+ HiiHandleBuffer[Index2++] = HiiHandleBuffer[Index1]; \r
}\r
}\r
- FreePool (HiiHandleBuffer);\r
- return NULL;\r
+ if (Index2 > 0) {\r
+ HiiHandleBuffer[Index2] = NULL;\r
+ return HiiHandleBuffer;\r
+ } else {\r
+ FreePool (HiiHandleBuffer);\r
+ return NULL;\r
+ }\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
- If String is NULL, then ASSERT().\r
+ If ConfigString is NULL, then ASSERT().\r
\r
- @param[in] String Pointer to a Null-terminated Unicode string.\r
+ @param[in] ConfigString Pointer to a Null-terminated Unicode string.\r
\r
@return Pointer to the Null-terminated Unicode result string.\r
\r
allocated using AllocatePool(). The caller is then responsible for freeing \r
the buffer using FreePool().\r
\r
- @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
- is an optional parameter that may be NULL.\r
@param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional \r
parameter that may be NULL.\r
+ @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
+ is an optional parameter that may be NULL.\r
@param[in] SetResultsData If not NULL, then this parameter specified the buffer\r
of uncommited data to set. If this parameter is NULL,\r
then the caller is requesting to get the uncommited data\r
StringPtr = StrStr (ConfigResp, L"&OFFSET");\r
if (StringPtr == NULL) {\r
//\r
- // No ConfigBlock value is requied to be validated.\r
+ // No ConfigBlock value is required to be validated.\r
// EFI_SUCCESS directly return.\r
//\r
return EFI_SUCCESS;\r
}\r
\r
//\r
- // 2. Check IFR value is in block data, then Validate Vaule\r
+ // 2. Check IFR value is in block data, then Validate Value\r
//\r
ZeroMem (&VarBlockData, sizeof (VarBlockData));\r
VarValue = 0;\r
}\r
break;\r
case EFI_IFR_FORM_OP:\r
+ case EFI_IFR_FORM_MAP_OP:\r
//\r
// Check the matched VarStoreId is found.\r
//\r
\r
//\r
// 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)\r
- // Get the default configuration string according to the found defaultname string ID.\r
+ // Get the default configuration string according to the found default name string ID.\r
//\r
Status = gHiiConfigRouting->GetAltConfig (\r
gHiiConfigRouting,\r
@param StartSearchString Pointer to the Null-terminated Unicode string that \r
marks the start of the value string to compare.\r
@param StopSearchString Pointer to the Null-terminated Unicode string that \r
- marks the end of the vakue string to compare.\r
+ marks the end of the value string to compare.\r
\r
@retval FALSE StartSearchString is not present in FirstString. \r
@retval FALSE StartSearchString is not present in SecondString.\r
}\r
\r
/**\r
- Retrieves uncommited data from the Form Browser and converts it to a binary\r
+ Retrieves uncommitted data from the Form Browser and converts it to a binary\r
buffer.\r
\r
- @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
- is an optional parameter that may be NULL.\r
@param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional \r
parameter that may be NULL.\r
- @param[in] BufferSize Length in bytes of buffer to hold retrived data. \r
- @param[out] Block Buffer of data to be updated.\r
+ @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
+ is an optional parameter that may be NULL.\r
+ @param[in] BufferSize Length in bytes of buffer to hold retrieved data. \r
+ @param[out] Buffer Buffer of data to be updated.\r
\r
@retval FALSE The uncommitted data could not be retrieved.\r
@retval TRUE The uncommitted data was retrieved.\r
HiiGetBrowserData (\r
IN CONST EFI_GUID *VariableGuid, OPTIONAL\r
IN CONST CHAR16 *VariableName, OPTIONAL\r
- IN UINTN BlockSize,\r
- OUT UINT8 *Block\r
+ IN UINTN BufferSize,\r
+ OUT UINT8 *Buffer\r
)\r
{\r
EFI_STRING ResultsData;\r
Status = gHiiConfigRouting->ConfigToBlock (\r
gHiiConfigRouting,\r
ConfigResp,\r
- Block,\r
- &BlockSize,\r
+ Buffer,\r
+ &BufferSize,\r
&Progress\r
);\r
//\r
\r
If Buffer is NULL, then ASSERT().\r
\r
- @param[in] VariableName Pointer to a Null-terminated Unicode string. This\r
- is an optional parameter that may be NULL.\r
@param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional\r
parameter that may be NULL.\r
+ @param[in] VariableName Pointer to a Null-terminated Unicode string. This\r
+ is an optional parameter that may be NULL.\r
@param[in] BufferSize Length, in bytes, of Buffer.\r
@param[in] Buffer Buffer of data to commit.\r
@param[in] RequestElement An optional field to specify which part of the\r
}\r
\r
/**\r
- Frees an OpCode Handle that was peviously allocated with HiiAllocateOpCodeHandle().\r
+ Frees an OpCode Handle that was previously allocated with HiiAllocateOpCodeHandle().\r
When an OpCode Handle is freed, all of the opcodes associated with the OpCode\r
Handle are also freed.\r
\r
If OpCodeHandle is NULL, then ASSERT().\r
\r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+\r
**/\r
VOID\r
EFIAPI\r
FreePool (OpCodeBuffer);\r
}\r
\r
+/**\r
+ Internal function gets the current position of opcode buffer.\r
+ \r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+\r
+ @return Current position of opcode buffer.\r
+**/\r
UINTN\r
EFIAPI\r
InternalHiiOpCodeHandlePosition (\r
return ((HII_LIB_OPCODE_BUFFER *)OpCodeHandle)->Position;\r
}\r
\r
+/**\r
+ Internal function gets the start pointer of opcode buffer.\r
+ \r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+\r
+ @return Pointer to the opcode buffer base.\r
+**/\r
UINT8 *\r
EFIAPI\r
InternalHiiOpCodeHandleBuffer (\r
return ((HII_LIB_OPCODE_BUFFER *)OpCodeHandle)->Buffer;\r
}\r
\r
+/**\r
+ Internal function reserves the enough buffer for current opcode.\r
+ When the buffer is not enough, Opcode buffer will be extended.\r
+ \r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+ @param[in] Size Size of current opcode.\r
+\r
+ @return Pointer to the current opcode.\r
+**/\r
UINT8 *\r
EFIAPI\r
InternalHiiGrowOpCodeHandle (\r
- VOID *OpCodeHandle,\r
- UINTN Size\r
+ IN VOID *OpCodeHandle,\r
+ IN UINTN Size\r
)\r
{\r
HII_LIB_OPCODE_BUFFER *OpCodeBuffer;\r
return Buffer;\r
}\r
\r
+/**\r
+ Internal function creates opcode based on the template opcode.\r
+ \r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+ @param[in] OpCodeTemplate Pointer to the template buffer of opcode.\r
+ @param[in] OpCode OpCode IFR value.\r
+ @param[in] OpCodeSize Size of opcode.\r
+ @param[in] ExtensionSize Size of extended opcode.\r
+ @param[in] Scope Scope bit of opcode.\r
+\r
+ @return Pointer to the current opcode with opcode data.\r
+**/\r
UINT8 *\r
EFIAPI\r
InternalHiiCreateOpCodeExtended (\r
return (UINT8 *)CopyMem (Buffer, Header, OpCodeSize);\r
}\r
\r
+/**\r
+ Internal function creates opcode based on the template opcode for the normal opcode.\r
+ \r
+ @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
+ @param[in] OpCodeTemplate Pointer to the template buffer of opcode.\r
+ @param[in] OpCode OpCode IFR value.\r
+ @param[in] OpCodeSize Size of opcode.\r
+\r
+ @return Pointer to the current opcode with opcode data.\r
+**/\r
UINT8 *\r
EFIAPI\r
InternalHiiCreateOpCode (\r
This is the internal worker function to update the data in\r
a form specified by FormSetGuid, FormId and Label.\r
\r
- @param FormSetGuid The optional Formset GUID.\r
- @param FormId The Form ID.\r
- @param Package The package header.\r
-\r
- @param TempPacakge The resultant package.\r
+ @param[in] FormSetGuid The optional Formset GUID.\r
+ @param[in] FormId The Form ID.\r
+ @param[in] Package The package header.\r
+ @param[in] OpCodeBufferStart An OpCode buffer that contains the set of IFR \r
+ opcodes to be inserted or replaced in the form.\r
+ @param[in] OpCodeBufferEnd An OpCcode buffer that contains the IFR opcode\r
+ that marks the end of a replace operation in the form.\r
+ @param[out] TempPackage The resultant package.\r
\r
@retval EFI_SUCCESS The function completes successfully.\r
+ @retval EFI_NOT_FOUND The updated opcode or endopcode is not found.\r
\r
**/\r
EFI_STATUS\r
} else {\r
GetFormSet = FALSE;\r
}\r
- } else if (IfrOpHdr->OpCode == EFI_IFR_FORM_OP) {\r
+ } else if (IfrOpHdr->OpCode == EFI_IFR_FORM_OP || IfrOpHdr->OpCode == EFI_IFR_FORM_MAP_OP) {\r
if (CompareMem (&((EFI_IFR_FORM *) IfrOpHdr)->FormId, &FormId, sizeof (EFI_FORM_ID)) == 0) {\r
GetForm = TRUE;\r
} else {\r
The form to update is specified by Handle, FormSetGuid, and FormId. Binary \r
comparisons of IFR opcodes are performed from the beginning of the form being \r
updated until an IFR opcode is found that exactly matches the first IFR opcode \r
- specifed by StartOpCodeHandle. The following rules are used to determine if\r
+ specified by StartOpCodeHandle. The following rules are used to determine if\r
an insert, replace, or delete operation is performed.\r
\r
1) If no matches are found, then NULL is returned. \r
2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes\r
- from StartOpcodeHandle except the first opcode are inserted immediately after \r
- the matching IFR opcode in the form beng updated.\r
+ from StartOpCodeHandle except the first opcode are inserted immediately after \r
+ the matching IFR opcode in the form to be updated.\r
3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made \r
- from the matching IFR opcode until an IFR opcode exatly matches the first \r
+ from the matching IFR opcode until an IFR opcode exactly matches the first \r
IFR opcode specified by EndOpCodeHandle. If no match is found for the first\r
IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match\r
is found, then all of the IFR opcodes between the start match and the end \r
match are deleted from the form being updated and all of the IFR opcodes\r
- from StartOpcodeHandle except the first opcode are inserted immediately after \r
+ from StartOpCodeHandle except the first opcode are inserted immediately after \r
the matching start IFR opcode. If StartOpCcodeHandle only contains one\r
- IFR instruction, then the result of ths operation will delete all of the IFR\r
+ IFR instruction, then the result of this operation will delete all of the IFR\r
opcodes between the start end matches.\r
\r
If HiiHandle is NULL, then ASSERT().\r
IN EFI_HII_HANDLE HiiHandle, \r
IN EFI_GUID *FormSetGuid, OPTIONAL\r
IN EFI_FORM_ID FormId,\r
- IN VOID *StartOpcodeHandle,\r
- IN VOID *EndOpcodeHandle OPTIONAL\r
+ IN VOID *StartOpCodeHandle,\r
+ IN VOID *EndOpCodeHandle OPTIONAL\r
)\r
{\r
EFI_STATUS Status;\r
// Input update data can't be NULL.\r
//\r
ASSERT (HiiHandle != NULL);\r
- ASSERT (StartOpcodeHandle != NULL);\r
+ ASSERT (StartOpCodeHandle != NULL);\r
UpdatePackageList = NULL;\r
TempPacakge = NULL;\r
HiiPackageList = NULL;\r
\r
//\r
- // Restrive buffer data from Opcode Handle\r
+ // Retrieve buffer data from Opcode Handle\r
//\r
- OpCodeBufferStart = (HII_LIB_OPCODE_BUFFER *) StartOpcodeHandle;\r
- OpCodeBufferEnd = (HII_LIB_OPCODE_BUFFER *) EndOpcodeHandle;\r
+ OpCodeBufferStart = (HII_LIB_OPCODE_BUFFER *) StartOpCodeHandle;\r
+ OpCodeBufferEnd = (HII_LIB_OPCODE_BUFFER *) EndOpCodeHandle;\r
\r
//\r
- // Get the orginal package list\r
+ // Get the original package list\r
//\r
BufferSize = 0;\r
HiiPackageList = NULL;\r
UpdateBufferPos += sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
\r
//\r
- // Go through each package to find the matched pacakge and update one by one\r
+ // Go through each package to find the matched package and update one by one\r
//\r
Updated = FALSE;\r
Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
//\r
Status = InternalHiiUpdateFormPackageData (FormSetGuid, FormId, Package, OpCodeBufferStart, OpCodeBufferEnd, TempPacakge);\r
//\r
- // The matched package is found. Its pacakge buffer will be updated by the input new data.\r
+ // The matched package is found. Its package buffer will be updated by the input new data.\r
//\r
if (!EFI_ERROR(Status)) {\r
//\r
WriteUnaligned32 (&UpdatePackageList->PackageLength, (UINT32) BufferSize);\r
\r
//\r
- // Update Pacakge to show form\r
+ // Update Package to show form\r
//\r
Status = gHiiDatabase->UpdatePackageList (gHiiDatabase, HiiHandle, UpdatePackageList);\r
} else {\r
projects / mirror_edk2.git / blobdiff