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_SPAN_OP
)) ||
412 (Operand
== EFI_IFR_CATENATE_OP
)
422 Calculate number of Statemens(Questions) and Expression OpCodes.
424 @param FormSet The FormSet to be counted.
425 @param NumberOfStatement Number of Statemens(Questions)
426 @param NumberOfExpression Number of Expression OpCodes
433 IN FORM_BROWSER_FORMSET
*FormSet
,
434 IN OUT UINT16
*NumberOfStatement
,
435 IN OUT UINT16
*NumberOfExpression
438 UINT16 StatementCount
;
439 UINT16 ExpressionCount
;
448 while (Offset
< FormSet
->IfrBinaryLength
) {
449 OpCodeData
= FormSet
->IfrBinaryData
+ Offset
;
450 OpCodeLen
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
453 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
)) {
460 *NumberOfStatement
= StatementCount
;
461 *NumberOfExpression
= ExpressionCount
;
466 Parse opcodes in the formset IFR binary.
468 @param FormSet Pointer of the FormSet data structure.
470 @retval EFI_SUCCESS Opcode parse success.
471 @retval Other Opcode parse fail.
476 IN FORM_BROWSER_FORMSET
*FormSet
481 FORM_BROWSER_FORM
*CurrentForm
;
482 FORM_BROWSER_STATEMENT
*CurrentStatement
;
489 FORMSET_STORAGE
*Storage
;
490 FORMSET_DEFAULTSTORE
*DefaultStore
;
491 QUESTION_DEFAULT
*CurrentDefault
;
492 QUESTION_OPTION
*CurrentOption
;
494 UINT16 NumberOfStatement
;
495 UINT16 NumberOfExpression
;
496 EFI_IMAGE_ID
*ImageId
;
497 EFI_HII_VALUE
*Value
;
498 LIST_ENTRY
*OneOfOptinMapEntryListHead
;
499 EFI_IFR_GUID_OPTIONKEY
*OptionMap
;
500 ONE_OF_OPTION_MAP
*OneOfOptionMap
;
501 ONE_OF_OPTION_MAP_ENTRY
*OneOfOptionMapEntry
;
503 EFI_IFR_ONE_OF
*OneOfOpcode
;
504 HII_THUNK_CONTEXT
*ThunkContext
;
506 mInScopeSubtitle
= FALSE
;
507 mInScopeSuppress
= FALSE
;
508 mInScopeGrayOut
= FALSE
;
509 CurrentDefault
= NULL
;
510 CurrentOption
= NULL
;
511 ThunkContext
= UefiHiiHandleToThunkContext ((CONST HII_THUNK_PRIVATE_DATA
*) mHiiThunkPrivateData
, FormSet
->HiiHandle
);
514 // Set to a invalid value.
516 OneOfType
= (UINT8
) -1;
519 // Get the number of Statements and Expressions
521 CountOpCodes (FormSet
, &NumberOfStatement
, &NumberOfExpression
);
522 FormSet
->NumberOfStatement
= NumberOfStatement
;
525 FormSet
->StatementBuffer
= AllocateZeroPool (NumberOfStatement
* sizeof (FORM_BROWSER_STATEMENT
));
526 if (FormSet
->StatementBuffer
== NULL
) {
527 return EFI_OUT_OF_RESOURCES
;
530 InitializeListHead (&FormSet
->StorageListHead
);
531 InitializeListHead (&FormSet
->DefaultStoreListHead
);
532 InitializeListHead (&FormSet
->FormListHead
);
533 InitializeListHead (&FormSet
->OneOfOptionMapListHead
);
536 CurrentStatement
= NULL
;
541 while (OpCodeOffset
< FormSet
->IfrBinaryLength
) {
542 OpCodeData
= FormSet
->IfrBinaryData
+ OpCodeOffset
;
544 OpCodeLength
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
545 OpCodeOffset
+= OpCodeLength
;
546 Operand
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
;
547 Scope
= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Scope
;
550 // If scope bit set, push onto scope stack
556 if (IsExpressionOpCode (Operand
)) {
565 case EFI_IFR_FORM_SET_OP
:
567 // check the formset GUID
569 if (!CompareGuid ((EFI_GUID
*)(VOID
*)&FormSet
->Guid
, (EFI_GUID
*)(VOID
*)&((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
)) {
570 return EFI_INVALID_PARAMETER
;
573 CopyMem (&FormSet
->FormSetTitle
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->FormSetTitle
, sizeof (EFI_STRING_ID
));
574 CopyMem (&FormSet
->Help
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Help
, sizeof (EFI_STRING_ID
));
577 case EFI_IFR_FORM_OP
:
579 // Create a new Form for this FormSet
581 CurrentForm
= AllocateZeroPool (sizeof (FORM_BROWSER_FORM
));
582 CurrentForm
->Signature
= FORM_BROWSER_FORM_SIGNATURE
;
584 InitializeListHead (&CurrentForm
->StatementListHead
);
586 CopyMem (&CurrentForm
->FormId
, &((EFI_IFR_FORM
*) OpCodeData
)->FormId
, sizeof (UINT16
));
587 CopyMem (&CurrentForm
->FormTitle
, &((EFI_IFR_FORM
*) OpCodeData
)->FormTitle
, sizeof (EFI_STRING_ID
));
590 // Insert into Form list of this FormSet
592 InsertTailList (&FormSet
->FormListHead
, &CurrentForm
->Link
);
598 case EFI_IFR_VARSTORE_OP
:
600 // Create a buffer Storage for this FormSet
602 Storage
= CreateStorage (FormSet
);
603 Storage
->Type
= EFI_HII_VARSTORE_BUFFER
;
605 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
606 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
607 CopyMem (&Storage
->Size
, &((EFI_IFR_VARSTORE
*) OpCodeData
)->Size
, sizeof (UINT16
));
609 AsciiString
= (CHAR8
*) ((EFI_IFR_VARSTORE
*) OpCodeData
)->Name
;
610 Storage
->Name
= AllocateZeroPool (AsciiStrSize (AsciiString
) * 2);
611 ASSERT (Storage
->Name
!= NULL
);
612 for (Index
= 0; AsciiString
[Index
] != 0; Index
++) {
613 Storage
->Name
[Index
] = (CHAR16
) AsciiString
[Index
];
618 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
620 // Framework IFR doesn't support Name/Value VarStore opcode
622 if (ThunkContext
!= NULL
&& ThunkContext
->ByFrameworkHiiNewPack
) {
627 case EFI_IFR_VARSTORE_EFI_OP
:
629 // Create a EFI variable Storage for this FormSet
631 Storage
= CreateStorage (FormSet
);
632 Storage
->Type
= EFI_HII_VARSTORE_EFI_VARIABLE
;
634 CopyMem (&Storage
->VarStoreId
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->VarStoreId
, sizeof (EFI_VARSTORE_ID
));
635 CopyMem (&Storage
->Guid
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
636 CopyMem (&Storage
->Attributes
, &((EFI_IFR_VARSTORE_EFI
*) OpCodeData
)->Attributes
, sizeof (UINT32
));
642 case EFI_IFR_DEFAULTSTORE_OP
:
643 DefaultStore
= AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE
));
644 DefaultStore
->Signature
= FORMSET_DEFAULTSTORE_SIGNATURE
;
646 CopyMem (&DefaultStore
->DefaultId
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
647 CopyMem (&DefaultStore
->DefaultName
, &((EFI_IFR_DEFAULTSTORE
*) OpCodeData
)->DefaultName
, sizeof (EFI_STRING_ID
));
650 // Insert to DefaultStore list of this Formset
652 InsertTailList (&FormSet
->DefaultStoreListHead
, &DefaultStore
->Link
);
658 case EFI_IFR_SUBTITLE_OP
:
659 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
660 CurrentStatement
->Flags
= ((EFI_IFR_SUBTITLE
*) OpCodeData
)->Flags
;
663 mInScopeSubtitle
= TRUE
;
667 case EFI_IFR_TEXT_OP
:
668 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
670 CopyMem (&CurrentStatement
->TextTwo
, &((EFI_IFR_TEXT
*) OpCodeData
)->TextTwo
, sizeof (EFI_STRING_ID
));
676 case EFI_IFR_ACTION_OP
:
677 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
679 if (OpCodeLength
== sizeof (EFI_IFR_ACTION_1
)) {
681 // No QuestionConfig present, so no configuration string will be processed
683 CurrentStatement
->QuestionConfig
= 0;
685 CopyMem (&CurrentStatement
->QuestionConfig
, &((EFI_IFR_ACTION
*) OpCodeData
)->QuestionConfig
, sizeof (EFI_STRING_ID
));
689 case EFI_IFR_RESET_BUTTON_OP
:
690 CurrentStatement
= CreateStatement (OpCodeData
, FormSet
, CurrentForm
);
691 CopyMem (&CurrentStatement
->DefaultId
, &((EFI_IFR_RESET_BUTTON
*) OpCodeData
)->DefaultId
, sizeof (EFI_DEFAULT_ID
));
695 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
697 CopyMem (&CurrentStatement
->RefFormId
, &((EFI_IFR_REF
*) OpCodeData
)->FormId
, sizeof (EFI_FORM_ID
));
698 if (OpCodeLength
>= sizeof (EFI_IFR_REF2
)) {
699 CopyMem (&CurrentStatement
->RefQuestionId
, &((EFI_IFR_REF2
*) OpCodeData
)->QuestionId
, sizeof (EFI_QUESTION_ID
));
701 if (OpCodeLength
>= sizeof (EFI_IFR_REF3
)) {
702 CopyMem (&CurrentStatement
->RefFormSetId
, &((EFI_IFR_REF3
*) OpCodeData
)->FormSetId
, sizeof (EFI_GUID
));
704 if (OpCodeLength
>= sizeof (EFI_IFR_REF4
)) {
705 CopyMem (&CurrentStatement
->RefDevicePath
, &((EFI_IFR_REF4
*) OpCodeData
)->DevicePath
, sizeof (EFI_STRING_ID
));
711 case EFI_IFR_ONE_OF_OP
:
712 case EFI_IFR_NUMERIC_OP
:
713 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
715 CurrentStatement
->Flags
= ((EFI_IFR_ONE_OF
*) OpCodeData
)->Flags
;
716 Value
= &CurrentStatement
->HiiValue
;
718 switch (CurrentStatement
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
719 case EFI_IFR_NUMERIC_SIZE_1
:
720 CurrentStatement
->Minimum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MinValue
;
721 CurrentStatement
->Maximum
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.MaxValue
;
722 CurrentStatement
->Step
= ((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u8
.Step
;
723 CurrentStatement
->StorageWidth
= sizeof (UINT8
);
724 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
727 case EFI_IFR_NUMERIC_SIZE_2
:
728 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MinValue
, sizeof (UINT16
));
729 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.MaxValue
, sizeof (UINT16
));
730 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u16
.Step
, sizeof (UINT16
));
731 CurrentStatement
->StorageWidth
= sizeof (UINT16
);
732 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
735 case EFI_IFR_NUMERIC_SIZE_4
:
736 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MinValue
, sizeof (UINT32
));
737 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.MaxValue
, sizeof (UINT32
));
738 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u32
.Step
, sizeof (UINT32
));
739 CurrentStatement
->StorageWidth
= sizeof (UINT32
);
740 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_32
;
743 case EFI_IFR_NUMERIC_SIZE_8
:
744 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MinValue
, sizeof (UINT64
));
745 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.MaxValue
, sizeof (UINT64
));
746 CopyMem (&CurrentStatement
->Step
, &((EFI_IFR_NUMERIC
*) OpCodeData
)->data
.u64
.Step
, sizeof (UINT64
));
747 CurrentStatement
->StorageWidth
= sizeof (UINT64
);
748 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
755 if (Operand
== EFI_IFR_ONE_OF_OP
) {
756 OneOfOpcode
= (EFI_IFR_ONE_OF
*) OpCodeData
;
757 OneOfType
= (UINT8
) (OneOfOpcode
->Flags
& EFI_IFR_NUMERIC_SIZE
);
761 case EFI_IFR_ORDERED_LIST_OP
:
762 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
764 CurrentStatement
->Flags
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->Flags
;
765 CurrentStatement
->MaxContainers
= ((EFI_IFR_ORDERED_LIST
*) OpCodeData
)->MaxContainers
;
766 CurrentStatement
->StorageWidth
= (UINT16
)(CurrentStatement
->MaxContainers
* sizeof (UINT8
));
769 // No buffer type is defined in EFI_IFR_TYPE_VALUE, so a Configuration Driver
770 // has to use FormBrowser2.Callback() to retrieve the uncommited data for
771 // an interactive orderedlist (i.e. with EFI_IFR_FLAG_CALLBACK flag set).
773 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_OTHER
;
774 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
778 case EFI_IFR_CHECKBOX_OP
:
779 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
781 CurrentStatement
->Flags
= ((EFI_IFR_CHECKBOX
*) OpCodeData
)->Flags
;
782 CurrentStatement
->StorageWidth
= sizeof (BOOLEAN
);
783 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_BOOLEAN
;
787 case EFI_IFR_STRING_OP
:
788 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
791 // MinSize is the minimum number of characters that can be accepted for this opcode,
792 // MaxSize is the maximum number of characters that can be accepted for this opcode.
793 // The characters are stored as Unicode, so the storage width should multiply 2.
795 CurrentStatement
->Minimum
= ((EFI_IFR_STRING
*) OpCodeData
)->MinSize
;
796 CurrentStatement
->Maximum
= ((EFI_IFR_STRING
*) OpCodeData
)->MaxSize
;
797 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (UINT16
));
798 CurrentStatement
->Flags
= ((EFI_IFR_STRING
*) OpCodeData
)->Flags
;
800 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
801 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
805 case EFI_IFR_PASSWORD_OP
:
806 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
809 // MinSize is the minimum number of characters that can be accepted for this opcode,
810 // MaxSize is the maximum number of characters that can be accepted for this opcode.
811 // The characters are stored as Unicode, so the storage width should multiply 2.
813 CopyMem (&CurrentStatement
->Minimum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MinSize
, sizeof (UINT16
));
814 CopyMem (&CurrentStatement
->Maximum
, &((EFI_IFR_PASSWORD
*) OpCodeData
)->MaxSize
, sizeof (UINT16
));
815 CurrentStatement
->StorageWidth
= (UINT16
)((UINTN
) CurrentStatement
->Maximum
* sizeof (UINT16
));
817 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_STRING
;
818 CurrentStatement
->BufferValue
= AllocateZeroPool (CurrentStatement
->StorageWidth
);
822 case EFI_IFR_DATE_OP
:
823 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
825 CurrentStatement
->Flags
= ((EFI_IFR_DATE
*) OpCodeData
)->Flags
;
826 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_DATE
;
830 case EFI_IFR_TIME_OP
:
831 CurrentStatement
= CreateQuestion (OpCodeData
, FormSet
, CurrentForm
);
833 CurrentStatement
->Flags
= ((EFI_IFR_TIME
*) OpCodeData
)->Flags
;
834 CurrentStatement
->HiiValue
.Type
= EFI_IFR_TYPE_TIME
;
841 case EFI_IFR_DEFAULT_OP
:
843 // EFI_IFR_DEFAULT appear in scope of a Question,
844 // It creates a default value for the current question.
845 // A Question may have more than one Default value which have different default types.
847 CurrentDefault
= AllocateZeroPool (sizeof (QUESTION_DEFAULT
));
848 CurrentDefault
->Signature
= QUESTION_DEFAULT_SIGNATURE
;
850 CurrentDefault
->Value
.Type
= ((EFI_IFR_DEFAULT
*) OpCodeData
)->Type
;
851 CopyMem (&CurrentDefault
->DefaultId
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->DefaultId
, sizeof (UINT16
));
852 CopyMem (&CurrentDefault
->Value
.Value
, &((EFI_IFR_DEFAULT
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
853 ExtendValueToU64 (&CurrentDefault
->Value
);
856 // Insert to Default Value list of current Question
858 InsertTailList (&CurrentStatement
->DefaultListHead
, &CurrentDefault
->Link
);
865 case EFI_IFR_ONE_OF_OPTION_OP
:
867 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
868 // It create a selection for use in current Question.
870 CurrentOption
= AllocateZeroPool (sizeof (QUESTION_OPTION
));
871 CurrentOption
->Signature
= QUESTION_OPTION_SIGNATURE
;
873 CurrentOption
->Flags
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Flags
;
874 CurrentOption
->Value
.Type
= ((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Type
;
875 CopyMem (&CurrentOption
->Text
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Option
, sizeof (EFI_STRING_ID
));
876 CopyMem (&CurrentOption
->Value
.Value
, &((EFI_IFR_ONE_OF_OPTION
*) OpCodeData
)->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
877 ExtendValueToU64 (&CurrentOption
->Value
);
880 // Insert to Option list of current Question
882 InsertTailList (&CurrentStatement
->OptionListHead
, &CurrentOption
->Link
);
888 case EFI_IFR_NO_SUBMIT_IF_OP
:
889 case EFI_IFR_INCONSISTENT_IF_OP
:
892 case EFI_IFR_SUPPRESS_IF_OP
:
895 case EFI_IFR_GRAY_OUT_IF_OP
:
898 case EFI_IFR_DISABLE_IF_OP
:
900 // Framework IFR doesn't support DisableIf opcode
902 if (ThunkContext
!= NULL
&& ThunkContext
->ByFrameworkHiiNewPack
) {
909 case EFI_IFR_VALUE_OP
:
912 case EFI_IFR_RULE_OP
:
918 case EFI_IFR_IMAGE_OP
:
920 // Get ScopeOpcode from top of stack
922 PopScope (&ScopeOpCode
);
923 PushScope (ScopeOpCode
);
925 switch (ScopeOpCode
) {
926 case EFI_IFR_FORM_SET_OP
:
927 ImageId
= &FormSet
->ImageId
;
930 case EFI_IFR_FORM_OP
:
931 ImageId
= &CurrentForm
->ImageId
;
934 case EFI_IFR_ONE_OF_OPTION_OP
:
935 ImageId
= &CurrentOption
->ImageId
;
939 ImageId
= &CurrentStatement
->ImageId
;
943 CopyMem (ImageId
, &((EFI_IFR_IMAGE
*) OpCodeData
)->Id
, sizeof (EFI_IMAGE_ID
));
949 case EFI_IFR_REFRESH_OP
:
950 CurrentStatement
->RefreshInterval
= ((EFI_IFR_REFRESH
*) OpCodeData
)->RefreshInterval
;
956 case EFI_IFR_GUID_OP
:
957 OptionMap
= (EFI_IFR_GUID_OPTIONKEY
*) OpCodeData
;
959 if (CompareGuid (&mTianoHiiIfrGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
961 // Tiano specific GUIDed opcodes
963 switch (((EFI_IFR_GUID_LABEL
*) OpCodeData
)->ExtendOpCode
) {
964 case EFI_IFR_EXTEND_OP_LABEL
:
971 case EFI_IFR_EXTEND_OP_CLASS
:
972 CopyMem (&FormSet
->Class
, &((EFI_IFR_GUID_CLASS
*) OpCodeData
)->Class
, sizeof (UINT16
));
975 case EFI_IFR_EXTEND_OP_SUBCLASS
:
976 CopyMem (&FormSet
->SubClass
, &((EFI_IFR_GUID_SUBCLASS
*) OpCodeData
)->SubClass
, sizeof (UINT16
));
982 } else if (CompareGuid ((EFI_GUID
*)(VOID
*)&OptionMap
->Guid
, &mFrameworkHiiCompatibilityGuid
)) {
983 if (OptionMap
->ExtendOpCode
== EFI_IFR_EXTEND_OP_OPTIONKEY
) {
984 OneOfOptinMapEntryListHead
= GetOneOfOptionMapEntryListHead (FormSet
, OptionMap
->QuestionId
);
985 if (OneOfOptinMapEntryListHead
== NULL
) {
986 OneOfOptionMap
= AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP
));
987 ASSERT (OneOfOptionMap
!= NULL
);
989 OneOfOptionMap
->Signature
= ONE_OF_OPTION_MAP_SIGNATURE
;
990 OneOfOptionMap
->QuestionId
= OptionMap
->QuestionId
;
993 // Make sure OneOfType is initialized.
995 ASSERT (OneOfType
!= (UINT8
) -1);
996 OneOfOptionMap
->ValueType
= OneOfType
;
997 InitializeListHead (&OneOfOptionMap
->OneOfOptionMapEntryListHead
);
998 OneOfOptinMapEntryListHead
= &OneOfOptionMap
->OneOfOptionMapEntryListHead
;
999 InsertTailList (&FormSet
->OneOfOptionMapListHead
, &OneOfOptionMap
->Link
);
1001 OneOfOptionMapEntry
= AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY
));
1002 ASSERT (OneOfOptionMapEntry
!= NULL
);
1004 OneOfOptionMapEntry
->Signature
= ONE_OF_OPTION_MAP_ENTRY_SIGNATURE
;
1005 OneOfOptionMapEntry
->FwKey
= OptionMap
->KeyValue
;
1006 CopyMem (&OneOfOptionMapEntry
->Value
, &OptionMap
->OptionValue
, sizeof (EFI_IFR_TYPE_VALUE
));
1008 InsertTailList (OneOfOptinMapEntryListHead
, &OneOfOptionMapEntry
->Link
);
1016 case EFI_IFR_END_OP
:
1017 Status
= PopScope (&ScopeOpCode
);
1018 if (EFI_ERROR (Status
)) {
1023 switch (ScopeOpCode
) {
1024 case EFI_IFR_FORM_SET_OP
:
1026 // End of FormSet, update FormSet IFR binary length
1027 // to stop parsing substantial OpCodes
1029 FormSet
->IfrBinaryLength
= OpCodeOffset
;
1032 case EFI_IFR_FORM_OP
:
1039 case EFI_IFR_ONE_OF_OPTION_OP
:
1043 CurrentOption
= NULL
;
1046 case EFI_IFR_SUBTITLE_OP
:
1047 mInScopeSubtitle
= FALSE
;
1050 case EFI_IFR_NO_SUBMIT_IF_OP
:
1051 case EFI_IFR_INCONSISTENT_IF_OP
:
1053 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
1057 case EFI_IFR_GRAY_OUT_IF_OP
:
1058 mInScopeGrayOut
= FALSE
;
1062 if (IsExpressionOpCode (ScopeOpCode
)) {