]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Expression.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Update the code to follow UEFI spec, process date/time/ref value type as buffer type...
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Expression.c
1 /** @file
2 Utility functions for expression evaluation.
3
4 Copyright (c) 2007 - 2014, 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 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
993
994 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
995 EFI_IFR_TYPE_BUFFER when do the value compare.
996
997 @param Value Expression value to compare on.
998
999 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1000 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1001
1002 **/
1003 BOOLEAN
1004 IsTypeInBuffer (
1005 IN EFI_HII_VALUE *Value
1006 )
1007 {
1008 switch (Value->Type) {
1009 case EFI_IFR_TYPE_BUFFER:
1010 case EFI_IFR_TYPE_DATE:
1011 case EFI_IFR_TYPE_TIME:
1012 case EFI_IFR_TYPE_REF:
1013 return TRUE;
1014
1015 default:
1016 return FALSE;
1017 }
1018 }
1019
1020 /**
1021 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
1022
1023 @param Value Expression value to compare on.
1024
1025 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1026 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1027
1028 **/
1029 BOOLEAN
1030 IsTypeInUINT64 (
1031 IN EFI_HII_VALUE *Value
1032 )
1033 {
1034 switch (Value->Type) {
1035 case EFI_IFR_TYPE_NUM_SIZE_8:
1036 case EFI_IFR_TYPE_NUM_SIZE_16:
1037 case EFI_IFR_TYPE_NUM_SIZE_32:
1038 case EFI_IFR_TYPE_NUM_SIZE_64:
1039 case EFI_IFR_TYPE_BOOLEAN:
1040 return TRUE;
1041
1042 default:
1043 return FALSE;
1044 }
1045 }
1046
1047 /**
1048 Return the buffer length for this value.
1049
1050 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1051 EFI_IFR_TYPE_BUFFER when do the value compare.
1052
1053 @param Value Expression value to compare on.
1054
1055 @retval BufLen Return the buffer length.
1056
1057 **/
1058 UINT16
1059 GetLengthForValue (
1060 IN EFI_HII_VALUE *Value
1061 )
1062 {
1063 switch (Value->Type) {
1064 case EFI_IFR_TYPE_BUFFER:
1065 return Value->BufferLen;
1066
1067 case EFI_IFR_TYPE_DATE:
1068 return (UINT16) sizeof (EFI_HII_DATE);
1069
1070 case EFI_IFR_TYPE_TIME:
1071 return (UINT16) sizeof (EFI_HII_TIME);
1072
1073 case EFI_IFR_TYPE_REF:
1074 return (UINT16) sizeof (EFI_HII_REF);
1075
1076 default:
1077 return 0;
1078 }
1079 }
1080
1081 /**
1082 Return the buffer pointer for this value.
1083
1084 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1085 EFI_IFR_TYPE_BUFFER when do the value compare.
1086
1087 @param Value Expression value to compare on.
1088
1089 @retval Buf Return the buffer pointer.
1090
1091 **/
1092 UINT8 *
1093 GetBufferForValue (
1094 IN EFI_HII_VALUE *Value
1095 )
1096 {
1097 switch (Value->Type) {
1098 case EFI_IFR_TYPE_BUFFER:
1099 return Value->Buffer;
1100
1101 case EFI_IFR_TYPE_DATE:
1102 return (UINT8 *) (&Value->Value.date);
1103
1104 case EFI_IFR_TYPE_TIME:
1105 return (UINT8 *) (&Value->Value.time);
1106
1107 case EFI_IFR_TYPE_REF:
1108 return (UINT8 *) (&Value->Value.ref);
1109
1110 default:
1111 return NULL;
1112 }
1113 }
1114
1115 /**
1116 Evaluate opcode EFI_IFR_TO_STRING.
1117
1118 @param FormSet Formset which contains this opcode.
1119 @param Format String format in EFI_IFR_TO_STRING.
1120 @param Result Evaluation result for this opcode.
1121
1122 @retval EFI_SUCCESS Opcode evaluation success.
1123 @retval Other Opcode evaluation failed.
1124
1125 **/
1126 EFI_STATUS
1127 IfrToString (
1128 IN FORM_BROWSER_FORMSET *FormSet,
1129 IN UINT8 Format,
1130 OUT EFI_HII_VALUE *Result
1131 )
1132 {
1133 EFI_STATUS Status;
1134 EFI_HII_VALUE Value;
1135 CHAR16 *String;
1136 CHAR16 *PrintFormat;
1137 CHAR16 Buffer[MAXIMUM_VALUE_CHARACTERS];
1138 UINT8 *TmpBuf;
1139 UINT8 *SrcBuf;
1140 UINTN SrcLen;
1141 UINTN BufferSize;
1142
1143 Status = PopExpression (&Value);
1144 if (EFI_ERROR (Status)) {
1145 return Status;
1146 }
1147
1148 switch (Value.Type) {
1149 case EFI_IFR_TYPE_NUM_SIZE_8:
1150 case EFI_IFR_TYPE_NUM_SIZE_16:
1151 case EFI_IFR_TYPE_NUM_SIZE_32:
1152 case EFI_IFR_TYPE_NUM_SIZE_64:
1153 BufferSize = MAXIMUM_VALUE_CHARACTERS * sizeof (CHAR16);
1154 switch (Format) {
1155 case EFI_IFR_STRING_UNSIGNED_DEC:
1156 case EFI_IFR_STRING_SIGNED_DEC:
1157 PrintFormat = L"%ld";
1158 break;
1159
1160 case EFI_IFR_STRING_LOWERCASE_HEX:
1161 PrintFormat = L"%lx";
1162 break;
1163
1164 case EFI_IFR_STRING_UPPERCASE_HEX:
1165 PrintFormat = L"%lX";
1166 break;
1167
1168 default:
1169 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1170 return EFI_SUCCESS;
1171 }
1172 UnicodeSPrint (Buffer, BufferSize, PrintFormat, Value.Value.u64);
1173 String = Buffer;
1174 break;
1175
1176 case EFI_IFR_TYPE_STRING:
1177 CopyMem (Result, &Value, sizeof (EFI_HII_VALUE));
1178 return EFI_SUCCESS;
1179
1180 case EFI_IFR_TYPE_BOOLEAN:
1181 String = (Value.Value.b) ? L"True" : L"False";
1182 break;
1183
1184 case EFI_IFR_TYPE_BUFFER:
1185 case EFI_IFR_TYPE_DATE:
1186 case EFI_IFR_TYPE_TIME:
1187 case EFI_IFR_TYPE_REF:
1188 //
1189 // + 3 is base on the unicode format, the length may be odd number,
1190 // so need 1 byte to align, also need 2 bytes for L'\0'.
1191 //
1192 if (Value.Type == EFI_IFR_TYPE_BUFFER) {
1193 SrcLen = Value.BufferLen;
1194 SrcBuf = Value.Buffer;
1195 } else {
1196 SrcBuf = GetBufferForValue(&Value);
1197 SrcLen = GetLengthForValue(&Value);
1198 }
1199
1200 TmpBuf = AllocateZeroPool (SrcLen + 3);
1201 ASSERT (TmpBuf != NULL);
1202 if (Format == EFI_IFR_STRING_ASCII) {
1203 CopyMem (TmpBuf, SrcBuf, SrcLen);
1204 PrintFormat = L"%a";
1205 } else {
1206 // Format == EFI_IFR_STRING_UNICODE
1207 CopyMem (TmpBuf, SrcBuf, SrcLen * sizeof (CHAR16));
1208 PrintFormat = L"%s";
1209 }
1210 UnicodeSPrint (Buffer, sizeof (Buffer), PrintFormat, TmpBuf);
1211 String = Buffer;
1212 FreePool (TmpBuf);
1213 if (Value.Type == EFI_IFR_TYPE_BUFFER) {
1214 FreePool (Value.Buffer);
1215 }
1216 break;
1217
1218 default:
1219 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1220 return EFI_SUCCESS;
1221 }
1222
1223 Result->Type = EFI_IFR_TYPE_STRING;
1224 Result->Value.string = NewString (String, FormSet->HiiHandle);
1225 return EFI_SUCCESS;
1226 }
1227
1228
1229 /**
1230 Evaluate opcode EFI_IFR_TO_UINT.
1231
1232 @param FormSet Formset which contains this opcode.
1233 @param Result Evaluation result for this opcode.
1234
1235 @retval EFI_SUCCESS Opcode evaluation success.
1236 @retval Other Opcode evaluation failed.
1237
1238 **/
1239 EFI_STATUS
1240 IfrToUint (
1241 IN FORM_BROWSER_FORMSET *FormSet,
1242 OUT EFI_HII_VALUE *Result
1243 )
1244 {
1245 EFI_STATUS Status;
1246 EFI_HII_VALUE Value;
1247 CHAR16 *String;
1248 CHAR16 *StringPtr;
1249
1250 Status = PopExpression (&Value);
1251 if (EFI_ERROR (Status)) {
1252 return Status;
1253 }
1254
1255 if (Value.Type >= EFI_IFR_TYPE_OTHER && !IsTypeInBuffer(&Value)) {
1256 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1257 return EFI_SUCCESS;
1258 }
1259
1260 Status = EFI_SUCCESS;
1261 if (Value.Type == EFI_IFR_TYPE_STRING) {
1262 String = GetToken (Value.Value.string, FormSet->HiiHandle);
1263 if (String == NULL) {
1264 return EFI_NOT_FOUND;
1265 }
1266
1267 IfrStrToUpper (String);
1268 StringPtr = StrStr (String, L"0X");
1269 if (StringPtr != NULL) {
1270 //
1271 // Hex string
1272 //
1273 Result->Value.u64 = StrHexToUint64 (String);
1274 } else {
1275 //
1276 // decimal string
1277 //
1278 Result->Value.u64 = StrDecimalToUint64 (String);
1279 }
1280 FreePool (String);
1281 } else if (IsTypeInBuffer(&Value)) {
1282 if (GetLengthForValue (&Value) > 8) {
1283 if (Value.Type == EFI_IFR_TYPE_BUFFER) {
1284 FreePool (Value.Buffer);
1285 }
1286 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1287 return EFI_SUCCESS;
1288 }
1289 Result->Value.u64 = *(UINT64*) GetBufferForValue (&Value);
1290 if (Value.Type == EFI_IFR_TYPE_BUFFER) {
1291 FreePool (Value.Buffer);
1292 }
1293 } else {
1294 CopyMem (Result, &Value, sizeof (EFI_HII_VALUE));
1295 }
1296
1297 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1298 return Status;
1299 }
1300
1301
1302 /**
1303 Evaluate opcode EFI_IFR_CATENATE.
1304
1305 @param FormSet Formset which contains this opcode.
1306 @param Result Evaluation result for this opcode.
1307
1308 @retval EFI_SUCCESS Opcode evaluation success.
1309 @retval Other Opcode evaluation failed.
1310
1311 **/
1312 EFI_STATUS
1313 IfrCatenate (
1314 IN FORM_BROWSER_FORMSET *FormSet,
1315 OUT EFI_HII_VALUE *Result
1316 )
1317 {
1318 EFI_STATUS Status;
1319 EFI_HII_VALUE Value[2];
1320 CHAR16 *String[2];
1321 UINTN Index;
1322 CHAR16 *StringPtr;
1323 UINTN Size;
1324 UINT16 Length0;
1325 UINT16 Length1;
1326
1327 //
1328 // String[0] - The second string
1329 // String[1] - The first string
1330 //
1331 String[0] = NULL;
1332 String[1] = NULL;
1333 StringPtr = NULL;
1334 Status = EFI_SUCCESS;
1335 ZeroMem (Value, sizeof (Value));
1336
1337 Status = PopExpression (&Value[0]);
1338 if (EFI_ERROR (Status)) {
1339 goto Done;
1340 }
1341
1342 Status = PopExpression (&Value[1]);
1343 if (EFI_ERROR (Status)) {
1344 goto Done;
1345 }
1346
1347 for (Index = 0; Index < 2; Index++) {
1348 if (Value[Index].Type != EFI_IFR_TYPE_STRING && !IsTypeInBuffer(&Value[Index])) {
1349 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1350 Status = EFI_SUCCESS;
1351 goto Done;
1352 }
1353
1354 if (Value[Index].Type == EFI_IFR_TYPE_STRING) {
1355 String[Index] = GetToken (Value[Index].Value.string, FormSet->HiiHandle);
1356 if (String[Index] == NULL) {
1357 Status = EFI_NOT_FOUND;
1358 goto Done;
1359 }
1360 }
1361 }
1362
1363 if (Value[0].Type == EFI_IFR_TYPE_STRING) {
1364 Size = StrSize (String[0]);
1365 StringPtr= AllocatePool (StrSize (String[1]) + Size);
1366 ASSERT (StringPtr != NULL);
1367 StrCpy (StringPtr, String[1]);
1368 StrCat (StringPtr, String[0]);
1369
1370 Result->Type = EFI_IFR_TYPE_STRING;
1371 Result->Value.string = NewString (StringPtr, FormSet->HiiHandle);
1372 } else {
1373 Result->Type = EFI_IFR_TYPE_BUFFER;
1374 Length0 = GetLengthForValue(&Value[0]);
1375 Length1 = GetLengthForValue(&Value[1]);
1376 Result->BufferLen = (UINT16) (Length0 + Length1);
1377
1378 Result->Buffer = AllocateZeroPool (Result->BufferLen);
1379 ASSERT (Result->Buffer != NULL);
1380
1381 CopyMem (Result->Buffer, GetBufferForValue(&Value[0]), Length0);
1382 CopyMem (&Result->Buffer[Length0], GetBufferForValue(&Value[1]), Length1);
1383 }
1384 Done:
1385 if (Value[0].Buffer != NULL) {
1386 FreePool (Value[0].Buffer);
1387 }
1388 if (Value[1].Buffer != NULL) {
1389 FreePool (Value[1].Buffer);
1390 }
1391 if (String[0] != NULL) {
1392 FreePool (String[0]);
1393 }
1394 if (String[1] != NULL) {
1395 FreePool (String[1]);
1396 }
1397 if (StringPtr != NULL) {
1398 FreePool (StringPtr);
1399 }
1400
1401 return Status;
1402 }
1403
1404
1405 /**
1406 Evaluate opcode EFI_IFR_MATCH.
1407
1408 @param FormSet Formset which contains this opcode.
1409 @param Result Evaluation result for this opcode.
1410
1411 @retval EFI_SUCCESS Opcode evaluation success.
1412 @retval Other Opcode evaluation failed.
1413
1414 **/
1415 EFI_STATUS
1416 IfrMatch (
1417 IN FORM_BROWSER_FORMSET *FormSet,
1418 OUT EFI_HII_VALUE *Result
1419 )
1420 {
1421 EFI_STATUS Status;
1422 EFI_HII_VALUE Value[2];
1423 CHAR16 *String[2];
1424 UINTN Index;
1425
1426 //
1427 // String[0] - The string to search
1428 // String[1] - pattern
1429 //
1430 String[0] = NULL;
1431 String[1] = NULL;
1432 Status = EFI_SUCCESS;
1433 ZeroMem (Value, sizeof (Value));
1434
1435 Status = PopExpression (&Value[0]);
1436 if (EFI_ERROR (Status)) {
1437 goto Done;
1438 }
1439
1440 Status = PopExpression (&Value[1]);
1441 if (EFI_ERROR (Status)) {
1442 goto Done;
1443 }
1444
1445 for (Index = 0; Index < 2; Index++) {
1446 if (Value[Index].Type != EFI_IFR_TYPE_STRING) {
1447 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1448 Status = EFI_SUCCESS;
1449 goto Done;
1450 }
1451
1452 String[Index] = GetToken (Value[Index].Value.string, FormSet->HiiHandle);
1453 if (String [Index] == NULL) {
1454 Status = EFI_NOT_FOUND;
1455 goto Done;
1456 }
1457 }
1458
1459 Result->Type = EFI_IFR_TYPE_BOOLEAN;
1460 Result->Value.b = mUnicodeCollation->MetaiMatch (mUnicodeCollation, String[0], String[1]);
1461
1462 Done:
1463 if (String[0] != NULL) {
1464 FreePool (String[0]);
1465 }
1466 if (String[1] != NULL) {
1467 FreePool (String[1]);
1468 }
1469
1470 return Status;
1471 }
1472
1473
1474 /**
1475 Evaluate opcode EFI_IFR_FIND.
1476
1477 @param FormSet Formset which contains this opcode.
1478 @param Format Case sensitive or insensitive.
1479 @param Result Evaluation result for this opcode.
1480
1481 @retval EFI_SUCCESS Opcode evaluation success.
1482 @retval Other Opcode evaluation failed.
1483
1484 **/
1485 EFI_STATUS
1486 IfrFind (
1487 IN FORM_BROWSER_FORMSET *FormSet,
1488 IN UINT8 Format,
1489 OUT EFI_HII_VALUE *Result
1490 )
1491 {
1492 EFI_STATUS Status;
1493 EFI_HII_VALUE Value[3];
1494 CHAR16 *String[2];
1495 UINTN Base;
1496 CHAR16 *StringPtr;
1497 UINTN Index;
1498
1499 ZeroMem (Value, sizeof (Value));
1500
1501 if (Format > EFI_IFR_FF_CASE_INSENSITIVE) {
1502 return EFI_INVALID_PARAMETER;
1503 }
1504
1505 Status = PopExpression (&Value[0]);
1506 if (EFI_ERROR (Status)) {
1507 return Status;
1508 }
1509
1510 Status = PopExpression (&Value[1]);
1511 if (EFI_ERROR (Status)) {
1512 return Status;
1513 }
1514
1515 Status = PopExpression (&Value[2]);
1516 if (EFI_ERROR (Status)) {
1517 return Status;
1518 }
1519
1520 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1521 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1522 return EFI_SUCCESS;
1523 }
1524 Base = (UINTN) Value[0].Value.u64;
1525
1526 //
1527 // String[0] - sub-string
1528 // String[1] - The string to search
1529 //
1530 String[0] = NULL;
1531 String[1] = NULL;
1532 for (Index = 0; Index < 2; Index++) {
1533 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1534 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1535 Status = EFI_SUCCESS;
1536 goto Done;
1537 }
1538
1539 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1540 if (String[Index] == NULL) {
1541 Status = EFI_NOT_FOUND;
1542 goto Done;
1543 }
1544
1545 if (Format == EFI_IFR_FF_CASE_INSENSITIVE) {
1546 //
1547 // Case insensitive, convert both string to upper case
1548 //
1549 IfrStrToUpper (String[Index]);
1550 }
1551 }
1552
1553 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1554 if (Base >= StrLen (String[1])) {
1555 Result->Value.u64 = 0xFFFFFFFFFFFFFFFFULL;
1556 } else {
1557 StringPtr = StrStr (String[1] + Base, String[0]);
1558 Result->Value.u64 = (StringPtr == NULL) ? 0xFFFFFFFFFFFFFFFFULL : (StringPtr - String[1]);
1559 }
1560
1561 Done:
1562 if (String[0] != NULL) {
1563 FreePool (String[0]);
1564 }
1565 if (String[1] != NULL) {
1566 FreePool (String[1]);
1567 }
1568
1569 return Status;
1570 }
1571
1572
1573 /**
1574 Evaluate opcode EFI_IFR_MID.
1575
1576 @param FormSet Formset which contains this opcode.
1577 @param Result Evaluation result for this opcode.
1578
1579 @retval EFI_SUCCESS Opcode evaluation success.
1580 @retval Other Opcode evaluation failed.
1581
1582 **/
1583 EFI_STATUS
1584 IfrMid (
1585 IN FORM_BROWSER_FORMSET *FormSet,
1586 OUT EFI_HII_VALUE *Result
1587 )
1588 {
1589 EFI_STATUS Status;
1590 EFI_HII_VALUE Value[3];
1591 CHAR16 *String;
1592 UINTN Base;
1593 UINTN Length;
1594 CHAR16 *SubString;
1595 UINT16 BufferLen;
1596 UINT8 *Buffer;
1597
1598 ZeroMem (Value, sizeof (Value));
1599
1600 Status = PopExpression (&Value[0]);
1601 if (EFI_ERROR (Status)) {
1602 return Status;
1603 }
1604
1605 Status = PopExpression (&Value[1]);
1606 if (EFI_ERROR (Status)) {
1607 return Status;
1608 }
1609
1610 Status = PopExpression (&Value[2]);
1611 if (EFI_ERROR (Status)) {
1612 return Status;
1613 }
1614
1615 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1616 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1617 return EFI_SUCCESS;
1618 }
1619 Length = (UINTN) Value[0].Value.u64;
1620
1621 if (Value[1].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1622 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1623 return EFI_SUCCESS;
1624 }
1625 Base = (UINTN) Value[1].Value.u64;
1626
1627 if (Value[2].Type != EFI_IFR_TYPE_STRING && !IsTypeInBuffer(&Value[2])) {
1628 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1629 return EFI_SUCCESS;
1630 }
1631 if (Value[2].Type == EFI_IFR_TYPE_STRING) {
1632 String = GetToken (Value[2].Value.string, FormSet->HiiHandle);
1633 if (String == NULL) {
1634 return EFI_NOT_FOUND;
1635 }
1636
1637 if (Length == 0 || Base >= StrLen (String)) {
1638 SubString = gEmptyString;
1639 } else {
1640 SubString = String + Base;
1641 if ((Base + Length) < StrLen (String)) {
1642 SubString[Length] = L'\0';
1643 }
1644 }
1645
1646 Result->Type = EFI_IFR_TYPE_STRING;
1647 Result->Value.string = NewString (SubString, FormSet->HiiHandle);
1648
1649 FreePool (String);
1650 } else {
1651 BufferLen = GetLengthForValue (&Value[2]);
1652 Buffer = GetBufferForValue (&Value[2]);
1653
1654 Result->Type = EFI_IFR_TYPE_BUFFER;
1655 if (Length == 0 || Base >= BufferLen) {
1656 Result->BufferLen = 0;
1657 Result->Buffer = NULL;
1658 } else {
1659 Result->BufferLen = (UINT16)((BufferLen - Base) < Length ? (BufferLen - Base) : Length);
1660 Result->Buffer = AllocateZeroPool (Result->BufferLen);
1661 ASSERT (Result->Buffer != NULL);
1662 CopyMem (Result->Buffer, &Buffer[Base], Result->BufferLen);
1663 }
1664
1665 if (Value[2].Type == EFI_IFR_TYPE_BUFFER) {
1666 FreePool (Value[2].Buffer);
1667 }
1668 }
1669
1670 return Status;
1671 }
1672
1673
1674 /**
1675 Evaluate opcode EFI_IFR_TOKEN.
1676
1677 @param FormSet Formset which contains this opcode.
1678 @param Result Evaluation result for this opcode.
1679
1680 @retval EFI_SUCCESS Opcode evaluation success.
1681 @retval Other Opcode evaluation failed.
1682
1683 **/
1684 EFI_STATUS
1685 IfrToken (
1686 IN FORM_BROWSER_FORMSET *FormSet,
1687 OUT EFI_HII_VALUE *Result
1688 )
1689 {
1690 EFI_STATUS Status;
1691 EFI_HII_VALUE Value[3];
1692 CHAR16 *String[2];
1693 UINTN Count;
1694 CHAR16 *Delimiter;
1695 CHAR16 *SubString;
1696 CHAR16 *StringPtr;
1697 UINTN Index;
1698
1699 ZeroMem (Value, sizeof (Value));
1700
1701 Status = PopExpression (&Value[0]);
1702 if (EFI_ERROR (Status)) {
1703 return Status;
1704 }
1705
1706 Status = PopExpression (&Value[1]);
1707 if (EFI_ERROR (Status)) {
1708 return Status;
1709 }
1710
1711 Status = PopExpression (&Value[2]);
1712 if (EFI_ERROR (Status)) {
1713 return Status;
1714 }
1715
1716 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1717 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1718 return EFI_SUCCESS;
1719 }
1720 Count = (UINTN) Value[0].Value.u64;
1721
1722 //
1723 // String[0] - Delimiter
1724 // String[1] - The string to search
1725 //
1726 String[0] = NULL;
1727 String[1] = NULL;
1728 for (Index = 0; Index < 2; Index++) {
1729 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1730 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1731 Status = EFI_SUCCESS;
1732 goto Done;
1733 }
1734
1735 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1736 if (String[Index] == NULL) {
1737 Status = EFI_NOT_FOUND;
1738 goto Done;
1739 }
1740 }
1741
1742 Delimiter = String[0];
1743 SubString = String[1];
1744 while (Count > 0) {
1745 SubString = StrStr (SubString, Delimiter);
1746 if (SubString != NULL) {
1747 //
1748 // Skip over the delimiter
1749 //
1750 SubString = SubString + StrLen (Delimiter);
1751 } else {
1752 break;
1753 }
1754 Count--;
1755 }
1756
1757 if (SubString == NULL) {
1758 //
1759 // nth delimited sub-string not found, push an empty string
1760 //
1761 SubString = gEmptyString;
1762 } else {
1763 //
1764 // Put a NULL terminator for nth delimited sub-string
1765 //
1766 StringPtr = StrStr (SubString, Delimiter);
1767 if (StringPtr != NULL) {
1768 *StringPtr = L'\0';
1769 }
1770 }
1771
1772 Result->Type = EFI_IFR_TYPE_STRING;
1773 Result->Value.string = NewString (SubString, FormSet->HiiHandle);
1774
1775 Done:
1776 if (String[0] != NULL) {
1777 FreePool (String[0]);
1778 }
1779 if (String[1] != NULL) {
1780 FreePool (String[1]);
1781 }
1782
1783 return Status;
1784 }
1785
1786
1787 /**
1788 Evaluate opcode EFI_IFR_SPAN.
1789
1790 @param FormSet Formset which contains this opcode.
1791 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1792 @param Result Evaluation result for this opcode.
1793
1794 @retval EFI_SUCCESS Opcode evaluation success.
1795 @retval Other Opcode evaluation failed.
1796
1797 **/
1798 EFI_STATUS
1799 IfrSpan (
1800 IN FORM_BROWSER_FORMSET *FormSet,
1801 IN UINT8 Flags,
1802 OUT EFI_HII_VALUE *Result
1803 )
1804 {
1805 EFI_STATUS Status;
1806 EFI_HII_VALUE Value[3];
1807 CHAR16 *String[2];
1808 CHAR16 *Charset;
1809 UINTN Base;
1810 UINTN Index;
1811 CHAR16 *StringPtr;
1812 BOOLEAN Found;
1813
1814 ZeroMem (Value, sizeof (Value));
1815
1816 Status = PopExpression (&Value[0]);
1817 if (EFI_ERROR (Status)) {
1818 return Status;
1819 }
1820
1821 Status = PopExpression (&Value[1]);
1822 if (EFI_ERROR (Status)) {
1823 return Status;
1824 }
1825
1826 Status = PopExpression (&Value[2]);
1827 if (EFI_ERROR (Status)) {
1828 return Status;
1829 }
1830
1831 if (Value[0].Type > EFI_IFR_TYPE_NUM_SIZE_64) {
1832 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1833 return EFI_SUCCESS;
1834 }
1835 Base = (UINTN) Value[0].Value.u64;
1836
1837 //
1838 // String[0] - Charset
1839 // String[1] - The string to search
1840 //
1841 String[0] = NULL;
1842 String[1] = NULL;
1843 for (Index = 0; Index < 2; Index++) {
1844 if (Value[Index + 1].Type != EFI_IFR_TYPE_STRING) {
1845 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1846 Status = EFI_SUCCESS;
1847 goto Done;
1848 }
1849
1850 String[Index] = GetToken (Value[Index + 1].Value.string, FormSet->HiiHandle);
1851 if (String [Index] == NULL) {
1852 Status = EFI_NOT_FOUND;
1853 goto Done;
1854 }
1855 }
1856
1857 if (Base >= StrLen (String[1])) {
1858 Result->Type = EFI_IFR_TYPE_UNDEFINED;
1859 Status = EFI_SUCCESS;
1860 goto Done;
1861 }
1862
1863 Found = FALSE;
1864 StringPtr = String[1] + Base;
1865 Charset = String[0];
1866 while (*StringPtr != 0 && !Found) {
1867 Index = 0;
1868 while (Charset[Index] != 0) {
1869 if (*StringPtr >= Charset[Index] && *StringPtr <= Charset[Index + 1]) {
1870 if (Flags == EFI_IFR_FLAGS_FIRST_MATCHING) {
1871 Found = TRUE;
1872 break;
1873 }
1874 } else {
1875 if (Flags == EFI_IFR_FLAGS_FIRST_NON_MATCHING) {
1876 Found = TRUE;
1877 break;
1878 }
1879 }
1880 //
1881 // Skip characters pair representing low-end of a range and high-end of a range
1882 //
1883 Index += 2;
1884 }
1885
1886 if (!Found) {
1887 StringPtr++;
1888 }
1889 }
1890
1891 Result->Type = EFI_IFR_TYPE_NUM_SIZE_64;
1892 Result->Value.u64 = StringPtr - String[1];
1893
1894 Done:
1895 if (String[0] != NULL) {
1896 FreePool (String[0]);
1897 }
1898 if (String[1] != NULL) {
1899 FreePool (String[1]);
1900 }
1901
1902 return Status;
1903 }
1904
1905
1906 /**
1907 Zero extend integer/boolean/date/time to UINT64 for comparing.
1908
1909 @param Value HII Value to be converted.
1910
1911 **/
1912 VOID
1913 ExtendValueToU64 (
1914 IN EFI_HII_VALUE *Value
1915 )
1916 {
1917 UINT64 Temp;
1918
1919 Temp = 0;
1920 switch (Value->Type) {
1921 case EFI_IFR_TYPE_NUM_SIZE_8:
1922 Temp = Value->Value.u8;
1923 break;
1924
1925 case EFI_IFR_TYPE_NUM_SIZE_16:
1926 Temp = Value->Value.u16;
1927 break;
1928
1929 case EFI_IFR_TYPE_NUM_SIZE_32:
1930 Temp = Value->Value.u32;
1931 break;
1932
1933 case EFI_IFR_TYPE_BOOLEAN:
1934 Temp = Value->Value.b;
1935 break;
1936
1937 case EFI_IFR_TYPE_TIME:
1938 Temp = Value->Value.u32 & 0xffffff;
1939 break;
1940
1941 case EFI_IFR_TYPE_DATE:
1942 Temp = Value->Value.u32;
1943 break;
1944
1945 default:
1946 return;
1947 }
1948
1949 Value->Value.u64 = Temp;
1950 }
1951
1952 /**
1953 Get UINT64 type value.
1954
1955 @param Value Input Hii value.
1956
1957 @retval UINT64 Return the UINT64 type value.
1958
1959 **/
1960 UINT64
1961 HiiValueToUINT64 (
1962 IN EFI_HII_VALUE *Value
1963 )
1964 {
1965 UINT64 RetVal;
1966
1967 RetVal = 0;
1968
1969 switch (Value->Type) {
1970 case EFI_IFR_TYPE_NUM_SIZE_8:
1971 RetVal = Value->Value.u8;
1972 break;
1973
1974 case EFI_IFR_TYPE_NUM_SIZE_16:
1975 RetVal = Value->Value.u16;
1976 break;
1977
1978 case EFI_IFR_TYPE_NUM_SIZE_32:
1979 RetVal = Value->Value.u32;
1980 break;
1981
1982 case EFI_IFR_TYPE_BOOLEAN:
1983 RetVal = Value->Value.b;
1984 break;
1985
1986 case EFI_IFR_TYPE_DATE:
1987 RetVal = *(UINT64*) &Value->Value.date;
1988 break;
1989
1990 case EFI_IFR_TYPE_TIME:
1991 RetVal = (*(UINT64*) &Value->Value.time) & 0xffffff;
1992 break;
1993
1994 default:
1995 RetVal = Value->Value.u64;
1996 break;
1997 }
1998
1999 return RetVal;
2000 }
2001
2002 /**
2003 Compare two Hii value.
2004
2005 @param Value1 Expression value to compare on left-hand.
2006 @param Value2 Expression value to compare on right-hand.
2007 @param Result Return value after compare.
2008 retval 0 Two operators equal.
2009 return Positive value if Value1 is greater than Value2.
2010 retval Negative value if Value1 is less than Value2.
2011 @param HiiHandle Only required for string compare.
2012
2013 @retval other Could not perform compare on two values.
2014 @retval EFI_SUCCESS Compare the value success.
2015
2016 **/
2017 EFI_STATUS
2018 CompareHiiValue (
2019 IN EFI_HII_VALUE *Value1,
2020 IN EFI_HII_VALUE *Value2,
2021 OUT INTN *Result,
2022 IN EFI_HII_HANDLE HiiHandle OPTIONAL
2023 )
2024 {
2025 INT64 Temp64;
2026 CHAR16 *Str1;
2027 CHAR16 *Str2;
2028 UINTN Len;
2029 UINT8 *Buf1;
2030 UINT16 Buf1Len;
2031 UINT8 *Buf2;
2032 UINT16 Buf2Len;
2033
2034 if (Value1->Type == EFI_IFR_TYPE_STRING && Value2->Type == EFI_IFR_TYPE_STRING) {
2035 if (Value1->Value.string == 0 || Value2->Value.string == 0) {
2036 //
2037 // StringId 0 is reserved
2038 //
2039 return EFI_INVALID_PARAMETER;
2040 }
2041
2042 if (Value1->Value.string == Value2->Value.string) {
2043 *Result = 0;
2044 return EFI_SUCCESS;
2045 }
2046
2047 Str1 = GetToken (Value1->Value.string, HiiHandle);
2048 if (Str1 == NULL) {
2049 //
2050 // String not found
2051 //
2052 return EFI_NOT_FOUND;
2053 }
2054
2055 Str2 = GetToken (Value2->Value.string, HiiHandle);
2056 if (Str2 == NULL) {
2057 FreePool (Str1);
2058 return EFI_NOT_FOUND;
2059 }
2060
2061 *Result = StrCmp (Str1, Str2);
2062
2063 FreePool (Str1);
2064 FreePool (Str2);
2065
2066 return EFI_SUCCESS;
2067 }
2068
2069 //
2070 // Take types(date, time, ref, buffer) as buffer
2071 //
2072 if (IsTypeInBuffer(Value1) && IsTypeInBuffer(Value2)) {
2073 Buf1 = GetBufferForValue(Value1);
2074 Buf1Len = GetLengthForValue(Value1);
2075 Buf2 = GetBufferForValue(Value2);
2076 Buf2Len = GetLengthForValue(Value2);
2077
2078 Len = Buf1Len > Buf2Len ? Buf2Len : Buf1Len;
2079 *Result = CompareMem (Buf1, Buf2, Len);
2080 if ((*Result == 0) && (Buf1Len != Buf2Len)) {
2081 //
2082 // In this case, means base on samll number buffer, the data is same
2083 // So which value has more data, which value is bigger.
2084 //
2085 *Result = Buf1Len > Buf2Len ? 1 : -1;
2086 }
2087 return EFI_SUCCESS;
2088 }
2089
2090 //
2091 // Take types(integer, boolean) as integer
2092 //
2093 if (IsTypeInUINT64(Value1) && IsTypeInUINT64(Value2)) {
2094 Temp64 = HiiValueToUINT64(Value1) - HiiValueToUINT64(Value2);
2095 if (Temp64 > 0) {
2096 *Result = 1;
2097 } else if (Temp64 < 0) {
2098 *Result = -1;
2099 } else {
2100 *Result = 0;
2101 }
2102
2103 return EFI_SUCCESS;
2104 }
2105
2106 return EFI_UNSUPPORTED;
2107 }
2108
2109 /**
2110 Check if current user has the privilege specified by the permissions GUID.
2111
2112 @param[in] Guid A GUID specifying setup access permissions.
2113
2114 @retval TRUE Current user has the privilege.
2115 @retval FALSE Current user does not have the privilege.
2116 **/
2117 BOOLEAN
2118 CheckUserPrivilege (
2119 IN EFI_GUID *Guid
2120 )
2121 {
2122 EFI_STATUS Status;
2123 EFI_USER_PROFILE_HANDLE UserProfileHandle;
2124 EFI_USER_INFO_HANDLE UserInfoHandle;
2125 EFI_USER_INFO *UserInfo;
2126 EFI_GUID *UserPermissionsGuid;
2127 UINTN UserInfoSize;
2128 UINTN AccessControlDataSize;
2129 EFI_USER_INFO_ACCESS_CONTROL *AccessControl;
2130 UINTN RemainSize;
2131
2132 if (mUserManager == NULL) {
2133 Status = gBS->LocateProtocol (
2134 &gEfiUserManagerProtocolGuid,
2135 NULL,
2136 (VOID **) &mUserManager
2137 );
2138 if (EFI_ERROR (Status)) {
2139 ///
2140 /// If the system does not support user management, then it is assumed that
2141 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
2142 /// op-code is always TRUE.
2143 ///
2144 return TRUE;
2145 }
2146 }
2147
2148 Status = mUserManager->Current (mUserManager, &UserProfileHandle);
2149 ASSERT_EFI_ERROR (Status);
2150
2151 ///
2152 /// Enumerate all user information of the current user profile
2153 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
2154 ///
2155
2156 for (UserInfoHandle = NULL;;) {
2157 Status = mUserManager->GetNextInfo (mUserManager, UserProfileHandle, &UserInfoHandle);
2158 if (EFI_ERROR (Status)) {
2159 break;
2160 }
2161
2162 UserInfoSize = 0;
2163 Status = mUserManager->GetInfo (mUserManager, UserProfileHandle, UserInfoHandle, NULL, &UserInfoSize);
2164 if (Status != EFI_BUFFER_TOO_SMALL) {
2165 continue;
2166 }
2167
2168 UserInfo = (EFI_USER_INFO *) AllocatePool (UserInfoSize);
2169 if (UserInfo == NULL) {
2170 break;
2171 }
2172
2173 Status = mUserManager->GetInfo (mUserManager, UserProfileHandle, UserInfoHandle, UserInfo, &UserInfoSize);
2174 if (EFI_ERROR (Status) ||
2175 UserInfo->InfoType != EFI_USER_INFO_ACCESS_POLICY_RECORD ||
2176 UserInfo->InfoSize <= sizeof (EFI_USER_INFO)) {
2177 FreePool (UserInfo);
2178 continue;
2179 }
2180
2181 RemainSize = UserInfo->InfoSize - sizeof (EFI_USER_INFO);
2182 AccessControl = (EFI_USER_INFO_ACCESS_CONTROL *)(UserInfo + 1);
2183 while (RemainSize >= sizeof (EFI_USER_INFO_ACCESS_CONTROL)) {
2184 if (RemainSize < AccessControl->Size || AccessControl->Size < sizeof (EFI_USER_INFO_ACCESS_CONTROL)) {
2185 break;
2186 }
2187 if (AccessControl->Type == EFI_USER_INFO_ACCESS_SETUP) {
2188 ///
2189 /// Check if current user has the privilege specified by the permissions GUID.
2190 ///
2191
2192 UserPermissionsGuid = (EFI_GUID *)(AccessControl + 1);
2193 AccessControlDataSize = AccessControl->Size - sizeof (EFI_USER_INFO_ACCESS_CONTROL);
2194 while (AccessControlDataSize >= sizeof (EFI_GUID)) {
2195 if (CompareGuid (Guid, UserPermissionsGuid)) {
2196 FreePool (UserInfo);
2197 return TRUE;
2198 }
2199 UserPermissionsGuid++;
2200 AccessControlDataSize -= sizeof (EFI_GUID);
2201 }
2202 }
2203 RemainSize -= AccessControl->Size;
2204 AccessControl = (EFI_USER_INFO_ACCESS_CONTROL *)((UINT8 *)AccessControl + AccessControl->Size);
2205 }
2206
2207 FreePool (UserInfo);
2208 }
2209 return FALSE;
2210 }
2211
2212 /**
2213 Get question value from the predefined formset.
2214
2215 @param DevicePath The driver's device path which produece the formset data.
2216 @param InputHiiHandle The hii handle associate with the formset data.
2217 @param FormSetGuid The formset guid which include the question.
2218 @param QuestionId The question id which need to get value from.
2219 @param Value The return data about question's value.
2220
2221 @retval TRUE Get the question value success.
2222 @retval FALSE Get the question value failed.
2223 **/
2224 BOOLEAN
2225 GetQuestionValueFromForm (
2226 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2227 IN EFI_HII_HANDLE InputHiiHandle,
2228 IN EFI_GUID *FormSetGuid,
2229 IN EFI_QUESTION_ID QuestionId,
2230 OUT EFI_HII_VALUE *Value
2231 )
2232 {
2233 EFI_STATUS Status;
2234 EFI_HII_HANDLE HiiHandle;
2235 FORM_BROWSER_STATEMENT *Question;
2236 FORM_BROWSER_FORMSET *FormSet;
2237 FORM_BROWSER_FORM *Form;
2238 BOOLEAN GetTheVal;
2239 LIST_ENTRY *Link;
2240
2241 //
2242 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2243 //
2244 ASSERT ((DevicePath != NULL && InputHiiHandle == NULL) ||
2245 (DevicePath == NULL && InputHiiHandle != NULL) );
2246
2247 GetTheVal = TRUE;
2248 HiiHandle = NULL;
2249 Question = NULL;
2250 Form = NULL;
2251
2252 //
2253 // Get HiiHandle.
2254 //
2255 if (DevicePath != NULL) {
2256 HiiHandle = DevicePathToHiiHandle (DevicePath, FormSetGuid);
2257 if (HiiHandle == NULL) {
2258 return FALSE;
2259 }
2260 } else {
2261 HiiHandle = InputHiiHandle;
2262 }
2263 ASSERT (HiiHandle != NULL);
2264
2265 //
2266 // Get the formset data include this question.
2267 //
2268 FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
2269 ASSERT (FormSet != NULL);
2270 Status = InitializeFormSet(HiiHandle, FormSetGuid, FormSet);
2271 if (EFI_ERROR (Status)) {
2272 GetTheVal = FALSE;
2273 goto Done;
2274 }
2275
2276 //
2277 // Base on the Question Id to get the question info.
2278 //
2279 Question = IdToQuestion(FormSet, NULL, QuestionId);
2280 if (Question == NULL) {
2281 GetTheVal = FALSE;
2282 goto Done;
2283 }
2284
2285 //
2286 // Search form in the formset scope
2287 //
2288 Link = GetFirstNode (&FormSet->FormListHead);
2289 while (!IsNull (&FormSet->FormListHead, Link)) {
2290 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
2291
2292 Question = IdToQuestion2 (Form, QuestionId);
2293 if (Question != NULL) {
2294 break;
2295 }
2296
2297 Link = GetNextNode (&FormSet->FormListHead, Link);
2298 Form = NULL;
2299 }
2300 ASSERT (Form != NULL);
2301
2302 //
2303 // Get the question value.
2304 //
2305 Status = GetQuestionValue(FormSet, Form, Question, GetSetValueWithHiiDriver);
2306 if (EFI_ERROR (Status)) {
2307 GetTheVal = FALSE;
2308 goto Done;
2309 }
2310
2311 CopyMem (Value, &Question->HiiValue, sizeof (EFI_HII_VALUE));
2312
2313 Done:
2314 //
2315 // Clean the formset structure and restore the global parameter.
2316 //
2317 if (FormSet != NULL) {
2318 DestroyFormSet (FormSet);
2319 }
2320
2321 return GetTheVal;
2322 }
2323
2324 /**
2325 Evaluate the result of a HII expression.
2326
2327 If Expression is NULL, then ASSERT.
2328
2329 @param FormSet FormSet associated with this expression.
2330 @param Form Form associated with this expression.
2331 @param Expression Expression to be evaluated.
2332
2333 @retval EFI_SUCCESS The expression evaluated successfuly
2334 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2335 could not be found.
2336 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2337 stack.
2338 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2339 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2340
2341 **/
2342 EFI_STATUS
2343 EvaluateExpression (
2344 IN FORM_BROWSER_FORMSET *FormSet,
2345 IN FORM_BROWSER_FORM *Form,
2346 IN OUT FORM_EXPRESSION *Expression
2347 )
2348 {
2349 EFI_STATUS Status;
2350 LIST_ENTRY *Link;
2351 EXPRESSION_OPCODE *OpCode;
2352 FORM_BROWSER_STATEMENT *Question;
2353 FORM_BROWSER_STATEMENT *Question2;
2354 UINT16 Index;
2355 EFI_HII_VALUE Data1;
2356 EFI_HII_VALUE Data2;
2357 EFI_HII_VALUE Data3;
2358 FORM_EXPRESSION *RuleExpression;
2359 EFI_HII_VALUE *Value;
2360 INTN Result;
2361 CHAR16 *StrPtr;
2362 CHAR16 *NameValue;
2363 UINT32 TempValue;
2364 LIST_ENTRY *SubExpressionLink;
2365 FORM_EXPRESSION *SubExpression;
2366 UINTN StackOffset;
2367 UINTN TempLength;
2368 CHAR16 TempStr[5];
2369 UINT8 DigitUint8;
2370 UINT8 *TempBuffer;
2371 EFI_TIME EfiTime;
2372 EFI_HII_VALUE QuestionVal;
2373 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
2374
2375 //
2376 // Save current stack offset.
2377 //
2378 StackOffset = SaveExpressionEvaluationStackOffset ();
2379
2380 ASSERT (Expression != NULL);
2381 Expression->Result.Type = EFI_IFR_TYPE_OTHER;
2382
2383 Link = GetFirstNode (&Expression->OpCodeListHead);
2384 while (!IsNull (&Expression->OpCodeListHead, Link)) {
2385 OpCode = EXPRESSION_OPCODE_FROM_LINK (Link);
2386
2387 Link = GetNextNode (&Expression->OpCodeListHead, Link);
2388
2389 ZeroMem (&Data1, sizeof (EFI_HII_VALUE));
2390 ZeroMem (&Data2, sizeof (EFI_HII_VALUE));
2391 ZeroMem (&Data3, sizeof (EFI_HII_VALUE));
2392
2393 Value = &Data3;
2394 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2395 Status = EFI_SUCCESS;
2396
2397 switch (OpCode->Operand) {
2398 //
2399 // Built-in functions
2400 //
2401 case EFI_IFR_EQ_ID_VAL_OP:
2402 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2403 if (Question == NULL) {
2404 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2405 break;
2406 }
2407
2408 Status = CompareHiiValue (&Question->HiiValue, &OpCode->Value, &Result, NULL);
2409 if (Status == EFI_UNSUPPORTED) {
2410 Status = EFI_SUCCESS;
2411 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2412 break;
2413 }
2414
2415 if (EFI_ERROR (Status)) {
2416 goto Done;
2417 }
2418 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
2419 break;
2420
2421 case EFI_IFR_EQ_ID_ID_OP:
2422 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2423 if (Question == NULL) {
2424 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2425 break;
2426 }
2427
2428 Question2 = IdToQuestion (FormSet, Form, OpCode->QuestionId2);
2429 if (Question2 == NULL) {
2430 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2431 break;
2432 }
2433
2434 Status = CompareHiiValue (&Question->HiiValue, &Question2->HiiValue, &Result, FormSet->HiiHandle);
2435 if (Status == EFI_UNSUPPORTED) {
2436 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2437 Status = EFI_SUCCESS;
2438 break;
2439 }
2440 if (EFI_ERROR (Status)) {
2441 goto Done;
2442 }
2443 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
2444 break;
2445
2446 case EFI_IFR_EQ_ID_VAL_LIST_OP:
2447 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2448 if (Question == NULL) {
2449 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2450 break;
2451 }
2452
2453 Value->Value.b = FALSE;
2454 for (Index =0; Index < OpCode->ListLength; Index++) {
2455 if (Question->HiiValue.Value.u16 == OpCode->ValueList[Index]) {
2456 Value->Value.b = TRUE;
2457 break;
2458 }
2459 }
2460 break;
2461
2462 case EFI_IFR_DUP_OP:
2463 Status = PopExpression (Value);
2464 if (EFI_ERROR (Status)) {
2465 goto Done;
2466 }
2467
2468 Status = PushExpression (Value);
2469 break;
2470
2471 case EFI_IFR_QUESTION_REF1_OP:
2472 case EFI_IFR_THIS_OP:
2473 Question = IdToQuestion (FormSet, Form, OpCode->QuestionId);
2474 if (Question == NULL) {
2475 Status = EFI_NOT_FOUND;
2476 goto Done;
2477 }
2478
2479 Value = &Question->HiiValue;
2480 break;
2481
2482 case EFI_IFR_SECURITY_OP:
2483 Value->Value.b = CheckUserPrivilege (&OpCode->Guid);
2484 break;
2485
2486 case EFI_IFR_GET_OP:
2487 //
2488 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2489 //
2490 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2491 Value->Value.u8 = 0;
2492 if (OpCode->VarStorage != NULL) {
2493 switch (OpCode->VarStorage->Type) {
2494 case EFI_HII_VARSTORE_BUFFER:
2495 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
2496 //
2497 // Get value from Edit Buffer
2498 //
2499 Value->Type = OpCode->ValueType;
2500 CopyMem (&Value->Value, OpCode->VarStorage->EditBuffer + OpCode->VarStoreInfo.VarOffset, OpCode->ValueWidth);
2501 break;
2502 case EFI_HII_VARSTORE_NAME_VALUE:
2503 if (OpCode->ValueType != EFI_IFR_TYPE_STRING) {
2504 //
2505 // Get value from string except for STRING value.
2506 //
2507 Status = GetValueByName (OpCode->VarStorage, OpCode->ValueName, &StrPtr, GetSetValueWithEditBuffer);
2508 if (!EFI_ERROR (Status)) {
2509 ASSERT (StrPtr != NULL);
2510 TempLength = StrLen (StrPtr);
2511 if (OpCode->ValueWidth >= ((TempLength + 1) / 2)) {
2512 Value->Type = OpCode->ValueType;
2513 TempBuffer = (UINT8 *) &Value->Value;
2514 ZeroMem (TempStr, sizeof (TempStr));
2515 for (Index = 0; Index < TempLength; Index ++) {
2516 TempStr[0] = StrPtr[TempLength - Index - 1];
2517 DigitUint8 = (UINT8) StrHexToUint64 (TempStr);
2518 if ((Index & 1) == 0) {
2519 TempBuffer [Index/2] = DigitUint8;
2520 } else {
2521 TempBuffer [Index/2] = (UINT8) ((DigitUint8 << 4) + TempBuffer [Index/2]);
2522 }
2523 }
2524 }
2525 }
2526 }
2527 break;
2528 case EFI_HII_VARSTORE_EFI_VARIABLE:
2529 //
2530 // Get value from variable.
2531 //
2532 TempLength = OpCode->ValueWidth;
2533 Value->Type = OpCode->ValueType;
2534 Status = gRT->GetVariable (
2535 OpCode->ValueName,
2536 &OpCode->VarStorage->Guid,
2537 NULL,
2538 &TempLength,
2539 &Value->Value
2540 );
2541 if (EFI_ERROR (Status)) {
2542 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2543 Value->Value.u8 = 0;
2544 }
2545 break;
2546 default:
2547 //
2548 // Not recognize storage.
2549 //
2550 Status = EFI_UNSUPPORTED;
2551 goto Done;
2552 }
2553 } else {
2554 //
2555 // For Time/Date Data
2556 //
2557 if (OpCode->ValueType != EFI_IFR_TYPE_DATE && OpCode->ValueType != EFI_IFR_TYPE_TIME) {
2558 //
2559 // Only support Data/Time data when storage doesn't exist.
2560 //
2561 Status = EFI_UNSUPPORTED;
2562 goto Done;
2563 }
2564 Status = gRT->GetTime (&EfiTime, NULL);
2565 if (!EFI_ERROR (Status)) {
2566 if (OpCode->ValueType == EFI_IFR_TYPE_DATE) {
2567 switch (OpCode->VarStoreInfo.VarOffset) {
2568 case 0x00:
2569 Value->Type = EFI_IFR_TYPE_NUM_SIZE_16;
2570 Value->Value.u16 = EfiTime.Year;
2571 break;
2572 case 0x02:
2573 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2574 Value->Value.u8 = EfiTime.Month;
2575 break;
2576 case 0x03:
2577 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2578 Value->Value.u8 = EfiTime.Day;
2579 break;
2580 default:
2581 //
2582 // Invalid Date field.
2583 //
2584 Status = EFI_INVALID_PARAMETER;
2585 goto Done;
2586 }
2587 } else {
2588 switch (OpCode->VarStoreInfo.VarOffset) {
2589 case 0x00:
2590 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2591 Value->Value.u8 = EfiTime.Hour;
2592 break;
2593 case 0x01:
2594 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2595 Value->Value.u8 = EfiTime.Minute;
2596 break;
2597 case 0x02:
2598 Value->Type = EFI_IFR_TYPE_NUM_SIZE_8;
2599 Value->Value.u8 = EfiTime.Second;
2600 break;
2601 default:
2602 //
2603 // Invalid Time field.
2604 //
2605 Status = EFI_INVALID_PARAMETER;
2606 goto Done;
2607 }
2608 }
2609 }
2610 }
2611
2612 break;
2613
2614 case EFI_IFR_QUESTION_REF3_OP:
2615 //
2616 // EFI_IFR_QUESTION_REF3
2617 // Pop an expression from the expression stack
2618 //
2619 Status = PopExpression (Value);
2620 if (EFI_ERROR (Status)) {
2621 goto Done;
2622 }
2623
2624 //
2625 // Validate the expression value
2626 //
2627 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2628 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2629 break;
2630 }
2631
2632 if (OpCode->DevicePath != 0) {
2633 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2634
2635 StrPtr = GetToken (OpCode->DevicePath, FormSet->HiiHandle);
2636 if (StrPtr != NULL && mPathFromText != NULL) {
2637 DevicePath = mPathFromText->ConvertTextToDevicePath(StrPtr);
2638 if (DevicePath != NULL && GetQuestionValueFromForm(DevicePath, NULL, &OpCode->Guid, Value->Value.u16, &QuestionVal)) {
2639 Value = &QuestionVal;
2640 }
2641 if (DevicePath != NULL) {
2642 FreePool (DevicePath);
2643 }
2644 }
2645
2646 if (StrPtr != NULL) {
2647 FreePool (StrPtr);
2648 }
2649 } else if (CompareGuid (&OpCode->Guid, &gZeroGuid) != 0) {
2650 if (!GetQuestionValueFromForm(NULL, FormSet->HiiHandle, &OpCode->Guid, Value->Value.u16, &QuestionVal)){
2651 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2652 break;
2653 }
2654 Value = &QuestionVal;
2655 } else {
2656 Question = IdToQuestion (FormSet, Form, Value->Value.u16);
2657 if (Question == NULL) {
2658 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2659 break;
2660 }
2661
2662 //
2663 // push the questions' value on to the expression stack
2664 //
2665 Value = &Question->HiiValue;
2666 }
2667 break;
2668
2669 case EFI_IFR_RULE_REF_OP:
2670 //
2671 // Find expression for this rule
2672 //
2673 RuleExpression = RuleIdToExpression (Form, OpCode->RuleId);
2674 if (RuleExpression == NULL) {
2675 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2676 break;
2677 }
2678
2679 //
2680 // Evaluate this rule expression
2681 //
2682 Status = EvaluateExpression (FormSet, Form, RuleExpression);
2683 if (EFI_ERROR (Status) || RuleExpression->Result.Type == EFI_IFR_TYPE_UNDEFINED) {
2684 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2685 break;
2686 }
2687
2688 Value = &RuleExpression->Result;
2689 break;
2690
2691 case EFI_IFR_STRING_REF1_OP:
2692 Value->Type = EFI_IFR_TYPE_STRING;
2693 Value->Value.string = OpCode->Value.Value.string;
2694 break;
2695
2696 //
2697 // Constant
2698 //
2699 case EFI_IFR_TRUE_OP:
2700 case EFI_IFR_FALSE_OP:
2701 case EFI_IFR_ONE_OP:
2702 case EFI_IFR_ONES_OP:
2703 case EFI_IFR_UINT8_OP:
2704 case EFI_IFR_UINT16_OP:
2705 case EFI_IFR_UINT32_OP:
2706 case EFI_IFR_UINT64_OP:
2707 case EFI_IFR_UNDEFINED_OP:
2708 case EFI_IFR_VERSION_OP:
2709 case EFI_IFR_ZERO_OP:
2710 Value = &OpCode->Value;
2711 break;
2712
2713 //
2714 // unary-op
2715 //
2716 case EFI_IFR_LENGTH_OP:
2717 Status = PopExpression (Value);
2718 if (EFI_ERROR (Status)) {
2719 goto Done;
2720 }
2721 if (Value->Type != EFI_IFR_TYPE_STRING && !IsTypeInBuffer (Value)) {
2722 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2723 break;
2724 }
2725
2726 if (Value->Type == EFI_IFR_TYPE_STRING) {
2727 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2728 if (StrPtr == NULL) {
2729 Status = EFI_INVALID_PARAMETER;
2730 goto Done;
2731 }
2732
2733 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2734 Value->Value.u64 = StrLen (StrPtr);
2735 FreePool (StrPtr);
2736 } else {
2737 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2738 Value->Value.u64 = GetLengthForValue(Value);
2739 FreePool (Value->Buffer);
2740 }
2741 break;
2742
2743 case EFI_IFR_NOT_OP:
2744 Status = PopExpression (Value);
2745 if (EFI_ERROR (Status)) {
2746 goto Done;
2747 }
2748 if (Value->Type != EFI_IFR_TYPE_BOOLEAN) {
2749 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2750 break;
2751 }
2752 Value->Value.b = (BOOLEAN) (!Value->Value.b);
2753 break;
2754
2755 case EFI_IFR_QUESTION_REF2_OP:
2756 //
2757 // Pop an expression from the expression stack
2758 //
2759 Status = PopExpression (Value);
2760 if (EFI_ERROR (Status)) {
2761 goto Done;
2762 }
2763
2764 //
2765 // Validate the expression value
2766 //
2767 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2768 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2769 break;
2770 }
2771
2772 Question = IdToQuestion (FormSet, Form, Value->Value.u16);
2773 if (Question == NULL) {
2774 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2775 break;
2776 }
2777
2778 Value = &Question->HiiValue;
2779 break;
2780
2781 case EFI_IFR_STRING_REF2_OP:
2782 //
2783 // Pop an expression from the expression stack
2784 //
2785 Status = PopExpression (Value);
2786 if (EFI_ERROR (Status)) {
2787 goto Done;
2788 }
2789
2790 //
2791 // Validate the expression value
2792 //
2793 if ((Value->Type > EFI_IFR_TYPE_NUM_SIZE_64) || (Value->Value.u64 > 0xffff)) {
2794 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2795 break;
2796 }
2797
2798 Value->Type = EFI_IFR_TYPE_STRING;
2799 StrPtr = GetToken (Value->Value.u16, FormSet->HiiHandle);
2800 if (StrPtr == NULL) {
2801 //
2802 // If String not exit, push an empty string
2803 //
2804 Value->Value.string = NewString (gEmptyString, FormSet->HiiHandle);
2805 } else {
2806 Index = (UINT16) Value->Value.u64;
2807 Value->Value.string = Index;
2808 FreePool (StrPtr);
2809 }
2810 break;
2811
2812 case EFI_IFR_TO_BOOLEAN_OP:
2813 //
2814 // Pop an expression from the expression stack
2815 //
2816 Status = PopExpression (Value);
2817 if (EFI_ERROR (Status)) {
2818 goto Done;
2819 }
2820
2821 //
2822 // Convert an expression to a Boolean
2823 //
2824 if (Value->Type <= EFI_IFR_TYPE_DATE) {
2825 //
2826 // When converting from an unsigned integer, zero will be converted to
2827 // FALSE and any other value will be converted to TRUE.
2828 //
2829 Value->Value.b = (BOOLEAN) (HiiValueToUINT64(Value) != 0);
2830
2831 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2832 } else if (Value->Type == EFI_IFR_TYPE_STRING) {
2833 //
2834 // When converting from a string, if case-insensitive compare
2835 // with "true" is True, then push True. If a case-insensitive compare
2836 // with "false" is True, then push False. Otherwise, push Undefined.
2837 //
2838 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2839 if (StrPtr == NULL) {
2840 Status = EFI_INVALID_PARAMETER;
2841 goto Done;
2842 }
2843
2844 IfrStrToUpper (StrPtr);
2845 if (StrCmp (StrPtr, L"TRUE") == 0){
2846 Value->Value.b = TRUE;
2847 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2848 } else if (StrCmp (StrPtr, L"FALSE") == 0) {
2849 Value->Value.b = FALSE;
2850 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2851 } else {
2852 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2853 }
2854 FreePool (StrPtr);
2855 } else if (Value->Type == EFI_IFR_TYPE_BUFFER) {
2856 //
2857 // When converting from a buffer, if the buffer is all zeroes,
2858 // then push False. Otherwise push True.
2859 //
2860 for (Index =0; Index < Value->BufferLen; Index ++) {
2861 if (Value->Buffer[Index] != 0) {
2862 break;
2863 }
2864 }
2865
2866 if (Index >= Value->BufferLen) {
2867 Value->Value.b = FALSE;
2868 } else {
2869 Value->Value.b = TRUE;
2870 }
2871 Value->Type = EFI_IFR_TYPE_BOOLEAN;
2872 FreePool (Value->Buffer);
2873 }
2874 break;
2875
2876 case EFI_IFR_TO_STRING_OP:
2877 Status = IfrToString (FormSet, OpCode->Format, Value);
2878 break;
2879
2880 case EFI_IFR_TO_UINT_OP:
2881 Status = IfrToUint (FormSet, Value);
2882 break;
2883
2884 case EFI_IFR_TO_LOWER_OP:
2885 case EFI_IFR_TO_UPPER_OP:
2886 Status = InitializeUnicodeCollationProtocol ();
2887 if (EFI_ERROR (Status)) {
2888 goto Done;
2889 }
2890
2891 Status = PopExpression (Value);
2892 if (EFI_ERROR (Status)) {
2893 goto Done;
2894 }
2895
2896 if (Value->Type != EFI_IFR_TYPE_STRING) {
2897 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2898 break;
2899 }
2900
2901 StrPtr = GetToken (Value->Value.string, FormSet->HiiHandle);
2902 if (StrPtr == NULL) {
2903 Status = EFI_NOT_FOUND;
2904 goto Done;
2905 }
2906
2907 if (OpCode->Operand == EFI_IFR_TO_LOWER_OP) {
2908 mUnicodeCollation->StrLwr (mUnicodeCollation, StrPtr);
2909 } else {
2910 mUnicodeCollation->StrUpr (mUnicodeCollation, StrPtr);
2911 }
2912 Value->Value.string = NewString (StrPtr, FormSet->HiiHandle);
2913 FreePool (StrPtr);
2914 break;
2915
2916 case EFI_IFR_BITWISE_NOT_OP:
2917 //
2918 // Pop an expression from the expression stack
2919 //
2920 Status = PopExpression (Value);
2921 if (EFI_ERROR (Status)) {
2922 goto Done;
2923 }
2924 if (Value->Type > EFI_IFR_TYPE_DATE) {
2925 Value->Type = EFI_IFR_TYPE_UNDEFINED;
2926 break;
2927 }
2928
2929 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
2930 Value->Value.u64 = ~ HiiValueToUINT64(Value);
2931 break;
2932
2933 case EFI_IFR_SET_OP:
2934 //
2935 // Pop an expression from the expression stack
2936 //
2937 Status = PopExpression (Value);
2938 if (EFI_ERROR (Status)) {
2939 goto Done;
2940 }
2941 Data1.Type = EFI_IFR_TYPE_BOOLEAN;
2942 Data1.Value.b = FALSE;
2943 //
2944 // Set value to var storage buffer
2945 //
2946 if (OpCode->VarStorage != NULL) {
2947 switch (OpCode->VarStorage->Type) {
2948 case EFI_HII_VARSTORE_BUFFER:
2949 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
2950 CopyMem (OpCode->VarStorage->EditBuffer + OpCode->VarStoreInfo.VarOffset, &Value->Value, OpCode->ValueWidth);
2951 Data1.Value.b = TRUE;
2952 break;
2953 case EFI_HII_VARSTORE_NAME_VALUE:
2954 if (OpCode->ValueType != EFI_IFR_TYPE_STRING) {
2955 NameValue = AllocateZeroPool ((OpCode->ValueWidth * 2 + 1) * sizeof (CHAR16));
2956 ASSERT (Value != NULL);
2957 //
2958 // Convert Buffer to Hex String
2959 //
2960 TempBuffer = (UINT8 *) &Value->Value + OpCode->ValueWidth - 1;
2961 StrPtr = NameValue;
2962 for (Index = 0; Index < OpCode->ValueWidth; Index ++, TempBuffer --) {
2963 StrPtr += UnicodeValueToString (StrPtr, PREFIX_ZERO | RADIX_HEX, *TempBuffer, 2);
2964 }
2965 Status = SetValueByName (OpCode->VarStorage, OpCode->ValueName, NameValue, GetSetValueWithEditBuffer, NULL);
2966 FreePool (NameValue);
2967 if (!EFI_ERROR (Status)) {
2968 Data1.Value.b = TRUE;
2969 }
2970 }
2971 break;
2972 case EFI_HII_VARSTORE_EFI_VARIABLE:
2973 Status = gRT->SetVariable (
2974 OpCode->ValueName,
2975 &OpCode->VarStorage->Guid,
2976 OpCode->VarStorage->Attributes,
2977 OpCode->ValueWidth,
2978 &Value->Value
2979 );
2980 if (!EFI_ERROR (Status)) {
2981 Data1.Value.b = TRUE;
2982 }
2983 break;
2984 default:
2985 //
2986 // Not recognize storage.
2987 //
2988 Status = EFI_UNSUPPORTED;
2989 goto Done;
2990 break;
2991 }
2992 } else {
2993 //
2994 // For Time/Date Data
2995 //
2996 if (OpCode->ValueType != EFI_IFR_TYPE_DATE && OpCode->ValueType != EFI_IFR_TYPE_TIME) {
2997 //
2998 // Only support Data/Time data when storage doesn't exist.
2999 //
3000 Status = EFI_UNSUPPORTED;
3001 goto Done;
3002 }
3003 Status = gRT->GetTime (&EfiTime, NULL);
3004 if (!EFI_ERROR (Status)) {
3005 if (OpCode->ValueType == EFI_IFR_TYPE_DATE) {
3006 switch (OpCode->VarStoreInfo.VarOffset) {
3007 case 0x00:
3008 EfiTime.Year = Value->Value.u16;
3009 break;
3010 case 0x02:
3011 EfiTime.Month = Value->Value.u8;
3012 break;
3013 case 0x03:
3014 EfiTime.Day = Value->Value.u8;
3015 break;
3016 default:
3017 //
3018 // Invalid Date field.
3019 //
3020 Status = EFI_INVALID_PARAMETER;
3021 goto Done;
3022 }
3023 } else {
3024 switch (OpCode->VarStoreInfo.VarOffset) {
3025 case 0x00:
3026 EfiTime.Hour = Value->Value.u8;
3027 break;
3028 case 0x01:
3029 EfiTime.Minute = Value->Value.u8;
3030 break;
3031 case 0x02:
3032 EfiTime.Second = Value->Value.u8;
3033 break;
3034 default:
3035 //
3036 // Invalid Time field.
3037 //
3038 Status = EFI_INVALID_PARAMETER;
3039 goto Done;
3040 }
3041 }
3042 Status = gRT->SetTime (&EfiTime);
3043 if (!EFI_ERROR (Status)) {
3044 Data1.Value.b = TRUE;
3045 }
3046 }
3047 }
3048 Value = &Data1;
3049 break;
3050
3051 //
3052 // binary-op
3053 //
3054 case EFI_IFR_ADD_OP:
3055 case EFI_IFR_SUBTRACT_OP:
3056 case EFI_IFR_MULTIPLY_OP:
3057 case EFI_IFR_DIVIDE_OP:
3058 case EFI_IFR_MODULO_OP:
3059 case EFI_IFR_BITWISE_AND_OP:
3060 case EFI_IFR_BITWISE_OR_OP:
3061 case EFI_IFR_SHIFT_LEFT_OP:
3062 case EFI_IFR_SHIFT_RIGHT_OP:
3063 //
3064 // Pop an expression from the expression stack
3065 //
3066 Status = PopExpression (&Data2);
3067 if (EFI_ERROR (Status)) {
3068 goto Done;
3069 }
3070
3071 //
3072 // Pop another expression from the expression stack
3073 //
3074 Status = PopExpression (&Data1);
3075 if (EFI_ERROR (Status)) {
3076 goto Done;
3077 }
3078
3079 if (Data2.Type > EFI_IFR_TYPE_DATE) {
3080 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3081 break;
3082 }
3083
3084
3085 if (Data1.Type > EFI_IFR_TYPE_DATE) {
3086 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3087 break;
3088 }
3089
3090 Value->Type = EFI_IFR_TYPE_NUM_SIZE_64;
3091
3092 switch (OpCode->Operand) {
3093 case EFI_IFR_ADD_OP:
3094 Value->Value.u64 = HiiValueToUINT64(&Data1) + HiiValueToUINT64(&Data2);
3095 break;
3096
3097 case EFI_IFR_SUBTRACT_OP:
3098 Value->Value.u64 = HiiValueToUINT64(&Data1) - HiiValueToUINT64(&Data2);
3099 break;
3100
3101 case EFI_IFR_MULTIPLY_OP:
3102 Value->Value.u64 = MultU64x32 (HiiValueToUINT64(&Data1), (UINT32) HiiValueToUINT64(&Data2));
3103 break;
3104
3105 case EFI_IFR_DIVIDE_OP:
3106 Value->Value.u64 = DivU64x32 (HiiValueToUINT64(&Data1), (UINT32) HiiValueToUINT64(&Data2));
3107 break;
3108
3109 case EFI_IFR_MODULO_OP:
3110 DivU64x32Remainder (HiiValueToUINT64(&Data1), (UINT32) HiiValueToUINT64(&Data2), &TempValue);
3111 Value->Value.u64 = TempValue;
3112 break;
3113
3114 case EFI_IFR_BITWISE_AND_OP:
3115 Value->Value.u64 = HiiValueToUINT64(&Data1) & HiiValueToUINT64(&Data2);
3116 break;
3117
3118 case EFI_IFR_BITWISE_OR_OP:
3119 Value->Value.u64 = HiiValueToUINT64(&Data1) | HiiValueToUINT64(&Data2);
3120 break;
3121
3122 case EFI_IFR_SHIFT_LEFT_OP:
3123 Value->Value.u64 = LShiftU64 (HiiValueToUINT64(&Data1), (UINTN) HiiValueToUINT64(&Data2));
3124 break;
3125
3126 case EFI_IFR_SHIFT_RIGHT_OP:
3127 Value->Value.u64 = RShiftU64 (HiiValueToUINT64(&Data1), (UINTN) HiiValueToUINT64(&Data2));
3128 break;
3129
3130 default:
3131 break;
3132 }
3133 break;
3134
3135 case EFI_IFR_AND_OP:
3136 case EFI_IFR_OR_OP:
3137 //
3138 // Two Boolean operator
3139 //
3140 Status = PopExpression (&Data2);
3141 if (EFI_ERROR (Status)) {
3142 goto Done;
3143 }
3144
3145 //
3146 // Pop another expression from the expression stack
3147 //
3148 Status = PopExpression (&Data1);
3149 if (EFI_ERROR (Status)) {
3150 goto Done;
3151 }
3152
3153 if (Data2.Type != EFI_IFR_TYPE_BOOLEAN) {
3154 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3155 break;
3156 }
3157
3158 if (Data1.Type != EFI_IFR_TYPE_BOOLEAN) {
3159 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3160 break;
3161 }
3162
3163 if (OpCode->Operand == EFI_IFR_AND_OP) {
3164 Value->Value.b = (BOOLEAN) (Data1.Value.b && Data2.Value.b);
3165 } else {
3166 Value->Value.b = (BOOLEAN) (Data1.Value.b || Data2.Value.b);
3167 }
3168 break;
3169
3170 case EFI_IFR_EQUAL_OP:
3171 case EFI_IFR_NOT_EQUAL_OP:
3172 case EFI_IFR_GREATER_EQUAL_OP:
3173 case EFI_IFR_GREATER_THAN_OP:
3174 case EFI_IFR_LESS_EQUAL_OP:
3175 case EFI_IFR_LESS_THAN_OP:
3176 //
3177 // Compare two integer, string, boolean or date/time
3178 //
3179 Status = PopExpression (&Data2);
3180 if (EFI_ERROR (Status)) {
3181 goto Done;
3182 }
3183
3184 //
3185 // Pop another expression from the expression stack
3186 //
3187 Status = PopExpression (&Data1);
3188 if (EFI_ERROR (Status)) {
3189 goto Done;
3190 }
3191
3192 if (Data2.Type > EFI_IFR_TYPE_BOOLEAN &&
3193 Data2.Type != EFI_IFR_TYPE_STRING &&
3194 !IsTypeInBuffer(&Data2)) {
3195 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3196 break;
3197 }
3198
3199 if (Data1.Type > EFI_IFR_TYPE_BOOLEAN &&
3200 Data1.Type != EFI_IFR_TYPE_STRING &&
3201 !IsTypeInBuffer(&Data1)) {
3202 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3203 break;
3204 }
3205
3206 Status = CompareHiiValue (&Data1, &Data2, &Result, FormSet->HiiHandle);
3207 if (Data1.Type == EFI_IFR_TYPE_BUFFER) {
3208 FreePool (Data1.Buffer);
3209 }
3210 if (Data2.Type == EFI_IFR_TYPE_BUFFER) {
3211 FreePool (Data2.Buffer);
3212 }
3213
3214 if (Status == EFI_UNSUPPORTED) {
3215 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3216 Status = EFI_SUCCESS;
3217 break;
3218 }
3219
3220 if (EFI_ERROR (Status)) {
3221 goto Done;
3222 }
3223
3224 switch (OpCode->Operand) {
3225 case EFI_IFR_EQUAL_OP:
3226 Value->Value.b = (BOOLEAN) ((Result == 0) ? TRUE : FALSE);
3227 break;
3228
3229 case EFI_IFR_NOT_EQUAL_OP:
3230 Value->Value.b = (BOOLEAN) ((Result != 0) ? TRUE : FALSE);
3231 break;
3232
3233 case EFI_IFR_GREATER_EQUAL_OP:
3234 Value->Value.b = (BOOLEAN) ((Result >= 0) ? TRUE : FALSE);
3235 break;
3236
3237 case EFI_IFR_GREATER_THAN_OP:
3238 Value->Value.b = (BOOLEAN) ((Result > 0) ? TRUE : FALSE);
3239 break;
3240
3241 case EFI_IFR_LESS_EQUAL_OP:
3242 Value->Value.b = (BOOLEAN) ((Result <= 0) ? TRUE : FALSE);
3243 break;
3244
3245 case EFI_IFR_LESS_THAN_OP:
3246 Value->Value.b = (BOOLEAN) ((Result < 0) ? TRUE : FALSE);
3247 break;
3248
3249 default:
3250 break;
3251 }
3252 break;
3253
3254 case EFI_IFR_MATCH_OP:
3255 Status = InitializeUnicodeCollationProtocol ();
3256 if (EFI_ERROR (Status)) {
3257 goto Done;
3258 }
3259
3260 Status = IfrMatch (FormSet, Value);
3261 break;
3262
3263 case EFI_IFR_CATENATE_OP:
3264 Status = IfrCatenate (FormSet, Value);
3265 break;
3266
3267 //
3268 // ternary-op
3269 //
3270 case EFI_IFR_CONDITIONAL_OP:
3271 //
3272 // Pop third expression from the expression stack
3273 //
3274 Status = PopExpression (&Data3);
3275 if (EFI_ERROR (Status)) {
3276 goto Done;
3277 }
3278
3279 //
3280 // Pop second expression from the expression stack
3281 //
3282 Status = PopExpression (&Data2);
3283 if (EFI_ERROR (Status)) {
3284 goto Done;
3285 }
3286
3287 //
3288 // Pop first expression from the expression stack
3289 //
3290 Status = PopExpression (&Data1);
3291 if (EFI_ERROR (Status)) {
3292 goto Done;
3293 }
3294 if (Data1.Type != EFI_IFR_TYPE_BOOLEAN) {
3295 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3296 break;
3297 }
3298
3299 if (Data1.Value.b) {
3300 Value = &Data3;
3301 } else {
3302 Value = &Data2;
3303 }
3304 break;
3305
3306 case EFI_IFR_FIND_OP:
3307 Status = IfrFind (FormSet, OpCode->Format, Value);
3308 break;
3309
3310 case EFI_IFR_MID_OP:
3311 Status = IfrMid (FormSet, Value);
3312 break;
3313
3314 case EFI_IFR_TOKEN_OP:
3315 Status = IfrToken (FormSet, Value);
3316 break;
3317
3318 case EFI_IFR_SPAN_OP:
3319 Status = IfrSpan (FormSet, OpCode->Flags, Value);
3320 break;
3321
3322 case EFI_IFR_MAP_OP:
3323 //
3324 // Pop the check value
3325 //
3326 Status = PopExpression (&Data1);
3327 if (EFI_ERROR (Status)) {
3328 goto Done;
3329 }
3330 //
3331 // Check MapExpression list is valid.
3332 //
3333 if (OpCode->MapExpressionList.ForwardLink == NULL) {
3334 Status = EFI_INVALID_PARAMETER;
3335 goto Done;
3336 }
3337 //
3338 // Go through map expression list.
3339 //
3340 SubExpressionLink = GetFirstNode(&OpCode->MapExpressionList);
3341 while (!IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3342 SubExpression = FORM_EXPRESSION_FROM_LINK (SubExpressionLink);
3343 //
3344 // Evaluate the first expression in this pair.
3345 //
3346 Status = EvaluateExpression (FormSet, Form, SubExpression);
3347 if (EFI_ERROR (Status)) {
3348 goto Done;
3349 }
3350 //
3351 // Compare the expression value with current value
3352 //
3353 if ((CompareHiiValue (&Data1, &SubExpression->Result, &Result, NULL) == EFI_SUCCESS) && (Result == 0)) {
3354 //
3355 // Try get the map value.
3356 //
3357 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3358 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3359 Status = EFI_INVALID_PARAMETER;
3360 goto Done;
3361 }
3362 SubExpression = FORM_EXPRESSION_FROM_LINK (SubExpressionLink);
3363 Status = EvaluateExpression (FormSet, Form, SubExpression);
3364 if (EFI_ERROR (Status)) {
3365 goto Done;
3366 }
3367 Value = &SubExpression->Result;
3368 break;
3369 }
3370 //
3371 // Skip the second expression on this pair.
3372 //
3373 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3374 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3375 Status = EFI_INVALID_PARAMETER;
3376 goto Done;
3377 }
3378 //
3379 // Goto the first expression on next pair.
3380 //
3381 SubExpressionLink = GetNextNode (&OpCode->MapExpressionList, SubExpressionLink);
3382 }
3383
3384 //
3385 // No map value is found.
3386 //
3387 if (IsNull (&OpCode->MapExpressionList, SubExpressionLink)) {
3388 Value->Type = EFI_IFR_TYPE_UNDEFINED;
3389 Value->Value.u8 = 0;
3390 }
3391 break;
3392
3393 default:
3394 break;
3395 }
3396 if (EFI_ERROR (Status) || Value->Type == EFI_IFR_TYPE_UNDEFINED) {
3397 goto Done;
3398 }
3399
3400 Status = PushExpression (Value);
3401 if (EFI_ERROR (Status)) {
3402 goto Done;
3403 }
3404 }
3405
3406 //
3407 // Pop the final result from expression stack
3408 //
3409 Value = &Data1;
3410 Status = PopExpression (Value);
3411 if (EFI_ERROR (Status)) {
3412 goto Done;
3413 }
3414
3415 //
3416 // After evaluating an expression, there should be only one value left on the expression stack
3417 //
3418 if (PopExpression (Value) != EFI_ACCESS_DENIED) {
3419 Status = EFI_INVALID_PARAMETER;
3420 }
3421
3422 Done:
3423 RestoreExpressionEvaluationStackOffset (StackOffset);
3424 if (!EFI_ERROR (Status)) {
3425 CopyMem (&Expression->Result, Value, sizeof (EFI_HII_VALUE));
3426 }
3427
3428 return Status;
3429 }
3430
3431 /**
3432 Check whether the result is TRUE or FALSE.
3433
3434 For the EFI_HII_VALUE value type is numeric, return TRUE if the
3435 value is not 0.
3436
3437 @param Result Input the result data.
3438
3439 @retval TRUE The result is TRUE.
3440 @retval FALSE The result is FALSE.
3441
3442 **/
3443 BOOLEAN
3444 IsTrue (
3445 IN EFI_HII_VALUE *Result
3446 )
3447 {
3448 switch (Result->Type) {
3449 case EFI_IFR_TYPE_BOOLEAN:
3450 return Result->Value.b;
3451
3452 case EFI_IFR_TYPE_NUM_SIZE_8:
3453 return (BOOLEAN)(Result->Value.u8 != 0);
3454
3455 case EFI_IFR_TYPE_NUM_SIZE_16:
3456 return (BOOLEAN)(Result->Value.u16 != 0);
3457
3458 case EFI_IFR_TYPE_NUM_SIZE_32:
3459 return (BOOLEAN)(Result->Value.u32 != 0);
3460
3461 case EFI_IFR_TYPE_NUM_SIZE_64:
3462 return (BOOLEAN)(Result->Value.u64 != 0);
3463
3464 default:
3465 return FALSE;
3466 }
3467 }
3468
3469 /**
3470 Return the result of the expression list. Check the expression list and
3471 return the highest priority express result.
3472 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3473
3474 @param ExpList The input expression list.
3475 @param Evaluate Whether need to evaluate the expression first.
3476 @param FormSet FormSet associated with this expression.
3477 @param Form Form associated with this expression.
3478
3479 @retval EXPRESS_RESULT Return the higher priority express result.
3480 DisableIf > SuppressIf > GrayOutIf > FALSE
3481
3482 **/
3483 EXPRESS_RESULT
3484 EvaluateExpressionList (
3485 IN FORM_EXPRESSION_LIST *ExpList,
3486 IN BOOLEAN Evaluate,
3487 IN FORM_BROWSER_FORMSET *FormSet, OPTIONAL
3488 IN FORM_BROWSER_FORM *Form OPTIONAL
3489 )
3490 {
3491 UINTN Index;
3492 EXPRESS_RESULT ReturnVal;
3493 EXPRESS_RESULT CompareOne;
3494 EFI_STATUS Status;
3495
3496 if (ExpList == NULL) {
3497 return ExpressFalse;
3498 }
3499
3500 ASSERT(ExpList->Signature == FORM_EXPRESSION_LIST_SIGNATURE);
3501 Index = 0;
3502
3503 //
3504 // Check whether need to evaluate the expression first.
3505 //
3506 if (Evaluate) {
3507 while (ExpList->Count > Index) {
3508 Status = EvaluateExpression (FormSet, Form, ExpList->Expression[Index++]);
3509 if (EFI_ERROR (Status)) {
3510 return ExpressFalse;
3511 }
3512 }
3513 }
3514
3515 //
3516 // Run the list of expressions.
3517 //
3518 ReturnVal = ExpressFalse;
3519 for (Index = 0; Index < ExpList->Count; Index++) {
3520 if (IsTrue (&ExpList->Expression[Index]->Result)) {
3521 switch (ExpList->Expression[Index]->Type) {
3522 case EFI_HII_EXPRESSION_SUPPRESS_IF:
3523 CompareOne = ExpressSuppress;
3524 break;
3525
3526 case EFI_HII_EXPRESSION_GRAY_OUT_IF:
3527 CompareOne = ExpressGrayOut;
3528 break;
3529
3530 case EFI_HII_EXPRESSION_DISABLE_IF:
3531 CompareOne = ExpressDisable;
3532 break;
3533
3534 default:
3535 return ExpressFalse;
3536 }
3537
3538 ReturnVal = ReturnVal < CompareOne ? CompareOne : ReturnVal;
3539 }
3540 }
3541
3542 return ReturnVal;
3543 }
EFI Development Kit II mirror for PVE