]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add the missing check for NULL pointer before use it.
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / IfrParse.c
1 /** @file
2 Parser for IFR binary encoding.
3
4 Copyright (c) 2007 - 2010, 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
9
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.
12
13 **/
14
15 #include "Setup.h"
16
17 UINT16 mStatementIndex;
18 UINT16 mExpressionOpCodeIndex;
19
20 BOOLEAN mInScopeSubtitle;
21 BOOLEAN mInScopeSuppress;
22 BOOLEAN mInScopeGrayOut;
23 BOOLEAN mInScopeDisable;
24 FORM_EXPRESSION *mSuppressExpression;
25 FORM_EXPRESSION *mGrayOutExpression;
26 FORM_EXPRESSION *mDisableExpression;
27
28 /**
29 Initialize Statement header members.
30
31 @param OpCodeData Pointer of the raw OpCode data.
32 @param FormSet Pointer of the current FormSe.
33 @param Form Pointer of the current Form.
34
35 @return The Statement.
36
37 **/
38 FORM_BROWSER_STATEMENT *
39 CreateStatement (
40 IN UINT8 *OpCodeData,
41 IN OUT FORM_BROWSER_FORMSET *FormSet,
42 IN OUT FORM_BROWSER_FORM *Form
43 )
44 {
45 FORM_BROWSER_STATEMENT *Statement;
46 EFI_IFR_STATEMENT_HEADER *StatementHdr;
47
48 if (Form == NULL) {
49 //
50 // We are currently not in a Form Scope, so just skip this Statement
51 //
52 return NULL;
53 }
54
55 Statement = &FormSet->StatementBuffer[mStatementIndex];
56 mStatementIndex++;
57
58 InitializeListHead (&Statement->DefaultListHead);
59 InitializeListHead (&Statement->OptionListHead);
60 InitializeListHead (&Statement->InconsistentListHead);
61 InitializeListHead (&Statement->NoSubmitListHead);
62
63 Statement->Signature = FORM_BROWSER_STATEMENT_SIGNATURE;
64
65 Statement->Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;
66
67 StatementHdr = (EFI_IFR_STATEMENT_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));
68 CopyMem (&Statement->Prompt, &StatementHdr->Prompt, sizeof (EFI_STRING_ID));
69 CopyMem (&Statement->Help, &StatementHdr->Help, sizeof (EFI_STRING_ID));
70
71 if (mInScopeSuppress) {
72 Statement->SuppressExpression = mSuppressExpression;
73 }
74
75 if (mInScopeGrayOut) {
76 Statement->GrayOutExpression = mGrayOutExpression;
77 }
78
79
80 if (mInScopeDisable) {
81 Statement->DisableExpression = mDisableExpression;
82 }
83
84 Statement->InSubtitle = mInScopeSubtitle;
85
86 //
87 // Insert this Statement into current Form
88 //
89 InsertTailList (&Form->StatementListHead, &Statement->Link);
90
91 return Statement;
92 }
93
94 /**
95 Convert a numeric value to a Unicode String and insert it to String Package.
96 This string is used as the Unicode Name for the EFI Variable. This is to support
97 the deprecated vareqval opcode.
98
99 @param FormSet The FormSet.
100 @param Statement The numeric question whose VarStoreInfo.VarName is the
101 numeric value which is used to produce the Unicode Name
102 for the EFI Variable.
103
104 If the Statement is NULL, the ASSERT.
105 If the opcode is not Numeric, then ASSERT.
106
107 @retval EFI_SUCCESS The funtion always succeeds.
108 **/
109 EFI_STATUS
110 UpdateCheckBoxStringToken (
111 IN CONST FORM_BROWSER_FORMSET *FormSet,
112 IN FORM_BROWSER_STATEMENT *Statement
113 )
114 {
115 CHAR16 Str[MAXIMUM_VALUE_CHARACTERS];
116 EFI_STRING_ID Id;
117
118 ASSERT (Statement != NULL);
119 ASSERT (Statement->Operand == EFI_IFR_NUMERIC_OP);
120
121 UnicodeValueToString (Str, 0, Statement->VarStoreInfo.VarName, MAXIMUM_VALUE_CHARACTERS - 1);
122
123 Id = HiiSetString (FormSet->HiiHandle, 0, Str, NULL);
124 if (Id == 0) {
125 return EFI_OUT_OF_RESOURCES;
126 }
127
128 Statement->VarStoreInfo.VarName = Id;
129
130 return EFI_SUCCESS;
131 }
132
133 /**
134 Check if the next opcode is the EFI_IFR_EXTEND_OP_VAREQNAME.
135
136 @param OpCodeData The current opcode.
137
138 @retval TRUE Yes.
139 @retval FALSE No.
140 **/
141 BOOLEAN
142 IsNextOpCodeGuidedVarEqName (
143 IN UINT8 *OpCodeData
144 )
145 {
146 //
147 // Get next opcode
148 //
149 OpCodeData += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
150 if (*OpCodeData == EFI_IFR_GUID_OP) {
151 if (CompareGuid (&gEfiIfrFrameworkGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
152 //
153 // Specific GUIDed opcodes to support IFR generated from Framework HII VFR
154 //
155 if ((((EFI_IFR_GUID_VAREQNAME *) OpCodeData)->ExtendOpCode) == EFI_IFR_EXTEND_OP_VAREQNAME) {
156 return TRUE;
157 }
158 }
159 }
160
161 return FALSE;
162 }
163
164 /**
165 Initialize Question's members.
166
167 @param OpCodeData Pointer of the raw OpCode data.
168 @param FormSet Pointer of the current FormSet.
169 @param Form Pointer of the current Form.
170
171 @return The Question.
172
173 **/
174 FORM_BROWSER_STATEMENT *
175 CreateQuestion (
176 IN UINT8 *OpCodeData,
177 IN OUT FORM_BROWSER_FORMSET *FormSet,
178 IN OUT FORM_BROWSER_FORM *Form
179 )
180 {
181 FORM_BROWSER_STATEMENT *Statement;
182 EFI_IFR_QUESTION_HEADER *QuestionHdr;
183 LIST_ENTRY *Link;
184 FORMSET_STORAGE *Storage;
185 NAME_VALUE_NODE *NameValueNode;
186 EFI_STATUS Status;
187
188 Statement = CreateStatement (OpCodeData, FormSet, Form);
189 if (Statement == NULL) {
190 return NULL;
191 }
192
193 QuestionHdr = (EFI_IFR_QUESTION_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));
194 CopyMem (&Statement->QuestionId, &QuestionHdr->QuestionId, sizeof (EFI_QUESTION_ID));
195 CopyMem (&Statement->VarStoreId, &QuestionHdr->VarStoreId, sizeof (EFI_VARSTORE_ID));
196 CopyMem (&Statement->VarStoreInfo.VarOffset, &QuestionHdr->VarStoreInfo.VarOffset, sizeof (UINT16));
197
198 Statement->QuestionFlags = QuestionHdr->Flags;
199
200 if (Statement->VarStoreId == 0) {
201 //
202 // VarStoreId of zero indicates no variable storage
203 //
204 return Statement;
205 }
206
207 //
208 // Take a look at next OpCode to see whether it is a GUIDed opcode to support
209 // Framework Compatibility
210 //
211 if (FeaturePcdGet (PcdFrameworkCompatibilitySupport)) {
212 if ((*OpCodeData == EFI_IFR_NUMERIC_OP) && IsNextOpCodeGuidedVarEqName (OpCodeData)) {
213 Status = UpdateCheckBoxStringToken (FormSet, Statement);
214 if (EFI_ERROR (Status)) {
215 return NULL;
216 }
217 }
218 }
219
220 //
221 // Find Storage for this Question
222 //
223 Link = GetFirstNode (&FormSet->StorageListHead);
224 while (!IsNull (&FormSet->StorageListHead, Link)) {
225 Storage = FORMSET_STORAGE_FROM_LINK (Link);
226
227 if (Storage->VarStoreId == Statement->VarStoreId) {
228 Statement->Storage = Storage;
229 break;
230 }
231
232 Link = GetNextNode (&FormSet->StorageListHead, Link);
233 }
234 ASSERT (Statement->Storage != NULL);
235
236 //
237 // Initialilze varname for Name/Value or EFI Variable
238 //
239 if ((Statement->Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) ||
240 (Statement->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE)) {
241 Statement->VariableName = GetToken (Statement->VarStoreInfo.VarName, FormSet->HiiHandle);
242 ASSERT (Statement->VariableName != NULL);
243
244 if (Statement->Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
245 //
246 // Insert to Name/Value varstore list
247 //
248 NameValueNode = AllocateZeroPool (sizeof (NAME_VALUE_NODE));
249 ASSERT (NameValueNode != NULL);
250 NameValueNode->Signature = NAME_VALUE_NODE_SIGNATURE;
251 NameValueNode->Name = AllocateCopyPool (StrSize (Statement->VariableName), Statement->VariableName);
252 ASSERT (NameValueNode->Name != NULL);
253 NameValueNode->Value = AllocateZeroPool (0x10);
254 ASSERT (NameValueNode->Value != NULL);
255 NameValueNode->EditValue = AllocateZeroPool (0x10);
256 ASSERT (NameValueNode->EditValue != NULL);
257
258 InsertTailList (&Statement->Storage->NameValueListHead, &NameValueNode->Link);
259 }
260 }
261
262 return Statement;
263 }
264
265
266 /**
267 Allocate a FORM_EXPRESSION node.
268
269 @param Form The Form associated with this Expression
270
271 @return Pointer to a FORM_EXPRESSION data structure.
272
273 **/
274 FORM_EXPRESSION *
275 CreateExpression (
276 IN OUT FORM_BROWSER_FORM *Form
277 )
278 {
279 FORM_EXPRESSION *Expression;
280
281 Expression = AllocateZeroPool (sizeof (FORM_EXPRESSION));
282 ASSERT (Expression != NULL);
283 Expression->Signature = FORM_EXPRESSION_SIGNATURE;
284 InitializeListHead (&Expression->OpCodeListHead);
285
286 return Expression;
287 }
288
289
290 /**
291 Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.
292
293 @param FormSet Pointer of the current FormSet
294
295 @return Pointer to a FORMSET_STORAGE data structure.
296
297 **/
298 FORMSET_STORAGE *
299 CreateStorage (
300 IN FORM_BROWSER_FORMSET *FormSet
301 )
302 {
303 FORMSET_STORAGE *Storage;
304
305 Storage = AllocateZeroPool (sizeof (FORMSET_STORAGE));
306 ASSERT (Storage != NULL);
307 Storage->Signature = FORMSET_STORAGE_SIGNATURE;
308 InitializeListHead (&Storage->NameValueListHead);
309 InsertTailList (&FormSet->StorageListHead, &Storage->Link);
310
311 return Storage;
312 }
313
314
315 /**
316 Create ConfigHdr string for a storage.
317
318 @param FormSet Pointer of the current FormSet
319 @param Storage Pointer of the storage
320
321 @retval EFI_SUCCESS Initialize ConfigHdr success
322
323 **/
324 EFI_STATUS
325 InitializeConfigHdr (
326 IN FORM_BROWSER_FORMSET *FormSet,
327 IN OUT FORMSET_STORAGE *Storage
328 )
329 {
330 CHAR16 *Name;
331
332 if (Storage->Type == EFI_HII_VARSTORE_BUFFER) {
333 Name = Storage->Name;
334 } else {
335 Name = NULL;
336 }
337
338 Storage->ConfigHdr = HiiConstructConfigHdr (
339 &Storage->Guid,
340 Name,
341 FormSet->DriverHandle
342 );
343
344 if (Storage->ConfigHdr == NULL) {
345 return EFI_NOT_FOUND;
346 }
347
348 Storage->ConfigRequest = AllocateCopyPool (StrSize (Storage->ConfigHdr), Storage->ConfigHdr);
349 Storage->SpareStrLen = 0;
350
351 return EFI_SUCCESS;
352 }
353
354
355 /**
356 Initialize Request Element of a Question. <RequestElement> ::= '&'<BlockName> | '&'<Label>
357
358 @param FormSet Pointer of the current FormSet.
359 @param Question The Question to be initialized.
360
361 @retval EFI_SUCCESS Function success.
362 @retval EFI_INVALID_PARAMETER No storage associated with the Question.
363
364 **/
365 EFI_STATUS
366 InitializeRequestElement (
367 IN OUT FORM_BROWSER_FORMSET *FormSet,
368 IN OUT FORM_BROWSER_STATEMENT *Question
369 )
370 {
371 FORMSET_STORAGE *Storage;
372 UINTN StrLen;
373 UINTN StringSize;
374 CHAR16 *NewStr;
375 CHAR16 RequestElement[30];
376
377 Storage = Question->Storage;
378 if (Storage == NULL) {
379 return EFI_INVALID_PARAMETER;
380 }
381
382 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
383 //
384 // <ConfigRequest> is unnecessary for EFI variable storage,
385 // GetVariable()/SetVariable() will be used to retrieve/save values
386 //
387 return EFI_SUCCESS;
388 }
389
390 //
391 // Prepare <RequestElement>
392 //
393 if (Storage->Type == EFI_HII_VARSTORE_BUFFER) {
394 StrLen = UnicodeSPrint (
395 RequestElement,
396 30 * sizeof (CHAR16),
397 L"&OFFSET=%x&WIDTH=%x",
398 Question->VarStoreInfo.VarOffset,
399 Question->StorageWidth
400 );
401 Question->BlockName = AllocateCopyPool ((StrLen + 1) * sizeof (CHAR16), RequestElement);
402 } else {
403 StrLen = UnicodeSPrint (RequestElement, 30 * sizeof (CHAR16), L"&%s", Question->VariableName);
404 }
405
406 if ((Question->Operand == EFI_IFR_PASSWORD_OP) && ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK)) {
407 //
408 // Password with CALLBACK flag is stored in encoded format,
409 // so don't need to append it to <ConfigRequest>
410 //
411 return EFI_SUCCESS;
412 }
413
414 //
415 // Append <RequestElement> to <ConfigRequest>
416 //
417 if (StrLen > Storage->SpareStrLen) {
418 //
419 // Old String buffer is not sufficient for RequestElement, allocate a new one
420 //
421 StringSize = (Storage->ConfigRequest != NULL) ? StrSize (Storage->ConfigRequest) : sizeof (CHAR16);
422 NewStr = AllocateZeroPool (StringSize + CONFIG_REQUEST_STRING_INCREMENTAL * sizeof (CHAR16));
423 ASSERT (NewStr != NULL);
424 if (Storage->ConfigRequest != NULL) {
425 CopyMem (NewStr, Storage->ConfigRequest, StringSize);
426 FreePool (Storage->ConfigRequest);
427 }
428 Storage->ConfigRequest = NewStr;
429 Storage->SpareStrLen = CONFIG_REQUEST_STRING_INCREMENTAL;
430 }
431
432 StrCat (Storage->ConfigRequest, RequestElement);
433 Storage->ElementCount++;
434 Storage->SpareStrLen -= StrLen;
435
436 return EFI_SUCCESS;
437 }
438
439
440 /**
441 Free resources of a Expression.
442
443 @param FormSet Pointer of the Expression
444
445 **/
446 VOID
447 DestroyExpression (
448 IN FORM_EXPRESSION *Expression
449 )
450 {
451 LIST_ENTRY *Link;
452 EXPRESSION_OPCODE *OpCode;
453 LIST_ENTRY *SubExpressionLink;
454 FORM_EXPRESSION *SubExpression;
455
456 while (!IsListEmpty (&Expression->OpCodeListHead)) {
457 Link = GetFirstNode (&Expression->OpCodeListHead);
458 OpCode = EXPRESSION_OPCODE_FROM_LINK (Link);
459 RemoveEntryList (&OpCode->Link);
460
461 if (OpCode->ValueList != NULL) {
462 FreePool (OpCode->ValueList);
463 }
464
465 if (OpCode->ValueName != NULL) {
466 FreePool (OpCode->ValueName);
467 }
468
469 if (OpCode->MapExpressionList.ForwardLink != NULL) {
470 while (!IsListEmpty (&OpCode->MapExpressionList)) {
471 SubExpressionLink = GetFirstNode(&OpCode->MapExpressionList);
472 SubExpression = FORM_EXPRESSION_FROM_LINK (SubExpressionLink);
473 RemoveEntryList(&SubExpression->Link);
474 DestroyExpression (SubExpression);
475 }
476 }
477 }
478
479 //
480 // Free this Expression
481 //
482 FreePool (Expression);
483 }
484
485
486 /**
487 Free resources of a storage.
488
489 @param Storage Pointer of the storage
490
491 **/
492 VOID
493 DestroyStorage (
494 IN FORMSET_STORAGE *Storage
495 )
496 {
497 LIST_ENTRY *Link;
498 NAME_VALUE_NODE *NameValueNode;
499
500 if (Storage == NULL) {
501 return;
502 }
503
504 if (Storage->Name != NULL) {
505 FreePool (Storage->Name);
506 }
507 if (Storage->Buffer != NULL) {
508 FreePool (Storage->Buffer);
509 }
510 if (Storage->EditBuffer != NULL) {
511 FreePool (Storage->EditBuffer);
512 }
513
514 while (!IsListEmpty (&Storage->NameValueListHead)) {
515 Link = GetFirstNode (&Storage->NameValueListHead);
516 NameValueNode = NAME_VALUE_NODE_FROM_LINK (Link);
517 RemoveEntryList (&NameValueNode->Link);
518
519 if (NameValueNode->Name != NULL) {
520 FreePool (NameValueNode->Name);
521 }
522 if (NameValueNode->Value != NULL) {
523 FreePool (NameValueNode->Value);
524 }
525 if (NameValueNode->EditValue != NULL) {
526 FreePool (NameValueNode->EditValue);
527 }
528 FreePool (NameValueNode);
529 }
530
531 if (Storage->ConfigHdr != NULL) {
532 FreePool (Storage->ConfigHdr);
533 }
534 if (Storage->ConfigRequest != NULL) {
535 FreePool (Storage->ConfigRequest);
536 }
537
538 FreePool (Storage);
539 }
540
541
542 /**
543 Free resources of a Statement.
544
545 @param Statement Pointer of the Statement
546
547 **/
548 VOID
549 DestroyStatement (
550 IN OUT FORM_BROWSER_STATEMENT *Statement
551 )
552 {
553 LIST_ENTRY *Link;
554 QUESTION_DEFAULT *Default;
555 QUESTION_OPTION *Option;
556 FORM_EXPRESSION *Expression;
557
558 //
559 // Free Default value List
560 //
561 while (!IsListEmpty (&Statement->DefaultListHead)) {
562 Link = GetFirstNode (&Statement->DefaultListHead);
563 Default = QUESTION_DEFAULT_FROM_LINK (Link);
564 RemoveEntryList (&Default->Link);
565
566 FreePool (Default);
567 }
568
569 //
570 // Free Options List
571 //
572 while (!IsListEmpty (&Statement->OptionListHead)) {
573 Link = GetFirstNode (&Statement->OptionListHead);
574 Option = QUESTION_OPTION_FROM_LINK (Link);
575 RemoveEntryList (&Option->Link);
576
577 FreePool (Option);
578 }
579
580 //
581 // Free Inconsistent List
582 //
583 while (!IsListEmpty (&Statement->InconsistentListHead)) {
584 Link = GetFirstNode (&Statement->InconsistentListHead);
585 Expression = FORM_EXPRESSION_FROM_LINK (Link);
586 RemoveEntryList (&Expression->Link);
587
588 DestroyExpression (Expression);
589 }
590
591 //
592 // Free NoSubmit List
593 //
594 while (!IsListEmpty (&Statement->NoSubmitListHead)) {
595 Link = GetFirstNode (&Statement->NoSubmitListHead);
596 Expression = FORM_EXPRESSION_FROM_LINK (Link);
597 RemoveEntryList (&Expression->Link);
598
599 DestroyExpression (Expression);
600 }
601
602 if (Statement->VariableName != NULL) {
603 FreePool (Statement->VariableName);
604 }
605 if (Statement->BlockName != NULL) {
606 FreePool (Statement->BlockName);
607 }
608 if (Statement->BufferValue != NULL) {
609 FreePool (Statement->BufferValue);
610 }
611 }
612
613
614 /**
615 Free resources of a Form.
616
617 @param Form Pointer of the Form.
618
619 **/
620 VOID
621 DestroyForm (
622 IN OUT FORM_BROWSER_FORM *Form
623 )
624 {
625 LIST_ENTRY *Link;
626 FORM_EXPRESSION *Expression;
627 FORM_BROWSER_STATEMENT *Statement;
628
629 //
630 // Free Form Expressions
631 //
632 while (!IsListEmpty (&Form->ExpressionListHead)) {
633 Link = GetFirstNode (&Form->ExpressionListHead);
634 Expression = FORM_EXPRESSION_FROM_LINK (Link);
635 RemoveEntryList (&Expression->Link);
636
637 DestroyExpression (Expression);
638 }
639
640 //
641 // Free Statements/Questions
642 //
643 while (!IsListEmpty (&Form->StatementListHead)) {
644 Link = GetFirstNode (&Form->StatementListHead);
645 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
646 RemoveEntryList (&Statement->Link);
647
648 DestroyStatement (Statement);
649 }
650
651 //
652 // Free this Form
653 //
654 FreePool (Form);
655 }
656
657
658 /**
659 Free resources allocated for a FormSet.
660
661 @param FormSet Pointer of the FormSet
662
663 **/
664 VOID
665 DestroyFormSet (
666 IN OUT FORM_BROWSER_FORMSET *FormSet
667 )
668 {
669 LIST_ENTRY *Link;
670 FORMSET_STORAGE *Storage;
671 FORMSET_DEFAULTSTORE *DefaultStore;
672 FORM_EXPRESSION *Expression;
673 FORM_BROWSER_FORM *Form;
674
675 if (FormSet->IfrBinaryData == NULL) {
676 //
677 // Uninitialized FormSet
678 //
679 FreePool (FormSet);
680 return;
681 }
682
683 //
684 // Free IFR binary buffer
685 //
686 FreePool (FormSet->IfrBinaryData);
687
688 //
689 // Free FormSet Storage
690 //
691 if (FormSet->StorageListHead.ForwardLink != NULL) {
692 while (!IsListEmpty (&FormSet->StorageListHead)) {
693 Link = GetFirstNode (&FormSet->StorageListHead);
694 Storage = FORMSET_STORAGE_FROM_LINK (Link);
695 RemoveEntryList (&Storage->Link);
696
697 DestroyStorage (Storage);
698 }
699 }
700
701 //
702 // Free FormSet Default Store
703 //
704 if (FormSet->DefaultStoreListHead.ForwardLink != NULL) {
705 while (!IsListEmpty (&FormSet->DefaultStoreListHead)) {
706 Link = GetFirstNode (&FormSet->DefaultStoreListHead);
707 DefaultStore = FORMSET_DEFAULTSTORE_FROM_LINK (Link);
708 RemoveEntryList (&DefaultStore->Link);
709
710 FreePool (DefaultStore);
711 }
712 }
713
714 //
715 // Free Formset Expressions
716 //
717 while (!IsListEmpty (&FormSet->ExpressionListHead)) {
718 Link = GetFirstNode (&FormSet->ExpressionListHead);
719 Expression = FORM_EXPRESSION_FROM_LINK (Link);
720 RemoveEntryList (&Expression->Link);
721
722 DestroyExpression (Expression);
723 }
724
725 //
726 // Free Forms
727 //
728 if (FormSet->FormListHead.ForwardLink != NULL) {
729 while (!IsListEmpty (&FormSet->FormListHead)) {
730 Link = GetFirstNode (&FormSet->FormListHead);
731 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
732 RemoveEntryList (&Form->Link);
733
734 DestroyForm (Form);
735 }
736 }
737
738 if (FormSet->StatementBuffer != NULL) {
739 FreePool (FormSet->StatementBuffer);
740 }
741 if (FormSet->ExpressionBuffer != NULL) {
742 FreePool (FormSet->ExpressionBuffer);
743 }
744
745 FreePool (FormSet);
746 }
747
748
749 /**
750 Tell whether this Operand is an Expression OpCode or not
751
752 @param Operand Operand of an IFR OpCode.
753
754 @retval TRUE This is an Expression OpCode.
755 @retval FALSE Not an Expression OpCode.
756
757 **/
758 BOOLEAN
759 IsExpressionOpCode (
760 IN UINT8 Operand
761 )
762 {
763 if (((Operand >= EFI_IFR_EQ_ID_VAL_OP) && (Operand <= EFI_IFR_NOT_OP)) ||
764 ((Operand >= EFI_IFR_MATCH_OP) && (Operand <= EFI_IFR_SET_OP)) ||
765 ((Operand >= EFI_IFR_EQUAL_OP) && (Operand <= EFI_IFR_SPAN_OP)) ||
766 (Operand == EFI_IFR_CATENATE_OP) ||
767 (Operand == EFI_IFR_TO_LOWER_OP) ||
768 (Operand == EFI_IFR_TO_UPPER_OP) ||
769 (Operand == EFI_IFR_MAP_OP) ||
770 (Operand == EFI_IFR_VERSION_OP) ||
771 (Operand == EFI_IFR_SECURITY_OP)) {
772 return TRUE;
773 } else {
774 return FALSE;
775 }
776 }
777
778
779 /**
780 Calculate number of Statemens(Questions) and Expression OpCodes.
781
782 @param FormSet The FormSet to be counted.
783 @param NumberOfStatement Number of Statemens(Questions)
784 @param NumberOfExpression Number of Expression OpCodes
785
786 **/
787 VOID
788 CountOpCodes (
789 IN FORM_BROWSER_FORMSET *FormSet,
790 IN OUT UINT16 *NumberOfStatement,
791 IN OUT UINT16 *NumberOfExpression
792 )
793 {
794 UINT16 StatementCount;
795 UINT16 ExpressionCount;
796 UINT8 *OpCodeData;
797 UINTN Offset;
798 UINTN OpCodeLen;
799
800 Offset = 0;
801 StatementCount = 0;
802 ExpressionCount = 0;
803
804 while (Offset < FormSet->IfrBinaryLength) {
805 OpCodeData = FormSet->IfrBinaryData + Offset;
806 OpCodeLen = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
807 Offset += OpCodeLen;
808
809 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode)) {
810 ExpressionCount++;
811 } else {
812 StatementCount++;
813 }
814 }
815
816 *NumberOfStatement = StatementCount;
817 *NumberOfExpression = ExpressionCount;
818 }
819
820
821
822 /**
823 Parse opcodes in the formset IFR binary.
824
825 @param FormSet Pointer of the FormSet data structure.
826
827 @retval EFI_SUCCESS Opcode parse success.
828 @retval Other Opcode parse fail.
829
830 **/
831 EFI_STATUS
832 ParseOpCodes (
833 IN FORM_BROWSER_FORMSET *FormSet
834 )
835 {
836 EFI_STATUS Status;
837 UINT16 Index;
838 FORM_BROWSER_FORM *CurrentForm;
839 FORM_BROWSER_STATEMENT *CurrentStatement;
840 EXPRESSION_OPCODE *ExpressionOpCode;
841 FORM_EXPRESSION *CurrentExpression;
842 UINT8 Operand;
843 UINT8 Scope;
844 UINTN OpCodeOffset;
845 UINTN OpCodeLength;
846 UINT8 *OpCodeData;
847 UINT8 ScopeOpCode;
848 FORMSET_STORAGE *Storage;
849 FORMSET_DEFAULTSTORE *DefaultStore;
850 QUESTION_DEFAULT *CurrentDefault;
851 QUESTION_OPTION *CurrentOption;
852 UINT8 Width;
853 CHAR8 *AsciiString;
854 UINT16 NumberOfStatement;
855 UINT16 NumberOfExpression;
856 EFI_IMAGE_ID *ImageId;
857 BOOLEAN SuppressForQuestion;
858 BOOLEAN SuppressForOption;
859 BOOLEAN InScopeOptionSuppress;
860 FORM_EXPRESSION *OptionSuppressExpression;
861 BOOLEAN InScopeFormSuppress;
862 FORM_EXPRESSION *FormSuppressExpression;
863 UINT16 DepthOfDisable;
864 BOOLEAN OpCodeDisabled;
865 BOOLEAN SingleOpCodeExpression;
866 BOOLEAN InScopeDefault;
867 EFI_HII_VALUE *Value;
868 EFI_IFR_FORM_MAP_METHOD *MapMethod;
869 UINT8 MapScopeDepth;
870 LIST_ENTRY *Link;
871 FORMSET_STORAGE *VarStorage;
872 LIST_ENTRY *MapExpressionList;
873 EFI_VARSTORE_ID TempVarstoreId;
874
875 mInScopeSubtitle = FALSE;
876 SuppressForQuestion = FALSE;
877 SuppressForOption = FALSE;
878 InScopeFormSuppress = FALSE;
879 mInScopeSuppress = FALSE;
880 InScopeOptionSuppress = FALSE;
881 mInScopeGrayOut = FALSE;
882 mInScopeDisable = FALSE;
883 DepthOfDisable = 0;
884 OpCodeDisabled = FALSE;
885 SingleOpCodeExpression = FALSE;
886 InScopeDefault = FALSE;
887 CurrentExpression = NULL;
888 CurrentDefault = NULL;
889 CurrentOption = NULL;
890 OptionSuppressExpression = NULL;
891 FormSuppressExpression = NULL;
892 ImageId = NULL;
893 MapMethod = NULL;
894 MapScopeDepth = 0;
895 Link = NULL;
896 VarStorage = NULL;
897 MapExpressionList = NULL;
898 TempVarstoreId = 0;
899
900 //
901 // Get the number of Statements and Expressions
902 //
903 CountOpCodes (FormSet, &NumberOfStatement, &NumberOfExpression);
904
905 mStatementIndex = 0;
906 FormSet->StatementBuffer = AllocateZeroPool (NumberOfStatement * sizeof (FORM_BROWSER_STATEMENT));
907 if (FormSet->StatementBuffer == NULL) {
908 return EFI_OUT_OF_RESOURCES;
909 }
910
911 mExpressionOpCodeIndex = 0;
912 FormSet->ExpressionBuffer = AllocateZeroPool (NumberOfExpression * sizeof (EXPRESSION_OPCODE));
913 if (FormSet->ExpressionBuffer == NULL) {
914 return EFI_OUT_OF_RESOURCES;
915 }
916
917 InitializeListHead (&FormSet->StorageListHead);
918 InitializeListHead (&FormSet->DefaultStoreListHead);
919 InitializeListHead (&FormSet->FormListHead);
920 ResetCurrentExpressionStack ();
921 ResetMapExpressionListStack ();
922
923 CurrentForm = NULL;
924 CurrentStatement = NULL;
925
926 ResetScopeStack ();
927
928 OpCodeOffset = 0;
929 while (OpCodeOffset < FormSet->IfrBinaryLength) {
930 OpCodeData = FormSet->IfrBinaryData + OpCodeOffset;
931
932 OpCodeLength = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
933 OpCodeOffset += OpCodeLength;
934 Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;
935 Scope = ((EFI_IFR_OP_HEADER *) OpCodeData)->Scope;
936
937 //
938 // If scope bit set, push onto scope stack
939 //
940 if (Scope != 0) {
941 PushScope (Operand);
942 }
943
944 if (OpCodeDisabled) {
945 //
946 // DisableIf Expression is evaluated to be TRUE, try to find its end.
947 // Here only cares the EFI_IFR_DISABLE_IF and EFI_IFR_END
948 //
949 if (Operand == EFI_IFR_DISABLE_IF_OP) {
950 DepthOfDisable++;
951 } else if (Operand == EFI_IFR_END_OP) {
952 Status = PopScope (&ScopeOpCode);
953 if (EFI_ERROR (Status)) {
954 return Status;
955 }
956
957 if (ScopeOpCode == EFI_IFR_DISABLE_IF_OP) {
958 if (DepthOfDisable == 0) {
959 mInScopeDisable = FALSE;
960 OpCodeDisabled = FALSE;
961 } else {
962 DepthOfDisable--;
963 }
964 }
965 }
966 continue;
967 }
968
969 if (IsExpressionOpCode (Operand)) {
970 ExpressionOpCode = &FormSet->ExpressionBuffer[mExpressionOpCodeIndex];
971 mExpressionOpCodeIndex++;
972
973 ExpressionOpCode->Signature = EXPRESSION_OPCODE_SIGNATURE;
974 ExpressionOpCode->Operand = Operand;
975 Value = &ExpressionOpCode->Value;
976
977 switch (Operand) {
978 case EFI_IFR_EQ_ID_VAL_OP:
979 CopyMem (&ExpressionOpCode->QuestionId, &((EFI_IFR_EQ_ID_VAL *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
980
981 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
982 CopyMem (&Value->Value.u16, &((EFI_IFR_EQ_ID_VAL *) OpCodeData)->Value, sizeof (UINT16));
983 break;
984
985 case EFI_IFR_EQ_ID_ID_OP:
986 CopyMem (&ExpressionOpCode->QuestionId, &((EFI_IFR_EQ_ID_ID *) OpCodeData)->QuestionId1, sizeof (EFI_QUESTION_ID));
987 CopyMem (&ExpressionOpCode->QuestionId2, &((EFI_IFR_EQ_ID_ID *) OpCodeData)->QuestionId2, sizeof (EFI_QUESTION_ID));
988 break;
989
990 case EFI_IFR_EQ_ID_LIST_OP:
991 CopyMem (&ExpressionOpCode->QuestionId, &((EFI_IFR_EQ_ID_VAL_LIST *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
992 CopyMem (&ExpressionOpCode->ListLength, &((EFI_IFR_EQ_ID_VAL_LIST *) OpCodeData)->ListLength, sizeof (UINT16));
993 ExpressionOpCode->ValueList = AllocateCopyPool (ExpressionOpCode->ListLength * sizeof (UINT16), &((EFI_IFR_EQ_ID_VAL_LIST *) OpCodeData)->ValueList);
994 break;
995
996 case EFI_IFR_TO_STRING_OP:
997 case EFI_IFR_FIND_OP:
998 ExpressionOpCode->Format = (( EFI_IFR_TO_STRING *) OpCodeData)->Format;
999 break;
1000
1001 case EFI_IFR_STRING_REF1_OP:
1002 Value->Type = EFI_IFR_TYPE_STRING;
1003 CopyMem (&Value->Value.string, &(( EFI_IFR_STRING_REF1 *) OpCodeData)->StringId, sizeof (EFI_STRING_ID));
1004 break;
1005
1006 case EFI_IFR_RULE_REF_OP:
1007 ExpressionOpCode->RuleId = (( EFI_IFR_RULE_REF *) OpCodeData)->RuleId;
1008 break;
1009
1010 case EFI_IFR_SPAN_OP:
1011 ExpressionOpCode->Flags = (( EFI_IFR_SPAN *) OpCodeData)->Flags;
1012 break;
1013
1014 case EFI_IFR_THIS_OP:
1015 ASSERT (CurrentStatement != NULL);
1016 ExpressionOpCode->QuestionId = CurrentStatement->QuestionId;
1017 break;
1018
1019 case EFI_IFR_SECURITY_OP:
1020 CopyMem (&ExpressionOpCode->Guid, &((EFI_IFR_SECURITY *) OpCodeData)->Permissions, sizeof (EFI_GUID));
1021 break;
1022
1023 case EFI_IFR_GET_OP:
1024 case EFI_IFR_SET_OP:
1025 CopyMem (&TempVarstoreId, &((EFI_IFR_GET *) OpCodeData)->VarStoreId, sizeof (TempVarstoreId));
1026 if (TempVarstoreId != 0) {
1027 if (FormSet->StorageListHead.ForwardLink != NULL) {
1028 Link = GetFirstNode (&FormSet->StorageListHead);
1029 while (!IsNull (&FormSet->StorageListHead, Link)) {
1030 VarStorage = FORMSET_STORAGE_FROM_LINK (Link);
1031 if (VarStorage->VarStoreId == ((EFI_IFR_GET *) OpCodeData)->VarStoreId) {
1032 ExpressionOpCode->VarStorage = VarStorage;
1033 break;
1034 }
1035 Link = GetNextNode (&FormSet->StorageListHead, Link);
1036 }
1037 }
1038 if (ExpressionOpCode->VarStorage == NULL) {
1039 //
1040 // VarStorage is not found.
1041 //
1042 return EFI_INVALID_PARAMETER;
1043 }
1044 }
1045 ExpressionOpCode->ValueType = ((EFI_IFR_GET *) OpCodeData)->VarStoreType;
1046 switch (ExpressionOpCode->ValueType) {
1047 case EFI_IFR_TYPE_BOOLEAN:
1048 case EFI_IFR_TYPE_NUM_SIZE_8:
1049 ExpressionOpCode->ValueWidth = 1;
1050 break;
1051
1052 case EFI_IFR_TYPE_NUM_SIZE_16:
1053 case EFI_IFR_TYPE_STRING:
1054 ExpressionOpCode->ValueWidth = 2;
1055 break;
1056
1057 case EFI_IFR_TYPE_NUM_SIZE_32:
1058 ExpressionOpCode->ValueWidth = 4;
1059 break;
1060
1061 case EFI_IFR_TYPE_NUM_SIZE_64:
1062 ExpressionOpCode->ValueWidth = 8;
1063 break;
1064
1065 case EFI_IFR_TYPE_DATE:
1066 ExpressionOpCode->ValueWidth = sizeof (EFI_IFR_DATE);
1067 break;
1068
1069 case EFI_IFR_TYPE_TIME:
1070 ExpressionOpCode->ValueWidth = sizeof (EFI_IFR_TIME);
1071 break;
1072
1073 case EFI_IFR_TYPE_OTHER:
1074 case EFI_IFR_TYPE_UNDEFINED:
1075 case EFI_IFR_TYPE_ACTION:
1076 case EFI_IFR_TYPE_BUFFER:
1077 default:
1078 //
1079 // Invalid value type for Get/Set opcode.
1080 //
1081 return EFI_INVALID_PARAMETER;
1082 }
1083 CopyMem (&ExpressionOpCode->VarStoreInfo.VarName, &((EFI_IFR_GET *) OpCodeData)->VarStoreInfo.VarName, sizeof (EFI_STRING_ID));
1084 CopyMem (&ExpressionOpCode->VarStoreInfo.VarOffset, &((EFI_IFR_GET *) OpCodeData)->VarStoreInfo.VarOffset, sizeof (UINT16));
1085 if ((ExpressionOpCode->VarStorage != NULL) &&
1086 (ExpressionOpCode->VarStorage->Type == EFI_HII_VARSTORE_NAME_VALUE ||
1087 ExpressionOpCode->VarStorage->Type == EFI_HII_VARSTORE_EFI_VARIABLE)) {
1088 ExpressionOpCode->ValueName = GetToken (ExpressionOpCode->VarStoreInfo.VarName, FormSet->HiiHandle);
1089 if (ExpressionOpCode->ValueName == NULL) {
1090 //
1091 // String ID is invalid.
1092 //
1093 return EFI_INVALID_PARAMETER;
1094 }
1095 }
1096 break;
1097
1098 case EFI_IFR_QUESTION_REF1_OP:
1099 CopyMem (&ExpressionOpCode->QuestionId, &((EFI_IFR_EQ_ID_VAL_LIST *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
1100 break;
1101
1102 case EFI_IFR_QUESTION_REF3_OP:
1103 if (OpCodeLength >= sizeof (EFI_IFR_QUESTION_REF3_2)) {
1104 CopyMem (&ExpressionOpCode->DevicePath, &(( EFI_IFR_QUESTION_REF3_2 *) OpCodeData)->DevicePath, sizeof (EFI_STRING_ID));
1105
1106 if (OpCodeLength >= sizeof (EFI_IFR_QUESTION_REF3_3)) {
1107 CopyMem (&ExpressionOpCode->Guid, &(( EFI_IFR_QUESTION_REF3_3 *) OpCodeData)->Guid, sizeof (EFI_GUID));
1108 }
1109 }
1110 break;
1111
1112 //
1113 // constant
1114 //
1115 case EFI_IFR_TRUE_OP:
1116 Value->Type = EFI_IFR_TYPE_BOOLEAN;
1117 Value->Value.b = TRUE;
1118 break;
1119
1120 case EFI_IFR_FALSE_OP:
1121 Value->Type = EFI_IFR_TYPE_BOOLEAN;
1122 Value->Value.b = FALSE;
1123 break;
1124
1125 case EFI_IFR_ONE_OP:
1126 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
1127 Value->Value.u8 = 1;
1128 break;
1129
1130 case EFI_IFR_ZERO_OP:
1131 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
1132 Value->Value.u8 = 0;
1133 break;
1134
1135 case EFI_IFR_ONES_OP:
1136 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1137 Value->Value.u64 = 0xffffffffffffffffULL;
1138 break;
1139
1140 case EFI_IFR_UINT8_OP:
1141 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
1142 Value->Value.u8 = (( EFI_IFR_UINT8 *) OpCodeData)->Value;
1143 break;
1144
1145 case EFI_IFR_UINT16_OP:
1146 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
1147 CopyMem (&Value->Value.u16, &(( EFI_IFR_UINT16 *) OpCodeData)->Value, sizeof (UINT16));
1148 break;
1149
1150 case EFI_IFR_UINT32_OP:
1151 Value->Type = EFI_IFR_TYPE_NUM_SIZE_32;
1152 CopyMem (&Value->Value.u32, &(( EFI_IFR_UINT32 *) OpCodeData)->Value, sizeof (UINT32));
1153 break;
1154
1155 case EFI_IFR_UINT64_OP:
1156 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1157 CopyMem (&Value->Value.u64, &(( EFI_IFR_UINT64 *) OpCodeData)->Value, sizeof (UINT64));
1158 break;
1159
1160 case EFI_IFR_UNDEFINED_OP:
1161 Value->Type = EFI_IFR_TYPE_UNDEFINED;
1162 break;
1163
1164 case EFI_IFR_VERSION_OP:
1165 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
1166 Value->Value.u16 = EFI_IFR_SPECIFICATION_VERSION;
1167 break;
1168
1169 default:
1170 break;
1171 }
1172 //
1173 // Create sub expression nested in MAP opcode
1174 //
1175 if (CurrentExpression == NULL && MapScopeDepth > 0) {
1176 CurrentExpression = CreateExpression (CurrentForm);
1177 ASSERT (MapExpressionList != NULL);
1178 InsertTailList (MapExpressionList, &CurrentExpression->Link);
1179 if (Scope == 0) {
1180 SingleOpCodeExpression = TRUE;
1181 }
1182 }
1183 ASSERT (CurrentExpression != NULL);
1184 InsertTailList (&CurrentExpression->OpCodeListHead, &ExpressionOpCode->Link);
1185 if (Operand == EFI_IFR_MAP_OP) {
1186 //
1187 // Store current Map Expression List.
1188 //
1189 if (MapExpressionList != NULL) {
1190 PushMapExpressionList (MapExpressionList);
1191 }
1192 //
1193 // Initialize new Map Expression List.
1194 //
1195 MapExpressionList = &ExpressionOpCode->MapExpressionList;
1196 InitializeListHead (MapExpressionList);
1197 //
1198 // Store current expression.
1199 //
1200 PushCurrentExpression (CurrentExpression);
1201 CurrentExpression = NULL;
1202 MapScopeDepth ++;
1203 } else if (SingleOpCodeExpression) {
1204 //
1205 // There are two cases to indicate the end of an Expression:
1206 // for single OpCode expression: one Expression OpCode
1207 // for expression consists of more than one OpCode: EFI_IFR_END
1208 //
1209 SingleOpCodeExpression = FALSE;
1210
1211 if (mInScopeDisable && CurrentForm == NULL) {
1212 //
1213 // This is DisableIf expression for Form, it should be a constant expression
1214 //
1215 Status = EvaluateExpression (FormSet, CurrentForm, CurrentExpression);
1216 if (EFI_ERROR (Status)) {
1217 return Status;
1218 }
1219
1220 if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {
1221 return EFI_INVALID_PARAMETER;
1222 }
1223
1224 OpCodeDisabled = CurrentExpression->Result.Value.b;
1225 }
1226
1227 CurrentExpression = NULL;
1228 }
1229
1230 continue;
1231 }
1232
1233 //
1234 // Parse the Opcode
1235 //
1236 switch (Operand) {
1237
1238 case EFI_IFR_FORM_SET_OP:
1239 //
1240 // Check the formset GUID
1241 //
1242 if (CompareMem (&FormSet->Guid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID)) != 0) {
1243 return EFI_INVALID_PARAMETER;
1244 }
1245
1246 CopyMem (&FormSet->FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
1247 CopyMem (&FormSet->Help, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
1248
1249 if (OpCodeLength > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
1250 //
1251 // The formset OpCode contains ClassGuid
1252 //
1253 FormSet->NumberOfClassGuid = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
1254 CopyMem (FormSet->ClassGuid, OpCodeData + sizeof (EFI_IFR_FORM_SET), FormSet->NumberOfClassGuid * sizeof (EFI_GUID));
1255 }
1256
1257 InitializeListHead (&FormSet->ExpressionListHead);
1258 break;
1259
1260 case EFI_IFR_FORM_OP:
1261 //
1262 // Create a new Form for this FormSet
1263 //
1264 CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));
1265 ASSERT (CurrentForm != NULL);
1266 CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;
1267 InitializeListHead (&CurrentForm->ExpressionListHead);
1268 InitializeListHead (&CurrentForm->StatementListHead);
1269
1270 CurrentForm->FormType = STANDARD_MAP_FORM_TYPE;
1271 CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));
1272 CopyMem (&CurrentForm->FormTitle, &((EFI_IFR_FORM *) OpCodeData)->FormTitle, sizeof (EFI_STRING_ID));
1273
1274 if (InScopeFormSuppress) {
1275 //
1276 // Form is inside of suppressif
1277 //
1278 CurrentForm->SuppressExpression = FormSuppressExpression;
1279 }
1280
1281 if (Scope != 0) {
1282 //
1283 // Enter scope of a Form, suppressif will be used for Question or Option
1284 //
1285 SuppressForQuestion = TRUE;
1286 }
1287
1288 //
1289 // Insert into Form list of this FormSet
1290 //
1291 InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);
1292 break;
1293
1294 case EFI_IFR_FORM_MAP_OP:
1295 //
1296 // Create a new Form for this FormSet
1297 //
1298 CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));
1299 ASSERT (CurrentForm != NULL);
1300 CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;
1301 InitializeListHead (&CurrentForm->ExpressionListHead);
1302 InitializeListHead (&CurrentForm->StatementListHead);
1303 CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));
1304
1305 MapMethod = (EFI_IFR_FORM_MAP_METHOD *) (OpCodeData + sizeof (EFI_IFR_FORM_MAP));
1306 //
1307 // FormMap Form must contain at least one Map Method.
1308 //
1309 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length < ((UINTN) (UINT8 *) (MapMethod + 1) - (UINTN) OpCodeData)) {
1310 return EFI_INVALID_PARAMETER;
1311 }
1312 //
1313 // Try to find the standard form map method.
1314 //
1315 while (((UINTN) (UINT8 *) MapMethod - (UINTN) OpCodeData) < ((EFI_IFR_OP_HEADER *) OpCodeData)->Length) {
1316 if (CompareGuid ((EFI_GUID *) (VOID *) &MapMethod->MethodIdentifier, &gEfiHiiStandardFormGuid)) {
1317 CopyMem (&CurrentForm->FormTitle, &MapMethod->MethodTitle, sizeof (EFI_STRING_ID));
1318 CurrentForm->FormType = STANDARD_MAP_FORM_TYPE;
1319 break;
1320 }
1321 MapMethod ++;
1322 }
1323 //
1324 // If the standard form map method is not found, the first map method title will be used.
1325 //
1326 if (CurrentForm->FormTitle == 0) {
1327 MapMethod = (EFI_IFR_FORM_MAP_METHOD *) (OpCodeData + sizeof (EFI_IFR_FORM_MAP));
1328 CopyMem (&CurrentForm->FormTitle, &MapMethod->MethodTitle, sizeof (EFI_STRING_ID));
1329 }
1330
1331 if (InScopeFormSuppress) {
1332 //
1333 // Form is inside of suppressif
1334 //
1335 CurrentForm->SuppressExpression = FormSuppressExpression;
1336 }
1337
1338 if (Scope != 0) {
1339 //
1340 // Enter scope of a Form, suppressif will be used for Question or Option
1341 //
1342 SuppressForQuestion = TRUE;
1343 }
1344
1345 //
1346 // Insert into Form list of this FormSet
1347 //
1348 InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);
1349 break;
1350
1351 //
1352 // Storage
1353 //
1354 case EFI_IFR_VARSTORE_OP:
1355 //
1356 // Create a buffer Storage for this FormSet
1357 //
1358 Storage = CreateStorage (FormSet);
1359 Storage->Type = EFI_HII_VARSTORE_BUFFER;
1360
1361 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1362 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE *) OpCodeData)->Guid, sizeof (EFI_GUID));
1363 CopyMem (&Storage->Size, &((EFI_IFR_VARSTORE *) OpCodeData)->Size, sizeof (UINT16));
1364
1365 Storage->Buffer = AllocateZeroPool (Storage->Size);
1366 Storage->EditBuffer = AllocateZeroPool (Storage->Size);
1367
1368 AsciiString = (CHAR8 *) ((EFI_IFR_VARSTORE *) OpCodeData)->Name;
1369 Storage->Name = AllocateZeroPool (AsciiStrSize (AsciiString) * 2);
1370 ASSERT (Storage->Name != NULL);
1371 for (Index = 0; AsciiString[Index] != 0; Index++) {
1372 Storage->Name[Index] = (CHAR16) AsciiString[Index];
1373 }
1374
1375 //
1376 // Initialize <ConfigHdr>
1377 //
1378 InitializeConfigHdr (FormSet, Storage);
1379 break;
1380
1381 case EFI_IFR_VARSTORE_NAME_VALUE_OP:
1382 //
1383 // Create a name/value Storage for this FormSet
1384 //
1385 Storage = CreateStorage (FormSet);
1386 Storage->Type = EFI_HII_VARSTORE_NAME_VALUE;
1387
1388 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1389 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->Guid, sizeof (EFI_GUID));
1390
1391 //
1392 // Initialize <ConfigHdr>
1393 //
1394 InitializeConfigHdr (FormSet, Storage);
1395 break;
1396
1397 case EFI_IFR_VARSTORE_EFI_OP:
1398 //
1399 // Create a EFI variable Storage for this FormSet
1400 //
1401 Storage = CreateStorage (FormSet);
1402 Storage->Type = EFI_HII_VARSTORE_EFI_VARIABLE;
1403
1404 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1405 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Guid, sizeof (EFI_GUID));
1406 CopyMem (&Storage->Attributes, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Attributes, sizeof (UINT32));
1407 break;
1408
1409 //
1410 // DefaultStore
1411 //
1412 case EFI_IFR_DEFAULTSTORE_OP:
1413 DefaultStore = AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE));
1414 ASSERT (DefaultStore != NULL);
1415 DefaultStore->Signature = FORMSET_DEFAULTSTORE_SIGNATURE;
1416
1417 CopyMem (&DefaultStore->DefaultId, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultId, sizeof (UINT16));
1418 CopyMem (&DefaultStore->DefaultName, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultName, sizeof (EFI_STRING_ID));
1419
1420 //
1421 // Insert to DefaultStore list of this Formset
1422 //
1423 InsertTailList (&FormSet->DefaultStoreListHead, &DefaultStore->Link);
1424 break;
1425
1426 //
1427 // Statements
1428 //
1429 case EFI_IFR_SUBTITLE_OP:
1430 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1431 ASSERT (CurrentStatement != NULL);
1432
1433 CurrentStatement->Flags = ((EFI_IFR_SUBTITLE *) OpCodeData)->Flags;
1434
1435 if (Scope != 0) {
1436 mInScopeSubtitle = TRUE;
1437 }
1438 break;
1439
1440 case EFI_IFR_TEXT_OP:
1441 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1442 ASSERT (CurrentStatement != NULL);
1443
1444 CopyMem (&CurrentStatement->TextTwo, &((EFI_IFR_TEXT *) OpCodeData)->TextTwo, sizeof (EFI_STRING_ID));
1445 break;
1446
1447 case EFI_IFR_RESET_BUTTON_OP:
1448 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1449 ASSERT (CurrentStatement != NULL);
1450 CopyMem (&CurrentStatement->DefaultId, &((EFI_IFR_RESET_BUTTON *) OpCodeData)->DefaultId, sizeof (EFI_DEFAULT_ID));
1451 break;
1452
1453 //
1454 // Questions
1455 //
1456 case EFI_IFR_ACTION_OP:
1457 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1458 ASSERT (CurrentStatement != NULL);
1459 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_ACTION;
1460
1461 if (OpCodeLength == sizeof (EFI_IFR_ACTION_1)) {
1462 //
1463 // No QuestionConfig present, so no configuration string will be processed
1464 //
1465 CurrentStatement->QuestionConfig = 0;
1466 } else {
1467 CopyMem (&CurrentStatement->QuestionConfig, &((EFI_IFR_ACTION *) OpCodeData)->QuestionConfig, sizeof (EFI_STRING_ID));
1468 }
1469 break;
1470
1471 case EFI_IFR_REF_OP:
1472 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1473 ASSERT (CurrentStatement != NULL);
1474 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_UNDEFINED;
1475 CopyMem (&CurrentStatement->RefFormId, &((EFI_IFR_REF *) OpCodeData)->FormId, sizeof (EFI_FORM_ID));
1476 if (OpCodeLength >= sizeof (EFI_IFR_REF2)) {
1477 CopyMem (&CurrentStatement->RefQuestionId, &((EFI_IFR_REF2 *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
1478
1479 if (OpCodeLength >= sizeof (EFI_IFR_REF3)) {
1480 CopyMem (&CurrentStatement->RefFormSetId, &((EFI_IFR_REF3 *) OpCodeData)->FormSetId, sizeof (EFI_GUID));
1481
1482 if (OpCodeLength >= sizeof (EFI_IFR_REF4)) {
1483 CopyMem (&CurrentStatement->RefDevicePath, &((EFI_IFR_REF4 *) OpCodeData)->DevicePath, sizeof (EFI_STRING_ID));
1484 }
1485 }
1486 }
1487 break;
1488
1489 case EFI_IFR_ONE_OF_OP:
1490 case EFI_IFR_NUMERIC_OP:
1491 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1492 ASSERT(CurrentStatement != NULL);
1493
1494 CurrentStatement->Flags = ((EFI_IFR_ONE_OF *) OpCodeData)->Flags;
1495 Value = &CurrentStatement->HiiValue;
1496
1497 switch (CurrentStatement->Flags & EFI_IFR_NUMERIC_SIZE) {
1498 case EFI_IFR_NUMERIC_SIZE_1:
1499 CurrentStatement->Minimum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MinValue;
1500 CurrentStatement->Maximum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MaxValue;
1501 CurrentStatement->Step = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.Step;
1502 CurrentStatement->StorageWidth = sizeof (UINT8);
1503 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
1504 break;
1505
1506 case EFI_IFR_NUMERIC_SIZE_2:
1507 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MinValue, sizeof (UINT16));
1508 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MaxValue, sizeof (UINT16));
1509 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.Step, sizeof (UINT16));
1510 CurrentStatement->StorageWidth = sizeof (UINT16);
1511 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
1512 break;
1513
1514 case EFI_IFR_NUMERIC_SIZE_4:
1515 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MinValue, sizeof (UINT32));
1516 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MaxValue, sizeof (UINT32));
1517 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.Step, sizeof (UINT32));
1518 CurrentStatement->StorageWidth = sizeof (UINT32);
1519 Value->Type = EFI_IFR_TYPE_NUM_SIZE_32;
1520 break;
1521
1522 case EFI_IFR_NUMERIC_SIZE_8:
1523 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MinValue, sizeof (UINT64));
1524 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MaxValue, sizeof (UINT64));
1525 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.Step, sizeof (UINT64));
1526 CurrentStatement->StorageWidth = sizeof (UINT64);
1527 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1528 break;
1529
1530 default:
1531 break;
1532 }
1533
1534 InitializeRequestElement (FormSet, CurrentStatement);
1535
1536 if ((Operand == EFI_IFR_ONE_OF_OP) && Scope != 0) {
1537 SuppressForOption = TRUE;
1538 }
1539 break;
1540
1541 case EFI_IFR_ORDERED_LIST_OP:
1542 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1543 ASSERT(CurrentStatement != NULL);
1544
1545 CurrentStatement->Flags = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->Flags;
1546 CurrentStatement->MaxContainers = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;
1547
1548 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BUFFER;
1549 CurrentStatement->BufferValue = NULL;
1550
1551 if (Scope != 0) {
1552 SuppressForOption = TRUE;
1553 }
1554 break;
1555
1556 case EFI_IFR_CHECKBOX_OP:
1557 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1558 ASSERT(CurrentStatement != NULL);
1559
1560 CurrentStatement->Flags = ((EFI_IFR_CHECKBOX *) OpCodeData)->Flags;
1561 CurrentStatement->StorageWidth = sizeof (BOOLEAN);
1562 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BOOLEAN;
1563
1564 InitializeRequestElement (FormSet, CurrentStatement);
1565
1566 break;
1567
1568 case EFI_IFR_STRING_OP:
1569 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1570 ASSERT (CurrentStatement != NULL);
1571 //
1572 // MinSize is the minimum number of characters that can be accepted for this opcode,
1573 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1574 // The characters are stored as Unicode, so the storage width should multiply 2.
1575 //
1576 CurrentStatement->Minimum = ((EFI_IFR_STRING *) OpCodeData)->MinSize;
1577 CurrentStatement->Maximum = ((EFI_IFR_STRING *) OpCodeData)->MaxSize;
1578 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (CHAR16));
1579 CurrentStatement->Flags = ((EFI_IFR_STRING *) OpCodeData)->Flags;
1580
1581 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
1582 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth + sizeof (CHAR16));
1583
1584 InitializeRequestElement (FormSet, CurrentStatement);
1585 break;
1586
1587 case EFI_IFR_PASSWORD_OP:
1588 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1589 ASSERT (CurrentStatement != NULL);
1590 //
1591 // MinSize is the minimum number of characters that can be accepted for this opcode,
1592 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1593 // The characters are stored as Unicode, so the storage width should multiply 2.
1594 //
1595 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_PASSWORD *) OpCodeData)->MinSize, sizeof (UINT16));
1596 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_PASSWORD *) OpCodeData)->MaxSize, sizeof (UINT16));
1597 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (CHAR16));
1598
1599 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
1600 CurrentStatement->BufferValue = AllocateZeroPool ((CurrentStatement->StorageWidth + sizeof (CHAR16)));
1601
1602 InitializeRequestElement (FormSet, CurrentStatement);
1603 break;
1604
1605 case EFI_IFR_DATE_OP:
1606 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1607 ASSERT(CurrentStatement != NULL);
1608
1609 CurrentStatement->Flags = ((EFI_IFR_DATE *) OpCodeData)->Flags;
1610 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_DATE;
1611
1612 if ((CurrentStatement->Flags & EFI_QF_DATE_STORAGE) == QF_DATE_STORAGE_NORMAL) {
1613 CurrentStatement->StorageWidth = sizeof (EFI_HII_DATE);
1614
1615 InitializeRequestElement (FormSet, CurrentStatement);
1616 } else {
1617 //
1618 // Don't assign storage for RTC type of date/time
1619 //
1620 CurrentStatement->Storage = NULL;
1621 CurrentStatement->StorageWidth = 0;
1622 }
1623 break;
1624
1625 case EFI_IFR_TIME_OP:
1626 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1627 ASSERT(CurrentStatement != NULL);
1628
1629 CurrentStatement->Flags = ((EFI_IFR_TIME *) OpCodeData)->Flags;
1630 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_TIME;
1631
1632 if ((CurrentStatement->Flags & QF_TIME_STORAGE) == QF_TIME_STORAGE_NORMAL) {
1633 CurrentStatement->StorageWidth = sizeof (EFI_IFR_TIME);
1634
1635 InitializeRequestElement (FormSet, CurrentStatement);
1636 } else {
1637 //
1638 // Don't assign storage for RTC type of date/time
1639 //
1640 CurrentStatement->Storage = NULL;
1641 CurrentStatement->StorageWidth = 0;
1642 }
1643 break;
1644
1645 //
1646 // Default
1647 //
1648 case EFI_IFR_DEFAULT_OP:
1649 //
1650 // EFI_IFR_DEFAULT appear in scope of a Question,
1651 // It creates a default value for the current question.
1652 // A Question may have more than one Default value which have different default types.
1653 //
1654 CurrentDefault = AllocateZeroPool (sizeof (QUESTION_DEFAULT));
1655 ASSERT (CurrentDefault != NULL);
1656 CurrentDefault->Signature = QUESTION_DEFAULT_SIGNATURE;
1657
1658 CurrentDefault->Value.Type = ((EFI_IFR_DEFAULT *) OpCodeData)->Type;
1659 CopyMem (&CurrentDefault->DefaultId, &((EFI_IFR_DEFAULT *) OpCodeData)->DefaultId, sizeof (UINT16));
1660 CopyMem (&CurrentDefault->Value.Value, &((EFI_IFR_DEFAULT *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
1661 ExtendValueToU64 (&CurrentDefault->Value);
1662
1663 //
1664 // Insert to Default Value list of current Question
1665 //
1666 InsertTailList (&CurrentStatement->DefaultListHead, &CurrentDefault->Link);
1667
1668 if (Scope != 0) {
1669 InScopeDefault = TRUE;
1670 }
1671 break;
1672
1673 //
1674 // Option
1675 //
1676 case EFI_IFR_ONE_OF_OPTION_OP:
1677 //
1678 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
1679 // It create a selection for use in current Question.
1680 //
1681 CurrentOption = AllocateZeroPool (sizeof (QUESTION_OPTION));
1682 ASSERT (CurrentOption != NULL);
1683 CurrentOption->Signature = QUESTION_OPTION_SIGNATURE;
1684
1685 CurrentOption->Flags = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags;
1686 CurrentOption->Value.Type = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Type;
1687 CopyMem (&CurrentOption->Text, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Option, sizeof (EFI_STRING_ID));
1688 CopyMem (&CurrentOption->Value.Value, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
1689 ExtendValueToU64 (&CurrentOption->Value);
1690
1691 if (InScopeOptionSuppress) {
1692 CurrentOption->SuppressExpression = OptionSuppressExpression;
1693 }
1694
1695 //
1696 // Insert to Option list of current Question
1697 //
1698 InsertTailList (&CurrentStatement->OptionListHead, &CurrentOption->Link);
1699
1700 //
1701 // Now we know the Storage width of nested Ordered List
1702 //
1703 ASSERT (CurrentStatement != NULL);
1704 if ((CurrentStatement->Operand == EFI_IFR_ORDERED_LIST_OP) && (CurrentStatement->BufferValue == NULL)) {
1705 Width = 1;
1706 switch (CurrentOption->Value.Type) {
1707 case EFI_IFR_TYPE_NUM_SIZE_8:
1708 Width = 1;
1709 break;
1710
1711 case EFI_IFR_TYPE_NUM_SIZE_16:
1712 Width = 2;
1713 break;
1714
1715 case EFI_IFR_TYPE_NUM_SIZE_32:
1716 Width = 4;
1717 break;
1718
1719 case EFI_IFR_TYPE_NUM_SIZE_64:
1720 Width = 8;
1721 break;
1722
1723 default:
1724 //
1725 // Invalid type for Ordered List
1726 //
1727 break;
1728 }
1729
1730 CurrentStatement->StorageWidth = (UINT16) (CurrentStatement->MaxContainers * Width);
1731 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
1732 CurrentStatement->ValueType = CurrentOption->Value.Type;
1733
1734 InitializeRequestElement (FormSet, CurrentStatement);
1735 }
1736 break;
1737
1738 //
1739 // Conditional
1740 //
1741 case EFI_IFR_NO_SUBMIT_IF_OP:
1742 case EFI_IFR_INCONSISTENT_IF_OP:
1743 //
1744 // Create an Expression node
1745 //
1746 CurrentExpression = CreateExpression (CurrentForm);
1747 CopyMem (&CurrentExpression->Error, &((EFI_IFR_INCONSISTENT_IF *) OpCodeData)->Error, sizeof (EFI_STRING_ID));
1748
1749 if (Operand == EFI_IFR_NO_SUBMIT_IF_OP) {
1750 CurrentExpression->Type = EFI_HII_EXPRESSION_NO_SUBMIT_IF;
1751 InsertTailList (&CurrentStatement->NoSubmitListHead, &CurrentExpression->Link);
1752 } else {
1753 CurrentExpression->Type = EFI_HII_EXPRESSION_INCONSISTENT_IF;
1754 InsertTailList (&CurrentStatement->InconsistentListHead, &CurrentExpression->Link);
1755 }
1756
1757 //
1758 // Take a look at next OpCode to see whether current expression consists
1759 // of single OpCode
1760 //
1761 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1762 SingleOpCodeExpression = TRUE;
1763 }
1764 break;
1765
1766 case EFI_IFR_SUPPRESS_IF_OP:
1767 //
1768 // Question and Option will appear in scope of this OpCode
1769 //
1770 CurrentExpression = CreateExpression (CurrentForm);
1771 CurrentExpression->Type = EFI_HII_EXPRESSION_SUPPRESS_IF;
1772
1773 if (CurrentForm == NULL) {
1774 InsertTailList (&FormSet->ExpressionListHead, &CurrentExpression->Link);
1775 } else {
1776 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1777 }
1778
1779 if (SuppressForOption) {
1780 InScopeOptionSuppress = TRUE;
1781 OptionSuppressExpression = CurrentExpression;
1782 } else if (SuppressForQuestion) {
1783 mInScopeSuppress = TRUE;
1784 mSuppressExpression = CurrentExpression;
1785 } else {
1786 InScopeFormSuppress = TRUE;
1787 FormSuppressExpression = CurrentExpression;
1788 }
1789
1790 //
1791 // Take a look at next OpCode to see whether current expression consists
1792 // of single OpCode
1793 //
1794 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1795 SingleOpCodeExpression = TRUE;
1796 }
1797 break;
1798
1799 case EFI_IFR_GRAY_OUT_IF_OP:
1800 //
1801 // Questions will appear in scope of this OpCode
1802 //
1803 CurrentExpression = CreateExpression (CurrentForm);
1804 CurrentExpression->Type = EFI_HII_EXPRESSION_GRAY_OUT_IF;
1805 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1806
1807 mInScopeGrayOut = TRUE;
1808 mGrayOutExpression = CurrentExpression;
1809
1810 //
1811 // Take a look at next OpCode to see whether current expression consists
1812 // of single OpCode
1813 //
1814 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1815 SingleOpCodeExpression = TRUE;
1816 }
1817 break;
1818
1819 case EFI_IFR_DISABLE_IF_OP:
1820 //
1821 // The DisableIf expression should only rely on constant, so it could be
1822 // evaluated at initialization and it will not be queued
1823 //
1824 CurrentExpression = AllocateZeroPool (sizeof (FORM_EXPRESSION));
1825 ASSERT (CurrentExpression != NULL);
1826 CurrentExpression->Signature = FORM_EXPRESSION_SIGNATURE;
1827 CurrentExpression->Type = EFI_HII_EXPRESSION_DISABLE_IF;
1828 InitializeListHead (&CurrentExpression->OpCodeListHead);
1829
1830 if (CurrentForm != NULL) {
1831 //
1832 // This is DisableIf for Question, enqueue it to Form expression list
1833 //
1834 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1835 }
1836
1837 mDisableExpression = CurrentExpression;
1838 mInScopeDisable = TRUE;
1839 OpCodeDisabled = FALSE;
1840
1841 //
1842 // Take a look at next OpCode to see whether current expression consists
1843 // of single OpCode
1844 //
1845 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1846 SingleOpCodeExpression = TRUE;
1847 }
1848 break;
1849
1850 //
1851 // Expression
1852 //
1853 case EFI_IFR_VALUE_OP:
1854 CurrentExpression = CreateExpression (CurrentForm);
1855 CurrentExpression->Type = EFI_HII_EXPRESSION_VALUE;
1856 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1857
1858 if (InScopeDefault) {
1859 //
1860 // Used for default (EFI_IFR_DEFAULT)
1861 //
1862 CurrentDefault->ValueExpression = CurrentExpression;
1863 } else {
1864 //
1865 // If used for a question, then the question will be read-only
1866 //
1867 //
1868 // Make sure CurrentStatement is not NULL.
1869 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1870 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1871 //
1872 ASSERT (CurrentStatement != NULL);
1873 CurrentStatement->ValueExpression = CurrentExpression;
1874 }
1875
1876 //
1877 // Take a look at next OpCode to see whether current expression consists
1878 // of single OpCode
1879 //
1880 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1881 SingleOpCodeExpression = TRUE;
1882 }
1883 break;
1884
1885 case EFI_IFR_RULE_OP:
1886 CurrentExpression = CreateExpression (CurrentForm);
1887 CurrentExpression->Type = EFI_HII_EXPRESSION_RULE;
1888
1889 CurrentExpression->RuleId = ((EFI_IFR_RULE *) OpCodeData)->RuleId;
1890 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1891
1892 //
1893 // Take a look at next OpCode to see whether current expression consists
1894 // of single OpCode
1895 //
1896 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1897 SingleOpCodeExpression = TRUE;
1898 }
1899 break;
1900
1901 case EFI_IFR_READ_OP:
1902 CurrentExpression = CreateExpression (CurrentForm);
1903 CurrentExpression->Type = EFI_HII_EXPRESSION_READ;
1904 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1905
1906 //
1907 // Make sure CurrentStatement is not NULL.
1908 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1909 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1910 //
1911 ASSERT (CurrentStatement != NULL);
1912 CurrentStatement->ReadExpression = CurrentExpression;
1913
1914 //
1915 // Take a look at next OpCode to see whether current expression consists
1916 // of single OpCode
1917 //
1918 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1919 SingleOpCodeExpression = TRUE;
1920 }
1921 break;
1922
1923 case EFI_IFR_WRITE_OP:
1924 CurrentExpression = CreateExpression (CurrentForm);
1925 CurrentExpression->Type = EFI_HII_EXPRESSION_WRITE;
1926 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1927
1928 //
1929 // Make sure CurrentStatement is not NULL.
1930 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1931 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1932 //
1933 ASSERT (CurrentStatement != NULL);
1934 CurrentStatement->WriteExpression = CurrentExpression;
1935
1936 //
1937 // Take a look at next OpCode to see whether current expression consists
1938 // of single OpCode
1939 //
1940 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1941 SingleOpCodeExpression = TRUE;
1942 }
1943 break;
1944
1945 //
1946 // Image
1947 //
1948 case EFI_IFR_IMAGE_OP:
1949 //
1950 // Get ScopeOpcode from top of stack
1951 //
1952 PopScope (&ScopeOpCode);
1953 PushScope (ScopeOpCode);
1954
1955 switch (ScopeOpCode) {
1956 case EFI_IFR_FORM_SET_OP:
1957 ImageId = &FormSet->ImageId;
1958 break;
1959
1960 case EFI_IFR_FORM_OP:
1961 case EFI_IFR_FORM_MAP_OP:
1962 ASSERT (CurrentForm != NULL);
1963 ImageId = &CurrentForm->ImageId;
1964 break;
1965
1966 case EFI_IFR_ONE_OF_OPTION_OP:
1967 ImageId = &CurrentOption->ImageId;
1968 break;
1969
1970 default:
1971 //
1972 // Make sure CurrentStatement is not NULL.
1973 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1974 // file is wrongly generated by tools such as VFR Compiler.
1975 //
1976 ASSERT (CurrentStatement != NULL);
1977 ImageId = &CurrentStatement->ImageId;
1978 break;
1979 }
1980
1981 ASSERT (ImageId != NULL);
1982 CopyMem (ImageId, &((EFI_IFR_IMAGE *) OpCodeData)->Id, sizeof (EFI_IMAGE_ID));
1983 break;
1984
1985 //
1986 // Refresh
1987 //
1988 case EFI_IFR_REFRESH_OP:
1989 ASSERT (CurrentStatement != NULL);
1990 CurrentStatement->RefreshInterval = ((EFI_IFR_REFRESH *) OpCodeData)->RefreshInterval;
1991 break;
1992
1993 //
1994 // Vendor specific
1995 //
1996 case EFI_IFR_GUID_OP:
1997 if (CompareGuid (&gEfiIfrTianoGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
1998 //
1999 // Tiano specific GUIDed opcodes
2000 //
2001 switch (((EFI_IFR_GUID_LABEL *) OpCodeData)->ExtendOpCode) {
2002 case EFI_IFR_EXTEND_OP_LABEL:
2003 //
2004 // just ignore label
2005 //
2006 break;
2007
2008 case EFI_IFR_EXTEND_OP_BANNER:
2009 //
2010 // By SubClass to get Banner Data from Front Page
2011 //
2012 if (FormSet->SubClass == EFI_FRONT_PAGE_SUBCLASS) {
2013 CopyMem (
2014 &gBannerData->Banner[((EFI_IFR_GUID_BANNER *) OpCodeData)->LineNumber][
2015 ((EFI_IFR_GUID_BANNER *) OpCodeData)->Alignment],
2016 &((EFI_IFR_GUID_BANNER *) OpCodeData)->Title,
2017 sizeof (EFI_STRING_ID)
2018 );
2019 }
2020 break;
2021
2022 case EFI_IFR_EXTEND_OP_CLASS:
2023 CopyMem (&FormSet->Class, &((EFI_IFR_GUID_CLASS *) OpCodeData)->Class, sizeof (UINT16));
2024 break;
2025
2026 case EFI_IFR_EXTEND_OP_SUBCLASS:
2027 CopyMem (&FormSet->SubClass, &((EFI_IFR_GUID_SUBCLASS *) OpCodeData)->SubClass, sizeof (UINT16));
2028 break;
2029
2030 default:
2031 break;
2032 }
2033 }
2034
2035 break;
2036
2037 //
2038 // Scope End
2039 //
2040 case EFI_IFR_END_OP:
2041 Status = PopScope (&ScopeOpCode);
2042 if (EFI_ERROR (Status)) {
2043 ResetScopeStack ();
2044 return Status;
2045 }
2046
2047 switch (ScopeOpCode) {
2048 case EFI_IFR_FORM_SET_OP:
2049 //
2050 // End of FormSet, update FormSet IFR binary length
2051 // to stop parsing substantial OpCodes
2052 //
2053 FormSet->IfrBinaryLength = OpCodeOffset;
2054 break;
2055
2056 case EFI_IFR_FORM_OP:
2057 case EFI_IFR_FORM_MAP_OP:
2058 //
2059 // End of Form
2060 //
2061 CurrentForm = NULL;
2062 SuppressForQuestion = FALSE;
2063 break;
2064
2065 case EFI_IFR_ONE_OF_OPTION_OP:
2066 //
2067 // End of Option
2068 //
2069 CurrentOption = NULL;
2070 break;
2071
2072 case EFI_IFR_SUBTITLE_OP:
2073 mInScopeSubtitle = FALSE;
2074 break;
2075
2076 case EFI_IFR_NO_SUBMIT_IF_OP:
2077 case EFI_IFR_INCONSISTENT_IF_OP:
2078 //
2079 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
2080 //
2081 break;
2082
2083 case EFI_IFR_SUPPRESS_IF_OP:
2084 if (SuppressForOption) {
2085 InScopeOptionSuppress = FALSE;
2086 } else if (SuppressForQuestion) {
2087 mInScopeSuppress = FALSE;
2088 } else {
2089 InScopeFormSuppress = FALSE;
2090 }
2091 break;
2092
2093 case EFI_IFR_GRAY_OUT_IF_OP:
2094 mInScopeGrayOut = FALSE;
2095 break;
2096
2097 case EFI_IFR_DISABLE_IF_OP:
2098 mInScopeDisable = FALSE;
2099 OpCodeDisabled = FALSE;
2100 break;
2101
2102 case EFI_IFR_ONE_OF_OP:
2103 case EFI_IFR_ORDERED_LIST_OP:
2104 SuppressForOption = FALSE;
2105 break;
2106
2107 case EFI_IFR_DEFAULT_OP:
2108 InScopeDefault = FALSE;
2109 break;
2110
2111 case EFI_IFR_MAP_OP:
2112 //
2113 // Get current Map Expression List.
2114 //
2115 Status = PopMapExpressionList ((VOID **) &MapExpressionList);
2116 if (Status == EFI_ACCESS_DENIED) {
2117 MapExpressionList = NULL;
2118 }
2119 //
2120 // Get current expression.
2121 //
2122 Status = PopCurrentExpression ((VOID **) &CurrentExpression);
2123 ASSERT_EFI_ERROR (Status);
2124 ASSERT (MapScopeDepth > 0);
2125 MapScopeDepth --;
2126 break;
2127
2128 default:
2129 if (IsExpressionOpCode (ScopeOpCode)) {
2130 if (mInScopeDisable && CurrentForm == NULL) {
2131 //
2132 // This is DisableIf expression for Form, it should be a constant expression
2133 //
2134 ASSERT (CurrentExpression != NULL);
2135 Status = EvaluateExpression (FormSet, CurrentForm, CurrentExpression);
2136 if (EFI_ERROR (Status)) {
2137 return Status;
2138 }
2139
2140 if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {
2141 return EFI_INVALID_PARAMETER;
2142 }
2143
2144 OpCodeDisabled = CurrentExpression->Result.Value.b;
2145 //
2146 // DisableIf Expression is only used once and not queued, free it
2147 //
2148 DestroyExpression (CurrentExpression);
2149 }
2150
2151 //
2152 // End of current Expression
2153 //
2154 CurrentExpression = NULL;
2155 }
2156 break;
2157 }
2158 break;
2159
2160 default:
2161 break;
2162 }
2163 }
2164
2165 return EFI_SUCCESS;
2166 }
EFI Development Kit II mirror for PVE