2 Utility functions for expression evaluation.
4 Copyright (c) 2007 - 2015, 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
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.
18 // Global stack used to evaluate boolean expresions
20 EFI_HII_VALUE
*mOpCodeScopeStack
= NULL
;
21 EFI_HII_VALUE
*mOpCodeScopeStackEnd
= NULL
;
22 EFI_HII_VALUE
*mOpCodeScopeStackPointer
= NULL
;
24 EFI_HII_VALUE
*mExpressionEvaluationStack
= NULL
;
25 EFI_HII_VALUE
*mExpressionEvaluationStackEnd
= NULL
;
26 EFI_HII_VALUE
*mExpressionEvaluationStackPointer
= NULL
;
27 UINTN mExpressionEvaluationStackOffset
= 0;
29 EFI_HII_VALUE
*mCurrentExpressionStack
= NULL
;
30 EFI_HII_VALUE
*mCurrentExpressionEnd
= NULL
;
31 EFI_HII_VALUE
*mCurrentExpressionPointer
= NULL
;
33 EFI_HII_VALUE
*mMapExpressionListStack
= NULL
;
34 EFI_HII_VALUE
*mMapExpressionListEnd
= NULL
;
35 EFI_HII_VALUE
*mMapExpressionListPointer
= NULL
;
37 FORM_EXPRESSION
**mFormExpressionStack
= NULL
;
38 FORM_EXPRESSION
**mFormExpressionEnd
= NULL
;
39 FORM_EXPRESSION
**mFormExpressionPointer
= NULL
;
41 FORM_EXPRESSION
**mStatementExpressionStack
= NULL
;
42 FORM_EXPRESSION
**mStatementExpressionEnd
= NULL
;
43 FORM_EXPRESSION
**mStatementExpressionPointer
= NULL
;
45 FORM_EXPRESSION
**mOptionExpressionStack
= NULL
;
46 FORM_EXPRESSION
**mOptionExpressionEnd
= NULL
;
47 FORM_EXPRESSION
**mOptionExpressionPointer
= NULL
;
51 // Unicode collation protocol interface
53 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
54 EFI_USER_MANAGER_PROTOCOL
*mUserManager
= NULL
;
57 Grow size of the stack.
59 This is an internal function.
61 @param Stack On input: old stack; On output: new stack
62 @param StackPtr On input: old stack pointer; On output: new stack
64 @param StackEnd On input: old stack end; On output: new stack end
66 @retval EFI_SUCCESS Grow stack success.
67 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
72 IN OUT EFI_HII_VALUE
**Stack
,
73 IN OUT EFI_HII_VALUE
**StackPtr
,
74 IN OUT EFI_HII_VALUE
**StackEnd
78 EFI_HII_VALUE
*NewStack
;
80 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
81 if (*StackPtr
!= NULL
) {
82 Size
= Size
+ (*StackEnd
- *Stack
);
85 NewStack
= AllocatePool (Size
* sizeof (EFI_HII_VALUE
));
86 if (NewStack
== NULL
) {
87 return EFI_OUT_OF_RESOURCES
;
90 if (*StackPtr
!= NULL
) {
92 // Copy from Old Stack to the New Stack
97 (*StackEnd
- *Stack
) * sizeof (EFI_HII_VALUE
)
101 // Free The Old Stack
107 // Make the Stack pointer point to the old data in the new stack
109 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
111 *StackEnd
= NewStack
+ Size
;
118 Push an element onto the Boolean Stack.
120 @param Stack On input: old stack; On output: new stack
121 @param StackPtr On input: old stack pointer; On output: new stack
123 @param StackEnd On input: old stack end; On output: new stack end
124 @param Data Data to push.
126 @retval EFI_SUCCESS Push stack success.
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
140 // Check for a stack overflow condition
142 if (*StackPtr
>= *StackEnd
) {
146 Status
= GrowStack (Stack
, StackPtr
, StackEnd
);
147 if (EFI_ERROR (Status
)) {
153 // Push the item onto the stack
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
);
161 *StackPtr
= *StackPtr
+ 1;
168 Pop an element from the stack.
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.
174 @retval EFI_SUCCESS The value was popped onto the stack.
175 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
180 IN EFI_HII_VALUE
*Stack
,
181 IN OUT EFI_HII_VALUE
**StackPtr
,
182 OUT EFI_HII_VALUE
*Data
186 // Check for a stack underflow condition
188 if (*StackPtr
== Stack
) {
189 return EFI_ACCESS_DENIED
;
193 // Pop the item off the stack
195 *StackPtr
= *StackPtr
- 1;
196 CopyMem (Data
, *StackPtr
, sizeof (EFI_HII_VALUE
));
202 Reset stack pointer to begin of the stack.
206 ResetCurrentExpressionStack (
210 mCurrentExpressionPointer
= mCurrentExpressionStack
;
211 mFormExpressionPointer
= mFormExpressionStack
;
212 mStatementExpressionPointer
= mStatementExpressionStack
;
213 mOptionExpressionPointer
= mOptionExpressionStack
;
218 Push current expression onto the Stack
220 @param Pointer Pointer to current expression.
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.
227 PushCurrentExpression (
233 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
234 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
237 &mCurrentExpressionStack
,
238 &mCurrentExpressionPointer
,
239 &mCurrentExpressionEnd
,
246 Pop current expression from the Stack
248 @param Pointer Pointer to current expression to be pop.
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.
255 PopCurrentExpression (
263 mCurrentExpressionStack
,
264 &mCurrentExpressionPointer
,
268 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
274 Reset stack pointer to begin of the stack.
278 ResetMapExpressionListStack (
282 mMapExpressionListPointer
= mMapExpressionListStack
;
287 Grow size of the stack.
289 This is an internal function.
291 @param Stack On input: old stack; On output: new stack
292 @param StackPtr On input: old stack pointer; On output: new stack
294 @param StackEnd On input: old stack end; On output: new stack end
295 @param MemberSize The stack member size.
297 @retval EFI_SUCCESS Grow stack success.
298 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
302 GrowConditionalStack (
303 IN OUT FORM_EXPRESSION
***Stack
,
304 IN OUT FORM_EXPRESSION
***StackPtr
,
305 IN OUT FORM_EXPRESSION
***StackEnd
,
310 FORM_EXPRESSION
**NewStack
;
312 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
313 if (*StackPtr
!= NULL
) {
314 Size
= Size
+ (*StackEnd
- *Stack
);
317 NewStack
= AllocatePool (Size
* MemberSize
);
318 if (NewStack
== NULL
) {
319 return EFI_OUT_OF_RESOURCES
;
322 if (*StackPtr
!= NULL
) {
324 // Copy from Old Stack to the New Stack
329 (*StackEnd
- *Stack
) * MemberSize
333 // Free The Old Stack
339 // Make the Stack pointer point to the old data in the new stack
341 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
343 *StackEnd
= NewStack
+ Size
;
349 Push an element onto the Stack.
351 @param Stack On input: old stack; On output: new stack
352 @param StackPtr On input: old stack pointer; On output: new stack
354 @param StackEnd On input: old stack end; On output: new stack end
355 @param Data Data to push.
357 @retval EFI_SUCCESS Push stack success.
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
371 // Check for a stack overflow condition
373 if (*StackPtr
>= *StackEnd
) {
377 Status
= GrowConditionalStack (Stack
, StackPtr
, StackEnd
, sizeof (FORM_EXPRESSION
*));
378 if (EFI_ERROR (Status
)) {
384 // Push the item onto the stack
386 CopyMem (*StackPtr
, Data
, sizeof (FORM_EXPRESSION
*));
387 *StackPtr
= *StackPtr
+ 1;
394 Pop an element from the stack.
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.
400 @retval EFI_SUCCESS The value was popped onto the stack.
401 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
405 PopConditionalStack (
406 IN FORM_EXPRESSION
**Stack
,
407 IN OUT FORM_EXPRESSION
***StackPtr
,
408 OUT FORM_EXPRESSION
**Data
412 // Check for a stack underflow condition
414 if (*StackPtr
== Stack
) {
415 return EFI_ACCESS_DENIED
;
419 // Pop the item off the stack
421 *StackPtr
= *StackPtr
- 1;
422 CopyMem (Data
, *StackPtr
, sizeof (FORM_EXPRESSION
*));
428 Get the expression list count.
430 @param Level Which type this expression belong to. Form,
433 @retval >=0 The expression count
434 @retval -1 Input parameter error.
438 GetConditionalExpressionCount (
439 IN EXPRESS_LEVEL Level
444 return mFormExpressionPointer
- mFormExpressionStack
;
445 case ExpressStatement
:
446 return mStatementExpressionPointer
- mStatementExpressionStack
;
448 return mOptionExpressionPointer
- mOptionExpressionStack
;
456 Get the expression Buffer pointer.
458 @param Level Which type this expression belong to. Form,
461 @retval The start pointer of the expression buffer or NULL.
465 GetConditionalExpressionList (
466 IN EXPRESS_LEVEL Level
471 return mFormExpressionStack
;
472 case ExpressStatement
:
473 return mStatementExpressionStack
;
475 return mOptionExpressionStack
;
484 Push the expression options onto the Stack.
486 @param Pointer Pointer to the current expression.
487 @param Level Which type this expression belong to. Form,
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.
495 PushConditionalExpression (
496 IN FORM_EXPRESSION
*Pointer
,
497 IN EXPRESS_LEVEL Level
502 return PushConditionalStack (
503 &mFormExpressionStack
,
504 &mFormExpressionPointer
,
508 case ExpressStatement
:
509 return PushConditionalStack (
510 &mStatementExpressionStack
,
511 &mStatementExpressionPointer
,
512 &mStatementExpressionEnd
,
516 return PushConditionalStack (
517 &mOptionExpressionStack
,
518 &mOptionExpressionPointer
,
519 &mOptionExpressionEnd
,
524 return EFI_INVALID_PARAMETER
;
529 Pop the expression options from the Stack
531 @param Level Which type this expression belong to. Form,
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.
539 PopConditionalExpression (
540 IN EXPRESS_LEVEL Level
543 FORM_EXPRESSION
*Pointer
;
547 return PopConditionalStack (
548 mFormExpressionStack
,
549 &mFormExpressionPointer
,
553 case ExpressStatement
:
554 return PopConditionalStack (
555 mStatementExpressionStack
,
556 &mStatementExpressionPointer
,
561 return PopConditionalStack (
562 mOptionExpressionStack
,
563 &mOptionExpressionPointer
,
569 return EFI_INVALID_PARAMETER
;
575 Push the list of map expression onto the Stack
577 @param Pointer Pointer to the list of map expression to be pushed.
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.
584 PushMapExpressionList (
590 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
591 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
594 &mMapExpressionListStack
,
595 &mMapExpressionListPointer
,
596 &mMapExpressionListEnd
,
603 Pop the list of map expression from the Stack
605 @param Pointer Pointer to the list of map expression to be pop.
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.
612 PopMapExpressionList (
620 mMapExpressionListStack
,
621 &mMapExpressionListPointer
,
625 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
631 Reset stack pointer to begin of the stack.
639 mOpCodeScopeStackPointer
= mOpCodeScopeStack
;
644 Push an Operand onto the Stack
646 @param Operand Operand to push.
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
660 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
661 Data
.Value
.u8
= Operand
;
665 &mOpCodeScopeStackPointer
,
666 &mOpCodeScopeStackEnd
,
673 Pop an Operand from the Stack
675 @param Operand Operand to pop.
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
692 &mOpCodeScopeStackPointer
,
696 *Operand
= Data
.Value
.u8
;
703 Push an Expression value onto the Stack
705 @param Value Expression value to push.
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
714 IN EFI_HII_VALUE
*Value
718 &mExpressionEvaluationStack
,
719 &mExpressionEvaluationStackPointer
,
720 &mExpressionEvaluationStackEnd
,
727 Pop an Expression value from the stack.
729 @param Value Expression value to pop.
731 @retval EFI_SUCCESS The value was popped onto the stack.
732 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
737 OUT EFI_HII_VALUE
*Value
741 mExpressionEvaluationStack
+ mExpressionEvaluationStackOffset
,
742 &mExpressionEvaluationStackPointer
,
748 Get current stack offset from stack start.
750 @return Stack offset to stack start.
753 SaveExpressionEvaluationStackOffset (
756 UINTN TempStackOffset
;
757 TempStackOffset
= mExpressionEvaluationStackOffset
;
758 mExpressionEvaluationStackOffset
= mExpressionEvaluationStackPointer
- mExpressionEvaluationStack
;
759 return TempStackOffset
;
763 Restore stack offset based on input stack offset
765 @param StackOffset Offset to stack start.
769 RestoreExpressionEvaluationStackOffset (
773 mExpressionEvaluationStackOffset
= StackOffset
;
777 Get Form given its FormId.
779 @param FormSet The formset which contains this form.
780 @param FormId Id of this form.
782 @retval Pointer The form.
783 @retval NULL Specified Form is not found in the formset.
788 IN FORM_BROWSER_FORMSET
*FormSet
,
793 FORM_BROWSER_FORM
*Form
;
795 Link
= GetFirstNode (&FormSet
->FormListHead
);
796 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
797 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
799 if (Form
->FormId
== FormId
) {
803 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
811 Search a Question in Form scope using its QuestionId.
813 @param Form The form which contains this Question.
814 @param QuestionId Id of this Question.
816 @retval Pointer The Question.
817 @retval NULL Specified Question not found in the form.
820 FORM_BROWSER_STATEMENT
*
822 IN FORM_BROWSER_FORM
*Form
,
827 FORM_BROWSER_STATEMENT
*Question
;
829 if (QuestionId
== 0 || Form
== NULL
) {
831 // The value of zero is reserved
836 Link
= GetFirstNode (&Form
->StatementListHead
);
837 while (!IsNull (&Form
->StatementListHead
, Link
)) {
838 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
840 if (Question
->QuestionId
== QuestionId
) {
844 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
852 Search a Question in Formset scope using its QuestionId.
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.
858 @retval Pointer The Question.
859 @retval NULL Specified Question not found in the form.
862 FORM_BROWSER_STATEMENT
*
864 IN FORM_BROWSER_FORMSET
*FormSet
,
865 IN FORM_BROWSER_FORM
*Form
,
870 FORM_BROWSER_STATEMENT
*Question
;
873 // Search in the form scope first
875 Question
= IdToQuestion2 (Form
, QuestionId
);
876 if (Question
!= NULL
) {
881 // Search in the formset scope
883 Link
= GetFirstNode (&FormSet
->FormListHead
);
884 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
885 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
887 Question
= IdToQuestion2 (Form
, QuestionId
);
888 if (Question
!= NULL
) {
890 // EFI variable storage may be updated by Callback() asynchronous,
891 // to keep synchronous, always reload the Question Value.
893 if (Question
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
894 GetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
900 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
908 Get Expression given its RuleId.
910 @param Form The form which contains this Expression.
911 @param RuleId Id of this Expression.
913 @retval Pointer The Expression.
914 @retval NULL Specified Expression not found in the form.
919 IN FORM_BROWSER_FORM
*Form
,
924 FORM_EXPRESSION
*Expression
;
926 Link
= GetFirstNode (&Form
->ExpressionListHead
);
927 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
928 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
930 if (Expression
->Type
== EFI_HII_EXPRESSION_RULE
&& Expression
->RuleId
== RuleId
) {
934 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
942 Locate the Unicode Collation Protocol interface for later use.
944 @retval EFI_SUCCESS Protocol interface initialize success.
945 @retval Other Protocol interface initialize failed.
949 InitializeUnicodeCollationProtocol (
955 if (mUnicodeCollation
!= NULL
) {
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.
964 Status
= gBS
->LocateProtocol (
965 &gEfiUnicodeCollation2ProtocolGuid
,
967 (VOID
**) &mUnicodeCollation
973 Convert the input Unicode character to upper.
975 @param String Th Unicode character to be converted.
983 while (*String
!= 0) {
984 if ((*String
>= 'a') && (*String
<= 'z')) {
985 *String
= (UINT16
) ((*String
) & ((UINT16
) ~0x20));
992 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
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.
997 @param Value Expression value to compare on.
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.
1005 IN EFI_HII_VALUE
*Value
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
:
1021 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
1023 @param Value Expression value to compare on.
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.
1031 IN EFI_HII_VALUE
*Value
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
:
1048 Return the buffer length for this value.
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.
1053 @param Value Expression value to compare on.
1055 @retval BufLen Return the buffer length.
1060 IN EFI_HII_VALUE
*Value
1063 switch (Value
->Type
) {
1064 case EFI_IFR_TYPE_BUFFER
:
1065 return Value
->BufferLen
;
1067 case EFI_IFR_TYPE_DATE
:
1068 return (UINT16
) sizeof (EFI_HII_DATE
);
1070 case EFI_IFR_TYPE_TIME
:
1071 return (UINT16
) sizeof (EFI_HII_TIME
);
1073 case EFI_IFR_TYPE_REF
:
1074 return (UINT16
) sizeof (EFI_HII_REF
);
1082 Return the buffer pointer for this value.
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.
1087 @param Value Expression value to compare on.
1089 @retval Buf Return the buffer pointer.
1094 IN EFI_HII_VALUE
*Value
1097 switch (Value
->Type
) {
1098 case EFI_IFR_TYPE_BUFFER
:
1099 return Value
->Buffer
;
1101 case EFI_IFR_TYPE_DATE
:
1102 return (UINT8
*) (&Value
->Value
.date
);
1104 case EFI_IFR_TYPE_TIME
:
1105 return (UINT8
*) (&Value
->Value
.time
);
1107 case EFI_IFR_TYPE_REF
:
1108 return (UINT8
*) (&Value
->Value
.ref
);
1116 Evaluate opcode EFI_IFR_TO_STRING.
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.
1122 @retval EFI_SUCCESS Opcode evaluation success.
1123 @retval Other Opcode evaluation failed.
1128 IN FORM_BROWSER_FORMSET
*FormSet
,
1130 OUT EFI_HII_VALUE
*Result
1134 EFI_HII_VALUE Value
;
1136 CHAR16
*PrintFormat
;
1137 CHAR16 Buffer
[MAXIMUM_VALUE_CHARACTERS
];
1143 Status
= PopExpression (&Value
);
1144 if (EFI_ERROR (Status
)) {
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
);
1155 case EFI_IFR_STRING_UNSIGNED_DEC
:
1156 case EFI_IFR_STRING_SIGNED_DEC
:
1157 PrintFormat
= L
"%ld";
1160 case EFI_IFR_STRING_LOWERCASE_HEX
:
1161 PrintFormat
= L
"%lx";
1164 case EFI_IFR_STRING_UPPERCASE_HEX
:
1165 PrintFormat
= L
"%lX";
1169 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1172 UnicodeSPrint (Buffer
, BufferSize
, PrintFormat
, Value
.Value
.u64
);
1176 case EFI_IFR_TYPE_STRING
:
1177 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1180 case EFI_IFR_TYPE_BOOLEAN
:
1181 String
= (Value
.Value
.b
) ? L
"True" : L
"False";
1184 case EFI_IFR_TYPE_BUFFER
:
1185 case EFI_IFR_TYPE_DATE
:
1186 case EFI_IFR_TYPE_TIME
:
1187 case EFI_IFR_TYPE_REF
:
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'.
1192 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1193 SrcLen
= Value
.BufferLen
;
1194 SrcBuf
= Value
.Buffer
;
1196 SrcBuf
= GetBufferForValue(&Value
);
1197 SrcLen
= GetLengthForValue(&Value
);
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";
1206 // Format == EFI_IFR_STRING_UNICODE
1207 CopyMem (TmpBuf
, SrcBuf
, SrcLen
* sizeof (CHAR16
));
1208 PrintFormat
= L
"%s";
1210 UnicodeSPrint (Buffer
, sizeof (Buffer
), PrintFormat
, TmpBuf
);
1213 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1214 FreePool (Value
.Buffer
);
1219 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1223 Result
->Type
= EFI_IFR_TYPE_STRING
;
1224 Result
->Value
.string
= NewString (String
, FormSet
->HiiHandle
);
1230 Evaluate opcode EFI_IFR_TO_UINT.
1232 @param FormSet Formset which contains this opcode.
1233 @param Result Evaluation result for this opcode.
1235 @retval EFI_SUCCESS Opcode evaluation success.
1236 @retval Other Opcode evaluation failed.
1241 IN FORM_BROWSER_FORMSET
*FormSet
,
1242 OUT EFI_HII_VALUE
*Result
1246 EFI_HII_VALUE Value
;
1250 Status
= PopExpression (&Value
);
1251 if (EFI_ERROR (Status
)) {
1255 if (Value
.Type
>= EFI_IFR_TYPE_OTHER
&& !IsTypeInBuffer(&Value
)) {
1256 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
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
;
1267 IfrStrToUpper (String
);
1268 StringPtr
= StrStr (String
, L
"0X");
1269 if (StringPtr
!= NULL
) {
1273 Result
->Value
.u64
= StrHexToUint64 (String
);
1278 Result
->Value
.u64
= StrDecimalToUint64 (String
);
1281 } else if (IsTypeInBuffer(&Value
)) {
1282 if (GetLengthForValue (&Value
) > 8) {
1283 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1284 FreePool (Value
.Buffer
);
1286 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1289 Result
->Value
.u64
= *(UINT64
*) GetBufferForValue (&Value
);
1290 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1291 FreePool (Value
.Buffer
);
1294 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1297 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1303 Evaluate opcode EFI_IFR_CATENATE.
1305 @param FormSet Formset which contains this opcode.
1306 @param Result Evaluation result for this opcode.
1308 @retval EFI_SUCCESS Opcode evaluation success.
1309 @retval Other Opcode evaluation failed.
1314 IN FORM_BROWSER_FORMSET
*FormSet
,
1315 OUT EFI_HII_VALUE
*Result
1319 EFI_HII_VALUE Value
[2];
1329 // String[0] - The second string
1330 // String[1] - The first string
1335 Status
= EFI_SUCCESS
;
1336 ZeroMem (Value
, sizeof (Value
));
1338 Status
= PopExpression (&Value
[0]);
1339 if (EFI_ERROR (Status
)) {
1343 Status
= PopExpression (&Value
[1]);
1344 if (EFI_ERROR (Status
)) {
1348 for (Index
= 0; Index
< 2; Index
++) {
1349 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[Index
])) {
1350 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1351 Status
= EFI_SUCCESS
;
1355 if (Value
[Index
].Type
== EFI_IFR_TYPE_STRING
) {
1356 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1357 if (String
[Index
] == NULL
) {
1358 Status
= EFI_NOT_FOUND
;
1364 if (Value
[0].Type
== EFI_IFR_TYPE_STRING
) {
1365 Size
= StrSize (String
[0]);
1366 StringPtr
= AllocatePool (StrSize (String
[1]) + Size
);
1367 ASSERT (StringPtr
!= NULL
);
1368 StrCpy (StringPtr
, String
[1]);
1369 StrCat (StringPtr
, String
[0]);
1371 Result
->Type
= EFI_IFR_TYPE_STRING
;
1372 Result
->Value
.string
= NewString (StringPtr
, FormSet
->HiiHandle
);
1374 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1375 Length0
= GetLengthForValue(&Value
[0]);
1376 Length1
= GetLengthForValue(&Value
[1]);
1377 Result
->BufferLen
= (UINT16
) (Length0
+ Length1
);
1379 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1380 ASSERT (Result
->Buffer
!= NULL
);
1382 TmpBuf
= GetBufferForValue(&Value
[0]);
1383 ASSERT (TmpBuf
!= NULL
);
1384 CopyMem (Result
->Buffer
, TmpBuf
, Length0
);
1385 TmpBuf
= GetBufferForValue(&Value
[1]);
1386 ASSERT (TmpBuf
!= NULL
);
1387 CopyMem (&Result
->Buffer
[Length0
], TmpBuf
, Length1
);
1390 if (Value
[0].Buffer
!= NULL
) {
1391 FreePool (Value
[0].Buffer
);
1393 if (Value
[1].Buffer
!= NULL
) {
1394 FreePool (Value
[1].Buffer
);
1396 if (String
[0] != NULL
) {
1397 FreePool (String
[0]);
1399 if (String
[1] != NULL
) {
1400 FreePool (String
[1]);
1402 if (StringPtr
!= NULL
) {
1403 FreePool (StringPtr
);
1411 Evaluate opcode EFI_IFR_MATCH.
1413 @param FormSet Formset which contains this opcode.
1414 @param Result Evaluation result for this opcode.
1416 @retval EFI_SUCCESS Opcode evaluation success.
1417 @retval Other Opcode evaluation failed.
1422 IN FORM_BROWSER_FORMSET
*FormSet
,
1423 OUT EFI_HII_VALUE
*Result
1427 EFI_HII_VALUE Value
[2];
1432 // String[0] - The string to search
1433 // String[1] - pattern
1437 Status
= EFI_SUCCESS
;
1438 ZeroMem (Value
, sizeof (Value
));
1440 Status
= PopExpression (&Value
[0]);
1441 if (EFI_ERROR (Status
)) {
1445 Status
= PopExpression (&Value
[1]);
1446 if (EFI_ERROR (Status
)) {
1450 for (Index
= 0; Index
< 2; Index
++) {
1451 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1452 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1453 Status
= EFI_SUCCESS
;
1457 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1458 if (String
[Index
] == NULL
) {
1459 Status
= EFI_NOT_FOUND
;
1464 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1465 Result
->Value
.b
= mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
[0], String
[1]);
1468 if (String
[0] != NULL
) {
1469 FreePool (String
[0]);
1471 if (String
[1] != NULL
) {
1472 FreePool (String
[1]);
1479 Evaluate opcode EFI_IFR_MATCH2.
1481 @param FormSet Formset which contains this opcode.
1482 @param SyntaxType Syntax type for match2.
1483 @param Result Evaluation result for this opcode.
1485 @retval EFI_SUCCESS Opcode evaluation success.
1486 @retval Other Opcode evaluation failed.
1491 IN FORM_BROWSER_FORMSET
*FormSet
,
1492 IN EFI_GUID
*SyntaxType
,
1493 OUT EFI_HII_VALUE
*Result
1497 EFI_HII_VALUE Value
[2];
1501 EFI_HANDLE
*HandleBuffer
;
1503 EFI_REGULAR_EXPRESSION_PROTOCOL
*RegularExpressionProtocol
;
1504 UINTN RegExSyntaxTypeListSize
;
1505 EFI_REGEX_SYNTAX_TYPE
*RegExSyntaxTypeList
;
1506 UINTN CapturesCount
;
1509 // String[0] - The string to search
1510 // String[1] - pattern
1514 HandleBuffer
= NULL
;
1515 RegExSyntaxTypeList
= NULL
;
1516 Status
= EFI_SUCCESS
;
1517 ZeroMem (Value
, sizeof (Value
));
1519 Status
= PopExpression (&Value
[0]);
1520 if (EFI_ERROR (Status
)) {
1524 Status
= PopExpression (&Value
[1]);
1525 if (EFI_ERROR (Status
)) {
1529 for (Index
= 0; Index
< 2; Index
++) {
1530 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1531 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1532 Status
= EFI_SUCCESS
;
1536 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1537 if (String
[Index
] == NULL
) {
1538 Status
= EFI_NOT_FOUND
;
1544 HandleBuffer
= NULL
;
1545 Status
= gBS
->LocateHandle(
1547 &gEfiRegularExpressionProtocolGuid
,
1551 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1552 HandleBuffer
= AllocateZeroPool(BufferSize
);
1553 if (HandleBuffer
== NULL
) {
1554 Status
= EFI_OUT_OF_RESOURCES
;
1557 Status
= gBS
->LocateHandle(
1559 &gEfiRegularExpressionProtocolGuid
,
1564 } else if (EFI_ERROR (Status
)) {
1565 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1566 Status
= EFI_SUCCESS
;
1570 for ( Index
= 0; Index
< BufferSize
/ sizeof(EFI_HANDLE
); Index
++) {
1571 Status
= gBS
->HandleProtocol (
1572 HandleBuffer
[Index
],
1573 &gEfiRegularExpressionProtocolGuid
,
1574 (VOID
**)&RegularExpressionProtocol
1576 if (EFI_ERROR (Status
)) {
1580 RegExSyntaxTypeListSize
= 0;
1581 RegExSyntaxTypeList
= NULL
;
1583 Status
= RegularExpressionProtocol
->GetInfo (
1584 RegularExpressionProtocol
,
1585 &RegExSyntaxTypeListSize
,
1588 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1589 RegExSyntaxTypeList
= AllocateZeroPool(RegExSyntaxTypeListSize
);
1590 if (RegExSyntaxTypeList
== NULL
) {
1591 Status
= EFI_OUT_OF_RESOURCES
;
1594 Status
= RegularExpressionProtocol
->GetInfo (
1595 RegularExpressionProtocol
,
1596 &RegExSyntaxTypeListSize
,
1599 } else if (EFI_ERROR (Status
)) {
1603 for (GuidIndex
= 0; GuidIndex
< RegExSyntaxTypeListSize
/ sizeof(EFI_GUID
); GuidIndex
++) {
1604 if (CompareGuid (&RegExSyntaxTypeList
[GuidIndex
], SyntaxType
)) {
1606 // Find the match type, return the value.
1608 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1609 Status
= RegularExpressionProtocol
->MatchString (
1610 RegularExpressionProtocol
,
1622 if (RegExSyntaxTypeList
!= NULL
) {
1623 FreePool (RegExSyntaxTypeList
);
1628 // Type specified by SyntaxType is not supported
1629 // in any of the EFI_REGULAR_EXPRESSION_PROTOCOL instances.
1631 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1632 Status
= EFI_SUCCESS
;
1635 if (String
[0] != NULL
) {
1636 FreePool (String
[0]);
1638 if (String
[1] != NULL
) {
1639 FreePool (String
[1]);
1641 if (RegExSyntaxTypeList
!= NULL
) {
1642 FreePool (RegExSyntaxTypeList
);
1644 if (HandleBuffer
!= NULL
) {
1645 FreePool (HandleBuffer
);
1651 Evaluate opcode EFI_IFR_FIND.
1653 @param FormSet Formset which contains this opcode.
1654 @param Format Case sensitive or insensitive.
1655 @param Result Evaluation result for this opcode.
1657 @retval EFI_SUCCESS Opcode evaluation success.
1658 @retval Other Opcode evaluation failed.
1663 IN FORM_BROWSER_FORMSET
*FormSet
,
1665 OUT EFI_HII_VALUE
*Result
1669 EFI_HII_VALUE Value
[3];
1675 ZeroMem (Value
, sizeof (Value
));
1677 if (Format
> EFI_IFR_FF_CASE_INSENSITIVE
) {
1678 return EFI_INVALID_PARAMETER
;
1681 Status
= PopExpression (&Value
[0]);
1682 if (EFI_ERROR (Status
)) {
1686 Status
= PopExpression (&Value
[1]);
1687 if (EFI_ERROR (Status
)) {
1691 Status
= PopExpression (&Value
[2]);
1692 if (EFI_ERROR (Status
)) {
1696 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1697 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1700 Base
= (UINTN
) Value
[0].Value
.u64
;
1703 // String[0] - sub-string
1704 // String[1] - The string to search
1708 for (Index
= 0; Index
< 2; Index
++) {
1709 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1710 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1711 Status
= EFI_SUCCESS
;
1715 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1716 if (String
[Index
] == NULL
) {
1717 Status
= EFI_NOT_FOUND
;
1721 if (Format
== EFI_IFR_FF_CASE_INSENSITIVE
) {
1723 // Case insensitive, convert both string to upper case
1725 IfrStrToUpper (String
[Index
]);
1729 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1730 if (Base
>= StrLen (String
[1])) {
1731 Result
->Value
.u64
= 0xFFFFFFFFFFFFFFFFULL
;
1733 StringPtr
= StrStr (String
[1] + Base
, String
[0]);
1734 Result
->Value
.u64
= (StringPtr
== NULL
) ? 0xFFFFFFFFFFFFFFFFULL
: (StringPtr
- String
[1]);
1738 if (String
[0] != NULL
) {
1739 FreePool (String
[0]);
1741 if (String
[1] != NULL
) {
1742 FreePool (String
[1]);
1750 Evaluate opcode EFI_IFR_MID.
1752 @param FormSet Formset which contains this opcode.
1753 @param Result Evaluation result for this opcode.
1755 @retval EFI_SUCCESS Opcode evaluation success.
1756 @retval Other Opcode evaluation failed.
1761 IN FORM_BROWSER_FORMSET
*FormSet
,
1762 OUT EFI_HII_VALUE
*Result
1766 EFI_HII_VALUE Value
[3];
1774 ZeroMem (Value
, sizeof (Value
));
1776 Status
= PopExpression (&Value
[0]);
1777 if (EFI_ERROR (Status
)) {
1781 Status
= PopExpression (&Value
[1]);
1782 if (EFI_ERROR (Status
)) {
1786 Status
= PopExpression (&Value
[2]);
1787 if (EFI_ERROR (Status
)) {
1791 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1792 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1795 Length
= (UINTN
) Value
[0].Value
.u64
;
1797 if (Value
[1].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1798 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1801 Base
= (UINTN
) Value
[1].Value
.u64
;
1803 if (Value
[2].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[2])) {
1804 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1807 if (Value
[2].Type
== EFI_IFR_TYPE_STRING
) {
1808 String
= GetToken (Value
[2].Value
.string
, FormSet
->HiiHandle
);
1809 if (String
== NULL
) {
1810 return EFI_NOT_FOUND
;
1813 if (Length
== 0 || Base
>= StrLen (String
)) {
1814 SubString
= gEmptyString
;
1816 SubString
= String
+ Base
;
1817 if ((Base
+ Length
) < StrLen (String
)) {
1818 SubString
[Length
] = L
'\0';
1822 Result
->Type
= EFI_IFR_TYPE_STRING
;
1823 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1827 BufferLen
= GetLengthForValue (&Value
[2]);
1828 Buffer
= GetBufferForValue (&Value
[2]);
1830 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1831 if (Length
== 0 || Base
>= BufferLen
) {
1832 Result
->BufferLen
= 0;
1833 Result
->Buffer
= NULL
;
1835 Result
->BufferLen
= (UINT16
)((BufferLen
- Base
) < Length
? (BufferLen
- Base
) : Length
);
1836 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1837 ASSERT (Result
->Buffer
!= NULL
);
1838 CopyMem (Result
->Buffer
, &Buffer
[Base
], Result
->BufferLen
);
1841 if (Value
[2].Type
== EFI_IFR_TYPE_BUFFER
) {
1842 FreePool (Value
[2].Buffer
);
1851 Evaluate opcode EFI_IFR_TOKEN.
1853 @param FormSet Formset which contains this opcode.
1854 @param Result Evaluation result for this opcode.
1856 @retval EFI_SUCCESS Opcode evaluation success.
1857 @retval Other Opcode evaluation failed.
1862 IN FORM_BROWSER_FORMSET
*FormSet
,
1863 OUT EFI_HII_VALUE
*Result
1867 EFI_HII_VALUE Value
[3];
1875 ZeroMem (Value
, sizeof (Value
));
1877 Status
= PopExpression (&Value
[0]);
1878 if (EFI_ERROR (Status
)) {
1882 Status
= PopExpression (&Value
[1]);
1883 if (EFI_ERROR (Status
)) {
1887 Status
= PopExpression (&Value
[2]);
1888 if (EFI_ERROR (Status
)) {
1892 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1893 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1896 Count
= (UINTN
) Value
[0].Value
.u64
;
1899 // String[0] - Delimiter
1900 // String[1] - The string to search
1904 for (Index
= 0; Index
< 2; Index
++) {
1905 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1906 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1907 Status
= EFI_SUCCESS
;
1911 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1912 if (String
[Index
] == NULL
) {
1913 Status
= EFI_NOT_FOUND
;
1918 Delimiter
= String
[0];
1919 SubString
= String
[1];
1921 SubString
= StrStr (SubString
, Delimiter
);
1922 if (SubString
!= NULL
) {
1924 // Skip over the delimiter
1926 SubString
= SubString
+ StrLen (Delimiter
);
1933 if (SubString
== NULL
) {
1935 // nth delimited sub-string not found, push an empty string
1937 SubString
= gEmptyString
;
1940 // Put a NULL terminator for nth delimited sub-string
1942 StringPtr
= StrStr (SubString
, Delimiter
);
1943 if (StringPtr
!= NULL
) {
1948 Result
->Type
= EFI_IFR_TYPE_STRING
;
1949 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1952 if (String
[0] != NULL
) {
1953 FreePool (String
[0]);
1955 if (String
[1] != NULL
) {
1956 FreePool (String
[1]);
1964 Evaluate opcode EFI_IFR_SPAN.
1966 @param FormSet Formset which contains this opcode.
1967 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1968 @param Result Evaluation result for this opcode.
1970 @retval EFI_SUCCESS Opcode evaluation success.
1971 @retval Other Opcode evaluation failed.
1976 IN FORM_BROWSER_FORMSET
*FormSet
,
1978 OUT EFI_HII_VALUE
*Result
1982 EFI_HII_VALUE Value
[3];
1990 ZeroMem (Value
, sizeof (Value
));
1992 Status
= PopExpression (&Value
[0]);
1993 if (EFI_ERROR (Status
)) {
1997 Status
= PopExpression (&Value
[1]);
1998 if (EFI_ERROR (Status
)) {
2002 Status
= PopExpression (&Value
[2]);
2003 if (EFI_ERROR (Status
)) {
2007 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
2008 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2011 Base
= (UINTN
) Value
[0].Value
.u64
;
2014 // String[0] - Charset
2015 // String[1] - The string to search
2019 for (Index
= 0; Index
< 2; Index
++) {
2020 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
2021 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2022 Status
= EFI_SUCCESS
;
2026 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
2027 if (String
[Index
] == NULL
) {
2028 Status
= EFI_NOT_FOUND
;
2033 if (Base
>= StrLen (String
[1])) {
2034 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2035 Status
= EFI_SUCCESS
;
2040 StringPtr
= String
[1] + Base
;
2041 Charset
= String
[0];
2042 while (*StringPtr
!= 0 && !Found
) {
2044 while (Charset
[Index
] != 0) {
2045 if (*StringPtr
>= Charset
[Index
] && *StringPtr
<= Charset
[Index
+ 1]) {
2046 if (Flags
== EFI_IFR_FLAGS_FIRST_MATCHING
) {
2051 if (Flags
== EFI_IFR_FLAGS_FIRST_NON_MATCHING
) {
2057 // Skip characters pair representing low-end of a range and high-end of a range
2067 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2068 Result
->Value
.u64
= StringPtr
- String
[1];
2071 if (String
[0] != NULL
) {
2072 FreePool (String
[0]);
2074 if (String
[1] != NULL
) {
2075 FreePool (String
[1]);
2083 Zero extend integer/boolean/date/time to UINT64 for comparing.
2085 @param Value HII Value to be converted.
2090 IN EFI_HII_VALUE
*Value
2096 switch (Value
->Type
) {
2097 case EFI_IFR_TYPE_NUM_SIZE_8
:
2098 Temp
= Value
->Value
.u8
;
2101 case EFI_IFR_TYPE_NUM_SIZE_16
:
2102 Temp
= Value
->Value
.u16
;
2105 case EFI_IFR_TYPE_NUM_SIZE_32
:
2106 Temp
= Value
->Value
.u32
;
2109 case EFI_IFR_TYPE_BOOLEAN
:
2110 Temp
= Value
->Value
.b
;
2113 case EFI_IFR_TYPE_TIME
:
2114 Temp
= Value
->Value
.u32
& 0xffffff;
2117 case EFI_IFR_TYPE_DATE
:
2118 Temp
= Value
->Value
.u32
;
2125 Value
->Value
.u64
= Temp
;
2129 Get UINT64 type value.
2131 @param Value Input Hii value.
2133 @retval UINT64 Return the UINT64 type value.
2138 IN EFI_HII_VALUE
*Value
2145 switch (Value
->Type
) {
2146 case EFI_IFR_TYPE_NUM_SIZE_8
:
2147 RetVal
= Value
->Value
.u8
;
2150 case EFI_IFR_TYPE_NUM_SIZE_16
:
2151 RetVal
= Value
->Value
.u16
;
2154 case EFI_IFR_TYPE_NUM_SIZE_32
:
2155 RetVal
= Value
->Value
.u32
;
2158 case EFI_IFR_TYPE_BOOLEAN
:
2159 RetVal
= Value
->Value
.b
;
2162 case EFI_IFR_TYPE_DATE
:
2163 RetVal
= *(UINT64
*) &Value
->Value
.date
;
2166 case EFI_IFR_TYPE_TIME
:
2167 RetVal
= (*(UINT64
*) &Value
->Value
.time
) & 0xffffff;
2171 RetVal
= Value
->Value
.u64
;
2179 Compare two Hii value.
2181 @param Value1 Expression value to compare on left-hand.
2182 @param Value2 Expression value to compare on right-hand.
2183 @param Result Return value after compare.
2184 retval 0 Two operators equal.
2185 return Positive value if Value1 is greater than Value2.
2186 retval Negative value if Value1 is less than Value2.
2187 @param HiiHandle Only required for string compare.
2189 @retval other Could not perform compare on two values.
2190 @retval EFI_SUCCESS Compare the value success.
2195 IN EFI_HII_VALUE
*Value1
,
2196 IN EFI_HII_VALUE
*Value2
,
2198 IN EFI_HII_HANDLE HiiHandle OPTIONAL
2210 if (Value1
->Type
== EFI_IFR_TYPE_STRING
&& Value2
->Type
== EFI_IFR_TYPE_STRING
) {
2211 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
2213 // StringId 0 is reserved
2215 return EFI_INVALID_PARAMETER
;
2218 if (Value1
->Value
.string
== Value2
->Value
.string
) {
2223 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
2228 return EFI_NOT_FOUND
;
2231 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
2234 return EFI_NOT_FOUND
;
2237 *Result
= StrCmp (Str1
, Str2
);
2246 // Take types(date, time, ref, buffer) as buffer
2248 if (IsTypeInBuffer(Value1
) && IsTypeInBuffer(Value2
)) {
2249 Buf1
= GetBufferForValue(Value1
);
2250 Buf1Len
= GetLengthForValue(Value1
);
2251 Buf2
= GetBufferForValue(Value2
);
2252 Buf2Len
= GetLengthForValue(Value2
);
2254 Len
= Buf1Len
> Buf2Len
? Buf2Len
: Buf1Len
;
2255 *Result
= CompareMem (Buf1
, Buf2
, Len
);
2256 if ((*Result
== 0) && (Buf1Len
!= Buf2Len
)) {
2258 // In this case, means base on samll number buffer, the data is same
2259 // So which value has more data, which value is bigger.
2261 *Result
= Buf1Len
> Buf2Len
? 1 : -1;
2267 // Take types(integer, boolean) as integer
2269 if (IsTypeInUINT64(Value1
) && IsTypeInUINT64(Value2
)) {
2270 Temp64
= HiiValueToUINT64(Value1
) - HiiValueToUINT64(Value2
);
2273 } else if (Temp64
< 0) {
2282 return EFI_UNSUPPORTED
;
2286 Check if current user has the privilege specified by the permissions GUID.
2288 @param[in] Guid A GUID specifying setup access permissions.
2290 @retval TRUE Current user has the privilege.
2291 @retval FALSE Current user does not have the privilege.
2294 CheckUserPrivilege (
2299 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
2300 EFI_USER_INFO_HANDLE UserInfoHandle
;
2301 EFI_USER_INFO
*UserInfo
;
2302 EFI_GUID
*UserPermissionsGuid
;
2304 UINTN AccessControlDataSize
;
2305 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
2308 if (mUserManager
== NULL
) {
2309 Status
= gBS
->LocateProtocol (
2310 &gEfiUserManagerProtocolGuid
,
2312 (VOID
**) &mUserManager
2314 if (EFI_ERROR (Status
)) {
2316 /// If the system does not support user management, then it is assumed that
2317 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
2318 /// op-code is always TRUE.
2324 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
2325 ASSERT_EFI_ERROR (Status
);
2328 /// Enumerate all user information of the current user profile
2329 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
2332 for (UserInfoHandle
= NULL
;;) {
2333 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
2334 if (EFI_ERROR (Status
)) {
2339 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
2340 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2344 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
2345 if (UserInfo
== NULL
) {
2349 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
2350 if (EFI_ERROR (Status
) ||
2351 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
2352 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
2353 FreePool (UserInfo
);
2357 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
2358 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
2359 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2360 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2363 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
2365 /// Check if current user has the privilege specified by the permissions GUID.
2368 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
2369 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
2370 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
2371 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
2372 FreePool (UserInfo
);
2375 UserPermissionsGuid
++;
2376 AccessControlDataSize
-= sizeof (EFI_GUID
);
2379 RemainSize
-= AccessControl
->Size
;
2380 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
2383 FreePool (UserInfo
);
2389 Get question value from the predefined formset.
2391 @param DevicePath The driver's device path which produece the formset data.
2392 @param InputHiiHandle The hii handle associate with the formset data.
2393 @param FormSetGuid The formset guid which include the question.
2394 @param QuestionId The question id which need to get value from.
2395 @param Value The return data about question's value.
2397 @retval TRUE Get the question value success.
2398 @retval FALSE Get the question value failed.
2401 GetQuestionValueFromForm (
2402 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2403 IN EFI_HII_HANDLE InputHiiHandle
,
2404 IN EFI_GUID
*FormSetGuid
,
2405 IN EFI_QUESTION_ID QuestionId
,
2406 OUT EFI_HII_VALUE
*Value
2410 EFI_HII_HANDLE HiiHandle
;
2411 FORM_BROWSER_STATEMENT
*Question
;
2412 FORM_BROWSER_FORMSET
*FormSet
;
2413 FORM_BROWSER_FORM
*Form
;
2418 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2420 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
2421 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
2431 if (DevicePath
!= NULL
) {
2432 HiiHandle
= DevicePathToHiiHandle (DevicePath
, FormSetGuid
);
2433 if (HiiHandle
== NULL
) {
2437 HiiHandle
= InputHiiHandle
;
2439 ASSERT (HiiHandle
!= NULL
);
2442 // Get the formset data include this question.
2444 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2445 ASSERT (FormSet
!= NULL
);
2446 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
);
2447 if (EFI_ERROR (Status
)) {
2453 // Base on the Question Id to get the question info.
2455 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2456 if (Question
== NULL
) {
2462 // Search form in the formset scope
2464 Link
= GetFirstNode (&FormSet
->FormListHead
);
2465 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2466 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2468 Question
= IdToQuestion2 (Form
, QuestionId
);
2469 if (Question
!= NULL
) {
2473 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2476 ASSERT (Form
!= NULL
);
2479 // Get the question value.
2481 Status
= GetQuestionValue(FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
2482 if (EFI_ERROR (Status
)) {
2487 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2491 // Clean the formset structure and restore the global parameter.
2493 if (FormSet
!= NULL
) {
2494 DestroyFormSet (FormSet
);
2501 Evaluate the result of a HII expression.
2503 If Expression is NULL, then ASSERT.
2505 @param FormSet FormSet associated with this expression.
2506 @param Form Form associated with this expression.
2507 @param Expression Expression to be evaluated.
2509 @retval EFI_SUCCESS The expression evaluated successfuly
2510 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2512 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2514 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2515 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2519 EvaluateExpression (
2520 IN FORM_BROWSER_FORMSET
*FormSet
,
2521 IN FORM_BROWSER_FORM
*Form
,
2522 IN OUT FORM_EXPRESSION
*Expression
2527 EXPRESSION_OPCODE
*OpCode
;
2528 FORM_BROWSER_STATEMENT
*Question
;
2529 FORM_BROWSER_STATEMENT
*Question2
;
2531 EFI_HII_VALUE Data1
;
2532 EFI_HII_VALUE Data2
;
2533 EFI_HII_VALUE Data3
;
2534 FORM_EXPRESSION
*RuleExpression
;
2535 EFI_HII_VALUE
*Value
;
2540 LIST_ENTRY
*SubExpressionLink
;
2541 FORM_EXPRESSION
*SubExpression
;
2548 EFI_HII_VALUE QuestionVal
;
2549 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2554 // Save current stack offset.
2556 StackOffset
= SaveExpressionEvaluationStackOffset ();
2558 ASSERT (Expression
!= NULL
);
2559 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2561 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2562 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2563 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2565 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2567 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2568 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2569 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2572 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2573 Status
= EFI_SUCCESS
;
2575 switch (OpCode
->Operand
) {
2577 // Built-in functions
2579 case EFI_IFR_EQ_ID_VAL_OP
:
2580 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2581 if (Question
== NULL
) {
2582 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2586 Status
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, &Result
, NULL
);
2587 if (Status
== EFI_UNSUPPORTED
) {
2588 Status
= EFI_SUCCESS
;
2589 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2593 if (EFI_ERROR (Status
)) {
2596 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2599 case EFI_IFR_EQ_ID_ID_OP
:
2600 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2601 if (Question
== NULL
) {
2602 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2606 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2607 if (Question2
== NULL
) {
2608 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2612 Status
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, &Result
, FormSet
->HiiHandle
);
2613 if (Status
== EFI_UNSUPPORTED
) {
2614 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2615 Status
= EFI_SUCCESS
;
2618 if (EFI_ERROR (Status
)) {
2621 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2624 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2625 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2626 if (Question
== NULL
) {
2627 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2631 Value
->Value
.b
= FALSE
;
2632 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2633 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2634 Value
->Value
.b
= TRUE
;
2640 case EFI_IFR_DUP_OP
:
2641 Status
= PopExpression (Value
);
2642 if (EFI_ERROR (Status
)) {
2646 Status
= PushExpression (Value
);
2649 case EFI_IFR_QUESTION_REF1_OP
:
2650 case EFI_IFR_THIS_OP
:
2651 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2652 if (Question
== NULL
) {
2653 Status
= EFI_NOT_FOUND
;
2657 Value
= &Question
->HiiValue
;
2660 case EFI_IFR_SECURITY_OP
:
2661 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2664 case EFI_IFR_GET_OP
:
2666 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2668 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2669 Value
->Value
.u8
= 0;
2670 if (OpCode
->VarStorage
!= NULL
) {
2671 switch (OpCode
->VarStorage
->Type
) {
2672 case EFI_HII_VARSTORE_BUFFER
:
2673 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2675 // Get value from Edit Buffer
2677 Value
->Type
= OpCode
->ValueType
;
2678 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2680 case EFI_HII_VARSTORE_NAME_VALUE
:
2681 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2683 // Get value from string except for STRING value.
2685 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
, GetSetValueWithEditBuffer
);
2686 if (!EFI_ERROR (Status
)) {
2687 ASSERT (StrPtr
!= NULL
);
2688 TempLength
= StrLen (StrPtr
);
2689 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2690 Value
->Type
= OpCode
->ValueType
;
2691 TempBuffer
= (UINT8
*) &Value
->Value
;
2692 ZeroMem (TempStr
, sizeof (TempStr
));
2693 for (Index
= 0; Index
< TempLength
; Index
++) {
2694 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2695 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2696 if ((Index
& 1) == 0) {
2697 TempBuffer
[Index
/2] = DigitUint8
;
2699 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2706 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2708 // Get value from variable.
2710 TempLength
= OpCode
->ValueWidth
;
2711 Value
->Type
= OpCode
->ValueType
;
2712 Status
= gRT
->GetVariable (
2714 &OpCode
->VarStorage
->Guid
,
2719 if (EFI_ERROR (Status
)) {
2720 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2721 Value
->Value
.u8
= 0;
2726 // Not recognize storage.
2728 Status
= EFI_UNSUPPORTED
;
2733 // For Time/Date Data
2735 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2737 // Only support Data/Time data when storage doesn't exist.
2739 Status
= EFI_UNSUPPORTED
;
2742 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2743 if (!EFI_ERROR (Status
)) {
2744 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2745 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2747 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2748 Value
->Value
.u16
= EfiTime
.Year
;
2751 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2752 Value
->Value
.u8
= EfiTime
.Month
;
2755 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2756 Value
->Value
.u8
= EfiTime
.Day
;
2760 // Invalid Date field.
2762 Status
= EFI_INVALID_PARAMETER
;
2766 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2768 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2769 Value
->Value
.u8
= EfiTime
.Hour
;
2772 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2773 Value
->Value
.u8
= EfiTime
.Minute
;
2776 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2777 Value
->Value
.u8
= EfiTime
.Second
;
2781 // Invalid Time field.
2783 Status
= EFI_INVALID_PARAMETER
;
2792 case EFI_IFR_QUESTION_REF3_OP
:
2794 // EFI_IFR_QUESTION_REF3
2795 // Pop an expression from the expression stack
2797 Status
= PopExpression (Value
);
2798 if (EFI_ERROR (Status
)) {
2803 // Validate the expression value
2805 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2806 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2810 if (OpCode
->DevicePath
!= 0) {
2811 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2813 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2814 if (StrPtr
!= NULL
&& mPathFromText
!= NULL
) {
2815 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StrPtr
);
2816 if (DevicePath
!= NULL
&& GetQuestionValueFromForm(DevicePath
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)) {
2817 Value
= &QuestionVal
;
2819 if (DevicePath
!= NULL
) {
2820 FreePool (DevicePath
);
2824 if (StrPtr
!= NULL
) {
2827 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2828 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2829 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2832 Value
= &QuestionVal
;
2834 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2835 if (Question
== NULL
) {
2836 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2841 // push the questions' value on to the expression stack
2843 Value
= &Question
->HiiValue
;
2847 case EFI_IFR_RULE_REF_OP
:
2849 // Find expression for this rule
2851 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2852 if (RuleExpression
== NULL
) {
2853 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2858 // Evaluate this rule expression
2860 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2861 if (EFI_ERROR (Status
) || RuleExpression
->Result
.Type
== EFI_IFR_TYPE_UNDEFINED
) {
2862 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2866 Value
= &RuleExpression
->Result
;
2869 case EFI_IFR_STRING_REF1_OP
:
2870 Value
->Type
= EFI_IFR_TYPE_STRING
;
2871 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2877 case EFI_IFR_TRUE_OP
:
2878 case EFI_IFR_FALSE_OP
:
2879 case EFI_IFR_ONE_OP
:
2880 case EFI_IFR_ONES_OP
:
2881 case EFI_IFR_UINT8_OP
:
2882 case EFI_IFR_UINT16_OP
:
2883 case EFI_IFR_UINT32_OP
:
2884 case EFI_IFR_UINT64_OP
:
2885 case EFI_IFR_UNDEFINED_OP
:
2886 case EFI_IFR_VERSION_OP
:
2887 case EFI_IFR_ZERO_OP
:
2888 Value
= &OpCode
->Value
;
2894 case EFI_IFR_LENGTH_OP
:
2895 Status
= PopExpression (Value
);
2896 if (EFI_ERROR (Status
)) {
2899 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer (Value
)) {
2900 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2904 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2905 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2906 if (StrPtr
== NULL
) {
2907 Status
= EFI_INVALID_PARAMETER
;
2911 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2912 Value
->Value
.u64
= StrLen (StrPtr
);
2915 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2916 Value
->Value
.u64
= GetLengthForValue(Value
);
2917 FreePool (Value
->Buffer
);
2921 case EFI_IFR_NOT_OP
:
2922 Status
= PopExpression (Value
);
2923 if (EFI_ERROR (Status
)) {
2926 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2927 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2930 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2933 case EFI_IFR_QUESTION_REF2_OP
:
2935 // Pop an expression from the expression stack
2937 Status
= PopExpression (Value
);
2938 if (EFI_ERROR (Status
)) {
2943 // Validate the expression value
2945 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2946 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2950 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2951 if (Question
== NULL
) {
2952 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2956 Value
= &Question
->HiiValue
;
2959 case EFI_IFR_STRING_REF2_OP
:
2961 // Pop an expression from the expression stack
2963 Status
= PopExpression (Value
);
2964 if (EFI_ERROR (Status
)) {
2969 // Validate the expression value
2971 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2972 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2976 Value
->Type
= EFI_IFR_TYPE_STRING
;
2977 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2978 if (StrPtr
== NULL
) {
2980 // If String not exit, push an empty string
2982 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2984 Index
= (UINT16
) Value
->Value
.u64
;
2985 Value
->Value
.string
= Index
;
2990 case EFI_IFR_TO_BOOLEAN_OP
:
2992 // Pop an expression from the expression stack
2994 Status
= PopExpression (Value
);
2995 if (EFI_ERROR (Status
)) {
3000 // Convert an expression to a Boolean
3002 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
3004 // When converting from an unsigned integer, zero will be converted to
3005 // FALSE and any other value will be converted to TRUE.
3007 Value
->Value
.b
= (BOOLEAN
) (HiiValueToUINT64(Value
) != 0);
3009 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3010 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
3012 // When converting from a string, if case-insensitive compare
3013 // with "true" is True, then push True. If a case-insensitive compare
3014 // with "false" is True, then push False. Otherwise, push Undefined.
3016 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
3017 if (StrPtr
== NULL
) {
3018 Status
= EFI_INVALID_PARAMETER
;
3022 IfrStrToUpper (StrPtr
);
3023 if (StrCmp (StrPtr
, L
"TRUE") == 0){
3024 Value
->Value
.b
= TRUE
;
3025 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3026 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
3027 Value
->Value
.b
= FALSE
;
3028 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3030 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3033 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
3035 // When converting from a buffer, if the buffer is all zeroes,
3036 // then push False. Otherwise push True.
3038 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
3039 if (Value
->Buffer
[Index
] != 0) {
3044 if (Index
>= Value
->BufferLen
) {
3045 Value
->Value
.b
= FALSE
;
3047 Value
->Value
.b
= TRUE
;
3049 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3050 FreePool (Value
->Buffer
);
3054 case EFI_IFR_TO_STRING_OP
:
3055 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
3058 case EFI_IFR_TO_UINT_OP
:
3059 Status
= IfrToUint (FormSet
, Value
);
3062 case EFI_IFR_TO_LOWER_OP
:
3063 case EFI_IFR_TO_UPPER_OP
:
3064 Status
= InitializeUnicodeCollationProtocol ();
3065 if (EFI_ERROR (Status
)) {
3069 Status
= PopExpression (Value
);
3070 if (EFI_ERROR (Status
)) {
3074 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
3075 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3079 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
3080 if (StrPtr
== NULL
) {
3081 Status
= EFI_NOT_FOUND
;
3085 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
3086 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
3088 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
3090 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
3094 case EFI_IFR_BITWISE_NOT_OP
:
3096 // Pop an expression from the expression stack
3098 Status
= PopExpression (Value
);
3099 if (EFI_ERROR (Status
)) {
3102 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
3103 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3107 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
3108 Value
->Value
.u64
= ~ HiiValueToUINT64(Value
);
3111 case EFI_IFR_SET_OP
:
3113 // Pop an expression from the expression stack
3115 Status
= PopExpression (Value
);
3116 if (EFI_ERROR (Status
)) {
3119 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
3120 Data1
.Value
.b
= FALSE
;
3122 // Set value to var storage buffer
3124 if (OpCode
->VarStorage
!= NULL
) {
3125 switch (OpCode
->VarStorage
->Type
) {
3126 case EFI_HII_VARSTORE_BUFFER
:
3127 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
3128 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
3129 Data1
.Value
.b
= TRUE
;
3131 case EFI_HII_VARSTORE_NAME_VALUE
:
3132 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
3133 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
3134 ASSERT (Value
!= NULL
);
3136 // Convert Buffer to Hex String
3138 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
3140 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
3141 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
3143 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, GetSetValueWithEditBuffer
, NULL
);
3144 FreePool (NameValue
);
3145 if (!EFI_ERROR (Status
)) {
3146 Data1
.Value
.b
= TRUE
;
3150 case EFI_HII_VARSTORE_EFI_VARIABLE
:
3151 Status
= gRT
->SetVariable (
3153 &OpCode
->VarStorage
->Guid
,
3154 OpCode
->VarStorage
->Attributes
,
3158 if (!EFI_ERROR (Status
)) {
3159 Data1
.Value
.b
= TRUE
;
3164 // Not recognize storage.
3166 Status
= EFI_UNSUPPORTED
;
3172 // For Time/Date Data
3174 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
3176 // Only support Data/Time data when storage doesn't exist.
3178 Status
= EFI_UNSUPPORTED
;
3181 Status
= gRT
->GetTime (&EfiTime
, NULL
);
3182 if (!EFI_ERROR (Status
)) {
3183 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
3184 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3186 EfiTime
.Year
= Value
->Value
.u16
;
3189 EfiTime
.Month
= Value
->Value
.u8
;
3192 EfiTime
.Day
= Value
->Value
.u8
;
3196 // Invalid Date field.
3198 Status
= EFI_INVALID_PARAMETER
;
3202 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3204 EfiTime
.Hour
= Value
->Value
.u8
;
3207 EfiTime
.Minute
= Value
->Value
.u8
;
3210 EfiTime
.Second
= Value
->Value
.u8
;
3214 // Invalid Time field.
3216 Status
= EFI_INVALID_PARAMETER
;
3220 Status
= gRT
->SetTime (&EfiTime
);
3221 if (!EFI_ERROR (Status
)) {
3222 Data1
.Value
.b
= TRUE
;
3232 case EFI_IFR_ADD_OP
:
3233 case EFI_IFR_SUBTRACT_OP
:
3234 case EFI_IFR_MULTIPLY_OP
:
3235 case EFI_IFR_DIVIDE_OP
:
3236 case EFI_IFR_MODULO_OP
:
3237 case EFI_IFR_BITWISE_AND_OP
:
3238 case EFI_IFR_BITWISE_OR_OP
:
3239 case EFI_IFR_SHIFT_LEFT_OP
:
3240 case EFI_IFR_SHIFT_RIGHT_OP
:
3242 // Pop an expression from the expression stack
3244 Status
= PopExpression (&Data2
);
3245 if (EFI_ERROR (Status
)) {
3250 // Pop another expression from the expression stack
3252 Status
= PopExpression (&Data1
);
3253 if (EFI_ERROR (Status
)) {
3257 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
3258 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3263 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
3264 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3268 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
3270 switch (OpCode
->Operand
) {
3271 case EFI_IFR_ADD_OP
:
3272 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) + HiiValueToUINT64(&Data2
);
3275 case EFI_IFR_SUBTRACT_OP
:
3276 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) - HiiValueToUINT64(&Data2
);
3279 case EFI_IFR_MULTIPLY_OP
:
3280 Value
->Value
.u64
= MultU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3283 case EFI_IFR_DIVIDE_OP
:
3284 Value
->Value
.u64
= DivU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3287 case EFI_IFR_MODULO_OP
:
3288 DivU64x32Remainder (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
), &TempValue
);
3289 Value
->Value
.u64
= TempValue
;
3292 case EFI_IFR_BITWISE_AND_OP
:
3293 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) & HiiValueToUINT64(&Data2
);
3296 case EFI_IFR_BITWISE_OR_OP
:
3297 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) | HiiValueToUINT64(&Data2
);
3300 case EFI_IFR_SHIFT_LEFT_OP
:
3301 Value
->Value
.u64
= LShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3304 case EFI_IFR_SHIFT_RIGHT_OP
:
3305 Value
->Value
.u64
= RShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3313 case EFI_IFR_AND_OP
:
3316 // Two Boolean operator
3318 Status
= PopExpression (&Data2
);
3319 if (EFI_ERROR (Status
)) {
3324 // Pop another expression from the expression stack
3326 Status
= PopExpression (&Data1
);
3327 if (EFI_ERROR (Status
)) {
3331 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3332 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3336 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3337 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3341 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
3342 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
3344 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
3348 case EFI_IFR_EQUAL_OP
:
3349 case EFI_IFR_NOT_EQUAL_OP
:
3350 case EFI_IFR_GREATER_EQUAL_OP
:
3351 case EFI_IFR_GREATER_THAN_OP
:
3352 case EFI_IFR_LESS_EQUAL_OP
:
3353 case EFI_IFR_LESS_THAN_OP
:
3355 // Compare two integer, string, boolean or date/time
3357 Status
= PopExpression (&Data2
);
3358 if (EFI_ERROR (Status
)) {
3363 // Pop another expression from the expression stack
3365 Status
= PopExpression (&Data1
);
3366 if (EFI_ERROR (Status
)) {
3370 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3371 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
3372 !IsTypeInBuffer(&Data2
)) {
3373 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3377 if (Data1
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3378 Data1
.Type
!= EFI_IFR_TYPE_STRING
&&
3379 !IsTypeInBuffer(&Data1
)) {
3380 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3384 Status
= CompareHiiValue (&Data1
, &Data2
, &Result
, FormSet
->HiiHandle
);
3385 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
3386 FreePool (Data1
.Buffer
);
3388 if (Data2
.Type
== EFI_IFR_TYPE_BUFFER
) {
3389 FreePool (Data2
.Buffer
);
3392 if (Status
== EFI_UNSUPPORTED
) {
3393 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3394 Status
= EFI_SUCCESS
;
3398 if (EFI_ERROR (Status
)) {
3402 switch (OpCode
->Operand
) {
3403 case EFI_IFR_EQUAL_OP
:
3404 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
3407 case EFI_IFR_NOT_EQUAL_OP
:
3408 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
3411 case EFI_IFR_GREATER_EQUAL_OP
:
3412 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
3415 case EFI_IFR_GREATER_THAN_OP
:
3416 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
3419 case EFI_IFR_LESS_EQUAL_OP
:
3420 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
3423 case EFI_IFR_LESS_THAN_OP
:
3424 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
3432 case EFI_IFR_MATCH_OP
:
3433 Status
= InitializeUnicodeCollationProtocol ();
3434 if (EFI_ERROR (Status
)) {
3438 Status
= IfrMatch (FormSet
, Value
);
3441 case EFI_IFR_MATCH2_OP
:
3442 Status
= IfrMatch2 (FormSet
, &OpCode
->Guid
, Value
);
3445 case EFI_IFR_CATENATE_OP
:
3446 Status
= IfrCatenate (FormSet
, Value
);
3452 case EFI_IFR_CONDITIONAL_OP
:
3454 // Pop third expression from the expression stack
3456 Status
= PopExpression (&Data3
);
3457 if (EFI_ERROR (Status
)) {
3462 // Pop second expression from the expression stack
3464 Status
= PopExpression (&Data2
);
3465 if (EFI_ERROR (Status
)) {
3470 // Pop first expression from the expression stack
3472 Status
= PopExpression (&Data1
);
3473 if (EFI_ERROR (Status
)) {
3476 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3477 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3481 if (Data1
.Value
.b
) {
3488 case EFI_IFR_FIND_OP
:
3489 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3492 case EFI_IFR_MID_OP
:
3493 Status
= IfrMid (FormSet
, Value
);
3496 case EFI_IFR_TOKEN_OP
:
3497 Status
= IfrToken (FormSet
, Value
);
3500 case EFI_IFR_SPAN_OP
:
3501 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3504 case EFI_IFR_MAP_OP
:
3506 // Pop the check value
3508 Status
= PopExpression (&Data1
);
3509 if (EFI_ERROR (Status
)) {
3513 // Check MapExpression list is valid.
3515 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3516 Status
= EFI_INVALID_PARAMETER
;
3520 // Go through map expression list.
3522 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3523 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3524 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3526 // Evaluate the first expression in this pair.
3528 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3529 if (EFI_ERROR (Status
)) {
3533 // Compare the expression value with current value
3535 if ((CompareHiiValue (&Data1
, &SubExpression
->Result
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
3537 // Try get the map value.
3539 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3540 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3541 Status
= EFI_INVALID_PARAMETER
;
3544 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3545 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3546 if (EFI_ERROR (Status
)) {
3549 Value
= &SubExpression
->Result
;
3553 // Skip the second expression on this pair.
3555 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3556 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3557 Status
= EFI_INVALID_PARAMETER
;
3561 // Goto the first expression on next pair.
3563 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3567 // No map value is found.
3569 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3570 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3571 Value
->Value
.u8
= 0;
3578 if (EFI_ERROR (Status
) || Value
->Type
== EFI_IFR_TYPE_UNDEFINED
) {
3582 Status
= PushExpression (Value
);
3583 if (EFI_ERROR (Status
)) {
3589 // Pop the final result from expression stack
3592 Status
= PopExpression (Value
);
3593 if (EFI_ERROR (Status
)) {
3598 // After evaluating an expression, there should be only one value left on the expression stack
3600 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3601 Status
= EFI_INVALID_PARAMETER
;
3605 RestoreExpressionEvaluationStackOffset (StackOffset
);
3606 if (!EFI_ERROR (Status
)) {
3607 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3614 Check whether the result is TRUE or FALSE.
3616 For the EFI_HII_VALUE value type is numeric, return TRUE if the
3619 @param Result Input the result data.
3621 @retval TRUE The result is TRUE.
3622 @retval FALSE The result is FALSE.
3627 IN EFI_HII_VALUE
*Result
3630 switch (Result
->Type
) {
3631 case EFI_IFR_TYPE_BOOLEAN
:
3632 return Result
->Value
.b
;
3634 case EFI_IFR_TYPE_NUM_SIZE_8
:
3635 return (BOOLEAN
)(Result
->Value
.u8
!= 0);
3637 case EFI_IFR_TYPE_NUM_SIZE_16
:
3638 return (BOOLEAN
)(Result
->Value
.u16
!= 0);
3640 case EFI_IFR_TYPE_NUM_SIZE_32
:
3641 return (BOOLEAN
)(Result
->Value
.u32
!= 0);
3643 case EFI_IFR_TYPE_NUM_SIZE_64
:
3644 return (BOOLEAN
)(Result
->Value
.u64
!= 0);
3652 Return the result of the expression list. Check the expression list and
3653 return the highest priority express result.
3654 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3656 @param ExpList The input expression list.
3657 @param Evaluate Whether need to evaluate the expression first.
3658 @param FormSet FormSet associated with this expression.
3659 @param Form Form associated with this expression.
3661 @retval EXPRESS_RESULT Return the higher priority express result.
3662 DisableIf > SuppressIf > GrayOutIf > FALSE
3666 EvaluateExpressionList (
3667 IN FORM_EXPRESSION_LIST
*ExpList
,
3668 IN BOOLEAN Evaluate
,
3669 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3670 IN FORM_BROWSER_FORM
*Form OPTIONAL
3674 EXPRESS_RESULT ReturnVal
;
3675 EXPRESS_RESULT CompareOne
;
3678 if (ExpList
== NULL
) {
3679 return ExpressFalse
;
3682 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3686 // Check whether need to evaluate the expression first.
3689 while (ExpList
->Count
> Index
) {
3690 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3691 if (EFI_ERROR (Status
)) {
3692 return ExpressFalse
;
3698 // Run the list of expressions.
3700 ReturnVal
= ExpressFalse
;
3701 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3702 if (IsTrue (&ExpList
->Expression
[Index
]->Result
)) {
3703 switch (ExpList
->Expression
[Index
]->Type
) {
3704 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3705 CompareOne
= ExpressSuppress
;
3708 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3709 CompareOne
= ExpressGrayOut
;
3712 case EFI_HII_EXPRESSION_DISABLE_IF
:
3713 CompareOne
= ExpressDisable
;
3717 return ExpressFalse
;
3720 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;