2 Utility functions for expression evaluation.
4 Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
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));
993 Evaluate opcode EFI_IFR_TO_STRING.
995 @param FormSet Formset which contains this opcode.
996 @param Format String format in EFI_IFR_TO_STRING.
997 @param Result Evaluation result for this opcode.
999 @retval EFI_SUCCESS Opcode evaluation success.
1000 @retval Other Opcode evaluation failed.
1005 IN FORM_BROWSER_FORMSET
*FormSet
,
1007 OUT EFI_HII_VALUE
*Result
1011 EFI_HII_VALUE Value
;
1013 CHAR16
*PrintFormat
;
1014 CHAR16 Buffer
[MAXIMUM_VALUE_CHARACTERS
];
1018 Status
= PopExpression (&Value
);
1019 if (EFI_ERROR (Status
)) {
1023 switch (Value
.Type
) {
1024 case EFI_IFR_TYPE_NUM_SIZE_8
:
1025 case EFI_IFR_TYPE_NUM_SIZE_16
:
1026 case EFI_IFR_TYPE_NUM_SIZE_32
:
1027 case EFI_IFR_TYPE_NUM_SIZE_64
:
1028 BufferSize
= MAXIMUM_VALUE_CHARACTERS
* sizeof (CHAR16
);
1030 case EFI_IFR_STRING_UNSIGNED_DEC
:
1031 case EFI_IFR_STRING_SIGNED_DEC
:
1032 PrintFormat
= L
"%ld";
1035 case EFI_IFR_STRING_LOWERCASE_HEX
:
1036 PrintFormat
= L
"%lx";
1039 case EFI_IFR_STRING_UPPERCASE_HEX
:
1040 PrintFormat
= L
"%lX";
1044 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1047 UnicodeSPrint (Buffer
, BufferSize
, PrintFormat
, Value
.Value
.u64
);
1051 case EFI_IFR_TYPE_STRING
:
1052 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1055 case EFI_IFR_TYPE_BOOLEAN
:
1056 String
= (Value
.Value
.b
) ? L
"True" : L
"False";
1059 case EFI_IFR_TYPE_BUFFER
:
1061 // + 3 is base on the unicode format, the length may be odd number,
1062 // so need 1 byte to align, also need 2 bytes for L'\0'.
1064 TmpBuf
= AllocateZeroPool (Value
.BufferLen
+ 3);
1065 ASSERT (TmpBuf
!= NULL
);
1066 if (Format
== EFI_IFR_STRING_ASCII
) {
1067 CopyMem (TmpBuf
, Value
.Buffer
, Value
.BufferLen
);
1068 PrintFormat
= L
"%a";
1070 // Format == EFI_IFR_STRING_UNICODE
1071 CopyMem (TmpBuf
, Value
.Buffer
, Value
.BufferLen
* sizeof (CHAR16
));
1072 PrintFormat
= L
"%s";
1074 UnicodeSPrint (Buffer
, sizeof (Buffer
), PrintFormat
, Value
.Buffer
);
1077 FreePool (Value
.Buffer
);
1081 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1085 Result
->Type
= EFI_IFR_TYPE_STRING
;
1086 Result
->Value
.string
= NewString (String
, FormSet
->HiiHandle
);
1092 Evaluate opcode EFI_IFR_TO_UINT.
1094 @param FormSet Formset which contains this opcode.
1095 @param Result Evaluation result for this opcode.
1097 @retval EFI_SUCCESS Opcode evaluation success.
1098 @retval Other Opcode evaluation failed.
1103 IN FORM_BROWSER_FORMSET
*FormSet
,
1104 OUT EFI_HII_VALUE
*Result
1108 EFI_HII_VALUE Value
;
1112 Status
= PopExpression (&Value
);
1113 if (EFI_ERROR (Status
)) {
1117 if (Value
.Type
>= EFI_IFR_TYPE_OTHER
&& Value
.Type
!= EFI_IFR_TYPE_BUFFER
) {
1118 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1122 Status
= EFI_SUCCESS
;
1123 if (Value
.Type
== EFI_IFR_TYPE_STRING
) {
1124 String
= GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1125 if (String
== NULL
) {
1126 return EFI_NOT_FOUND
;
1129 IfrStrToUpper (String
);
1130 StringPtr
= StrStr (String
, L
"0X");
1131 if (StringPtr
!= NULL
) {
1135 Result
->Value
.u64
= StrHexToUint64 (String
);
1140 Result
->Value
.u64
= StrDecimalToUint64 (String
);
1143 } else if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1144 if (Value
.BufferLen
> 8) {
1145 FreePool (Value
.Buffer
);
1146 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1149 Result
->Value
.u64
= *(UINT64
*) Value
.Buffer
;
1150 FreePool (Value
.Buffer
);
1152 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1155 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1161 Evaluate opcode EFI_IFR_CATENATE.
1163 @param FormSet Formset which contains this opcode.
1164 @param Result Evaluation result for this opcode.
1166 @retval EFI_SUCCESS Opcode evaluation success.
1167 @retval Other Opcode evaluation failed.
1172 IN FORM_BROWSER_FORMSET
*FormSet
,
1173 OUT EFI_HII_VALUE
*Result
1177 EFI_HII_VALUE Value
[2];
1184 // String[0] - The second string
1185 // String[1] - The first string
1190 Status
= EFI_SUCCESS
;
1191 ZeroMem (Value
, sizeof (Value
));
1193 Status
= PopExpression (&Value
[0]);
1194 if (EFI_ERROR (Status
)) {
1198 Status
= PopExpression (&Value
[1]);
1199 if (EFI_ERROR (Status
)) {
1203 for (Index
= 0; Index
< 2; Index
++) {
1204 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
&& Value
[Index
].Type
!= EFI_IFR_TYPE_BUFFER
) {
1205 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1206 Status
= EFI_SUCCESS
;
1210 if (Value
[Index
].Type
== EFI_IFR_TYPE_STRING
) {
1211 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1212 if (String
[Index
] == NULL
) {
1213 Status
= EFI_NOT_FOUND
;
1219 if (Value
[0].Type
== EFI_IFR_TYPE_STRING
) {
1220 Size
= StrSize (String
[0]);
1221 StringPtr
= AllocatePool (StrSize (String
[1]) + Size
);
1222 ASSERT (StringPtr
!= NULL
);
1223 StrCpy (StringPtr
, String
[1]);
1224 StrCat (StringPtr
, String
[0]);
1226 Result
->Type
= EFI_IFR_TYPE_STRING
;
1227 Result
->Value
.string
= NewString (StringPtr
, FormSet
->HiiHandle
);
1229 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1230 Result
->BufferLen
= (UINT16
) (Value
[0].BufferLen
+ Value
[1].BufferLen
);
1232 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1233 ASSERT (Result
->Buffer
!= NULL
);
1235 CopyMem (Result
->Buffer
, Value
[0].Buffer
, Value
[0].BufferLen
);
1236 CopyMem (&Result
->Buffer
[Value
[0].BufferLen
], Value
[1].Buffer
, Value
[1].BufferLen
);
1239 if (Value
[0].Buffer
!= NULL
) {
1240 FreePool (Value
[0].Buffer
);
1242 if (Value
[1].Buffer
!= NULL
) {
1243 FreePool (Value
[1].Buffer
);
1245 if (String
[0] != NULL
) {
1246 FreePool (String
[0]);
1248 if (String
[1] != NULL
) {
1249 FreePool (String
[1]);
1251 if (StringPtr
!= NULL
) {
1252 FreePool (StringPtr
);
1260 Evaluate opcode EFI_IFR_MATCH.
1262 @param FormSet Formset which contains this opcode.
1263 @param Result Evaluation result for this opcode.
1265 @retval EFI_SUCCESS Opcode evaluation success.
1266 @retval Other Opcode evaluation failed.
1271 IN FORM_BROWSER_FORMSET
*FormSet
,
1272 OUT EFI_HII_VALUE
*Result
1276 EFI_HII_VALUE Value
[2];
1281 // String[0] - The string to search
1282 // String[1] - pattern
1286 Status
= EFI_SUCCESS
;
1287 ZeroMem (Value
, sizeof (Value
));
1289 Status
= PopExpression (&Value
[0]);
1290 if (EFI_ERROR (Status
)) {
1294 Status
= PopExpression (&Value
[1]);
1295 if (EFI_ERROR (Status
)) {
1299 for (Index
= 0; Index
< 2; Index
++) {
1300 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1301 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1302 Status
= EFI_SUCCESS
;
1306 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1307 if (String
[Index
] == NULL
) {
1308 Status
= EFI_NOT_FOUND
;
1313 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1314 Result
->Value
.b
= mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
[0], String
[1]);
1317 if (String
[0] != NULL
) {
1318 FreePool (String
[0]);
1320 if (String
[1] != NULL
) {
1321 FreePool (String
[1]);
1329 Evaluate opcode EFI_IFR_FIND.
1331 @param FormSet Formset which contains this opcode.
1332 @param Format Case sensitive or insensitive.
1333 @param Result Evaluation result for this opcode.
1335 @retval EFI_SUCCESS Opcode evaluation success.
1336 @retval Other Opcode evaluation failed.
1341 IN FORM_BROWSER_FORMSET
*FormSet
,
1343 OUT EFI_HII_VALUE
*Result
1347 EFI_HII_VALUE Value
[3];
1353 ZeroMem (Value
, sizeof (Value
));
1355 if (Format
> EFI_IFR_FF_CASE_INSENSITIVE
) {
1356 return EFI_INVALID_PARAMETER
;
1359 Status
= PopExpression (&Value
[0]);
1360 if (EFI_ERROR (Status
)) {
1364 Status
= PopExpression (&Value
[1]);
1365 if (EFI_ERROR (Status
)) {
1369 Status
= PopExpression (&Value
[2]);
1370 if (EFI_ERROR (Status
)) {
1374 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1375 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1378 Base
= (UINTN
) Value
[0].Value
.u64
;
1381 // String[0] - sub-string
1382 // String[1] - The string to search
1386 for (Index
= 0; Index
< 2; Index
++) {
1387 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1388 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1389 Status
= EFI_SUCCESS
;
1393 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1394 if (String
[Index
] == NULL
) {
1395 Status
= EFI_NOT_FOUND
;
1399 if (Format
== EFI_IFR_FF_CASE_INSENSITIVE
) {
1401 // Case insensitive, convert both string to upper case
1403 IfrStrToUpper (String
[Index
]);
1407 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1408 if (Base
>= StrLen (String
[1])) {
1409 Result
->Value
.u64
= 0xFFFFFFFFFFFFFFFFULL
;
1411 StringPtr
= StrStr (String
[1] + Base
, String
[0]);
1412 Result
->Value
.u64
= (StringPtr
== NULL
) ? 0xFFFFFFFFFFFFFFFFULL
: (StringPtr
- String
[1]);
1416 if (String
[0] != NULL
) {
1417 FreePool (String
[0]);
1419 if (String
[1] != NULL
) {
1420 FreePool (String
[1]);
1428 Evaluate opcode EFI_IFR_MID.
1430 @param FormSet Formset which contains this opcode.
1431 @param Result Evaluation result for this opcode.
1433 @retval EFI_SUCCESS Opcode evaluation success.
1434 @retval Other Opcode evaluation failed.
1439 IN FORM_BROWSER_FORMSET
*FormSet
,
1440 OUT EFI_HII_VALUE
*Result
1444 EFI_HII_VALUE Value
[3];
1451 ZeroMem (Value
, sizeof (Value
));
1453 Status
= PopExpression (&Value
[0]);
1454 if (EFI_ERROR (Status
)) {
1458 Status
= PopExpression (&Value
[1]);
1459 if (EFI_ERROR (Status
)) {
1463 Status
= PopExpression (&Value
[2]);
1464 if (EFI_ERROR (Status
)) {
1468 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1469 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1472 Length
= (UINTN
) Value
[0].Value
.u64
;
1474 if (Value
[1].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1475 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1478 Base
= (UINTN
) Value
[1].Value
.u64
;
1480 if (Value
[2].Type
!= EFI_IFR_TYPE_STRING
&& Value
[2].Type
!= EFI_IFR_TYPE_BUFFER
) {
1481 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1484 if (Value
[2].Type
== EFI_IFR_TYPE_STRING
) {
1485 String
= GetToken (Value
[2].Value
.string
, FormSet
->HiiHandle
);
1486 if (String
== NULL
) {
1487 return EFI_NOT_FOUND
;
1490 if (Length
== 0 || Base
>= StrLen (String
)) {
1491 SubString
= gEmptyString
;
1493 SubString
= String
+ Base
;
1494 if ((Base
+ Length
) < StrLen (String
)) {
1495 SubString
[Length
] = L
'\0';
1499 Result
->Type
= EFI_IFR_TYPE_STRING
;
1500 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1504 BufferLen
= Value
[2].BufferLen
;
1506 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1507 if (Length
== 0 || Base
>= BufferLen
) {
1508 Result
->BufferLen
= 0;
1509 Result
->Buffer
= NULL
;
1511 Result
->BufferLen
= (UINT16
)((BufferLen
- Base
) < Length
? (BufferLen
- Base
) : Length
);
1512 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1513 ASSERT (Result
->Buffer
!= NULL
);
1514 CopyMem (Result
->Buffer
, &Value
[2].Buffer
[Base
], Result
->BufferLen
);
1517 FreePool (Value
[2].Buffer
);
1525 Evaluate opcode EFI_IFR_TOKEN.
1527 @param FormSet Formset which contains this opcode.
1528 @param Result Evaluation result for this opcode.
1530 @retval EFI_SUCCESS Opcode evaluation success.
1531 @retval Other Opcode evaluation failed.
1536 IN FORM_BROWSER_FORMSET
*FormSet
,
1537 OUT EFI_HII_VALUE
*Result
1541 EFI_HII_VALUE Value
[3];
1549 ZeroMem (Value
, sizeof (Value
));
1551 Status
= PopExpression (&Value
[0]);
1552 if (EFI_ERROR (Status
)) {
1556 Status
= PopExpression (&Value
[1]);
1557 if (EFI_ERROR (Status
)) {
1561 Status
= PopExpression (&Value
[2]);
1562 if (EFI_ERROR (Status
)) {
1566 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1567 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1570 Count
= (UINTN
) Value
[0].Value
.u64
;
1573 // String[0] - Delimiter
1574 // String[1] - The string to search
1578 for (Index
= 0; Index
< 2; Index
++) {
1579 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1580 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1581 Status
= EFI_SUCCESS
;
1585 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1586 if (String
[Index
] == NULL
) {
1587 Status
= EFI_NOT_FOUND
;
1592 Delimiter
= String
[0];
1593 SubString
= String
[1];
1595 SubString
= StrStr (SubString
, Delimiter
);
1596 if (SubString
!= NULL
) {
1598 // Skip over the delimiter
1600 SubString
= SubString
+ StrLen (Delimiter
);
1607 if (SubString
== NULL
) {
1609 // nth delimited sub-string not found, push an empty string
1611 SubString
= gEmptyString
;
1614 // Put a NULL terminator for nth delimited sub-string
1616 StringPtr
= StrStr (SubString
, Delimiter
);
1617 if (StringPtr
!= NULL
) {
1622 Result
->Type
= EFI_IFR_TYPE_STRING
;
1623 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1626 if (String
[0] != NULL
) {
1627 FreePool (String
[0]);
1629 if (String
[1] != NULL
) {
1630 FreePool (String
[1]);
1638 Evaluate opcode EFI_IFR_SPAN.
1640 @param FormSet Formset which contains this opcode.
1641 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1642 @param Result Evaluation result for this opcode.
1644 @retval EFI_SUCCESS Opcode evaluation success.
1645 @retval Other Opcode evaluation failed.
1650 IN FORM_BROWSER_FORMSET
*FormSet
,
1652 OUT EFI_HII_VALUE
*Result
1656 EFI_HII_VALUE Value
[3];
1664 ZeroMem (Value
, sizeof (Value
));
1666 Status
= PopExpression (&Value
[0]);
1667 if (EFI_ERROR (Status
)) {
1671 Status
= PopExpression (&Value
[1]);
1672 if (EFI_ERROR (Status
)) {
1676 Status
= PopExpression (&Value
[2]);
1677 if (EFI_ERROR (Status
)) {
1681 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1682 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1685 Base
= (UINTN
) Value
[0].Value
.u64
;
1688 // String[0] - Charset
1689 // String[1] - The string to search
1693 for (Index
= 0; Index
< 2; Index
++) {
1694 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1695 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1696 Status
= EFI_SUCCESS
;
1700 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1701 if (String
[Index
] == NULL
) {
1702 Status
= EFI_NOT_FOUND
;
1707 if (Base
>= StrLen (String
[1])) {
1708 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1709 Status
= EFI_SUCCESS
;
1714 StringPtr
= String
[1] + Base
;
1715 Charset
= String
[0];
1716 while (*StringPtr
!= 0 && !Found
) {
1718 while (Charset
[Index
] != 0) {
1719 if (*StringPtr
>= Charset
[Index
] && *StringPtr
<= Charset
[Index
+ 1]) {
1720 if (Flags
== EFI_IFR_FLAGS_FIRST_MATCHING
) {
1725 if (Flags
== EFI_IFR_FLAGS_FIRST_NON_MATCHING
) {
1731 // Skip characters pair representing low-end of a range and high-end of a range
1741 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1742 Result
->Value
.u64
= StringPtr
- String
[1];
1745 if (String
[0] != NULL
) {
1746 FreePool (String
[0]);
1748 if (String
[1] != NULL
) {
1749 FreePool (String
[1]);
1757 Zero extend integer/boolean/date/time to UINT64 for comparing.
1759 @param Value HII Value to be converted.
1764 IN EFI_HII_VALUE
*Value
1770 switch (Value
->Type
) {
1771 case EFI_IFR_TYPE_NUM_SIZE_8
:
1772 Temp
= Value
->Value
.u8
;
1775 case EFI_IFR_TYPE_NUM_SIZE_16
:
1776 Temp
= Value
->Value
.u16
;
1779 case EFI_IFR_TYPE_NUM_SIZE_32
:
1780 Temp
= Value
->Value
.u32
;
1783 case EFI_IFR_TYPE_BOOLEAN
:
1784 Temp
= Value
->Value
.b
;
1787 case EFI_IFR_TYPE_TIME
:
1788 Temp
= Value
->Value
.u32
& 0xffffff;
1791 case EFI_IFR_TYPE_DATE
:
1792 Temp
= Value
->Value
.u32
;
1799 Value
->Value
.u64
= Temp
;
1804 Compare two Hii value.
1806 @param Value1 Expression value to compare on left-hand.
1807 @param Value2 Expression value to compare on right-hand.
1808 @param Result Return value after compare.
1809 retval 0 Two operators equal.
1810 return Positive value if Value1 is greater than Value2.
1811 retval Negative value if Value1 is less than Value2.
1812 @param HiiHandle Only required for string compare.
1814 @retval other Could not perform compare on two values.
1815 @retval EFI_SUCCESS Compare the value success.
1820 IN EFI_HII_VALUE
*Value1
,
1821 IN EFI_HII_VALUE
*Value2
,
1823 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1831 if (Value1
->Type
>= EFI_IFR_TYPE_OTHER
|| Value2
->Type
>= EFI_IFR_TYPE_OTHER
) {
1832 if (Value1
->Type
!= EFI_IFR_TYPE_BUFFER
&& Value2
->Type
!= EFI_IFR_TYPE_BUFFER
) {
1833 return EFI_UNSUPPORTED
;
1837 if (Value1
->Type
== EFI_IFR_TYPE_STRING
|| Value2
->Type
== EFI_IFR_TYPE_STRING
) {
1838 if (Value1
->Type
!= Value2
->Type
) {
1840 // Both Operator should be type of String
1842 return EFI_UNSUPPORTED
;
1845 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
1847 // StringId 0 is reserved
1849 return EFI_INVALID_PARAMETER
;
1852 if (Value1
->Value
.string
== Value2
->Value
.string
) {
1857 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
1862 return EFI_NOT_FOUND
;
1865 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
1868 return EFI_NOT_FOUND
;
1871 *Result
= StrCmp (Str1
, Str2
);
1879 if (Value1
->Type
== EFI_IFR_TYPE_BUFFER
|| Value2
->Type
== EFI_IFR_TYPE_BUFFER
) {
1880 if (Value1
->Type
!= Value2
->Type
) {
1882 // Both Operator should be type of Buffer.
1884 return EFI_UNSUPPORTED
;
1886 Len
= Value1
->BufferLen
> Value2
->BufferLen
? Value2
->BufferLen
: Value1
->BufferLen
;
1887 *Result
= CompareMem (Value1
->Buffer
, Value2
->Buffer
, Len
);
1888 if ((*Result
== 0) && (Value1
->BufferLen
!= Value2
->BufferLen
))
1891 // In this case, means base on samll number buffer, the data is same
1892 // So which value has more data, which value is bigger.
1894 *Result
= Value1
->BufferLen
> Value2
->BufferLen
? 1 : -1;
1900 // Take remain types(integer, boolean, date/time) as integer
1902 Temp64
= (INT64
) (Value1
->Value
.u64
- Value2
->Value
.u64
);
1905 } else if (Temp64
< 0) {
1915 Check if current user has the privilege specified by the permissions GUID.
1917 @param[in] Guid A GUID specifying setup access permissions.
1919 @retval TRUE Current user has the privilege.
1920 @retval FALSE Current user does not have the privilege.
1923 CheckUserPrivilege (
1928 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
1929 EFI_USER_INFO_HANDLE UserInfoHandle
;
1930 EFI_USER_INFO
*UserInfo
;
1931 EFI_GUID
*UserPermissionsGuid
;
1933 UINTN AccessControlDataSize
;
1934 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
1937 if (mUserManager
== NULL
) {
1938 Status
= gBS
->LocateProtocol (
1939 &gEfiUserManagerProtocolGuid
,
1941 (VOID
**) &mUserManager
1943 if (EFI_ERROR (Status
)) {
1945 /// If the system does not support user management, then it is assumed that
1946 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
1947 /// op-code is always TRUE.
1953 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
1954 ASSERT_EFI_ERROR (Status
);
1957 /// Enumerate all user information of the current user profile
1958 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
1961 for (UserInfoHandle
= NULL
;;) {
1962 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
1963 if (EFI_ERROR (Status
)) {
1968 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
1969 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1973 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
1974 if (UserInfo
== NULL
) {
1978 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
1979 if (EFI_ERROR (Status
) ||
1980 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
1981 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
1982 FreePool (UserInfo
);
1986 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
1987 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
1988 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
1989 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
1992 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
1994 /// Check if current user has the privilege specified by the permissions GUID.
1997 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
1998 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
1999 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
2000 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
2001 FreePool (UserInfo
);
2004 UserPermissionsGuid
++;
2005 AccessControlDataSize
-= sizeof (EFI_GUID
);
2008 RemainSize
-= AccessControl
->Size
;
2009 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
2012 FreePool (UserInfo
);
2018 Get question value from the predefined formset.
2020 @param DevicePath The driver's device path which produece the formset data.
2021 @param InputHiiHandle The hii handle associate with the formset data.
2022 @param FormSetGuid The formset guid which include the question.
2023 @param QuestionId The question id which need to get value from.
2024 @param Value The return data about question's value.
2026 @retval TRUE Get the question value success.
2027 @retval FALSE Get the question value failed.
2030 GetQuestionValueFromForm (
2031 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2032 IN EFI_HII_HANDLE InputHiiHandle
,
2033 IN EFI_GUID
*FormSetGuid
,
2034 IN EFI_QUESTION_ID QuestionId
,
2035 OUT EFI_HII_VALUE
*Value
2039 EFI_HANDLE DriverHandle
;
2041 EFI_HII_HANDLE
*HiiHandles
;
2042 EFI_HII_HANDLE HiiHandle
;
2044 FORM_BROWSER_STATEMENT
*Question
;
2045 FORM_BROWSER_FORMSET
*FormSet
;
2046 FORM_BROWSER_FORM
*Form
;
2051 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2053 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
2054 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
2057 DriverHandle
= NULL
;
2065 if (DevicePath
!= NULL
) {
2067 // 1. Get Driver handle.
2069 Status
= gBS
->LocateDevicePath (
2070 &gEfiDevicePathProtocolGuid
,
2074 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
2079 // 2. Get Hii handle
2081 HiiHandles
= HiiGetHiiHandles (NULL
);
2082 if (HiiHandles
== NULL
) {
2086 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
2087 Status
= mHiiDatabase
->GetPackageListHandle (
2092 if (!EFI_ERROR (Status
) && (Handle
== DriverHandle
)) {
2093 HiiHandle
= HiiHandles
[Index
];
2097 FreePool (HiiHandles
);
2099 HiiHandle
= InputHiiHandle
;
2101 ASSERT (HiiHandle
!= NULL
);
2104 // Get the formset data include this question.
2106 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2107 ASSERT (FormSet
!= NULL
);
2108 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
, FALSE
);
2109 if (EFI_ERROR (Status
)) {
2115 // Base on the Question Id to get the question info.
2117 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2118 if (Question
== NULL
) {
2124 // Search form in the formset scope
2126 Link
= GetFirstNode (&FormSet
->FormListHead
);
2127 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2128 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2130 Question
= IdToQuestion2 (Form
, QuestionId
);
2131 if (Question
!= NULL
) {
2135 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2138 ASSERT (Form
!= NULL
);
2141 // Get the question value.
2143 Status
= GetQuestionValue(FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
2144 if (EFI_ERROR (Status
)) {
2149 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2153 // Clean the formset structure and restore the global parameter.
2155 if (FormSet
!= NULL
) {
2156 DestroyFormSet (FormSet
);
2163 Evaluate the result of a HII expression.
2165 If Expression is NULL, then ASSERT.
2167 @param FormSet FormSet associated with this expression.
2168 @param Form Form associated with this expression.
2169 @param Expression Expression to be evaluated.
2171 @retval EFI_SUCCESS The expression evaluated successfuly
2172 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2174 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2176 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2177 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2181 EvaluateExpression (
2182 IN FORM_BROWSER_FORMSET
*FormSet
,
2183 IN FORM_BROWSER_FORM
*Form
,
2184 IN OUT FORM_EXPRESSION
*Expression
2189 EXPRESSION_OPCODE
*OpCode
;
2190 FORM_BROWSER_STATEMENT
*Question
;
2191 FORM_BROWSER_STATEMENT
*Question2
;
2193 EFI_HII_VALUE Data1
;
2194 EFI_HII_VALUE Data2
;
2195 EFI_HII_VALUE Data3
;
2196 FORM_EXPRESSION
*RuleExpression
;
2197 EFI_HII_VALUE
*Value
;
2202 LIST_ENTRY
*SubExpressionLink
;
2203 FORM_EXPRESSION
*SubExpression
;
2210 EFI_HII_VALUE QuestionVal
;
2211 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2214 // Save current stack offset.
2216 StackOffset
= SaveExpressionEvaluationStackOffset ();
2218 ASSERT (Expression
!= NULL
);
2219 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2221 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2222 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2223 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2225 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2227 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2228 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2229 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2232 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2233 Status
= EFI_SUCCESS
;
2235 switch (OpCode
->Operand
) {
2237 // Built-in functions
2239 case EFI_IFR_EQ_ID_VAL_OP
:
2240 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2241 if (Question
== NULL
) {
2242 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2246 Status
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, &Result
, NULL
);
2247 if (Status
== EFI_UNSUPPORTED
) {
2248 Status
= EFI_SUCCESS
;
2249 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2253 if (EFI_ERROR (Status
)) {
2256 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2259 case EFI_IFR_EQ_ID_ID_OP
:
2260 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2261 if (Question
== NULL
) {
2262 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2266 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2267 if (Question2
== NULL
) {
2268 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2272 Status
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, &Result
, FormSet
->HiiHandle
);
2273 if (Status
== EFI_UNSUPPORTED
) {
2274 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2275 Status
= EFI_SUCCESS
;
2278 if (EFI_ERROR (Status
)) {
2281 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2284 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2285 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2286 if (Question
== NULL
) {
2287 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2291 Value
->Value
.b
= FALSE
;
2292 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2293 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2294 Value
->Value
.b
= TRUE
;
2300 case EFI_IFR_DUP_OP
:
2301 Status
= PopExpression (Value
);
2302 if (EFI_ERROR (Status
)) {
2306 Status
= PushExpression (Value
);
2309 case EFI_IFR_QUESTION_REF1_OP
:
2310 case EFI_IFR_THIS_OP
:
2311 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2312 if (Question
== NULL
) {
2313 Status
= EFI_NOT_FOUND
;
2317 Value
= &Question
->HiiValue
;
2320 case EFI_IFR_SECURITY_OP
:
2321 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2324 case EFI_IFR_GET_OP
:
2326 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2328 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2329 Value
->Value
.u8
= 0;
2330 if (OpCode
->VarStorage
!= NULL
) {
2331 switch (OpCode
->VarStorage
->Type
) {
2332 case EFI_HII_VARSTORE_BUFFER
:
2333 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2335 // Get value from Edit Buffer
2337 Value
->Type
= OpCode
->ValueType
;
2338 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2340 case EFI_HII_VARSTORE_NAME_VALUE
:
2341 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2343 // Get value from string except for STRING value.
2345 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
, GetSetValueWithEditBuffer
);
2346 if (!EFI_ERROR (Status
)) {
2347 ASSERT (StrPtr
!= NULL
);
2348 TempLength
= StrLen (StrPtr
);
2349 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2350 Value
->Type
= OpCode
->ValueType
;
2351 TempBuffer
= (UINT8
*) &Value
->Value
;
2352 ZeroMem (TempStr
, sizeof (TempStr
));
2353 for (Index
= 0; Index
< TempLength
; Index
++) {
2354 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2355 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2356 if ((Index
& 1) == 0) {
2357 TempBuffer
[Index
/2] = DigitUint8
;
2359 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2366 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2368 // Get value from variable.
2370 TempLength
= OpCode
->ValueWidth
;
2371 Value
->Type
= OpCode
->ValueType
;
2372 Status
= gRT
->GetVariable (
2374 &OpCode
->VarStorage
->Guid
,
2379 if (EFI_ERROR (Status
)) {
2380 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2381 Value
->Value
.u8
= 0;
2386 // Not recognize storage.
2388 Status
= EFI_UNSUPPORTED
;
2393 // For Time/Date Data
2395 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2397 // Only support Data/Time data when storage doesn't exist.
2399 Status
= EFI_UNSUPPORTED
;
2402 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2403 if (!EFI_ERROR (Status
)) {
2404 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2405 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2407 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2408 Value
->Value
.u16
= EfiTime
.Year
;
2411 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2412 Value
->Value
.u8
= EfiTime
.Month
;
2415 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2416 Value
->Value
.u8
= EfiTime
.Day
;
2420 // Invalid Date field.
2422 Status
= EFI_INVALID_PARAMETER
;
2426 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2428 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2429 Value
->Value
.u8
= EfiTime
.Hour
;
2432 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2433 Value
->Value
.u8
= EfiTime
.Minute
;
2436 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2437 Value
->Value
.u8
= EfiTime
.Second
;
2441 // Invalid Time field.
2443 Status
= EFI_INVALID_PARAMETER
;
2452 case EFI_IFR_QUESTION_REF3_OP
:
2454 // EFI_IFR_QUESTION_REF3
2455 // Pop an expression from the expression stack
2457 Status
= PopExpression (Value
);
2458 if (EFI_ERROR (Status
)) {
2463 // Validate the expression value
2465 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2466 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2470 if (OpCode
->DevicePath
!= 0) {
2471 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2473 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2474 if (StrPtr
!= NULL
&& mPathFromText
!= NULL
) {
2475 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StrPtr
);
2476 if (DevicePath
!= NULL
&& GetQuestionValueFromForm(DevicePath
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)) {
2477 Value
= &QuestionVal
;
2479 if (DevicePath
!= NULL
) {
2480 FreePool (DevicePath
);
2484 if (StrPtr
!= NULL
) {
2487 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2488 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2489 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2492 Value
= &QuestionVal
;
2494 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2495 if (Question
== NULL
) {
2496 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2501 // push the questions' value on to the expression stack
2503 Value
= &Question
->HiiValue
;
2507 case EFI_IFR_RULE_REF_OP
:
2509 // Find expression for this rule
2511 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2512 if (RuleExpression
== NULL
) {
2513 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2518 // Evaluate this rule expression
2520 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2521 if (EFI_ERROR (Status
) || RuleExpression
->Result
.Type
== EFI_IFR_TYPE_UNDEFINED
) {
2522 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2526 Value
= &RuleExpression
->Result
;
2529 case EFI_IFR_STRING_REF1_OP
:
2530 Value
->Type
= EFI_IFR_TYPE_STRING
;
2531 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2537 case EFI_IFR_TRUE_OP
:
2538 case EFI_IFR_FALSE_OP
:
2539 case EFI_IFR_ONE_OP
:
2540 case EFI_IFR_ONES_OP
:
2541 case EFI_IFR_UINT8_OP
:
2542 case EFI_IFR_UINT16_OP
:
2543 case EFI_IFR_UINT32_OP
:
2544 case EFI_IFR_UINT64_OP
:
2545 case EFI_IFR_UNDEFINED_OP
:
2546 case EFI_IFR_VERSION_OP
:
2547 case EFI_IFR_ZERO_OP
:
2548 Value
= &OpCode
->Value
;
2554 case EFI_IFR_LENGTH_OP
:
2555 Status
= PopExpression (Value
);
2556 if (EFI_ERROR (Status
)) {
2559 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& Value
->Type
!= EFI_IFR_TYPE_BUFFER
) {
2560 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2564 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2565 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2566 if (StrPtr
== NULL
) {
2567 Status
= EFI_INVALID_PARAMETER
;
2571 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2572 Value
->Value
.u64
= StrLen (StrPtr
);
2575 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2576 Value
->Value
.u64
= Value
->BufferLen
;
2577 FreePool (Value
->Buffer
);
2581 case EFI_IFR_NOT_OP
:
2582 Status
= PopExpression (Value
);
2583 if (EFI_ERROR (Status
)) {
2586 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2587 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2590 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2593 case EFI_IFR_QUESTION_REF2_OP
:
2595 // Pop an expression from the expression stack
2597 Status
= PopExpression (Value
);
2598 if (EFI_ERROR (Status
)) {
2603 // Validate the expression value
2605 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2606 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2610 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2611 if (Question
== NULL
) {
2612 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2616 Value
= &Question
->HiiValue
;
2619 case EFI_IFR_STRING_REF2_OP
:
2621 // Pop an expression from the expression stack
2623 Status
= PopExpression (Value
);
2624 if (EFI_ERROR (Status
)) {
2629 // Validate the expression value
2631 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2632 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2636 Value
->Type
= EFI_IFR_TYPE_STRING
;
2637 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2638 if (StrPtr
== NULL
) {
2640 // If String not exit, push an empty string
2642 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2644 Index
= (UINT16
) Value
->Value
.u64
;
2645 Value
->Value
.string
= Index
;
2650 case EFI_IFR_TO_BOOLEAN_OP
:
2652 // Pop an expression from the expression stack
2654 Status
= PopExpression (Value
);
2655 if (EFI_ERROR (Status
)) {
2660 // Convert an expression to a Boolean
2662 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
2664 // When converting from an unsigned integer, zero will be converted to
2665 // FALSE and any other value will be converted to TRUE.
2667 Value
->Value
.b
= (BOOLEAN
) (Value
->Value
.u64
!= 0);
2669 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2670 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2672 // When converting from a string, if case-insensitive compare
2673 // with "true" is True, then push True. If a case-insensitive compare
2674 // with "false" is True, then push False. Otherwise, push Undefined.
2676 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2677 if (StrPtr
== NULL
) {
2678 Status
= EFI_INVALID_PARAMETER
;
2682 IfrStrToUpper (StrPtr
);
2683 if (StrCmp (StrPtr
, L
"TRUE") == 0){
2684 Value
->Value
.b
= TRUE
;
2685 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2686 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
2687 Value
->Value
.b
= FALSE
;
2688 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2690 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2693 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
2695 // When converting from a buffer, if the buffer is all zeroes,
2696 // then push False. Otherwise push True.
2698 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
2699 if (Value
->Buffer
[Index
] != 0) {
2704 if (Index
>= Value
->BufferLen
) {
2705 Value
->Value
.b
= FALSE
;
2707 Value
->Value
.b
= TRUE
;
2709 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2710 FreePool (Value
->Buffer
);
2714 case EFI_IFR_TO_STRING_OP
:
2715 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
2718 case EFI_IFR_TO_UINT_OP
:
2719 Status
= IfrToUint (FormSet
, Value
);
2722 case EFI_IFR_TO_LOWER_OP
:
2723 case EFI_IFR_TO_UPPER_OP
:
2724 Status
= InitializeUnicodeCollationProtocol ();
2725 if (EFI_ERROR (Status
)) {
2729 Status
= PopExpression (Value
);
2730 if (EFI_ERROR (Status
)) {
2734 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
2735 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2739 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2740 if (StrPtr
== NULL
) {
2741 Status
= EFI_NOT_FOUND
;
2745 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
2746 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
2748 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
2750 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
2754 case EFI_IFR_BITWISE_NOT_OP
:
2756 // Pop an expression from the expression stack
2758 Status
= PopExpression (Value
);
2759 if (EFI_ERROR (Status
)) {
2762 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
2763 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2767 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2768 Value
->Value
.u64
= ~Value
->Value
.u64
;
2771 case EFI_IFR_SET_OP
:
2773 // Pop an expression from the expression stack
2775 Status
= PopExpression (Value
);
2776 if (EFI_ERROR (Status
)) {
2779 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
2780 Data1
.Value
.b
= FALSE
;
2782 // Set value to var storage buffer
2784 if (OpCode
->VarStorage
!= NULL
) {
2785 switch (OpCode
->VarStorage
->Type
) {
2786 case EFI_HII_VARSTORE_BUFFER
:
2787 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2788 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
2789 Data1
.Value
.b
= TRUE
;
2791 case EFI_HII_VARSTORE_NAME_VALUE
:
2792 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2793 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
2794 ASSERT (Value
!= NULL
);
2796 // Convert Buffer to Hex String
2798 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
2800 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
2801 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
2803 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, GetSetValueWithEditBuffer
);
2804 FreePool (NameValue
);
2805 if (!EFI_ERROR (Status
)) {
2806 Data1
.Value
.b
= TRUE
;
2810 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2811 Status
= gRT
->SetVariable (
2813 &OpCode
->VarStorage
->Guid
,
2814 OpCode
->VarStorage
->Attributes
,
2818 if (!EFI_ERROR (Status
)) {
2819 Data1
.Value
.b
= TRUE
;
2824 // Not recognize storage.
2826 Status
= EFI_UNSUPPORTED
;
2832 // For Time/Date Data
2834 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2836 // Only support Data/Time data when storage doesn't exist.
2838 Status
= EFI_UNSUPPORTED
;
2841 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2842 if (!EFI_ERROR (Status
)) {
2843 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2844 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2846 EfiTime
.Year
= Value
->Value
.u16
;
2849 EfiTime
.Month
= Value
->Value
.u8
;
2852 EfiTime
.Day
= Value
->Value
.u8
;
2856 // Invalid Date field.
2858 Status
= EFI_INVALID_PARAMETER
;
2862 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2864 EfiTime
.Hour
= Value
->Value
.u8
;
2867 EfiTime
.Minute
= Value
->Value
.u8
;
2870 EfiTime
.Second
= Value
->Value
.u8
;
2874 // Invalid Time field.
2876 Status
= EFI_INVALID_PARAMETER
;
2880 Status
= gRT
->SetTime (&EfiTime
);
2881 if (!EFI_ERROR (Status
)) {
2882 Data1
.Value
.b
= TRUE
;
2892 case EFI_IFR_ADD_OP
:
2893 case EFI_IFR_SUBTRACT_OP
:
2894 case EFI_IFR_MULTIPLY_OP
:
2895 case EFI_IFR_DIVIDE_OP
:
2896 case EFI_IFR_MODULO_OP
:
2897 case EFI_IFR_BITWISE_AND_OP
:
2898 case EFI_IFR_BITWISE_OR_OP
:
2899 case EFI_IFR_SHIFT_LEFT_OP
:
2900 case EFI_IFR_SHIFT_RIGHT_OP
:
2902 // Pop an expression from the expression stack
2904 Status
= PopExpression (&Data2
);
2905 if (EFI_ERROR (Status
)) {
2910 // Pop another expression from the expression stack
2912 Status
= PopExpression (&Data1
);
2913 if (EFI_ERROR (Status
)) {
2917 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
2918 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2923 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
2924 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2928 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2930 switch (OpCode
->Operand
) {
2931 case EFI_IFR_ADD_OP
:
2932 Value
->Value
.u64
= Data1
.Value
.u64
+ Data2
.Value
.u64
;
2935 case EFI_IFR_SUBTRACT_OP
:
2936 Value
->Value
.u64
= Data1
.Value
.u64
- Data2
.Value
.u64
;
2939 case EFI_IFR_MULTIPLY_OP
:
2940 Value
->Value
.u64
= MultU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2943 case EFI_IFR_DIVIDE_OP
:
2944 Value
->Value
.u64
= DivU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2947 case EFI_IFR_MODULO_OP
:
2948 DivU64x32Remainder (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
, &TempValue
);
2949 Value
->Value
.u64
= TempValue
;
2952 case EFI_IFR_BITWISE_AND_OP
:
2953 Value
->Value
.u64
= Data1
.Value
.u64
& Data2
.Value
.u64
;
2956 case EFI_IFR_BITWISE_OR_OP
:
2957 Value
->Value
.u64
= Data1
.Value
.u64
| Data2
.Value
.u64
;
2960 case EFI_IFR_SHIFT_LEFT_OP
:
2961 Value
->Value
.u64
= LShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2964 case EFI_IFR_SHIFT_RIGHT_OP
:
2965 Value
->Value
.u64
= RShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2973 case EFI_IFR_AND_OP
:
2976 // Two Boolean operator
2978 Status
= PopExpression (&Data2
);
2979 if (EFI_ERROR (Status
)) {
2984 // Pop another expression from the expression stack
2986 Status
= PopExpression (&Data1
);
2987 if (EFI_ERROR (Status
)) {
2991 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2992 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2996 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2997 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3001 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
3002 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
3004 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
3008 case EFI_IFR_EQUAL_OP
:
3009 case EFI_IFR_NOT_EQUAL_OP
:
3010 case EFI_IFR_GREATER_EQUAL_OP
:
3011 case EFI_IFR_GREATER_THAN_OP
:
3012 case EFI_IFR_LESS_EQUAL_OP
:
3013 case EFI_IFR_LESS_THAN_OP
:
3015 // Compare two integer, string, boolean or date/time
3017 Status
= PopExpression (&Data2
);
3018 if (EFI_ERROR (Status
)) {
3023 // Pop another expression from the expression stack
3025 Status
= PopExpression (&Data1
);
3026 if (EFI_ERROR (Status
)) {
3030 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3031 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
3032 Data2
.Type
!= EFI_IFR_TYPE_BUFFER
) {
3033 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3037 if (Data1
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3038 Data1
.Type
!= EFI_IFR_TYPE_STRING
&&
3039 Data1
.Type
!= EFI_IFR_TYPE_BUFFER
) {
3040 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3044 Status
= CompareHiiValue (&Data1
, &Data2
, &Result
, FormSet
->HiiHandle
);
3045 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
3046 FreePool (Data1
.Buffer
);
3047 FreePool (Data2
.Buffer
);
3050 if (Status
== EFI_UNSUPPORTED
) {
3051 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3052 Status
= EFI_SUCCESS
;
3056 if (EFI_ERROR (Status
)) {
3060 switch (OpCode
->Operand
) {
3061 case EFI_IFR_EQUAL_OP
:
3062 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
3065 case EFI_IFR_NOT_EQUAL_OP
:
3066 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
3069 case EFI_IFR_GREATER_EQUAL_OP
:
3070 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
3073 case EFI_IFR_GREATER_THAN_OP
:
3074 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
3077 case EFI_IFR_LESS_EQUAL_OP
:
3078 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
3081 case EFI_IFR_LESS_THAN_OP
:
3082 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
3090 case EFI_IFR_MATCH_OP
:
3091 Status
= InitializeUnicodeCollationProtocol ();
3092 if (EFI_ERROR (Status
)) {
3096 Status
= IfrMatch (FormSet
, Value
);
3099 case EFI_IFR_CATENATE_OP
:
3100 Status
= IfrCatenate (FormSet
, Value
);
3106 case EFI_IFR_CONDITIONAL_OP
:
3108 // Pop third expression from the expression stack
3110 Status
= PopExpression (&Data3
);
3111 if (EFI_ERROR (Status
)) {
3116 // Pop second expression from the expression stack
3118 Status
= PopExpression (&Data2
);
3119 if (EFI_ERROR (Status
)) {
3124 // Pop first expression from the expression stack
3126 Status
= PopExpression (&Data1
);
3127 if (EFI_ERROR (Status
)) {
3130 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3131 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3135 if (Data1
.Value
.b
) {
3142 case EFI_IFR_FIND_OP
:
3143 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3146 case EFI_IFR_MID_OP
:
3147 Status
= IfrMid (FormSet
, Value
);
3150 case EFI_IFR_TOKEN_OP
:
3151 Status
= IfrToken (FormSet
, Value
);
3154 case EFI_IFR_SPAN_OP
:
3155 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3158 case EFI_IFR_MAP_OP
:
3160 // Pop the check value
3162 Status
= PopExpression (&Data1
);
3163 if (EFI_ERROR (Status
)) {
3167 // Check MapExpression list is valid.
3169 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3170 Status
= EFI_INVALID_PARAMETER
;
3174 // Go through map expression list.
3176 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3177 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3178 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3180 // Evaluate the first expression in this pair.
3182 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3183 if (EFI_ERROR (Status
)) {
3187 // Compare the expression value with current value
3189 if ((CompareHiiValue (&Data1
, &SubExpression
->Result
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
3191 // Try get the map value.
3193 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3194 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3195 Status
= EFI_INVALID_PARAMETER
;
3198 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3199 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3200 if (EFI_ERROR (Status
)) {
3203 Value
= &SubExpression
->Result
;
3207 // Skip the second expression on this pair.
3209 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3210 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3211 Status
= EFI_INVALID_PARAMETER
;
3215 // Goto the first expression on next pair.
3217 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3221 // No map value is found.
3223 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3224 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3225 Value
->Value
.u8
= 0;
3232 if (EFI_ERROR (Status
) || Value
->Type
== EFI_IFR_TYPE_UNDEFINED
) {
3236 Status
= PushExpression (Value
);
3237 if (EFI_ERROR (Status
)) {
3243 // Pop the final result from expression stack
3246 Status
= PopExpression (Value
);
3247 if (EFI_ERROR (Status
)) {
3252 // After evaluating an expression, there should be only one value left on the expression stack
3254 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3255 Status
= EFI_INVALID_PARAMETER
;
3259 RestoreExpressionEvaluationStackOffset (StackOffset
);
3260 if (!EFI_ERROR (Status
)) {
3261 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3268 Return the result of the expression list. Check the expression list and
3269 return the highest priority express result.
3270 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3272 @param ExpList The input expression list.
3273 @param Evaluate Whether need to evaluate the expression first.
3274 @param FormSet FormSet associated with this expression.
3275 @param Form Form associated with this expression.
3277 @retval EXPRESS_RESULT Return the higher priority express result.
3278 DisableIf > SuppressIf > GrayOutIf > FALSE
3282 EvaluateExpressionList (
3283 IN FORM_EXPRESSION_LIST
*ExpList
,
3284 IN BOOLEAN Evaluate
,
3285 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3286 IN FORM_BROWSER_FORM
*Form OPTIONAL
3290 EXPRESS_RESULT ReturnVal
;
3291 EXPRESS_RESULT CompareOne
;
3294 if (ExpList
== NULL
) {
3295 return ExpressFalse
;
3298 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3302 // Check whether need to evaluate the expression first.
3305 while (ExpList
->Count
> Index
) {
3306 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3307 if (EFI_ERROR (Status
)) {
3308 return ExpressFalse
;
3314 // Run the list of expressions.
3316 ReturnVal
= ExpressFalse
;
3317 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3318 if (ExpList
->Expression
[Index
]->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
&&
3319 ExpList
->Expression
[Index
]->Result
.Value
.b
) {
3320 switch (ExpList
->Expression
[Index
]->Type
) {
3321 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3322 CompareOne
= ExpressSuppress
;
3325 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3326 CompareOne
= ExpressGrayOut
;
3329 case EFI_HII_EXPRESSION_DISABLE_IF
:
3330 CompareOne
= ExpressDisable
;
3334 return ExpressFalse
;
3337 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;