]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Expression.c
e717196dd4a29b33218cc0dac43c75640680bcfe
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Expression.c
1 /** @file
2 Utility functions for expression evaluation.
3
4 Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
5 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 //
18 // Global stack used to evaluate boolean expresions
19 //
20 EFI_HII_VALUE *mOpCodeScopeStack = NULL;
21 EFI_HII_VALUE *mOpCodeScopeStackEnd = NULL;
22 EFI_HII_VALUE *mOpCodeScopeStackPointer = NULL;
23
24 EFI_HII_VALUE *mExpressionEvaluationStack = NULL;
25 EFI_HII_VALUE *mExpressionEvaluationStackEnd = NULL;
26 EFI_HII_VALUE *mExpressionEvaluationStackPointer = NULL;
27 UINTN mExpressionEvaluationStackOffset = 0;
28
29 EFI_HII_VALUE *mCurrentExpressionStack = NULL;
30 EFI_HII_VALUE *mCurrentExpressionEnd = NULL;
31 EFI_HII_VALUE *mCurrentExpressionPointer = NULL;
32
33 EFI_HII_VALUE *mMapExpressionListStack = NULL;
34 EFI_HII_VALUE *mMapExpressionListEnd = NULL;
35 EFI_HII_VALUE *mMapExpressionListPointer = NULL;
36
37 FORM_EXPRESSION **mFormExpressionStack = NULL;
38 FORM_EXPRESSION **mFormExpressionEnd = NULL;
39 FORM_EXPRESSION **mFormExpressionPointer = NULL;
40
41 FORM_EXPRESSION **mStatementExpressionStack = NULL;
42 FORM_EXPRESSION **mStatementExpressionEnd = NULL;
43 FORM_EXPRESSION **mStatementExpressionPointer = NULL;
44
45 FORM_EXPRESSION **mOptionExpressionStack = NULL;
46 FORM_EXPRESSION **mOptionExpressionEnd = NULL;
47 FORM_EXPRESSION **mOptionExpressionPointer = NULL;
48
49
50 //
51 // Unicode collation protocol interface
52 //
53 EFI_UNICODE_COLLATION_PROTOCOL *mUnicodeCollation = NULL;
54 EFI_USER_MANAGER_PROTOCOL *mUserManager = NULL;
55
56 /**
57 Grow size of the stack.
58
59 This is an internal function.
60
61 @param Stack On input: old stack; On output: new stack
62 @param StackPtr On input: old stack pointer; On output: new stack
63 pointer
64 @param StackEnd On input: old stack end; On output: new stack end
65
66 @retval EFI_SUCCESS Grow stack success.
67 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
68
69 **/
70 EFI_STATUS
71 GrowStack (
72 IN OUT EFI_HII_VALUE **Stack,
73 IN OUT EFI_HII_VALUE **StackPtr,
74 IN OUT EFI_HII_VALUE **StackEnd
75 )
76 {
77 UINTN Size;
78 EFI_HII_VALUE *NewStack;
79
80 Size = EXPRESSION_STACK_SIZE_INCREMENT;
81 if (*StackPtr != NULL) {
82 Size = Size + (*StackEnd - *Stack);
83 }
84
85 NewStack = AllocatePool (Size * sizeof (EFI_HII_VALUE));
86 if (NewStack == NULL) {
87 return EFI_OUT_OF_RESOURCES;
88 }
89
90 if (*StackPtr != NULL) {
91 //
92 // Copy from Old Stack to the New Stack
93 //
94 CopyMem (
95 NewStack,
96 *Stack,
97 (*StackEnd - *Stack) * sizeof (EFI_HII_VALUE)
98 );
99
100 //
101 // Free The Old Stack
102 //
103 FreePool (*Stack);
104 }
105
106 //
107 // Make the Stack pointer point to the old data in the new stack
108 //
109 *StackPtr = NewStack + (*StackPtr - *Stack);
110 *Stack = NewStack;
111 *StackEnd = NewStack + Size;
112
113 return EFI_SUCCESS;
114 }
115
116
117 /**
118 Push an element onto the Boolean Stack.
119
120 @param Stack On input: old stack; On output: new stack
121 @param StackPtr On input: old stack pointer; On output: new stack
122 pointer
123 @param StackEnd On input: old stack end; On output: new stack end
124 @param Data Data to push.
125
126 @retval EFI_SUCCESS Push stack success.
127
128 **/
129 EFI_STATUS
130 PushStack (
131 IN OUT EFI_HII_VALUE **Stack,
132 IN OUT EFI_HII_VALUE **StackPtr,
133 IN OUT EFI_HII_VALUE **StackEnd,
134 IN EFI_HII_VALUE *Data
135 )
136 {
137 EFI_STATUS Status;
138
139 //
140 // Check for a stack overflow condition
141 //
142 if (*StackPtr >= *StackEnd) {
143 //
144 // Grow the stack
145 //
146 Status = GrowStack (Stack, StackPtr, StackEnd);
147 if (EFI_ERROR (Status)) {
148 return Status;
149 }
150 }
151
152 //
153 // Push the item onto the stack
154 //
155 CopyMem (*StackPtr, Data, sizeof (EFI_HII_VALUE));
156 if (Data->Type == EFI_IFR_TYPE_BUFFER) {
157 (*StackPtr)->Buffer = AllocateCopyPool(Data->BufferLen, Data->Buffer);
158 ASSERT ((*StackPtr)->Buffer != NULL);
159 }
160
161 *StackPtr = *StackPtr + 1;
162
163 return EFI_SUCCESS;
164 }
165
166
167 /**
168 Pop an element from the stack.
169
170 @param Stack On input: old stack
171 @param StackPtr On input: old stack pointer; On output: new stack pointer
172 @param Data Data to pop.
173
174 @retval EFI_SUCCESS The value was popped onto the stack.
175 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
176
177 **/
178 EFI_STATUS
179 PopStack (
180 IN EFI_HII_VALUE *Stack,
181 IN OUT EFI_HII_VALUE **StackPtr,
182 OUT EFI_HII_VALUE *Data
183 )
184 {
185 //
186 // Check for a stack underflow condition
187 //
188 if (*StackPtr == Stack) {
189 return EFI_ACCESS_DENIED;
190 }
191
192 //
193 // Pop the item off the stack
194 //
195 *StackPtr = *StackPtr - 1;
196 CopyMem (Data, *StackPtr, sizeof (EFI_HII_VALUE));
197 return EFI_SUCCESS;
198 }
199
200
201 /**
202 Reset stack pointer to begin of the stack.
203
204 **/
205 VOID
206 ResetCurrentExpressionStack (
207 VOID
208 )
209 {
210 mCurrentExpressionPointer = mCurrentExpressionStack;
211 mFormExpressionPointer = mFormExpressionStack;
212 mStatementExpressionPointer = mStatementExpressionStack;
213 mOptionExpressionPointer = mOptionExpressionStack;
214 }
215
216
217 /**
218 Push current expression onto the Stack
219
220 @param Pointer Pointer to current expression.
221
222 @retval EFI_SUCCESS The value was pushed onto the stack.
223 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
224
225 **/
226 EFI_STATUS
227 PushCurrentExpression (
228 IN VOID *Pointer
229 )
230 {
231 EFI_HII_VALUE Data;
232
233 Data.Type = EFI_IFR_TYPE_NUM_SIZE_64;
234 Data.Value.u64 = (UINT64) (UINTN) Pointer;
235
236 return PushStack (
237 &mCurrentExpressionStack,
238 &mCurrentExpressionPointer,
239 &mCurrentExpressionEnd,
240 &Data
241 );
242 }
243
244
245 /**
246 Pop current expression from the Stack
247
248 @param Pointer Pointer to current expression to be pop.
249
250 @retval EFI_SUCCESS The value was pushed onto the stack.
251 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
252
253 **/
254 EFI_STATUS
255 PopCurrentExpression (
256 OUT VOID **Pointer
257 )
258 {
259 EFI_STATUS Status;
260 EFI_HII_VALUE Data;
261
262 Status = PopStack (
263 mCurrentExpressionStack,
264 &mCurrentExpressionPointer,
265 &Data
266 );
267
268 *Pointer = (VOID *) (UINTN) Data.Value.u64;
269
270 return Status;
271 }
272
273 /**
274 Reset stack pointer to begin of the stack.
275
276 **/
277 VOID
278 ResetMapExpressionListStack (
279 VOID
280 )
281 {
282 mMapExpressionListPointer = mMapExpressionListStack;
283 }
284
285
286 /**
287 Grow size of the stack.
288
289 This is an internal function.
290
291 @param Stack On input: old stack; On output: new stack
292 @param StackPtr On input: old stack pointer; On output: new stack
293 pointer
294 @param StackEnd On input: old stack end; On output: new stack end
295 @param MemberSize The stack member size.
296
297 @retval EFI_SUCCESS Grow stack success.
298 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
299
300 **/
301 EFI_STATUS
302 GrowConditionalStack (
303 IN OUT FORM_EXPRESSION ***Stack,
304 IN OUT FORM_EXPRESSION ***StackPtr,
305 IN OUT FORM_EXPRESSION ***StackEnd,
306 IN UINTN MemberSize
307 )
308 {
309 UINTN Size;
310 FORM_EXPRESSION **NewStack;
311
312 Size = EXPRESSION_STACK_SIZE_INCREMENT;
313 if (*StackPtr != NULL) {
314 Size = Size + (*StackEnd - *Stack);
315 }
316
317 NewStack = AllocatePool (Size * MemberSize);
318 if (NewStack == NULL) {
319 return EFI_OUT_OF_RESOURCES;
320 }
321
322 if (*StackPtr != NULL) {
323 //
324 // Copy from Old Stack to the New Stack
325 //
326 CopyMem (
327 NewStack,
328 *Stack,
329 (*StackEnd - *Stack) * MemberSize
330 );
331
332 //
333 // Free The Old Stack
334 //
335 FreePool (*Stack);
336 }
337
338 //
339 // Make the Stack pointer point to the old data in the new stack
340 //
341 *StackPtr = NewStack + (*StackPtr - *Stack);
342 *Stack = NewStack;
343 *StackEnd = NewStack + Size;
344
345 return EFI_SUCCESS;
346 }
347
348 /**
349 Push an element onto the Stack.
350
351 @param Stack On input: old stack; On output: new stack
352 @param StackPtr On input: old stack pointer; On output: new stack
353 pointer
354 @param StackEnd On input: old stack end; On output: new stack end
355 @param Data Data to push.
356
357 @retval EFI_SUCCESS Push stack success.
358
359 **/
360 EFI_STATUS
361 PushConditionalStack (
362 IN OUT FORM_EXPRESSION ***Stack,
363 IN OUT FORM_EXPRESSION ***StackPtr,
364 IN OUT FORM_EXPRESSION ***StackEnd,
365 IN FORM_EXPRESSION **Data
366 )
367 {
368 EFI_STATUS Status;
369
370 //
371 // Check for a stack overflow condition
372 //
373 if (*StackPtr >= *StackEnd) {
374 //
375 // Grow the stack
376 //
377 Status = GrowConditionalStack (Stack, StackPtr, StackEnd, sizeof (FORM_EXPRESSION *));
378 if (EFI_ERROR (Status)) {
379 return Status;
380 }
381 }
382
383 //
384 // Push the item onto the stack
385 //
386 CopyMem (*StackPtr, Data, sizeof (FORM_EXPRESSION *));
387 *StackPtr = *StackPtr + 1;
388
389 return EFI_SUCCESS;
390
391 }
392
393 /**
394 Pop an element from the stack.
395
396 @param Stack On input: old stack
397 @param StackPtr On input: old stack pointer; On output: new stack pointer
398 @param Data Data to pop.
399
400 @retval EFI_SUCCESS The value was popped onto the stack.
401 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
402
403 **/
404 EFI_STATUS
405 PopConditionalStack (
406 IN FORM_EXPRESSION **Stack,
407 IN OUT FORM_EXPRESSION ***StackPtr,
408 OUT FORM_EXPRESSION **Data
409 )
410 {
411 //
412 // Check for a stack underflow condition
413 //
414 if (*StackPtr == Stack) {
415 return EFI_ACCESS_DENIED;
416 }
417
418 //
419 // Pop the item off the stack
420 //
421 *StackPtr = *StackPtr - 1;
422 CopyMem (Data, *StackPtr, sizeof (FORM_EXPRESSION *));
423 return EFI_SUCCESS;
424
425 }
426
427 /**
428 Get the expression list count.
429
430 @param Level Which type this expression belong to. Form,
431 statement or option?
432
433 @retval >=0 The expression count
434 @retval -1 Input parameter error.
435
436 **/
437 INTN
438 GetConditionalExpressionCount (
439 IN EXPRESS_LEVEL Level
440 )
441 {
442 switch (Level) {
443 case ExpressForm:
444 return mFormExpressionPointer - mFormExpressionStack;
445 case ExpressStatement:
446 return mStatementExpressionPointer - mStatementExpressionStack;
447 case ExpressOption:
448 return mOptionExpressionPointer - mOptionExpressionStack;
449 default:
450 ASSERT (FALSE);
451 return -1;
452 }
453 }
454
455 /**
456 Get the expression Buffer pointer.
457
458 @param Level Which type this expression belong to. Form,
459 statement or option?
460
461 @retval The start pointer of the expression buffer or NULL.
462
463 **/
464 FORM_EXPRESSION **
465 GetConditionalExpressionList (
466 IN EXPRESS_LEVEL Level
467 )
468 {
469 switch (Level) {
470 case ExpressForm:
471 return mFormExpressionStack;
472 case ExpressStatement:
473 return mStatementExpressionStack;
474 case ExpressOption:
475 return mOptionExpressionStack;
476 default:
477 ASSERT (FALSE);
478 return NULL;
479 }
480 }
481
482
483 /**
484 Push the expression options onto the Stack.
485
486 @param Pointer Pointer to the current expression.
487 @param Level Which type this expression belong to. Form,
488 statement or option?
489
490 @retval EFI_SUCCESS The value was pushed onto the stack.
491 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
492
493 **/
494 EFI_STATUS
495 PushConditionalExpression (
496 IN FORM_EXPRESSION *Pointer,
497 IN EXPRESS_LEVEL Level
498 )
499 {
500 switch (Level) {
501 case ExpressForm:
502 return PushConditionalStack (
503 &mFormExpressionStack,
504 &mFormExpressionPointer,
505 &mFormExpressionEnd,
506 &Pointer
507 );
508 case ExpressStatement:
509 return PushConditionalStack (
510 &mStatementExpressionStack,
511 &mStatementExpressionPointer,
512 &mStatementExpressionEnd,
513 &Pointer
514 );
515 case ExpressOption:
516 return PushConditionalStack (
517 &mOptionExpressionStack,
518 &mOptionExpressionPointer,
519 &mOptionExpressionEnd,
520 &Pointer
521 );
522 default:
523 ASSERT (FALSE);
524 return EFI_INVALID_PARAMETER;
525 }
526 }
527
528 /**
529 Pop the expression options from the Stack
530
531 @param Level Which type this expression belong to. Form,
532 statement or option?
533
534 @retval EFI_SUCCESS The value was pushed onto the stack.
535 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
536
537 **/
538 EFI_STATUS
539 PopConditionalExpression (
540 IN EXPRESS_LEVEL Level
541 )
542 {
543 FORM_EXPRESSION *Pointer;
544
545 switch (Level) {
546 case ExpressForm:
547 return PopConditionalStack (
548 mFormExpressionStack,
549 &mFormExpressionPointer,
550 &Pointer
551 );
552
553 case ExpressStatement:
554 return PopConditionalStack (
555 mStatementExpressionStack,
556 &mStatementExpressionPointer,
557 &Pointer
558 );
559
560 case ExpressOption:
561 return PopConditionalStack (
562 mOptionExpressionStack,
563 &mOptionExpressionPointer,
564 &Pointer
565 );
566
567 default:
568 ASSERT (FALSE);
569 return EFI_INVALID_PARAMETER;
570 }
571 }
572
573
574 /**
575 Push the list of map expression onto the Stack
576
577 @param Pointer Pointer to the list of map expression to be pushed.
578
579 @retval EFI_SUCCESS The value was pushed onto the stack.
580 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
581
582 **/
583 EFI_STATUS
584 PushMapExpressionList (
585 IN VOID *Pointer
586 )
587 {
588 EFI_HII_VALUE Data;
589
590 Data.Type = EFI_IFR_TYPE_NUM_SIZE_64;
591 Data.Value.u64 = (UINT64) (UINTN) Pointer;
592
593 return PushStack (
594 &mMapExpressionListStack,
595 &mMapExpressionListPointer,
596 &mMapExpressionListEnd,
597 &Data
598 );
599 }
600
601
602 /**
603 Pop the list of map expression from the Stack
604
605 @param Pointer Pointer to the list of map expression to be pop.
606
607 @retval EFI_SUCCESS The value was pushed onto the stack.
608 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
609
610 **/
611 EFI_STATUS
612 PopMapExpressionList (
613 OUT VOID **Pointer
614 )
615 {
616 EFI_STATUS Status;
617 EFI_HII_VALUE Data;
618
619 Status = PopStack (
620 mMapExpressionListStack,
621 &mMapExpressionListPointer,
622 &Data
623 );
624
625 *Pointer = (VOID *) (UINTN) Data.Value.u64;
626
627 return Status;
628 }
629
630 /**
631 Reset stack pointer to begin of the stack.
632
633 **/
634 VOID
635 ResetScopeStack (
636 VOID
637 )
638 {
639 mOpCodeScopeStackPointer = mOpCodeScopeStack;
640 }
641
642
643 /**
644 Push an Operand onto the Stack
645
646 @param Operand Operand to push.
647
648 @retval EFI_SUCCESS The value was pushed onto the stack.
649 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
650 stack.
651
652 **/
653 EFI_STATUS
654 PushScope (
655 IN UINT8 Operand
656 )
657 {
658 EFI_HII_VALUE Data;
659
660 Data.Type = EFI_IFR_TYPE_NUM_SIZE_8;
661 Data.Value.u8 = Operand;
662
663 return PushStack (
664 &mOpCodeScopeStack,
665 &mOpCodeScopeStackPointer,
666 &mOpCodeScopeStackEnd,
667 &Data
668 );
669 }
670
671
672 /**
673 Pop an Operand from the Stack
674
675 @param Operand Operand to pop.
676
677 @retval EFI_SUCCESS The value was pushed onto the stack.
678 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
679 stack.
680
681 **/
682 EFI_STATUS
683 PopScope (
684 OUT UINT8 *Operand
685 )
686 {
687 EFI_STATUS Status;
688 EFI_HII_VALUE Data;
689
690 Status = PopStack (
691 mOpCodeScopeStack,
692 &mOpCodeScopeStackPointer,
693 &Data
694 );
695
696 *Operand = Data.Value.u8;
697
698 return Status;
699 }
700
701
702 /**
703 Push an Expression value onto the Stack
704
705 @param Value Expression value to push.
706
707 @retval EFI_SUCCESS The value was pushed onto the stack.
708 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
709 stack.
710
711 **/
712 EFI_STATUS
713 PushExpression (
714 IN EFI_HII_VALUE *Value
715 )
716 {
717 return PushStack (
718 &mExpressionEvaluationStack,
719 &mExpressionEvaluationStackPointer,
720 &mExpressionEvaluationStackEnd,
721 Value
722 );
723 }
724
725
726 /**
727 Pop an Expression value from the stack.
728
729 @param Value Expression value to pop.
730
731 @retval EFI_SUCCESS The value was popped onto the stack.
732 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
733
734 **/
735 EFI_STATUS
736 PopExpression (
737 OUT EFI_HII_VALUE *Value
738 )
739 {
740 return PopStack (
741 mExpressionEvaluationStack + mExpressionEvaluationStackOffset,
742 &mExpressionEvaluationStackPointer,
743 Value
744 );
745 }
746
747 /**
748 Get current stack offset from stack start.
749
750 @return Stack offset to stack start.
751 **/
752 UINTN
753 SaveExpressionEvaluationStackOffset (
754 )
755 {
756 UINTN TempStackOffset;
757 TempStackOffset = mExpressionEvaluationStackOffset;
758 mExpressionEvaluationStackOffset = mExpressionEvaluationStackPointer - mExpressionEvaluationStack;
759 return TempStackOffset;
760 }
761
762 /**
763 Restore stack offset based on input stack offset
764
765 @param StackOffset Offset to stack start.
766
767 **/
768 VOID
769 RestoreExpressionEvaluationStackOffset (
770 UINTN StackOffset
771 )
772 {
773 mExpressionEvaluationStackOffset = StackOffset;
774 }
775
776 /**
777 Get Form given its FormId.
778
779 @param FormSet The formset which contains this form.
780 @param FormId Id of this form.
781
782 @retval Pointer The form.
783 @retval NULL Specified Form is not found in the formset.
784
785 **/
786 FORM_BROWSER_FORM *
787 IdToForm (
788 IN FORM_BROWSER_FORMSET *FormSet,
789 IN UINT16 FormId
790 )
791 {
792 LIST_ENTRY *Link;
793 FORM_BROWSER_FORM *Form;
794
795 Link = GetFirstNode (&FormSet->FormListHead);
796 while (!IsNull (&FormSet->FormListHead, Link)) {
797 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
798
799 if (Form->FormId == FormId) {
800 return Form;
801 }
802
803 Link = GetNextNode (&FormSet->FormListHead, Link);
804 }
805
806 return NULL;
807 }
808
809
810 /**
811 Search a Question in Form scope using its QuestionId.
812
813 @param Form The form which contains this Question.
814 @param QuestionId Id of this Question.
815
816 @retval Pointer The Question.
817 @retval NULL Specified Question not found in the form.
818
819 **/
820 FORM_BROWSER_STATEMENT *
821 IdToQuestion2 (
822 IN FORM_BROWSER_FORM *Form,
823 IN UINT16 QuestionId
824 )
825 {
826 LIST_ENTRY *Link;
827 FORM_BROWSER_STATEMENT *Question;
828
829 if (QuestionId == 0 || Form == NULL) {
830 //
831 // The value of zero is reserved
832 //
833 return NULL;
834 }
835
836 Link = GetFirstNode (&Form->StatementListHead);
837 while (!IsNull (&Form->StatementListHead, Link)) {
838 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
839
840 if (Question->QuestionId == QuestionId) {
841 return Question;
842 }
843
844 Link = GetNextNode (&Form->StatementListHead, Link);
845 }
846
847 return NULL;
848 }
849
850
851 /**
852 Search a Question in Formset scope using its QuestionId.
853
854 @param FormSet The formset which contains this form.
855 @param Form The form which contains this Question.
856 @param QuestionId Id of this Question.
857
858 @retval Pointer The Question.
859 @retval NULL Specified Question not found in the form.
860
861 **/
862 FORM_BROWSER_STATEMENT *
863 IdToQuestion (
864 IN FORM_BROWSER_FORMSET *FormSet,
865 IN FORM_BROWSER_FORM *Form,
866 IN UINT16 QuestionId
867 )
868 {
869 LIST_ENTRY *Link;
870 FORM_BROWSER_STATEMENT *Question;
871
872 //
873 // Search in the form scope first
874 //
875 Question = IdToQuestion2 (Form, QuestionId);
876 if (Question != NULL) {
877 return Question;
878 }
879
880 //
881 // Search in the formset scope
882 //
883 Link = GetFirstNode (&FormSet->FormListHead);
884 while (!IsNull (&FormSet->FormListHead, Link)) {
885 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
886
887 Question = IdToQuestion2 (Form, QuestionId);
888 if (Question != NULL) {
889 //
890 // EFI variable storage may be updated by Callback() asynchronous,
891 // to keep synchronous, always reload the Question Value.
892 //
893 if (Question->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
894 GetQuestionValue (FormSet, Form, Question, GetSetValueWithHiiDriver);
895 }
896
897 return Question;
898 }
899
900 Link = GetNextNode (&FormSet->FormListHead, Link);
901 }
902
903 return NULL;
904 }
905
906
907 /**
908 Get Expression given its RuleId.
909
910 @param Form The form which contains this Expression.
911 @param RuleId Id of this Expression.
912
913 @retval Pointer The Expression.
914 @retval NULL Specified Expression not found in the form.
915
916 **/
917 FORM_EXPRESSION *
918 RuleIdToExpression (
919 IN FORM_BROWSER_FORM *Form,
920 IN UINT8 RuleId
921 )
922 {
923 LIST_ENTRY *Link;
924 FORM_EXPRESSION *Expression;
925
926 Link = GetFirstNode (&Form->ExpressionListHead);
927 while (!IsNull (&Form->ExpressionListHead, Link)) {
928 Expression = FORM_EXPRESSION_FROM_LINK (Link);
929
930 if (Expression->Type == EFI_HII_EXPRESSION_RULE && Expression->RuleId == RuleId) {
931 return Expression;
932 }
933
934 Link = GetNextNode (&Form->ExpressionListHead, Link);
935 }
936
937 return NULL;
938 }
939
940
941 /**
942 Locate the Unicode Collation Protocol interface for later use.
943
944 @retval EFI_SUCCESS Protocol interface initialize success.
945 @retval Other Protocol interface initialize failed.
946
947 **/
948 EFI_STATUS
949 InitializeUnicodeCollationProtocol (
950 VOID
951 )
952 {
953 EFI_STATUS Status;
954
955 if (mUnicodeCollation != NULL) {
956 return EFI_SUCCESS;
957 }
958
959 //
960 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
961 // instances first and then select one which support English language.
962 // Current implementation just pick the first instance.
963 //
964 Status = gBS->LocateProtocol (
965 &gEfiUnicodeCollation2ProtocolGuid,
966 NULL,
967 (VOID **) &mUnicodeCollation
968 );
969 return Status;
970 }
971
972 /**
973 Convert the input Unicode character to upper.
974
975 @param String Th Unicode character to be converted.
976
977 **/
978 VOID
979 IfrStrToUpper (
980 IN CHAR16 *String
981 )
982 {
983 while (*String != 0) {
984 if ((*String >= 'a') && (*String <= 'z')) {
985 *String = (UINT16) ((*String) & ((UINT16) ~0x20));
986 }
987 String++;
988 }
989 }
990
991
992 /**
993 Evaluate opcode EFI_IFR_TO_STRING.
994
995 @param FormSet Formset which contains this opcode.
996 @param Format String format in EFI_IFR_TO_STRING.
997 @param Result Evaluation result for this opcode.
998
999 @retval EFI_SUCCESS Opcode evaluation success.
1000 @retval Other Opcode evaluation failed.
1001
1002 **/
1003 EFI_STATUS
1004 IfrToString (
1005 IN FORM_BROWSER_FORMSET *FormSet,
1006 IN UINT8 Format,
1007 OUT EFI_HII_VALUE *Result
1008 )
1009 {
1010 EFI_STATUS Status;
1011 EFI_HII_VALUE Value;
1012 CHAR16 *String;
1013 CHAR16 *PrintFormat;
1014 CHAR16 Buffer[MAXIMUM_VALUE_CHARACTERS];
1015 UINT8 *TmpBuf;
1016 UINTN BufferSize;
1017
1018 Status = PopExpression (&Value);
1019 if (EFI_ERROR (Status)) {
1020 return Status;
1021 }
1022
1023 switch (Value.Type) {
1024 case EFI_IFR_TYPE_NUM_SIZE_8:
1025 case EFI_IFR_TYPE_NUM_SIZE_16:
1026 case EFI_IFR_TYPE_NUM_SIZE_32:
1027 case EFI_IFR_TYPE_NUM_SIZE_64:
1028 BufferSize = MAXIMUM_VALUE_CHARACTERS * sizeof (CHAR16);
1029 switch (Format) {
1030 case EFI_IFR_STRING_UNSIGNED_DEC:
1031 case EFI_IFR_STRING_SIGNED_DEC:
1032 PrintFormat = L"%ld";
1033 break;
1034
1035 case EFI_IFR_STRING_LOWERCASE_HEX:
1036 PrintFormat = L"%lx";
1037 break;
1038
1039 case EFI_IFR_STRING_UPPERCASE_HEX:
1040 PrintFormat = L"%lX";
1041 break;
1042
1043 default:
1044 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1045 return EFI_SUCCESS;
1046 }
1047 UnicodeSPrint (Buffer, BufferSize, PrintFormat, Value.Value.u64);
1048 String = Buffer;
1049 break;
1050
1051 case EFI_IFR_TYPE_STRING:
1052 CopyMem (Result, &Value, sizeof (EFI_HII_VALUE));
1053 return EFI_SUCCESS;
1054
1055 case EFI_IFR_TYPE_BOOLEAN:
1056 String = (Value.Value.b) ? L"True" : L"False";
1057 break;
1058
1059 case EFI_IFR_TYPE_BUFFER:
1060 //
1061 // + 3 is base on the unicode format, the length may be odd number,
1062 // so need 1 byte to align, also need 2 bytes for L'\0'.
1063 //
1064 TmpBuf = AllocateZeroPool (Value.BufferLen + 3);
1065 ASSERT (TmpBuf != NULL);
1066 if (Format == EFI_IFR_STRING_ASCII) {
1067 CopyMem (TmpBuf, Value.Buffer, Value.BufferLen);
1068 PrintFormat = L"%a";
1069 } else {
1070 // Format == EFI_IFR_STRING_UNICODE
1071 CopyMem (TmpBuf, Value.Buffer, Value.BufferLen * sizeof (CHAR16));
1072 PrintFormat = L"%s";
1073 }
1074 UnicodeSPrint (Buffer, sizeof (Buffer), PrintFormat, Value.Buffer);
1075 String = Buffer;
1076 FreePool (TmpBuf);
1077 FreePool (Value.Buffer);
1078 break;
1079
1080 default:
1081 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1082 return EFI_SUCCESS;
1083 }
1084
1085 Result->Type = EFI_IFR_TYPE_STRING;
1086 Result->Value.string = NewString (String, FormSet->HiiHandle);
1087 return EFI_SUCCESS;
1088 }
1089
1090
1091 /**
1092 Evaluate opcode EFI_IFR_TO_UINT.
1093
1094 @param FormSet Formset which contains this opcode.
1095 @param Result Evaluation result for this opcode.
1096
1097 @retval EFI_SUCCESS Opcode evaluation success.
1098 @retval Other Opcode evaluation failed.
1099
1100 **/
1101 EFI_STATUS
1102 IfrToUint (
1103 IN FORM_BROWSER_FORMSET *FormSet,
1104 OUT EFI_HII_VALUE *Result
1105 )
1106 {
1107 EFI_STATUS Status;
1108 EFI_HII_VALUE Value;
1109 CHAR16 *String;
1110 CHAR16 *StringPtr;
1111
1112 Status = PopExpression (&Value);
1113 if (EFI_ERROR (Status)) {
1114 return Status;
1115 }
1116
1117 if (Value.Type >= EFI_IFR_TYPE_OTHER && Value.Type != EFI_IFR_TYPE_BUFFER) {
1118 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1119 return EFI_SUCCESS;
1120 }
1121
1122 Status = EFI_SUCCESS;
1123 if (Value.Type == EFI_IFR_TYPE_STRING) {
1124 String = GetToken (Value.Value.string, FormSet->HiiHandle);
1125 if (String == NULL) {
1126 return EFI_NOT_FOUND;
1127 }
1128
1129 IfrStrToUpper (String);
1130 StringPtr = StrStr (String, L"0X");
1131 if (StringPtr != NULL) {
1132 //
1133 // Hex string
1134 //
1135 Result->Value.u64 = StrHexToUint64 (String);
1136 } else {
1137 //
1138 // decimal string
1139 //
1140 Result->Value.u64 = StrDecimalToUint64 (String);
1141 }
1142 FreePool (String);
1143 } else if (Value.Type == EFI_IFR_TYPE_BUFFER) {
1144 if (Value.BufferLen > 8) {
1145 FreePool (Value.Buffer);
1146 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1147 return EFI_SUCCESS;
1148 }
1149 Result->Value.u64 = *(UINT64*) Value.Buffer;
1150 FreePool (Value.Buffer);
1151 } else {
1152 CopyMem (Result, &Value, sizeof (EFI_HII_VALUE));
1153 }
1154
1155 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1156 return Status;
1157 }
1158
1159
1160 /**
1161 Evaluate opcode EFI_IFR_CATENATE.
1162
1163 @param FormSet Formset which contains this opcode.
1164 @param Result Evaluation result for this opcode.
1165
1166 @retval EFI_SUCCESS Opcode evaluation success.
1167 @retval Other Opcode evaluation failed.
1168
1169 **/
1170 EFI_STATUS
1171 IfrCatenate (
1172 IN FORM_BROWSER_FORMSET *FormSet,
1173 OUT EFI_HII_VALUE *Result
1174 )
1175 {
1176 EFI_STATUS Status;
1177 EFI_HII_VALUE Value[2];
1178 CHAR16 *String[2];
1179 UINTN Index;
1180 CHAR16 *StringPtr;
1181 UINTN Size;
1182
1183 //
1184 // String[0] - The second string
1185 // String[1] - The first string
1186 //
1187 String[0] = NULL;
1188 String[1] = NULL;
1189 StringPtr = NULL;
1190 Status = EFI_SUCCESS;
1191 ZeroMem (Value, sizeof (Value));
1192
1193 Status = PopExpression (&Value[0]);
1194 if (EFI_ERROR (Status)) {
1195 goto Done;
1196 }
1197
1198 Status = PopExpression (&Value[1]);
1199 if (EFI_ERROR (Status)) {
1200 goto Done;
1201 }
1202
1203 for (Index = 0; Index < 2; Index++) {
1204 if (Value[Index].Type != EFI_IFR_TYPE_STRING && Value[Index].Type != EFI_IFR_TYPE_BUFFER) {
1205 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1206 Status = EFI_SUCCESS;
1207 goto Done;
1208 }
1209
1210 if (Value[Index].Type == EFI_IFR_TYPE_STRING) {
1211 String[Index] = GetToken (Value[Index].Value.string, FormSet->HiiHandle);
1212 if (String[Index] == NULL) {
1213 Status = EFI_NOT_FOUND;
1214 goto Done;
1215 }
1216 }
1217 }
1218
1219 if (Value[0].Type == EFI_IFR_TYPE_STRING) {
1220 Size = StrSize (String[0]);
1221 StringPtr= AllocatePool (StrSize (String[1]) + Size);
1222 ASSERT (StringPtr != NULL);
1223 StrCpy (StringPtr, String[1]);
1224 StrCat (StringPtr, String[0]);
1225
1226 Result->Type = EFI_IFR_TYPE_STRING;
1227 Result->Value.string = NewString (StringPtr, FormSet->HiiHandle);
1228 } else {
1229 Result->Type = EFI_IFR_TYPE_BUFFER;
1230 Result->BufferLen = (UINT16) (Value[0].BufferLen + Value[1].BufferLen);
1231
1232 Result->Buffer = AllocateZeroPool (Result->BufferLen);
1233 ASSERT (Result->Buffer != NULL);
1234
1235 CopyMem (Result->Buffer, Value[0].Buffer, Value[0].BufferLen);
1236 CopyMem (&Result->Buffer[Value[0].BufferLen], Value[1].Buffer, Value[1].BufferLen);
1237 }
1238 Done:
1239 if (Value[0].Buffer != NULL) {
1240 FreePool (Value[0].Buffer);
1241 }
1242 if (Value[1].Buffer != NULL) {
1243 FreePool (Value[1].Buffer);
1244 }
1245 if (String[0] != NULL) {
1246 FreePool (String[0]);
1247 }
1248 if (String[1] != NULL) {
1249 FreePool (String[1]);
1250 }
1251 if (StringPtr != NULL) {
1252 FreePool (StringPtr);
1253 }
1254
1255 return Status;
1256 }
1257
1258
1259 /**
1260 Evaluate opcode EFI_IFR_MATCH.
1261
1262 @param FormSet Formset which contains this opcode.
1263 @param Result Evaluation result for this opcode.
1264
1265 @retval EFI_SUCCESS Opcode evaluation success.
1266 @retval Other Opcode evaluation failed.
1267
1268 **/
1269 EFI_STATUS
1270 IfrMatch (
1271 IN FORM_BROWSER_FORMSET *FormSet,
1272 OUT EFI_HII_VALUE *Result
1273 )
1274 {
1275 EFI_STATUS Status;
1276 EFI_HII_VALUE Value[2];
1277 CHAR16 *String[2];
1278 UINTN Index;
1279
1280 //
1281 // String[0] - The string to search
1282 // String[1] - pattern
1283 //
1284 String[0] = NULL;
1285 String[1] = NULL;
1286 Status = EFI_SUCCESS;
1287 ZeroMem (Value, sizeof (Value));
1288
1289 Status = PopExpression (&Value[0]);
1290 if (EFI_ERROR (Status)) {
1291 goto Done;
1292 }
1293
1294 Status = PopExpression (&Value[1]);
1295 if (EFI_ERROR (Status)) {
1296 goto Done;
1297 }
1298
1299 for (Index = 0; Index < 2; Index++) {
1300 if (Value[Index].Type != EFI_IFR_TYPE_STRING) {
1301 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1302 Status = EFI_SUCCESS;
1303 goto Done;
1304 }
1305
1306 String[Index] = GetToken (Value[Index].Value.string, FormSet->HiiHandle);
1307 if (String [Index] == NULL) {
1308 Status = EFI_NOT_FOUND;
1309 goto Done;
1310 }
1311 }
1312
1313 Result->Type = EFI_IFR_TYPE_BOOLEAN;
1314 Result->Value.b = mUnicodeCollation->MetaiMatch (mUnicodeCollation, String[0], String[1]);
1315
1316 Done:
1317 if (String[0] != NULL) {
1318 FreePool (String[0]);
1319 }
1320 if (String[1] != NULL) {
1321 FreePool (String[1]);
1322 }
1323
1324 return Status;
1325 }
1326
1327
1328 /**
1329 Evaluate opcode EFI_IFR_FIND.
1330
1331 @param FormSet Formset which contains this opcode.
1332 @param Format Case sensitive or insensitive.
1333 @param Result Evaluation result for this opcode.
1334
1335 @retval EFI_SUCCESS Opcode evaluation success.
1336 @retval Other Opcode evaluation failed.
1337
1338 **/
1339 EFI_STATUS
1340 IfrFind (
1341 IN FORM_BROWSER_FORMSET *FormSet,
1342 IN UINT8 Format,
1343 OUT EFI_HII_VALUE *Result
1344 )
1345 {
1346 EFI_STATUS Status;
1347 EFI_HII_VALUE Value[3];
1348 CHAR16 *String[2];
1349 UINTN Base;
1350 CHAR16 *StringPtr;
1351 UINTN Index;
1352
1353 ZeroMem (Value, sizeof (Value));
1354
1355 if (Format > EFI_IFR_FF_CASE_INSENSITIVE) {
1356 return EFI_INVALID_PARAMETER;
1357 }
1358
1359 Status = PopExpression (&Value[0]);
1360 if (EFI_ERROR (Status)) {
1361 return Status;
1362 }
1363
1364 Status = PopExpression (&Value[1]);
1365 if (EFI_ERROR (Status)) {
1366 return Status;
1367 }
1368
1369 Status = PopExpression (&Value[2]);
1370 if (EFI_ERROR (Status)) {
1371 return Status;
1372 }
1373
1374 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1375 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1376 return EFI_SUCCESS;
1377 }
1378 Base = (UINTN) Value[0].Value.u64;
1379
1380 //
1381 // String[0] - sub-string
1382 // String[1] - The string to search
1383 //
1384 String[0] = NULL;
1385 String[1] = NULL;
1386 for (Index = 0; Index < 2; Index++) {
1387 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1388 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1389 Status = EFI_SUCCESS;
1390 goto Done;
1391 }
1392
1393 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1394 if (String[Index] == NULL) {
1395 Status = EFI_NOT_FOUND;
1396 goto Done;
1397 }
1398
1399 if (Format == EFI_IFR_FF_CASE_INSENSITIVE) {
1400 //
1401 // Case insensitive, convert both string to upper case
1402 //
1403 IfrStrToUpper (String[Index]);
1404 }
1405 }
1406
1407 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1408 if (Base >= StrLen (String[1])) {
1409 Result->Value.u64 = 0xFFFFFFFFFFFFFFFFULL;
1410 } else {
1411 StringPtr = StrStr (String[1] + Base, String[0]);
1412 Result->Value.u64 = (StringPtr == NULL) ? 0xFFFFFFFFFFFFFFFFULL : (StringPtr - String[1]);
1413 }
1414
1415 Done:
1416 if (String[0] != NULL) {
1417 FreePool (String[0]);
1418 }
1419 if (String[1] != NULL) {
1420 FreePool (String[1]);
1421 }
1422
1423 return Status;
1424 }
1425
1426
1427 /**
1428 Evaluate opcode EFI_IFR_MID.
1429
1430 @param FormSet Formset which contains this opcode.
1431 @param Result Evaluation result for this opcode.
1432
1433 @retval EFI_SUCCESS Opcode evaluation success.
1434 @retval Other Opcode evaluation failed.
1435
1436 **/
1437 EFI_STATUS
1438 IfrMid (
1439 IN FORM_BROWSER_FORMSET *FormSet,
1440 OUT EFI_HII_VALUE *Result
1441 )
1442 {
1443 EFI_STATUS Status;
1444 EFI_HII_VALUE Value[3];
1445 CHAR16 *String;
1446 UINTN Base;
1447 UINTN Length;
1448 CHAR16 *SubString;
1449 UINT16 BufferLen;
1450
1451 ZeroMem (Value, sizeof (Value));
1452
1453 Status = PopExpression (&Value[0]);
1454 if (EFI_ERROR (Status)) {
1455 return Status;
1456 }
1457
1458 Status = PopExpression (&Value[1]);
1459 if (EFI_ERROR (Status)) {
1460 return Status;
1461 }
1462
1463 Status = PopExpression (&Value[2]);
1464 if (EFI_ERROR (Status)) {
1465 return Status;
1466 }
1467
1468 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1469 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1470 return EFI_SUCCESS;
1471 }
1472 Length = (UINTN) Value[0].Value.u64;
1473
1474 if (Value[1].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1475 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1476 return EFI_SUCCESS;
1477 }
1478 Base = (UINTN) Value[1].Value.u64;
1479
1480 if (Value[2].Type != EFI_IFR_TYPE_STRING && Value[2].Type != EFI_IFR_TYPE_BUFFER) {
1481 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1482 return EFI_SUCCESS;
1483 }
1484 if (Value[2].Type == EFI_IFR_TYPE_STRING) {
1485 String = GetToken (Value[2].Value.string, FormSet->HiiHandle);
1486 if (String == NULL) {
1487 return EFI_NOT_FOUND;
1488 }
1489
1490 if (Length == 0 || Base >= StrLen (String)) {
1491 SubString = gEmptyString;
1492 } else {
1493 SubString = String + Base;
1494 if ((Base + Length) < StrLen (String)) {
1495 SubString[Length] = L'\0';
1496 }
1497 }
1498
1499 Result->Type = EFI_IFR_TYPE_STRING;
1500 Result->Value.string = NewString (SubString, FormSet->HiiHandle);
1501
1502 FreePool (String);
1503 } else {
1504 BufferLen = Value[2].BufferLen;
1505
1506 Result->Type = EFI_IFR_TYPE_BUFFER;
1507 if (Length == 0 || Base >= BufferLen) {
1508 Result->BufferLen = 0;
1509 Result->Buffer = NULL;
1510 } else {
1511 Result->BufferLen = (UINT16)((BufferLen - Base) < Length ? (BufferLen - Base) : Length);
1512 Result->Buffer = AllocateZeroPool (Result->BufferLen);
1513 ASSERT (Result->Buffer != NULL);
1514 CopyMem (Result->Buffer, &Value[2].Buffer[Base], Result->BufferLen);
1515 }
1516
1517 FreePool (Value[2].Buffer);
1518 }
1519
1520 return Status;
1521 }
1522
1523
1524 /**
1525 Evaluate opcode EFI_IFR_TOKEN.
1526
1527 @param FormSet Formset which contains this opcode.
1528 @param Result Evaluation result for this opcode.
1529
1530 @retval EFI_SUCCESS Opcode evaluation success.
1531 @retval Other Opcode evaluation failed.
1532
1533 **/
1534 EFI_STATUS
1535 IfrToken (
1536 IN FORM_BROWSER_FORMSET *FormSet,
1537 OUT EFI_HII_VALUE *Result
1538 )
1539 {
1540 EFI_STATUS Status;
1541 EFI_HII_VALUE Value[3];
1542 CHAR16 *String[2];
1543 UINTN Count;
1544 CHAR16 *Delimiter;
1545 CHAR16 *SubString;
1546 CHAR16 *StringPtr;
1547 UINTN Index;
1548
1549 ZeroMem (Value, sizeof (Value));
1550
1551 Status = PopExpression (&Value[0]);
1552 if (EFI_ERROR (Status)) {
1553 return Status;
1554 }
1555
1556 Status = PopExpression (&Value[1]);
1557 if (EFI_ERROR (Status)) {
1558 return Status;
1559 }
1560
1561 Status = PopExpression (&Value[2]);
1562 if (EFI_ERROR (Status)) {
1563 return Status;
1564 }
1565
1566 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1567 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1568 return EFI_SUCCESS;
1569 }
1570 Count = (UINTN) Value[0].Value.u64;
1571
1572 //
1573 // String[0] - Delimiter
1574 // String[1] - The string to search
1575 //
1576 String[0] = NULL;
1577 String[1] = NULL;
1578 for (Index = 0; Index < 2; Index++) {
1579 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1580 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1581 Status = EFI_SUCCESS;
1582 goto Done;
1583 }
1584
1585 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1586 if (String[Index] == NULL) {
1587 Status = EFI_NOT_FOUND;
1588 goto Done;
1589 }
1590 }
1591
1592 Delimiter = String[0];
1593 SubString = String[1];
1594 while (Count > 0) {
1595 SubString = StrStr (SubString, Delimiter);
1596 if (SubString != NULL) {
1597 //
1598 // Skip over the delimiter
1599 //
1600 SubString = SubString + StrLen (Delimiter);
1601 } else {
1602 break;
1603 }
1604 Count--;
1605 }
1606
1607 if (SubString == NULL) {
1608 //
1609 // nth delimited sub-string not found, push an empty string
1610 //
1611 SubString = gEmptyString;
1612 } else {
1613 //
1614 // Put a NULL terminator for nth delimited sub-string
1615 //
1616 StringPtr = StrStr (SubString, Delimiter);
1617 if (StringPtr != NULL) {
1618 *StringPtr = L'\0';
1619 }
1620 }
1621
1622 Result->Type = EFI_IFR_TYPE_STRING;
1623 Result->Value.string = NewString (SubString, FormSet->HiiHandle);
1624
1625 Done:
1626 if (String[0] != NULL) {
1627 FreePool (String[0]);
1628 }
1629 if (String[1] != NULL) {
1630 FreePool (String[1]);
1631 }
1632
1633 return Status;
1634 }
1635
1636
1637 /**
1638 Evaluate opcode EFI_IFR_SPAN.
1639
1640 @param FormSet Formset which contains this opcode.
1641 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1642 @param Result Evaluation result for this opcode.
1643
1644 @retval EFI_SUCCESS Opcode evaluation success.
1645 @retval Other Opcode evaluation failed.
1646
1647 **/
1648 EFI_STATUS
1649 IfrSpan (
1650 IN FORM_BROWSER_FORMSET *FormSet,
1651 IN UINT8 Flags,
1652 OUT EFI_HII_VALUE *Result
1653 )
1654 {
1655 EFI_STATUS Status;
1656 EFI_HII_VALUE Value[3];
1657 CHAR16 *String[2];
1658 CHAR16 *Charset;
1659 UINTN Base;
1660 UINTN Index;
1661 CHAR16 *StringPtr;
1662 BOOLEAN Found;
1663
1664 ZeroMem (Value, sizeof (Value));
1665
1666 Status = PopExpression (&Value[0]);
1667 if (EFI_ERROR (Status)) {
1668 return Status;
1669 }
1670
1671 Status = PopExpression (&Value[1]);
1672 if (EFI_ERROR (Status)) {
1673 return Status;
1674 }
1675
1676 Status = PopExpression (&Value[2]);
1677 if (EFI_ERROR (Status)) {
1678 return Status;
1679 }
1680
1681 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1682 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1683 return EFI_SUCCESS;
1684 }
1685 Base = (UINTN) Value[0].Value.u64;
1686
1687 //
1688 // String[0] - Charset
1689 // String[1] - The string to search
1690 //
1691 String[0] = NULL;
1692 String[1] = NULL;
1693 for (Index = 0; Index < 2; Index++) {
1694 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1695 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1696 Status = EFI_SUCCESS;
1697 goto Done;
1698 }
1699
1700 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1701 if (String [Index] == NULL) {
1702 Status = EFI_NOT_FOUND;
1703 goto Done;
1704 }
1705 }
1706
1707 if (Base >= StrLen (String[1])) {
1708 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1709 Status = EFI_SUCCESS;
1710 goto Done;
1711 }
1712
1713 Found = FALSE;
1714 StringPtr = String[1] + Base;
1715 Charset = String[0];
1716 while (*StringPtr != 0 && !Found) {
1717 Index = 0;
1718 while (Charset[Index] != 0) {
1719 if (*StringPtr >= Charset[Index] && *StringPtr <= Charset[Index + 1]) {
1720 if (Flags == EFI_IFR_FLAGS_FIRST_MATCHING) {
1721 Found = TRUE;
1722 break;
1723 }
1724 } else {
1725 if (Flags == EFI_IFR_FLAGS_FIRST_NON_MATCHING) {
1726 Found = TRUE;
1727 break;
1728 }
1729 }
1730 //
1731 // Skip characters pair representing low-end of a range and high-end of a range
1732 //
1733 Index += 2;
1734 }
1735
1736 if (!Found) {
1737 StringPtr++;
1738 }
1739 }
1740
1741 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1742 Result->Value.u64 = StringPtr - String[1];
1743
1744 Done:
1745 if (String[0] != NULL) {
1746 FreePool (String[0]);
1747 }
1748 if (String[1] != NULL) {
1749 FreePool (String[1]);
1750 }
1751
1752 return Status;
1753 }
1754
1755
1756 /**
1757 Zero extend integer/boolean/date/time to UINT64 for comparing.
1758
1759 @param Value HII Value to be converted.
1760
1761 **/
1762 VOID
1763 ExtendValueToU64 (
1764 IN EFI_HII_VALUE *Value
1765 )
1766 {
1767 UINT64 Temp;
1768
1769 Temp = 0;
1770 switch (Value->Type) {
1771 case EFI_IFR_TYPE_NUM_SIZE_8:
1772 Temp = Value->Value.u8;
1773 break;
1774
1775 case EFI_IFR_TYPE_NUM_SIZE_16:
1776 Temp = Value->Value.u16;
1777 break;
1778
1779 case EFI_IFR_TYPE_NUM_SIZE_32:
1780 Temp = Value->Value.u32;
1781 break;
1782
1783 case EFI_IFR_TYPE_BOOLEAN:
1784 Temp = Value->Value.b;
1785 break;
1786
1787 case EFI_IFR_TYPE_TIME:
1788 Temp = Value->Value.u32 & 0xffffff;
1789 break;
1790
1791 case EFI_IFR_TYPE_DATE:
1792 Temp = Value->Value.u32;
1793 break;
1794
1795 default:
1796 return;
1797 }
1798
1799 Value->Value.u64 = Temp;
1800 }
1801
1802
1803 /**
1804 Compare two Hii value.
1805
1806 @param Value1 Expression value to compare on left-hand.
1807 @param Value2 Expression value to compare on right-hand.
1808 @param Result Return value after compare.
1809 retval 0 Two operators equal.
1810 return Positive value if Value1 is greater than Value2.
1811 retval Negative value if Value1 is less than Value2.
1812 @param HiiHandle Only required for string compare.
1813
1814 @retval other Could not perform compare on two values.
1815 @retval EFI_SUCCESS Compare the value success.
1816
1817 **/
1818 EFI_STATUS
1819 CompareHiiValue (
1820 IN EFI_HII_VALUE *Value1,
1821 IN EFI_HII_VALUE *Value2,
1822 OUT INTN *Result,
1823 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1824 )
1825 {
1826 INT64 Temp64;
1827 CHAR16 *Str1;
1828 CHAR16 *Str2;
1829 UINTN Len;
1830
1831 if (Value1->Type >= EFI_IFR_TYPE_OTHER || Value2->Type >= EFI_IFR_TYPE_OTHER ) {
1832 if (Value1->Type != EFI_IFR_TYPE_BUFFER && Value2->Type != EFI_IFR_TYPE_BUFFER) {
1833 return EFI_UNSUPPORTED;
1834 }
1835 }
1836
1837 if (Value1->Type == EFI_IFR_TYPE_STRING || Value2->Type == EFI_IFR_TYPE_STRING ) {
1838 if (Value1->Type != Value2->Type) {
1839 //
1840 // Both Operator should be type of String
1841 //
1842 return EFI_UNSUPPORTED;
1843 }
1844
1845 if (Value1->Value.string == 0 || Value2->Value.string == 0) {
1846 //
1847 // StringId 0 is reserved
1848 //
1849 return EFI_INVALID_PARAMETER;
1850 }
1851
1852 if (Value1->Value.string == Value2->Value.string) {
1853 *Result = 0;
1854 return EFI_SUCCESS;
1855 }
1856
1857 Str1 = GetToken (Value1->Value.string, HiiHandle);
1858 if (Str1 == NULL) {
1859 //
1860 // String not found
1861 //
1862 return EFI_NOT_FOUND;
1863 }
1864
1865 Str2 = GetToken (Value2->Value.string, HiiHandle);
1866 if (Str2 == NULL) {
1867 FreePool (Str1);
1868 return EFI_NOT_FOUND;
1869 }
1870
1871 *Result = StrCmp (Str1, Str2);
1872
1873 FreePool (Str1);
1874 FreePool (Str2);
1875
1876 return EFI_SUCCESS;
1877 }
1878
1879 if (Value1->Type == EFI_IFR_TYPE_BUFFER || Value2->Type == EFI_IFR_TYPE_BUFFER ) {
1880 if (Value1->Type != Value2->Type) {
1881 //
1882 // Both Operator should be type of Buffer.
1883 //
1884 return EFI_UNSUPPORTED;
1885 }
1886 Len = Value1->BufferLen > Value2->BufferLen ? Value2->BufferLen : Value1->BufferLen;
1887 *Result = CompareMem (Value1->Buffer, Value2->Buffer, Len);
1888 if ((*Result == 0) && (Value1->BufferLen != Value2->BufferLen))
1889 {
1890 //
1891 // In this case, means base on samll number buffer, the data is same
1892 // So which value has more data, which value is bigger.
1893 //
1894 *Result = Value1->BufferLen > Value2->BufferLen ? 1 : -1;
1895 }
1896 return EFI_SUCCESS;
1897 }
1898
1899 //
1900 // Take remain types(integer, boolean, date/time) as integer
1901 //
1902 Temp64 = (INT64) (Value1->Value.u64 - Value2->Value.u64);
1903 if (Temp64 > 0) {
1904 *Result = 1;
1905 } else if (Temp64 < 0) {
1906 *Result = -1;
1907 } else {
1908 *Result = 0;
1909 }
1910
1911 return EFI_SUCCESS;
1912 }
1913
1914 /**
1915 Check if current user has the privilege specified by the permissions GUID.
1916
1917 @param[in] Guid A GUID specifying setup access permissions.
1918
1919 @retval TRUE Current user has the privilege.
1920 @retval FALSE Current user does not have the privilege.
1921 **/
1922 BOOLEAN
1923 CheckUserPrivilege (
1924 IN EFI_GUID *Guid
1925 )
1926 {
1927 EFI_STATUS Status;
1928 EFI_USER_PROFILE_HANDLE UserProfileHandle;
1929 EFI_USER_INFO_HANDLE UserInfoHandle;
1930 EFI_USER_INFO *UserInfo;
1931 EFI_GUID *UserPermissionsGuid;
1932 UINTN UserInfoSize;
1933 UINTN AccessControlDataSize;
1934 EFI_USER_INFO_ACCESS_CONTROL *AccessControl;
1935 UINTN RemainSize;
1936
1937 if (mUserManager == NULL) {
1938 Status = gBS->LocateProtocol (
1939 &gEfiUserManagerProtocolGuid,
1940 NULL,
1941 (VOID **) &mUserManager
1942 );
1943 if (EFI_ERROR (Status)) {
1944 ///
1945 /// If the system does not support user management, then it is assumed that
1946 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
1947 /// op-code is always TRUE.
1948 ///
1949 return TRUE;
1950 }
1951 }
1952
1953 Status = mUserManager->Current (mUserManager, &UserProfileHandle);
1954 ASSERT_EFI_ERROR (Status);
1955
1956 ///
1957 /// Enumerate all user information of the current user profile
1958 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
1959 ///
1960
1961 for (UserInfoHandle = NULL;;) {
1962 Status = mUserManager->GetNextInfo (mUserManager, UserProfileHandle, &UserInfoHandle);
1963 if (EFI_ERROR (Status)) {
1964 break;
1965 }
1966
1967 UserInfoSize = 0;
1968 Status = mUserManager->GetInfo (mUserManager, UserProfileHandle, UserInfoHandle, NULL, &UserInfoSize);
1969 if (Status != EFI_BUFFER_TOO_SMALL) {
1970 continue;
1971 }
1972
1973 UserInfo = (EFI_USER_INFO *) AllocatePool (UserInfoSize);
1974 if (UserInfo == NULL) {
1975 break;
1976 }
1977
1978 Status = mUserManager->GetInfo (mUserManager, UserProfileHandle, UserInfoHandle, UserInfo, &UserInfoSize);
1979 if (EFI_ERROR (Status) ||
1980 UserInfo->InfoType != EFI_USER_INFO_ACCESS_POLICY_RECORD ||
1981 UserInfo->InfoSize <= sizeof (EFI_USER_INFO)) {
1982 FreePool (UserInfo);
1983 continue;
1984 }
1985
1986 RemainSize = UserInfo->InfoSize - sizeof (EFI_USER_INFO);
1987 AccessControl = (EFI_USER_INFO_ACCESS_CONTROL *)(UserInfo + 1);
1988 while (RemainSize >= sizeof (EFI_USER_INFO_ACCESS_CONTROL)) {
1989 if (RemainSize < AccessControl->Size || AccessControl->Size < sizeof (EFI_USER_INFO_ACCESS_CONTROL)) {
1990 break;
1991 }
1992 if (AccessControl->Type == EFI_USER_INFO_ACCESS_SETUP) {
1993 ///
1994 /// Check if current user has the privilege specified by the permissions GUID.
1995 ///
1996
1997 UserPermissionsGuid = (EFI_GUID *)(AccessControl + 1);
1998 AccessControlDataSize = AccessControl->Size - sizeof (EFI_USER_INFO_ACCESS_CONTROL);
1999 while (AccessControlDataSize >= sizeof (EFI_GUID)) {
2000 if (CompareGuid (Guid, UserPermissionsGuid)) {
2001 FreePool (UserInfo);
2002 return TRUE;
2003 }
2004 UserPermissionsGuid++;
2005 AccessControlDataSize -= sizeof (EFI_GUID);
2006 }
2007 }
2008 RemainSize -= AccessControl->Size;
2009 AccessControl = (EFI_USER_INFO_ACCESS_CONTROL *)((UINT8 *)AccessControl + AccessControl->Size);
2010 }
2011
2012 FreePool (UserInfo);
2013 }
2014 return FALSE;
2015 }
2016
2017 /**
2018 Get question value from the predefined formset.
2019
2020 @param DevicePath The driver's device path which produece the formset data.
2021 @param InputHiiHandle The hii handle associate with the formset data.
2022 @param FormSetGuid The formset guid which include the question.
2023 @param QuestionId The question id which need to get value from.
2024 @param Value The return data about question's value.
2025
2026 @retval TRUE Get the question value success.
2027 @retval FALSE Get the question value failed.
2028 **/
2029 BOOLEAN
2030 GetQuestionValueFromForm (
2031 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2032 IN EFI_HII_HANDLE InputHiiHandle,
2033 IN EFI_GUID *FormSetGuid,
2034 IN EFI_QUESTION_ID QuestionId,
2035 OUT EFI_HII_VALUE *Value
2036 )
2037 {
2038 EFI_STATUS Status;
2039 EFI_HII_HANDLE HiiHandle;
2040 FORM_BROWSER_STATEMENT *Question;
2041 FORM_BROWSER_FORMSET *FormSet;
2042 FORM_BROWSER_FORM *Form;
2043 BOOLEAN GetTheVal;
2044 LIST_ENTRY *Link;
2045
2046 //
2047 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2048 //
2049 ASSERT ((DevicePath != NULL && InputHiiHandle == NULL) ||
2050 (DevicePath == NULL && InputHiiHandle != NULL) );
2051
2052 GetTheVal = TRUE;
2053 HiiHandle = NULL;
2054 Question = NULL;
2055 Form = NULL;
2056
2057 //
2058 // Get HiiHandle.
2059 //
2060 if (DevicePath != NULL) {
2061 HiiHandle = DevicePathToHiiHandle (DevicePath, FormSetGuid);
2062 if (HiiHandle == NULL) {
2063 return FALSE;
2064 }
2065 } else {
2066 HiiHandle = InputHiiHandle;
2067 }
2068 ASSERT (HiiHandle != NULL);
2069
2070 //
2071 // Get the formset data include this question.
2072 //
2073 FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
2074 ASSERT (FormSet != NULL);
2075 Status = InitializeFormSet(HiiHandle, FormSetGuid, FormSet);
2076 if (EFI_ERROR (Status)) {
2077 GetTheVal = FALSE;
2078 goto Done;
2079 }
2080
2081 //
2082 // Base on the Question Id to get the question info.
2083 //
2084 Question = IdToQuestion(FormSet, NULL, QuestionId);
2085 if (Question == NULL) {
2086 GetTheVal = FALSE;
2087 goto Done;
2088 }
2089
2090 //
2091 // Search form in the formset scope
2092 //
2093 Link = GetFirstNode (&FormSet->FormListHead);
2094 while (!IsNull (&FormSet->FormListHead, Link)) {
2095 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
2096
2097 Question = IdToQuestion2 (Form, QuestionId);
2098 if (Question != NULL) {
2099 break;
2100 }
2101
2102 Link = GetNextNode (&FormSet->FormListHead, Link);
2103 Form = NULL;
2104 }
2105 ASSERT (Form != NULL);
2106
2107 //
2108 // Get the question value.
2109 //
2110 Status = GetQuestionValue(FormSet, Form, Question, GetSetValueWithHiiDriver);
2111 if (EFI_ERROR (Status)) {
2112 GetTheVal = FALSE;
2113 goto Done;
2114 }
2115
2116 CopyMem (Value, &Question->HiiValue, sizeof (EFI_HII_VALUE));
2117
2118 Done:
2119 //
2120 // Clean the formset structure and restore the global parameter.
2121 //
2122 if (FormSet != NULL) {
2123 DestroyFormSet (FormSet);
2124 }
2125
2126 return GetTheVal;
2127 }
2128
2129 /**
2130 Evaluate the result of a HII expression.
2131
2132 If Expression is NULL, then ASSERT.
2133
2134 @param FormSet FormSet associated with this expression.
2135 @param Form Form associated with this expression.
2136 @param Expression Expression to be evaluated.
2137
2138 @retval EFI_SUCCESS The expression evaluated successfuly
2139 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2140 could not be found.
2141 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2142 stack.
2143 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2144 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2145
2146 **/
2147 EFI_STATUS
2148 EvaluateExpression (
2149 IN FORM_BROWSER_FORMSET *FormSet,
2150 IN FORM_BROWSER_FORM *Form,
2151 IN OUT FORM_EXPRESSION *Expression
2152 )
2153 {
2154 EFI_STATUS Status;
2155 LIST_ENTRY *Link;
2156 EXPRESSION_OPCODE *OpCode;
2157 FORM_BROWSER_STATEMENT *Question;
2158 FORM_BROWSER_STATEMENT *Question2;
2159 UINT16 Index;
2160 EFI_HII_VALUE Data1;
2161 EFI_HII_VALUE Data2;
2162 EFI_HII_VALUE Data3;
2163 FORM_EXPRESSION *RuleExpression;
2164 EFI_HII_VALUE *Value;
2165 INTN Result;
2166 CHAR16 *StrPtr;
2167 CHAR16 *NameValue;
2168 UINT32 TempValue;
2169 LIST_ENTRY *SubExpressionLink;
2170 FORM_EXPRESSION *SubExpression;
2171 UINTN StackOffset;
2172 UINTN TempLength;
2173 CHAR16 TempStr[5];
2174 UINT8 DigitUint8;
2175 UINT8 *TempBuffer;
2176 EFI_TIME EfiTime;
2177 EFI_HII_VALUE QuestionVal;
2178 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
2179
2180 //
2181 // Save current stack offset.
2182 //
2183 StackOffset = SaveExpressionEvaluationStackOffset ();
2184
2185 ASSERT (Expression != NULL);
2186 Expression->Result.Type = EFI_IFR_TYPE_OTHER;
2187
2188 Link = GetFirstNode (&Expression->OpCodeListHead);
2189 while (!IsNull (&Expression->OpCodeListHead, Link)) {
2190 OpCode = EXPRESSION_OPCODE_FROM_LINK (Link);
2191
2192 Link = GetNextNode (&Expression->OpCodeListHead, Link);
2193
2194 ZeroMem (&Data1, sizeof (EFI_HII_VALUE));
2195 ZeroMem (&Data2, sizeof (EFI_HII_VALUE));
2196 ZeroMem (&Data3, sizeof (EFI_HII_VALUE));
2197
2198 Value = &Data3;
2199 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2200 Status = EFI_SUCCESS;
2201
2202 switch (OpCode->Operand) {
2203 //
2204 // Built-in functions
2205 //
2206 case EFI_IFR_EQ_ID_VAL_OP:
2207 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2208 if (Question == NULL) {
2209 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2210 break;
2211 }
2212
2213 Status = CompareHiiValue (&Question->HiiValue, &OpCode->Value, &Result, NULL);
2214 if (Status == EFI_UNSUPPORTED) {
2215 Status = EFI_SUCCESS;
2216 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2217 break;
2218 }
2219
2220 if (EFI_ERROR (Status)) {
2221 goto Done;
2222 }
2223 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
2224 break;
2225
2226 case EFI_IFR_EQ_ID_ID_OP:
2227 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2228 if (Question == NULL) {
2229 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2230 break;
2231 }
2232
2233 Question2 = IdToQuestion (FormSet, Form, OpCode->QuestionId2);
2234 if (Question2 == NULL) {
2235 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2236 break;
2237 }
2238
2239 Status = CompareHiiValue (&Question->HiiValue, &Question2->HiiValue, &Result, FormSet->HiiHandle);
2240 if (Status == EFI_UNSUPPORTED) {
2241 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2242 Status = EFI_SUCCESS;
2243 break;
2244 }
2245 if (EFI_ERROR (Status)) {
2246 goto Done;
2247 }
2248 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
2249 break;
2250
2251 case EFI_IFR_EQ_ID_VAL_LIST_OP:
2252 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2253 if (Question == NULL) {
2254 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2255 break;
2256 }
2257
2258 Value->Value.b = FALSE;
2259 for (Index =0; Index < OpCode->ListLength; Index++) {
2260 if (Question->HiiValue.Value.u16 == OpCode->ValueList[Index]) {
2261 Value->Value.b = TRUE;
2262 break;
2263 }
2264 }
2265 break;
2266
2267 case EFI_IFR_DUP_OP:
2268 Status = PopExpression (Value);
2269 if (EFI_ERROR (Status)) {
2270 goto Done;
2271 }
2272
2273 Status = PushExpression (Value);
2274 break;
2275
2276 case EFI_IFR_QUESTION_REF1_OP:
2277 case EFI_IFR_THIS_OP:
2278 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2279 if (Question == NULL) {
2280 Status = EFI_NOT_FOUND;
2281 goto Done;
2282 }
2283
2284 Value = &Question->HiiValue;
2285 break;
2286
2287 case EFI_IFR_SECURITY_OP:
2288 Value->Value.b = CheckUserPrivilege (&OpCode->Guid);
2289 break;
2290
2291 case EFI_IFR_GET_OP:
2292 //
2293 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2294 //
2295 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2296 Value->Value.u8 = 0;
2297 if (OpCode->VarStorage != NULL) {
2298 switch (OpCode->VarStorage->Type) {
2299 case EFI_HII_VARSTORE_BUFFER:
2300 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
2301 //
2302 // Get value from Edit Buffer
2303 //
2304 Value->Type = OpCode->ValueType;
2305 CopyMem (&Value->Value, OpCode->VarStorage->EditBuffer + OpCode->VarStoreInfo.VarOffset, OpCode->ValueWidth);
2306 break;
2307 case EFI_HII_VARSTORE_NAME_VALUE:
2308 if (OpCode->ValueType != EFI_IFR_TYPE_STRING) {
2309 //
2310 // Get value from string except for STRING value.
2311 //
2312 Status = GetValueByName (OpCode->VarStorage, OpCode->ValueName, &StrPtr, GetSetValueWithEditBuffer);
2313 if (!EFI_ERROR (Status)) {
2314 ASSERT (StrPtr != NULL);
2315 TempLength = StrLen (StrPtr);
2316 if (OpCode->ValueWidth >= ((TempLength + 1) / 2)) {
2317 Value->Type = OpCode->ValueType;
2318 TempBuffer = (UINT8 *) &Value->Value;
2319 ZeroMem (TempStr, sizeof (TempStr));
2320 for (Index = 0; Index < TempLength; Index ++) {
2321 TempStr[0] = StrPtr[TempLength - Index - 1];
2322 DigitUint8 = (UINT8) StrHexToUint64 (TempStr);
2323 if ((Index & 1) == 0) {
2324 TempBuffer [Index/2] = DigitUint8;
2325 } else {
2326 TempBuffer [Index/2] = (UINT8) ((DigitUint8 << 4) + TempBuffer [Index/2]);
2327 }
2328 }
2329 }
2330 }
2331 }
2332 break;
2333 case EFI_HII_VARSTORE_EFI_VARIABLE:
2334 //
2335 // Get value from variable.
2336 //
2337 TempLength = OpCode->ValueWidth;
2338 Value->Type = OpCode->ValueType;
2339 Status = gRT->GetVariable (
2340 OpCode->ValueName,
2341 &OpCode->VarStorage->Guid,
2342 NULL,
2343 &TempLength,
2344 &Value->Value
2345 );
2346 if (EFI_ERROR (Status)) {
2347 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2348 Value->Value.u8 = 0;
2349 }
2350 break;
2351 default:
2352 //
2353 // Not recognize storage.
2354 //
2355 Status = EFI_UNSUPPORTED;
2356 goto Done;
2357 }
2358 } else {
2359 //
2360 // For Time/Date Data
2361 //
2362 if (OpCode->ValueType != EFI_IFR_TYPE_DATE && OpCode->ValueType != EFI_IFR_TYPE_TIME) {
2363 //
2364 // Only support Data/Time data when storage doesn't exist.
2365 //
2366 Status = EFI_UNSUPPORTED;
2367 goto Done;
2368 }
2369 Status = gRT->GetTime (&EfiTime, NULL);
2370 if (!EFI_ERROR (Status)) {
2371 if (OpCode->ValueType == EFI_IFR_TYPE_DATE) {
2372 switch (OpCode->VarStoreInfo.VarOffset) {
2373 case 0x00:
2374 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
2375 Value->Value.u16 = EfiTime.Year;
2376 break;
2377 case 0x02:
2378 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2379 Value->Value.u8 = EfiTime.Month;
2380 break;
2381 case 0x03:
2382 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2383 Value->Value.u8 = EfiTime.Day;
2384 break;
2385 default:
2386 //
2387 // Invalid Date field.
2388 //
2389 Status = EFI_INVALID_PARAMETER;
2390 goto Done;
2391 }
2392 } else {
2393 switch (OpCode->VarStoreInfo.VarOffset) {
2394 case 0x00:
2395 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2396 Value->Value.u8 = EfiTime.Hour;
2397 break;
2398 case 0x01:
2399 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2400 Value->Value.u8 = EfiTime.Minute;
2401 break;
2402 case 0x02:
2403 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2404 Value->Value.u8 = EfiTime.Second;
2405 break;
2406 default:
2407 //
2408 // Invalid Time field.
2409 //
2410 Status = EFI_INVALID_PARAMETER;
2411 goto Done;
2412 }
2413 }
2414 }
2415 }
2416
2417 break;
2418
2419 case EFI_IFR_QUESTION_REF3_OP:
2420 //
2421 // EFI_IFR_QUESTION_REF3
2422 // Pop an expression from the expression stack
2423 //
2424 Status = PopExpression (Value);
2425 if (EFI_ERROR (Status)) {
2426 goto Done;
2427 }
2428
2429 //
2430 // Validate the expression value
2431 //
2432 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2433 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2434 break;
2435 }
2436
2437 if (OpCode->DevicePath != 0) {
2438 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2439
2440 StrPtr = GetToken (OpCode->DevicePath, FormSet->HiiHandle);
2441 if (StrPtr != NULL && mPathFromText != NULL) {
2442 DevicePath = mPathFromText->ConvertTextToDevicePath(StrPtr);
2443 if (DevicePath != NULL && GetQuestionValueFromForm(DevicePath, NULL, &OpCode->Guid, Value->Value.u16, &QuestionVal)) {
2444 Value = &QuestionVal;
2445 }
2446 if (DevicePath != NULL) {
2447 FreePool (DevicePath);
2448 }
2449 }
2450
2451 if (StrPtr != NULL) {
2452 FreePool (StrPtr);
2453 }
2454 } else if (CompareGuid (&OpCode->Guid, &gZeroGuid) != 0) {
2455 if (!GetQuestionValueFromForm(NULL, FormSet->HiiHandle, &OpCode->Guid, Value->Value.u16, &QuestionVal)){
2456 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2457 break;
2458 }
2459 Value = &QuestionVal;
2460 } else {
2461 Question = IdToQuestion (FormSet, Form, Value->Value.u16);
2462 if (Question == NULL) {
2463 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2464 break;
2465 }
2466
2467 //
2468 // push the questions' value on to the expression stack
2469 //
2470 Value = &Question->HiiValue;
2471 }
2472 break;
2473
2474 case EFI_IFR_RULE_REF_OP:
2475 //
2476 // Find expression for this rule
2477 //
2478 RuleExpression = RuleIdToExpression (Form, OpCode->RuleId);
2479 if (RuleExpression == NULL) {
2480 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2481 break;
2482 }
2483
2484 //
2485 // Evaluate this rule expression
2486 //
2487 Status = EvaluateExpression (FormSet, Form, RuleExpression);
2488 if (EFI_ERROR (Status) || RuleExpression->Result.Type == EFI_IFR_TYPE_UNDEFINED) {
2489 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2490 break;
2491 }
2492
2493 Value = &RuleExpression->Result;
2494 break;
2495
2496 case EFI_IFR_STRING_REF1_OP:
2497 Value->Type = EFI_IFR_TYPE_STRING;
2498 Value->Value.string = OpCode->Value.Value.string;
2499 break;
2500
2501 //
2502 // Constant
2503 //
2504 case EFI_IFR_TRUE_OP:
2505 case EFI_IFR_FALSE_OP:
2506 case EFI_IFR_ONE_OP:
2507 case EFI_IFR_ONES_OP:
2508 case EFI_IFR_UINT8_OP:
2509 case EFI_IFR_UINT16_OP:
2510 case EFI_IFR_UINT32_OP:
2511 case EFI_IFR_UINT64_OP:
2512 case EFI_IFR_UNDEFINED_OP:
2513 case EFI_IFR_VERSION_OP:
2514 case EFI_IFR_ZERO_OP:
2515 Value = &OpCode->Value;
2516 break;
2517
2518 //
2519 // unary-op
2520 //
2521 case EFI_IFR_LENGTH_OP:
2522 Status = PopExpression (Value);
2523 if (EFI_ERROR (Status)) {
2524 goto Done;
2525 }
2526 if (Value->Type != EFI_IFR_TYPE_STRING && Value->Type != EFI_IFR_TYPE_BUFFER) {
2527 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2528 break;
2529 }
2530
2531 if (Value->Type == EFI_IFR_TYPE_STRING) {
2532 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2533 if (StrPtr == NULL) {
2534 Status = EFI_INVALID_PARAMETER;
2535 goto Done;
2536 }
2537
2538 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2539 Value->Value.u64 = StrLen (StrPtr);
2540 FreePool (StrPtr);
2541 } else {
2542 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2543 Value->Value.u64 = Value->BufferLen;
2544 FreePool (Value->Buffer);
2545 }
2546 break;
2547
2548 case EFI_IFR_NOT_OP:
2549 Status = PopExpression (Value);
2550 if (EFI_ERROR (Status)) {
2551 goto Done;
2552 }
2553 if (Value->Type != EFI_IFR_TYPE_BOOLEAN) {
2554 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2555 break;
2556 }
2557 Value->Value.b = (BOOLEAN) (!Value->Value.b);
2558 break;
2559
2560 case EFI_IFR_QUESTION_REF2_OP:
2561 //
2562 // Pop an expression from the expression stack
2563 //
2564 Status = PopExpression (Value);
2565 if (EFI_ERROR (Status)) {
2566 goto Done;
2567 }
2568
2569 //
2570 // Validate the expression value
2571 //
2572 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2573 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2574 break;
2575 }
2576
2577 Question = IdToQuestion (FormSet, Form, Value->Value.u16);
2578 if (Question == NULL) {
2579 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2580 break;
2581 }
2582
2583 Value = &Question->HiiValue;
2584 break;
2585
2586 case EFI_IFR_STRING_REF2_OP:
2587 //
2588 // Pop an expression from the expression stack
2589 //
2590 Status = PopExpression (Value);
2591 if (EFI_ERROR (Status)) {
2592 goto Done;
2593 }
2594
2595 //
2596 // Validate the expression value
2597 //
2598 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2599 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2600 break;
2601 }
2602
2603 Value->Type = EFI_IFR_TYPE_STRING;
2604 StrPtr = GetToken (Value->Value.u16, FormSet->HiiHandle);
2605 if (StrPtr == NULL) {
2606 //
2607 // If String not exit, push an empty string
2608 //
2609 Value->Value.string = NewString (gEmptyString, FormSet->HiiHandle);
2610 } else {
2611 Index = (UINT16) Value->Value.u64;
2612 Value->Value.string = Index;
2613 FreePool (StrPtr);
2614 }
2615 break;
2616
2617 case EFI_IFR_TO_BOOLEAN_OP:
2618 //
2619 // Pop an expression from the expression stack
2620 //
2621 Status = PopExpression (Value);
2622 if (EFI_ERROR (Status)) {
2623 goto Done;
2624 }
2625
2626 //
2627 // Convert an expression to a Boolean
2628 //
2629 if (Value->Type <= EFI_IFR_TYPE_DATE) {
2630 //
2631 // When converting from an unsigned integer, zero will be converted to
2632 // FALSE and any other value will be converted to TRUE.
2633 //
2634 Value->Value.b = (BOOLEAN) (Value->Value.u64 != 0);
2635
2636 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2637 } else if (Value->Type == EFI_IFR_TYPE_STRING) {
2638 //
2639 // When converting from a string, if case-insensitive compare
2640 // with "true" is True, then push True. If a case-insensitive compare
2641 // with "false" is True, then push False. Otherwise, push Undefined.
2642 //
2643 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2644 if (StrPtr == NULL) {
2645 Status = EFI_INVALID_PARAMETER;
2646 goto Done;
2647 }
2648
2649 IfrStrToUpper (StrPtr);
2650 if (StrCmp (StrPtr, L"TRUE") == 0){
2651 Value->Value.b = TRUE;
2652 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2653 } else if (StrCmp (StrPtr, L"FALSE") == 0) {
2654 Value->Value.b = FALSE;
2655 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2656 } else {
2657 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2658 }
2659 FreePool (StrPtr);
2660 } else if (Value->Type == EFI_IFR_TYPE_BUFFER) {
2661 //
2662 // When converting from a buffer, if the buffer is all zeroes,
2663 // then push False. Otherwise push True.
2664 //
2665 for (Index =0; Index < Value->BufferLen; Index ++) {
2666 if (Value->Buffer[Index] != 0) {
2667 break;
2668 }
2669 }
2670
2671 if (Index >= Value->BufferLen) {
2672 Value->Value.b = FALSE;
2673 } else {
2674 Value->Value.b = TRUE;
2675 }
2676 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2677 FreePool (Value->Buffer);
2678 }
2679 break;
2680
2681 case EFI_IFR_TO_STRING_OP:
2682 Status = IfrToString (FormSet, OpCode->Format, Value);
2683 break;
2684
2685 case EFI_IFR_TO_UINT_OP:
2686 Status = IfrToUint (FormSet, Value);
2687 break;
2688
2689 case EFI_IFR_TO_LOWER_OP:
2690 case EFI_IFR_TO_UPPER_OP:
2691 Status = InitializeUnicodeCollationProtocol ();
2692 if (EFI_ERROR (Status)) {
2693 goto Done;
2694 }
2695
2696 Status = PopExpression (Value);
2697 if (EFI_ERROR (Status)) {
2698 goto Done;
2699 }
2700
2701 if (Value->Type != EFI_IFR_TYPE_STRING) {
2702 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2703 break;
2704 }
2705
2706 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2707 if (StrPtr == NULL) {
2708 Status = EFI_NOT_FOUND;
2709 goto Done;
2710 }
2711
2712 if (OpCode->Operand == EFI_IFR_TO_LOWER_OP) {
2713 mUnicodeCollation->StrLwr (mUnicodeCollation, StrPtr);
2714 } else {
2715 mUnicodeCollation->StrUpr (mUnicodeCollation, StrPtr);
2716 }
2717 Value->Value.string = NewString (StrPtr, FormSet->HiiHandle);
2718 FreePool (StrPtr);
2719 break;
2720
2721 case EFI_IFR_BITWISE_NOT_OP:
2722 //
2723 // Pop an expression from the expression stack
2724 //
2725 Status = PopExpression (Value);
2726 if (EFI_ERROR (Status)) {
2727 goto Done;
2728 }
2729 if (Value->Type > EFI_IFR_TYPE_DATE) {
2730 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2731 break;
2732 }
2733
2734 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2735 Value->Value.u64 = ~Value->Value.u64;
2736 break;
2737
2738 case EFI_IFR_SET_OP:
2739 //
2740 // Pop an expression from the expression stack
2741 //
2742 Status = PopExpression (Value);
2743 if (EFI_ERROR (Status)) {
2744 goto Done;
2745 }
2746 Data1.Type = EFI_IFR_TYPE_BOOLEAN;
2747 Data1.Value.b = FALSE;
2748 //
2749 // Set value to var storage buffer
2750 //
2751 if (OpCode->VarStorage != NULL) {
2752 switch (OpCode->VarStorage->Type) {
2753 case EFI_HII_VARSTORE_BUFFER:
2754 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
2755 CopyMem (OpCode->VarStorage->EditBuffer + OpCode->VarStoreInfo.VarOffset, &Value->Value, OpCode->ValueWidth);
2756 Data1.Value.b = TRUE;
2757 break;
2758 case EFI_HII_VARSTORE_NAME_VALUE:
2759 if (OpCode->ValueType != EFI_IFR_TYPE_STRING) {
2760 NameValue = AllocateZeroPool ((OpCode->ValueWidth * 2 + 1) * sizeof (CHAR16));
2761 ASSERT (Value != NULL);
2762 //
2763 // Convert Buffer to Hex String
2764 //
2765 TempBuffer = (UINT8 *) &Value->Value + OpCode->ValueWidth - 1;
2766 StrPtr = NameValue;
2767 for (Index = 0; Index < OpCode->ValueWidth; Index ++, TempBuffer --) {
2768 StrPtr += UnicodeValueToString (StrPtr, PREFIX_ZERO | RADIX_HEX, *TempBuffer, 2);
2769 }
2770 Status = SetValueByName (OpCode->VarStorage, OpCode->ValueName, NameValue, GetSetValueWithEditBuffer, NULL);
2771 FreePool (NameValue);
2772 if (!EFI_ERROR (Status)) {
2773 Data1.Value.b = TRUE;
2774 }
2775 }
2776 break;
2777 case EFI_HII_VARSTORE_EFI_VARIABLE:
2778 Status = gRT->SetVariable (
2779 OpCode->ValueName,
2780 &OpCode->VarStorage->Guid,
2781 OpCode->VarStorage->Attributes,
2782 OpCode->ValueWidth,
2783 &Value->Value
2784 );
2785 if (!EFI_ERROR (Status)) {
2786 Data1.Value.b = TRUE;
2787 }
2788 break;
2789 default:
2790 //
2791 // Not recognize storage.
2792 //
2793 Status = EFI_UNSUPPORTED;
2794 goto Done;
2795 break;
2796 }
2797 } else {
2798 //
2799 // For Time/Date Data
2800 //
2801 if (OpCode->ValueType != EFI_IFR_TYPE_DATE && OpCode->ValueType != EFI_IFR_TYPE_TIME) {
2802 //
2803 // Only support Data/Time data when storage doesn't exist.
2804 //
2805 Status = EFI_UNSUPPORTED;
2806 goto Done;
2807 }
2808 Status = gRT->GetTime (&EfiTime, NULL);
2809 if (!EFI_ERROR (Status)) {
2810 if (OpCode->ValueType == EFI_IFR_TYPE_DATE) {
2811 switch (OpCode->VarStoreInfo.VarOffset) {
2812 case 0x00:
2813 EfiTime.Year = Value->Value.u16;
2814 break;
2815 case 0x02:
2816 EfiTime.Month = Value->Value.u8;
2817 break;
2818 case 0x03:
2819 EfiTime.Day = Value->Value.u8;
2820 break;
2821 default:
2822 //
2823 // Invalid Date field.
2824 //
2825 Status = EFI_INVALID_PARAMETER;
2826 goto Done;
2827 }
2828 } else {
2829 switch (OpCode->VarStoreInfo.VarOffset) {
2830 case 0x00:
2831 EfiTime.Hour = Value->Value.u8;
2832 break;
2833 case 0x01:
2834 EfiTime.Minute = Value->Value.u8;
2835 break;
2836 case 0x02:
2837 EfiTime.Second = Value->Value.u8;
2838 break;
2839 default:
2840 //
2841 // Invalid Time field.
2842 //
2843 Status = EFI_INVALID_PARAMETER;
2844 goto Done;
2845 }
2846 }
2847 Status = gRT->SetTime (&EfiTime);
2848 if (!EFI_ERROR (Status)) {
2849 Data1.Value.b = TRUE;
2850 }
2851 }
2852 }
2853 Value = &Data1;
2854 break;
2855
2856 //
2857 // binary-op
2858 //
2859 case EFI_IFR_ADD_OP:
2860 case EFI_IFR_SUBTRACT_OP:
2861 case EFI_IFR_MULTIPLY_OP:
2862 case EFI_IFR_DIVIDE_OP:
2863 case EFI_IFR_MODULO_OP:
2864 case EFI_IFR_BITWISE_AND_OP:
2865 case EFI_IFR_BITWISE_OR_OP:
2866 case EFI_IFR_SHIFT_LEFT_OP:
2867 case EFI_IFR_SHIFT_RIGHT_OP:
2868 //
2869 // Pop an expression from the expression stack
2870 //
2871 Status = PopExpression (&Data2);
2872 if (EFI_ERROR (Status)) {
2873 goto Done;
2874 }
2875
2876 //
2877 // Pop another expression from the expression stack
2878 //
2879 Status = PopExpression (&Data1);
2880 if (EFI_ERROR (Status)) {
2881 goto Done;
2882 }
2883
2884 if (Data2.Type > EFI_IFR_TYPE_DATE) {
2885 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2886 break;
2887 }
2888
2889
2890 if (Data1.Type > EFI_IFR_TYPE_DATE) {
2891 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2892 break;
2893 }
2894
2895 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2896
2897 switch (OpCode->Operand) {
2898 case EFI_IFR_ADD_OP:
2899 Value->Value.u64 = Data1.Value.u64 + Data2.Value.u64;
2900 break;
2901
2902 case EFI_IFR_SUBTRACT_OP:
2903 Value->Value.u64 = Data1.Value.u64 - Data2.Value.u64;
2904 break;
2905
2906 case EFI_IFR_MULTIPLY_OP:
2907 Value->Value.u64 = MultU64x32 (Data1.Value.u64, (UINT32) Data2.Value.u64);
2908 break;
2909
2910 case EFI_IFR_DIVIDE_OP:
2911 Value->Value.u64 = DivU64x32 (Data1.Value.u64, (UINT32) Data2.Value.u64);
2912 break;
2913
2914 case EFI_IFR_MODULO_OP:
2915 DivU64x32Remainder (Data1.Value.u64, (UINT32) Data2.Value.u64, &TempValue);
2916 Value->Value.u64 = TempValue;
2917 break;
2918
2919 case EFI_IFR_BITWISE_AND_OP:
2920 Value->Value.u64 = Data1.Value.u64 & Data2.Value.u64;
2921 break;
2922
2923 case EFI_IFR_BITWISE_OR_OP:
2924 Value->Value.u64 = Data1.Value.u64 | Data2.Value.u64;
2925 break;
2926
2927 case EFI_IFR_SHIFT_LEFT_OP:
2928 Value->Value.u64 = LShiftU64 (Data1.Value.u64, (UINTN) Data2.Value.u64);
2929 break;
2930
2931 case EFI_IFR_SHIFT_RIGHT_OP:
2932 Value->Value.u64 = RShiftU64 (Data1.Value.u64, (UINTN) Data2.Value.u64);
2933 break;
2934
2935 default:
2936 break;
2937 }
2938 break;
2939
2940 case EFI_IFR_AND_OP:
2941 case EFI_IFR_OR_OP:
2942 //
2943 // Two Boolean operator
2944 //
2945 Status = PopExpression (&Data2);
2946 if (EFI_ERROR (Status)) {
2947 goto Done;
2948 }
2949
2950 //
2951 // Pop another expression from the expression stack
2952 //
2953 Status = PopExpression (&Data1);
2954 if (EFI_ERROR (Status)) {
2955 goto Done;
2956 }
2957
2958 if (Data2.Type != EFI_IFR_TYPE_BOOLEAN) {
2959 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2960 break;
2961 }
2962
2963 if (Data1.Type != EFI_IFR_TYPE_BOOLEAN) {
2964 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2965 break;
2966 }
2967
2968 if (OpCode->Operand == EFI_IFR_AND_OP) {
2969 Value->Value.b = (BOOLEAN) (Data1.Value.b && Data2.Value.b);
2970 } else {
2971 Value->Value.b = (BOOLEAN) (Data1.Value.b || Data2.Value.b);
2972 }
2973 break;
2974
2975 case EFI_IFR_EQUAL_OP:
2976 case EFI_IFR_NOT_EQUAL_OP:
2977 case EFI_IFR_GREATER_EQUAL_OP:
2978 case EFI_IFR_GREATER_THAN_OP:
2979 case EFI_IFR_LESS_EQUAL_OP:
2980 case EFI_IFR_LESS_THAN_OP:
2981 //
2982 // Compare two integer, string, boolean or date/time
2983 //
2984 Status = PopExpression (&Data2);
2985 if (EFI_ERROR (Status)) {
2986 goto Done;
2987 }
2988
2989 //
2990 // Pop another expression from the expression stack
2991 //
2992 Status = PopExpression (&Data1);
2993 if (EFI_ERROR (Status)) {
2994 goto Done;
2995 }
2996
2997 if (Data2.Type > EFI_IFR_TYPE_BOOLEAN &&
2998 Data2.Type != EFI_IFR_TYPE_STRING &&
2999 Data2.Type != EFI_IFR_TYPE_BUFFER) {
3000 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3001 break;
3002 }
3003
3004 if (Data1.Type > EFI_IFR_TYPE_BOOLEAN &&
3005 Data1.Type != EFI_IFR_TYPE_STRING &&
3006 Data1.Type != EFI_IFR_TYPE_BUFFER) {
3007 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3008 break;
3009 }
3010
3011 Status = CompareHiiValue (&Data1, &Data2, &Result, FormSet->HiiHandle);
3012 if (Data1.Type == EFI_IFR_TYPE_BUFFER) {
3013 FreePool (Data1.Buffer);
3014 FreePool (Data2.Buffer);
3015 }
3016
3017 if (Status == EFI_UNSUPPORTED) {
3018 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3019 Status = EFI_SUCCESS;
3020 break;
3021 }
3022
3023 if (EFI_ERROR (Status)) {
3024 goto Done;
3025 }
3026
3027 switch (OpCode->Operand) {
3028 case EFI_IFR_EQUAL_OP:
3029 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
3030 break;
3031
3032 case EFI_IFR_NOT_EQUAL_OP:
3033 Value->Value.b = (BOOLEAN) ((Result != 0) ? TRUE : FALSE);
3034 break;
3035
3036 case EFI_IFR_GREATER_EQUAL_OP:
3037 Value->Value.b = (BOOLEAN) ((Result >= 0) ? TRUE : FALSE);
3038 break;
3039
3040 case EFI_IFR_GREATER_THAN_OP:
3041 Value->Value.b = (BOOLEAN) ((Result > 0) ? TRUE : FALSE);
3042 break;
3043
3044 case EFI_IFR_LESS_EQUAL_OP:
3045 Value->Value.b = (BOOLEAN) ((Result <= 0) ? TRUE : FALSE);
3046 break;
3047
3048 case EFI_IFR_LESS_THAN_OP:
3049 Value->Value.b = (BOOLEAN) ((Result < 0) ? TRUE : FALSE);
3050 break;
3051
3052 default:
3053 break;
3054 }
3055 break;
3056
3057 case EFI_IFR_MATCH_OP:
3058 Status = InitializeUnicodeCollationProtocol ();
3059 if (EFI_ERROR (Status)) {
3060 goto Done;
3061 }
3062
3063 Status = IfrMatch (FormSet, Value);
3064 break;
3065
3066 case EFI_IFR_CATENATE_OP:
3067 Status = IfrCatenate (FormSet, Value);
3068 break;
3069
3070 //
3071 // ternary-op
3072 //
3073 case EFI_IFR_CONDITIONAL_OP:
3074 //
3075 // Pop third expression from the expression stack
3076 //
3077 Status = PopExpression (&Data3);
3078 if (EFI_ERROR (Status)) {
3079 goto Done;
3080 }
3081
3082 //
3083 // Pop second expression from the expression stack
3084 //
3085 Status = PopExpression (&Data2);
3086 if (EFI_ERROR (Status)) {
3087 goto Done;
3088 }
3089
3090 //
3091 // Pop first expression from the expression stack
3092 //
3093 Status = PopExpression (&Data1);
3094 if (EFI_ERROR (Status)) {
3095 goto Done;
3096 }
3097 if (Data1.Type != EFI_IFR_TYPE_BOOLEAN) {
3098 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3099 break;
3100 }
3101
3102 if (Data1.Value.b) {
3103 Value = &Data3;
3104 } else {
3105 Value = &Data2;
3106 }
3107 break;
3108
3109 case EFI_IFR_FIND_OP:
3110 Status = IfrFind (FormSet, OpCode->Format, Value);
3111 break;
3112
3113 case EFI_IFR_MID_OP:
3114 Status = IfrMid (FormSet, Value);
3115 break;
3116
3117 case EFI_IFR_TOKEN_OP:
3118 Status = IfrToken (FormSet, Value);
3119 break;
3120
3121 case EFI_IFR_SPAN_OP:
3122 Status = IfrSpan (FormSet, OpCode->Flags, Value);
3123 break;
3124
3125 case EFI_IFR_MAP_OP:
3126 //
3127 // Pop the check value
3128 //
3129 Status = PopExpression (&Data1);
3130 if (EFI_ERROR (Status)) {
3131 goto Done;
3132 }
3133 //
3134 // Check MapExpression list is valid.
3135 //
3136 if (OpCode->MapExpressionList.ForwardLink == NULL) {
3137 Status = EFI_INVALID_PARAMETER;
3138 goto Done;
3139 }
3140 //
3141 // Go through map expression list.
3142 //
3143 SubExpressionLink = GetFirstNode(&OpCode->MapExpressionList);
3144 while (!IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3145 SubExpression = FORM_EXPRESSION_FROM_LINK (SubExpressionLink);
3146 //
3147 // Evaluate the first expression in this pair.
3148 //
3149 Status = EvaluateExpression (FormSet, Form, SubExpression);
3150 if (EFI_ERROR (Status)) {
3151 goto Done;
3152 }
3153 //
3154 // Compare the expression value with current value
3155 //
3156 if ((CompareHiiValue (&Data1, &SubExpression->Result, &Result, NULL) == EFI_SUCCESS) && (Result == 0)) {
3157 //
3158 // Try get the map value.
3159 //
3160 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3161 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3162 Status = EFI_INVALID_PARAMETER;
3163 goto Done;
3164 }
3165 SubExpression = FORM_EXPRESSION_FROM_LINK (SubExpressionLink);
3166 Status = EvaluateExpression (FormSet, Form, SubExpression);
3167 if (EFI_ERROR (Status)) {
3168 goto Done;
3169 }
3170 Value = &SubExpression->Result;
3171 break;
3172 }
3173 //
3174 // Skip the second expression on this pair.
3175 //
3176 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3177 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3178 Status = EFI_INVALID_PARAMETER;
3179 goto Done;
3180 }
3181 //
3182 // Goto the first expression on next pair.
3183 //
3184 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3185 }
3186
3187 //
3188 // No map value is found.
3189 //
3190 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3191 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3192 Value->Value.u8 = 0;
3193 }
3194 break;
3195
3196 default:
3197 break;
3198 }
3199 if (EFI_ERROR (Status) || Value->Type == EFI_IFR_TYPE_UNDEFINED) {
3200 goto Done;
3201 }
3202
3203 Status = PushExpression (Value);
3204 if (EFI_ERROR (Status)) {
3205 goto Done;
3206 }
3207 }
3208
3209 //
3210 // Pop the final result from expression stack
3211 //
3212 Value = &Data1;
3213 Status = PopExpression (Value);
3214 if (EFI_ERROR (Status)) {
3215 goto Done;
3216 }
3217
3218 //
3219 // After evaluating an expression, there should be only one value left on the expression stack
3220 //
3221 if (PopExpression (Value) != EFI_ACCESS_DENIED) {
3222 Status = EFI_INVALID_PARAMETER;
3223 }
3224
3225 Done:
3226 RestoreExpressionEvaluationStackOffset (StackOffset);
3227 if (!EFI_ERROR (Status)) {
3228 CopyMem (&Expression->Result, Value, sizeof (EFI_HII_VALUE));
3229 }
3230
3231 return Status;
3232 }
3233
3234 /**
3235 Return the result of the expression list. Check the expression list and
3236 return the highest priority express result.
3237 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3238
3239 @param ExpList The input expression list.
3240 @param Evaluate Whether need to evaluate the expression first.
3241 @param FormSet FormSet associated with this expression.
3242 @param Form Form associated with this expression.
3243
3244 @retval EXPRESS_RESULT Return the higher priority express result.
3245 DisableIf > SuppressIf > GrayOutIf > FALSE
3246
3247 **/
3248 EXPRESS_RESULT
3249 EvaluateExpressionList (
3250 IN FORM_EXPRESSION_LIST *ExpList,
3251 IN BOOLEAN Evaluate,
3252 IN FORM_BROWSER_FORMSET *FormSet, OPTIONAL
3253 IN FORM_BROWSER_FORM *Form OPTIONAL
3254 )
3255 {
3256 UINTN Index;
3257 EXPRESS_RESULT ReturnVal;
3258 EXPRESS_RESULT CompareOne;
3259 EFI_STATUS Status;
3260
3261 if (ExpList == NULL) {
3262 return ExpressFalse;
3263 }
3264
3265 ASSERT(ExpList->Signature == FORM_EXPRESSION_LIST_SIGNATURE);
3266 Index = 0;
3267
3268 //
3269 // Check whether need to evaluate the expression first.
3270 //
3271 if (Evaluate) {
3272 while (ExpList->Count > Index) {
3273 Status = EvaluateExpression (FormSet, Form, ExpList->Expression[Index++]);
3274 if (EFI_ERROR (Status)) {
3275 return ExpressFalse;
3276 }
3277 }
3278 }
3279
3280 //
3281 // Run the list of expressions.
3282 //
3283 ReturnVal = ExpressFalse;
3284 for (Index = 0; Index < ExpList->Count; Index++) {
3285 if (ExpList->Expression[Index]->Result.Type == EFI_IFR_TYPE_BOOLEAN &&
3286 ExpList->Expression[Index]->Result.Value.b) {
3287 switch (ExpList->Expression[Index]->Type) {
3288 case EFI_HII_EXPRESSION_SUPPRESS_IF:
3289 CompareOne = ExpressSuppress;
3290 break;
3291
3292 case EFI_HII_EXPRESSION_GRAY_OUT_IF:
3293 CompareOne = ExpressGrayOut;
3294 break;
3295
3296 case EFI_HII_EXPRESSION_DISABLE_IF:
3297 CompareOne = ExpressDisable;
3298 break;
3299
3300 default:
3301 return ExpressFalse;
3302 }
3303
3304 ReturnVal = ReturnVal < CompareOne ? CompareOne : ReturnVal;
3305 }
3306 }
3307
3308 return ReturnVal;
3309 }