2 Utility functions for expression evaluation.
4 Copyright (c) 2007 - 2012, 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
, FALSE
);
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 return EFI_UNSUPPORTED
;
1046 UnicodeSPrint (Buffer
, BufferSize
, PrintFormat
, Value
.Value
.u64
);
1050 case EFI_IFR_TYPE_STRING
:
1051 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1054 case EFI_IFR_TYPE_BOOLEAN
:
1055 String
= (Value
.Value
.b
) ? L
"True" : L
"False";
1058 case EFI_IFR_TYPE_BUFFER
:
1060 // + 3 is base on the unicode format, the length may be odd number,
1061 // so need 1 byte to align, also need 2 bytes for L'\0'.
1063 TmpBuf
= AllocateZeroPool (Value
.BufferLen
+ 3);
1064 ASSERT (TmpBuf
!= NULL
);
1065 if (Format
== EFI_IFR_STRING_ASCII
) {
1066 CopyMem (TmpBuf
, Value
.Buffer
, Value
.BufferLen
);
1067 PrintFormat
= L
"%a";
1069 // Format == EFI_IFR_STRING_UNICODE
1070 CopyMem (TmpBuf
, Value
.Buffer
, Value
.BufferLen
* sizeof (CHAR16
));
1071 PrintFormat
= L
"%s";
1073 UnicodeSPrint (Buffer
, MAXIMUM_VALUE_CHARACTERS
, PrintFormat
, Value
.Buffer
);
1076 FreePool (Value
.Buffer
);
1080 return EFI_UNSUPPORTED
;
1083 Result
->Type
= EFI_IFR_TYPE_STRING
;
1084 Result
->Value
.string
= NewString (String
, FormSet
->HiiHandle
);
1090 Evaluate opcode EFI_IFR_TO_UINT.
1092 @param FormSet Formset which contains this opcode.
1093 @param Result Evaluation result for this opcode.
1095 @retval EFI_SUCCESS Opcode evaluation success.
1096 @retval Other Opcode evaluation failed.
1101 IN FORM_BROWSER_FORMSET
*FormSet
,
1102 OUT EFI_HII_VALUE
*Result
1106 EFI_HII_VALUE Value
;
1110 Status
= PopExpression (&Value
);
1111 if (EFI_ERROR (Status
)) {
1115 if (Value
.Type
>= EFI_IFR_TYPE_OTHER
&& Value
.Type
!= EFI_IFR_TYPE_BUFFER
) {
1116 return EFI_UNSUPPORTED
;
1119 Status
= EFI_SUCCESS
;
1120 if (Value
.Type
== EFI_IFR_TYPE_STRING
) {
1121 String
= GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1122 if (String
== NULL
) {
1123 return EFI_NOT_FOUND
;
1126 IfrStrToUpper (String
);
1127 StringPtr
= StrStr (String
, L
"0X");
1128 if (StringPtr
!= NULL
) {
1132 Result
->Value
.u64
= StrHexToUint64 (String
);
1137 Result
->Value
.u64
= StrDecimalToUint64 (String
);
1140 } else if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1141 if (Value
.BufferLen
> 8) {
1142 FreePool (Value
.Buffer
);
1143 return EFI_UNSUPPORTED
;
1145 Result
->Value
.u64
= *(UINT64
*) Value
.Buffer
;
1146 FreePool (Value
.Buffer
);
1148 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1151 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1157 Evaluate opcode EFI_IFR_CATENATE.
1159 @param FormSet Formset which contains this opcode.
1160 @param Result Evaluation result for this opcode.
1162 @retval EFI_SUCCESS Opcode evaluation success.
1163 @retval Other Opcode evaluation failed.
1168 IN FORM_BROWSER_FORMSET
*FormSet
,
1169 OUT EFI_HII_VALUE
*Result
1173 EFI_HII_VALUE Value
[2];
1180 // String[0] - The second string
1181 // String[1] - The first string
1186 Status
= EFI_SUCCESS
;
1187 ZeroMem (Value
, sizeof (Value
));
1189 for (Index
= 0; Index
< 2; Index
++) {
1190 Status
= PopExpression (&Value
[Index
]);
1191 if (EFI_ERROR (Status
)) {
1195 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
&& Value
[Index
].Type
!= EFI_IFR_TYPE_BUFFER
) {
1196 Status
= EFI_UNSUPPORTED
;
1200 if (Value
[Index
].Type
== EFI_IFR_TYPE_STRING
) {
1201 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1202 if (String
[Index
] == NULL
) {
1203 Status
= EFI_NOT_FOUND
;
1209 if (Value
[0].Type
== EFI_IFR_TYPE_STRING
) {
1210 Size
= StrSize (String
[0]);
1211 StringPtr
= AllocatePool (StrSize (String
[1]) + Size
);
1212 ASSERT (StringPtr
!= NULL
);
1213 StrCpy (StringPtr
, String
[1]);
1214 StrCat (StringPtr
, String
[0]);
1216 Result
->Type
= EFI_IFR_TYPE_STRING
;
1217 Result
->Value
.string
= NewString (StringPtr
, FormSet
->HiiHandle
);
1219 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1220 Result
->BufferLen
= (UINT16
) (Value
[0].BufferLen
+ Value
[1].BufferLen
);
1222 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1223 ASSERT (Result
->Buffer
!= NULL
);
1225 CopyMem (Result
->Buffer
, Value
[0].Buffer
, Value
[0].BufferLen
);
1226 CopyMem (&Result
->Buffer
[Value
[0].BufferLen
], Value
[1].Buffer
, Value
[1].BufferLen
);
1229 if (Value
[0].Buffer
!= NULL
) {
1230 FreePool (Value
[0].Buffer
);
1232 if (Value
[1].Buffer
!= NULL
) {
1233 FreePool (Value
[1].Buffer
);
1235 if (String
[0] != NULL
) {
1236 FreePool (String
[0]);
1238 if (String
[1] != NULL
) {
1239 FreePool (String
[1]);
1241 if (StringPtr
!= NULL
) {
1242 FreePool (StringPtr
);
1250 Evaluate opcode EFI_IFR_MATCH.
1252 @param FormSet Formset which contains this opcode.
1253 @param Result Evaluation result for this opcode.
1255 @retval EFI_SUCCESS Opcode evaluation success.
1256 @retval Other Opcode evaluation failed.
1261 IN FORM_BROWSER_FORMSET
*FormSet
,
1262 OUT EFI_HII_VALUE
*Result
1266 EFI_HII_VALUE Value
;
1271 // String[0] - The string to search
1272 // String[1] - pattern
1276 Status
= EFI_SUCCESS
;
1277 for (Index
= 0; Index
< 2; Index
++) {
1278 Status
= PopExpression (&Value
);
1279 if (EFI_ERROR (Status
)) {
1283 if (Value
.Type
!= EFI_IFR_TYPE_STRING
) {
1284 Status
= EFI_UNSUPPORTED
;
1288 String
[Index
] = GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1289 if (String
[Index
] == NULL
) {
1290 Status
= EFI_NOT_FOUND
;
1295 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1296 Result
->Value
.b
= mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
[0], String
[1]);
1299 if (String
[0] != NULL
) {
1300 FreePool (String
[0]);
1302 if (String
[1] != NULL
) {
1303 FreePool (String
[1]);
1311 Evaluate opcode EFI_IFR_FIND.
1313 @param FormSet Formset which contains this opcode.
1314 @param Format Case sensitive or insensitive.
1315 @param Result Evaluation result for this opcode.
1317 @retval EFI_SUCCESS Opcode evaluation success.
1318 @retval Other Opcode evaluation failed.
1323 IN FORM_BROWSER_FORMSET
*FormSet
,
1325 OUT EFI_HII_VALUE
*Result
1329 EFI_HII_VALUE Value
;
1335 if (Format
> EFI_IFR_FF_CASE_INSENSITIVE
) {
1336 return EFI_UNSUPPORTED
;
1339 Status
= PopExpression (&Value
);
1340 if (EFI_ERROR (Status
)) {
1343 if (Value
.Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1344 return EFI_UNSUPPORTED
;
1346 Base
= (UINTN
) Value
.Value
.u64
;
1349 // String[0] - sub-string
1350 // String[1] - The string to search
1354 for (Index
= 0; Index
< 2; Index
++) {
1355 Status
= PopExpression (&Value
);
1356 if (EFI_ERROR (Status
)) {
1360 if (Value
.Type
!= EFI_IFR_TYPE_STRING
) {
1361 Status
= EFI_UNSUPPORTED
;
1365 String
[Index
] = GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1366 if (String
[Index
] == NULL
) {
1367 Status
= EFI_NOT_FOUND
;
1371 if (Format
== EFI_IFR_FF_CASE_INSENSITIVE
) {
1373 // Case insensitive, convert both string to upper case
1375 IfrStrToUpper (String
[Index
]);
1379 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1380 if (Base
>= StrLen (String
[1])) {
1381 Result
->Value
.u64
= 0xFFFFFFFFFFFFFFFFULL
;
1383 StringPtr
= StrStr (String
[1] + Base
, String
[0]);
1384 Result
->Value
.u64
= (StringPtr
== NULL
) ? 0xFFFFFFFFFFFFFFFFULL
: (StringPtr
- String
[1]);
1388 if (String
[0] != NULL
) {
1389 FreePool (String
[0]);
1391 if (String
[1] != NULL
) {
1392 FreePool (String
[1]);
1400 Evaluate opcode EFI_IFR_MID.
1402 @param FormSet Formset which contains this opcode.
1403 @param Result Evaluation result for this opcode.
1405 @retval EFI_SUCCESS Opcode evaluation success.
1406 @retval Other Opcode evaluation failed.
1411 IN FORM_BROWSER_FORMSET
*FormSet
,
1412 OUT EFI_HII_VALUE
*Result
1416 EFI_HII_VALUE Value
;
1424 Status
= PopExpression (&Value
);
1425 if (EFI_ERROR (Status
)) {
1428 if (Value
.Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1429 return EFI_UNSUPPORTED
;
1431 Length
= (UINTN
) Value
.Value
.u64
;
1433 Status
= PopExpression (&Value
);
1434 if (EFI_ERROR (Status
)) {
1437 if (Value
.Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1438 return EFI_UNSUPPORTED
;
1440 Base
= (UINTN
) Value
.Value
.u64
;
1442 Status
= PopExpression (&Value
);
1443 if (EFI_ERROR (Status
)) {
1446 if (Value
.Type
!= EFI_IFR_TYPE_STRING
&& Value
.Type
!= EFI_IFR_TYPE_BUFFER
) {
1447 return EFI_UNSUPPORTED
;
1449 if (Value
.Type
== EFI_IFR_TYPE_STRING
) {
1450 String
= GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1451 if (String
== NULL
) {
1452 return EFI_NOT_FOUND
;
1455 if (Length
== 0 || Base
>= StrLen (String
)) {
1456 SubString
= gEmptyString
;
1458 SubString
= String
+ Base
;
1459 if ((Base
+ Length
) < StrLen (String
)) {
1460 SubString
[Length
] = L
'\0';
1464 Result
->Type
= EFI_IFR_TYPE_STRING
;
1465 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1469 Buffer
= Value
.Buffer
;
1470 BufferLen
= Value
.BufferLen
;
1472 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1473 if (Length
== 0 || Base
>= BufferLen
) {
1474 Result
->BufferLen
= 0;
1475 Result
->Buffer
= NULL
;
1477 Result
->BufferLen
= (UINT16
)((BufferLen
- Base
) < Length
? (BufferLen
- Base
) : Length
);
1478 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1479 ASSERT (Result
->Buffer
!= NULL
);
1480 CopyMem (Result
->Buffer
, &Value
.Buffer
[Base
], Result
->BufferLen
);
1483 FreePool (Value
.Buffer
);
1491 Evaluate opcode EFI_IFR_TOKEN.
1493 @param FormSet Formset which contains this opcode.
1494 @param Result Evaluation result for this opcode.
1496 @retval EFI_SUCCESS Opcode evaluation success.
1497 @retval Other Opcode evaluation failed.
1502 IN FORM_BROWSER_FORMSET
*FormSet
,
1503 OUT EFI_HII_VALUE
*Result
1507 EFI_HII_VALUE Value
;
1515 Status
= PopExpression (&Value
);
1516 if (EFI_ERROR (Status
)) {
1519 if (Value
.Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1520 return EFI_UNSUPPORTED
;
1522 Count
= (UINTN
) Value
.Value
.u64
;
1525 // String[0] - Delimiter
1526 // String[1] - The string to search
1530 for (Index
= 0; Index
< 2; Index
++) {
1531 Status
= PopExpression (&Value
);
1532 if (EFI_ERROR (Status
)) {
1536 if (Value
.Type
!= EFI_IFR_TYPE_STRING
) {
1537 Status
= EFI_UNSUPPORTED
;
1541 String
[Index
] = GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1542 if (String
[Index
] == NULL
) {
1543 Status
= EFI_NOT_FOUND
;
1548 Delimiter
= String
[0];
1549 SubString
= String
[1];
1551 SubString
= StrStr (SubString
, Delimiter
);
1552 if (SubString
!= NULL
) {
1554 // Skip over the delimiter
1556 SubString
= SubString
+ StrLen (Delimiter
);
1563 if (SubString
== NULL
) {
1565 // nth delimited sub-string not found, push an empty string
1567 SubString
= gEmptyString
;
1570 // Put a NULL terminator for nth delimited sub-string
1572 StringPtr
= StrStr (SubString
, Delimiter
);
1573 if (StringPtr
!= NULL
) {
1578 Result
->Type
= EFI_IFR_TYPE_STRING
;
1579 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1582 if (String
[0] != NULL
) {
1583 FreePool (String
[0]);
1585 if (String
[1] != NULL
) {
1586 FreePool (String
[1]);
1594 Evaluate opcode EFI_IFR_SPAN.
1596 @param FormSet Formset which contains this opcode.
1597 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1598 @param Result Evaluation result for this opcode.
1600 @retval EFI_SUCCESS Opcode evaluation success.
1601 @retval Other Opcode evaluation failed.
1606 IN FORM_BROWSER_FORMSET
*FormSet
,
1608 OUT EFI_HII_VALUE
*Result
1612 EFI_HII_VALUE Value
;
1620 Status
= PopExpression (&Value
);
1621 if (EFI_ERROR (Status
)) {
1624 if (Value
.Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1625 return EFI_UNSUPPORTED
;
1627 Base
= (UINTN
) Value
.Value
.u64
;
1630 // String[0] - Charset
1631 // String[1] - The string to search
1635 for (Index
= 0; Index
< 2; Index
++) {
1636 Status
= PopExpression (&Value
);
1637 if (EFI_ERROR (Status
)) {
1641 if (Value
.Type
!= EFI_IFR_TYPE_STRING
) {
1642 Status
= EFI_UNSUPPORTED
;
1646 String
[Index
] = GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1647 if (String
[Index
] == NULL
) {
1648 Status
= EFI_NOT_FOUND
;
1653 if (Base
>= StrLen (String
[1])) {
1654 Status
= EFI_UNSUPPORTED
;
1659 StringPtr
= String
[1] + Base
;
1660 Charset
= String
[0];
1661 while (*StringPtr
!= 0 && !Found
) {
1663 while (Charset
[Index
] != 0) {
1664 if (*StringPtr
>= Charset
[Index
] && *StringPtr
<= Charset
[Index
+ 1]) {
1665 if (Flags
== EFI_IFR_FLAGS_FIRST_MATCHING
) {
1670 if (Flags
== EFI_IFR_FLAGS_FIRST_NON_MATCHING
) {
1676 // Skip characters pair representing low-end of a range and high-end of a range
1686 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1687 Result
->Value
.u64
= StringPtr
- String
[1];
1690 if (String
[0] != NULL
) {
1691 FreePool (String
[0]);
1693 if (String
[1] != NULL
) {
1694 FreePool (String
[1]);
1702 Zero extend integer/boolean/date/time to UINT64 for comparing.
1704 @param Value HII Value to be converted.
1709 IN EFI_HII_VALUE
*Value
1715 switch (Value
->Type
) {
1716 case EFI_IFR_TYPE_NUM_SIZE_8
:
1717 Temp
= Value
->Value
.u8
;
1720 case EFI_IFR_TYPE_NUM_SIZE_16
:
1721 Temp
= Value
->Value
.u16
;
1724 case EFI_IFR_TYPE_NUM_SIZE_32
:
1725 Temp
= Value
->Value
.u32
;
1728 case EFI_IFR_TYPE_BOOLEAN
:
1729 Temp
= Value
->Value
.b
;
1732 case EFI_IFR_TYPE_TIME
:
1733 Temp
= Value
->Value
.u32
& 0xffffff;
1736 case EFI_IFR_TYPE_DATE
:
1737 Temp
= Value
->Value
.u32
;
1744 Value
->Value
.u64
= Temp
;
1749 Compare two Hii value.
1751 @param Value1 Expression value to compare on left-hand.
1752 @param Value2 Expression value to compare on right-hand.
1753 @param HiiHandle Only required for string compare.
1755 @retval EFI_INVALID_PARAMETER Could not perform compare on two values.
1756 @retval 0 Two operators equal.
1757 @return Positive value if Value1 is greater than Value2.
1758 @retval Negative value if Value1 is less than Value2.
1763 IN EFI_HII_VALUE
*Value1
,
1764 IN EFI_HII_VALUE
*Value2
,
1765 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1774 if (Value1
->Type
>= EFI_IFR_TYPE_OTHER
|| Value2
->Type
>= EFI_IFR_TYPE_OTHER
) {
1775 if (Value1
->Type
!= EFI_IFR_TYPE_BUFFER
&& Value2
->Type
!= EFI_IFR_TYPE_BUFFER
) {
1776 return EFI_INVALID_PARAMETER
;
1780 if (Value1
->Type
== EFI_IFR_TYPE_STRING
|| Value2
->Type
== EFI_IFR_TYPE_STRING
) {
1781 if (Value1
->Type
!= Value2
->Type
) {
1783 // Both Operator should be type of String
1785 return EFI_INVALID_PARAMETER
;
1788 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
1790 // StringId 0 is reserved
1792 return EFI_INVALID_PARAMETER
;
1795 if (Value1
->Value
.string
== Value2
->Value
.string
) {
1799 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
1804 return EFI_INVALID_PARAMETER
;
1807 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
1810 return EFI_INVALID_PARAMETER
;
1813 Result
= StrCmp (Str1
, Str2
);
1821 if (Value1
->Type
== EFI_IFR_TYPE_BUFFER
|| Value2
->Type
== EFI_IFR_TYPE_BUFFER
) {
1822 if (Value1
->Type
!= Value2
->Type
) {
1824 // Both Operator should be type of Buffer.
1826 return EFI_INVALID_PARAMETER
;
1828 Len
= Value1
->BufferLen
> Value2
->BufferLen
? Value2
->BufferLen
: Value1
->BufferLen
;
1829 Result
= CompareMem (Value1
->Buffer
, Value2
->Buffer
, Len
);
1830 if ((Result
== 0) && (Value1
->BufferLen
!= Value2
->BufferLen
))
1833 // In this case, means base on samll number buffer, the data is same
1834 // So which value has more data, which value is bigger.
1836 Result
= Value1
->BufferLen
> Value2
->BufferLen
? 1 : -1;
1842 // Take remain types(integer, boolean, date/time) as integer
1844 Temp64
= (INT64
) (Value1
->Value
.u64
- Value2
->Value
.u64
);
1847 } else if (Temp64
< 0) {
1857 Check if current user has the privilege specified by the permissions GUID.
1859 @param[in] Guid A GUID specifying setup access permissions.
1861 @retval TRUE Current user has the privilege.
1862 @retval FALSE Current user does not have the privilege.
1865 CheckUserPrivilege (
1870 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
1871 EFI_USER_INFO_HANDLE UserInfoHandle
;
1872 EFI_USER_INFO
*UserInfo
;
1873 EFI_GUID
*UserPermissionsGuid
;
1875 UINTN AccessControlDataSize
;
1876 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
1879 if (mUserManager
== NULL
) {
1880 Status
= gBS
->LocateProtocol (
1881 &gEfiUserManagerProtocolGuid
,
1883 (VOID
**) &mUserManager
1885 if (EFI_ERROR (Status
)) {
1887 /// If the system does not support user management, then it is assumed that
1888 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
1889 /// op-code is always TRUE.
1895 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
1896 ASSERT_EFI_ERROR (Status
);
1899 /// Enumerate all user information of the current user profile
1900 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
1903 for (UserInfoHandle
= NULL
;;) {
1904 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
1905 if (EFI_ERROR (Status
)) {
1910 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
1911 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1915 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
1916 if (UserInfo
== NULL
) {
1920 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
1921 if (EFI_ERROR (Status
) ||
1922 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
1923 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
1924 FreePool (UserInfo
);
1928 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
1929 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
1930 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
1931 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
1934 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
1936 /// Check if current user has the privilege specified by the permissions GUID.
1939 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
1940 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
1941 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
1942 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
1943 FreePool (UserInfo
);
1946 UserPermissionsGuid
++;
1947 AccessControlDataSize
-= sizeof (EFI_GUID
);
1950 RemainSize
-= AccessControl
->Size
;
1951 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
1954 FreePool (UserInfo
);
1960 Get question value from the predefined formset.
1962 @param DevicePath The driver's device path which produece the formset data.
1963 @param InputHiiHandle The hii handle associate with the formset data.
1964 @param FormSetGuid The formset guid which include the question.
1965 @param QuestionId The question id which need to get value from.
1966 @param Value The return data about question's value.
1968 @retval TRUE Get the question value success.
1969 @retval FALSE Get the question value failed.
1972 GetQuestionValueFromForm (
1973 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1974 IN EFI_HII_HANDLE InputHiiHandle
,
1975 IN EFI_GUID
*FormSetGuid
,
1976 IN EFI_QUESTION_ID QuestionId
,
1977 OUT EFI_HII_VALUE
*Value
1981 EFI_HANDLE DriverHandle
;
1983 EFI_HII_HANDLE
*HiiHandles
;
1984 EFI_HII_HANDLE HiiHandle
;
1986 FORM_BROWSER_STATEMENT
*Question
;
1987 FORM_BROWSER_FORMSET
*FormSet
;
1988 FORM_BROWSER_FORM
*Form
;
1993 // The input parameter DevicePath or InputHiiHandle must have one valid input.
1995 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
1996 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
1999 DriverHandle
= NULL
;
2007 if (DevicePath
!= NULL
) {
2009 // 1. Get Driver handle.
2011 Status
= gBS
->LocateDevicePath (
2012 &gEfiDevicePathProtocolGuid
,
2016 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
2021 // 2. Get Hii handle
2023 HiiHandles
= HiiGetHiiHandles (NULL
);
2024 if (HiiHandles
== NULL
) {
2028 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
2029 Status
= mHiiDatabase
->GetPackageListHandle (
2034 if (!EFI_ERROR (Status
) && (Handle
== DriverHandle
)) {
2035 HiiHandle
= HiiHandles
[Index
];
2039 FreePool (HiiHandles
);
2041 HiiHandle
= InputHiiHandle
;
2043 ASSERT (HiiHandle
!= NULL
);
2046 // Get the formset data include this question.
2048 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2049 ASSERT (FormSet
!= NULL
);
2050 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
, FALSE
);
2051 if (EFI_ERROR (Status
)) {
2057 // Base on the Question Id to get the question info.
2059 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2060 if (Question
== NULL
) {
2066 // Search form in the formset scope
2068 Link
= GetFirstNode (&FormSet
->FormListHead
);
2069 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2070 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2072 Question
= IdToQuestion2 (Form
, QuestionId
);
2073 if (Question
!= NULL
) {
2077 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2080 ASSERT (Form
!= NULL
);
2083 // Get the question value.
2085 Status
= GetQuestionValue(FormSet
, Form
, Question
, FALSE
);
2086 if (EFI_ERROR (Status
)) {
2091 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2095 // Clean the formset structure and restore the global parameter.
2097 if (FormSet
!= NULL
) {
2098 DestroyFormSet (FormSet
);
2105 Evaluate the result of a HII expression.
2107 If Expression is NULL, then ASSERT.
2109 @param FormSet FormSet associated with this expression.
2110 @param Form Form associated with this expression.
2111 @param Expression Expression to be evaluated.
2113 @retval EFI_SUCCESS The expression evaluated successfuly
2114 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2116 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2118 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2119 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2123 EvaluateExpression (
2124 IN FORM_BROWSER_FORMSET
*FormSet
,
2125 IN FORM_BROWSER_FORM
*Form
,
2126 IN OUT FORM_EXPRESSION
*Expression
2131 EXPRESSION_OPCODE
*OpCode
;
2132 FORM_BROWSER_STATEMENT
*Question
;
2133 FORM_BROWSER_STATEMENT
*Question2
;
2135 EFI_HII_VALUE Data1
;
2136 EFI_HII_VALUE Data2
;
2137 EFI_HII_VALUE Data3
;
2138 FORM_EXPRESSION
*RuleExpression
;
2139 EFI_HII_VALUE
*Value
;
2144 LIST_ENTRY
*SubExpressionLink
;
2145 FORM_EXPRESSION
*SubExpression
;
2152 EFI_HII_VALUE QuestionVal
;
2155 // Save current stack offset.
2157 StackOffset
= SaveExpressionEvaluationStackOffset ();
2159 ASSERT (Expression
!= NULL
);
2160 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2162 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2163 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2164 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2166 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2168 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2169 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2170 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2173 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2174 Status
= EFI_SUCCESS
;
2176 switch (OpCode
->Operand
) {
2178 // Built-in functions
2180 case EFI_IFR_EQ_ID_VAL_OP
:
2181 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2182 if (Question
== NULL
) {
2183 Status
= EFI_NOT_FOUND
;
2187 Result
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, NULL
);
2188 if (Result
== EFI_INVALID_PARAMETER
) {
2189 Status
= EFI_INVALID_PARAMETER
;
2192 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2195 case EFI_IFR_EQ_ID_ID_OP
:
2196 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2197 if (Question
== NULL
) {
2198 Status
= EFI_NOT_FOUND
;
2202 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2203 if (Question2
== NULL
) {
2204 Status
= EFI_NOT_FOUND
;
2208 Result
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, FormSet
->HiiHandle
);
2209 if (Result
== EFI_INVALID_PARAMETER
) {
2210 Status
= EFI_INVALID_PARAMETER
;
2213 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2216 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2217 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2218 if (Question
== NULL
) {
2219 Status
= EFI_NOT_FOUND
;
2223 Value
->Value
.b
= FALSE
;
2224 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2225 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2226 Value
->Value
.b
= TRUE
;
2232 case EFI_IFR_DUP_OP
:
2233 Status
= PopExpression (Value
);
2234 if (EFI_ERROR (Status
)) {
2238 Status
= PushExpression (Value
);
2241 case EFI_IFR_QUESTION_REF1_OP
:
2242 case EFI_IFR_THIS_OP
:
2243 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2244 if (Question
== NULL
) {
2245 Status
= EFI_NOT_FOUND
;
2249 Value
= &Question
->HiiValue
;
2252 case EFI_IFR_SECURITY_OP
:
2253 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2256 case EFI_IFR_GET_OP
:
2258 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2260 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2261 Value
->Value
.u8
= 0;
2262 if (OpCode
->VarStorage
!= NULL
) {
2263 switch (OpCode
->VarStorage
->Type
) {
2264 case EFI_HII_VARSTORE_BUFFER
:
2265 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2267 // Get value from Edit Buffer
2269 Value
->Type
= OpCode
->ValueType
;
2270 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2272 case EFI_HII_VARSTORE_NAME_VALUE
:
2273 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2275 // Get value from string except for STRING value.
2277 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
);
2278 if (!EFI_ERROR (Status
)) {
2279 ASSERT (StrPtr
!= NULL
);
2280 TempLength
= StrLen (StrPtr
);
2281 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2282 Value
->Type
= OpCode
->ValueType
;
2283 TempBuffer
= (UINT8
*) &Value
->Value
;
2284 ZeroMem (TempStr
, sizeof (TempStr
));
2285 for (Index
= 0; Index
< TempLength
; Index
++) {
2286 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2287 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2288 if ((Index
& 1) == 0) {
2289 TempBuffer
[Index
/2] = DigitUint8
;
2291 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2298 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2300 // Get value from variable.
2302 TempLength
= OpCode
->ValueWidth
;
2303 Value
->Type
= OpCode
->ValueType
;
2304 Status
= gRT
->GetVariable (
2306 &OpCode
->VarStorage
->Guid
,
2311 if (EFI_ERROR (Status
)) {
2312 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2313 Value
->Value
.u8
= 0;
2318 // Not recognize storage.
2320 Status
= EFI_UNSUPPORTED
;
2325 // For Time/Date Data
2327 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2329 // Only support Data/Time data when storage doesn't exist.
2331 Status
= EFI_UNSUPPORTED
;
2334 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2335 if (!EFI_ERROR (Status
)) {
2336 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2337 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2339 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2340 Value
->Value
.u16
= EfiTime
.Year
;
2343 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2344 Value
->Value
.u8
= EfiTime
.Month
;
2347 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2348 Value
->Value
.u8
= EfiTime
.Day
;
2352 // Invalid Date field.
2354 Status
= EFI_INVALID_PARAMETER
;
2358 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2360 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2361 Value
->Value
.u8
= EfiTime
.Hour
;
2364 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2365 Value
->Value
.u8
= EfiTime
.Minute
;
2368 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2369 Value
->Value
.u8
= EfiTime
.Second
;
2373 // Invalid Time field.
2375 Status
= EFI_INVALID_PARAMETER
;
2384 case EFI_IFR_QUESTION_REF3_OP
:
2386 // EFI_IFR_QUESTION_REF3
2387 // Pop an expression from the expression stack
2389 Status
= PopExpression (Value
);
2390 if (EFI_ERROR (Status
)) {
2395 // Validate the expression value
2397 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2398 Status
= EFI_NOT_FOUND
;
2402 if (OpCode
->DevicePath
!= 0) {
2403 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2404 if (StrPtr
== NULL
) {
2405 Status
= EFI_NOT_FOUND
;
2409 if (!GetQuestionValueFromForm((EFI_DEVICE_PATH_PROTOCOL
*)StrPtr
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2410 Status
= EFI_NOT_FOUND
;
2413 Value
= &QuestionVal
;
2414 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2415 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2416 Status
= EFI_NOT_FOUND
;
2419 Value
= &QuestionVal
;
2421 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2422 if (Question
== NULL
) {
2423 Status
= EFI_NOT_FOUND
;
2428 // push the questions' value on to the expression stack
2430 Value
= &Question
->HiiValue
;
2434 case EFI_IFR_RULE_REF_OP
:
2436 // Find expression for this rule
2438 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2439 if (RuleExpression
== NULL
) {
2440 Status
= EFI_NOT_FOUND
;
2445 // Evaluate this rule expression
2447 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2448 if (EFI_ERROR (Status
)) {
2452 Value
= &RuleExpression
->Result
;
2455 case EFI_IFR_STRING_REF1_OP
:
2456 Value
->Type
= EFI_IFR_TYPE_STRING
;
2457 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2463 case EFI_IFR_TRUE_OP
:
2464 case EFI_IFR_FALSE_OP
:
2465 case EFI_IFR_ONE_OP
:
2466 case EFI_IFR_ONES_OP
:
2467 case EFI_IFR_UINT8_OP
:
2468 case EFI_IFR_UINT16_OP
:
2469 case EFI_IFR_UINT32_OP
:
2470 case EFI_IFR_UINT64_OP
:
2471 case EFI_IFR_UNDEFINED_OP
:
2472 case EFI_IFR_VERSION_OP
:
2473 case EFI_IFR_ZERO_OP
:
2474 Value
= &OpCode
->Value
;
2480 case EFI_IFR_LENGTH_OP
:
2481 Status
= PopExpression (Value
);
2482 if (EFI_ERROR (Status
)) {
2485 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& Value
->Type
!= EFI_IFR_TYPE_BUFFER
) {
2486 Status
= EFI_INVALID_PARAMETER
;
2490 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2491 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2492 if (StrPtr
== NULL
) {
2493 Status
= EFI_INVALID_PARAMETER
;
2497 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2498 Value
->Value
.u64
= StrLen (StrPtr
);
2501 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2502 Value
->Value
.u64
= Value
->BufferLen
;
2503 FreePool (Value
->Buffer
);
2507 case EFI_IFR_NOT_OP
:
2508 Status
= PopExpression (Value
);
2509 if (EFI_ERROR (Status
)) {
2512 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2513 Status
= EFI_INVALID_PARAMETER
;
2516 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2519 case EFI_IFR_QUESTION_REF2_OP
:
2521 // Pop an expression from the expression stack
2523 Status
= PopExpression (Value
);
2524 if (EFI_ERROR (Status
)) {
2529 // Validate the expression value
2531 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2532 Status
= EFI_NOT_FOUND
;
2536 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2537 if (Question
== NULL
) {
2538 Status
= EFI_NOT_FOUND
;
2542 Value
= &Question
->HiiValue
;
2545 case EFI_IFR_STRING_REF2_OP
:
2547 // Pop an expression from the expression stack
2549 Status
= PopExpression (Value
);
2550 if (EFI_ERROR (Status
)) {
2555 // Validate the expression value
2557 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2558 Status
= EFI_NOT_FOUND
;
2562 Value
->Type
= EFI_IFR_TYPE_STRING
;
2563 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2564 if (StrPtr
== NULL
) {
2566 // If String not exit, push an empty string
2568 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2570 Index
= (UINT16
) Value
->Value
.u64
;
2571 Value
->Value
.string
= Index
;
2576 case EFI_IFR_TO_BOOLEAN_OP
:
2578 // Pop an expression from the expression stack
2580 Status
= PopExpression (Value
);
2581 if (EFI_ERROR (Status
)) {
2586 // Convert an expression to a Boolean
2588 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
2590 // When converting from an unsigned integer, zero will be converted to
2591 // FALSE and any other value will be converted to TRUE.
2593 Value
->Value
.b
= (BOOLEAN
) (Value
->Value
.u64
!= 0);
2595 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2596 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2598 // When converting from a string, if case-insensitive compare
2599 // with "true" is True, then push True. If a case-insensitive compare
2600 // with "false" is True, then push False. Otherwise, push Undefined.
2602 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2603 if (StrPtr
== NULL
) {
2604 Status
= EFI_INVALID_PARAMETER
;
2608 IfrStrToUpper (StrPtr
);
2609 if (StrCmp (StrPtr
, L
"TRUE") == 0){
2610 Value
->Value
.b
= TRUE
;
2611 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
2612 Value
->Value
.b
= FALSE
;
2614 Status
= EFI_INVALID_PARAMETER
;
2619 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2620 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
2622 // When converting from a buffer, if the buffer is all zeroes,
2623 // then push False. Otherwise push True.
2625 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
2626 if (Value
->Buffer
[Index
] != 0) {
2631 if (Index
>= Value
->BufferLen
) {
2632 Value
->Value
.b
= FALSE
;
2634 Value
->Value
.b
= TRUE
;
2636 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2637 FreePool (Value
->Buffer
);
2641 case EFI_IFR_TO_STRING_OP
:
2642 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
2645 case EFI_IFR_TO_UINT_OP
:
2646 Status
= IfrToUint (FormSet
, Value
);
2649 case EFI_IFR_TO_LOWER_OP
:
2650 case EFI_IFR_TO_UPPER_OP
:
2651 Status
= InitializeUnicodeCollationProtocol ();
2652 if (EFI_ERROR (Status
)) {
2656 Status
= PopExpression (Value
);
2657 if (EFI_ERROR (Status
)) {
2661 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
2662 Status
= EFI_UNSUPPORTED
;
2666 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2667 if (StrPtr
== NULL
) {
2668 Status
= EFI_NOT_FOUND
;
2672 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
2673 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
2675 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
2677 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
2681 case EFI_IFR_BITWISE_NOT_OP
:
2683 // Pop an expression from the expression stack
2685 Status
= PopExpression (Value
);
2686 if (EFI_ERROR (Status
)) {
2689 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
2690 Status
= EFI_INVALID_PARAMETER
;
2694 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2695 Value
->Value
.u64
= ~Value
->Value
.u64
;
2698 case EFI_IFR_SET_OP
:
2700 // Pop an expression from the expression stack
2702 Status
= PopExpression (Value
);
2703 if (EFI_ERROR (Status
)) {
2706 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
2707 Data1
.Value
.b
= FALSE
;
2709 // Set value to var storage buffer
2711 if (OpCode
->VarStorage
!= NULL
) {
2712 switch (OpCode
->VarStorage
->Type
) {
2713 case EFI_HII_VARSTORE_BUFFER
:
2714 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2715 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
2716 Data1
.Value
.b
= TRUE
;
2718 case EFI_HII_VARSTORE_NAME_VALUE
:
2719 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2720 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
2721 ASSERT (Value
!= NULL
);
2723 // Convert Buffer to Hex String
2725 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
2727 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
2728 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
2730 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, TRUE
);
2731 FreePool (NameValue
);
2732 if (!EFI_ERROR (Status
)) {
2733 Data1
.Value
.b
= TRUE
;
2737 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2738 Status
= gRT
->SetVariable (
2740 &OpCode
->VarStorage
->Guid
,
2741 OpCode
->VarStorage
->Attributes
,
2745 if (!EFI_ERROR (Status
)) {
2746 Data1
.Value
.b
= TRUE
;
2751 // Not recognize storage.
2753 Status
= EFI_UNSUPPORTED
;
2759 // For Time/Date Data
2761 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2763 // Only support Data/Time data when storage doesn't exist.
2765 Status
= EFI_UNSUPPORTED
;
2768 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2769 if (!EFI_ERROR (Status
)) {
2770 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2771 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2773 EfiTime
.Year
= Value
->Value
.u16
;
2776 EfiTime
.Month
= Value
->Value
.u8
;
2779 EfiTime
.Day
= Value
->Value
.u8
;
2783 // Invalid Date field.
2785 Status
= EFI_INVALID_PARAMETER
;
2789 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2791 EfiTime
.Hour
= Value
->Value
.u8
;
2794 EfiTime
.Minute
= Value
->Value
.u8
;
2797 EfiTime
.Second
= Value
->Value
.u8
;
2801 // Invalid Time field.
2803 Status
= EFI_INVALID_PARAMETER
;
2807 Status
= gRT
->SetTime (&EfiTime
);
2808 if (!EFI_ERROR (Status
)) {
2809 Data1
.Value
.b
= TRUE
;
2819 case EFI_IFR_ADD_OP
:
2820 case EFI_IFR_SUBTRACT_OP
:
2821 case EFI_IFR_MULTIPLY_OP
:
2822 case EFI_IFR_DIVIDE_OP
:
2823 case EFI_IFR_MODULO_OP
:
2824 case EFI_IFR_BITWISE_AND_OP
:
2825 case EFI_IFR_BITWISE_OR_OP
:
2826 case EFI_IFR_SHIFT_LEFT_OP
:
2827 case EFI_IFR_SHIFT_RIGHT_OP
:
2829 // Pop an expression from the expression stack
2831 Status
= PopExpression (&Data2
);
2832 if (EFI_ERROR (Status
)) {
2835 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
2836 Status
= EFI_INVALID_PARAMETER
;
2841 // Pop another expression from the expression stack
2843 Status
= PopExpression (&Data1
);
2844 if (EFI_ERROR (Status
)) {
2847 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
2848 Status
= EFI_INVALID_PARAMETER
;
2852 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2854 switch (OpCode
->Operand
) {
2855 case EFI_IFR_ADD_OP
:
2856 Value
->Value
.u64
= Data1
.Value
.u64
+ Data2
.Value
.u64
;
2859 case EFI_IFR_SUBTRACT_OP
:
2860 Value
->Value
.u64
= Data1
.Value
.u64
- Data2
.Value
.u64
;
2863 case EFI_IFR_MULTIPLY_OP
:
2864 Value
->Value
.u64
= MultU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2867 case EFI_IFR_DIVIDE_OP
:
2868 Value
->Value
.u64
= DivU64x32 (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
);
2871 case EFI_IFR_MODULO_OP
:
2872 DivU64x32Remainder (Data1
.Value
.u64
, (UINT32
) Data2
.Value
.u64
, &TempValue
);
2873 Value
->Value
.u64
= TempValue
;
2876 case EFI_IFR_BITWISE_AND_OP
:
2877 Value
->Value
.u64
= Data1
.Value
.u64
& Data2
.Value
.u64
;
2880 case EFI_IFR_BITWISE_OR_OP
:
2881 Value
->Value
.u64
= Data1
.Value
.u64
| Data2
.Value
.u64
;
2884 case EFI_IFR_SHIFT_LEFT_OP
:
2885 Value
->Value
.u64
= LShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2888 case EFI_IFR_SHIFT_RIGHT_OP
:
2889 Value
->Value
.u64
= RShiftU64 (Data1
.Value
.u64
, (UINTN
) Data2
.Value
.u64
);
2897 case EFI_IFR_AND_OP
:
2900 // Two Boolean operator
2902 Status
= PopExpression (&Data2
);
2903 if (EFI_ERROR (Status
)) {
2906 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2907 Status
= EFI_INVALID_PARAMETER
;
2912 // Pop another expression from the expression stack
2914 Status
= PopExpression (&Data1
);
2915 if (EFI_ERROR (Status
)) {
2918 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2919 Status
= EFI_INVALID_PARAMETER
;
2923 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
2924 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
2926 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
2930 case EFI_IFR_EQUAL_OP
:
2931 case EFI_IFR_NOT_EQUAL_OP
:
2932 case EFI_IFR_GREATER_EQUAL_OP
:
2933 case EFI_IFR_GREATER_THAN_OP
:
2934 case EFI_IFR_LESS_EQUAL_OP
:
2935 case EFI_IFR_LESS_THAN_OP
:
2937 // Compare two integer, string, boolean or date/time
2939 Status
= PopExpression (&Data2
);
2940 if (EFI_ERROR (Status
)) {
2943 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
2944 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
2945 Data2
.Type
!= EFI_IFR_TYPE_BUFFER
) {
2946 Status
= EFI_INVALID_PARAMETER
;
2951 // Pop another expression from the expression stack
2953 Status
= PopExpression (&Data1
);
2954 if (EFI_ERROR (Status
)) {
2958 Result
= CompareHiiValue (&Data1
, &Data2
, FormSet
->HiiHandle
);
2959 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
2960 FreePool (Data1
.Buffer
);
2961 FreePool (Data2
.Buffer
);
2964 if (Result
== EFI_INVALID_PARAMETER
) {
2965 Status
= EFI_INVALID_PARAMETER
;
2969 switch (OpCode
->Operand
) {
2970 case EFI_IFR_EQUAL_OP
:
2971 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2974 case EFI_IFR_NOT_EQUAL_OP
:
2975 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
2978 case EFI_IFR_GREATER_EQUAL_OP
:
2979 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
2982 case EFI_IFR_GREATER_THAN_OP
:
2983 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
2986 case EFI_IFR_LESS_EQUAL_OP
:
2987 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
2990 case EFI_IFR_LESS_THAN_OP
:
2991 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
2999 case EFI_IFR_MATCH_OP
:
3000 Status
= InitializeUnicodeCollationProtocol ();
3001 if (EFI_ERROR (Status
)) {
3005 Status
= IfrMatch (FormSet
, Value
);
3008 case EFI_IFR_CATENATE_OP
:
3009 Status
= IfrCatenate (FormSet
, Value
);
3015 case EFI_IFR_CONDITIONAL_OP
:
3017 // Pop third expression from the expression stack
3019 Status
= PopExpression (&Data3
);
3020 if (EFI_ERROR (Status
)) {
3025 // Pop second expression from the expression stack
3027 Status
= PopExpression (&Data2
);
3028 if (EFI_ERROR (Status
)) {
3033 // Pop first expression from the expression stack
3035 Status
= PopExpression (&Data1
);
3036 if (EFI_ERROR (Status
)) {
3039 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3040 Status
= EFI_INVALID_PARAMETER
;
3044 if (Data1
.Value
.b
) {
3051 case EFI_IFR_FIND_OP
:
3052 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3055 case EFI_IFR_MID_OP
:
3056 Status
= IfrMid (FormSet
, Value
);
3059 case EFI_IFR_TOKEN_OP
:
3060 Status
= IfrToken (FormSet
, Value
);
3063 case EFI_IFR_SPAN_OP
:
3064 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3067 case EFI_IFR_MAP_OP
:
3069 // Pop the check value
3071 Status
= PopExpression (&Data1
);
3072 if (EFI_ERROR (Status
)) {
3076 // Check MapExpression list is valid.
3078 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3079 Status
= EFI_INVALID_PARAMETER
;
3083 // Go through map expression list.
3085 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3086 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3087 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3089 // Evaluate the first expression in this pair.
3091 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3092 if (EFI_ERROR (Status
)) {
3096 // Compare the expression value with current value
3098 if (CompareHiiValue (&Data1
, &SubExpression
->Result
, NULL
) == 0) {
3100 // Try get the map value.
3102 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3103 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3104 Status
= EFI_INVALID_PARAMETER
;
3107 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3108 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3109 if (EFI_ERROR (Status
)) {
3112 Value
= &SubExpression
->Result
;
3116 // Skip the second expression on this pair.
3118 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3119 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3120 Status
= EFI_INVALID_PARAMETER
;
3124 // Goto the first expression on next pair.
3126 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3130 // No map value is found.
3132 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3133 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3134 Value
->Value
.u8
= 0;
3141 if (EFI_ERROR (Status
)) {
3145 Status
= PushExpression (Value
);
3146 if (EFI_ERROR (Status
)) {
3152 // Pop the final result from expression stack
3155 Status
= PopExpression (Value
);
3156 if (EFI_ERROR (Status
)) {
3161 // After evaluating an expression, there should be only one value left on the expression stack
3163 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3164 Status
= EFI_INVALID_PARAMETER
;
3168 RestoreExpressionEvaluationStackOffset (StackOffset
);
3169 if (!EFI_ERROR (Status
)) {
3170 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3177 Return the result of the expression list. Check the expression list and
3178 return the highest priority express result.
3179 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3181 @param ExpList The input expression list.
3182 @param Evaluate Whether need to evaluate the expression first.
3183 @param FormSet FormSet associated with this expression.
3184 @param Form Form associated with this expression.
3186 @retval EXPRESS_RESULT Return the higher priority express result.
3187 DisableIf > SuppressIf > GrayOutIf > FALSE
3191 EvaluateExpressionList (
3192 IN FORM_EXPRESSION_LIST
*ExpList
,
3193 IN BOOLEAN Evaluate
,
3194 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3195 IN FORM_BROWSER_FORM
*Form OPTIONAL
3199 EXPRESS_RESULT ReturnVal
;
3200 EXPRESS_RESULT CompareOne
;
3203 if (ExpList
== NULL
) {
3204 return ExpressFalse
;
3207 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3211 // Check whether need to evaluate the expression first.
3214 while (ExpList
->Count
> Index
) {
3215 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3216 if (EFI_ERROR (Status
)) {
3217 return ExpressFalse
;
3223 // Run the list of expressions.
3225 ReturnVal
= ExpressFalse
;
3226 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3227 if (ExpList
->Expression
[Index
]->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
&&
3228 ExpList
->Expression
[Index
]->Result
.Value
.b
) {
3229 switch (ExpList
->Expression
[Index
]->Type
) {
3230 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3231 CompareOne
= ExpressSuppress
;
3234 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3235 CompareOne
= ExpressGrayOut
;
3238 case EFI_HII_EXPRESSION_DISABLE_IF
:
3239 CompareOne
= ExpressDisable
;
3243 return ExpressFalse
;
3246 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;