2 Parser for IFR binary encoding.
4 Copyright (c) 2007 - 2008, Intel Corporation
5 All rights reserved. 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.
18 UINT16 mStatementIndex
;
19 UINT16 mExpressionOpCodeIndex
;
21 BOOLEAN mInScopeSubtitle
;
22 BOOLEAN mInScopeSuppress
;
23 BOOLEAN mInScopeGrayOut
;
24 FORM_EXPRESSION
*mSuppressExpression
;
25 FORM_EXPRESSION
*mGrayOutExpression
;
27 EFI_GUID gTianoHiiIfrGuid
= EFI_IFR_TIANO_GUID
;
28 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID mFrameworkHiiCompatibilityGuid
= EFI_IFR_FRAMEWORK_GUID
;
32 Initialize Statement header members.
34 @param OpCodeData Pointer of the raw OpCode data.
35 @param FormSet Pointer of the current FormSe.
36 @param Form Pointer of the current Form.
38 @return The Statement.
41 FORM_BROWSER_STATEMENT
*
44 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
45 IN OUT FORM_BROWSER_FORM
*Form
48 FORM_BROWSER_STATEMENT
*Statement
;
49 EFI_IFR_STATEMENT_HEADER
*StatementHdr
;
53 // We are currently not in a Form Scope, so just skip this Statement
58 Statement
= &FormSet
->StatementBuffer
[mStatementIndex
];
61 InitializeListHead (&Statement
->DefaultListHead
);
62 InitializeListHead (&Statement
->OptionListHead
);
63 InitializeListHead (&Statement
->InconsistentListHead
);
64 InitializeListHead (&Statement
->NoSubmitListHead
);
66 Statement
->Signature
= FORM_BROWSER_STATEMENT_SIGNATURE
;
68 Statement
->Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
70 StatementHdr
= (EFI_IFR_STATEMENT_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
71 CopyMem (&Statement
->Prompt
, &StatementHdr
->Prompt
, sizeof (EFI_STRING_ID
));
72 CopyMem (&Statement
->Help
, &StatementHdr
->Help
, sizeof (EFI_STRING_ID
));
74 if (mInScopeSuppress
) {
75 Statement
->SuppressExpression
= mSuppressExpression
;
78 if (mInScopeGrayOut
) {
79 Statement
->GrayOutExpression
= mGrayOutExpression
;
82 Statement
->InSubtitle
= mInScopeSubtitle
;
85 // Insert this Statement into current Form
87 InsertTailList (&Form
->StatementListHead
, &Statement
->Link
);
93 UpdateCheckBoxStringToken (
94 IN CONST FORM_BROWSER_FORMSET
*FormSet
,
95 IN FORM_BROWSER_STATEMENT
*Statement
98 CHAR16 Str
[MAXIMUM_VALUE_CHARACTERS
];
102 ASSERT (Statement
!= NULL
);
103 ASSERT (Statement
->Operand
== EFI_IFR_NUMERIC_OP
);
105 UnicodeValueToString (Str
, 0, Statement
->VarStoreInfo
.VarName
, MAXIMUM_VALUE_CHARACTERS
- 1);
107 Status
= HiiLibNewString (FormSet
->HiiHandle
, &Id
, Str
);
109 if (EFI_ERROR (Status
)) {
113 Statement
->VarStoreInfo
.VarName
= Id
;
119 IsNextOpCodeGuidedVarEqName (
126 OpCodeData
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
127 if (*OpCodeData
== EFI_IFR_GUID_OP
) {
128 if (CompareGuid (&mFrameworkHiiCompatibilityGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
130 // Specific GUIDed opcodes to support IFR generated from Framework HII VFR
132 if ((((EFI_IFR_GUID_VAREQNAME
*) OpCodeData
)->ExtendOpCode
) == EFI_IFR_EXTEND_OP_VAREQNAME
) {
142 Initialize Question's members.
144 @param OpCodeData Pointer of the raw OpCode data.
145 @param FormSet Pointer of the current FormSet.
146 @param Form Pointer of the current Form.
148 @return The Question.
151 FORM_BROWSER_STATEMENT
*
153 IN UINT8
*OpCodeData
,
154 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
155 IN OUT FORM_BROWSER_FORM
*Form
158 FORM_BROWSER_STATEMENT
*Statement
;
159 EFI_IFR_QUESTION_HEADER
*QuestionHdr
;
161 FORMSET_STORAGE
*Storage
;
162 NAME_VALUE_NODE
*NameValueNode
;
165 Statement
= CreateStatement (OpCodeData
, FormSet
, Form
);
166 if (Statement
== NULL
) {
170 QuestionHdr
= (EFI_IFR_QUESTION_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
171 CopyMem (&Statement
->QuestionId
, &QuestionHdr
->QuestionId
, sizeof (EFI_QUESTION_ID
));
172 CopyMem (&Statement
->VarStoreId
, &QuestionHdr
->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
173 CopyMem (&Statement
->VarStoreInfo
.VarOffset
, &QuestionHdr
->VarStoreInfo
.VarOffset
, sizeof (UINT16
));
175 Statement
->QuestionFlags
= QuestionHdr
->Flags
;
177 if (Statement
->VarStoreId
== 0) {
179 // VarStoreId of zero indicates no variable storage
185 // Take a look at next OpCode to see whether it is a GUIDed opcode to support
186 // Framework Compatibility
188 if (FeaturePcdGet (PcdFrameworkHiiCompatibilitySupport
)) {
189 if ((*OpCodeData
== EFI_IFR_NUMERIC_OP
) && IsNextOpCodeGuidedVarEqName (OpCodeData
)) {
190 Status
= UpdateCheckBoxStringToken (FormSet
, Statement
);
191 if (EFI_ERROR (Status
)) {
198 // Find Storage for this Question
200 Link
= GetFirstNode (&FormSet
->StorageListHead
);
201 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
202 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
204 if (Storage
->VarStoreId
== Statement
->VarStoreId
) {
205 Statement
->Storage
= Storage
;
209 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
211 ASSERT (Statement
->Storage
!= NULL
);
214 // Initialilze varname for Name/Value or EFI Variable
216 if ((Statement
->Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) ||
217 (Statement
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
)) {
218 Statement
->VariableName
= GetToken (Statement
->VarStoreInfo
.VarName
, FormSet
->HiiHandle
);
219 ASSERT (Statement
->VariableName
!= NULL
);
221 if (Statement
->Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
223 // Insert to Name/Value varstore list
225 NameValueNode
= AllocateZeroPool (sizeof (NAME_VALUE_NODE
));
226 ASSERT (NameValueNode
!= NULL
);
227 NameValueNode
->Signature
= NAME_VALUE_NODE_SIGNATURE
;
228 NameValueNode
->Name
= AllocateCopyPool (StrSize (Statement
->VariableName
), Statement
->VariableName
);
229 ASSERT (NameValueNode
->Name
!= NULL
);
230 NameValueNode
->Value
= AllocateZeroPool (0x10);
231 ASSERT (NameValueNode
->Value
!= NULL
);
232 NameValueNode
->EditValue
= AllocateZeroPool (0x10);
233 ASSERT (NameValueNode
->EditValue
!= NULL
);
235 InsertTailList (&Statement
->Storage
->NameValueListHead
, &NameValueNode
->Link
);
244 Allocate a FORM_EXPRESSION node.
246 @param Form The Form associated with this Expression
248 @return Pointer to a FORM_EXPRESSION data structure.
253 IN OUT FORM_BROWSER_FORM
*Form
256 FORM_EXPRESSION
*Expression
;
258 Expression
= AllocateZeroPool (sizeof (FORM_EXPRESSION
));
259 Expression
->Signature
= FORM_EXPRESSION_SIGNATURE
;
260 InitializeListHead (&Expression
->OpCodeListHead
);
267 Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.
269 @param FormSet Pointer of the current FormSet
271 @return Pointer to a FORMSET_STORAGE data structure.
276 IN FORM_BROWSER_FORMSET
*FormSet
279 FORMSET_STORAGE
*Storage
;
281 Storage
= AllocateZeroPool (sizeof (FORMSET_STORAGE
));
282 Storage
->Signature
= FORMSET_STORAGE_SIGNATURE
;
283 InitializeListHead (&Storage
->NameValueListHead
);
284 InsertTailList (&FormSet
->StorageListHead
, &Storage
->Link
);
291 Create ConfigHdr string for a storage.
293 @param FormSet Pointer of the current FormSet
294 @param Storage Pointer of the storage
296 @retval EFI_SUCCESS Initialize ConfigHdr success
300 InitializeConfigHdr (
301 IN FORM_BROWSER_FORMSET
*FormSet
,
302 IN OUT FORMSET_STORAGE
*Storage
309 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) {
310 Name
= Storage
->Name
;
316 Status
= ConstructConfigHdr (
321 FormSet
->DriverHandle
323 if (Status
== EFI_BUFFER_TOO_SMALL
) {
324 Storage
->ConfigHdr
= AllocateZeroPool (StrBufferLen
);
325 Status
= ConstructConfigHdr (
330 FormSet
->DriverHandle
334 if (EFI_ERROR (Status
)) {
338 Storage
->ConfigRequest
= AllocateCopyPool (StrBufferLen
, Storage
->ConfigHdr
);
339 Storage
->SpareStrLen
= 0;
346 Initialize Request Element of a Question. <RequestElement> ::= '&'<BlockName> | '&'<Label>
348 @param FormSet Pointer of the current FormSet.
349 @param Question The Question to be initialized.
351 @retval EFI_SUCCESS Function success.
352 @retval EFI_INVALID_PARAMETER No storage associated with the Question.
356 InitializeRequestElement (
357 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
358 IN OUT FORM_BROWSER_STATEMENT
*Question
361 FORMSET_STORAGE
*Storage
;
365 CHAR16 RequestElement
[30];
367 Storage
= Question
->Storage
;
368 if (Storage
== NULL
) {
369 return EFI_INVALID_PARAMETER
;
372 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
374 // <ConfigRequest> is unnecessary for EFI variable storage,
375 // GetVariable()/SetVariable() will be used to retrieve/save values
381 // Prepare <RequestElement>
383 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) {
384 StrLen
= UnicodeSPrint (
386 30 * sizeof (CHAR16
),
387 L
"&OFFSET=%x&WIDTH=%x",
388 Question
->VarStoreInfo
.VarOffset
,
389 Question
->StorageWidth
391 Question
->BlockName
= AllocateCopyPool ((StrLen
+ 1) * sizeof (CHAR16
), RequestElement
);
393 StrLen
= UnicodeSPrint (RequestElement
, 30 * sizeof (CHAR16
), L
"&%s", Question
->VariableName
);
396 if ((Question
->Operand
== EFI_IFR_PASSWORD_OP
) && ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
)) {
398 // Password with CALLBACK flag is stored in encoded format,
399 // so don't need to append it to <ConfigRequest>
405 // Append <RequestElement> to <ConfigRequest>
407 if (StrLen
> Storage
->SpareStrLen
) {
409 // Old String buffer is not sufficient for RequestElement, allocate a new one
411 StringSize
= (Storage
->ConfigRequest
!= NULL
) ? StrSize (Storage
->ConfigRequest
) : sizeof (CHAR16
);
412 NewStr
= AllocateZeroPool (StringSize
+ CONFIG_REQUEST_STRING_INCREMENTAL
* sizeof (CHAR16
));
413 if (Storage
->ConfigRequest
!= NULL
) {
414 CopyMem (NewStr
, Storage
->ConfigRequest
, StringSize
);
415 gBS
->FreePool (Storage
->ConfigRequest
);
417 Storage
->ConfigRequest
= NewStr
;
418 Storage
->SpareStrLen
= CONFIG_REQUEST_STRING_INCREMENTAL
;
421 StrCat (Storage
->ConfigRequest
, RequestElement
);
422 Storage
->ElementCount
++;
423 Storage
->SpareStrLen
-= StrLen
;
430 Free resources of a Expression.
432 @param FormSet Pointer of the Expression
437 IN FORM_EXPRESSION
*Expression
441 EXPRESSION_OPCODE
*OpCode
;
443 while (!IsListEmpty (&Expression
->OpCodeListHead
)) {
444 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
445 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
446 RemoveEntryList (&OpCode
->Link
);
448 SafeFreePool (OpCode
->ValueList
);
452 // Free this Expression
454 gBS
->FreePool (Expression
);
459 Free resources of a storage.
461 @param Storage Pointer of the storage
466 IN FORMSET_STORAGE
*Storage
470 NAME_VALUE_NODE
*NameValueNode
;
472 if (Storage
== NULL
) {
476 SafeFreePool (Storage
->Name
);
477 SafeFreePool (Storage
->Buffer
);
478 SafeFreePool (Storage
->EditBuffer
);
480 while (!IsListEmpty (&Storage
->NameValueListHead
)) {
481 Link
= GetFirstNode (&Storage
->NameValueListHead
);
482 NameValueNode
= NAME_VALUE_NODE_FROM_LINK (Link
);
483 RemoveEntryList (&NameValueNode
->Link
);
485 SafeFreePool (NameValueNode
->Name
);
486 SafeFreePool (NameValueNode
->Value
);
487 SafeFreePool (NameValueNode
->EditValue
);
488 SafeFreePool (NameValueNode
);
491 SafeFreePool (Storage
->ConfigHdr
);
492 SafeFreePool (Storage
->ConfigRequest
);
494 gBS
->FreePool (Storage
);
499 Free resources of a Statement.
501 @param Statement Pointer of the Statement
506 IN OUT FORM_BROWSER_STATEMENT
*Statement
510 QUESTION_DEFAULT
*Default
;
511 QUESTION_OPTION
*Option
;
512 FORM_EXPRESSION
*Expression
;
515 // Free Default value List
517 while (!IsListEmpty (&Statement
->DefaultListHead
)) {
518 Link
= GetFirstNode (&Statement
->DefaultListHead
);
519 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
520 RemoveEntryList (&Default
->Link
);
522 gBS
->FreePool (Default
);
528 while (!IsListEmpty (&Statement
->OptionListHead
)) {
529 Link
= GetFirstNode (&Statement
->OptionListHead
);
530 Option
= QUESTION_OPTION_FROM_LINK (Link
);
531 RemoveEntryList (&Option
->Link
);
533 gBS
->FreePool (Option
);
537 // Free Inconsistent List
539 while (!IsListEmpty (&Statement
->InconsistentListHead
)) {
540 Link
= GetFirstNode (&Statement
->InconsistentListHead
);
541 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
542 RemoveEntryList (&Expression
->Link
);
544 DestroyExpression (Expression
);
548 // Free NoSubmit List
550 while (!IsListEmpty (&Statement
->NoSubmitListHead
)) {
551 Link
= GetFirstNode (&Statement
->NoSubmitListHead
);
552 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
553 RemoveEntryList (&Expression
->Link
);
555 DestroyExpression (Expression
);
558 SafeFreePool (Statement
->VariableName
);
559 SafeFreePool (Statement
->BlockName
);
564 Free resources of a Form.
566 @param Form Pointer of the Form.
571 IN OUT FORM_BROWSER_FORM
*Form
575 FORM_EXPRESSION
*Expression
;
576 FORM_BROWSER_STATEMENT
*Statement
;
579 // Free Form Expressions
581 while (!IsListEmpty (&Form
->ExpressionListHead
)) {
582 Link
= GetFirstNode (&Form
->ExpressionListHead
);
583 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
584 RemoveEntryList (&Expression
->Link
);
586 DestroyExpression (Expression
);
590 // Free Statements/Questions
592 while (!IsListEmpty (&Form
->StatementListHead
)) {
593 Link
= GetFirstNode (&Form
->StatementListHead
);
594 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
595 RemoveEntryList (&Statement
->Link
);
597 DestroyStatement (Statement
);
603 gBS
->FreePool (Form
);
608 Free resources allocated for a FormSet.
610 @param FormSet Pointer of the FormSet
615 IN OUT FORM_BROWSER_FORMSET
*FormSet
619 FORMSET_STORAGE
*Storage
;
620 FORMSET_DEFAULTSTORE
*DefaultStore
;
621 FORM_BROWSER_FORM
*Form
;
624 // Free IFR binary buffer
626 SafeFreePool (FormSet
->IfrBinaryData
);
629 // Free FormSet Storage
631 if (FormSet
->StorageListHead
.ForwardLink
!= NULL
) {
632 while (!IsListEmpty (&FormSet
->StorageListHead
)) {
633 Link
= GetFirstNode (&FormSet
->StorageListHead
);
634 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
635 RemoveEntryList (&Storage
->Link
);
637 DestroyStorage (Storage
);
642 // Free FormSet Default Store
644 if (FormSet
->DefaultStoreListHead
.ForwardLink
!= NULL
) {
645 while (!IsListEmpty (&FormSet
->DefaultStoreListHead
)) {
646 Link
= GetFirstNode (&FormSet
->DefaultStoreListHead
);
647 DefaultStore
= FORMSET_DEFAULTSTORE_FROM_LINK (Link
);
648 RemoveEntryList (&DefaultStore
->Link
);
650 gBS
->FreePool (DefaultStore
);
657 if (FormSet
->FormListHead
.ForwardLink
!= NULL
) {
658 while (!IsListEmpty (&FormSet
->FormListHead
)) {
659 Link
= GetFirstNode (&FormSet
->FormListHead
);
660 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
661 RemoveEntryList (&Form
->Link
);
667 SafeFreePool (FormSet
->StatementBuffer
);
668 SafeFreePool (FormSet
->ExpressionBuffer
);
670 SafeFreePool (FormSet
);
675 Tell whether this Operand is an Expression OpCode or not
677 @param Operand Operand of an IFR OpCode.
679 @retval TRUE This is an Expression OpCode.
680 @retval FALSE Not an Expression OpCode.
688 if (((Operand
>= EFI_IFR_EQ_ID_VAL_OP
) && (Operand
<= EFI_IFR_NOT_OP
)) ||
689 ((Operand
>= EFI_IFR_MATCH_OP
) && (Operand
<= EFI_IFR_SPAN_OP
)) ||
690 (Operand
== EFI_IFR_CATENATE_OP
) ||
691 (Operand
== EFI_IFR_TO_LOWER_OP
) ||
692 (Operand
== EFI_IFR_TO_UPPER_OP
) ||
693 (Operand
== EFI_IFR_VERSION_OP
)
703 Calculate number of Statemens(Questions) and Expression OpCodes.
705 @param FormSet The FormSet to be counted.
706 @param NumberOfStatement Number of Statemens(Questions)
707 @param NumberOfExpression Number of Expression OpCodes
712 IN FORM_BROWSER_FORMSET
*FormSet
,
713 IN OUT UINT16
*NumberOfStatement
,
714 IN OUT UINT16
*NumberOfExpression
717 UINT16 StatementCount
;
718 UINT16 ExpressionCount
;
727 while (Offset
< FormSet
->IfrBinaryLength
) {
728 OpCodeData
= FormSet
->IfrBinaryData
+ Offset
;
729 OpCodeLen
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
732 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
)) {
739 *NumberOfStatement
= StatementCount
;
740 *NumberOfExpression
= ExpressionCount
;
746 Parse opcodes in the formset IFR binary.
748 @param FormSet Pointer of the FormSet data structure.
750 @retval EFI_SUCCESS Opcode parse success.
751 @retval Other Opcode parse fail.
756 IN FORM_BROWSER_FORMSET
*FormSet
761 FORM_BROWSER_FORM
*CurrentForm
;
762 FORM_BROWSER_STATEMENT
*CurrentStatement
;
763 EXPRESSION_OPCODE
*ExpressionOpCode
;
764 FORM_EXPRESSION
*CurrentExpression
;
771 FORMSET_STORAGE
*Storage
;
772 FORMSET_DEFAULTSTORE
*DefaultStore
;
773 QUESTION_DEFAULT
*CurrentDefault
;
774 QUESTION_OPTION
*CurrentOption
;
776 UINT16 NumberOfStatement
;
777 UINT16 NumberOfExpression
;
778 EFI_IMAGE_ID
*ImageId
;
779 BOOLEAN SuppressForOption
;
780 BOOLEAN InScopeOptionSuppress
;
781 FORM_EXPRESSION
*OptionSuppressExpression
;
782 BOOLEAN InScopeDisable
;
783 UINT16 DepthOfDisable
;
784 BOOLEAN OpCodeDisabled
;
785 BOOLEAN SingleOpCodeExpression
;
786 BOOLEAN InScopeDefault
;
787 EFI_HII_VALUE
*Value
;
789 mInScopeSubtitle
= FALSE
;
790 SuppressForOption
= FALSE
;
791 mInScopeSuppress
= FALSE
;
792 InScopeOptionSuppress
= FALSE
;
793 mInScopeGrayOut
= FALSE
;
794 InScopeDisable
= FALSE
;
796 OpCodeDisabled
= FALSE
;
797 SingleOpCodeExpression
= FALSE
;
798 InScopeDefault
= FALSE
;
799 CurrentExpression
= NULL
;
800 CurrentDefault
= NULL
;
801 CurrentOption
= NULL
;
802 OptionSuppressExpression
= NULL
;
805 // Get the number of Statements and Expressions
807 CountOpCodes (FormSet
, &NumberOfStatement
, &NumberOfExpression
);
810 FormSet
->StatementBuffer
= AllocateZeroPool (NumberOfStatement
* sizeof (FORM_BROWSER_STATEMENT
));
811 if (FormSet
->StatementBuffer
== NULL
) {
812 return EFI_OUT_OF_RESOURCES
;
815 mExpressionOpCodeIndex
= 0;
816 FormSet
->ExpressionBuffer
= AllocateZeroPool (NumberOfExpression
* sizeof (EXPRESSION_OPCODE
));
817 if (FormSet
->ExpressionBuffer
== NULL
) {
818 return EFI_OUT_OF_RESOURCES
;
821 InitializeListHead (&FormSet
->StorageListHead
);
822 InitializeListHead (&FormSet
->DefaultStoreListHead
);
823 InitializeListHead (&FormSet
->FormListHead
);
826 CurrentStatement
= NULL
;
831 while (OpCodeOffset
< FormSet
->IfrBinaryLength
) {
832 OpCodeData
= FormSet
->IfrBinaryData
+ OpCodeOffset
;
834 OpCodeLength
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
835 OpCodeOffset
+= OpCodeLength
;
836 Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
837 Scope
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Scope
;
840 // If scope bit set, push onto scope stack
846 if (OpCodeDisabled
) {
848 // DisableIf Expression is evaluated to be TRUE, try to find its end.
849 // Here only cares the EFI_IFR_DISABLE_IF and EFI_IFR_END
851 if (Operand
== EFI_IFR_DISABLE_IF_OP
) {
853 } else if (Operand
== EFI_IFR_END_OP
) {
854 Status
= PopScope (&ScopeOpCode
);
855 if (EFI_ERROR (Status
)) {
859 if (ScopeOpCode
== EFI_IFR_DISABLE_IF_OP
) {
860 if (DepthOfDisable
== 0) {
861 InScopeDisable
= FALSE
;
862 OpCodeDisabled
= FALSE
;
871 if (IsExpressionOpCode (Operand
)) {
872 ExpressionOpCode
= &FormSet
->ExpressionBuffer
[mExpressionOpCodeIndex
];
873 mExpressionOpCodeIndex
++;
875 ExpressionOpCode
->Signature
= EXPRESSION_OPCODE_SIGNATURE
;
876 ExpressionOpCode
->Operand
= Operand
;
877 Value
= &ExpressionOpCode
->Value
;
880 case EFI_IFR_EQ_ID_VAL_OP
:
881 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_VAL
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
883 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
884 CopyMem (&Value
->Value
.u16
, &((EFI_IFR_EQ_ID_VAL
*) OpCodeData
)->Value
, sizeof (UINT16
));
887 case EFI_IFR_EQ_ID_ID_OP
:
888 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_ID
*) OpCodeData
)->QuestionId1
, sizeof (EFI_QUESTION_ID
));
889 CopyMem (&ExpressionOpCode
->QuestionId2
, &((EFI_IFR_EQ_ID_ID
*) OpCodeData
)->QuestionId2
, sizeof (EFI_QUESTION_ID
));
892 case EFI_IFR_EQ_ID_LIST_OP
:
893 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_LIST
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
894 CopyMem (&ExpressionOpCode
->ListLength
, &((EFI_IFR_EQ_ID_LIST
*) OpCodeData
)->ListLength
, sizeof (UINT16
));
895 ExpressionOpCode
->ValueList
= AllocateCopyPool (ExpressionOpCode
->ListLength
* sizeof (UINT16
), &((EFI_IFR_EQ_ID_LIST
*) OpCodeData
)->ValueList
);
898 case EFI_IFR_TO_STRING_OP
:
899 case EFI_IFR_FIND_OP
:
900 ExpressionOpCode
->Format
= (( EFI_IFR_TO_STRING
*) OpCodeData
)->Format
;
903 case EFI_IFR_STRING_REF1_OP
:
904 Value
->Type
= EFI_IFR_TYPE_STRING
;
905 CopyMem (&Value
->Value
.string
, &(( EFI_IFR_STRING_REF1
*) OpCodeData
)->StringId
, sizeof (EFI_STRING_ID
));
908 case EFI_IFR_RULE_REF_OP
:
909 ExpressionOpCode
->RuleId
= (( EFI_IFR_RULE_REF
*) OpCodeData
)->RuleId
;
912 case EFI_IFR_SPAN_OP
:
913 ExpressionOpCode
->Flags
= (( EFI_IFR_SPAN
*) OpCodeData
)->Flags
;
916 case EFI_IFR_THIS_OP
:
917 ExpressionOpCode
->QuestionId
= CurrentStatement
->QuestionId
;
920 case EFI_IFR_QUESTION_REF1_OP
:
921 CopyMem (&ExpressionOpCode
->QuestionId
, &((EFI_IFR_EQ_ID_LIST
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
924 case EFI_IFR_QUESTION_REF3_OP
:
925 if (OpCodeLength
>= sizeof (EFI_IFR_QUESTION_REF3_2
)) {
926 CopyMem (&ExpressionOpCode
->DevicePath
, &(( EFI_IFR_QUESTION_REF3_2
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
928 if (OpCodeLength
>= sizeof (EFI_IFR_QUESTION_REF3_3
)) {
929 CopyMem (&ExpressionOpCode
->Guid
, &(( EFI_IFR_QUESTION_REF3_3
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
937 case EFI_IFR_TRUE_OP
:
938 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
939 Value
->Value
.b
= TRUE
;
942 case EFI_IFR_FALSE_OP
:
943 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
944 Value
->Value
.b
= FALSE
;
948 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
952 case EFI_IFR_ZERO_OP
:
953 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
957 case EFI_IFR_ONES_OP
:
958 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
959 Value
->Value
.u64
= 0xffffffffffffffffULL
;
962 case EFI_IFR_UINT8_OP
:
963 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
964 Value
->Value
.u8
= (( EFI_IFR_UINT8
*) OpCodeData
)->Value
;
967 case EFI_IFR_UINT16_OP
:
968 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
969 CopyMem (&Value
->Value
.u16
, &(( EFI_IFR_UINT16
*) OpCodeData
)->Value
, sizeof (UINT16
));
972 case EFI_IFR_UINT32_OP
:
973 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
974 CopyMem (&Value
->Value
.u32
, &(( EFI_IFR_UINT32
*) OpCodeData
)->Value
, sizeof (UINT32
));
977 case EFI_IFR_UINT64_OP
:
978 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
979 CopyMem (&Value
->Value
.u64
, &(( EFI_IFR_UINT64
*) OpCodeData
)->Value
, sizeof (UINT64
));
982 case EFI_IFR_UNDEFINED_OP
:
983 Value
->Type
= EFI_IFR_TYPE_OTHER
;
986 case EFI_IFR_VERSION_OP
:
987 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
988 Value
->Value
.u16
= EFI_IFR_SPECIFICATION_VERSION
;
995 InsertTailList (&CurrentExpression
->OpCodeListHead
, &ExpressionOpCode
->Link
);
997 if (SingleOpCodeExpression
) {
999 // There are two cases to indicate the end of an Expression:
1000 // for single OpCode expression: one Expression OpCode
1001 // for expression consists of more than one OpCode: EFI_IFR_END
1003 SingleOpCodeExpression
= FALSE
;
1005 if (InScopeDisable
) {
1007 // Evaluate DisableIf expression
1009 Status
= EvaluateExpression (FormSet
, CurrentForm
, CurrentExpression
);
1010 if (EFI_ERROR (Status
)) {
1013 if (CurrentExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
1014 return EFI_INVALID_PARAMETER
;
1017 OpCodeDisabled
= CurrentExpression
->Result
.Value
.b
;
1020 CurrentExpression
= NULL
;
1031 case EFI_IFR_FORM_SET_OP
:
1033 // check the formset GUID
1035 if (CompareMem (&FormSet
->Guid
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
)) != 0) {
1036 return EFI_INVALID_PARAMETER
;
1039 CopyMem (&FormSet
->FormSetTitle
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->FormSetTitle
, sizeof (EFI_STRING_ID
));
1040 CopyMem (&FormSet
->Help
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Help
, sizeof (EFI_STRING_ID
));
1043 case EFI_IFR_FORM_OP
:
1045 // Create a new Form for this FormSet
1047 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
1048 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
1049 InitializeListHead (&CurrentForm
->ExpressionListHead
);
1050 InitializeListHead (&CurrentForm
->StatementListHead
);
1052 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
1053 CopyMem (&CurrentForm
->FormTitle
, &((EFI_IFR_FORM
*) OpCodeData
)->FormTitle
, sizeof (EFI_STRING_ID
));
1056 // Insert into Form list of this FormSet
1058 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
1064 case EFI_IFR_VARSTORE_OP
:
1066 // Create a buffer Storage for this FormSet
1068 Storage
= CreateStorage (FormSet
);
1069 Storage
->Type
= EFI_HII_VARSTORE_BUFFER
;
1071 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1072 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
1073 CopyMem (&Storage
->Size
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Size
, sizeof (UINT16
));
1075 Storage
->Buffer
= AllocateZeroPool (Storage
->Size
);
1076 Storage
->EditBuffer
= AllocateZeroPool (Storage
->Size
);
1078 AsciiString
= (CHAR8
*) ((EFI_IFR_VARSTORE
*) OpCodeData
)->Name
;
1079 Storage
->Name
= AllocateZeroPool (AsciiStrSize (AsciiString
) * 2);
1080 ASSERT (Storage
->Name
!= NULL
);
1081 for (Index
= 0; AsciiString
[Index
] != 0; Index
++) {
1082 Storage
->Name
[Index
] = (CHAR16
) AsciiString
[Index
];
1086 // Initialize <ConfigHdr>
1088 InitializeConfigHdr (FormSet
, Storage
);
1091 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1093 // Create a name/value Storage for this FormSet
1095 Storage
= CreateStorage (FormSet
);
1096 Storage
->Type
= EFI_HII_VARSTORE_NAME_VALUE
;
1098 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1099 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
1102 // Initialize <ConfigHdr>
1104 InitializeConfigHdr (FormSet
, Storage
);
1107 case EFI_IFR_VARSTORE_EFI_OP
:
1109 // Create a EFI variable Storage for this FormSet
1111 Storage
= CreateStorage (FormSet
);
1112 Storage
->Type
= EFI_HII_VARSTORE_EFI_VARIABLE
;
1114 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
1115 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
1116 CopyMem (&Storage
->Attributes
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Attributes
, sizeof (UINT32
));
1122 case EFI_IFR_DEFAULTSTORE_OP
:
1123 DefaultStore
= AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE
));
1124 DefaultStore
->Signature
= FORMSET_DEFAULTSTORE_SIGNATURE
;
1126 CopyMem (&DefaultStore
->DefaultId
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
1127 CopyMem (&DefaultStore
->DefaultName
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultName
, sizeof (EFI_STRING_ID
));
1130 // Insert to DefaultStore list of this Formset
1132 InsertTailList (&FormSet
->DefaultStoreListHead
, &DefaultStore
->Link
);
1138 case EFI_IFR_SUBTITLE_OP
:
1139 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
1140 CurrentStatement
->Flags
= ((EFI_IFR_SUBTITLE
*) OpCodeData
)->Flags
;
1143 mInScopeSubtitle
= TRUE
;
1147 case EFI_IFR_TEXT_OP
:
1148 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
1150 CopyMem (&CurrentStatement
->TextTwo
, &((EFI_IFR_TEXT
*) OpCodeData
)->TextTwo
, sizeof (EFI_STRING_ID
));
1156 case EFI_IFR_ACTION_OP
:
1157 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1159 if (OpCodeLength
== sizeof (EFI_IFR_ACTION_1
)) {
1161 // No QuestionConfig present, so no configuration string will be processed
1163 CurrentStatement
->QuestionConfig
= 0;
1165 CopyMem (&CurrentStatement
->QuestionConfig
, &((EFI_IFR_ACTION
*) OpCodeData
)->QuestionConfig
, sizeof (EFI_STRING_ID
));
1169 case EFI_IFR_RESET_BUTTON_OP
:
1170 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1172 CopyMem (&CurrentStatement
->DefaultId
, &((EFI_IFR_RESET_BUTTON
*) OpCodeData
)->DefaultId
, sizeof (EFI_DEFAULT_ID
));
1175 case EFI_IFR_REF_OP
:
1176 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1178 CopyMem (&CurrentStatement
->RefFormId
, &((EFI_IFR_REF
*) OpCodeData
)->FormId
, sizeof (EFI_FORM_ID
));
1179 if (OpCodeLength
>= sizeof (EFI_IFR_REF2
)) {
1180 CopyMem (&CurrentStatement
->RefQuestionId
, &((EFI_IFR_REF2
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
1182 if (OpCodeLength
>= sizeof (EFI_IFR_REF3
)) {
1183 CopyMem (&CurrentStatement
->RefFormSetId
, &((EFI_IFR_REF3
*) OpCodeData
)->FormSetId
, sizeof (EFI_GUID
));
1185 if (OpCodeLength
>= sizeof (EFI_IFR_REF4
)) {
1186 CopyMem (&CurrentStatement
->RefDevicePath
, &((EFI_IFR_REF4
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
1192 case EFI_IFR_ONE_OF_OP
:
1193 case EFI_IFR_NUMERIC_OP
:
1194 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1196 CurrentStatement
->Flags
= ((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
;
1197 Value
= &CurrentStatement
->HiiValue
;
1199 switch (CurrentStatement
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1200 case EFI_IFR_NUMERIC_SIZE_1
:
1201 CurrentStatement
->Minimum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MinValue
;
1202 CurrentStatement
->Maximum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MaxValue
;
1203 CurrentStatement
->Step
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.Step
;
1204 CurrentStatement
->StorageWidth
= sizeof (UINT8
);
1205 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
1208 case EFI_IFR_NUMERIC_SIZE_2
:
1209 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MinValue
, sizeof (UINT16
));
1210 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MaxValue
, sizeof (UINT16
));
1211 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.Step
, sizeof (UINT16
));
1212 CurrentStatement
->StorageWidth
= sizeof (UINT16
);
1213 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
1216 case EFI_IFR_NUMERIC_SIZE_4
:
1217 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MinValue
, sizeof (UINT32
));
1218 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MaxValue
, sizeof (UINT32
));
1219 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.Step
, sizeof (UINT32
));
1220 CurrentStatement
->StorageWidth
= sizeof (UINT32
);
1221 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
1224 case EFI_IFR_NUMERIC_SIZE_8
:
1225 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MinValue
, sizeof (UINT64
));
1226 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MaxValue
, sizeof (UINT64
));
1227 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.Step
, sizeof (UINT64
));
1228 CurrentStatement
->StorageWidth
= sizeof (UINT64
);
1229 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1236 InitializeRequestElement (FormSet
, CurrentStatement
);
1238 if ((Operand
== EFI_IFR_ONE_OF_OP
) && Scope
!= 0) {
1239 SuppressForOption
= TRUE
;
1243 case EFI_IFR_ORDERED_LIST_OP
:
1244 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1246 CurrentStatement
->Flags
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Flags
;
1247 CurrentStatement
->MaxContainers
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
1248 CurrentStatement
->StorageWidth
= (UINT16
)(CurrentStatement
->MaxContainers
* sizeof (UINT8
));
1249 InitializeRequestElement (FormSet
, CurrentStatement
);
1252 // No buffer type is defined in EFI_IFR_TYPE_VALUE, so a Configuration Driver
1253 // has to use FormBrowser2.Callback() to retrieve the uncommited data for
1254 // an interactive orderedlist (i.e. with EFI_IFR_FLAG_CALLBACK flag set).
1256 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_OTHER
;
1257 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
1260 SuppressForOption
= TRUE
;
1264 case EFI_IFR_CHECKBOX_OP
:
1265 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1267 CurrentStatement
->Flags
= ((EFI_IFR_CHECKBOX
*) OpCodeData
)->Flags
;
1268 CurrentStatement
->StorageWidth
= sizeof (BOOLEAN
);
1269 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_BOOLEAN
;
1271 InitializeRequestElement (FormSet
, CurrentStatement
);
1275 case EFI_IFR_STRING_OP
:
1276 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1279 // MinSize is the minimum number of characters that can be accepted for this opcode,
1280 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1281 // The characters are stored as Unicode, so the storage width should multiply 2.
1283 CurrentStatement
->Minimum
= ((EFI_IFR_STRING
*) OpCodeData
)->MinSize
;
1284 CurrentStatement
->Maximum
= ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
;
1285 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (CHAR16
));
1286 CurrentStatement
->Flags
= ((EFI_IFR_STRING
*) OpCodeData
)->Flags
;
1288 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
1289 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
+ sizeof (CHAR16
));
1291 InitializeRequestElement (FormSet
, CurrentStatement
);
1294 case EFI_IFR_PASSWORD_OP
:
1295 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1298 // MinSize is the minimum number of characters that can be accepted for this opcode,
1299 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1300 // The characters are stored as Unicode, so the storage width should multiply 2.
1302 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MinSize
, sizeof (UINT16
));
1303 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MaxSize
, sizeof (UINT16
));
1304 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (CHAR16
));
1306 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
1307 CurrentStatement
->BufferValue
= AllocateZeroPool ((CurrentStatement
->StorageWidth
+ sizeof (CHAR16
)));
1309 InitializeRequestElement (FormSet
, CurrentStatement
);
1312 case EFI_IFR_DATE_OP
:
1313 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1315 CurrentStatement
->Flags
= ((EFI_IFR_DATE
*) OpCodeData
)->Flags
;
1316 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_DATE
;
1318 if ((CurrentStatement
->Flags
& EFI_QF_DATE_STORAGE
) == QF_DATE_STORAGE_NORMAL
) {
1319 CurrentStatement
->StorageWidth
= sizeof (EFI_HII_DATE
);
1321 InitializeRequestElement (FormSet
, CurrentStatement
);
1324 // Don't assign storage for RTC type of date/time
1326 CurrentStatement
->Storage
= NULL
;
1327 CurrentStatement
->StorageWidth
= 0;
1331 case EFI_IFR_TIME_OP
:
1332 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
1334 CurrentStatement
->Flags
= ((EFI_IFR_TIME
*) OpCodeData
)->Flags
;
1335 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_TIME
;
1337 if ((CurrentStatement
->Flags
& QF_TIME_STORAGE
) == QF_TIME_STORAGE_NORMAL
) {
1338 CurrentStatement
->StorageWidth
= sizeof (EFI_IFR_TIME
);
1340 InitializeRequestElement (FormSet
, CurrentStatement
);
1343 // Don't assign storage for RTC type of date/time
1345 CurrentStatement
->Storage
= NULL
;
1346 CurrentStatement
->StorageWidth
= 0;
1353 case EFI_IFR_DEFAULT_OP
:
1355 // EFI_IFR_DEFAULT appear in scope of a Question,
1356 // It creates a default value for the current question.
1357 // A Question may have more than one Default value which have different default types.
1359 CurrentDefault
= AllocateZeroPool (sizeof (QUESTION_DEFAULT
));
1360 CurrentDefault
->Signature
= QUESTION_DEFAULT_SIGNATURE
;
1362 CurrentDefault
->Value
.Type
= ((EFI_IFR_DEFAULT
*) OpCodeData
)->Type
;
1363 CopyMem (&CurrentDefault
->DefaultId
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
1364 CopyMem (&CurrentDefault
->Value
.Value
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
1365 ExtendValueToU64 (&CurrentDefault
->Value
);
1368 // Insert to Default Value list of current Question
1370 InsertTailList (&CurrentStatement
->DefaultListHead
, &CurrentDefault
->Link
);
1373 InScopeDefault
= TRUE
;
1380 case EFI_IFR_ONE_OF_OPTION_OP
:
1382 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
1383 // It create a selection for use in current Question.
1385 CurrentOption
= AllocateZeroPool (sizeof (QUESTION_OPTION
));
1386 CurrentOption
->Signature
= QUESTION_OPTION_SIGNATURE
;
1388 CurrentOption
->Flags
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Flags
;
1389 CurrentOption
->Value
.Type
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Type
;
1390 CopyMem (&CurrentOption
->Text
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Option
, sizeof (EFI_STRING_ID
));
1391 CopyMem (&CurrentOption
->Value
.Value
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
1392 ExtendValueToU64 (&CurrentOption
->Value
);
1394 if (InScopeOptionSuppress
) {
1395 CurrentOption
->SuppressExpression
= OptionSuppressExpression
;
1399 // Insert to Option list of current Question
1401 InsertTailList (&CurrentStatement
->OptionListHead
, &CurrentOption
->Link
);
1407 case EFI_IFR_NO_SUBMIT_IF_OP
:
1408 case EFI_IFR_INCONSISTENT_IF_OP
:
1410 // Create an Expression node
1412 CurrentExpression
= CreateExpression (CurrentForm
);
1413 CopyMem (&CurrentExpression
->Error
, &((EFI_IFR_INCONSISTENT_IF
*) OpCodeData
)->Error
, sizeof (EFI_STRING_ID
));
1415 if (Operand
== EFI_IFR_NO_SUBMIT_IF_OP
) {
1416 CurrentExpression
->Type
= EFI_HII_EXPRESSION_NO_SUBMIT_IF
;
1417 InsertTailList (&CurrentStatement
->NoSubmitListHead
, &CurrentExpression
->Link
);
1419 CurrentExpression
->Type
= EFI_HII_EXPRESSION_INCONSISTENT_IF
;
1420 InsertTailList (&CurrentStatement
->InconsistentListHead
, &CurrentExpression
->Link
);
1424 case EFI_IFR_SUPPRESS_IF_OP
:
1426 // Question and Option will appear in scope of this OpCode
1428 CurrentExpression
= CreateExpression (CurrentForm
);
1429 CurrentExpression
->Type
= EFI_HII_EXPRESSION_SUPPRESS_IF
;
1430 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
1432 if (SuppressForOption
) {
1433 InScopeOptionSuppress
= TRUE
;
1434 OptionSuppressExpression
= CurrentExpression
;
1436 mInScopeSuppress
= TRUE
;
1437 mSuppressExpression
= CurrentExpression
;
1441 case EFI_IFR_GRAY_OUT_IF_OP
:
1443 // Questions will appear in scope of this OpCode
1445 CurrentExpression
= CreateExpression (CurrentForm
);
1446 CurrentExpression
->Type
= EFI_HII_EXPRESSION_GRAY_OUT_IF
;
1447 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
1449 mInScopeGrayOut
= TRUE
;
1450 mGrayOutExpression
= CurrentExpression
;
1453 case EFI_IFR_DISABLE_IF_OP
:
1455 // The DisableIf expression should only rely on constant, so it could be
1456 // evaluated at initialization and it will not be queued
1458 CurrentExpression
= AllocateZeroPool (sizeof (FORM_EXPRESSION
));
1459 CurrentExpression
->Signature
= FORM_EXPRESSION_SIGNATURE
;
1460 CurrentExpression
->Type
= EFI_HII_EXPRESSION_DISABLE_IF
;
1461 InitializeListHead (&CurrentExpression
->OpCodeListHead
);
1463 InScopeDisable
= TRUE
;
1464 OpCodeDisabled
= FALSE
;
1467 // Take a look at next OpCode to see whether current expression consists
1470 if (((EFI_IFR_OP_HEADER
*) (OpCodeData
+ OpCodeLength
))->Scope
== 0) {
1471 SingleOpCodeExpression
= TRUE
;
1478 case EFI_IFR_VALUE_OP
:
1479 CurrentExpression
= CreateExpression (CurrentForm
);
1480 CurrentExpression
->Type
= EFI_HII_EXPRESSION_VALUE
;
1481 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
1483 if (InScopeDefault
) {
1485 // Used for default (EFI_IFR_DEFAULT)
1487 CurrentDefault
->ValueExpression
= CurrentExpression
;
1490 // If used for a question, then the question will be read-only
1492 CurrentStatement
->ValueExpression
= CurrentExpression
;
1496 case EFI_IFR_RULE_OP
:
1497 CurrentExpression
= CreateExpression (CurrentForm
);
1498 CurrentExpression
->Type
= EFI_HII_EXPRESSION_RULE
;
1500 CurrentExpression
->RuleId
= ((EFI_IFR_RULE
*) OpCodeData
)->RuleId
;
1501 InsertTailList (&CurrentForm
->ExpressionListHead
, &CurrentExpression
->Link
);
1507 case EFI_IFR_IMAGE_OP
:
1509 // Get ScopeOpcode from top of stack
1511 PopScope (&ScopeOpCode
);
1512 PushScope (ScopeOpCode
);
1514 switch (ScopeOpCode
) {
1515 case EFI_IFR_FORM_SET_OP
:
1516 ImageId
= &FormSet
->ImageId
;
1519 case EFI_IFR_FORM_OP
:
1520 ImageId
= &CurrentForm
->ImageId
;
1523 case EFI_IFR_ONE_OF_OPTION_OP
:
1524 ImageId
= &CurrentOption
->ImageId
;
1528 ImageId
= &CurrentStatement
->ImageId
;
1532 CopyMem (ImageId
, &((EFI_IFR_IMAGE
*) OpCodeData
)->Id
, sizeof (EFI_IMAGE_ID
));
1538 case EFI_IFR_REFRESH_OP
:
1539 CurrentStatement
->RefreshInterval
= ((EFI_IFR_REFRESH
*) OpCodeData
)->RefreshInterval
;
1545 case EFI_IFR_GUID_OP
:
1546 if (CompareGuid (&gTianoHiiIfrGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
1548 // Tiano specific GUIDed opcodes
1550 switch (((EFI_IFR_GUID_LABEL
*) OpCodeData
)->ExtendOpCode
) {
1551 case EFI_IFR_EXTEND_OP_LABEL
:
1553 // just ignore label
1557 case EFI_IFR_EXTEND_OP_BANNER
:
1558 if (FormSet
->SubClass
== EFI_FRONT_PAGE_SUBCLASS
) {
1560 &BannerData
->Banner
[((EFI_IFR_GUID_BANNER
*) OpCodeData
)->LineNumber
][
1561 ((EFI_IFR_GUID_BANNER
*) OpCodeData
)->Alignment
],
1562 &((EFI_IFR_GUID_BANNER
*) OpCodeData
)->Title
,
1563 sizeof (EFI_STRING_ID
)
1568 case EFI_IFR_EXTEND_OP_CLASS
:
1569 CopyMem (&FormSet
->Class
, &((EFI_IFR_GUID_CLASS
*) OpCodeData
)->Class
, sizeof (UINT16
));
1572 case EFI_IFR_EXTEND_OP_SUBCLASS
:
1573 CopyMem (&FormSet
->SubClass
, &((EFI_IFR_GUID_SUBCLASS
*) OpCodeData
)->SubClass
, sizeof (UINT16
));
1586 case EFI_IFR_END_OP
:
1587 Status
= PopScope (&ScopeOpCode
);
1588 if (EFI_ERROR (Status
)) {
1593 switch (ScopeOpCode
) {
1594 case EFI_IFR_FORM_SET_OP
:
1596 // End of FormSet, update FormSet IFR binary length
1597 // to stop parsing substantial OpCodes
1599 FormSet
->IfrBinaryLength
= OpCodeOffset
;
1602 case EFI_IFR_FORM_OP
:
1609 case EFI_IFR_ONE_OF_OPTION_OP
:
1613 CurrentOption
= NULL
;
1616 case EFI_IFR_SUBTITLE_OP
:
1617 mInScopeSubtitle
= FALSE
;
1620 case EFI_IFR_NO_SUBMIT_IF_OP
:
1621 case EFI_IFR_INCONSISTENT_IF_OP
:
1623 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
1627 case EFI_IFR_SUPPRESS_IF_OP
:
1628 if (SuppressForOption
) {
1629 InScopeOptionSuppress
= FALSE
;
1631 mInScopeSuppress
= FALSE
;
1635 case EFI_IFR_GRAY_OUT_IF_OP
:
1636 mInScopeGrayOut
= FALSE
;
1639 case EFI_IFR_DISABLE_IF_OP
:
1640 InScopeDisable
= FALSE
;
1641 OpCodeDisabled
= FALSE
;
1644 case EFI_IFR_ONE_OF_OP
:
1645 case EFI_IFR_ORDERED_LIST_OP
:
1646 SuppressForOption
= FALSE
;
1649 case EFI_IFR_DEFAULT_OP
:
1650 InScopeDefault
= FALSE
;
1654 if (IsExpressionOpCode (ScopeOpCode
)) {
1655 if (InScopeDisable
) {
1657 // Evaluate DisableIf expression
1659 Status
= EvaluateExpression (FormSet
, CurrentForm
, CurrentExpression
);
1660 if (EFI_ERROR (Status
)) {
1663 if (CurrentExpression
->Result
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
1664 return EFI_INVALID_PARAMETER
;
1667 OpCodeDisabled
= CurrentExpression
->Result
.Value
.b
;
1669 // DisableIf Expression is only used once and not quequed, free it
1671 DestroyExpression (CurrentExpression
);
1675 // End of current Expression
1677 CurrentExpression
= NULL
;