2 Parser for IFR binary encoding.
4 Copyright (c) 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.
15 #include "HiiDatabase.h"
17 #include "UefiIfrParserExpression.h"
19 UINT16 mStatementIndex
;
21 BOOLEAN mInScopeSubtitle
;
22 BOOLEAN mInScopeSuppress
;
23 BOOLEAN mInScopeGrayOut
;
25 EFI_GUID mFrameworkHiiCompatibilityGuid
= EFI_IFR_FRAMEWORK_GUID
;
26 extern EFI_GUID mTianoHiiIfrGuid
;
29 GetOneOfOptionMapEntryListHead (
30 IN CONST FORM_BROWSER_FORMSET
*FormSet
,
35 ONE_OF_OPTION_MAP
*Map
;
37 Link
= GetFirstNode (&FormSet
->OneOfOptionMapListHead
);
39 while (!IsNull (&FormSet
->OneOfOptionMapListHead
, Link
)) {
40 Map
= ONE_OF_OPTION_MAP_FROM_LINK (Link
);
41 if (QuestionId
== Map
->QuestionId
) {
42 return &Map
->OneOfOptionMapEntryListHead
;
44 Link
= GetNextNode (&FormSet
->OneOfOptionMapListHead
, Link
);
51 DestoryOneOfOptionMap (
52 IN LIST_ENTRY
*OneOfOptionMapListHead
55 ONE_OF_OPTION_MAP
*Map
;
56 ONE_OF_OPTION_MAP_ENTRY
*MapEntry
;
60 while (!IsListEmpty (OneOfOptionMapListHead
)) {
61 Link
= GetFirstNode (OneOfOptionMapListHead
);
63 Map
= ONE_OF_OPTION_MAP_FROM_LINK (Link
);
65 while (!IsListEmpty (&Map
->OneOfOptionMapEntryListHead
)) {
66 Link2
= GetFirstNode (&Map
->OneOfOptionMapEntryListHead
);
68 MapEntry
= ONE_OF_OPTION_MAP_ENTRY_FROM_LINK (Link2
);
70 RemoveEntryList (Link2
);
75 RemoveEntryList (Link
);
82 Initialize Statement header members.
84 @param OpCodeData Pointer of the raw OpCode data.
85 @param FormSet Pointer of the current FormSe.
86 @param Form Pointer of the current Form.
88 @return The Statement.
91 FORM_BROWSER_STATEMENT
*
94 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
95 IN OUT FORM_BROWSER_FORM
*Form
98 FORM_BROWSER_STATEMENT
*Statement
;
99 EFI_IFR_STATEMENT_HEADER
*StatementHdr
;
103 // We are currently not in a Form Scope, so just skip this Statement
108 Statement
= &FormSet
->StatementBuffer
[mStatementIndex
];
111 InitializeListHead (&Statement
->DefaultListHead
);
112 InitializeListHead (&Statement
->OptionListHead
);
114 Statement
->Signature
= FORM_BROWSER_STATEMENT_SIGNATURE
;
116 Statement
->Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
118 StatementHdr
= (EFI_IFR_STATEMENT_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
119 CopyMem (&Statement
->Prompt
, &StatementHdr
->Prompt
, sizeof (EFI_STRING_ID
));
120 CopyMem (&Statement
->Help
, &StatementHdr
->Help
, sizeof (EFI_STRING_ID
));
122 Statement
->InSubtitle
= mInScopeSubtitle
;
125 // Insert this Statement into current Form
127 InsertTailList (&Form
->StatementListHead
, &Statement
->Link
);
133 Initialize Question's members.
135 @param OpCodeData Pointer of the raw OpCode data.
136 @param FormSet Pointer of the current FormSet.
137 @param Form Pointer of the current Form.
139 @return The Question.
142 FORM_BROWSER_STATEMENT
*
144 IN UINT8
*OpCodeData
,
145 IN OUT FORM_BROWSER_FORMSET
*FormSet
,
146 IN OUT FORM_BROWSER_FORM
*Form
149 FORM_BROWSER_STATEMENT
*Statement
;
150 EFI_IFR_QUESTION_HEADER
*QuestionHdr
;
152 FORMSET_STORAGE
*Storage
;
154 Statement
= CreateStatement (OpCodeData
, FormSet
, Form
);
155 if (Statement
== NULL
) {
159 QuestionHdr
= (EFI_IFR_QUESTION_HEADER
*) (OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
));
160 CopyMem (&Statement
->QuestionId
, &QuestionHdr
->QuestionId
, sizeof (EFI_QUESTION_ID
));
161 CopyMem (&Statement
->VarStoreId
, &QuestionHdr
->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
162 CopyMem (&Statement
->VarStoreInfo
.VarOffset
, &QuestionHdr
->VarStoreInfo
.VarOffset
, sizeof (UINT16
));
164 if (FormSet
->MaxQuestionId
< QuestionHdr
->QuestionId
) {
165 FormSet
->MaxQuestionId
= QuestionHdr
->QuestionId
;
168 Statement
->QuestionFlags
= QuestionHdr
->Flags
;
170 if (Statement
->VarStoreId
== 0) {
172 // VarStoreId of zero indicates no variable storage
178 // Find Storage for this Question
180 Link
= GetFirstNode (&FormSet
->StorageListHead
);
181 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
182 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
184 if (Storage
->VarStoreId
== Statement
->VarStoreId
) {
185 Statement
->Storage
= Storage
;
189 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
191 ASSERT (Statement
->Storage
!= NULL
);
197 Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.
199 @param FormSet Pointer of the current FormSet
201 @return Pointer to a FORMSET_STORAGE data structure.
206 IN FORM_BROWSER_FORMSET
*FormSet
209 FORMSET_STORAGE
*Storage
;
211 Storage
= AllocateZeroPool (sizeof (FORMSET_STORAGE
));
212 Storage
->Signature
= FORMSET_STORAGE_SIGNATURE
;
213 InsertTailList (&FormSet
->StorageListHead
, &Storage
->Link
);
219 Free resources of a storage
221 @param Storage Pointer of the storage
228 IN FORMSET_STORAGE
*Storage
231 if (Storage
== NULL
) {
235 if (Storage
->Name
!= NULL
) {
236 FreePool (Storage
->Name
);
244 Free resources of a Statement
246 @param Statement Pointer of the Statement
253 IN OUT FORM_BROWSER_STATEMENT
*Statement
257 QUESTION_DEFAULT
*Default
;
258 QUESTION_OPTION
*Option
;
261 // Free Default value List
263 while (!IsListEmpty (&Statement
->DefaultListHead
)) {
264 Link
= GetFirstNode (&Statement
->DefaultListHead
);
265 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
266 RemoveEntryList (&Default
->Link
);
268 gBS
->FreePool (Default
);
274 while (!IsListEmpty (&Statement
->OptionListHead
)) {
275 Link
= GetFirstNode (&Statement
->OptionListHead
);
276 Option
= QUESTION_OPTION_FROM_LINK (Link
);
277 RemoveEntryList (&Option
->Link
);
279 gBS
->FreePool (Option
);
287 Free resources of a Form
289 @param Form Pointer of the Form
296 IN OUT FORM_BROWSER_FORM
*Form
300 FORM_BROWSER_STATEMENT
*Statement
;
303 // Free Statements/Questions
305 while (!IsListEmpty (&Form
->StatementListHead
)) {
306 Link
= GetFirstNode (&Form
->StatementListHead
);
307 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
308 RemoveEntryList (&Statement
->Link
);
310 DestroyStatement (Statement
);
316 gBS
->FreePool (Form
);
321 Free resources allocated for a FormSet
323 @param FormSet Pointer of the FormSet
330 IN OUT FORM_BROWSER_FORMSET
*FormSet
334 FORMSET_STORAGE
*Storage
;
335 FORMSET_DEFAULTSTORE
*DefaultStore
;
336 FORM_BROWSER_FORM
*Form
;
339 // Free IFR binary buffer
341 FreePool (FormSet
->IfrBinaryData
);
344 // Free FormSet Storage
346 if (FormSet
->StorageListHead
.ForwardLink
!= NULL
) {
347 while (!IsListEmpty (&FormSet
->StorageListHead
)) {
348 Link
= GetFirstNode (&FormSet
->StorageListHead
);
349 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
350 RemoveEntryList (&Storage
->Link
);
352 DestroyStorage (Storage
);
357 // Free FormSet Default Store
359 if (FormSet
->DefaultStoreListHead
.ForwardLink
!= NULL
) {
360 while (!IsListEmpty (&FormSet
->DefaultStoreListHead
)) {
361 Link
= GetFirstNode (&FormSet
->DefaultStoreListHead
);
362 DefaultStore
= FORMSET_DEFAULTSTORE_FROM_LINK (Link
);
363 RemoveEntryList (&DefaultStore
->Link
);
365 gBS
->FreePool (DefaultStore
);
372 if (FormSet
->FormListHead
.ForwardLink
!= NULL
) {
373 while (!IsListEmpty (&FormSet
->FormListHead
)) {
374 Link
= GetFirstNode (&FormSet
->FormListHead
);
375 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
376 RemoveEntryList (&Form
->Link
);
382 if (FormSet
->StatementBuffer
!= NULL
) {
383 FreePool (FormSet
->StatementBuffer
);
386 DestoryOneOfOptionMap (&FormSet
->OneOfOptionMapListHead
);
388 if (FormSet
->OriginalDefaultVarStoreName
!= NULL
) {
389 FreePool (FormSet
->OriginalDefaultVarStoreName
);
397 Tell whether this Operand is an Expression OpCode or not
399 @param Operand Operand of an IFR OpCode.
401 @retval TRUE This is an Expression OpCode.
402 @retval FALSE Not an Expression OpCode.
410 if (((Operand
>= EFI_IFR_EQ_ID_VAL_OP
) && (Operand
<= EFI_IFR_NOT_OP
)) ||
411 ((Operand
>= EFI_IFR_MATCH_OP
) && (Operand
<= EFI_IFR_SET_OP
)) ||
412 ((Operand
>= EFI_IFR_EQUAL_OP
) && (Operand
<= EFI_IFR_SPAN_OP
)) ||
413 (Operand
== EFI_IFR_CATENATE_OP
) ||
414 (Operand
== EFI_IFR_TO_LOWER_OP
) ||
415 (Operand
== EFI_IFR_TO_UPPER_OP
) ||
416 (Operand
== EFI_IFR_MAP_OP
) ||
417 (Operand
== EFI_IFR_VERSION_OP
) ||
418 (Operand
== EFI_IFR_SECURITY_OP
)) {
427 Calculate number of Statemens(Questions) and Expression OpCodes.
429 @param FormSet The FormSet to be counted.
430 @param NumberOfStatement Number of Statemens(Questions)
431 @param NumberOfExpression Number of Expression OpCodes
438 IN FORM_BROWSER_FORMSET
*FormSet
,
439 IN OUT UINT16
*NumberOfStatement
,
440 IN OUT UINT16
*NumberOfExpression
443 UINT16 StatementCount
;
444 UINT16 ExpressionCount
;
453 while (Offset
< FormSet
->IfrBinaryLength
) {
454 OpCodeData
= FormSet
->IfrBinaryData
+ Offset
;
455 OpCodeLen
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
458 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
)) {
465 *NumberOfStatement
= StatementCount
;
466 *NumberOfExpression
= ExpressionCount
;
471 Parse opcodes in the formset IFR binary.
473 @param FormSet Pointer of the FormSet data structure.
475 @retval EFI_SUCCESS Opcode parse success.
476 @retval Other Opcode parse fail.
481 IN FORM_BROWSER_FORMSET
*FormSet
486 FORM_BROWSER_FORM
*CurrentForm
;
487 FORM_BROWSER_STATEMENT
*CurrentStatement
;
494 FORMSET_STORAGE
*Storage
;
495 FORMSET_DEFAULTSTORE
*DefaultStore
;
496 QUESTION_DEFAULT
*CurrentDefault
;
497 QUESTION_OPTION
*CurrentOption
;
499 UINT16 NumberOfStatement
;
500 UINT16 NumberOfExpression
;
501 EFI_IMAGE_ID
*ImageId
;
502 EFI_HII_VALUE
*Value
;
503 LIST_ENTRY
*OneOfOptinMapEntryListHead
;
504 EFI_IFR_GUID_OPTIONKEY
*OptionMap
;
505 ONE_OF_OPTION_MAP
*OneOfOptionMap
;
506 ONE_OF_OPTION_MAP_ENTRY
*OneOfOptionMapEntry
;
508 EFI_IFR_ONE_OF
*OneOfOpcode
;
509 HII_THUNK_CONTEXT
*ThunkContext
;
510 EFI_IFR_FORM_MAP_METHOD
*MapMethod
;
512 mInScopeSubtitle
= FALSE
;
513 mInScopeSuppress
= FALSE
;
514 mInScopeGrayOut
= FALSE
;
515 CurrentDefault
= NULL
;
516 CurrentOption
= NULL
;
518 ThunkContext
= UefiHiiHandleToThunkContext ((CONST HII_THUNK_PRIVATE_DATA
*) mHiiThunkPrivateData
, FormSet
->HiiHandle
);
521 // Set to a invalid value.
523 OneOfType
= (UINT8
) -1;
526 // Get the number of Statements and Expressions
528 CountOpCodes (FormSet
, &NumberOfStatement
, &NumberOfExpression
);
529 FormSet
->NumberOfStatement
= NumberOfStatement
;
532 FormSet
->StatementBuffer
= AllocateZeroPool (NumberOfStatement
* sizeof (FORM_BROWSER_STATEMENT
));
533 if (FormSet
->StatementBuffer
== NULL
) {
534 return EFI_OUT_OF_RESOURCES
;
537 InitializeListHead (&FormSet
->StorageListHead
);
538 InitializeListHead (&FormSet
->DefaultStoreListHead
);
539 InitializeListHead (&FormSet
->FormListHead
);
540 InitializeListHead (&FormSet
->OneOfOptionMapListHead
);
543 CurrentStatement
= NULL
;
548 while (OpCodeOffset
< FormSet
->IfrBinaryLength
) {
549 OpCodeData
= FormSet
->IfrBinaryData
+ OpCodeOffset
;
551 OpCodeLength
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
552 OpCodeOffset
+= OpCodeLength
;
553 Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
554 Scope
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Scope
;
557 // If scope bit set, push onto scope stack
563 if (IsExpressionOpCode (Operand
)) {
572 case EFI_IFR_FORM_SET_OP
:
574 // check the formset GUID
576 if (!CompareGuid ((EFI_GUID
*)(VOID
*)&FormSet
->Guid
, (EFI_GUID
*)(VOID
*)&((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
)) {
577 return EFI_INVALID_PARAMETER
;
580 CopyMem (&FormSet
->FormSetTitle
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->FormSetTitle
, sizeof (EFI_STRING_ID
));
581 CopyMem (&FormSet
->Help
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Help
, sizeof (EFI_STRING_ID
));
584 case EFI_IFR_FORM_OP
:
586 // Create a new Form for this FormSet
588 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
589 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
591 InitializeListHead (&CurrentForm
->StatementListHead
);
593 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
594 CopyMem (&CurrentForm
->FormTitle
, &((EFI_IFR_FORM
*) OpCodeData
)->FormTitle
, sizeof (EFI_STRING_ID
));
597 // Insert into Form list of this FormSet
599 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
602 case EFI_IFR_FORM_MAP_OP
:
604 // Create a new Form Map for this FormSet
606 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
607 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
609 InitializeListHead (&CurrentForm
->StatementListHead
);
611 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
612 MapMethod
= (EFI_IFR_FORM_MAP_METHOD
*) (OpCodeData
+ sizeof (EFI_IFR_FORM_MAP
));
615 // FormMap Form must contain at least one Map Method.
617 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
< ((UINTN
) (UINT8
*) (MapMethod
+ 1) - (UINTN
) OpCodeData
)) {
618 return EFI_INVALID_PARAMETER
;
622 // Try to find the standard form map method.
624 while (((UINTN
) (UINT8
*) MapMethod
- (UINTN
) OpCodeData
) < ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
) {
625 if (CompareGuid ((EFI_GUID
*) (VOID
*) &MapMethod
->MethodIdentifier
, &gEfiHiiStandardFormGuid
)) {
626 CopyMem (&CurrentForm
->FormTitle
, &MapMethod
->MethodTitle
, sizeof (EFI_STRING_ID
));
632 // If the standard form map method is not found, the first map method title will be used.
634 if (CurrentForm
->FormTitle
== 0) {
635 MapMethod
= (EFI_IFR_FORM_MAP_METHOD
*) (OpCodeData
+ sizeof (EFI_IFR_FORM_MAP
));
636 CopyMem (&CurrentForm
->FormTitle
, &MapMethod
->MethodTitle
, sizeof (EFI_STRING_ID
));
640 // Insert into Form list of this FormSet
642 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
648 case EFI_IFR_VARSTORE_OP
:
650 // Create a buffer Storage for this FormSet
652 Storage
= CreateStorage (FormSet
);
653 Storage
->Type
= EFI_HII_VARSTORE_BUFFER
;
655 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
656 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
657 CopyMem (&Storage
->Size
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Size
, sizeof (UINT16
));
659 AsciiString
= (CHAR8
*) ((EFI_IFR_VARSTORE
*) OpCodeData
)->Name
;
660 Storage
->Name
= AllocateZeroPool (AsciiStrSize (AsciiString
) * 2);
661 ASSERT (Storage
->Name
!= NULL
);
662 for (Index
= 0; AsciiString
[Index
] != 0; Index
++) {
663 Storage
->Name
[Index
] = (CHAR16
) AsciiString
[Index
];
668 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
670 // Framework IFR doesn't support Name/Value VarStore opcode
672 if (ThunkContext
!= NULL
&& ThunkContext
->ByFrameworkHiiNewPack
) {
677 // Create a name/value Storage for this FormSet
679 Storage
= CreateStorage (FormSet
);
680 Storage
->Type
= EFI_HII_VARSTORE_NAME_VALUE
;
682 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
683 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE_NAME_VALUE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
687 case EFI_IFR_VARSTORE_EFI_OP
:
689 // Create a EFI variable Storage for this FormSet
691 Storage
= CreateStorage (FormSet
);
692 Storage
->Type
= EFI_HII_VARSTORE_EFI_VARIABLE
;
694 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
695 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
696 CopyMem (&Storage
->Attributes
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Attributes
, sizeof (UINT32
));
702 case EFI_IFR_DEFAULTSTORE_OP
:
703 DefaultStore
= AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE
));
704 DefaultStore
->Signature
= FORMSET_DEFAULTSTORE_SIGNATURE
;
706 CopyMem (&DefaultStore
->DefaultId
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
707 CopyMem (&DefaultStore
->DefaultName
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultName
, sizeof (EFI_STRING_ID
));
710 // Insert to DefaultStore list of this Formset
712 InsertTailList (&FormSet
->DefaultStoreListHead
, &DefaultStore
->Link
);
718 case EFI_IFR_SUBTITLE_OP
:
719 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
720 ASSERT (CurrentStatement
!= NULL
);
721 CurrentStatement
->Flags
= ((EFI_IFR_SUBTITLE
*) OpCodeData
)->Flags
;
724 mInScopeSubtitle
= TRUE
;
728 case EFI_IFR_TEXT_OP
:
729 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
730 ASSERT (CurrentStatement
!= NULL
);
732 CopyMem (&CurrentStatement
->TextTwo
, &((EFI_IFR_TEXT
*) OpCodeData
)->TextTwo
, sizeof (EFI_STRING_ID
));
738 case EFI_IFR_ACTION_OP
:
739 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
740 ASSERT (CurrentStatement
!= NULL
);
742 if (OpCodeLength
== sizeof (EFI_IFR_ACTION_1
)) {
744 // No QuestionConfig present, so no configuration string will be processed
746 CurrentStatement
->QuestionConfig
= 0;
748 CopyMem (&CurrentStatement
->QuestionConfig
, &((EFI_IFR_ACTION
*) OpCodeData
)->QuestionConfig
, sizeof (EFI_STRING_ID
));
752 case EFI_IFR_RESET_BUTTON_OP
:
753 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
754 ASSERT (CurrentStatement
!= NULL
);
755 CopyMem (&CurrentStatement
->DefaultId
, &((EFI_IFR_RESET_BUTTON
*) OpCodeData
)->DefaultId
, sizeof (EFI_DEFAULT_ID
));
759 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
760 ASSERT (CurrentStatement
!= NULL
);
762 CopyMem (&CurrentStatement
->RefFormId
, &((EFI_IFR_REF
*) OpCodeData
)->FormId
, sizeof (EFI_FORM_ID
));
763 if (OpCodeLength
>= sizeof (EFI_IFR_REF2
)) {
764 CopyMem (&CurrentStatement
->RefQuestionId
, &((EFI_IFR_REF2
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
766 if (OpCodeLength
>= sizeof (EFI_IFR_REF3
)) {
767 CopyMem (&CurrentStatement
->RefFormSetId
, &((EFI_IFR_REF3
*) OpCodeData
)->FormSetId
, sizeof (EFI_GUID
));
769 if (OpCodeLength
>= sizeof (EFI_IFR_REF4
)) {
770 CopyMem (&CurrentStatement
->RefDevicePath
, &((EFI_IFR_REF4
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
776 case EFI_IFR_ONE_OF_OP
:
777 case EFI_IFR_NUMERIC_OP
:
778 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
779 ASSERT (CurrentStatement
!= NULL
);
781 CurrentStatement
->Flags
= ((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
;
782 Value
= &CurrentStatement
->HiiValue
;
784 switch (CurrentStatement
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
785 case EFI_IFR_NUMERIC_SIZE_1
:
786 CurrentStatement
->Minimum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MinValue
;
787 CurrentStatement
->Maximum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MaxValue
;
788 CurrentStatement
->Step
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.Step
;
789 CurrentStatement
->StorageWidth
= sizeof (UINT8
);
790 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
793 case EFI_IFR_NUMERIC_SIZE_2
:
794 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MinValue
, sizeof (UINT16
));
795 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MaxValue
, sizeof (UINT16
));
796 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.Step
, sizeof (UINT16
));
797 CurrentStatement
->StorageWidth
= sizeof (UINT16
);
798 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
801 case EFI_IFR_NUMERIC_SIZE_4
:
802 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MinValue
, sizeof (UINT32
));
803 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MaxValue
, sizeof (UINT32
));
804 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.Step
, sizeof (UINT32
));
805 CurrentStatement
->StorageWidth
= sizeof (UINT32
);
806 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
809 case EFI_IFR_NUMERIC_SIZE_8
:
810 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MinValue
, sizeof (UINT64
));
811 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MaxValue
, sizeof (UINT64
));
812 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.Step
, sizeof (UINT64
));
813 CurrentStatement
->StorageWidth
= sizeof (UINT64
);
814 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
821 if (Operand
== EFI_IFR_ONE_OF_OP
) {
822 OneOfOpcode
= (EFI_IFR_ONE_OF
*) OpCodeData
;
823 OneOfType
= (UINT8
) (OneOfOpcode
->Flags
& EFI_IFR_NUMERIC_SIZE
);
827 case EFI_IFR_ORDERED_LIST_OP
:
828 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
829 ASSERT (CurrentStatement
!= NULL
);
831 CurrentStatement
->Flags
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Flags
;
832 CurrentStatement
->MaxContainers
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
833 CurrentStatement
->StorageWidth
= (UINT16
)(CurrentStatement
->MaxContainers
* sizeof (UINT8
));
836 // No buffer type is defined in EFI_IFR_TYPE_VALUE, so a Configuration Driver
837 // has to use FormBrowser2.Callback() to retrieve the uncommited data for
838 // an interactive orderedlist (i.e. with EFI_IFR_FLAG_CALLBACK flag set).
840 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_OTHER
;
841 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
845 case EFI_IFR_CHECKBOX_OP
:
846 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
847 ASSERT (CurrentStatement
!= NULL
);
849 CurrentStatement
->Flags
= ((EFI_IFR_CHECKBOX
*) OpCodeData
)->Flags
;
850 CurrentStatement
->StorageWidth
= sizeof (BOOLEAN
);
851 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_BOOLEAN
;
855 case EFI_IFR_STRING_OP
:
856 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
857 ASSERT (CurrentStatement
!= NULL
);
860 // MinSize is the minimum number of characters that can be accepted for this opcode,
861 // MaxSize is the maximum number of characters that can be accepted for this opcode.
862 // The characters are stored as Unicode, so the storage width should multiply 2.
864 CurrentStatement
->Minimum
= ((EFI_IFR_STRING
*) OpCodeData
)->MinSize
;
865 CurrentStatement
->Maximum
= ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
;
866 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (UINT16
));
867 CurrentStatement
->Flags
= ((EFI_IFR_STRING
*) OpCodeData
)->Flags
;
869 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
870 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
874 case EFI_IFR_PASSWORD_OP
:
875 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
876 ASSERT (CurrentStatement
!= NULL
);
879 // MinSize is the minimum number of characters that can be accepted for this opcode,
880 // MaxSize is the maximum number of characters that can be accepted for this opcode.
881 // The characters are stored as Unicode, so the storage width should multiply 2.
883 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MinSize
, sizeof (UINT16
));
884 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MaxSize
, sizeof (UINT16
));
885 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (UINT16
));
887 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
888 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
892 case EFI_IFR_DATE_OP
:
893 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
894 ASSERT (CurrentStatement
!= NULL
);
896 CurrentStatement
->Flags
= ((EFI_IFR_DATE
*) OpCodeData
)->Flags
;
897 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_DATE
;
901 case EFI_IFR_TIME_OP
:
902 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
903 ASSERT (CurrentStatement
!= NULL
);
905 CurrentStatement
->Flags
= ((EFI_IFR_TIME
*) OpCodeData
)->Flags
;
906 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_TIME
;
913 case EFI_IFR_DEFAULT_OP
:
915 // EFI_IFR_DEFAULT appear in scope of a Question,
916 // It creates a default value for the current question.
917 // A Question may have more than one Default value which have different default types.
919 CurrentDefault
= AllocateZeroPool (sizeof (QUESTION_DEFAULT
));
920 CurrentDefault
->Signature
= QUESTION_DEFAULT_SIGNATURE
;
922 CurrentDefault
->Value
.Type
= ((EFI_IFR_DEFAULT
*) OpCodeData
)->Type
;
923 CopyMem (&CurrentDefault
->DefaultId
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
924 CopyMem (&CurrentDefault
->Value
.Value
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
925 ExtendValueToU64 (&CurrentDefault
->Value
);
928 // Insert to Default Value list of current Question
930 InsertTailList (&CurrentStatement
->DefaultListHead
, &CurrentDefault
->Link
);
937 case EFI_IFR_ONE_OF_OPTION_OP
:
939 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
940 // It create a selection for use in current Question.
942 CurrentOption
= AllocateZeroPool (sizeof (QUESTION_OPTION
));
943 CurrentOption
->Signature
= QUESTION_OPTION_SIGNATURE
;
945 CurrentOption
->Flags
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Flags
;
946 CurrentOption
->Value
.Type
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Type
;
947 CopyMem (&CurrentOption
->Text
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Option
, sizeof (EFI_STRING_ID
));
948 CopyMem (&CurrentOption
->Value
.Value
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
949 ExtendValueToU64 (&CurrentOption
->Value
);
952 // Insert to Option list of current Question
954 InsertTailList (&CurrentStatement
->OptionListHead
, &CurrentOption
->Link
);
960 case EFI_IFR_NO_SUBMIT_IF_OP
:
961 case EFI_IFR_INCONSISTENT_IF_OP
:
964 case EFI_IFR_SUPPRESS_IF_OP
:
967 case EFI_IFR_GRAY_OUT_IF_OP
:
970 case EFI_IFR_DISABLE_IF_OP
:
972 // Framework IFR doesn't support DisableIf opcode
974 if (ThunkContext
!= NULL
&& ThunkContext
->ByFrameworkHiiNewPack
) {
981 case EFI_IFR_VALUE_OP
:
982 case EFI_IFR_READ_OP
:
983 case EFI_IFR_WRITE_OP
:
986 case EFI_IFR_RULE_OP
:
992 case EFI_IFR_IMAGE_OP
:
994 // Get ScopeOpcode from top of stack
996 PopScope (&ScopeOpCode
);
997 PushScope (ScopeOpCode
);
999 switch (ScopeOpCode
) {
1000 case EFI_IFR_FORM_SET_OP
:
1001 ImageId
= &FormSet
->ImageId
;
1004 case EFI_IFR_FORM_OP
:
1005 case EFI_IFR_FORM_MAP_OP
:
1006 ImageId
= &CurrentForm
->ImageId
;
1009 case EFI_IFR_ONE_OF_OPTION_OP
:
1010 ImageId
= &CurrentOption
->ImageId
;
1015 // Make sure CurrentStatement is not NULL.
1016 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1017 // file is wrongly generated by tools such as VFR Compiler.
1019 ASSERT (CurrentStatement
!= NULL
);
1020 ImageId
= &CurrentStatement
->ImageId
;
1024 ASSERT (ImageId
!= NULL
);
1025 CopyMem (ImageId
, &((EFI_IFR_IMAGE
*) OpCodeData
)->Id
, sizeof (EFI_IMAGE_ID
));
1031 case EFI_IFR_REFRESH_OP
:
1032 ASSERT (CurrentStatement
!= NULL
);
1033 CurrentStatement
->RefreshInterval
= ((EFI_IFR_REFRESH
*) OpCodeData
)->RefreshInterval
;
1039 case EFI_IFR_GUID_OP
:
1040 OptionMap
= (EFI_IFR_GUID_OPTIONKEY
*) OpCodeData
;
1042 if (CompareGuid (&mTianoHiiIfrGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
1044 // Tiano specific GUIDed opcodes
1046 switch (((EFI_IFR_GUID_LABEL
*) OpCodeData
)->ExtendOpCode
) {
1047 case EFI_IFR_EXTEND_OP_LABEL
:
1049 // just ignore label
1054 case EFI_IFR_EXTEND_OP_CLASS
:
1055 CopyMem (&FormSet
->Class
, &((EFI_IFR_GUID_CLASS
*) OpCodeData
)->Class
, sizeof (UINT16
));
1058 case EFI_IFR_EXTEND_OP_SUBCLASS
:
1059 CopyMem (&FormSet
->SubClass
, &((EFI_IFR_GUID_SUBCLASS
*) OpCodeData
)->SubClass
, sizeof (UINT16
));
1065 } else if (CompareGuid ((EFI_GUID
*)(VOID
*)&OptionMap
->Guid
, &mFrameworkHiiCompatibilityGuid
)) {
1066 if (OptionMap
->ExtendOpCode
== EFI_IFR_EXTEND_OP_OPTIONKEY
) {
1067 OneOfOptinMapEntryListHead
= GetOneOfOptionMapEntryListHead (FormSet
, OptionMap
->QuestionId
);
1068 if (OneOfOptinMapEntryListHead
== NULL
) {
1069 OneOfOptionMap
= AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP
));
1070 ASSERT (OneOfOptionMap
!= NULL
);
1072 OneOfOptionMap
->Signature
= ONE_OF_OPTION_MAP_SIGNATURE
;
1073 OneOfOptionMap
->QuestionId
= OptionMap
->QuestionId
;
1076 // Make sure OneOfType is initialized.
1078 ASSERT (OneOfType
!= (UINT8
) -1);
1079 OneOfOptionMap
->ValueType
= OneOfType
;
1080 InitializeListHead (&OneOfOptionMap
->OneOfOptionMapEntryListHead
);
1081 OneOfOptinMapEntryListHead
= &OneOfOptionMap
->OneOfOptionMapEntryListHead
;
1082 InsertTailList (&FormSet
->OneOfOptionMapListHead
, &OneOfOptionMap
->Link
);
1084 OneOfOptionMapEntry
= AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY
));
1085 ASSERT (OneOfOptionMapEntry
!= NULL
);
1087 OneOfOptionMapEntry
->Signature
= ONE_OF_OPTION_MAP_ENTRY_SIGNATURE
;
1088 OneOfOptionMapEntry
->FwKey
= OptionMap
->KeyValue
;
1089 CopyMem (&OneOfOptionMapEntry
->Value
, &OptionMap
->OptionValue
, sizeof (EFI_IFR_TYPE_VALUE
));
1091 InsertTailList (OneOfOptinMapEntryListHead
, &OneOfOptionMapEntry
->Link
);
1099 case EFI_IFR_END_OP
:
1100 Status
= PopScope (&ScopeOpCode
);
1101 if (EFI_ERROR (Status
)) {
1106 switch (ScopeOpCode
) {
1107 case EFI_IFR_FORM_SET_OP
:
1109 // End of FormSet, update FormSet IFR binary length
1110 // to stop parsing substantial OpCodes
1112 FormSet
->IfrBinaryLength
= OpCodeOffset
;
1115 case EFI_IFR_FORM_OP
:
1116 case EFI_IFR_FORM_MAP_OP
:
1123 case EFI_IFR_ONE_OF_OPTION_OP
:
1127 CurrentOption
= NULL
;
1130 case EFI_IFR_SUBTITLE_OP
:
1131 mInScopeSubtitle
= FALSE
;
1134 case EFI_IFR_NO_SUBMIT_IF_OP
:
1135 case EFI_IFR_INCONSISTENT_IF_OP
:
1137 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
1141 case EFI_IFR_GRAY_OUT_IF_OP
:
1142 mInScopeGrayOut
= FALSE
;
1146 if (IsExpressionOpCode (ScopeOpCode
)) {