]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
projects / mirror_edk2.git / blob
? search:


5593b6eeb5c47649d1766febdee885d6c855cbf6
[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 InsertTailList (MapExpressionList, &CurrentExpression->Link);
1178 if (Scope == 0) {
1179 SingleOpCodeExpression = TRUE;
1180 }
1181 }
1182 ASSERT (CurrentExpression != NULL);
1183 InsertTailList (&CurrentExpression->OpCodeListHead, &ExpressionOpCode->Link);
1184 if (Operand == EFI_IFR_MAP_OP) {
1185 //
1186 // Store current Map Expression List.
1187 //
1188 if (MapExpressionList != NULL) {
1189 PushMapExpressionList (MapExpressionList);
1190 }
1191 //
1192 // Initialize new Map Expression List.
1193 //
1194 MapExpressionList = &ExpressionOpCode->MapExpressionList;
1195 InitializeListHead (MapExpressionList);
1196 //
1197 // Store current expression.
1198 //
1199 PushCurrentExpression (CurrentExpression);
1200 CurrentExpression = NULL;
1201 MapScopeDepth ++;
1202 } else if (SingleOpCodeExpression) {
1203 //
1204 // There are two cases to indicate the end of an Expression:
1205 // for single OpCode expression: one Expression OpCode
1206 // for expression consists of more than one OpCode: EFI_IFR_END
1207 //
1208 SingleOpCodeExpression = FALSE;
1209
1210 if (mInScopeDisable && CurrentForm == NULL) {
1211 //
1212 // This is DisableIf expression for Form, it should be a constant expression
1213 //
1214 Status = EvaluateExpression (FormSet, CurrentForm, CurrentExpression);
1215 if (EFI_ERROR (Status)) {
1216 return Status;
1217 }
1218
1219 if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {
1220 return EFI_INVALID_PARAMETER;
1221 }
1222
1223 OpCodeDisabled = CurrentExpression->Result.Value.b;
1224 }
1225
1226 CurrentExpression = NULL;
1227 }
1228
1229 continue;
1230 }
1231
1232 //
1233 // Parse the Opcode
1234 //
1235 switch (Operand) {
1236
1237 case EFI_IFR_FORM_SET_OP:
1238 //
1239 // Check the formset GUID
1240 //
1241 if (CompareMem (&FormSet->Guid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID)) != 0) {
1242 return EFI_INVALID_PARAMETER;
1243 }
1244
1245 CopyMem (&FormSet->FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
1246 CopyMem (&FormSet->Help, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
1247
1248 if (OpCodeLength > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
1249 //
1250 // The formset OpCode contains ClassGuid
1251 //
1252 FormSet->NumberOfClassGuid = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
1253 CopyMem (FormSet->ClassGuid, OpCodeData + sizeof (EFI_IFR_FORM_SET), FormSet->NumberOfClassGuid * sizeof (EFI_GUID));
1254 }
1255
1256 InitializeListHead (&FormSet->ExpressionListHead);
1257 break;
1258
1259 case EFI_IFR_FORM_OP:
1260 //
1261 // Create a new Form for this FormSet
1262 //
1263 CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));
1264 ASSERT (CurrentForm != NULL);
1265 CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;
1266 InitializeListHead (&CurrentForm->ExpressionListHead);
1267 InitializeListHead (&CurrentForm->StatementListHead);
1268
1269 CurrentForm->FormType = STANDARD_MAP_FORM_TYPE;
1270 CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));
1271 CopyMem (&CurrentForm->FormTitle, &((EFI_IFR_FORM *) OpCodeData)->FormTitle, sizeof (EFI_STRING_ID));
1272
1273 if (InScopeFormSuppress) {
1274 //
1275 // Form is inside of suppressif
1276 //
1277 CurrentForm->SuppressExpression = FormSuppressExpression;
1278 }
1279
1280 if (Scope != 0) {
1281 //
1282 // Enter scope of a Form, suppressif will be used for Question or Option
1283 //
1284 SuppressForQuestion = TRUE;
1285 }
1286
1287 //
1288 // Insert into Form list of this FormSet
1289 //
1290 InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);
1291 break;
1292
1293 case EFI_IFR_FORM_MAP_OP:
1294 //
1295 // Create a new Form for this FormSet
1296 //
1297 CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));
1298 ASSERT (CurrentForm != NULL);
1299 CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;
1300 InitializeListHead (&CurrentForm->ExpressionListHead);
1301 InitializeListHead (&CurrentForm->StatementListHead);
1302 CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));
1303
1304 MapMethod = (EFI_IFR_FORM_MAP_METHOD *) (OpCodeData + sizeof (EFI_IFR_FORM_MAP));
1305 //
1306 // FormMap Form must contain at least one Map Method.
1307 //
1308 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length < ((UINTN) (UINT8 *) (MapMethod + 1) - (UINTN) OpCodeData)) {
1309 return EFI_INVALID_PARAMETER;
1310 }
1311 //
1312 // Try to find the standard form map method.
1313 //
1314 while (((UINTN) (UINT8 *) MapMethod - (UINTN) OpCodeData) < ((EFI_IFR_OP_HEADER *) OpCodeData)->Length) {
1315 if (CompareGuid ((EFI_GUID *) (VOID *) &MapMethod->MethodIdentifier, &gEfiHiiStandardFormGuid)) {
1316 CopyMem (&CurrentForm->FormTitle, &MapMethod->MethodTitle, sizeof (EFI_STRING_ID));
1317 CurrentForm->FormType = STANDARD_MAP_FORM_TYPE;
1318 break;
1319 }
1320 MapMethod ++;
1321 }
1322 //
1323 // If the standard form map method is not found, the first map method title will be used.
1324 //
1325 if (CurrentForm->FormTitle == 0) {
1326 MapMethod = (EFI_IFR_FORM_MAP_METHOD *) (OpCodeData + sizeof (EFI_IFR_FORM_MAP));
1327 CopyMem (&CurrentForm->FormTitle, &MapMethod->MethodTitle, sizeof (EFI_STRING_ID));
1328 }
1329
1330 if (InScopeFormSuppress) {
1331 //
1332 // Form is inside of suppressif
1333 //
1334 CurrentForm->SuppressExpression = FormSuppressExpression;
1335 }
1336
1337 if (Scope != 0) {
1338 //
1339 // Enter scope of a Form, suppressif will be used for Question or Option
1340 //
1341 SuppressForQuestion = TRUE;
1342 }
1343
1344 //
1345 // Insert into Form list of this FormSet
1346 //
1347 InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);
1348 break;
1349
1350 //
1351 // Storage
1352 //
1353 case EFI_IFR_VARSTORE_OP:
1354 //
1355 // Create a buffer Storage for this FormSet
1356 //
1357 Storage = CreateStorage (FormSet);
1358 Storage->Type = EFI_HII_VARSTORE_BUFFER;
1359
1360 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1361 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE *) OpCodeData)->Guid, sizeof (EFI_GUID));
1362 CopyMem (&Storage->Size, &((EFI_IFR_VARSTORE *) OpCodeData)->Size, sizeof (UINT16));
1363
1364 Storage->Buffer = AllocateZeroPool (Storage->Size);
1365 Storage->EditBuffer = AllocateZeroPool (Storage->Size);
1366
1367 AsciiString = (CHAR8 *) ((EFI_IFR_VARSTORE *) OpCodeData)->Name;
1368 Storage->Name = AllocateZeroPool (AsciiStrSize (AsciiString) * 2);
1369 ASSERT (Storage->Name != NULL);
1370 for (Index = 0; AsciiString[Index] != 0; Index++) {
1371 Storage->Name[Index] = (CHAR16) AsciiString[Index];
1372 }
1373
1374 //
1375 // Initialize <ConfigHdr>
1376 //
1377 InitializeConfigHdr (FormSet, Storage);
1378 break;
1379
1380 case EFI_IFR_VARSTORE_NAME_VALUE_OP:
1381 //
1382 // Create a name/value Storage for this FormSet
1383 //
1384 Storage = CreateStorage (FormSet);
1385 Storage->Type = EFI_HII_VARSTORE_NAME_VALUE;
1386
1387 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1388 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->Guid, sizeof (EFI_GUID));
1389
1390 //
1391 // Initialize <ConfigHdr>
1392 //
1393 InitializeConfigHdr (FormSet, Storage);
1394 break;
1395
1396 case EFI_IFR_VARSTORE_EFI_OP:
1397 //
1398 // Create a EFI variable Storage for this FormSet
1399 //
1400 Storage = CreateStorage (FormSet);
1401 Storage->Type = EFI_HII_VARSTORE_EFI_VARIABLE;
1402
1403 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
1404 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Guid, sizeof (EFI_GUID));
1405 CopyMem (&Storage->Attributes, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Attributes, sizeof (UINT32));
1406 break;
1407
1408 //
1409 // DefaultStore
1410 //
1411 case EFI_IFR_DEFAULTSTORE_OP:
1412 DefaultStore = AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE));
1413 ASSERT (DefaultStore != NULL);
1414 DefaultStore->Signature = FORMSET_DEFAULTSTORE_SIGNATURE;
1415
1416 CopyMem (&DefaultStore->DefaultId, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultId, sizeof (UINT16));
1417 CopyMem (&DefaultStore->DefaultName, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultName, sizeof (EFI_STRING_ID));
1418
1419 //
1420 // Insert to DefaultStore list of this Formset
1421 //
1422 InsertTailList (&FormSet->DefaultStoreListHead, &DefaultStore->Link);
1423 break;
1424
1425 //
1426 // Statements
1427 //
1428 case EFI_IFR_SUBTITLE_OP:
1429 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1430 ASSERT (CurrentStatement != NULL);
1431
1432 CurrentStatement->Flags = ((EFI_IFR_SUBTITLE *) OpCodeData)->Flags;
1433
1434 if (Scope != 0) {
1435 mInScopeSubtitle = TRUE;
1436 }
1437 break;
1438
1439 case EFI_IFR_TEXT_OP:
1440 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1441 ASSERT (CurrentStatement != NULL);
1442
1443 CopyMem (&CurrentStatement->TextTwo, &((EFI_IFR_TEXT *) OpCodeData)->TextTwo, sizeof (EFI_STRING_ID));
1444 break;
1445
1446 case EFI_IFR_RESET_BUTTON_OP:
1447 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
1448 ASSERT (CurrentStatement != NULL);
1449 CopyMem (&CurrentStatement->DefaultId, &((EFI_IFR_RESET_BUTTON *) OpCodeData)->DefaultId, sizeof (EFI_DEFAULT_ID));
1450 break;
1451
1452 //
1453 // Questions
1454 //
1455 case EFI_IFR_ACTION_OP:
1456 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1457 ASSERT (CurrentStatement != NULL);
1458 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_ACTION;
1459
1460 if (OpCodeLength == sizeof (EFI_IFR_ACTION_1)) {
1461 //
1462 // No QuestionConfig present, so no configuration string will be processed
1463 //
1464 CurrentStatement->QuestionConfig = 0;
1465 } else {
1466 CopyMem (&CurrentStatement->QuestionConfig, &((EFI_IFR_ACTION *) OpCodeData)->QuestionConfig, sizeof (EFI_STRING_ID));
1467 }
1468 break;
1469
1470 case EFI_IFR_REF_OP:
1471 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1472 ASSERT (CurrentStatement != NULL);
1473 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_UNDEFINED;
1474 CopyMem (&CurrentStatement->RefFormId, &((EFI_IFR_REF *) OpCodeData)->FormId, sizeof (EFI_FORM_ID));
1475 if (OpCodeLength >= sizeof (EFI_IFR_REF2)) {
1476 CopyMem (&CurrentStatement->RefQuestionId, &((EFI_IFR_REF2 *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
1477
1478 if (OpCodeLength >= sizeof (EFI_IFR_REF3)) {
1479 CopyMem (&CurrentStatement->RefFormSetId, &((EFI_IFR_REF3 *) OpCodeData)->FormSetId, sizeof (EFI_GUID));
1480
1481 if (OpCodeLength >= sizeof (EFI_IFR_REF4)) {
1482 CopyMem (&CurrentStatement->RefDevicePath, &((EFI_IFR_REF4 *) OpCodeData)->DevicePath, sizeof (EFI_STRING_ID));
1483 }
1484 }
1485 }
1486 break;
1487
1488 case EFI_IFR_ONE_OF_OP:
1489 case EFI_IFR_NUMERIC_OP:
1490 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1491 ASSERT(CurrentStatement != NULL);
1492
1493 CurrentStatement->Flags = ((EFI_IFR_ONE_OF *) OpCodeData)->Flags;
1494 Value = &CurrentStatement->HiiValue;
1495
1496 switch (CurrentStatement->Flags & EFI_IFR_NUMERIC_SIZE) {
1497 case EFI_IFR_NUMERIC_SIZE_1:
1498 CurrentStatement->Minimum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MinValue;
1499 CurrentStatement->Maximum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MaxValue;
1500 CurrentStatement->Step = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.Step;
1501 CurrentStatement->StorageWidth = sizeof (UINT8);
1502 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
1503 break;
1504
1505 case EFI_IFR_NUMERIC_SIZE_2:
1506 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MinValue, sizeof (UINT16));
1507 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MaxValue, sizeof (UINT16));
1508 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.Step, sizeof (UINT16));
1509 CurrentStatement->StorageWidth = sizeof (UINT16);
1510 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
1511 break;
1512
1513 case EFI_IFR_NUMERIC_SIZE_4:
1514 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MinValue, sizeof (UINT32));
1515 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MaxValue, sizeof (UINT32));
1516 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.Step, sizeof (UINT32));
1517 CurrentStatement->StorageWidth = sizeof (UINT32);
1518 Value->Type = EFI_IFR_TYPE_NUM_SIZE_32;
1519 break;
1520
1521 case EFI_IFR_NUMERIC_SIZE_8:
1522 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MinValue, sizeof (UINT64));
1523 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MaxValue, sizeof (UINT64));
1524 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.Step, sizeof (UINT64));
1525 CurrentStatement->StorageWidth = sizeof (UINT64);
1526 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1527 break;
1528
1529 default:
1530 break;
1531 }
1532
1533 InitializeRequestElement (FormSet, CurrentStatement);
1534
1535 if ((Operand == EFI_IFR_ONE_OF_OP) && Scope != 0) {
1536 SuppressForOption = TRUE;
1537 }
1538 break;
1539
1540 case EFI_IFR_ORDERED_LIST_OP:
1541 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1542 ASSERT(CurrentStatement != NULL);
1543
1544 CurrentStatement->Flags = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->Flags;
1545 CurrentStatement->MaxContainers = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;
1546
1547 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BUFFER;
1548 CurrentStatement->BufferValue = NULL;
1549
1550 if (Scope != 0) {
1551 SuppressForOption = TRUE;
1552 }
1553 break;
1554
1555 case EFI_IFR_CHECKBOX_OP:
1556 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1557 ASSERT(CurrentStatement != NULL);
1558
1559 CurrentStatement->Flags = ((EFI_IFR_CHECKBOX *) OpCodeData)->Flags;
1560 CurrentStatement->StorageWidth = sizeof (BOOLEAN);
1561 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BOOLEAN;
1562
1563 InitializeRequestElement (FormSet, CurrentStatement);
1564
1565 break;
1566
1567 case EFI_IFR_STRING_OP:
1568 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1569 ASSERT (CurrentStatement != NULL);
1570 //
1571 // MinSize is the minimum number of characters that can be accepted for this opcode,
1572 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1573 // The characters are stored as Unicode, so the storage width should multiply 2.
1574 //
1575 CurrentStatement->Minimum = ((EFI_IFR_STRING *) OpCodeData)->MinSize;
1576 CurrentStatement->Maximum = ((EFI_IFR_STRING *) OpCodeData)->MaxSize;
1577 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (CHAR16));
1578 CurrentStatement->Flags = ((EFI_IFR_STRING *) OpCodeData)->Flags;
1579
1580 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
1581 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth + sizeof (CHAR16));
1582
1583 InitializeRequestElement (FormSet, CurrentStatement);
1584 break;
1585
1586 case EFI_IFR_PASSWORD_OP:
1587 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1588 ASSERT (CurrentStatement != NULL);
1589 //
1590 // MinSize is the minimum number of characters that can be accepted for this opcode,
1591 // MaxSize is the maximum number of characters that can be accepted for this opcode.
1592 // The characters are stored as Unicode, so the storage width should multiply 2.
1593 //
1594 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_PASSWORD *) OpCodeData)->MinSize, sizeof (UINT16));
1595 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_PASSWORD *) OpCodeData)->MaxSize, sizeof (UINT16));
1596 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (CHAR16));
1597
1598 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
1599 CurrentStatement->BufferValue = AllocateZeroPool ((CurrentStatement->StorageWidth + sizeof (CHAR16)));
1600
1601 InitializeRequestElement (FormSet, CurrentStatement);
1602 break;
1603
1604 case EFI_IFR_DATE_OP:
1605 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1606 ASSERT(CurrentStatement != NULL);
1607
1608 CurrentStatement->Flags = ((EFI_IFR_DATE *) OpCodeData)->Flags;
1609 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_DATE;
1610
1611 if ((CurrentStatement->Flags & EFI_QF_DATE_STORAGE) == QF_DATE_STORAGE_NORMAL) {
1612 CurrentStatement->StorageWidth = sizeof (EFI_HII_DATE);
1613
1614 InitializeRequestElement (FormSet, CurrentStatement);
1615 } else {
1616 //
1617 // Don't assign storage for RTC type of date/time
1618 //
1619 CurrentStatement->Storage = NULL;
1620 CurrentStatement->StorageWidth = 0;
1621 }
1622 break;
1623
1624 case EFI_IFR_TIME_OP:
1625 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
1626 ASSERT(CurrentStatement != NULL);
1627
1628 CurrentStatement->Flags = ((EFI_IFR_TIME *) OpCodeData)->Flags;
1629 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_TIME;
1630
1631 if ((CurrentStatement->Flags & QF_TIME_STORAGE) == QF_TIME_STORAGE_NORMAL) {
1632 CurrentStatement->StorageWidth = sizeof (EFI_IFR_TIME);
1633
1634 InitializeRequestElement (FormSet, CurrentStatement);
1635 } else {
1636 //
1637 // Don't assign storage for RTC type of date/time
1638 //
1639 CurrentStatement->Storage = NULL;
1640 CurrentStatement->StorageWidth = 0;
1641 }
1642 break;
1643
1644 //
1645 // Default
1646 //
1647 case EFI_IFR_DEFAULT_OP:
1648 //
1649 // EFI_IFR_DEFAULT appear in scope of a Question,
1650 // It creates a default value for the current question.
1651 // A Question may have more than one Default value which have different default types.
1652 //
1653 CurrentDefault = AllocateZeroPool (sizeof (QUESTION_DEFAULT));
1654 ASSERT (CurrentDefault != NULL);
1655 CurrentDefault->Signature = QUESTION_DEFAULT_SIGNATURE;
1656
1657 CurrentDefault->Value.Type = ((EFI_IFR_DEFAULT *) OpCodeData)->Type;
1658 CopyMem (&CurrentDefault->DefaultId, &((EFI_IFR_DEFAULT *) OpCodeData)->DefaultId, sizeof (UINT16));
1659 CopyMem (&CurrentDefault->Value.Value, &((EFI_IFR_DEFAULT *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
1660 ExtendValueToU64 (&CurrentDefault->Value);
1661
1662 //
1663 // Insert to Default Value list of current Question
1664 //
1665 InsertTailList (&CurrentStatement->DefaultListHead, &CurrentDefault->Link);
1666
1667 if (Scope != 0) {
1668 InScopeDefault = TRUE;
1669 }
1670 break;
1671
1672 //
1673 // Option
1674 //
1675 case EFI_IFR_ONE_OF_OPTION_OP:
1676 //
1677 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
1678 // It create a selection for use in current Question.
1679 //
1680 CurrentOption = AllocateZeroPool (sizeof (QUESTION_OPTION));
1681 ASSERT (CurrentOption != NULL);
1682 CurrentOption->Signature = QUESTION_OPTION_SIGNATURE;
1683
1684 CurrentOption->Flags = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags;
1685 CurrentOption->Value.Type = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Type;
1686 CopyMem (&CurrentOption->Text, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Option, sizeof (EFI_STRING_ID));
1687 CopyMem (&CurrentOption->Value.Value, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
1688 ExtendValueToU64 (&CurrentOption->Value);
1689
1690 if (InScopeOptionSuppress) {
1691 CurrentOption->SuppressExpression = OptionSuppressExpression;
1692 }
1693
1694 //
1695 // Insert to Option list of current Question
1696 //
1697 InsertTailList (&CurrentStatement->OptionListHead, &CurrentOption->Link);
1698
1699 //
1700 // Now we know the Storage width of nested Ordered List
1701 //
1702 ASSERT (CurrentStatement != NULL);
1703 if ((CurrentStatement->Operand == EFI_IFR_ORDERED_LIST_OP) && (CurrentStatement->BufferValue == NULL)) {
1704 Width = 1;
1705 switch (CurrentOption->Value.Type) {
1706 case EFI_IFR_TYPE_NUM_SIZE_8:
1707 Width = 1;
1708 break;
1709
1710 case EFI_IFR_TYPE_NUM_SIZE_16:
1711 Width = 2;
1712 break;
1713
1714 case EFI_IFR_TYPE_NUM_SIZE_32:
1715 Width = 4;
1716 break;
1717
1718 case EFI_IFR_TYPE_NUM_SIZE_64:
1719 Width = 8;
1720 break;
1721
1722 default:
1723 //
1724 // Invalid type for Ordered List
1725 //
1726 break;
1727 }
1728
1729 CurrentStatement->StorageWidth = (UINT16) (CurrentStatement->MaxContainers * Width);
1730 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
1731 CurrentStatement->ValueType = CurrentOption->Value.Type;
1732
1733 InitializeRequestElement (FormSet, CurrentStatement);
1734 }
1735 break;
1736
1737 //
1738 // Conditional
1739 //
1740 case EFI_IFR_NO_SUBMIT_IF_OP:
1741 case EFI_IFR_INCONSISTENT_IF_OP:
1742 //
1743 // Create an Expression node
1744 //
1745 CurrentExpression = CreateExpression (CurrentForm);
1746 CopyMem (&CurrentExpression->Error, &((EFI_IFR_INCONSISTENT_IF *) OpCodeData)->Error, sizeof (EFI_STRING_ID));
1747
1748 if (Operand == EFI_IFR_NO_SUBMIT_IF_OP) {
1749 CurrentExpression->Type = EFI_HII_EXPRESSION_NO_SUBMIT_IF;
1750 InsertTailList (&CurrentStatement->NoSubmitListHead, &CurrentExpression->Link);
1751 } else {
1752 CurrentExpression->Type = EFI_HII_EXPRESSION_INCONSISTENT_IF;
1753 InsertTailList (&CurrentStatement->InconsistentListHead, &CurrentExpression->Link);
1754 }
1755
1756 //
1757 // Take a look at next OpCode to see whether current expression consists
1758 // of single OpCode
1759 //
1760 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1761 SingleOpCodeExpression = TRUE;
1762 }
1763 break;
1764
1765 case EFI_IFR_SUPPRESS_IF_OP:
1766 //
1767 // Question and Option will appear in scope of this OpCode
1768 //
1769 CurrentExpression = CreateExpression (CurrentForm);
1770 CurrentExpression->Type = EFI_HII_EXPRESSION_SUPPRESS_IF;
1771
1772 if (CurrentForm == NULL) {
1773 InsertTailList (&FormSet->ExpressionListHead, &CurrentExpression->Link);
1774 } else {
1775 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1776 }
1777
1778 if (SuppressForOption) {
1779 InScopeOptionSuppress = TRUE;
1780 OptionSuppressExpression = CurrentExpression;
1781 } else if (SuppressForQuestion) {
1782 mInScopeSuppress = TRUE;
1783 mSuppressExpression = CurrentExpression;
1784 } else {
1785 InScopeFormSuppress = TRUE;
1786 FormSuppressExpression = CurrentExpression;
1787 }
1788
1789 //
1790 // Take a look at next OpCode to see whether current expression consists
1791 // of single OpCode
1792 //
1793 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1794 SingleOpCodeExpression = TRUE;
1795 }
1796 break;
1797
1798 case EFI_IFR_GRAY_OUT_IF_OP:
1799 //
1800 // Questions will appear in scope of this OpCode
1801 //
1802 CurrentExpression = CreateExpression (CurrentForm);
1803 CurrentExpression->Type = EFI_HII_EXPRESSION_GRAY_OUT_IF;
1804 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1805
1806 mInScopeGrayOut = TRUE;
1807 mGrayOutExpression = CurrentExpression;
1808
1809 //
1810 // Take a look at next OpCode to see whether current expression consists
1811 // of single OpCode
1812 //
1813 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1814 SingleOpCodeExpression = TRUE;
1815 }
1816 break;
1817
1818 case EFI_IFR_DISABLE_IF_OP:
1819 //
1820 // The DisableIf expression should only rely on constant, so it could be
1821 // evaluated at initialization and it will not be queued
1822 //
1823 CurrentExpression = AllocateZeroPool (sizeof (FORM_EXPRESSION));
1824 ASSERT (CurrentExpression != NULL);
1825 CurrentExpression->Signature = FORM_EXPRESSION_SIGNATURE;
1826 CurrentExpression->Type = EFI_HII_EXPRESSION_DISABLE_IF;
1827 InitializeListHead (&CurrentExpression->OpCodeListHead);
1828
1829 if (CurrentForm != NULL) {
1830 //
1831 // This is DisableIf for Question, enqueue it to Form expression list
1832 //
1833 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1834 }
1835
1836 mDisableExpression = CurrentExpression;
1837 mInScopeDisable = TRUE;
1838 OpCodeDisabled = FALSE;
1839
1840 //
1841 // Take a look at next OpCode to see whether current expression consists
1842 // of single OpCode
1843 //
1844 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1845 SingleOpCodeExpression = TRUE;
1846 }
1847 break;
1848
1849 //
1850 // Expression
1851 //
1852 case EFI_IFR_VALUE_OP:
1853 CurrentExpression = CreateExpression (CurrentForm);
1854 CurrentExpression->Type = EFI_HII_EXPRESSION_VALUE;
1855 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1856
1857 if (InScopeDefault) {
1858 //
1859 // Used for default (EFI_IFR_DEFAULT)
1860 //
1861 CurrentDefault->ValueExpression = CurrentExpression;
1862 } else {
1863 //
1864 // If used for a question, then the question will be read-only
1865 //
1866 //
1867 // Make sure CurrentStatement is not NULL.
1868 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1869 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1870 //
1871 ASSERT (CurrentStatement != NULL);
1872 CurrentStatement->ValueExpression = CurrentExpression;
1873 }
1874
1875 //
1876 // Take a look at next OpCode to see whether current expression consists
1877 // of single OpCode
1878 //
1879 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1880 SingleOpCodeExpression = TRUE;
1881 }
1882 break;
1883
1884 case EFI_IFR_RULE_OP:
1885 CurrentExpression = CreateExpression (CurrentForm);
1886 CurrentExpression->Type = EFI_HII_EXPRESSION_RULE;
1887
1888 CurrentExpression->RuleId = ((EFI_IFR_RULE *) OpCodeData)->RuleId;
1889 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1890
1891 //
1892 // Take a look at next OpCode to see whether current expression consists
1893 // of single OpCode
1894 //
1895 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1896 SingleOpCodeExpression = TRUE;
1897 }
1898 break;
1899
1900 case EFI_IFR_READ_OP:
1901 CurrentExpression = CreateExpression (CurrentForm);
1902 CurrentExpression->Type = EFI_HII_EXPRESSION_READ;
1903 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1904
1905 //
1906 // Make sure CurrentStatement is not NULL.
1907 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1908 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1909 //
1910 ASSERT (CurrentStatement != NULL);
1911 CurrentStatement->ReadExpression = CurrentExpression;
1912
1913 //
1914 // Take a look at next OpCode to see whether current expression consists
1915 // of single OpCode
1916 //
1917 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1918 SingleOpCodeExpression = TRUE;
1919 }
1920 break;
1921
1922 case EFI_IFR_WRITE_OP:
1923 CurrentExpression = CreateExpression (CurrentForm);
1924 CurrentExpression->Type = EFI_HII_EXPRESSION_WRITE;
1925 InsertTailList (&CurrentForm->ExpressionListHead, &CurrentExpression->Link);
1926
1927 //
1928 // Make sure CurrentStatement is not NULL.
1929 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1930 // file is wrongly generated by tools such as VFR Compiler. There may be a bug in VFR Compiler.
1931 //
1932 ASSERT (CurrentStatement != NULL);
1933 CurrentStatement->WriteExpression = CurrentExpression;
1934
1935 //
1936 // Take a look at next OpCode to see whether current expression consists
1937 // of single OpCode
1938 //
1939 if (((EFI_IFR_OP_HEADER *) (OpCodeData + OpCodeLength))->Scope == 0) {
1940 SingleOpCodeExpression = TRUE;
1941 }
1942 break;
1943
1944 //
1945 // Image
1946 //
1947 case EFI_IFR_IMAGE_OP:
1948 //
1949 // Get ScopeOpcode from top of stack
1950 //
1951 PopScope (&ScopeOpCode);
1952 PushScope (ScopeOpCode);
1953
1954 switch (ScopeOpCode) {
1955 case EFI_IFR_FORM_SET_OP:
1956 ImageId = &FormSet->ImageId;
1957 break;
1958
1959 case EFI_IFR_FORM_OP:
1960 case EFI_IFR_FORM_MAP_OP:
1961 ASSERT (CurrentForm != NULL);
1962 ImageId = &CurrentForm->ImageId;
1963 break;
1964
1965 case EFI_IFR_ONE_OF_OPTION_OP:
1966 ImageId = &CurrentOption->ImageId;
1967 break;
1968
1969 default:
1970 //
1971 // Make sure CurrentStatement is not NULL.
1972 // If it is NULL, 1) ParseOpCodes functions may parse the IFR wrongly. Or 2) the IFR
1973 // file is wrongly generated by tools such as VFR Compiler.
1974 //
1975 ASSERT (CurrentStatement != NULL);
1976 ImageId = &CurrentStatement->ImageId;
1977 break;
1978 }
1979
1980 ASSERT (ImageId != NULL);
1981 CopyMem (ImageId, &((EFI_IFR_IMAGE *) OpCodeData)->Id, sizeof (EFI_IMAGE_ID));
1982 break;
1983
1984 //
1985 // Refresh
1986 //
1987 case EFI_IFR_REFRESH_OP:
1988 ASSERT (CurrentStatement != NULL);
1989 CurrentStatement->RefreshInterval = ((EFI_IFR_REFRESH *) OpCodeData)->RefreshInterval;
1990 break;
1991
1992 //
1993 // Vendor specific
1994 //
1995 case EFI_IFR_GUID_OP:
1996 if (CompareGuid (&gEfiIfrTianoGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
1997 //
1998 // Tiano specific GUIDed opcodes
1999 //
2000 switch (((EFI_IFR_GUID_LABEL *) OpCodeData)->ExtendOpCode) {
2001 case EFI_IFR_EXTEND_OP_LABEL:
2002 //
2003 // just ignore label
2004 //
2005 break;
2006
2007 case EFI_IFR_EXTEND_OP_BANNER:
2008 //
2009 // By SubClass to get Banner Data from Front Page
2010 //
2011 if (FormSet->SubClass == EFI_FRONT_PAGE_SUBCLASS) {
2012 CopyMem (
2013 &gBannerData->Banner[((EFI_IFR_GUID_BANNER *) OpCodeData)->LineNumber][
2014 ((EFI_IFR_GUID_BANNER *) OpCodeData)->Alignment],
2015 &((EFI_IFR_GUID_BANNER *) OpCodeData)->Title,
2016 sizeof (EFI_STRING_ID)
2017 );
2018 }
2019 break;
2020
2021 case EFI_IFR_EXTEND_OP_CLASS:
2022 CopyMem (&FormSet->Class, &((EFI_IFR_GUID_CLASS *) OpCodeData)->Class, sizeof (UINT16));
2023 break;
2024
2025 case EFI_IFR_EXTEND_OP_SUBCLASS:
2026 CopyMem (&FormSet->SubClass, &((EFI_IFR_GUID_SUBCLASS *) OpCodeData)->SubClass, sizeof (UINT16));
2027 break;
2028
2029 default:
2030 break;
2031 }
2032 }
2033
2034 break;
2035
2036 //
2037 // Scope End
2038 //
2039 case EFI_IFR_END_OP:
2040 Status = PopScope (&ScopeOpCode);
2041 if (EFI_ERROR (Status)) {
2042 ResetScopeStack ();
2043 return Status;
2044 }
2045
2046 switch (ScopeOpCode) {
2047 case EFI_IFR_FORM_SET_OP:
2048 //
2049 // End of FormSet, update FormSet IFR binary length
2050 // to stop parsing substantial OpCodes
2051 //
2052 FormSet->IfrBinaryLength = OpCodeOffset;
2053 break;
2054
2055 case EFI_IFR_FORM_OP:
2056 case EFI_IFR_FORM_MAP_OP:
2057 //
2058 // End of Form
2059 //
2060 CurrentForm = NULL;
2061 SuppressForQuestion = FALSE;
2062 break;
2063
2064 case EFI_IFR_ONE_OF_OPTION_OP:
2065 //
2066 // End of Option
2067 //
2068 CurrentOption = NULL;
2069 break;
2070
2071 case EFI_IFR_SUBTITLE_OP:
2072 mInScopeSubtitle = FALSE;
2073 break;
2074
2075 case EFI_IFR_NO_SUBMIT_IF_OP:
2076 case EFI_IFR_INCONSISTENT_IF_OP:
2077 //
2078 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
2079 //
2080 break;
2081
2082 case EFI_IFR_SUPPRESS_IF_OP:
2083 if (SuppressForOption) {
2084 InScopeOptionSuppress = FALSE;
2085 } else if (SuppressForQuestion) {
2086 mInScopeSuppress = FALSE;
2087 } else {
2088 InScopeFormSuppress = FALSE;
2089 }
2090 break;
2091
2092 case EFI_IFR_GRAY_OUT_IF_OP:
2093 mInScopeGrayOut = FALSE;
2094 break;
2095
2096 case EFI_IFR_DISABLE_IF_OP:
2097 mInScopeDisable = FALSE;
2098 OpCodeDisabled = FALSE;
2099 break;
2100
2101 case EFI_IFR_ONE_OF_OP:
2102 case EFI_IFR_ORDERED_LIST_OP:
2103 SuppressForOption = FALSE;
2104 break;
2105
2106 case EFI_IFR_DEFAULT_OP:
2107 InScopeDefault = FALSE;
2108 break;
2109
2110 case EFI_IFR_MAP_OP:
2111 //
2112 // Get current Map Expression List.
2113 //
2114 Status = PopMapExpressionList ((VOID **) &MapExpressionList);
2115 if (Status == EFI_ACCESS_DENIED) {
2116 MapExpressionList = NULL;
2117 }
2118 //
2119 // Get current expression.
2120 //
2121 Status = PopCurrentExpression ((VOID **) &CurrentExpression);
2122 ASSERT_EFI_ERROR (Status);
2123 MapScopeDepth --;
2124 break;
2125
2126 default:
2127 if (IsExpressionOpCode (ScopeOpCode)) {
2128 if (mInScopeDisable && CurrentForm == NULL) {
2129 //
2130 // This is DisableIf expression for Form, it should be a constant expression
2131 //
2132 ASSERT (CurrentExpression != NULL);
2133 Status = EvaluateExpression (FormSet, CurrentForm, CurrentExpression);
2134 if (EFI_ERROR (Status)) {
2135 return Status;
2136 }
2137
2138 if (CurrentExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN) {
2139 return EFI_INVALID_PARAMETER;
2140 }
2141
2142 OpCodeDisabled = CurrentExpression->Result.Value.b;
2143 //
2144 // DisableIf Expression is only used once and not queued, free it
2145 //
2146 DestroyExpression (CurrentExpression);
2147 }
2148
2149 //
2150 // End of current Expression
2151 //
2152 CurrentExpression = NULL;
2153 }
2154 break;
2155 }
2156 break;
2157
2158 default:
2159 break;
2160 }
2161 }
2162
2163 return EFI_SUCCESS;
2164 }
EFI Development Kit II mirror for PVE