]> git.proxmox.com Git - mirror_edk2.git/blob - EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/UefiIfrParser.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Support Name/Value Storage in UEFI2.1 HII driver.
[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiOnUefiHiiThunk / UefiIfrParser.c
1 /** @file
2 Parser for IFR binary encoding.
3
4 Copyright (c) 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
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 "HiiDatabase.h"
16
17 #include "UefiIfrParserExpression.h"
18
19 UINT16 mStatementIndex;
20
21 BOOLEAN mInScopeSubtitle;
22 BOOLEAN mInScopeSuppress;
23 BOOLEAN mInScopeGrayOut;
24
25 EFI_GUID mFrameworkHiiCompatibilityGuid = EFI_IFR_FRAMEWORK_GUID;
26 extern EFI_GUID mTianoHiiIfrGuid;
27
28 LIST_ENTRY *
29 GetOneOfOptionMapEntryListHead (
30 IN CONST FORM_BROWSER_FORMSET *FormSet,
31 IN UINT16 QuestionId
32 )
33 {
34 LIST_ENTRY *Link;
35 ONE_OF_OPTION_MAP *Map;
36
37 Link = GetFirstNode (&FormSet->OneOfOptionMapListHead);
38
39 while (!IsNull (&FormSet->OneOfOptionMapListHead, Link)) {
40 Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);
41 if (QuestionId == Map->QuestionId) {
42 return &Map->OneOfOptionMapEntryListHead;
43 }
44 Link = GetNextNode (&FormSet->OneOfOptionMapListHead, Link);
45 }
46
47 return NULL;
48 }
49
50 VOID
51 DestoryOneOfOptionMap (
52 IN LIST_ENTRY *OneOfOptionMapListHead
53 )
54 {
55 ONE_OF_OPTION_MAP *Map;
56 ONE_OF_OPTION_MAP_ENTRY *MapEntry;
57 LIST_ENTRY *Link;
58 LIST_ENTRY *Link2;
59
60 while (!IsListEmpty (OneOfOptionMapListHead)) {
61 Link = GetFirstNode (OneOfOptionMapListHead);
62
63 Map = ONE_OF_OPTION_MAP_FROM_LINK (Link);
64
65 while (!IsListEmpty (&Map->OneOfOptionMapEntryListHead)) {
66 Link2 = GetFirstNode (&Map->OneOfOptionMapEntryListHead);
67
68 MapEntry = ONE_OF_OPTION_MAP_ENTRY_FROM_LINK (Link2);
69
70 RemoveEntryList (Link2);
71
72 FreePool (MapEntry);
73 }
74
75 RemoveEntryList (Link);
76 FreePool (Map);
77 }
78 }
79
80
81 /**
82 Initialize Statement header members.
83
84 @param OpCodeData Pointer of the raw OpCode data.
85 @param FormSet Pointer of the current FormSe.
86 @param Form Pointer of the current Form.
87
88 @return The Statement.
89
90 **/
91 FORM_BROWSER_STATEMENT *
92 CreateStatement (
93 IN UINT8 *OpCodeData,
94 IN OUT FORM_BROWSER_FORMSET *FormSet,
95 IN OUT FORM_BROWSER_FORM *Form
96 )
97 {
98 FORM_BROWSER_STATEMENT *Statement;
99 EFI_IFR_STATEMENT_HEADER *StatementHdr;
100
101 if (Form == NULL) {
102 //
103 // We are currently not in a Form Scope, so just skip this Statement
104 //
105 return NULL;
106 }
107
108 Statement = &FormSet->StatementBuffer[mStatementIndex];
109 mStatementIndex++;
110
111 InitializeListHead (&Statement->DefaultListHead);
112 InitializeListHead (&Statement->OptionListHead);
113
114 Statement->Signature = FORM_BROWSER_STATEMENT_SIGNATURE;
115
116 Statement->Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;
117
118 StatementHdr = (EFI_IFR_STATEMENT_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));
119 CopyMem (&Statement->Prompt, &StatementHdr->Prompt, sizeof (EFI_STRING_ID));
120 CopyMem (&Statement->Help, &StatementHdr->Help, sizeof (EFI_STRING_ID));
121
122 Statement->InSubtitle = mInScopeSubtitle;
123
124 //
125 // Insert this Statement into current Form
126 //
127 InsertTailList (&Form->StatementListHead, &Statement->Link);
128
129 return Statement;
130 }
131
132 /**
133 Initialize Question's members.
134
135 @param OpCodeData Pointer of the raw OpCode data.
136 @param FormSet Pointer of the current FormSet.
137 @param Form Pointer of the current Form.
138
139 @return The Question.
140
141 **/
142 FORM_BROWSER_STATEMENT *
143 CreateQuestion (
144 IN UINT8 *OpCodeData,
145 IN OUT FORM_BROWSER_FORMSET *FormSet,
146 IN OUT FORM_BROWSER_FORM *Form
147 )
148 {
149 FORM_BROWSER_STATEMENT *Statement;
150 EFI_IFR_QUESTION_HEADER *QuestionHdr;
151 LIST_ENTRY *Link;
152 FORMSET_STORAGE *Storage;
153
154 Statement = CreateStatement (OpCodeData, FormSet, Form);
155 if (Statement == NULL) {
156 return NULL;
157 }
158
159 QuestionHdr = (EFI_IFR_QUESTION_HEADER *) (OpCodeData + sizeof (EFI_IFR_OP_HEADER));
160 CopyMem (&Statement->QuestionId, &QuestionHdr->QuestionId, sizeof (EFI_QUESTION_ID));
161 CopyMem (&Statement->VarStoreId, &QuestionHdr->VarStoreId, sizeof (EFI_VARSTORE_ID));
162 CopyMem (&Statement->VarStoreInfo.VarOffset, &QuestionHdr->VarStoreInfo.VarOffset, sizeof (UINT16));
163
164 if (FormSet->MaxQuestionId < QuestionHdr->QuestionId) {
165 FormSet->MaxQuestionId = QuestionHdr->QuestionId;
166 }
167
168 Statement->QuestionFlags = QuestionHdr->Flags;
169
170 if (Statement->VarStoreId == 0) {
171 //
172 // VarStoreId of zero indicates no variable storage
173 //
174 return Statement;
175 }
176
177 //
178 // Find Storage for this Question
179 //
180 Link = GetFirstNode (&FormSet->StorageListHead);
181 while (!IsNull (&FormSet->StorageListHead, Link)) {
182 Storage = FORMSET_STORAGE_FROM_LINK (Link);
183
184 if (Storage->VarStoreId == Statement->VarStoreId) {
185 Statement->Storage = Storage;
186 break;
187 }
188
189 Link = GetNextNode (&FormSet->StorageListHead, Link);
190 }
191 ASSERT (Statement->Storage != NULL);
192
193 return Statement;
194 }
195
196 /**
197 Allocate a FORMSET_STORAGE data structure and insert to FormSet Storage List.
198
199 @param FormSet Pointer of the current FormSet
200
201 @return Pointer to a FORMSET_STORAGE data structure.
202
203 **/
204 FORMSET_STORAGE *
205 CreateStorage (
206 IN FORM_BROWSER_FORMSET *FormSet
207 )
208 {
209 FORMSET_STORAGE *Storage;
210
211 Storage = AllocateZeroPool (sizeof (FORMSET_STORAGE));
212 Storage->Signature = FORMSET_STORAGE_SIGNATURE;
213 InsertTailList (&FormSet->StorageListHead, &Storage->Link);
214
215 return Storage;
216 }
217
218 /**
219 Free resources of a storage
220
221 @param Storage Pointer of the storage
222
223 @return None.
224
225 **/
226 VOID
227 DestroyStorage (
228 IN FORMSET_STORAGE *Storage
229 )
230 {
231 if (Storage == NULL) {
232 return;
233 }
234
235 if (Storage->Name!= NULL) {
236 FreePool (Storage->Name);
237 }
238
239 FreePool (Storage);
240 }
241
242
243 /**
244 Free resources of a Statement
245
246 @param Statement Pointer of the Statement
247
248 @return None.
249
250 **/
251 VOID
252 DestroyStatement (
253 IN OUT FORM_BROWSER_STATEMENT *Statement
254 )
255 {
256 LIST_ENTRY *Link;
257 QUESTION_DEFAULT *Default;
258 QUESTION_OPTION *Option;
259
260 //
261 // Free Default value List
262 //
263 while (!IsListEmpty (&Statement->DefaultListHead)) {
264 Link = GetFirstNode (&Statement->DefaultListHead);
265 Default = QUESTION_DEFAULT_FROM_LINK (Link);
266 RemoveEntryList (&Default->Link);
267
268 gBS->FreePool (Default);
269 }
270
271 //
272 // Free Options List
273 //
274 while (!IsListEmpty (&Statement->OptionListHead)) {
275 Link = GetFirstNode (&Statement->OptionListHead);
276 Option = QUESTION_OPTION_FROM_LINK (Link);
277 RemoveEntryList (&Option->Link);
278
279 gBS->FreePool (Option);
280 }
281
282 }
283
284
285
286 /**
287 Free resources of a Form
288
289 @param Form Pointer of the Form
290
291 @return None.
292
293 **/
294 VOID
295 DestroyForm (
296 IN OUT FORM_BROWSER_FORM *Form
297 )
298 {
299 LIST_ENTRY *Link;
300 FORM_BROWSER_STATEMENT *Statement;
301
302 //
303 // Free Statements/Questions
304 //
305 while (!IsListEmpty (&Form->StatementListHead)) {
306 Link = GetFirstNode (&Form->StatementListHead);
307 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
308 RemoveEntryList (&Statement->Link);
309
310 DestroyStatement (Statement);
311 }
312
313 //
314 // Free this Form
315 //
316 gBS->FreePool (Form);
317 }
318
319
320 /**
321 Free resources allocated for a FormSet
322
323 @param FormSet Pointer of the FormSet
324
325 @return None.
326
327 **/
328 VOID
329 DestroyFormSet (
330 IN OUT FORM_BROWSER_FORMSET *FormSet
331 )
332 {
333 LIST_ENTRY *Link;
334 FORMSET_STORAGE *Storage;
335 FORMSET_DEFAULTSTORE *DefaultStore;
336 FORM_BROWSER_FORM *Form;
337
338 //
339 // Free IFR binary buffer
340 //
341 FreePool (FormSet->IfrBinaryData);
342
343 //
344 // Free FormSet Storage
345 //
346 if (FormSet->StorageListHead.ForwardLink != NULL) {
347 while (!IsListEmpty (&FormSet->StorageListHead)) {
348 Link = GetFirstNode (&FormSet->StorageListHead);
349 Storage = FORMSET_STORAGE_FROM_LINK (Link);
350 RemoveEntryList (&Storage->Link);
351
352 DestroyStorage (Storage);
353 }
354 }
355
356 //
357 // Free FormSet Default Store
358 //
359 if (FormSet->DefaultStoreListHead.ForwardLink != NULL) {
360 while (!IsListEmpty (&FormSet->DefaultStoreListHead)) {
361 Link = GetFirstNode (&FormSet->DefaultStoreListHead);
362 DefaultStore = FORMSET_DEFAULTSTORE_FROM_LINK (Link);
363 RemoveEntryList (&DefaultStore->Link);
364
365 gBS->FreePool (DefaultStore);
366 }
367 }
368
369 //
370 // Free Forms
371 //
372 if (FormSet->FormListHead.ForwardLink != NULL) {
373 while (!IsListEmpty (&FormSet->FormListHead)) {
374 Link = GetFirstNode (&FormSet->FormListHead);
375 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
376 RemoveEntryList (&Form->Link);
377
378 DestroyForm (Form);
379 }
380 }
381
382 if (FormSet->StatementBuffer != NULL) {
383 FreePool (FormSet->StatementBuffer);
384 }
385
386 DestoryOneOfOptionMap (&FormSet->OneOfOptionMapListHead);
387
388 if (FormSet->OriginalDefaultVarStoreName != NULL) {
389 FreePool (FormSet->OriginalDefaultVarStoreName);
390 }
391
392 FreePool (FormSet);
393 }
394
395
396 /**
397 Tell whether this Operand is an Expression OpCode or not
398
399 @param Operand Operand of an IFR OpCode.
400
401 @retval TRUE This is an Expression OpCode.
402 @retval FALSE Not an Expression OpCode.
403
404 **/
405 BOOLEAN
406 IsExpressionOpCode (
407 IN UINT8 Operand
408 )
409 {
410 if (((Operand >= EFI_IFR_EQ_ID_VAL_OP) && (Operand <= EFI_IFR_NOT_OP)) ||
411 ((Operand >= EFI_IFR_MATCH_OP) && (Operand <= EFI_IFR_SPAN_OP)) ||
412 (Operand == EFI_IFR_CATENATE_OP)
413 ) {
414 return TRUE;
415 } else {
416 return FALSE;
417 }
418 }
419
420
421 /**
422 Calculate number of Statemens(Questions) and Expression OpCodes.
423
424 @param FormSet The FormSet to be counted.
425 @param NumberOfStatement Number of Statemens(Questions)
426 @param NumberOfExpression Number of Expression OpCodes
427
428 @return None.
429
430 **/
431 VOID
432 CountOpCodes (
433 IN FORM_BROWSER_FORMSET *FormSet,
434 IN OUT UINT16 *NumberOfStatement,
435 IN OUT UINT16 *NumberOfExpression
436 )
437 {
438 UINT16 StatementCount;
439 UINT16 ExpressionCount;
440 UINT8 *OpCodeData;
441 UINTN Offset;
442 UINTN OpCodeLen;
443
444 Offset = 0;
445 StatementCount = 0;
446 ExpressionCount = 0;
447
448 while (Offset < FormSet->IfrBinaryLength) {
449 OpCodeData = FormSet->IfrBinaryData + Offset;
450 OpCodeLen = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
451 Offset += OpCodeLen;
452
453 if (IsExpressionOpCode (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode)) {
454 ExpressionCount++;
455 } else {
456 StatementCount++;
457 }
458 }
459
460 *NumberOfStatement = StatementCount;
461 *NumberOfExpression = ExpressionCount;
462 }
463
464
465 /**
466 Parse opcodes in the formset IFR binary.
467
468 @param FormSet Pointer of the FormSet data structure.
469
470 @retval EFI_SUCCESS Opcode parse success.
471 @retval Other Opcode parse fail.
472
473 **/
474 EFI_STATUS
475 ParseOpCodes (
476 IN FORM_BROWSER_FORMSET *FormSet
477 )
478 {
479 EFI_STATUS Status;
480 UINT16 Index;
481 FORM_BROWSER_FORM *CurrentForm;
482 FORM_BROWSER_STATEMENT *CurrentStatement;
483 UINT8 Operand;
484 UINT8 Scope;
485 UINTN OpCodeOffset;
486 UINTN OpCodeLength;
487 UINT8 *OpCodeData;
488 UINT8 ScopeOpCode;
489 FORMSET_STORAGE *Storage;
490 FORMSET_DEFAULTSTORE *DefaultStore;
491 QUESTION_DEFAULT *CurrentDefault;
492 QUESTION_OPTION *CurrentOption;
493 CHAR8 *AsciiString;
494 UINT16 NumberOfStatement;
495 UINT16 NumberOfExpression;
496 EFI_IMAGE_ID *ImageId;
497 EFI_HII_VALUE *Value;
498 LIST_ENTRY *OneOfOptinMapEntryListHead;
499 EFI_IFR_GUID_OPTIONKEY *OptionMap;
500 ONE_OF_OPTION_MAP *OneOfOptionMap;
501 ONE_OF_OPTION_MAP_ENTRY *OneOfOptionMapEntry;
502 UINT8 OneOfType;
503 EFI_IFR_ONE_OF *OneOfOpcode;
504 HII_THUNK_CONTEXT *ThunkContext;
505
506 mInScopeSubtitle = FALSE;
507 mInScopeSuppress = FALSE;
508 mInScopeGrayOut = FALSE;
509 CurrentDefault = NULL;
510 CurrentOption = NULL;
511 ThunkContext = UefiHiiHandleToThunkContext ((CONST HII_THUNK_PRIVATE_DATA*) mHiiThunkPrivateData, FormSet->HiiHandle);
512
513 //
514 // Set to a invalid value.
515 //
516 OneOfType = (UINT8) -1;
517
518 //
519 // Get the number of Statements and Expressions
520 //
521 CountOpCodes (FormSet, &NumberOfStatement, &NumberOfExpression);
522 FormSet->NumberOfStatement = NumberOfStatement;
523
524 mStatementIndex = 0;
525 FormSet->StatementBuffer = AllocateZeroPool (NumberOfStatement * sizeof (FORM_BROWSER_STATEMENT));
526 if (FormSet->StatementBuffer == NULL) {
527 return EFI_OUT_OF_RESOURCES;
528 }
529
530 InitializeListHead (&FormSet->StorageListHead);
531 InitializeListHead (&FormSet->DefaultStoreListHead);
532 InitializeListHead (&FormSet->FormListHead);
533 InitializeListHead (&FormSet->OneOfOptionMapListHead);
534
535 CurrentForm = NULL;
536 CurrentStatement = NULL;
537
538 ResetScopeStack ();
539
540 OpCodeOffset = 0;
541 while (OpCodeOffset < FormSet->IfrBinaryLength) {
542 OpCodeData = FormSet->IfrBinaryData + OpCodeOffset;
543
544 OpCodeLength = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
545 OpCodeOffset += OpCodeLength;
546 Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;
547 Scope = ((EFI_IFR_OP_HEADER *) OpCodeData)->Scope;
548
549 //
550 // If scope bit set, push onto scope stack
551 //
552 if (Scope) {
553 PushScope (Operand);
554 }
555
556 if (IsExpressionOpCode (Operand)) {
557 continue;
558 }
559
560 //
561 // Parse the Opcode
562 //
563 switch (Operand) {
564
565 case EFI_IFR_FORM_SET_OP:
566 //
567 // check the formset GUID
568 //
569 if (!CompareGuid ((EFI_GUID *)(VOID *)&FormSet->Guid, (EFI_GUID *)(VOID *)&((EFI_IFR_FORM_SET *) OpCodeData)->Guid)) {
570 return EFI_INVALID_PARAMETER;
571 }
572
573 CopyMem (&FormSet->FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
574 CopyMem (&FormSet->Help, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
575 break;
576
577 case EFI_IFR_FORM_OP:
578 //
579 // Create a new Form for this FormSet
580 //
581 CurrentForm = AllocateZeroPool (sizeof (FORM_BROWSER_FORM));
582 CurrentForm->Signature = FORM_BROWSER_FORM_SIGNATURE;
583
584 InitializeListHead (&CurrentForm->StatementListHead);
585
586 CopyMem (&CurrentForm->FormId, &((EFI_IFR_FORM *) OpCodeData)->FormId, sizeof (UINT16));
587 CopyMem (&CurrentForm->FormTitle, &((EFI_IFR_FORM *) OpCodeData)->FormTitle, sizeof (EFI_STRING_ID));
588
589 //
590 // Insert into Form list of this FormSet
591 //
592 InsertTailList (&FormSet->FormListHead, &CurrentForm->Link);
593 break;
594
595 //
596 // Storage
597 //
598 case EFI_IFR_VARSTORE_OP:
599 //
600 // Create a buffer Storage for this FormSet
601 //
602 Storage = CreateStorage (FormSet);
603 Storage->Type = EFI_HII_VARSTORE_BUFFER;
604
605 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
606 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE *) OpCodeData)->Guid, sizeof (EFI_GUID));
607 CopyMem (&Storage->Size, &((EFI_IFR_VARSTORE *) OpCodeData)->Size, sizeof (UINT16));
608
609 AsciiString = (CHAR8 *) ((EFI_IFR_VARSTORE *) OpCodeData)->Name;
610 Storage->Name = AllocateZeroPool (AsciiStrSize (AsciiString) * 2);
611 ASSERT (Storage->Name != NULL);
612 for (Index = 0; AsciiString[Index] != 0; Index++) {
613 Storage->Name[Index] = (CHAR16) AsciiString[Index];
614 }
615
616 break;
617
618 case EFI_IFR_VARSTORE_NAME_VALUE_OP:
619 //
620 // Framework IFR doesn't support Name/Value VarStore opcode
621 //
622 if (ThunkContext != NULL && ThunkContext->ByFrameworkHiiNewPack) {
623 ASSERT (FALSE);
624 }
625
626 //
627 // Create a name/value Storage for this FormSet
628 //
629 Storage = CreateStorage (FormSet);
630 Storage->Type = EFI_HII_VARSTORE_NAME_VALUE;
631
632 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
633 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_NAME_VALUE *) OpCodeData)->Guid, sizeof (EFI_GUID));
634
635 break;
636
637 case EFI_IFR_VARSTORE_EFI_OP:
638 //
639 // Create a EFI variable Storage for this FormSet
640 //
641 Storage = CreateStorage (FormSet);
642 Storage->Type = EFI_HII_VARSTORE_EFI_VARIABLE;
643
644 CopyMem (&Storage->VarStoreId, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->VarStoreId, sizeof (EFI_VARSTORE_ID));
645 CopyMem (&Storage->Guid, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Guid, sizeof (EFI_GUID));
646 CopyMem (&Storage->Attributes, &((EFI_IFR_VARSTORE_EFI *) OpCodeData)->Attributes, sizeof (UINT32));
647 break;
648
649 //
650 // DefaultStore
651 //
652 case EFI_IFR_DEFAULTSTORE_OP:
653 DefaultStore = AllocateZeroPool (sizeof (FORMSET_DEFAULTSTORE));
654 DefaultStore->Signature = FORMSET_DEFAULTSTORE_SIGNATURE;
655
656 CopyMem (&DefaultStore->DefaultId, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultId, sizeof (UINT16));
657 CopyMem (&DefaultStore->DefaultName, &((EFI_IFR_DEFAULTSTORE *) OpCodeData)->DefaultName, sizeof (EFI_STRING_ID));
658
659 //
660 // Insert to DefaultStore list of this Formset
661 //
662 InsertTailList (&FormSet->DefaultStoreListHead, &DefaultStore->Link);
663 break;
664
665 //
666 // Statements
667 //
668 case EFI_IFR_SUBTITLE_OP:
669 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
670 CurrentStatement->Flags = ((EFI_IFR_SUBTITLE *) OpCodeData)->Flags;
671
672 if (Scope) {
673 mInScopeSubtitle = TRUE;
674 }
675 break;
676
677 case EFI_IFR_TEXT_OP:
678 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
679
680 CopyMem (&CurrentStatement->TextTwo, &((EFI_IFR_TEXT *) OpCodeData)->TextTwo, sizeof (EFI_STRING_ID));
681 break;
682
683 //
684 // Questions
685 //
686 case EFI_IFR_ACTION_OP:
687 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
688
689 if (OpCodeLength == sizeof (EFI_IFR_ACTION_1)) {
690 //
691 // No QuestionConfig present, so no configuration string will be processed
692 //
693 CurrentStatement->QuestionConfig = 0;
694 } else {
695 CopyMem (&CurrentStatement->QuestionConfig, &((EFI_IFR_ACTION *) OpCodeData)->QuestionConfig, sizeof (EFI_STRING_ID));
696 }
697 break;
698
699 case EFI_IFR_RESET_BUTTON_OP:
700 CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
701 CopyMem (&CurrentStatement->DefaultId, &((EFI_IFR_RESET_BUTTON *) OpCodeData)->DefaultId, sizeof (EFI_DEFAULT_ID));
702 break;
703
704 case EFI_IFR_REF_OP:
705 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
706
707 CopyMem (&CurrentStatement->RefFormId, &((EFI_IFR_REF *) OpCodeData)->FormId, sizeof (EFI_FORM_ID));
708 if (OpCodeLength >= sizeof (EFI_IFR_REF2)) {
709 CopyMem (&CurrentStatement->RefQuestionId, &((EFI_IFR_REF2 *) OpCodeData)->QuestionId, sizeof (EFI_QUESTION_ID));
710
711 if (OpCodeLength >= sizeof (EFI_IFR_REF3)) {
712 CopyMem (&CurrentStatement->RefFormSetId, &((EFI_IFR_REF3 *) OpCodeData)->FormSetId, sizeof (EFI_GUID));
713
714 if (OpCodeLength >= sizeof (EFI_IFR_REF4)) {
715 CopyMem (&CurrentStatement->RefDevicePath, &((EFI_IFR_REF4 *) OpCodeData)->DevicePath, sizeof (EFI_STRING_ID));
716 }
717 }
718 }
719 break;
720
721 case EFI_IFR_ONE_OF_OP:
722 case EFI_IFR_NUMERIC_OP:
723 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
724
725 CurrentStatement->Flags = ((EFI_IFR_ONE_OF *) OpCodeData)->Flags;
726 Value = &CurrentStatement->HiiValue;
727
728 switch (CurrentStatement->Flags & EFI_IFR_NUMERIC_SIZE) {
729 case EFI_IFR_NUMERIC_SIZE_1:
730 CurrentStatement->Minimum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MinValue;
731 CurrentStatement->Maximum = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.MaxValue;
732 CurrentStatement->Step = ((EFI_IFR_NUMERIC *) OpCodeData)->data.u8.Step;
733 CurrentStatement->StorageWidth = sizeof (UINT8);
734 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
735 break;
736
737 case EFI_IFR_NUMERIC_SIZE_2:
738 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MinValue, sizeof (UINT16));
739 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.MaxValue, sizeof (UINT16));
740 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u16.Step, sizeof (UINT16));
741 CurrentStatement->StorageWidth = sizeof (UINT16);
742 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
743 break;
744
745 case EFI_IFR_NUMERIC_SIZE_4:
746 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MinValue, sizeof (UINT32));
747 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.MaxValue, sizeof (UINT32));
748 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u32.Step, sizeof (UINT32));
749 CurrentStatement->StorageWidth = sizeof (UINT32);
750 Value->Type = EFI_IFR_TYPE_NUM_SIZE_32;
751 break;
752
753 case EFI_IFR_NUMERIC_SIZE_8:
754 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MinValue, sizeof (UINT64));
755 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.MaxValue, sizeof (UINT64));
756 CopyMem (&CurrentStatement->Step, &((EFI_IFR_NUMERIC *) OpCodeData)->data.u64.Step, sizeof (UINT64));
757 CurrentStatement->StorageWidth = sizeof (UINT64);
758 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
759 break;
760
761 default:
762 break;
763 }
764
765 if (Operand == EFI_IFR_ONE_OF_OP) {
766 OneOfOpcode = (EFI_IFR_ONE_OF *) OpCodeData;
767 OneOfType = (UINT8) (OneOfOpcode->Flags & EFI_IFR_NUMERIC_SIZE);
768 }
769 break;
770
771 case EFI_IFR_ORDERED_LIST_OP:
772 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
773
774 CurrentStatement->Flags = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->Flags;
775 CurrentStatement->MaxContainers = ((EFI_IFR_ORDERED_LIST *) OpCodeData)->MaxContainers;
776 CurrentStatement->StorageWidth = (UINT16)(CurrentStatement->MaxContainers * sizeof (UINT8));
777
778 //
779 // No buffer type is defined in EFI_IFR_TYPE_VALUE, so a Configuration Driver
780 // has to use FormBrowser2.Callback() to retrieve the uncommited data for
781 // an interactive orderedlist (i.e. with EFI_IFR_FLAG_CALLBACK flag set).
782 //
783 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_OTHER;
784 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
785
786 break;
787
788 case EFI_IFR_CHECKBOX_OP:
789 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
790
791 CurrentStatement->Flags = ((EFI_IFR_CHECKBOX *) OpCodeData)->Flags;
792 CurrentStatement->StorageWidth = sizeof (BOOLEAN);
793 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_BOOLEAN;
794
795 break;
796
797 case EFI_IFR_STRING_OP:
798 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
799
800 //
801 // MinSize is the minimum number of characters that can be accepted for this opcode,
802 // MaxSize is the maximum number of characters that can be accepted for this opcode.
803 // The characters are stored as Unicode, so the storage width should multiply 2.
804 //
805 CurrentStatement->Minimum = ((EFI_IFR_STRING *) OpCodeData)->MinSize;
806 CurrentStatement->Maximum = ((EFI_IFR_STRING *) OpCodeData)->MaxSize;
807 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (UINT16));
808 CurrentStatement->Flags = ((EFI_IFR_STRING *) OpCodeData)->Flags;
809
810 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
811 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
812
813 break;
814
815 case EFI_IFR_PASSWORD_OP:
816 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
817
818 //
819 // MinSize is the minimum number of characters that can be accepted for this opcode,
820 // MaxSize is the maximum number of characters that can be accepted for this opcode.
821 // The characters are stored as Unicode, so the storage width should multiply 2.
822 //
823 CopyMem (&CurrentStatement->Minimum, &((EFI_IFR_PASSWORD *) OpCodeData)->MinSize, sizeof (UINT16));
824 CopyMem (&CurrentStatement->Maximum, &((EFI_IFR_PASSWORD *) OpCodeData)->MaxSize, sizeof (UINT16));
825 CurrentStatement->StorageWidth = (UINT16)((UINTN) CurrentStatement->Maximum * sizeof (UINT16));
826
827 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_STRING;
828 CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
829
830 break;
831
832 case EFI_IFR_DATE_OP:
833 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
834
835 CurrentStatement->Flags = ((EFI_IFR_DATE *) OpCodeData)->Flags;
836 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_DATE;
837
838 break;
839
840 case EFI_IFR_TIME_OP:
841 CurrentStatement = CreateQuestion (OpCodeData, FormSet, CurrentForm);
842
843 CurrentStatement->Flags = ((EFI_IFR_TIME *) OpCodeData)->Flags;
844 CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_TIME;
845
846 break;
847
848 //
849 // Default
850 //
851 case EFI_IFR_DEFAULT_OP:
852 //
853 // EFI_IFR_DEFAULT appear in scope of a Question,
854 // It creates a default value for the current question.
855 // A Question may have more than one Default value which have different default types.
856 //
857 CurrentDefault = AllocateZeroPool (sizeof (QUESTION_DEFAULT));
858 CurrentDefault->Signature = QUESTION_DEFAULT_SIGNATURE;
859
860 CurrentDefault->Value.Type = ((EFI_IFR_DEFAULT *) OpCodeData)->Type;
861 CopyMem (&CurrentDefault->DefaultId, &((EFI_IFR_DEFAULT *) OpCodeData)->DefaultId, sizeof (UINT16));
862 CopyMem (&CurrentDefault->Value.Value, &((EFI_IFR_DEFAULT *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
863 ExtendValueToU64 (&CurrentDefault->Value);
864
865 //
866 // Insert to Default Value list of current Question
867 //
868 InsertTailList (&CurrentStatement->DefaultListHead, &CurrentDefault->Link);
869
870 break;
871
872 //
873 // Option
874 //
875 case EFI_IFR_ONE_OF_OPTION_OP:
876 //
877 // EFI_IFR_ONE_OF_OPTION appear in scope of a Question.
878 // It create a selection for use in current Question.
879 //
880 CurrentOption = AllocateZeroPool (sizeof (QUESTION_OPTION));
881 CurrentOption->Signature = QUESTION_OPTION_SIGNATURE;
882
883 CurrentOption->Flags = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Flags;
884 CurrentOption->Value.Type = ((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Type;
885 CopyMem (&CurrentOption->Text, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Option, sizeof (EFI_STRING_ID));
886 CopyMem (&CurrentOption->Value.Value, &((EFI_IFR_ONE_OF_OPTION *) OpCodeData)->Value, sizeof (EFI_IFR_TYPE_VALUE));
887 ExtendValueToU64 (&CurrentOption->Value);
888
889 //
890 // Insert to Option list of current Question
891 //
892 InsertTailList (&CurrentStatement->OptionListHead, &CurrentOption->Link);
893 break;
894
895 //
896 // Conditional
897 //
898 case EFI_IFR_NO_SUBMIT_IF_OP:
899 case EFI_IFR_INCONSISTENT_IF_OP:
900 break;
901
902 case EFI_IFR_SUPPRESS_IF_OP:
903 break;
904
905 case EFI_IFR_GRAY_OUT_IF_OP:
906 break;
907
908 case EFI_IFR_DISABLE_IF_OP:
909 //
910 // Framework IFR doesn't support DisableIf opcode
911 //
912 if (ThunkContext != NULL && ThunkContext->ByFrameworkHiiNewPack) {
913 ASSERT (FALSE);
914 }
915
916 //
917 // Expression
918 //
919 case EFI_IFR_VALUE_OP:
920 break;
921
922 case EFI_IFR_RULE_OP:
923 break;
924
925 //
926 // Image
927 //
928 case EFI_IFR_IMAGE_OP:
929 //
930 // Get ScopeOpcode from top of stack
931 //
932 PopScope (&ScopeOpCode);
933 PushScope (ScopeOpCode);
934
935 switch (ScopeOpCode) {
936 case EFI_IFR_FORM_SET_OP:
937 ImageId = &FormSet->ImageId;
938 break;
939
940 case EFI_IFR_FORM_OP:
941 ImageId = &CurrentForm->ImageId;
942 break;
943
944 case EFI_IFR_ONE_OF_OPTION_OP:
945 ImageId = &CurrentOption->ImageId;
946 break;
947
948 default:
949 ImageId = &CurrentStatement->ImageId;
950 break;
951 }
952
953 CopyMem (ImageId, &((EFI_IFR_IMAGE *) OpCodeData)->Id, sizeof (EFI_IMAGE_ID));
954 break;
955
956 //
957 // Refresh
958 //
959 case EFI_IFR_REFRESH_OP:
960 CurrentStatement->RefreshInterval = ((EFI_IFR_REFRESH *) OpCodeData)->RefreshInterval;
961 break;
962
963 //
964 // Vendor specific
965 //
966 case EFI_IFR_GUID_OP:
967 OptionMap = (EFI_IFR_GUID_OPTIONKEY *) OpCodeData;
968
969 if (CompareGuid (&mTianoHiiIfrGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
970 //
971 // Tiano specific GUIDed opcodes
972 //
973 switch (((EFI_IFR_GUID_LABEL *) OpCodeData)->ExtendOpCode) {
974 case EFI_IFR_EXTEND_OP_LABEL:
975 //
976 // just ignore label
977 //
978 break;
979
980
981 case EFI_IFR_EXTEND_OP_CLASS:
982 CopyMem (&FormSet->Class, &((EFI_IFR_GUID_CLASS *) OpCodeData)->Class, sizeof (UINT16));
983 break;
984
985 case EFI_IFR_EXTEND_OP_SUBCLASS:
986 CopyMem (&FormSet->SubClass, &((EFI_IFR_GUID_SUBCLASS *) OpCodeData)->SubClass, sizeof (UINT16));
987 break;
988
989 default:
990 break;
991 }
992 } else if (CompareGuid ((EFI_GUID *)(VOID *)&OptionMap->Guid, &mFrameworkHiiCompatibilityGuid)) {
993 if (OptionMap->ExtendOpCode == EFI_IFR_EXTEND_OP_OPTIONKEY) {
994 OneOfOptinMapEntryListHead = GetOneOfOptionMapEntryListHead (FormSet, OptionMap->QuestionId);
995 if (OneOfOptinMapEntryListHead == NULL) {
996 OneOfOptionMap = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP));
997 ASSERT (OneOfOptionMap != NULL);
998
999 OneOfOptionMap->Signature = ONE_OF_OPTION_MAP_SIGNATURE;
1000 OneOfOptionMap->QuestionId = OptionMap->QuestionId;
1001
1002 //
1003 // Make sure OneOfType is initialized.
1004 //
1005 ASSERT (OneOfType != (UINT8) -1);
1006 OneOfOptionMap->ValueType = OneOfType;
1007 InitializeListHead (&OneOfOptionMap->OneOfOptionMapEntryListHead);
1008 OneOfOptinMapEntryListHead = &OneOfOptionMap->OneOfOptionMapEntryListHead;
1009 InsertTailList (&FormSet->OneOfOptionMapListHead, &OneOfOptionMap->Link);
1010 }
1011 OneOfOptionMapEntry = AllocateZeroPool (sizeof (ONE_OF_OPTION_MAP_ENTRY));
1012 ASSERT (OneOfOptionMapEntry != NULL);
1013
1014 OneOfOptionMapEntry->Signature = ONE_OF_OPTION_MAP_ENTRY_SIGNATURE;
1015 OneOfOptionMapEntry->FwKey = OptionMap->KeyValue;
1016 CopyMem (&OneOfOptionMapEntry->Value, &OptionMap->OptionValue, sizeof (EFI_IFR_TYPE_VALUE));
1017
1018 InsertTailList (OneOfOptinMapEntryListHead, &OneOfOptionMapEntry->Link);
1019 }
1020 }
1021 break;
1022
1023 //
1024 // Scope End
1025 //
1026 case EFI_IFR_END_OP:
1027 Status = PopScope (&ScopeOpCode);
1028 if (EFI_ERROR (Status)) {
1029 ResetScopeStack ();
1030 return Status;
1031 }
1032
1033 switch (ScopeOpCode) {
1034 case EFI_IFR_FORM_SET_OP:
1035 //
1036 // End of FormSet, update FormSet IFR binary length
1037 // to stop parsing substantial OpCodes
1038 //
1039 FormSet->IfrBinaryLength = OpCodeOffset;
1040 break;
1041
1042 case EFI_IFR_FORM_OP:
1043 //
1044 // End of Form
1045 //
1046 CurrentForm = NULL;
1047 break;
1048
1049 case EFI_IFR_ONE_OF_OPTION_OP:
1050 //
1051 // End of Option
1052 //
1053 CurrentOption = NULL;
1054 break;
1055
1056 case EFI_IFR_SUBTITLE_OP:
1057 mInScopeSubtitle = FALSE;
1058 break;
1059
1060 case EFI_IFR_NO_SUBMIT_IF_OP:
1061 case EFI_IFR_INCONSISTENT_IF_OP:
1062 //
1063 // Ignore end of EFI_IFR_NO_SUBMIT_IF and EFI_IFR_INCONSISTENT_IF
1064 //
1065 break;
1066
1067 case EFI_IFR_GRAY_OUT_IF_OP:
1068 mInScopeGrayOut = FALSE;
1069 break;
1070
1071 default:
1072 if (IsExpressionOpCode (ScopeOpCode)) {
1073 }
1074 break;
1075 }
1076 break;
1077
1078 default:
1079 break;
1080 }
1081 }
1082
1083 return EFI_SUCCESS;
1084 }
1085
1086
1087
1088
EFI Development Kit II mirror for PVE