2 Parser for IFR binary encoding.
4 Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 UINT16 mStatementIndex
;
18 UINT16 mExpressionOpCodeIndex
;
19 EFI_QUESTION_ID mUsedQuestionId
;
20 BOOLEAN mInScopeSubtitle
;
21 extern LIST_ENTRY gBrowserStorageList
;
23 Initialize Statement header members.
25 @param OpCodeData Pointer of the raw OpCode data.
26 @param FormSet Pointer of the current FormSe.
27 @param Form Pointer of the current Form.
29 @return The Statement.
32 FORM_BROWSER_STATEMENT
*
35 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
36 IN OUT FORM_BROWSER_FORM
*Form
39 FORM_BROWSER_STATEMENT
*Statement
;
40 EFI_IFR_STATEMENT_HEADER
*StatementHdr
;
41 INTN ConditionalExprCount
;
45 // Only guid op may out side the form level.
47 ASSERT (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
== EFI_IFR_GUID_OP
);
50 Statement
= &FormSet
->StatementBuffer
[mStatementIndex
];
53 InitializeListHead (&Statement
->DefaultListHead
);
54 InitializeListHead (&Statement
->OptionListHead
);
55 InitializeListHead (&Statement
->InconsistentListHead
);
56 InitializeListHead (&Statement
->NoSubmitListHead
);
58 Statement
->Signature
= FORM_BROWSER_STATEMENT_SIGNATURE
;
60 Statement
->Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
61 Statement
->OpCode
= (EFI_IFR_OP_HEADER
*) OpCodeData
;
63 StatementHdr
= (EFI_IFR_STATEMENT_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
64 CopyMem (&Statement
->Prompt
, &StatementHdr
->Prompt
, sizeof (EFI_STRING_ID
));
65 CopyMem (&Statement
->Help
, &StatementHdr
->Help
, sizeof (EFI_STRING_ID
));
67 ConditionalExprCount
= GetConditionalExpressionCount(ExpressStatement
);
68 if (ConditionalExprCount
> 0) {
70 // Form is inside of suppressif
73 Statement
->Expression
= (FORM_EXPRESSION_LIST
*) AllocatePool(
74 (UINTN
) (sizeof(FORM_EXPRESSION_LIST
) + ((ConditionalExprCount
-1) * sizeof(FORM_EXPRESSION
*))));
75 ASSERT (Statement
->Expression
!= NULL
);
76 Statement
->Expression
->Count
= (UINTN
) ConditionalExprCount
;
77 Statement
->Expression
->Signature
= FORM_EXPRESSION_LIST_SIGNATURE
;
78 CopyMem (Statement
->Expression
->Expression
, GetConditionalExpressionList(ExpressStatement
), (UINTN
) (sizeof (FORM_EXPRESSION
*) * ConditionalExprCount
));
81 Statement
->InSubtitle
= mInScopeSubtitle
;
84 // Insert this Statement into current Form
87 InsertTailList (&FormSet
->StatementListOSF
, &Statement
->Link
);
89 InsertTailList (&Form
->StatementListHead
, &Statement
->Link
);
95 Convert a numeric value to a Unicode String and insert it to String Package.
96 This string is used as the Unicode Name for the EFI Variable. This is to support
97 the deprecated vareqval opcode.
99 @param FormSet The FormSet.
100 @param Statement The numeric question whose VarStoreInfo.VarName is the
101 numeric value which is used to produce the Unicode Name
102 for the EFI Variable.
104 If the Statement is NULL, the ASSERT.
105 If the opcode is not Numeric, then ASSERT.
107 @retval EFI_SUCCESS The funtion always succeeds.
110 UpdateCheckBoxStringToken (
111 IN CONST FORM_BROWSER_FORMSET
*FormSet
,
112 IN FORM_BROWSER_STATEMENT
*Statement
115 CHAR16 Str
[MAXIMUM_VALUE_CHARACTERS
];
118 ASSERT (Statement
!= NULL
);
119 ASSERT (Statement
->Operand
== EFI_IFR_NUMERIC_OP
);
121 UnicodeValueToString (Str
, 0, Statement
->VarStoreInfo
.VarName
, MAXIMUM_VALUE_CHARACTERS
- 1);
123 Id
= HiiSetString (FormSet
->HiiHandle
, 0, Str
, NULL
);
125 return EFI_OUT_OF_RESOURCES
;
128 Statement
->VarStoreInfo
.VarName
= Id
;
134 Check if the next opcode is the EFI_IFR_EXTEND_OP_VAREQNAME.
136 @param OpCodeData The current opcode.
142 IsNextOpCodeGuidedVarEqName (
149 OpCodeData
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
150 if (*OpCodeData
== EFI_IFR_GUID_OP
) {
151 if (CompareGuid (&gEfiIfrFrameworkGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
153 // Specific GUIDed opcodes to support IFR generated from Framework HII VFR
155 if ((((EFI_IFR_GUID_VAREQNAME
*) OpCodeData
)->ExtendOpCode
) == EFI_IFR_EXTEND_OP_VAREQNAME
) {
165 Initialize Question's members.
167 @param OpCodeData Pointer of the raw OpCode data.
168 @param FormSet Pointer of the current FormSet.
169 @param Form Pointer of the current Form.
171 @return The Question.
174 FORM_BROWSER_STATEMENT
*
176 IN UINT8
*OpCodeData
,
177 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
178 IN OUT FORM_BROWSER_FORM
*Form
181 FORM_BROWSER_STATEMENT
*Statement
;
182 EFI_IFR_QUESTION_HEADER
*QuestionHdr
;
184 FORMSET_STORAGE
*Storage
;
185 NAME_VALUE_NODE
*NameValueNode
;
189 Statement
= CreateStatement (OpCodeData
, FormSet
, Form
);
190 if (Statement
== NULL
) {
194 QuestionHdr
= (EFI_IFR_QUESTION_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
195 CopyMem (&Statement
->QuestionId
, &QuestionHdr
->QuestionId
, sizeof (EFI_QUESTION_ID
));
196 CopyMem (&Statement
->VarStoreId
, &QuestionHdr
->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
197 CopyMem (&Statement
->VarStoreInfo
.VarOffset
, &QuestionHdr
->VarStoreInfo
.VarOffset
, sizeof (UINT16
));
199 Statement
->QuestionFlags
= QuestionHdr
->Flags
;
201 if (Statement
->VarStoreId
== 0) {
203 // VarStoreId of zero indicates no variable storage
209 // Take a look at next OpCode to see whether it is a GUIDed opcode to support
210 // Framework Compatibility
212 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport
)) {
213 if ((*OpCodeData
== EFI_IFR_NUMERIC_OP
) && IsNextOpCodeGuidedVarEqName (OpCodeData
)) {
214 Status
= UpdateCheckBoxStringToken (FormSet
, Statement
);
215 if (EFI_ERROR (Status
)) {
222 // Find Storage for this Question
224 Link
= GetFirstNode (&FormSet
->StorageListHead
);
225 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
226 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
228 if (Storage
->VarStoreId
== Statement
->VarStoreId
) {
229 Statement
->Storage
= Storage
->BrowserStorage
;
233 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
235 ASSERT (Statement
->Storage
!= NULL
);
238 // Initialilze varname for Name/Value or EFI Variable
240 if ((Statement
->Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) ||
241 (Statement
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
)) {
242 Statement
->VariableName
= GetToken (Statement
->VarStoreInfo
.VarName
, FormSet
->HiiHandle
);
243 ASSERT (Statement
->VariableName
!= NULL
);
245 if (Statement
->Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
247 // Check whether old string node already exist.
250 if (!IsListEmpty(&Statement
->Storage
->NameValueListHead
)) {
251 Link
= GetFirstNode (&Statement
->Storage
->NameValueListHead
);
252 while (!IsNull (&Statement
->Storage
->NameValueListHead
, Link
)) {
253 NameValueNode
= NAME_VALUE_NODE_FROM_LINK (Link
);
255 if (StrCmp (Statement
->VariableName
, NameValueNode
->Name
) == 0) {
260 Link
= GetNextNode (&Statement
->Storage
->NameValueListHead
, Link
);
266 // Insert to Name/Value varstore list
268 NameValueNode
= AllocateZeroPool (sizeof (NAME_VALUE_NODE
));
269 ASSERT (NameValueNode
!= NULL
);
270 NameValueNode
->Signature
= NAME_VALUE_NODE_SIGNATURE
;
271 NameValueNode
->Name
= AllocateCopyPool (StrSize (Statement
->VariableName
), Statement
->VariableName
);
272 ASSERT (NameValueNode
->Name
!= NULL
);
273 NameValueNode
->Value
= AllocateZeroPool (0x10);
274 ASSERT (NameValueNode
->Value
!= NULL
);
275 NameValueNode
->EditValue
= AllocateZeroPool (0x10);
276 ASSERT (NameValueNode
->EditValue
!= NULL
);
278 InsertTailList (&Statement
->Storage
->NameValueListHead
, &NameValueNode
->Link
);
288 Allocate a FORM_EXPRESSION node.
290 @param Form The Form associated with this Expression
292 @return Pointer to a FORM_EXPRESSION data structure.
297 IN OUT FORM_BROWSER_FORM
*Form
300 FORM_EXPRESSION
*Expression
;
302 Expression
= AllocateZeroPool (sizeof (FORM_EXPRESSION
));
303 ASSERT (Expression
!= NULL
);
304 Expression
->Signature
= FORM_EXPRESSION_SIGNATURE
;
305 InitializeListHead (&Expression
->OpCodeListHead
);
311 Create ConfigHdr string for a storage.
313 @param FormSet Pointer of the current FormSet
314 @param Storage Pointer of the storage
316 @retval EFI_SUCCESS Initialize ConfigHdr success
320 InitializeConfigHdr (
321 IN FORM_BROWSER_FORMSET
*FormSet
,
322 IN OUT BROWSER_STORAGE
*Storage
327 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
328 Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
329 Name
= Storage
->Name
;
334 Storage
->ConfigHdr
= HiiConstructConfigHdr (
337 FormSet
->DriverHandle
340 if (Storage
->ConfigHdr
== NULL
) {
341 return EFI_NOT_FOUND
;
348 Find the global storage link base on the input storate type, name and guid.
350 @param StorageType Storage type.
351 @param StorageGuid Storage guid.
352 @param StorageName Storage Name.
354 @return Pointer to a GLOBAL_STORAGE data structure.
359 IN UINT8 StorageType
,
360 IN EFI_GUID
*StorageGuid
,
361 IN CHAR16
*StorageName
365 BROWSER_STORAGE
*BrowserStorage
;
367 Link
= GetFirstNode (&gBrowserStorageList
);
368 while (!IsNull (&gBrowserStorageList
, Link
)) {
369 BrowserStorage
= BROWSER_STORAGE_FROM_LINK (Link
);
371 if ((BrowserStorage
->Type
== StorageType
) && CompareGuid (&BrowserStorage
->Guid
, StorageGuid
)) {
372 if (StorageType
== EFI_HII_VARSTORE_NAME_VALUE
) {
373 return BrowserStorage
;
376 if (StrCmp (BrowserStorage
->Name
, StorageName
) == 0) {
377 return BrowserStorage
;
384 Link
= GetNextNode (&gBrowserStorageList
, Link
);
391 Intialize the Global Storage.
393 @param BrowserStorage Pointer to the global storage.
394 @param StorageType Storage type.
395 @param OpCodeData Binary data for this opcode.
399 IntializeBrowserStorage (
400 IN BROWSER_STORAGE
*BrowserStorage
,
401 IN UINT8 StorageType
,
405 switch (StorageType
) {
406 case EFI_HII_VARSTORE_BUFFER
:
407 CopyMem (&BrowserStorage
->Guid
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
408 CopyMem (&BrowserStorage
->Size
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Size
, sizeof (UINT16
));
410 BrowserStorage
->Buffer
= AllocateZeroPool (BrowserStorage
->Size
);
411 BrowserStorage
->EditBuffer
= AllocateZeroPool (BrowserStorage
->Size
);
414 case EFI_HII_VARSTORE_EFI_VARIABLE
:
415 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
416 CopyMem (&BrowserStorage
->Guid
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
417 CopyMem (&BrowserStorage
->Attributes
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Attributes
, sizeof (UINT32
));
418 CopyMem (&BrowserStorage
->Size
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Size
, sizeof (UINT16
));
420 if (StorageType
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
421 BrowserStorage
->Buffer
= AllocateZeroPool (BrowserStorage
->Size
);
422 BrowserStorage
->EditBuffer
= AllocateZeroPool (BrowserStorage
->Size
);
426 case EFI_HII_VARSTORE_NAME_VALUE
:
427 CopyMem (&BrowserStorage
->Guid
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
429 InitializeListHead (&BrowserStorage
->NameValueListHead
);
438 Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.
440 @param FormSet Pointer of the current FormSet
441 @param StorageType Storage type.
442 @param OpCodeData Binary data for this opcode.
444 @return Pointer to a FORMSET_STORAGE data structure.
449 IN FORM_BROWSER_FORMSET
*FormSet
,
450 IN UINT8 StorageType
,
454 FORMSET_STORAGE
*Storage
;
455 CHAR16
*UnicodeString
;
457 BROWSER_STORAGE
*BrowserStorage
;
458 EFI_GUID
*StorageGuid
;
461 UnicodeString
= NULL
;
463 switch (StorageType
) {
464 case EFI_HII_VARSTORE_BUFFER
:
465 StorageGuid
= (EFI_GUID
*) (CHAR8
*) &((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
;
466 StorageName
= (CHAR8
*) ((EFI_IFR_VARSTORE
*) OpCodeData
)->Name
;
469 case EFI_HII_VARSTORE_EFI_VARIABLE
:
470 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
471 StorageGuid
= (EFI_GUID
*) (CHAR8
*) &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
;
472 StorageName
= (CHAR8
*) ((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Name
;
476 ASSERT (StorageType
== EFI_HII_VARSTORE_NAME_VALUE
);
477 StorageGuid
= &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->Guid
;
481 if (StorageType
!= EFI_HII_VARSTORE_NAME_VALUE
) {
482 ASSERT (StorageName
!= NULL
);
484 UnicodeString
= AllocateZeroPool (AsciiStrSize (StorageName
) * 2);
485 ASSERT (UnicodeString
!= NULL
);
486 for (Index
= 0; StorageName
[Index
] != 0; Index
++) {
487 UnicodeString
[Index
] = (CHAR16
) StorageName
[Index
];
491 Storage
= AllocateZeroPool (sizeof (FORMSET_STORAGE
));
492 ASSERT (Storage
!= NULL
);
493 Storage
->Signature
= FORMSET_STORAGE_SIGNATURE
;
494 InsertTailList (&FormSet
->StorageListHead
, &Storage
->Link
);
496 BrowserStorage
= FindStorageInList(StorageType
, StorageGuid
, UnicodeString
);
497 if (BrowserStorage
== NULL
) {
498 BrowserStorage
= AllocateZeroPool (sizeof (BROWSER_STORAGE
));
499 ASSERT (BrowserStorage
!= NULL
);
501 BrowserStorage
->Signature
= BROWSER_STORAGE_SIGNATURE
;
502 InsertTailList (&gBrowserStorageList
, &BrowserStorage
->Link
);
504 IntializeBrowserStorage (BrowserStorage
, StorageType
, OpCodeData
);
505 BrowserStorage
->Type
= StorageType
;
506 if (StorageType
!= EFI_HII_VARSTORE_NAME_VALUE
) {
507 BrowserStorage
->Name
= UnicodeString
;
510 InitializeConfigHdr (FormSet
, BrowserStorage
);
513 // Add count because one formset storage use this global storage.
515 BrowserStorage
->ReferenceCount
++;
517 Storage
->BrowserStorage
= BrowserStorage
;
518 Storage
->ConfigRequest
= AllocateCopyPool (StrSize (BrowserStorage
->ConfigHdr
), BrowserStorage
->ConfigHdr
);
519 Storage
->SpareStrLen
= 0;
525 Initialize Request Element of a Question. <RequestElement> ::= '&'<BlockName> | '&'<Label>
527 @param FormSet Pointer of the current FormSet.
528 @param Question The Question to be initialized.
529 @param Form Pointer of the current form.
531 @retval EFI_SUCCESS Function success.
532 @retval EFI_INVALID_PARAMETER No storage associated with the Question.
536 InitializeRequestElement (
537 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
538 IN OUT FORM_BROWSER_STATEMENT
*Question
,
539 IN OUT FORM_BROWSER_FORM
*Form
542 BROWSER_STORAGE
*Storage
;
543 FORMSET_STORAGE
*FormsetStorage
;
547 CHAR16 RequestElement
[30];
550 FORM_BROWSER_CONFIG_REQUEST
*ConfigInfo
;
552 Storage
= Question
->Storage
;
553 if (Storage
== NULL
) {
554 return EFI_INVALID_PARAMETER
;
557 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
559 // <ConfigRequest> is unnecessary for EFI variable storage,
560 // GetVariable()/SetVariable() will be used to retrieve/save values
566 // Prepare <RequestElement>
568 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
569 Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
570 StrLen
= UnicodeSPrint (
572 30 * sizeof (CHAR16
),
573 L
"&OFFSET=%x&WIDTH=%x",
574 Question
->VarStoreInfo
.VarOffset
,
575 Question
->StorageWidth
577 Question
->BlockName
= AllocateCopyPool ((StrLen
+ 1) * sizeof (CHAR16
), RequestElement
);
579 StrLen
= UnicodeSPrint (RequestElement
, 30 * sizeof (CHAR16
), L
"&%s", Question
->VariableName
);
582 if ((Question
->Operand
== EFI_IFR_PASSWORD_OP
) && ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
)) {
584 // Password with CALLBACK flag is stored in encoded format,
585 // so don't need to append it to <ConfigRequest>
591 // Find Formset Storage for this Question
593 FormsetStorage
= NULL
;
594 Link
= GetFirstNode (&FormSet
->StorageListHead
);
595 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
596 FormsetStorage
= FORMSET_STORAGE_FROM_LINK (Link
);
598 if (FormsetStorage
->VarStoreId
== Question
->VarStoreId
) {
602 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
604 ASSERT (FormsetStorage
!= NULL
);
607 // Append <RequestElement> to <ConfigRequest>
609 if (StrLen
> FormsetStorage
->SpareStrLen
) {
611 // Old String buffer is not sufficient for RequestElement, allocate a new one
613 StringSize
= (FormsetStorage
->ConfigRequest
!= NULL
) ? StrSize (FormsetStorage
->ConfigRequest
) : sizeof (CHAR16
);
614 NewStr
= AllocateZeroPool (StringSize
+ CONFIG_REQUEST_STRING_INCREMENTAL
* sizeof (CHAR16
));
615 ASSERT (NewStr
!= NULL
);
616 if (FormsetStorage
->ConfigRequest
!= NULL
) {
617 CopyMem (NewStr
, FormsetStorage
->ConfigRequest
, StringSize
);
618 FreePool (FormsetStorage
->ConfigRequest
);
620 FormsetStorage
->ConfigRequest
= NewStr
;
621 FormsetStorage
->SpareStrLen
= CONFIG_REQUEST_STRING_INCREMENTAL
;
624 StrCat (FormsetStorage
->ConfigRequest
, RequestElement
);
625 FormsetStorage
->ElementCount
++;
626 FormsetStorage
->SpareStrLen
-= StrLen
;
629 // Update the Config Request info saved in the form.
633 Link
= GetFirstNode (&Form
->ConfigRequestHead
);
634 while (!IsNull (&Form
->ConfigRequestHead
, Link
)) {
635 ConfigInfo
= FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link
);
637 if (ConfigInfo
!= NULL
&& ConfigInfo
->Storage
== Storage
) {
642 Link
= GetNextNode (&Form
->ConfigRequestHead
, Link
);
646 ConfigInfo
= AllocateZeroPool(sizeof (FORM_BROWSER_CONFIG_REQUEST
));
647 ASSERT (ConfigInfo
!= NULL
);
648 ConfigInfo
->Signature
= FORM_BROWSER_CONFIG_REQUEST_SIGNATURE
;
649 ConfigInfo
->ConfigRequest
= AllocateCopyPool (StrSize (Storage
->ConfigHdr
), Storage
->ConfigHdr
);
650 ConfigInfo
->SpareStrLen
= 0;
651 ConfigInfo
->Storage
= Storage
;
652 InsertTailList(&Form
->ConfigRequestHead
, &ConfigInfo
->Link
);
656 // Append <RequestElement> to <ConfigRequest>
658 if (StrLen
> ConfigInfo
->SpareStrLen
) {
660 // Old String buffer is not sufficient for RequestElement, allocate a new one
662 StringSize
= (ConfigInfo
->ConfigRequest
!= NULL
) ? StrSize (ConfigInfo
->ConfigRequest
) : sizeof (CHAR16
);
663 NewStr
= AllocateZeroPool (StringSize
+ CONFIG_REQUEST_STRING_INCREMENTAL
* sizeof (CHAR16
));
664 ASSERT (NewStr
!= NULL
);
665 if (ConfigInfo
->ConfigRequest
!= NULL
) {
666 CopyMem (NewStr
, ConfigInfo
->ConfigRequest
, StringSize
);
667 FreePool (ConfigInfo
->ConfigRequest
);
669 ConfigInfo
->ConfigRequest
= NewStr
;
670 ConfigInfo
->SpareStrLen
= CONFIG_REQUEST_STRING_INCREMENTAL
;
673 StrCat (ConfigInfo
->ConfigRequest
, RequestElement
);
674 ConfigInfo
->ElementCount
++;
675 ConfigInfo
->SpareStrLen
-= StrLen
;
681 Free resources of a Expression.
683 @param FormSet Pointer of the Expression
688 IN FORM_EXPRESSION
*Expression
692 EXPRESSION_OPCODE
*OpCode
;
693 LIST_ENTRY
*SubExpressionLink
;
694 FORM_EXPRESSION
*SubExpression
;
696 while (!IsListEmpty (&Expression
->OpCodeListHead
)) {
697 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
698 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
699 RemoveEntryList (&OpCode
->Link
);
701 if (OpCode
->ValueList
!= NULL
) {
702 FreePool (OpCode
->ValueList
);
705 if (OpCode
->ValueName
!= NULL
) {
706 FreePool (OpCode
->ValueName
);
709 if (OpCode
->MapExpressionList
.ForwardLink
!= NULL
) {
710 while (!IsListEmpty (&OpCode
->MapExpressionList
)) {
711 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
712 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
713 RemoveEntryList(&SubExpression
->Link
);
714 DestroyExpression (SubExpression
);
720 // Free this Expression
722 FreePool (Expression
);
726 Free resources of a storage.
728 @param Storage Pointer of the storage
733 IN FORMSET_STORAGE
*Storage
736 if (Storage
== NULL
) {
740 if (Storage
->ConfigRequest
!= NULL
) {
741 FreePool (Storage
->ConfigRequest
);
745 // Minus the reference to the global storage.
747 ASSERT (Storage
->BrowserStorage
->ReferenceCount
> 0);
748 Storage
->BrowserStorage
->ReferenceCount
--;
755 Free resources of a Statement.
757 @param FormSet Pointer of the FormSet
758 @param Statement Pointer of the Statement
763 IN FORM_BROWSER_FORMSET
*FormSet
,
764 IN OUT FORM_BROWSER_STATEMENT
*Statement
768 QUESTION_DEFAULT
*Default
;
769 QUESTION_OPTION
*Option
;
770 FORM_EXPRESSION
*Expression
;
773 // Free Default value List
775 while (!IsListEmpty (&Statement
->DefaultListHead
)) {
776 Link
= GetFirstNode (&Statement
->DefaultListHead
);
777 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
778 RemoveEntryList (&Default
->Link
);
786 while (!IsListEmpty (&Statement
->OptionListHead
)) {
787 Link
= GetFirstNode (&Statement
->OptionListHead
);
788 Option
= QUESTION_OPTION_FROM_LINK (Link
);
789 if (Option
->SuppressExpression
!= NULL
) {
790 FreePool (Option
->SuppressExpression
);
792 RemoveEntryList (&Option
->Link
);
798 // Free Inconsistent List
800 while (!IsListEmpty (&Statement
->InconsistentListHead
)) {
801 Link
= GetFirstNode (&Statement
->InconsistentListHead
);
802 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
803 RemoveEntryList (&Expression
->Link
);
805 DestroyExpression (Expression
);
809 // Free NoSubmit List
811 while (!IsListEmpty (&Statement
->NoSubmitListHead
)) {
812 Link
= GetFirstNode (&Statement
->NoSubmitListHead
);
813 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
814 RemoveEntryList (&Expression
->Link
);
816 DestroyExpression (Expression
);
819 if (Statement
->Expression
!= NULL
) {
820 FreePool (Statement
->Expression
);
823 if (Statement
->VariableName
!= NULL
) {
824 FreePool (Statement
->VariableName
);
826 if (Statement
->BlockName
!= NULL
) {
827 FreePool (Statement
->BlockName
);
829 if (Statement
->BufferValue
!= NULL
) {
830 FreePool (Statement
->BufferValue
);
832 if (Statement
->Operand
== EFI_IFR_STRING_OP
|| Statement
->Operand
== EFI_IFR_PASSWORD_OP
) {
833 DeleteString(Statement
->HiiValue
.Value
.string
, FormSet
->HiiHandle
);
839 Free resources of a Form.
841 @param FormSet Pointer of the FormSet
842 @param Form Pointer of the Form.
847 IN FORM_BROWSER_FORMSET
*FormSet
,
848 IN OUT FORM_BROWSER_FORM
*Form
852 FORM_EXPRESSION
*Expression
;
853 FORM_BROWSER_STATEMENT
*Statement
;
854 FORM_BROWSER_CONFIG_REQUEST
*ConfigInfo
;
857 // Free Form Expressions
859 while (!IsListEmpty (&Form
->ExpressionListHead
)) {
860 Link
= GetFirstNode (&Form
->ExpressionListHead
);
861 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
862 RemoveEntryList (&Expression
->Link
);
864 DestroyExpression (Expression
);
868 // Free Statements/Questions
870 while (!IsListEmpty (&Form
->StatementListHead
)) {
871 Link
= GetFirstNode (&Form
->StatementListHead
);
872 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
873 RemoveEntryList (&Statement
->Link
);
875 DestroyStatement (FormSet
, Statement
);
879 // Free ConfigRequest string.
881 while (!IsListEmpty (&Form
->ConfigRequestHead
)) {
882 Link
= GetFirstNode (&Form
->ConfigRequestHead
);
883 ConfigInfo
= FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link
);
884 RemoveEntryList (&ConfigInfo
->Link
);
886 FreePool (ConfigInfo
->ConfigRequest
);
887 FreePool (ConfigInfo
);
890 if (Form
->SuppressExpression
!= NULL
) {
891 FreePool (Form
->SuppressExpression
);
902 Free resources allocated for a FormSet.
904 @param FormSet Pointer of the FormSet
909 IN OUT FORM_BROWSER_FORMSET
*FormSet
913 FORMSET_STORAGE
*Storage
;
914 FORMSET_DEFAULTSTORE
*DefaultStore
;
915 FORM_EXPRESSION
*Expression
;
916 FORM_BROWSER_FORM
*Form
;
918 if (FormSet
->IfrBinaryData
== NULL
) {
920 // Uninitialized FormSet
927 // Free IFR binary buffer
929 FreePool (FormSet
->IfrBinaryData
);
932 // Free FormSet Storage
934 if (FormSet
->StorageListHead
.ForwardLink
!= NULL
) {
935 while (!IsListEmpty (&FormSet
->StorageListHead
)) {
936 Link
= GetFirstNode (&FormSet
->StorageListHead
);
937 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
938 RemoveEntryList (&Storage
->Link
);
940 DestroyStorage (Storage
);
945 // Free FormSet Default Store
947 if (FormSet
->DefaultStoreListHead
.ForwardLink
!= NULL
) {
948 while (!IsListEmpty (&FormSet
->DefaultStoreListHead
)) {
949 Link
= GetFirstNode (&FormSet
->DefaultStoreListHead
);
950 DefaultStore
= FORMSET_DEFAULTSTORE_FROM_LINK (Link
);
951 RemoveEntryList (&DefaultStore
->Link
);
953 FreePool (DefaultStore
);
958 // Free Formset Expressions
960 while (!IsListEmpty (&FormSet
->ExpressionListHead
)) {
961 Link
= GetFirstNode (&FormSet
->ExpressionListHead
);
962 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
963 RemoveEntryList (&Expression
->Link
);
965 DestroyExpression (Expression
);
971 if (FormSet
->FormListHead
.ForwardLink
!= NULL
) {
972 while (!IsListEmpty (&FormSet
->FormListHead
)) {
973 Link
= GetFirstNode (&FormSet
->FormListHead
);
974 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
975 RemoveEntryList (&Form
->Link
);
977 DestroyForm (FormSet
, Form
);
981 if (FormSet
->StatementBuffer
!= NULL
) {
982 FreePool (FormSet
->StatementBuffer
);
984 if (FormSet
->ExpressionBuffer
!= NULL
) {
985 FreePool (FormSet
->ExpressionBuffer
);
993 Tell whether this Operand is an Expression OpCode or not
995 @param Operand Operand of an IFR OpCode.
997 @retval TRUE This is an Expression OpCode.
998 @retval FALSE Not an Expression OpCode.
1002 IsExpressionOpCode (
1006 if (((Operand
>= EFI_IFR_EQ_ID_VAL_OP
) && (Operand
<= EFI_IFR_NOT_OP
)) ||
1007 ((Operand
>= EFI_IFR_MATCH_OP
) && (Operand
<= EFI_IFR_SET_OP
)) ||
1008 ((Operand
>= EFI_IFR_EQUAL_OP
) && (Operand
<= EFI_IFR_SPAN_OP
)) ||
1009 (Operand
== EFI_IFR_CATENATE_OP
) ||
1010 (Operand
== EFI_IFR_TO_LOWER_OP
) ||
1011 (Operand
== EFI_IFR_TO_UPPER_OP
) ||
1012 (Operand
== EFI_IFR_MAP_OP
) ||
1013 (Operand
== EFI_IFR_VERSION_OP
) ||
1014 (Operand
== EFI_IFR_SECURITY_OP
)) {
1023 Calculate number of Statemens(Questions) and Expression OpCodes.
1025 @param FormSet The FormSet to be counted.
1026 @param NumberOfStatement Number of Statemens(Questions)
1027 @param NumberOfExpression Number of Expression OpCodes
1032 IN FORM_BROWSER_FORMSET
*FormSet
,
1033 IN OUT UINT16
*NumberOfStatement
,
1034 IN OUT UINT16
*NumberOfExpression
1037 UINT16 StatementCount
;
1038 UINT16 ExpressionCount
;
1045 ExpressionCount
= 0;
1047 while (Offset
< FormSet
->IfrBinaryLength
) {
1048 OpCodeData
= FormSet
->IfrBinaryData
+ Offset
;
1049 OpCodeLen
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
1050 Offset
+= OpCodeLen
;
1052 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
)) {
1059 *NumberOfStatement
= StatementCount
;
1060 *NumberOfExpression
= ExpressionCount
;
1066 Parse opcodes in the formset IFR binary.
1068 @param FormSet Pointer of the FormSet data structure.
1070 @retval EFI_SUCCESS Opcode parse success.
1071 @retval Other Opcode parse fail.
1076 IN FORM_BROWSER_FORMSET
*FormSet
1080 FORM_BROWSER_FORM
*CurrentForm
;
1081 FORM_BROWSER_STATEMENT
*CurrentStatement
;
1082 EXPRESSION_OPCODE
*ExpressionOpCode
;
1083 FORM_EXPRESSION
*CurrentExpression
;
1090 FORMSET_STORAGE
*Storage
;
1091 FORMSET_DEFAULTSTORE
*DefaultStore
;
1092 QUESTION_DEFAULT
*CurrentDefault
;
1093 QUESTION_OPTION
*CurrentOption
;
1095 UINT16 NumberOfStatement
;
1096 UINT16 NumberOfExpression
;
1097 EFI_IMAGE_ID
*ImageId
;
1098 BOOLEAN SuppressForQuestion
;
1099 BOOLEAN SuppressForOption
;
1100 UINT16 DepthOfDisable
;
1101 BOOLEAN OpCodeDisabled
;
1102 BOOLEAN SingleOpCodeExpression
;
1103 BOOLEAN InScopeDefault
;
1104 EFI_HII_VALUE
*Value
;
1105 EFI_IFR_FORM_MAP_METHOD
*MapMethod
;
1106 UINT8 MapScopeDepth
;
1108 FORMSET_STORAGE
*VarStorage
;
1109 LIST_ENTRY
*MapExpressionList
;
1110 EFI_VARSTORE_ID TempVarstoreId
;
1111 BOOLEAN InScopeDisable
;
1112 INTN ConditionalExprCount
;
1114 mInScopeSubtitle
= FALSE
;
1115 SuppressForQuestion
= FALSE
;
1116 SuppressForOption
= FALSE
;
1117 InScopeDisable
= FALSE
;
1119 OpCodeDisabled
= FALSE
;
1120 SingleOpCodeExpression
= FALSE
;
1121 InScopeDefault
= FALSE
;
1122 CurrentExpression
= NULL
;
1123 CurrentDefault
= NULL
;
1124 CurrentOption
= NULL
;
1130 MapExpressionList
= NULL
;
1132 ConditionalExprCount
= 0;
1135 // Get the number of Statements and Expressions
1137 CountOpCodes (FormSet
, &NumberOfStatement
, &NumberOfExpression
);
1139 mStatementIndex
= 0;
1140 mUsedQuestionId
= 1;
1141 FormSet
->StatementBuffer
= AllocateZeroPool (NumberOfStatement
* sizeof (FORM_BROWSER_STATEMENT
));
1142 if (FormSet
->StatementBuffer
== NULL
) {
1143 return EFI_OUT_OF_RESOURCES
;
1146 mExpressionOpCodeIndex
= 0;
1147 FormSet
->ExpressionBuffer
= AllocateZeroPool (NumberOfExpression
* sizeof (EXPRESSION_OPCODE
));
1148 if (FormSet
->ExpressionBuffer
== NULL
) {
1149 return EFI_OUT_OF_RESOURCES
;
1152 InitializeListHead (&FormSet
->StatementListOSF
);
1153 InitializeListHead (&FormSet
->StorageListHead
);
1154 InitializeListHead (&FormSet
->DefaultStoreListHead
);
1155 InitializeListHead (&FormSet
->FormListHead
);
1156 InitializeListHead (&FormSet
->ExpressionListHead
);
1157 ResetCurrentExpressionStack ();
1158 ResetMapExpressionListStack ();
1161 CurrentStatement
= NULL
;
1166 while (OpCodeOffset
< FormSet
->IfrBinaryLength
) {
1167 OpCodeData
= FormSet
->IfrBinaryData
+ OpCodeOffset
;
1169 OpCodeLength
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
1170 OpCodeOffset
+= OpCodeLength
;
1171 Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
1172 Scope
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Scope
;
1175 // If scope bit set, push onto scope stack
1178 PushScope (Operand
);
1181 if (OpCodeDisabled
) {
1183 // DisableIf Expression is evaluated to be TRUE, try to find its end.
1184 // Here only cares the EFI_IFR_DISABLE_IF and EFI_IFR_END
1186 if (Operand
== EFI_IFR_DISABLE_IF_OP
) {
1188 } else if (Operand
== EFI_IFR_END_OP
) {
1189 Status
= PopScope (&ScopeOpCode
);
1190 if (EFI_ERROR (Status
)) {
1194 if (ScopeOpCode
== EFI_IFR_DISABLE_IF_OP
) {
1195 if (DepthOfDisable
== 0) {
1196 InScopeDisable
= FALSE
;
1197 OpCodeDisabled
= FALSE
;
1206 if (IsExpressionOpCode (Operand
)) {
1207 ExpressionOpCode
= &FormSet
->ExpressionBuffer
[mExpressionOpCodeIndex
];
1208 mExpressionOpCodeIndex
++;
1210 ExpressionOpCode
->Signature
= EXPRESSION_OPCODE_SIGNATURE
;
1211 ExpressionOpCode
->Operand
= Operand
;
1212 Value
= &ExpressionOpCode
->Value
;
1215 case EFI_IFR_EQ_ID_VAL_OP
:
1216 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_VAL
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
1218 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
1219 CopyMem (&Value
->Value
.u16
, &((EFI_IFR_EQ_ID_VAL
*) OpCodeData
)->Value
, sizeof (UINT16
));
1222 case EFI_IFR_EQ_ID_ID_OP
:
1223 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_ID
*) OpCodeData
)->QuestionId1
, sizeof (EFI_QUESTION_ID
));
1224 CopyMem (&ExpressionOpCode
->QuestionId2
, &((EFI_IFR_EQ_ID_ID
*) OpCodeData
)->QuestionId2
, sizeof (EFI_QUESTION_ID
));
1227 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
1228 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_VAL_LIST
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
1229 CopyMem (&ExpressionOpCode
->ListLength
, &((EFI_IFR_EQ_ID_VAL_LIST
*) OpCodeData
)->ListLength
, sizeof (UINT16
));
1230 ExpressionOpCode
->ValueList
= AllocateCopyPool (ExpressionOpCode
->ListLength
* sizeof (UINT16
), &((EFI_IFR_EQ_ID_VAL_LIST
*) OpCodeData
)->ValueList
);
1233 case EFI_IFR_TO_STRING_OP
:
1234 case EFI_IFR_FIND_OP
:
1235 ExpressionOpCode
->Format
= (( EFI_IFR_TO_STRING
*) OpCodeData
)->Format
;
1238 case EFI_IFR_STRING_REF1_OP
:
1239 Value
->Type
= EFI_IFR_TYPE_STRING
;
1240 CopyMem (&Value
->Value
.string
, &(( EFI_IFR_STRING_REF1
*) OpCodeData
)->StringId
, sizeof (EFI_STRING_ID
));
1243 case EFI_IFR_RULE_REF_OP
:
1244 ExpressionOpCode
->RuleId
= (( EFI_IFR_RULE_REF
*) OpCodeData
)->RuleId
;
1247 case EFI_IFR_SPAN_OP
:
1248 ExpressionOpCode
->Flags
= (( EFI_IFR_SPAN
*) OpCodeData
)->Flags
;
1251 case EFI_IFR_THIS_OP
:
1252 ASSERT (CurrentStatement
!= NULL
);
1253 ExpressionOpCode
->QuestionId
= CurrentStatement
->QuestionId
;
1256 case EFI_IFR_SECURITY_OP
:
1257 CopyMem (&ExpressionOpCode
->Guid
, &((EFI_IFR_SECURITY
*) OpCodeData
)->Permissions
, sizeof (EFI_GUID
));
1260 case EFI_IFR_GET_OP
:
1261 case EFI_IFR_SET_OP
:
1262 CopyMem (&TempVarstoreId
, &((EFI_IFR_GET
*) OpCodeData
)->VarStoreId
, sizeof (TempVarstoreId
));
1263 if (TempVarstoreId
!= 0) {
1264 if (FormSet
->StorageListHead
.ForwardLink
!= NULL
) {
1265 Link
= GetFirstNode (&FormSet
->StorageListHead
);
1266 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
1267 VarStorage
= FORMSET_STORAGE_FROM_LINK (Link
);
1268 if (VarStorage
->VarStoreId
== ((EFI_IFR_GET
*) OpCodeData
)->VarStoreId
) {
1269 ExpressionOpCode
->VarStorage
= VarStorage
->BrowserStorage
;
1272 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
1275 if (ExpressionOpCode
->VarStorage
== NULL
) {
1277 // VarStorage is not found.
1279 return EFI_INVALID_PARAMETER
;
1282 ExpressionOpCode
->ValueType
= ((EFI_IFR_GET
*) OpCodeData
)->VarStoreType
;
1283 switch (ExpressionOpCode
->ValueType
) {
1284 case EFI_IFR_TYPE_BOOLEAN
:
1285 case EFI_IFR_TYPE_NUM_SIZE_8
:
1286 ExpressionOpCode
->ValueWidth
= 1;
1289 case EFI_IFR_TYPE_NUM_SIZE_16
:
1290 case EFI_IFR_TYPE_STRING
:
1291 ExpressionOpCode
->ValueWidth
= 2;
1294 case EFI_IFR_TYPE_NUM_SIZE_32
:
1295 ExpressionOpCode
->ValueWidth
= 4;
1298 case EFI_IFR_TYPE_NUM_SIZE_64
:
1299 ExpressionOpCode
->ValueWidth
= 8;
1302 case EFI_IFR_TYPE_DATE
:
1303 ExpressionOpCode
->ValueWidth
= (UINT8
) sizeof (EFI_IFR_DATE
);
1306 case EFI_IFR_TYPE_TIME
:
1307 ExpressionOpCode
->ValueWidth
= (UINT8
) sizeof (EFI_IFR_TIME
);
1310 case EFI_IFR_TYPE_REF
:
1311 ExpressionOpCode
->ValueWidth
= (UINT8
) sizeof (EFI_IFR_REF
);
1314 case EFI_IFR_TYPE_OTHER
:
1315 case EFI_IFR_TYPE_UNDEFINED
:
1316 case EFI_IFR_TYPE_ACTION
:
1317 case EFI_IFR_TYPE_BUFFER
:
1320 // Invalid value type for Get/Set opcode.
1322 return EFI_INVALID_PARAMETER
;
1324 CopyMem (&ExpressionOpCode
->VarStoreInfo
.VarName
, &((EFI_IFR_GET
*) OpCodeData
)->VarStoreInfo
.VarName
, sizeof (EFI_STRING_ID
));
1325 CopyMem (&ExpressionOpCode
->VarStoreInfo
.VarOffset
, &((EFI_IFR_GET
*) OpCodeData
)->VarStoreInfo
.VarOffset
, sizeof (UINT16
));
1326 if ((ExpressionOpCode
->VarStorage
!= NULL
) &&
1327 (ExpressionOpCode
->VarStorage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
||
1328 ExpressionOpCode
->VarStorage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
)) {
1329 ExpressionOpCode
->ValueName
= GetToken (ExpressionOpCode
->VarStoreInfo
.VarName
, FormSet
->HiiHandle
);
1330 if (ExpressionOpCode
->ValueName
== NULL
) {
1332 // String ID is invalid.
1334 return EFI_INVALID_PARAMETER
;
1339 case EFI_IFR_QUESTION_REF1_OP
:
1340 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_VAL_LIST
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
1343 case EFI_IFR_QUESTION_REF3_OP
:
1344 if (OpCodeLength
>= sizeof (EFI_IFR_QUESTION_REF3_2
)) {
1345 CopyMem (&ExpressionOpCode
->DevicePath
, &(( EFI_IFR_QUESTION_REF3_2
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
1347 if (OpCodeLength
>= sizeof (EFI_IFR_QUESTION_REF3_3
)) {
1348 CopyMem (&ExpressionOpCode
->Guid
, &(( EFI_IFR_QUESTION_REF3_3
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
1356 case EFI_IFR_TRUE_OP
:
1357 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1358 Value
->Value
.b
= TRUE
;
1361 case EFI_IFR_FALSE_OP
:
1362 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1363 Value
->Value
.b
= FALSE
;
1366 case EFI_IFR_ONE_OP
:
1367 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
1368 Value
->Value
.u8
= 1;
1371 case EFI_IFR_ZERO_OP
:
1372 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
1373 Value
->Value
.u8
= 0;
1376 case EFI_IFR_ONES_OP
:
1377 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1378 Value
->Value
.u64
= 0xffffffffffffffffULL
;
1381 case EFI_IFR_UINT8_OP
:
1382 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
1383 Value
->Value
.u8
= (( EFI_IFR_UINT8
*) OpCodeData
)->Value
;
1386 case EFI_IFR_UINT16_OP
:
1387 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
1388 CopyMem (&Value
->Value
.u16
, &(( EFI_IFR_UINT16
*) OpCodeData
)->Value
, sizeof (UINT16
));
1391 case EFI_IFR_UINT32_OP
:
1392 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
1393 CopyMem (&Value
->Value
.u32
, &(( EFI_IFR_UINT32
*) OpCodeData
)->Value
, sizeof (UINT32
));
1396 case EFI_IFR_UINT64_OP
:
1397 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1398 CopyMem (&Value
->Value
.u64
, &(( EFI_IFR_UINT64
*) OpCodeData
)->Value
, sizeof (UINT64
));
1401 case EFI_IFR_UNDEFINED_OP
:
1402 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1405 case EFI_IFR_VERSION_OP
:
1406 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
1407 Value
->Value
.u16
= EFI_IFR_SPECIFICATION_VERSION
;
1414 // Create sub expression nested in MAP opcode
1416 if (CurrentExpression
== NULL
&& MapScopeDepth
> 0) {
1417 CurrentExpression
= CreateExpression (CurrentForm
);
1418 ASSERT (MapExpressionList
!= NULL
);
1419 InsertTailList (MapExpressionList
, &CurrentExpression
->Link
);
1421 SingleOpCodeExpression
= TRUE
;
1424 ASSERT (CurrentExpression
!= NULL
);
1425 InsertTailList (&CurrentExpression
->OpCodeListHead
, &ExpressionOpCode
->Link
);
1426 if (Operand
== EFI_IFR_MAP_OP
) {
1428 // Store current Map Expression List.
1430 if (MapExpressionList
!= NULL
) {
1431 PushMapExpressionList (MapExpressionList
);
1434 // Initialize new Map Expression List.
1436 MapExpressionList
= &ExpressionOpCode
->MapExpressionList
;
1437 InitializeListHead (MapExpressionList
);
1439 // Store current expression.
1441 PushCurrentExpression (CurrentExpression
);
1442 CurrentExpression
= NULL
;
1444 } else if (SingleOpCodeExpression
) {
1446 // There are two cases to indicate the end of an Expression:
1447 // for single OpCode expression: one Expression OpCode
1448 // for expression consists of more than one OpCode: EFI_IFR_END
1450 SingleOpCodeExpression
= FALSE
;
1452 if (InScopeDisable
&& CurrentForm
== NULL
) {
1454 // This is DisableIf expression for Form, it should be a constant expression
1456 Status
= EvaluateExpression (FormSet
, CurrentForm
, CurrentExpression
);
1457 if (EFI_ERROR (Status
)) {
1461 if (CurrentExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
1462 return EFI_INVALID_PARAMETER
;
1465 OpCodeDisabled
= CurrentExpression
->Result
.Value
.b
;
1468 CurrentExpression
= NULL
;
1479 case EFI_IFR_FORM_SET_OP
:
1481 // Check the formset GUID
1483 if (CompareMem (&FormSet
->Guid
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
)) != 0) {
1484 return EFI_INVALID_PARAMETER
;
1487 CopyMem (&FormSet
->FormSetTitle
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->FormSetTitle
, sizeof (EFI_STRING_ID
));
1488 CopyMem (&FormSet
->Help
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Help
, sizeof (EFI_STRING_ID
));
1490 if (OpCodeLength
> OFFSET_OF (EFI_IFR_FORM_SET
, Flags
)) {
1492 // The formset OpCode contains ClassGuid
1494 FormSet
->NumberOfClassGuid
= (UINT8
) (((EFI_IFR_FORM_SET
*) OpCodeData
)->Flags
& 0x3);
1495 CopyMem (FormSet
->ClassGuid
, OpCodeData
+ sizeof (EFI_IFR_FORM_SET
), FormSet
->NumberOfClassGuid
* sizeof (EFI_GUID
));
1499 case EFI_IFR_FORM_OP
:
1501 // Create a new Form for this FormSet
1503 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
1504 ASSERT (CurrentForm
!= NULL
);
1505 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
1506 InitializeListHead (&CurrentForm
->ExpressionListHead
);
1507 InitializeListHead (&CurrentForm
->StatementListHead
);
1508 InitializeListHead (&CurrentForm
->ConfigRequestHead
);
1510 CurrentForm
->FormType
= STANDARD_MAP_FORM_TYPE
;
1511 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
1512 CopyMem (&CurrentForm
->FormTitle
, &((EFI_IFR_FORM
*) OpCodeData
)->FormTitle
, sizeof (EFI_STRING_ID
));
1514 ConditionalExprCount
= GetConditionalExpressionCount(ExpressForm
);
1515 if ( ConditionalExprCount
> 0) {
1517 // Form is inside of suppressif
1519 CurrentForm
->SuppressExpression
= (FORM_EXPRESSION_LIST
*) AllocatePool(
1520 (UINTN
) (sizeof(FORM_EXPRESSION_LIST
) + ((ConditionalExprCount
-1) * sizeof(FORM_EXPRESSION
*))));
1521 ASSERT (CurrentForm
->SuppressExpression
!= NULL
);
1522 CurrentForm
->SuppressExpression
->Count
= (UINTN
) ConditionalExprCount
;
1523 CurrentForm
->SuppressExpression
->Signature
= FORM_EXPRESSION_LIST_SIGNATURE
;
1524 CopyMem (CurrentForm
->SuppressExpression
->Expression
, GetConditionalExpressionList(ExpressForm
), (UINTN
) (sizeof (FORM_EXPRESSION
*) * ConditionalExprCount
));
1529 // Enter scope of a Form, suppressif will be used for Question or Option
1531 SuppressForQuestion
= TRUE
;
1535 // Insert into Form list of this FormSet
1537 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
1540 case EFI_IFR_FORM_MAP_OP
:
1542 // Create a new Form for this FormSet
1544 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
1545 ASSERT (CurrentForm
!= NULL
);
1546 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
1547 InitializeListHead (&CurrentForm
->ExpressionListHead
);
1548 InitializeListHead (&CurrentForm
->StatementListHead
);
1549 InitializeListHead (&CurrentForm
->ConfigRequestHead
);
1550 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
1552 MapMethod
= (EFI_IFR_FORM_MAP_METHOD
*) (OpCodeData
+ sizeof (EFI_IFR_FORM_MAP
));
1554 // FormMap Form must contain at least one Map Method.
1556 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
< ((UINTN
) (UINT8
*) (MapMethod
+ 1) - (UINTN
) OpCodeData
)) {
1557 return EFI_INVALID_PARAMETER
;
1560 // Try to find the standard form map method.
1562 while (((UINTN
) (UINT8
*) MapMethod
- (UINTN
) OpCodeData
) < ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
) {
1563 if (CompareGuid ((EFI_GUID
*) (VOID
*) &MapMethod
->MethodIdentifier
, &gEfiHiiStandardFormGuid
)) {
1564 CopyMem (&CurrentForm
->FormTitle
, &MapMethod
->MethodTitle
, sizeof (EFI_STRING_ID
));
1565 CurrentForm
->FormType
= STANDARD_MAP_FORM_TYPE
;
1571 // If the standard form map method is not found, the first map method title will be used.
1573 if (CurrentForm
->FormTitle
== 0) {
1574 MapMethod
= (EFI_IFR_FORM_MAP_METHOD
*) (OpCodeData
+ sizeof (EFI_IFR_FORM_MAP
));
1575 CopyMem (&CurrentForm
->FormTitle
, &MapMethod
->MethodTitle
, sizeof (EFI_STRING_ID
));
1578 ConditionalExprCount
= GetConditionalExpressionCount(ExpressForm
);
1579 if ( ConditionalExprCount
> 0) {
1581 // Form is inside of suppressif
1583 CurrentForm
->SuppressExpression
= (FORM_EXPRESSION_LIST
*) AllocatePool(
1584 (UINTN
) (sizeof(FORM_EXPRESSION_LIST
) + ((ConditionalExprCount
-1) * sizeof(FORM_EXPRESSION
*))));
1585 ASSERT (CurrentForm
->SuppressExpression
!= NULL
);
1586 CurrentForm
->SuppressExpression
->Count
= (UINTN
) ConditionalExprCount
;
1587 CurrentForm
->SuppressExpression
->Signature
= FORM_EXPRESSION_LIST_SIGNATURE
;
1588 CopyMem (CurrentForm
->SuppressExpression
->Expression
, GetConditionalExpressionList(ExpressForm
), (UINTN
) (sizeof (FORM_EXPRESSION
*) * ConditionalExprCount
));
1593 // Enter scope of a Form, suppressif will be used for Question or Option
1595 SuppressForQuestion
= TRUE
;
1599 // Insert into Form list of this FormSet
1601 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
1607 case EFI_IFR_VARSTORE_OP
:
1609 // Create a buffer Storage for this FormSet
1611 Storage
= CreateStorage (FormSet
, EFI_HII_VARSTORE_BUFFER
, OpCodeData
);
1612 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1615 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1617 // Create a name/value Storage for this FormSet
1619 Storage
= CreateStorage (FormSet
, EFI_HII_VARSTORE_NAME_VALUE
, OpCodeData
);
1620 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1623 case EFI_IFR_VARSTORE_EFI_OP
:
1625 // Create a EFI variable Storage for this FormSet
1627 if (OpCodeLength
< sizeof (EFI_IFR_VARSTORE_EFI
)) {
1629 // Create efi varstore with format follow UEFI spec before 2.3.1.
1631 Storage
= CreateStorage (FormSet
, EFI_HII_VARSTORE_EFI_VARIABLE
, OpCodeData
);
1634 // Create efi varstore with format follow UEFI spec 2.3.1 and later.
1636 Storage
= CreateStorage (FormSet
, EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
, OpCodeData
);
1638 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1644 case EFI_IFR_DEFAULTSTORE_OP
:
1645 DefaultStore
= AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE
));
1646 ASSERT (DefaultStore
!= NULL
);
1647 DefaultStore
->Signature
= FORMSET_DEFAULTSTORE_SIGNATURE
;
1649 CopyMem (&DefaultStore
->DefaultId
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
1650 CopyMem (&DefaultStore
->DefaultName
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultName
, sizeof (EFI_STRING_ID
));
1653 // Insert to DefaultStore list of this Formset
1655 InsertTailList (&FormSet
->DefaultStoreListHead
, &DefaultStore
->Link
);
1661 case EFI_IFR_SUBTITLE_OP
:
1662 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
1663 ASSERT (CurrentStatement
!= NULL
);
1665 CurrentStatement
->Flags
= ((EFI_IFR_SUBTITLE
*) OpCodeData
)->Flags
;
1666 CurrentStatement
->FakeQuestionId
= mUsedQuestionId
++;
1668 mInScopeSubtitle
= TRUE
;
1672 case EFI_IFR_TEXT_OP
:
1673 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
1674 ASSERT (CurrentStatement
!= NULL
);
1675 CurrentStatement
->FakeQuestionId
= mUsedQuestionId
++;
1676 CopyMem (&CurrentStatement
->TextTwo
, &((EFI_IFR_TEXT
*) OpCodeData
)->TextTwo
, sizeof (EFI_STRING_ID
));
1679 case EFI_IFR_RESET_BUTTON_OP
:
1680 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
1681 ASSERT (CurrentStatement
!= NULL
);
1682 CurrentStatement
->FakeQuestionId
= mUsedQuestionId
++;
1683 CopyMem (&CurrentStatement
->DefaultId
, &((EFI_IFR_RESET_BUTTON
*) OpCodeData
)->DefaultId
, sizeof (EFI_DEFAULT_ID
));
1689 case EFI_IFR_ACTION_OP
:
1690 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1691 ASSERT (CurrentStatement
!= NULL
);
1692 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_ACTION
;
1694 if (OpCodeLength
== sizeof (EFI_IFR_ACTION_1
)) {
1696 // No QuestionConfig present, so no configuration string will be processed
1698 CurrentStatement
->QuestionConfig
= 0;
1700 CopyMem (&CurrentStatement
->QuestionConfig
, &((EFI_IFR_ACTION
*) OpCodeData
)->QuestionConfig
, sizeof (EFI_STRING_ID
));
1704 case EFI_IFR_REF_OP
:
1705 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1706 ASSERT (CurrentStatement
!= NULL
);
1707 Value
= &CurrentStatement
->HiiValue
;
1708 Value
->Type
= EFI_IFR_TYPE_REF
;
1709 if (OpCodeLength
>= sizeof (EFI_IFR_REF
)) {
1710 CopyMem (&Value
->Value
.ref
.FormId
, &((EFI_IFR_REF
*) OpCodeData
)->FormId
, sizeof (EFI_FORM_ID
));
1712 if (OpCodeLength
>= sizeof (EFI_IFR_REF2
)) {
1713 CopyMem (&Value
->Value
.ref
.QuestionId
, &((EFI_IFR_REF2
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
1715 if (OpCodeLength
>= sizeof (EFI_IFR_REF3
)) {
1716 CopyMem (&Value
->Value
.ref
.FormSetGuid
, &((EFI_IFR_REF3
*) OpCodeData
)->FormSetId
, sizeof (EFI_GUID
));
1718 if (OpCodeLength
>= sizeof (EFI_IFR_REF4
)) {
1719 CopyMem (&Value
->Value
.ref
.DevicePath
, &((EFI_IFR_REF4
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
1724 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (EFI_HII_REF
);
1725 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1728 case EFI_IFR_ONE_OF_OP
:
1729 case EFI_IFR_NUMERIC_OP
:
1730 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1731 ASSERT(CurrentStatement
!= NULL
);
1733 CurrentStatement
->Flags
= ((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
;
1734 Value
= &CurrentStatement
->HiiValue
;
1736 switch (CurrentStatement
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1737 case EFI_IFR_NUMERIC_SIZE_1
:
1738 CurrentStatement
->Minimum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MinValue
;
1739 CurrentStatement
->Maximum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MaxValue
;
1740 CurrentStatement
->Step
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.Step
;
1741 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (UINT8
);
1742 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
1745 case EFI_IFR_NUMERIC_SIZE_2
:
1746 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MinValue
, sizeof (UINT16
));
1747 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MaxValue
, sizeof (UINT16
));
1748 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.Step
, sizeof (UINT16
));
1749 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (UINT16
);
1750 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
1753 case EFI_IFR_NUMERIC_SIZE_4
:
1754 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MinValue
, sizeof (UINT32
));
1755 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MaxValue
, sizeof (UINT32
));
1756 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.Step
, sizeof (UINT32
));
1757 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (UINT32
);
1758 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
1761 case EFI_IFR_NUMERIC_SIZE_8
:
1762 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MinValue
, sizeof (UINT64
));
1763 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MaxValue
, sizeof (UINT64
));
1764 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.Step
, sizeof (UINT64
));
1765 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (UINT64
);
1766 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1773 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1775 if ((Operand
== EFI_IFR_ONE_OF_OP
) && Scope
!= 0) {
1776 SuppressForOption
= TRUE
;
1780 case EFI_IFR_ORDERED_LIST_OP
:
1781 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1782 ASSERT(CurrentStatement
!= NULL
);
1784 CurrentStatement
->Flags
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Flags
;
1785 CurrentStatement
->MaxContainers
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1787 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_BUFFER
;
1788 CurrentStatement
->BufferValue
= NULL
;
1791 SuppressForOption
= TRUE
;
1795 case EFI_IFR_CHECKBOX_OP
:
1796 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1797 ASSERT(CurrentStatement
!= NULL
);
1799 CurrentStatement
->Flags
= ((EFI_IFR_CHECKBOX
*) OpCodeData
)->Flags
;
1800 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (BOOLEAN
);
1801 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_BOOLEAN
;
1803 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1807 case EFI_IFR_STRING_OP
:
1808 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1809 ASSERT (CurrentStatement
!= NULL
);
1811 // MinSize is the minimum number of characters that can be accepted for this opcode,
1812 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1813 // The characters are stored as Unicode, so the storage width should multiply 2.
1815 CurrentStatement
->Minimum
= ((EFI_IFR_STRING
*) OpCodeData
)->MinSize
;
1816 CurrentStatement
->Maximum
= ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
;
1817 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (CHAR16
));
1818 CurrentStatement
->Flags
= ((EFI_IFR_STRING
*) OpCodeData
)->Flags
;
1820 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
1821 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
+ sizeof (CHAR16
));
1822 CurrentStatement
->HiiValue
.Value
.string
= NewString ((CHAR16
*) CurrentStatement
->BufferValue
, FormSet
->HiiHandle
);
1824 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1827 case EFI_IFR_PASSWORD_OP
:
1828 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1829 ASSERT (CurrentStatement
!= NULL
);
1831 // MinSize is the minimum number of characters that can be accepted for this opcode,
1832 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1833 // The characters are stored as Unicode, so the storage width should multiply 2.
1835 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MinSize
, sizeof (UINT16
));
1836 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MaxSize
, sizeof (UINT16
));
1837 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (CHAR16
));
1839 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
1840 CurrentStatement
->BufferValue
= AllocateZeroPool ((CurrentStatement
->StorageWidth
+ sizeof (CHAR16
)));
1841 CurrentStatement
->HiiValue
.Value
.string
= NewString ((CHAR16
*) CurrentStatement
->BufferValue
, FormSet
->HiiHandle
);
1843 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1846 case EFI_IFR_DATE_OP
:
1847 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1848 ASSERT(CurrentStatement
!= NULL
);
1850 CurrentStatement
->Flags
= ((EFI_IFR_DATE
*) OpCodeData
)->Flags
;
1851 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_DATE
;
1853 if ((CurrentStatement
->Flags
& EFI_QF_DATE_STORAGE
) == QF_DATE_STORAGE_NORMAL
) {
1854 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (EFI_HII_DATE
);
1856 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1859 // Don't assign storage for RTC type of date/time
1861 CurrentStatement
->Storage
= NULL
;
1862 CurrentStatement
->StorageWidth
= 0;
1866 case EFI_IFR_TIME_OP
:
1867 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1868 ASSERT(CurrentStatement
!= NULL
);
1870 CurrentStatement
->Flags
= ((EFI_IFR_TIME
*) OpCodeData
)->Flags
;
1871 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_TIME
;
1873 if ((CurrentStatement
->Flags
& QF_TIME_STORAGE
) == QF_TIME_STORAGE_NORMAL
) {
1874 CurrentStatement
->StorageWidth
= (UINT16
) sizeof (EFI_HII_TIME
);
1876 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1879 // Don't assign storage for RTC type of date/time
1881 CurrentStatement
->Storage
= NULL
;
1882 CurrentStatement
->StorageWidth
= 0;
1889 case EFI_IFR_DEFAULT_OP
:
1891 // EFI_IFR_DEFAULT appear in scope of a Question,
1892 // It creates a default value for the current question.
1893 // A Question may have more than one Default value which have different default types.
1895 CurrentDefault
= AllocateZeroPool (sizeof (QUESTION_DEFAULT
));
1896 ASSERT (CurrentDefault
!= NULL
);
1897 CurrentDefault
->Signature
= QUESTION_DEFAULT_SIGNATURE
;
1899 CurrentDefault
->Value
.Type
= ((EFI_IFR_DEFAULT
*) OpCodeData
)->Type
;
1900 CopyMem (&CurrentDefault
->DefaultId
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
1901 if (OpCodeLength
> OFFSET_OF (EFI_IFR_DEFAULT
, Value
)) {
1902 CopyMem (&CurrentDefault
->Value
.Value
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->Value
, OpCodeLength
- OFFSET_OF (EFI_IFR_DEFAULT
, Value
));
1903 ExtendValueToU64 (&CurrentDefault
->Value
);
1907 // Insert to Default Value list of current Question
1909 InsertTailList (&CurrentStatement
->DefaultListHead
, &CurrentDefault
->Link
);
1912 InScopeDefault
= TRUE
;
1919 case EFI_IFR_ONE_OF_OPTION_OP
:
1921 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
1922 // It create a selection for use in current Question.
1924 CurrentOption
= AllocateZeroPool (sizeof (QUESTION_OPTION
));
1925 ASSERT (CurrentOption
!= NULL
);
1926 CurrentOption
->Signature
= QUESTION_OPTION_SIGNATURE
;
1927 CurrentOption
->OpCode
= (EFI_IFR_ONE_OF_OPTION
*) OpCodeData
;
1929 CurrentOption
->Flags
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Flags
;
1930 CurrentOption
->Value
.Type
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Type
;
1931 CopyMem (&CurrentOption
->Text
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Option
, sizeof (EFI_STRING_ID
));
1932 CopyMem (&CurrentOption
->Value
.Value
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Value
, OpCodeLength
- OFFSET_OF (EFI_IFR_ONE_OF_OPTION
, Value
));
1933 ExtendValueToU64 (&CurrentOption
->Value
);
1935 ConditionalExprCount
= GetConditionalExpressionCount(ExpressOption
);
1936 if ( ConditionalExprCount
> 0) {
1938 // Form is inside of suppressif
1940 CurrentOption
->SuppressExpression
= (FORM_EXPRESSION_LIST
*) AllocatePool(
1941 (UINTN
) (sizeof(FORM_EXPRESSION_LIST
) + ((ConditionalExprCount
-1) * sizeof(FORM_EXPRESSION
*))));
1942 ASSERT (CurrentOption
->SuppressExpression
!= NULL
);
1943 CurrentOption
->SuppressExpression
->Count
= (UINTN
) ConditionalExprCount
;
1944 CurrentOption
->SuppressExpression
->Signature
= FORM_EXPRESSION_LIST_SIGNATURE
;
1945 CopyMem (CurrentOption
->SuppressExpression
->Expression
, GetConditionalExpressionList(ExpressOption
), (UINTN
) (sizeof (FORM_EXPRESSION
*) * ConditionalExprCount
));
1949 // Insert to Option list of current Question
1951 InsertTailList (&CurrentStatement
->OptionListHead
, &CurrentOption
->Link
);
1954 // Now we know the Storage width of nested Ordered List
1956 ASSERT (CurrentStatement
!= NULL
);
1957 if ((CurrentStatement
->Operand
== EFI_IFR_ORDERED_LIST_OP
) && (CurrentStatement
->BufferValue
== NULL
)) {
1959 switch (CurrentOption
->Value
.Type
) {
1960 case EFI_IFR_TYPE_NUM_SIZE_8
:
1964 case EFI_IFR_TYPE_NUM_SIZE_16
:
1968 case EFI_IFR_TYPE_NUM_SIZE_32
:
1972 case EFI_IFR_TYPE_NUM_SIZE_64
:
1978 // Invalid type for Ordered List
1983 CurrentStatement
->StorageWidth
= (UINT16
) (CurrentStatement
->MaxContainers
* Width
);
1984 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
1985 CurrentStatement
->ValueType
= CurrentOption
->Value
.Type
;
1986 if (CurrentStatement
->HiiValue
.Type
== EFI_IFR_TYPE_BUFFER
) {
1987 CurrentStatement
->HiiValue
.Buffer
= CurrentStatement
->BufferValue
;
1988 CurrentStatement
->HiiValue
.BufferLen
= CurrentStatement
->StorageWidth
;
1991 InitializeRequestElement (FormSet
, CurrentStatement
, CurrentForm
);
1998 case EFI_IFR_NO_SUBMIT_IF_OP
:
1999 case EFI_IFR_INCONSISTENT_IF_OP
:
2001 // Create an Expression node
2003 CurrentExpression
= CreateExpression (CurrentForm
);
2004 CopyMem (&CurrentExpression
->Error
, &((EFI_IFR_INCONSISTENT_IF
*) OpCodeData
)->Error
, sizeof (EFI_STRING_ID
));
2006 if (Operand
== EFI_IFR_NO_SUBMIT_IF_OP
) {
2007 CurrentExpression
->Type
= EFI_HII_EXPRESSION_NO_SUBMIT_IF
;
2008 InsertTailList (&CurrentStatement
->NoSubmitListHead
, &CurrentExpression
->Link
);
2010 CurrentExpression
->Type
= EFI_HII_EXPRESSION_INCONSISTENT_IF
;
2011 InsertTailList (&CurrentStatement
->InconsistentListHead
, &CurrentExpression
->Link
);
2015 // Take a look at next OpCode to see whether current expression consists
2018 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2019 SingleOpCodeExpression
= TRUE
;
2023 case EFI_IFR_SUPPRESS_IF_OP
:
2025 // Question and Option will appear in scope of this OpCode
2027 CurrentExpression
= CreateExpression (CurrentForm
);
2028 CurrentExpression
->Type
= EFI_HII_EXPRESSION_SUPPRESS_IF
;
2030 if (CurrentForm
== NULL
) {
2031 InsertTailList (&FormSet
->ExpressionListHead
, &CurrentExpression
->Link
);
2033 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2036 if (SuppressForOption
) {
2037 PushConditionalExpression(CurrentExpression
, ExpressOption
);
2038 } else if (SuppressForQuestion
) {
2039 PushConditionalExpression(CurrentExpression
, ExpressStatement
);
2041 PushConditionalExpression(CurrentExpression
, ExpressForm
);
2045 // Take a look at next OpCode to see whether current expression consists
2048 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2049 SingleOpCodeExpression
= TRUE
;
2053 case EFI_IFR_GRAY_OUT_IF_OP
:
2055 // Questions will appear in scope of this OpCode
2057 CurrentExpression
= CreateExpression (CurrentForm
);
2058 CurrentExpression
->Type
= EFI_HII_EXPRESSION_GRAY_OUT_IF
;
2059 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2060 PushConditionalExpression(CurrentExpression
, ExpressStatement
);
2063 // Take a look at next OpCode to see whether current expression consists
2066 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2067 SingleOpCodeExpression
= TRUE
;
2071 case EFI_IFR_DISABLE_IF_OP
:
2073 // The DisableIf expression should only rely on constant, so it could be
2074 // evaluated at initialization and it will not be queued
2076 CurrentExpression
= AllocateZeroPool (sizeof (FORM_EXPRESSION
));
2077 ASSERT (CurrentExpression
!= NULL
);
2078 CurrentExpression
->Signature
= FORM_EXPRESSION_SIGNATURE
;
2079 CurrentExpression
->Type
= EFI_HII_EXPRESSION_DISABLE_IF
;
2080 InitializeListHead (&CurrentExpression
->OpCodeListHead
);
2082 if (CurrentForm
!= NULL
) {
2084 // This is DisableIf for Question, enqueue it to Form expression list
2086 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2087 PushConditionalExpression(CurrentExpression
, ExpressStatement
);
2090 OpCodeDisabled
= FALSE
;
2091 InScopeDisable
= TRUE
;
2093 // Take a look at next OpCode to see whether current expression consists
2096 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2097 SingleOpCodeExpression
= TRUE
;
2104 case EFI_IFR_VALUE_OP
:
2105 CurrentExpression
= CreateExpression (CurrentForm
);
2106 CurrentExpression
->Type
= EFI_HII_EXPRESSION_VALUE
;
2107 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2109 if (InScopeDefault
) {
2111 // Used for default (EFI_IFR_DEFAULT)
2113 CurrentDefault
->ValueExpression
= CurrentExpression
;
2116 // If used for a question, then the question will be read-only
2119 // Make sure CurrentStatement is not NULL.
2120 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
2121 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
2123 ASSERT (CurrentStatement
!= NULL
);
2124 CurrentStatement
->ValueExpression
= CurrentExpression
;
2128 // Take a look at next OpCode to see whether current expression consists
2131 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2132 SingleOpCodeExpression
= TRUE
;
2136 case EFI_IFR_RULE_OP
:
2137 CurrentExpression
= CreateExpression (CurrentForm
);
2138 CurrentExpression
->Type
= EFI_HII_EXPRESSION_RULE
;
2140 CurrentExpression
->RuleId
= ((EFI_IFR_RULE
*) OpCodeData
)->RuleId
;
2141 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2144 // Take a look at next OpCode to see whether current expression consists
2147 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2148 SingleOpCodeExpression
= TRUE
;
2152 case EFI_IFR_READ_OP
:
2153 CurrentExpression
= CreateExpression (CurrentForm
);
2154 CurrentExpression
->Type
= EFI_HII_EXPRESSION_READ
;
2155 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2158 // Make sure CurrentStatement is not NULL.
2159 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
2160 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
2162 ASSERT (CurrentStatement
!= NULL
);
2163 CurrentStatement
->ReadExpression
= CurrentExpression
;
2166 // Take a look at next OpCode to see whether current expression consists
2169 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2170 SingleOpCodeExpression
= TRUE
;
2174 case EFI_IFR_WRITE_OP
:
2175 CurrentExpression
= CreateExpression (CurrentForm
);
2176 CurrentExpression
->Type
= EFI_HII_EXPRESSION_WRITE
;
2177 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
2180 // Make sure CurrentStatement is not NULL.
2181 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
2182 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
2184 ASSERT (CurrentStatement
!= NULL
);
2185 CurrentStatement
->WriteExpression
= CurrentExpression
;
2188 // Take a look at next OpCode to see whether current expression consists
2191 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
2192 SingleOpCodeExpression
= TRUE
;
2199 case EFI_IFR_IMAGE_OP
:
2201 // Get ScopeOpcode from top of stack
2203 PopScope (&ScopeOpCode
);
2204 PushScope (ScopeOpCode
);
2206 switch (ScopeOpCode
) {
2207 case EFI_IFR_FORM_SET_OP
:
2208 ImageId
= &FormSet
->ImageId
;
2211 case EFI_IFR_FORM_OP
:
2212 case EFI_IFR_FORM_MAP_OP
:
2213 ASSERT (CurrentForm
!= NULL
);
2214 ImageId
= &CurrentForm
->ImageId
;
2217 case EFI_IFR_ONE_OF_OPTION_OP
:
2218 ImageId
= &CurrentOption
->ImageId
;
2223 // Make sure CurrentStatement is not NULL.
2224 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
2225 // file is wrongly generated by tools such as VFR Compiler.
2227 ASSERT (CurrentStatement
!= NULL
);
2228 ImageId
= &CurrentStatement
->ImageId
;
2232 ASSERT (ImageId
!= NULL
);
2233 CopyMem (ImageId
, &((EFI_IFR_IMAGE
*) OpCodeData
)->Id
, sizeof (EFI_IMAGE_ID
));
2239 case EFI_IFR_REFRESH_OP
:
2240 ASSERT (CurrentStatement
!= NULL
);
2241 CurrentStatement
->RefreshInterval
= ((EFI_IFR_REFRESH
*) OpCodeData
)->RefreshInterval
;
2247 case EFI_IFR_REFRESH_ID_OP
:
2248 ASSERT (CurrentStatement
!= NULL
);
2249 CopyMem (&CurrentStatement
->RefreshGuid
, &((EFI_IFR_REFRESH_ID
*) OpCodeData
)->RefreshEventGroupId
, sizeof (EFI_GUID
));
2255 case EFI_IFR_MODAL_TAG_OP
:
2256 ASSERT (CurrentForm
!= NULL
);
2257 CurrentForm
->ModalForm
= TRUE
;
2261 // Lock tag, used by form and statement.
2263 case EFI_IFR_LOCKED_OP
:
2265 // Get ScopeOpcode from top of stack
2267 PopScope (&ScopeOpCode
);
2268 PushScope (ScopeOpCode
);
2269 switch (ScopeOpCode
) {
2270 case EFI_IFR_FORM_OP
:
2271 case EFI_IFR_FORM_MAP_OP
:
2272 ASSERT (CurrentForm
!= NULL
);
2273 CurrentForm
->Locked
= TRUE
;
2277 ASSERT (CurrentStatement
!= NULL
);
2278 CurrentStatement
->Locked
= TRUE
;
2285 case EFI_IFR_GUID_OP
:
2286 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
2292 case EFI_IFR_END_OP
:
2293 Status
= PopScope (&ScopeOpCode
);
2294 if (EFI_ERROR (Status
)) {
2299 switch (ScopeOpCode
) {
2300 case EFI_IFR_FORM_SET_OP
:
2302 // End of FormSet, update FormSet IFR binary length
2303 // to stop parsing substantial OpCodes
2305 FormSet
->IfrBinaryLength
= OpCodeOffset
;
2308 case EFI_IFR_FORM_OP
:
2309 case EFI_IFR_FORM_MAP_OP
:
2314 SuppressForQuestion
= FALSE
;
2317 case EFI_IFR_ONE_OF_OPTION_OP
:
2321 CurrentOption
= NULL
;
2324 case EFI_IFR_SUBTITLE_OP
:
2325 mInScopeSubtitle
= FALSE
;
2328 case EFI_IFR_NO_SUBMIT_IF_OP
:
2329 case EFI_IFR_INCONSISTENT_IF_OP
:
2331 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
2335 case EFI_IFR_SUPPRESS_IF_OP
:
2336 if (SuppressForOption
) {
2337 PopConditionalExpression(ExpressOption
);
2338 } else if (SuppressForQuestion
) {
2339 PopConditionalExpression(ExpressStatement
);
2341 PopConditionalExpression(ExpressForm
);
2345 case EFI_IFR_GRAY_OUT_IF_OP
:
2346 PopConditionalExpression(ExpressStatement
);
2349 case EFI_IFR_DISABLE_IF_OP
:
2350 if (CurrentForm
!= NULL
) {
2351 PopConditionalExpression(ExpressStatement
);
2353 InScopeDisable
= FALSE
;
2354 OpCodeDisabled
= FALSE
;
2357 case EFI_IFR_ONE_OF_OP
:
2358 case EFI_IFR_ORDERED_LIST_OP
:
2359 SuppressForOption
= FALSE
;
2362 case EFI_IFR_DEFAULT_OP
:
2363 InScopeDefault
= FALSE
;
2366 case EFI_IFR_MAP_OP
:
2368 // Get current Map Expression List.
2370 Status
= PopMapExpressionList ((VOID
**) &MapExpressionList
);
2371 if (Status
== EFI_ACCESS_DENIED
) {
2372 MapExpressionList
= NULL
;
2375 // Get current expression.
2377 Status
= PopCurrentExpression ((VOID
**) &CurrentExpression
);
2378 ASSERT_EFI_ERROR (Status
);
2379 ASSERT (MapScopeDepth
> 0);
2384 if (IsExpressionOpCode (ScopeOpCode
)) {
2385 if (InScopeDisable
&& CurrentForm
== NULL
) {
2387 // This is DisableIf expression for Form, it should be a constant expression
2389 ASSERT (CurrentExpression
!= NULL
);
2390 Status
= EvaluateExpression (FormSet
, CurrentForm
, CurrentExpression
);
2391 if (EFI_ERROR (Status
)) {
2395 if (CurrentExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2396 return EFI_INVALID_PARAMETER
;
2399 OpCodeDisabled
= CurrentExpression
->Result
.Value
.b
;
2401 // DisableIf Expression is only used once and not queued, free it
2403 DestroyExpression (CurrentExpression
);
2407 // End of current Expression
2409 CurrentExpression
= NULL
;