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
;
1803 Get UINT64 type value.
1805 @param Value Input Hii value.
1807 @retval UINT64 Return the UINT64 type value.
1812 IN EFI_HII_VALUE
*Value
1819 switch (Value
->Type
) {
1820 case EFI_IFR_TYPE_NUM_SIZE_8
:
1821 RetVal
= Value
->Value
.u8
;
1824 case EFI_IFR_TYPE_NUM_SIZE_16
:
1825 RetVal
= Value
->Value
.u16
;
1828 case EFI_IFR_TYPE_NUM_SIZE_32
:
1829 RetVal
= Value
->Value
.u32
;
1832 case EFI_IFR_TYPE_BOOLEAN
:
1833 RetVal
= Value
->Value
.b
;
1836 case EFI_IFR_TYPE_DATE
:
1837 RetVal
= *(UINT64
*) &Value
->Value
.date
;
1840 case EFI_IFR_TYPE_TIME
:
1841 RetVal
= (*(UINT64
*) &Value
->Value
.time
) & 0xffffff;
1845 RetVal
= Value
->Value
.u64
;
1853 Compare two Hii value.
1855 @param Value1 Expression value to compare on left-hand.
1856 @param Value2 Expression value to compare on right-hand.
1857 @param Result Return value after compare.
1858 retval 0 Two operators equal.
1859 return Positive value if Value1 is greater than Value2.
1860 retval Negative value if Value1 is less than Value2.
1861 @param HiiHandle Only required for string compare.
1863 @retval other Could not perform compare on two values.
1864 @retval EFI_SUCCESS Compare the value success.
1869 IN EFI_HII_VALUE
*Value1
,
1870 IN EFI_HII_VALUE
*Value2
,
1872 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1880 if (Value1
->Type
>= EFI_IFR_TYPE_OTHER
|| Value2
->Type
>= EFI_IFR_TYPE_OTHER
) {
1881 if (Value1
->Type
!= EFI_IFR_TYPE_BUFFER
&& Value2
->Type
!= EFI_IFR_TYPE_BUFFER
) {
1882 return EFI_UNSUPPORTED
;
1886 if (Value1
->Type
== EFI_IFR_TYPE_STRING
|| Value2
->Type
== EFI_IFR_TYPE_STRING
) {
1887 if (Value1
->Type
!= Value2
->Type
) {
1889 // Both Operator should be type of String
1891 return EFI_UNSUPPORTED
;
1894 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
1896 // StringId 0 is reserved
1898 return EFI_INVALID_PARAMETER
;
1901 if (Value1
->Value
.string
== Value2
->Value
.string
) {
1906 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
1911 return EFI_NOT_FOUND
;
1914 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
1917 return EFI_NOT_FOUND
;
1920 *Result
= StrCmp (Str1
, Str2
);
1928 if (Value1
->Type
== EFI_IFR_TYPE_BUFFER
|| Value2
->Type
== EFI_IFR_TYPE_BUFFER
) {
1929 if (Value1
->Type
!= Value2
->Type
) {
1931 // Both Operator should be type of Buffer.
1933 return EFI_UNSUPPORTED
;
1935 Len
= Value1
->BufferLen
> Value2
->BufferLen
? Value2
->BufferLen
: Value1
->BufferLen
;
1936 *Result
= CompareMem (Value1
->Buffer
, Value2
->Buffer
, Len
);
1937 if ((*Result
== 0) && (Value1
->BufferLen
!= Value2
->BufferLen
))
1940 // In this case, means base on samll number buffer, the data is same
1941 // So which value has more data, which value is bigger.
1943 *Result
= Value1
->BufferLen
> Value2
->BufferLen
? 1 : -1;
1949 // Take remain types(integer, boolean, date/time) as integer
1951 Temp64
= HiiValueToUINT64(Value1
) - HiiValueToUINT64(Value2
);
1954 } else if (Temp64
< 0) {
1964 Check if current user has the privilege specified by the permissions GUID.
1966 @param[in] Guid A GUID specifying setup access permissions.
1968 @retval TRUE Current user has the privilege.
1969 @retval FALSE Current user does not have the privilege.
1972 CheckUserPrivilege (
1977 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
1978 EFI_USER_INFO_HANDLE UserInfoHandle
;
1979 EFI_USER_INFO
*UserInfo
;
1980 EFI_GUID
*UserPermissionsGuid
;
1982 UINTN AccessControlDataSize
;
1983 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
1986 if (mUserManager
== NULL
) {
1987 Status
= gBS
->LocateProtocol (
1988 &gEfiUserManagerProtocolGuid
,
1990 (VOID
**) &mUserManager
1992 if (EFI_ERROR (Status
)) {
1994 /// If the system does not support user management, then it is assumed that
1995 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
1996 /// op-code is always TRUE.
2002 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
2003 ASSERT_EFI_ERROR (Status
);
2006 /// Enumerate all user information of the current user profile
2007 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
2010 for (UserInfoHandle
= NULL
;;) {
2011 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
2012 if (EFI_ERROR (Status
)) {
2017 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
2018 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2022 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
2023 if (UserInfo
== NULL
) {
2027 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
2028 if (EFI_ERROR (Status
) ||
2029 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
2030 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
2031 FreePool (UserInfo
);
2035 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
2036 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
2037 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2038 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2041 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
2043 /// Check if current user has the privilege specified by the permissions GUID.
2046 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
2047 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
2048 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
2049 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
2050 FreePool (UserInfo
);
2053 UserPermissionsGuid
++;
2054 AccessControlDataSize
-= sizeof (EFI_GUID
);
2057 RemainSize
-= AccessControl
->Size
;
2058 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
2061 FreePool (UserInfo
);
2067 Get question value from the predefined formset.
2069 @param DevicePath The driver's device path which produece the formset data.
2070 @param InputHiiHandle The hii handle associate with the formset data.
2071 @param FormSetGuid The formset guid which include the question.
2072 @param QuestionId The question id which need to get value from.
2073 @param Value The return data about question's value.
2075 @retval TRUE Get the question value success.
2076 @retval FALSE Get the question value failed.
2079 GetQuestionValueFromForm (
2080 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2081 IN EFI_HII_HANDLE InputHiiHandle
,
2082 IN EFI_GUID
*FormSetGuid
,
2083 IN EFI_QUESTION_ID QuestionId
,
2084 OUT EFI_HII_VALUE
*Value
2088 EFI_HII_HANDLE HiiHandle
;
2089 FORM_BROWSER_STATEMENT
*Question
;
2090 FORM_BROWSER_FORMSET
*FormSet
;
2091 FORM_BROWSER_FORM
*Form
;
2096 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2098 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
2099 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
2109 if (DevicePath
!= NULL
) {
2110 HiiHandle
= DevicePathToHiiHandle (DevicePath
, FormSetGuid
);
2111 if (HiiHandle
== NULL
) {
2115 HiiHandle
= InputHiiHandle
;
2117 ASSERT (HiiHandle
!= NULL
);
2120 // Get the formset data include this question.
2122 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2123 ASSERT (FormSet
!= NULL
);
2124 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
);
2125 if (EFI_ERROR (Status
)) {
2131 // Base on the Question Id to get the question info.
2133 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2134 if (Question
== NULL
) {
2140 // Search form in the formset scope
2142 Link
= GetFirstNode (&FormSet
->FormListHead
);
2143 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2144 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2146 Question
= IdToQuestion2 (Form
, QuestionId
);
2147 if (Question
!= NULL
) {
2151 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2154 ASSERT (Form
!= NULL
);
2157 // Get the question value.
2159 Status
= GetQuestionValue(FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
2160 if (EFI_ERROR (Status
)) {
2165 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2169 // Clean the formset structure and restore the global parameter.
2171 if (FormSet
!= NULL
) {
2172 DestroyFormSet (FormSet
);
2179 Evaluate the result of a HII expression.
2181 If Expression is NULL, then ASSERT.
2183 @param FormSet FormSet associated with this expression.
2184 @param Form Form associated with this expression.
2185 @param Expression Expression to be evaluated.
2187 @retval EFI_SUCCESS The expression evaluated successfuly
2188 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2190 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2192 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2193 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2197 EvaluateExpression (
2198 IN FORM_BROWSER_FORMSET
*FormSet
,
2199 IN FORM_BROWSER_FORM
*Form
,
2200 IN OUT FORM_EXPRESSION
*Expression
2205 EXPRESSION_OPCODE
*OpCode
;
2206 FORM_BROWSER_STATEMENT
*Question
;
2207 FORM_BROWSER_STATEMENT
*Question2
;
2209 EFI_HII_VALUE Data1
;
2210 EFI_HII_VALUE Data2
;
2211 EFI_HII_VALUE Data3
;
2212 FORM_EXPRESSION
*RuleExpression
;
2213 EFI_HII_VALUE
*Value
;
2218 LIST_ENTRY
*SubExpressionLink
;
2219 FORM_EXPRESSION
*SubExpression
;
2226 EFI_HII_VALUE QuestionVal
;
2227 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2230 // Save current stack offset.
2232 StackOffset
= SaveExpressionEvaluationStackOffset ();
2234 ASSERT (Expression
!= NULL
);
2235 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2237 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2238 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2239 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2241 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2243 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2244 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2245 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2248 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2249 Status
= EFI_SUCCESS
;
2251 switch (OpCode
->Operand
) {
2253 // Built-in functions
2255 case EFI_IFR_EQ_ID_VAL_OP
:
2256 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2257 if (Question
== NULL
) {
2258 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2262 Status
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, &Result
, NULL
);
2263 if (Status
== EFI_UNSUPPORTED
) {
2264 Status
= EFI_SUCCESS
;
2265 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2269 if (EFI_ERROR (Status
)) {
2272 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2275 case EFI_IFR_EQ_ID_ID_OP
:
2276 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2277 if (Question
== NULL
) {
2278 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2282 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2283 if (Question2
== NULL
) {
2284 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2288 Status
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, &Result
, FormSet
->HiiHandle
);
2289 if (Status
== EFI_UNSUPPORTED
) {
2290 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2291 Status
= EFI_SUCCESS
;
2294 if (EFI_ERROR (Status
)) {
2297 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2300 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2301 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2302 if (Question
== NULL
) {
2303 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2307 Value
->Value
.b
= FALSE
;
2308 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2309 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2310 Value
->Value
.b
= TRUE
;
2316 case EFI_IFR_DUP_OP
:
2317 Status
= PopExpression (Value
);
2318 if (EFI_ERROR (Status
)) {
2322 Status
= PushExpression (Value
);
2325 case EFI_IFR_QUESTION_REF1_OP
:
2326 case EFI_IFR_THIS_OP
:
2327 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2328 if (Question
== NULL
) {
2329 Status
= EFI_NOT_FOUND
;
2333 Value
= &Question
->HiiValue
;
2336 case EFI_IFR_SECURITY_OP
:
2337 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2340 case EFI_IFR_GET_OP
:
2342 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2344 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2345 Value
->Value
.u8
= 0;
2346 if (OpCode
->VarStorage
!= NULL
) {
2347 switch (OpCode
->VarStorage
->Type
) {
2348 case EFI_HII_VARSTORE_BUFFER
:
2349 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2351 // Get value from Edit Buffer
2353 Value
->Type
= OpCode
->ValueType
;
2354 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2356 case EFI_HII_VARSTORE_NAME_VALUE
:
2357 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2359 // Get value from string except for STRING value.
2361 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
, GetSetValueWithEditBuffer
);
2362 if (!EFI_ERROR (Status
)) {
2363 ASSERT (StrPtr
!= NULL
);
2364 TempLength
= StrLen (StrPtr
);
2365 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2366 Value
->Type
= OpCode
->ValueType
;
2367 TempBuffer
= (UINT8
*) &Value
->Value
;
2368 ZeroMem (TempStr
, sizeof (TempStr
));
2369 for (Index
= 0; Index
< TempLength
; Index
++) {
2370 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2371 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2372 if ((Index
& 1) == 0) {
2373 TempBuffer
[Index
/2] = DigitUint8
;
2375 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2382 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2384 // Get value from variable.
2386 TempLength
= OpCode
->ValueWidth
;
2387 Value
->Type
= OpCode
->ValueType
;
2388 Status
= gRT
->GetVariable (
2390 &OpCode
->VarStorage
->Guid
,
2395 if (EFI_ERROR (Status
)) {
2396 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2397 Value
->Value
.u8
= 0;
2402 // Not recognize storage.
2404 Status
= EFI_UNSUPPORTED
;
2409 // For Time/Date Data
2411 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2413 // Only support Data/Time data when storage doesn't exist.
2415 Status
= EFI_UNSUPPORTED
;
2418 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2419 if (!EFI_ERROR (Status
)) {
2420 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2421 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2423 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2424 Value
->Value
.u16
= EfiTime
.Year
;
2427 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2428 Value
->Value
.u8
= EfiTime
.Month
;
2431 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2432 Value
->Value
.u8
= EfiTime
.Day
;
2436 // Invalid Date field.
2438 Status
= EFI_INVALID_PARAMETER
;
2442 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2444 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2445 Value
->Value
.u8
= EfiTime
.Hour
;
2448 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2449 Value
->Value
.u8
= EfiTime
.Minute
;
2452 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2453 Value
->Value
.u8
= EfiTime
.Second
;
2457 // Invalid Time field.
2459 Status
= EFI_INVALID_PARAMETER
;
2468 case EFI_IFR_QUESTION_REF3_OP
:
2470 // EFI_IFR_QUESTION_REF3
2471 // Pop an expression from the expression stack
2473 Status
= PopExpression (Value
);
2474 if (EFI_ERROR (Status
)) {
2479 // Validate the expression value
2481 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2482 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2486 if (OpCode
->DevicePath
!= 0) {
2487 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2489 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2490 if (StrPtr
!= NULL
&& mPathFromText
!= NULL
) {
2491 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StrPtr
);
2492 if (DevicePath
!= NULL
&& GetQuestionValueFromForm(DevicePath
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)) {
2493 Value
= &QuestionVal
;
2495 if (DevicePath
!= NULL
) {
2496 FreePool (DevicePath
);
2500 if (StrPtr
!= NULL
) {
2503 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2504 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2505 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2508 Value
= &QuestionVal
;
2510 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2511 if (Question
== NULL
) {
2512 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2517 // push the questions' value on to the expression stack
2519 Value
= &Question
->HiiValue
;
2523 case EFI_IFR_RULE_REF_OP
:
2525 // Find expression for this rule
2527 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2528 if (RuleExpression
== NULL
) {
2529 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2534 // Evaluate this rule expression
2536 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2537 if (EFI_ERROR (Status
) || RuleExpression
->Result
.Type
== EFI_IFR_TYPE_UNDEFINED
) {
2538 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2542 Value
= &RuleExpression
->Result
;
2545 case EFI_IFR_STRING_REF1_OP
:
2546 Value
->Type
= EFI_IFR_TYPE_STRING
;
2547 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2553 case EFI_IFR_TRUE_OP
:
2554 case EFI_IFR_FALSE_OP
:
2555 case EFI_IFR_ONE_OP
:
2556 case EFI_IFR_ONES_OP
:
2557 case EFI_IFR_UINT8_OP
:
2558 case EFI_IFR_UINT16_OP
:
2559 case EFI_IFR_UINT32_OP
:
2560 case EFI_IFR_UINT64_OP
:
2561 case EFI_IFR_UNDEFINED_OP
:
2562 case EFI_IFR_VERSION_OP
:
2563 case EFI_IFR_ZERO_OP
:
2564 Value
= &OpCode
->Value
;
2570 case EFI_IFR_LENGTH_OP
:
2571 Status
= PopExpression (Value
);
2572 if (EFI_ERROR (Status
)) {
2575 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& Value
->Type
!= EFI_IFR_TYPE_BUFFER
) {
2576 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2580 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2581 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2582 if (StrPtr
== NULL
) {
2583 Status
= EFI_INVALID_PARAMETER
;
2587 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2588 Value
->Value
.u64
= StrLen (StrPtr
);
2591 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2592 Value
->Value
.u64
= Value
->BufferLen
;
2593 FreePool (Value
->Buffer
);
2597 case EFI_IFR_NOT_OP
:
2598 Status
= PopExpression (Value
);
2599 if (EFI_ERROR (Status
)) {
2602 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2603 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2606 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2609 case EFI_IFR_QUESTION_REF2_OP
:
2611 // Pop an expression from the expression stack
2613 Status
= PopExpression (Value
);
2614 if (EFI_ERROR (Status
)) {
2619 // Validate the expression value
2621 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2622 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2626 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2627 if (Question
== NULL
) {
2628 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2632 Value
= &Question
->HiiValue
;
2635 case EFI_IFR_STRING_REF2_OP
:
2637 // Pop an expression from the expression stack
2639 Status
= PopExpression (Value
);
2640 if (EFI_ERROR (Status
)) {
2645 // Validate the expression value
2647 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2648 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2652 Value
->Type
= EFI_IFR_TYPE_STRING
;
2653 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2654 if (StrPtr
== NULL
) {
2656 // If String not exit, push an empty string
2658 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2660 Index
= (UINT16
) Value
->Value
.u64
;
2661 Value
->Value
.string
= Index
;
2666 case EFI_IFR_TO_BOOLEAN_OP
:
2668 // Pop an expression from the expression stack
2670 Status
= PopExpression (Value
);
2671 if (EFI_ERROR (Status
)) {
2676 // Convert an expression to a Boolean
2678 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
2680 // When converting from an unsigned integer, zero will be converted to
2681 // FALSE and any other value will be converted to TRUE.
2683 Value
->Value
.b
= (BOOLEAN
) (Value
->Value
.u64
!= 0);
2685 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2686 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2688 // When converting from a string, if case-insensitive compare
2689 // with "true" is True, then push True. If a case-insensitive compare
2690 // with "false" is True, then push False. Otherwise, push Undefined.
2692 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2693 if (StrPtr
== NULL
) {
2694 Status
= EFI_INVALID_PARAMETER
;
2698 IfrStrToUpper (StrPtr
);
2699 if (StrCmp (StrPtr
, L
"TRUE") == 0){
2700 Value
->Value
.b
= TRUE
;
2701 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2702 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
2703 Value
->Value
.b
= FALSE
;
2704 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2706 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2709 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
2711 // When converting from a buffer, if the buffer is all zeroes,
2712 // then push False. Otherwise push True.
2714 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
2715 if (Value
->Buffer
[Index
] != 0) {
2720 if (Index
>= Value
->BufferLen
) {
2721 Value
->Value
.b
= FALSE
;
2723 Value
->Value
.b
= TRUE
;
2725 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2726 FreePool (Value
->Buffer
);
2730 case EFI_IFR_TO_STRING_OP
:
2731 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
2734 case EFI_IFR_TO_UINT_OP
:
2735 Status
= IfrToUint (FormSet
, Value
);
2738 case EFI_IFR_TO_LOWER_OP
:
2739 case EFI_IFR_TO_UPPER_OP
:
2740 Status
= InitializeUnicodeCollationProtocol ();
2741 if (EFI_ERROR (Status
)) {
2745 Status
= PopExpression (Value
);
2746 if (EFI_ERROR (Status
)) {
2750 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
2751 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2755 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2756 if (StrPtr
== NULL
) {
2757 Status
= EFI_NOT_FOUND
;
2761 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
2762 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
2764 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
2766 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
2770 case EFI_IFR_BITWISE_NOT_OP
:
2772 // Pop an expression from the expression stack
2774 Status
= PopExpression (Value
);
2775 if (EFI_ERROR (Status
)) {
2778 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
2779 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2783 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2784 Value
->Value
.u64
= ~Value
->Value
.u64
;
2787 case EFI_IFR_SET_OP
:
2789 // Pop an expression from the expression stack
2791 Status
= PopExpression (Value
);
2792 if (EFI_ERROR (Status
)) {
2795 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
2796 Data1
.Value
.b
= FALSE
;
2798 // Set value to var storage buffer
2800 if (OpCode
->VarStorage
!= NULL
) {
2801 switch (OpCode
->VarStorage
->Type
) {
2802 case EFI_HII_VARSTORE_BUFFER
:
2803 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2804 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
2805 Data1
.Value
.b
= TRUE
;
2807 case EFI_HII_VARSTORE_NAME_VALUE
:
2808 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2809 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
2810 ASSERT (Value
!= NULL
);
2812 // Convert Buffer to Hex String
2814 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
2816 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
2817 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
2819 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, GetSetValueWithEditBuffer
, NULL
);
2820 FreePool (NameValue
);
2821 if (!EFI_ERROR (Status
)) {
2822 Data1
.Value
.b
= TRUE
;
2826 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2827 Status
= gRT
->SetVariable (
2829 &OpCode
->VarStorage
->Guid
,
2830 OpCode
->VarStorage
->Attributes
,
2834 if (!EFI_ERROR (Status
)) {
2835 Data1
.Value
.b
= TRUE
;
2840 // Not recognize storage.
2842 Status
= EFI_UNSUPPORTED
;
2848 // For Time/Date Data
2850 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2852 // Only support Data/Time data when storage doesn't exist.
2854 Status
= EFI_UNSUPPORTED
;
2857 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2858 if (!EFI_ERROR (Status
)) {
2859 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2860 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2862 EfiTime
.Year
= Value
->Value
.u16
;
2865 EfiTime
.Month
= Value
->Value
.u8
;
2868 EfiTime
.Day
= Value
->Value
.u8
;
2872 // Invalid Date field.
2874 Status
= EFI_INVALID_PARAMETER
;
2878 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2880 EfiTime
.Hour
= Value
->Value
.u8
;
2883 EfiTime
.Minute
= Value
->Value
.u8
;
2886 EfiTime
.Second
= Value
->Value
.u8
;
2890 // Invalid Time field.
2892 Status
= EFI_INVALID_PARAMETER
;
2896 Status
= gRT
->SetTime (&EfiTime
);
2897 if (!EFI_ERROR (Status
)) {
2898 Data1
.Value
.b
= TRUE
;
2908 case EFI_IFR_ADD_OP
:
2909 case EFI_IFR_SUBTRACT_OP
:
2910 case EFI_IFR_MULTIPLY_OP
:
2911 case EFI_IFR_DIVIDE_OP
:
2912 case EFI_IFR_MODULO_OP
:
2913 case EFI_IFR_BITWISE_AND_OP
:
2914 case EFI_IFR_BITWISE_OR_OP
:
2915 case EFI_IFR_SHIFT_LEFT_OP
:
2916 case EFI_IFR_SHIFT_RIGHT_OP
:
2918 // Pop an expression from the expression stack
2920 Status
= PopExpression (&Data2
);
2921 if (EFI_ERROR (Status
)) {
2926 // Pop another expression from the expression stack
2928 Status
= PopExpression (&Data1
);
2929 if (EFI_ERROR (Status
)) {
2933 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
2934 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2939 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
2940 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2944 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2946 switch (OpCode
->Operand
) {
2947 case EFI_IFR_ADD_OP
:
2948 Value
->Value
.u64
= Data1
.Value
.u64
+ Data2
.Value
.u64
;
2951 case EFI_IFR_SUBTRACT_OP
:
2952 Value
->Value
.u64
= Data1
.Value
.u64
- Data2
.Value
.u64
;
2955 case EFI_IFR_MULTIPLY_OP
:
2956 Value
->Value
.u64
= MultU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2959 case EFI_IFR_DIVIDE_OP
:
2960 Value
->Value
.u64
= DivU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2963 case EFI_IFR_MODULO_OP
:
2964 DivU64x32Remainder (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
, &TempValue
);
2965 Value
->Value
.u64
= TempValue
;
2968 case EFI_IFR_BITWISE_AND_OP
:
2969 Value
->Value
.u64
= Data1
.Value
.u64
& Data2
.Value
.u64
;
2972 case EFI_IFR_BITWISE_OR_OP
:
2973 Value
->Value
.u64
= Data1
.Value
.u64
| Data2
.Value
.u64
;
2976 case EFI_IFR_SHIFT_LEFT_OP
:
2977 Value
->Value
.u64
= LShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2980 case EFI_IFR_SHIFT_RIGHT_OP
:
2981 Value
->Value
.u64
= RShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2989 case EFI_IFR_AND_OP
:
2992 // Two Boolean operator
2994 Status
= PopExpression (&Data2
);
2995 if (EFI_ERROR (Status
)) {
3000 // Pop another expression from the expression stack
3002 Status
= PopExpression (&Data1
);
3003 if (EFI_ERROR (Status
)) {
3007 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3008 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3012 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3013 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3017 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
3018 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
3020 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
3024 case EFI_IFR_EQUAL_OP
:
3025 case EFI_IFR_NOT_EQUAL_OP
:
3026 case EFI_IFR_GREATER_EQUAL_OP
:
3027 case EFI_IFR_GREATER_THAN_OP
:
3028 case EFI_IFR_LESS_EQUAL_OP
:
3029 case EFI_IFR_LESS_THAN_OP
:
3031 // Compare two integer, string, boolean or date/time
3033 Status
= PopExpression (&Data2
);
3034 if (EFI_ERROR (Status
)) {
3039 // Pop another expression from the expression stack
3041 Status
= PopExpression (&Data1
);
3042 if (EFI_ERROR (Status
)) {
3046 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3047 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
3048 Data2
.Type
!= EFI_IFR_TYPE_BUFFER
) {
3049 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3053 if (Data1
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3054 Data1
.Type
!= EFI_IFR_TYPE_STRING
&&
3055 Data1
.Type
!= EFI_IFR_TYPE_BUFFER
) {
3056 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3060 Status
= CompareHiiValue (&Data1
, &Data2
, &Result
, FormSet
->HiiHandle
);
3061 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
3062 FreePool (Data1
.Buffer
);
3063 FreePool (Data2
.Buffer
);
3066 if (Status
== EFI_UNSUPPORTED
) {
3067 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3068 Status
= EFI_SUCCESS
;
3072 if (EFI_ERROR (Status
)) {
3076 switch (OpCode
->Operand
) {
3077 case EFI_IFR_EQUAL_OP
:
3078 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
3081 case EFI_IFR_NOT_EQUAL_OP
:
3082 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
3085 case EFI_IFR_GREATER_EQUAL_OP
:
3086 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
3089 case EFI_IFR_GREATER_THAN_OP
:
3090 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
3093 case EFI_IFR_LESS_EQUAL_OP
:
3094 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
3097 case EFI_IFR_LESS_THAN_OP
:
3098 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
3106 case EFI_IFR_MATCH_OP
:
3107 Status
= InitializeUnicodeCollationProtocol ();
3108 if (EFI_ERROR (Status
)) {
3112 Status
= IfrMatch (FormSet
, Value
);
3115 case EFI_IFR_CATENATE_OP
:
3116 Status
= IfrCatenate (FormSet
, Value
);
3122 case EFI_IFR_CONDITIONAL_OP
:
3124 // Pop third expression from the expression stack
3126 Status
= PopExpression (&Data3
);
3127 if (EFI_ERROR (Status
)) {
3132 // Pop second expression from the expression stack
3134 Status
= PopExpression (&Data2
);
3135 if (EFI_ERROR (Status
)) {
3140 // Pop first expression from the expression stack
3142 Status
= PopExpression (&Data1
);
3143 if (EFI_ERROR (Status
)) {
3146 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3147 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3151 if (Data1
.Value
.b
) {
3158 case EFI_IFR_FIND_OP
:
3159 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3162 case EFI_IFR_MID_OP
:
3163 Status
= IfrMid (FormSet
, Value
);
3166 case EFI_IFR_TOKEN_OP
:
3167 Status
= IfrToken (FormSet
, Value
);
3170 case EFI_IFR_SPAN_OP
:
3171 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3174 case EFI_IFR_MAP_OP
:
3176 // Pop the check value
3178 Status
= PopExpression (&Data1
);
3179 if (EFI_ERROR (Status
)) {
3183 // Check MapExpression list is valid.
3185 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3186 Status
= EFI_INVALID_PARAMETER
;
3190 // Go through map expression list.
3192 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3193 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3194 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3196 // Evaluate the first expression in this pair.
3198 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3199 if (EFI_ERROR (Status
)) {
3203 // Compare the expression value with current value
3205 if ((CompareHiiValue (&Data1
, &SubExpression
->Result
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
3207 // Try get the map value.
3209 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3210 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3211 Status
= EFI_INVALID_PARAMETER
;
3214 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3215 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3216 if (EFI_ERROR (Status
)) {
3219 Value
= &SubExpression
->Result
;
3223 // Skip the second expression on this pair.
3225 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3226 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3227 Status
= EFI_INVALID_PARAMETER
;
3231 // Goto the first expression on next pair.
3233 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3237 // No map value is found.
3239 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3240 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3241 Value
->Value
.u8
= 0;
3248 if (EFI_ERROR (Status
) || Value
->Type
== EFI_IFR_TYPE_UNDEFINED
) {
3252 Status
= PushExpression (Value
);
3253 if (EFI_ERROR (Status
)) {
3259 // Pop the final result from expression stack
3262 Status
= PopExpression (Value
);
3263 if (EFI_ERROR (Status
)) {
3268 // After evaluating an expression, there should be only one value left on the expression stack
3270 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3271 Status
= EFI_INVALID_PARAMETER
;
3275 RestoreExpressionEvaluationStackOffset (StackOffset
);
3276 if (!EFI_ERROR (Status
)) {
3277 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3284 Return the result of the expression list. Check the expression list and
3285 return the highest priority express result.
3286 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3288 @param ExpList The input expression list.
3289 @param Evaluate Whether need to evaluate the expression first.
3290 @param FormSet FormSet associated with this expression.
3291 @param Form Form associated with this expression.
3293 @retval EXPRESS_RESULT Return the higher priority express result.
3294 DisableIf > SuppressIf > GrayOutIf > FALSE
3298 EvaluateExpressionList (
3299 IN FORM_EXPRESSION_LIST
*ExpList
,
3300 IN BOOLEAN Evaluate
,
3301 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3302 IN FORM_BROWSER_FORM
*Form OPTIONAL
3306 EXPRESS_RESULT ReturnVal
;
3307 EXPRESS_RESULT CompareOne
;
3310 if (ExpList
== NULL
) {
3311 return ExpressFalse
;
3314 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3318 // Check whether need to evaluate the expression first.
3321 while (ExpList
->Count
> Index
) {
3322 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3323 if (EFI_ERROR (Status
)) {
3324 return ExpressFalse
;
3330 // Run the list of expressions.
3332 ReturnVal
= ExpressFalse
;
3333 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3334 if (ExpList
->Expression
[Index
]->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
&&
3335 ExpList
->Expression
[Index
]->Result
.Value
.b
) {
3336 switch (ExpList
->Expression
[Index
]->Type
) {
3337 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3338 CompareOne
= ExpressSuppress
;
3341 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3342 CompareOne
= ExpressGrayOut
;
3345 case EFI_HII_EXPRESSION_DISABLE_IF
:
3346 CompareOne
= ExpressDisable
;
3350 return ExpressFalse
;
3353 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;