2 Utility functions for expression evaluation.
4 Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // Global stack used to evaluate boolean expresions
20 EFI_HII_VALUE
*mOpCodeScopeStack
= NULL
;
21 EFI_HII_VALUE
*mOpCodeScopeStackEnd
= NULL
;
22 EFI_HII_VALUE
*mOpCodeScopeStackPointer
= NULL
;
24 EFI_HII_VALUE
*mExpressionEvaluationStack
= NULL
;
25 EFI_HII_VALUE
*mExpressionEvaluationStackEnd
= NULL
;
26 EFI_HII_VALUE
*mExpressionEvaluationStackPointer
= NULL
;
27 UINTN mExpressionEvaluationStackOffset
= 0;
29 EFI_HII_VALUE
*mCurrentExpressionStack
= NULL
;
30 EFI_HII_VALUE
*mCurrentExpressionEnd
= NULL
;
31 EFI_HII_VALUE
*mCurrentExpressionPointer
= NULL
;
33 EFI_HII_VALUE
*mMapExpressionListStack
= NULL
;
34 EFI_HII_VALUE
*mMapExpressionListEnd
= NULL
;
35 EFI_HII_VALUE
*mMapExpressionListPointer
= NULL
;
37 FORM_EXPRESSION
**mFormExpressionStack
= NULL
;
38 FORM_EXPRESSION
**mFormExpressionEnd
= NULL
;
39 FORM_EXPRESSION
**mFormExpressionPointer
= NULL
;
41 FORM_EXPRESSION
**mStatementExpressionStack
= NULL
;
42 FORM_EXPRESSION
**mStatementExpressionEnd
= NULL
;
43 FORM_EXPRESSION
**mStatementExpressionPointer
= NULL
;
45 FORM_EXPRESSION
**mOptionExpressionStack
= NULL
;
46 FORM_EXPRESSION
**mOptionExpressionEnd
= NULL
;
47 FORM_EXPRESSION
**mOptionExpressionPointer
= NULL
;
51 // Unicode collation protocol interface
53 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
54 EFI_USER_MANAGER_PROTOCOL
*mUserManager
= NULL
;
57 Grow size of the stack.
59 This is an internal function.
61 @param Stack On input: old stack; On output: new stack
62 @param StackPtr On input: old stack pointer; On output: new stack
64 @param StackEnd On input: old stack end; On output: new stack end
66 @retval EFI_SUCCESS Grow stack success.
67 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
72 IN OUT EFI_HII_VALUE
**Stack
,
73 IN OUT EFI_HII_VALUE
**StackPtr
,
74 IN OUT EFI_HII_VALUE
**StackEnd
78 EFI_HII_VALUE
*NewStack
;
80 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
81 if (*StackPtr
!= NULL
) {
82 Size
= Size
+ (*StackEnd
- *Stack
);
85 NewStack
= AllocatePool (Size
* sizeof (EFI_HII_VALUE
));
86 if (NewStack
== NULL
) {
87 return EFI_OUT_OF_RESOURCES
;
90 if (*StackPtr
!= NULL
) {
92 // Copy from Old Stack to the New Stack
97 (*StackEnd
- *Stack
) * sizeof (EFI_HII_VALUE
)
101 // Free The Old Stack
107 // Make the Stack pointer point to the old data in the new stack
109 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
111 *StackEnd
= NewStack
+ Size
;
118 Push an element onto the Boolean Stack.
120 @param Stack On input: old stack; On output: new stack
121 @param StackPtr On input: old stack pointer; On output: new stack
123 @param StackEnd On input: old stack end; On output: new stack end
124 @param Data Data to push.
126 @retval EFI_SUCCESS Push stack success.
131 IN OUT EFI_HII_VALUE
**Stack
,
132 IN OUT EFI_HII_VALUE
**StackPtr
,
133 IN OUT EFI_HII_VALUE
**StackEnd
,
134 IN EFI_HII_VALUE
*Data
140 // Check for a stack overflow condition
142 if (*StackPtr
>= *StackEnd
) {
146 Status
= GrowStack (Stack
, StackPtr
, StackEnd
);
147 if (EFI_ERROR (Status
)) {
153 // Push the item onto the stack
155 CopyMem (*StackPtr
, Data
, sizeof (EFI_HII_VALUE
));
156 if (Data
->Type
== EFI_IFR_TYPE_BUFFER
) {
157 (*StackPtr
)->Buffer
= AllocateCopyPool(Data
->BufferLen
, Data
->Buffer
);
158 ASSERT ((*StackPtr
)->Buffer
!= NULL
);
161 *StackPtr
= *StackPtr
+ 1;
168 Pop an element from the stack.
170 @param Stack On input: old stack
171 @param StackPtr On input: old stack pointer; On output: new stack pointer
172 @param Data Data to pop.
174 @retval EFI_SUCCESS The value was popped onto the stack.
175 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
180 IN EFI_HII_VALUE
*Stack
,
181 IN OUT EFI_HII_VALUE
**StackPtr
,
182 OUT EFI_HII_VALUE
*Data
186 // Check for a stack underflow condition
188 if (*StackPtr
== Stack
) {
189 return EFI_ACCESS_DENIED
;
193 // Pop the item off the stack
195 *StackPtr
= *StackPtr
- 1;
196 CopyMem (Data
, *StackPtr
, sizeof (EFI_HII_VALUE
));
202 Reset stack pointer to begin of the stack.
206 ResetCurrentExpressionStack (
210 mCurrentExpressionPointer
= mCurrentExpressionStack
;
211 mFormExpressionPointer
= mFormExpressionStack
;
212 mStatementExpressionPointer
= mStatementExpressionStack
;
213 mOptionExpressionPointer
= mOptionExpressionStack
;
218 Push current expression onto the Stack
220 @param Pointer Pointer to current expression.
222 @retval EFI_SUCCESS The value was pushed onto the stack.
223 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
227 PushCurrentExpression (
233 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
234 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
237 &mCurrentExpressionStack
,
238 &mCurrentExpressionPointer
,
239 &mCurrentExpressionEnd
,
246 Pop current expression from the Stack
248 @param Pointer Pointer to current expression to be pop.
250 @retval EFI_SUCCESS The value was pushed onto the stack.
251 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
255 PopCurrentExpression (
263 mCurrentExpressionStack
,
264 &mCurrentExpressionPointer
,
268 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
274 Reset stack pointer to begin of the stack.
278 ResetMapExpressionListStack (
282 mMapExpressionListPointer
= mMapExpressionListStack
;
287 Grow size of the stack.
289 This is an internal function.
291 @param Stack On input: old stack; On output: new stack
292 @param StackPtr On input: old stack pointer; On output: new stack
294 @param StackEnd On input: old stack end; On output: new stack end
295 @param MemberSize The stack member size.
297 @retval EFI_SUCCESS Grow stack success.
298 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
302 GrowConditionalStack (
303 IN OUT FORM_EXPRESSION
***Stack
,
304 IN OUT FORM_EXPRESSION
***StackPtr
,
305 IN OUT FORM_EXPRESSION
***StackEnd
,
310 FORM_EXPRESSION
**NewStack
;
312 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
313 if (*StackPtr
!= NULL
) {
314 Size
= Size
+ (*StackEnd
- *Stack
);
317 NewStack
= AllocatePool (Size
* MemberSize
);
318 if (NewStack
== NULL
) {
319 return EFI_OUT_OF_RESOURCES
;
322 if (*StackPtr
!= NULL
) {
324 // Copy from Old Stack to the New Stack
329 (*StackEnd
- *Stack
) * MemberSize
333 // Free The Old Stack
339 // Make the Stack pointer point to the old data in the new stack
341 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
343 *StackEnd
= NewStack
+ Size
;
349 Push an element onto the Stack.
351 @param Stack On input: old stack; On output: new stack
352 @param StackPtr On input: old stack pointer; On output: new stack
354 @param StackEnd On input: old stack end; On output: new stack end
355 @param Data Data to push.
357 @retval EFI_SUCCESS Push stack success.
361 PushConditionalStack (
362 IN OUT FORM_EXPRESSION
***Stack
,
363 IN OUT FORM_EXPRESSION
***StackPtr
,
364 IN OUT FORM_EXPRESSION
***StackEnd
,
365 IN FORM_EXPRESSION
**Data
371 // Check for a stack overflow condition
373 if (*StackPtr
>= *StackEnd
) {
377 Status
= GrowConditionalStack (Stack
, StackPtr
, StackEnd
, sizeof (FORM_EXPRESSION
*));
378 if (EFI_ERROR (Status
)) {
384 // Push the item onto the stack
386 CopyMem (*StackPtr
, Data
, sizeof (FORM_EXPRESSION
*));
387 *StackPtr
= *StackPtr
+ 1;
394 Pop an element from the stack.
396 @param Stack On input: old stack
397 @param StackPtr On input: old stack pointer; On output: new stack pointer
398 @param Data Data to pop.
400 @retval EFI_SUCCESS The value was popped onto the stack.
401 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
405 PopConditionalStack (
406 IN FORM_EXPRESSION
**Stack
,
407 IN OUT FORM_EXPRESSION
***StackPtr
,
408 OUT FORM_EXPRESSION
**Data
412 // Check for a stack underflow condition
414 if (*StackPtr
== Stack
) {
415 return EFI_ACCESS_DENIED
;
419 // Pop the item off the stack
421 *StackPtr
= *StackPtr
- 1;
422 CopyMem (Data
, *StackPtr
, sizeof (FORM_EXPRESSION
*));
428 Get the expression list count.
430 @param Level Which type this expression belong to. Form,
433 @retval >=0 The expression count
434 @retval -1 Input parameter error.
438 GetConditionalExpressionCount (
439 IN EXPRESS_LEVEL Level
444 return mFormExpressionPointer
- mFormExpressionStack
;
445 case ExpressStatement
:
446 return mStatementExpressionPointer
- mStatementExpressionStack
;
448 return mOptionExpressionPointer
- mOptionExpressionStack
;
456 Get the expression Buffer pointer.
458 @param Level Which type this expression belong to. Form,
461 @retval The start pointer of the expression buffer or NULL.
465 GetConditionalExpressionList (
466 IN EXPRESS_LEVEL Level
471 return mFormExpressionStack
;
472 case ExpressStatement
:
473 return mStatementExpressionStack
;
475 return mOptionExpressionStack
;
484 Push the expression options onto the Stack.
486 @param Pointer Pointer to the current expression.
487 @param Level Which type this expression belong to. Form,
490 @retval EFI_SUCCESS The value was pushed onto the stack.
491 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
495 PushConditionalExpression (
496 IN FORM_EXPRESSION
*Pointer
,
497 IN EXPRESS_LEVEL Level
502 return PushConditionalStack (
503 &mFormExpressionStack
,
504 &mFormExpressionPointer
,
508 case ExpressStatement
:
509 return PushConditionalStack (
510 &mStatementExpressionStack
,
511 &mStatementExpressionPointer
,
512 &mStatementExpressionEnd
,
516 return PushConditionalStack (
517 &mOptionExpressionStack
,
518 &mOptionExpressionPointer
,
519 &mOptionExpressionEnd
,
524 return EFI_INVALID_PARAMETER
;
529 Pop the expression options from the Stack
531 @param Level Which type this expression belong to. Form,
534 @retval EFI_SUCCESS The value was pushed onto the stack.
535 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
539 PopConditionalExpression (
540 IN EXPRESS_LEVEL Level
543 FORM_EXPRESSION
*Pointer
;
547 return PopConditionalStack (
548 mFormExpressionStack
,
549 &mFormExpressionPointer
,
553 case ExpressStatement
:
554 return PopConditionalStack (
555 mStatementExpressionStack
,
556 &mStatementExpressionPointer
,
561 return PopConditionalStack (
562 mOptionExpressionStack
,
563 &mOptionExpressionPointer
,
569 return EFI_INVALID_PARAMETER
;
575 Push the list of map expression onto the Stack
577 @param Pointer Pointer to the list of map expression to be pushed.
579 @retval EFI_SUCCESS The value was pushed onto the stack.
580 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
584 PushMapExpressionList (
590 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
591 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
594 &mMapExpressionListStack
,
595 &mMapExpressionListPointer
,
596 &mMapExpressionListEnd
,
603 Pop the list of map expression from the Stack
605 @param Pointer Pointer to the list of map expression to be pop.
607 @retval EFI_SUCCESS The value was pushed onto the stack.
608 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
612 PopMapExpressionList (
620 mMapExpressionListStack
,
621 &mMapExpressionListPointer
,
625 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
631 Reset stack pointer to begin of the stack.
639 mOpCodeScopeStackPointer
= mOpCodeScopeStack
;
644 Push an Operand onto the Stack
646 @param Operand Operand to push.
648 @retval EFI_SUCCESS The value was pushed onto the stack.
649 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
660 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
661 Data
.Value
.u8
= Operand
;
665 &mOpCodeScopeStackPointer
,
666 &mOpCodeScopeStackEnd
,
673 Pop an Operand from the Stack
675 @param Operand Operand to pop.
677 @retval EFI_SUCCESS The value was pushed onto the stack.
678 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
692 &mOpCodeScopeStackPointer
,
696 *Operand
= Data
.Value
.u8
;
703 Push an Expression value onto the Stack
705 @param Value Expression value to push.
707 @retval EFI_SUCCESS The value was pushed onto the stack.
708 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
714 IN EFI_HII_VALUE
*Value
718 &mExpressionEvaluationStack
,
719 &mExpressionEvaluationStackPointer
,
720 &mExpressionEvaluationStackEnd
,
727 Pop an Expression value from the stack.
729 @param Value Expression value to pop.
731 @retval EFI_SUCCESS The value was popped onto the stack.
732 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
737 OUT EFI_HII_VALUE
*Value
741 mExpressionEvaluationStack
+ mExpressionEvaluationStackOffset
,
742 &mExpressionEvaluationStackPointer
,
748 Get current stack offset from stack start.
750 @return Stack offset to stack start.
753 SaveExpressionEvaluationStackOffset (
756 UINTN TempStackOffset
;
757 TempStackOffset
= mExpressionEvaluationStackOffset
;
758 mExpressionEvaluationStackOffset
= mExpressionEvaluationStackPointer
- mExpressionEvaluationStack
;
759 return TempStackOffset
;
763 Restore stack offset based on input stack offset
765 @param StackOffset Offset to stack start.
769 RestoreExpressionEvaluationStackOffset (
773 mExpressionEvaluationStackOffset
= StackOffset
;
777 Get Form given its FormId.
779 @param FormSet The formset which contains this form.
780 @param FormId Id of this form.
782 @retval Pointer The form.
783 @retval NULL Specified Form is not found in the formset.
788 IN FORM_BROWSER_FORMSET
*FormSet
,
793 FORM_BROWSER_FORM
*Form
;
795 Link
= GetFirstNode (&FormSet
->FormListHead
);
796 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
797 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
799 if (Form
->FormId
== FormId
) {
803 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
811 Search a Question in Form scope using its QuestionId.
813 @param Form The form which contains this Question.
814 @param QuestionId Id of this Question.
816 @retval Pointer The Question.
817 @retval NULL Specified Question not found in the form.
820 FORM_BROWSER_STATEMENT
*
822 IN FORM_BROWSER_FORM
*Form
,
827 FORM_BROWSER_STATEMENT
*Question
;
829 if (QuestionId
== 0 || Form
== NULL
) {
831 // The value of zero is reserved
836 Link
= GetFirstNode (&Form
->StatementListHead
);
837 while (!IsNull (&Form
->StatementListHead
, Link
)) {
838 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
840 if (Question
->QuestionId
== QuestionId
) {
844 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
852 Search a Question in Formset scope using its QuestionId.
854 @param FormSet The formset which contains this form.
855 @param Form The form which contains this Question.
856 @param QuestionId Id of this Question.
858 @retval Pointer The Question.
859 @retval NULL Specified Question not found in the form.
862 FORM_BROWSER_STATEMENT
*
864 IN FORM_BROWSER_FORMSET
*FormSet
,
865 IN FORM_BROWSER_FORM
*Form
,
870 FORM_BROWSER_STATEMENT
*Question
;
873 // Search in the form scope first
875 Question
= IdToQuestion2 (Form
, QuestionId
);
876 if (Question
!= NULL
) {
881 // Search in the formset scope
883 Link
= GetFirstNode (&FormSet
->FormListHead
);
884 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
885 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
887 Question
= IdToQuestion2 (Form
, QuestionId
);
888 if (Question
!= NULL
) {
890 // EFI variable storage may be updated by Callback() asynchronous,
891 // to keep synchronous, always reload the Question Value.
893 if (Question
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
894 GetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
900 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
908 Get Expression given its RuleId.
910 @param Form The form which contains this Expression.
911 @param RuleId Id of this Expression.
913 @retval Pointer The Expression.
914 @retval NULL Specified Expression not found in the form.
919 IN FORM_BROWSER_FORM
*Form
,
924 FORM_EXPRESSION
*Expression
;
926 Link
= GetFirstNode (&Form
->ExpressionListHead
);
927 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
928 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
930 if (Expression
->Type
== EFI_HII_EXPRESSION_RULE
&& Expression
->RuleId
== RuleId
) {
934 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
942 Locate the Unicode Collation Protocol interface for later use.
944 @retval EFI_SUCCESS Protocol interface initialize success.
945 @retval Other Protocol interface initialize failed.
949 InitializeUnicodeCollationProtocol (
955 if (mUnicodeCollation
!= NULL
) {
960 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
961 // instances first and then select one which support English language.
962 // Current implementation just pick the first instance.
964 Status
= gBS
->LocateProtocol (
965 &gEfiUnicodeCollation2ProtocolGuid
,
967 (VOID
**) &mUnicodeCollation
973 Convert the input Unicode character to upper.
975 @param String Th Unicode character to be converted.
983 while (*String
!= 0) {
984 if ((*String
>= 'a') && (*String
<= 'z')) {
985 *String
= (UINT16
) ((*String
) & ((UINT16
) ~0x20));
992 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
994 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
995 EFI_IFR_TYPE_BUFFER when do the value compare.
997 @param Value Expression value to compare on.
999 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1000 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1005 IN EFI_HII_VALUE
*Value
1008 switch (Value
->Type
) {
1009 case EFI_IFR_TYPE_BUFFER
:
1010 case EFI_IFR_TYPE_DATE
:
1011 case EFI_IFR_TYPE_TIME
:
1012 case EFI_IFR_TYPE_REF
:
1021 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
1023 @param Value Expression value to compare on.
1025 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1026 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1031 IN EFI_HII_VALUE
*Value
1034 switch (Value
->Type
) {
1035 case EFI_IFR_TYPE_NUM_SIZE_8
:
1036 case EFI_IFR_TYPE_NUM_SIZE_16
:
1037 case EFI_IFR_TYPE_NUM_SIZE_32
:
1038 case EFI_IFR_TYPE_NUM_SIZE_64
:
1039 case EFI_IFR_TYPE_BOOLEAN
:
1048 Return the buffer length for this value.
1050 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1051 EFI_IFR_TYPE_BUFFER when do the value compare.
1053 @param Value Expression value to compare on.
1055 @retval BufLen Return the buffer length.
1060 IN EFI_HII_VALUE
*Value
1063 switch (Value
->Type
) {
1064 case EFI_IFR_TYPE_BUFFER
:
1065 return Value
->BufferLen
;
1067 case EFI_IFR_TYPE_DATE
:
1068 return (UINT16
) sizeof (EFI_HII_DATE
);
1070 case EFI_IFR_TYPE_TIME
:
1071 return (UINT16
) sizeof (EFI_HII_TIME
);
1073 case EFI_IFR_TYPE_REF
:
1074 return (UINT16
) sizeof (EFI_HII_REF
);
1082 Return the buffer pointer for this value.
1084 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1085 EFI_IFR_TYPE_BUFFER when do the value compare.
1087 @param Value Expression value to compare on.
1089 @retval Buf Return the buffer pointer.
1094 IN EFI_HII_VALUE
*Value
1097 switch (Value
->Type
) {
1098 case EFI_IFR_TYPE_BUFFER
:
1099 return Value
->Buffer
;
1101 case EFI_IFR_TYPE_DATE
:
1102 return (UINT8
*) (&Value
->Value
.date
);
1104 case EFI_IFR_TYPE_TIME
:
1105 return (UINT8
*) (&Value
->Value
.time
);
1107 case EFI_IFR_TYPE_REF
:
1108 return (UINT8
*) (&Value
->Value
.ref
);
1116 Evaluate opcode EFI_IFR_TO_STRING.
1118 @param FormSet Formset which contains this opcode.
1119 @param Format String format in EFI_IFR_TO_STRING.
1120 @param Result Evaluation result for this opcode.
1122 @retval EFI_SUCCESS Opcode evaluation success.
1123 @retval Other Opcode evaluation failed.
1128 IN FORM_BROWSER_FORMSET
*FormSet
,
1130 OUT EFI_HII_VALUE
*Result
1134 EFI_HII_VALUE Value
;
1136 CHAR16
*PrintFormat
;
1137 CHAR16 Buffer
[MAXIMUM_VALUE_CHARACTERS
];
1143 Status
= PopExpression (&Value
);
1144 if (EFI_ERROR (Status
)) {
1148 switch (Value
.Type
) {
1149 case EFI_IFR_TYPE_NUM_SIZE_8
:
1150 case EFI_IFR_TYPE_NUM_SIZE_16
:
1151 case EFI_IFR_TYPE_NUM_SIZE_32
:
1152 case EFI_IFR_TYPE_NUM_SIZE_64
:
1153 BufferSize
= MAXIMUM_VALUE_CHARACTERS
* sizeof (CHAR16
);
1155 case EFI_IFR_STRING_UNSIGNED_DEC
:
1156 case EFI_IFR_STRING_SIGNED_DEC
:
1157 PrintFormat
= L
"%ld";
1160 case EFI_IFR_STRING_LOWERCASE_HEX
:
1161 PrintFormat
= L
"%lx";
1164 case EFI_IFR_STRING_UPPERCASE_HEX
:
1165 PrintFormat
= L
"%lX";
1169 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1172 UnicodeSPrint (Buffer
, BufferSize
, PrintFormat
, Value
.Value
.u64
);
1176 case EFI_IFR_TYPE_STRING
:
1177 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1180 case EFI_IFR_TYPE_BOOLEAN
:
1181 String
= (Value
.Value
.b
) ? L
"True" : L
"False";
1184 case EFI_IFR_TYPE_BUFFER
:
1185 case EFI_IFR_TYPE_DATE
:
1186 case EFI_IFR_TYPE_TIME
:
1187 case EFI_IFR_TYPE_REF
:
1189 // + 3 is base on the unicode format, the length may be odd number,
1190 // so need 1 byte to align, also need 2 bytes for L'\0'.
1192 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1193 SrcLen
= Value
.BufferLen
;
1194 SrcBuf
= Value
.Buffer
;
1196 SrcBuf
= GetBufferForValue(&Value
);
1197 SrcLen
= GetLengthForValue(&Value
);
1200 TmpBuf
= AllocateZeroPool (SrcLen
+ 3);
1201 ASSERT (TmpBuf
!= NULL
);
1202 if (Format
== EFI_IFR_STRING_ASCII
) {
1203 CopyMem (TmpBuf
, SrcBuf
, SrcLen
);
1204 PrintFormat
= L
"%a";
1206 // Format == EFI_IFR_STRING_UNICODE
1207 CopyMem (TmpBuf
, SrcBuf
, SrcLen
* sizeof (CHAR16
));
1208 PrintFormat
= L
"%s";
1210 UnicodeSPrint (Buffer
, sizeof (Buffer
), PrintFormat
, TmpBuf
);
1213 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1214 FreePool (Value
.Buffer
);
1219 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1223 Result
->Type
= EFI_IFR_TYPE_STRING
;
1224 Result
->Value
.string
= NewString (String
, FormSet
->HiiHandle
);
1230 Evaluate opcode EFI_IFR_TO_UINT.
1232 @param FormSet Formset which contains this opcode.
1233 @param Result Evaluation result for this opcode.
1235 @retval EFI_SUCCESS Opcode evaluation success.
1236 @retval Other Opcode evaluation failed.
1241 IN FORM_BROWSER_FORMSET
*FormSet
,
1242 OUT EFI_HII_VALUE
*Result
1246 EFI_HII_VALUE Value
;
1250 Status
= PopExpression (&Value
);
1251 if (EFI_ERROR (Status
)) {
1255 if (Value
.Type
>= EFI_IFR_TYPE_OTHER
&& !IsTypeInBuffer(&Value
)) {
1256 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1260 Status
= EFI_SUCCESS
;
1261 if (Value
.Type
== EFI_IFR_TYPE_STRING
) {
1262 String
= GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1263 if (String
== NULL
) {
1264 return EFI_NOT_FOUND
;
1267 IfrStrToUpper (String
);
1268 StringPtr
= StrStr (String
, L
"0X");
1269 if (StringPtr
!= NULL
) {
1273 Result
->Value
.u64
= StrHexToUint64 (String
);
1278 Result
->Value
.u64
= StrDecimalToUint64 (String
);
1281 } else if (IsTypeInBuffer(&Value
)) {
1282 if (GetLengthForValue (&Value
) > 8) {
1283 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1284 FreePool (Value
.Buffer
);
1286 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1289 Result
->Value
.u64
= *(UINT64
*) GetBufferForValue (&Value
);
1290 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1291 FreePool (Value
.Buffer
);
1294 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1297 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1303 Evaluate opcode EFI_IFR_CATENATE.
1305 @param FormSet Formset which contains this opcode.
1306 @param Result Evaluation result for this opcode.
1308 @retval EFI_SUCCESS Opcode evaluation success.
1309 @retval Other Opcode evaluation failed.
1314 IN FORM_BROWSER_FORMSET
*FormSet
,
1315 OUT EFI_HII_VALUE
*Result
1319 EFI_HII_VALUE Value
[2];
1328 // String[0] - The second string
1329 // String[1] - The first string
1334 Status
= EFI_SUCCESS
;
1335 ZeroMem (Value
, sizeof (Value
));
1337 Status
= PopExpression (&Value
[0]);
1338 if (EFI_ERROR (Status
)) {
1342 Status
= PopExpression (&Value
[1]);
1343 if (EFI_ERROR (Status
)) {
1347 for (Index
= 0; Index
< 2; Index
++) {
1348 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[Index
])) {
1349 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1350 Status
= EFI_SUCCESS
;
1354 if (Value
[Index
].Type
== EFI_IFR_TYPE_STRING
) {
1355 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1356 if (String
[Index
] == NULL
) {
1357 Status
= EFI_NOT_FOUND
;
1363 if (Value
[0].Type
== EFI_IFR_TYPE_STRING
) {
1364 Size
= StrSize (String
[0]);
1365 StringPtr
= AllocatePool (StrSize (String
[1]) + Size
);
1366 ASSERT (StringPtr
!= NULL
);
1367 StrCpy (StringPtr
, String
[1]);
1368 StrCat (StringPtr
, String
[0]);
1370 Result
->Type
= EFI_IFR_TYPE_STRING
;
1371 Result
->Value
.string
= NewString (StringPtr
, FormSet
->HiiHandle
);
1373 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1374 Length0
= GetLengthForValue(&Value
[0]);
1375 Length1
= GetLengthForValue(&Value
[1]);
1376 Result
->BufferLen
= (UINT16
) (Length0
+ Length1
);
1378 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1379 ASSERT (Result
->Buffer
!= NULL
);
1381 CopyMem (Result
->Buffer
, GetBufferForValue(&Value
[0]), Length0
);
1382 CopyMem (&Result
->Buffer
[Length0
], GetBufferForValue(&Value
[1]), Length1
);
1385 if (Value
[0].Buffer
!= NULL
) {
1386 FreePool (Value
[0].Buffer
);
1388 if (Value
[1].Buffer
!= NULL
) {
1389 FreePool (Value
[1].Buffer
);
1391 if (String
[0] != NULL
) {
1392 FreePool (String
[0]);
1394 if (String
[1] != NULL
) {
1395 FreePool (String
[1]);
1397 if (StringPtr
!= NULL
) {
1398 FreePool (StringPtr
);
1406 Evaluate opcode EFI_IFR_MATCH.
1408 @param FormSet Formset which contains this opcode.
1409 @param Result Evaluation result for this opcode.
1411 @retval EFI_SUCCESS Opcode evaluation success.
1412 @retval Other Opcode evaluation failed.
1417 IN FORM_BROWSER_FORMSET
*FormSet
,
1418 OUT EFI_HII_VALUE
*Result
1422 EFI_HII_VALUE Value
[2];
1427 // String[0] - The string to search
1428 // String[1] - pattern
1432 Status
= EFI_SUCCESS
;
1433 ZeroMem (Value
, sizeof (Value
));
1435 Status
= PopExpression (&Value
[0]);
1436 if (EFI_ERROR (Status
)) {
1440 Status
= PopExpression (&Value
[1]);
1441 if (EFI_ERROR (Status
)) {
1445 for (Index
= 0; Index
< 2; Index
++) {
1446 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1447 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1448 Status
= EFI_SUCCESS
;
1452 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1453 if (String
[Index
] == NULL
) {
1454 Status
= EFI_NOT_FOUND
;
1459 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1460 Result
->Value
.b
= mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
[0], String
[1]);
1463 if (String
[0] != NULL
) {
1464 FreePool (String
[0]);
1466 if (String
[1] != NULL
) {
1467 FreePool (String
[1]);
1475 Evaluate opcode EFI_IFR_FIND.
1477 @param FormSet Formset which contains this opcode.
1478 @param Format Case sensitive or insensitive.
1479 @param Result Evaluation result for this opcode.
1481 @retval EFI_SUCCESS Opcode evaluation success.
1482 @retval Other Opcode evaluation failed.
1487 IN FORM_BROWSER_FORMSET
*FormSet
,
1489 OUT EFI_HII_VALUE
*Result
1493 EFI_HII_VALUE Value
[3];
1499 ZeroMem (Value
, sizeof (Value
));
1501 if (Format
> EFI_IFR_FF_CASE_INSENSITIVE
) {
1502 return EFI_INVALID_PARAMETER
;
1505 Status
= PopExpression (&Value
[0]);
1506 if (EFI_ERROR (Status
)) {
1510 Status
= PopExpression (&Value
[1]);
1511 if (EFI_ERROR (Status
)) {
1515 Status
= PopExpression (&Value
[2]);
1516 if (EFI_ERROR (Status
)) {
1520 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1521 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1524 Base
= (UINTN
) Value
[0].Value
.u64
;
1527 // String[0] - sub-string
1528 // String[1] - The string to search
1532 for (Index
= 0; Index
< 2; Index
++) {
1533 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1534 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1535 Status
= EFI_SUCCESS
;
1539 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1540 if (String
[Index
] == NULL
) {
1541 Status
= EFI_NOT_FOUND
;
1545 if (Format
== EFI_IFR_FF_CASE_INSENSITIVE
) {
1547 // Case insensitive, convert both string to upper case
1549 IfrStrToUpper (String
[Index
]);
1553 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1554 if (Base
>= StrLen (String
[1])) {
1555 Result
->Value
.u64
= 0xFFFFFFFFFFFFFFFFULL
;
1557 StringPtr
= StrStr (String
[1] + Base
, String
[0]);
1558 Result
->Value
.u64
= (StringPtr
== NULL
) ? 0xFFFFFFFFFFFFFFFFULL
: (StringPtr
- String
[1]);
1562 if (String
[0] != NULL
) {
1563 FreePool (String
[0]);
1565 if (String
[1] != NULL
) {
1566 FreePool (String
[1]);
1574 Evaluate opcode EFI_IFR_MID.
1576 @param FormSet Formset which contains this opcode.
1577 @param Result Evaluation result for this opcode.
1579 @retval EFI_SUCCESS Opcode evaluation success.
1580 @retval Other Opcode evaluation failed.
1585 IN FORM_BROWSER_FORMSET
*FormSet
,
1586 OUT EFI_HII_VALUE
*Result
1590 EFI_HII_VALUE Value
[3];
1598 ZeroMem (Value
, sizeof (Value
));
1600 Status
= PopExpression (&Value
[0]);
1601 if (EFI_ERROR (Status
)) {
1605 Status
= PopExpression (&Value
[1]);
1606 if (EFI_ERROR (Status
)) {
1610 Status
= PopExpression (&Value
[2]);
1611 if (EFI_ERROR (Status
)) {
1615 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1616 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1619 Length
= (UINTN
) Value
[0].Value
.u64
;
1621 if (Value
[1].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1622 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1625 Base
= (UINTN
) Value
[1].Value
.u64
;
1627 if (Value
[2].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[2])) {
1628 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1631 if (Value
[2].Type
== EFI_IFR_TYPE_STRING
) {
1632 String
= GetToken (Value
[2].Value
.string
, FormSet
->HiiHandle
);
1633 if (String
== NULL
) {
1634 return EFI_NOT_FOUND
;
1637 if (Length
== 0 || Base
>= StrLen (String
)) {
1638 SubString
= gEmptyString
;
1640 SubString
= String
+ Base
;
1641 if ((Base
+ Length
) < StrLen (String
)) {
1642 SubString
[Length
] = L
'\0';
1646 Result
->Type
= EFI_IFR_TYPE_STRING
;
1647 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1651 BufferLen
= GetLengthForValue (&Value
[2]);
1652 Buffer
= GetBufferForValue (&Value
[2]);
1654 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1655 if (Length
== 0 || Base
>= BufferLen
) {
1656 Result
->BufferLen
= 0;
1657 Result
->Buffer
= NULL
;
1659 Result
->BufferLen
= (UINT16
)((BufferLen
- Base
) < Length
? (BufferLen
- Base
) : Length
);
1660 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1661 ASSERT (Result
->Buffer
!= NULL
);
1662 CopyMem (Result
->Buffer
, &Buffer
[Base
], Result
->BufferLen
);
1665 if (Value
[2].Type
== EFI_IFR_TYPE_BUFFER
) {
1666 FreePool (Value
[2].Buffer
);
1675 Evaluate opcode EFI_IFR_TOKEN.
1677 @param FormSet Formset which contains this opcode.
1678 @param Result Evaluation result for this opcode.
1680 @retval EFI_SUCCESS Opcode evaluation success.
1681 @retval Other Opcode evaluation failed.
1686 IN FORM_BROWSER_FORMSET
*FormSet
,
1687 OUT EFI_HII_VALUE
*Result
1691 EFI_HII_VALUE Value
[3];
1699 ZeroMem (Value
, sizeof (Value
));
1701 Status
= PopExpression (&Value
[0]);
1702 if (EFI_ERROR (Status
)) {
1706 Status
= PopExpression (&Value
[1]);
1707 if (EFI_ERROR (Status
)) {
1711 Status
= PopExpression (&Value
[2]);
1712 if (EFI_ERROR (Status
)) {
1716 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1717 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1720 Count
= (UINTN
) Value
[0].Value
.u64
;
1723 // String[0] - Delimiter
1724 // String[1] - The string to search
1728 for (Index
= 0; Index
< 2; Index
++) {
1729 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1730 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1731 Status
= EFI_SUCCESS
;
1735 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1736 if (String
[Index
] == NULL
) {
1737 Status
= EFI_NOT_FOUND
;
1742 Delimiter
= String
[0];
1743 SubString
= String
[1];
1745 SubString
= StrStr (SubString
, Delimiter
);
1746 if (SubString
!= NULL
) {
1748 // Skip over the delimiter
1750 SubString
= SubString
+ StrLen (Delimiter
);
1757 if (SubString
== NULL
) {
1759 // nth delimited sub-string not found, push an empty string
1761 SubString
= gEmptyString
;
1764 // Put a NULL terminator for nth delimited sub-string
1766 StringPtr
= StrStr (SubString
, Delimiter
);
1767 if (StringPtr
!= NULL
) {
1772 Result
->Type
= EFI_IFR_TYPE_STRING
;
1773 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1776 if (String
[0] != NULL
) {
1777 FreePool (String
[0]);
1779 if (String
[1] != NULL
) {
1780 FreePool (String
[1]);
1788 Evaluate opcode EFI_IFR_SPAN.
1790 @param FormSet Formset which contains this opcode.
1791 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1792 @param Result Evaluation result for this opcode.
1794 @retval EFI_SUCCESS Opcode evaluation success.
1795 @retval Other Opcode evaluation failed.
1800 IN FORM_BROWSER_FORMSET
*FormSet
,
1802 OUT EFI_HII_VALUE
*Result
1806 EFI_HII_VALUE Value
[3];
1814 ZeroMem (Value
, sizeof (Value
));
1816 Status
= PopExpression (&Value
[0]);
1817 if (EFI_ERROR (Status
)) {
1821 Status
= PopExpression (&Value
[1]);
1822 if (EFI_ERROR (Status
)) {
1826 Status
= PopExpression (&Value
[2]);
1827 if (EFI_ERROR (Status
)) {
1831 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1832 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1835 Base
= (UINTN
) Value
[0].Value
.u64
;
1838 // String[0] - Charset
1839 // String[1] - The string to search
1843 for (Index
= 0; Index
< 2; Index
++) {
1844 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1845 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1846 Status
= EFI_SUCCESS
;
1850 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1851 if (String
[Index
] == NULL
) {
1852 Status
= EFI_NOT_FOUND
;
1857 if (Base
>= StrLen (String
[1])) {
1858 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1859 Status
= EFI_SUCCESS
;
1864 StringPtr
= String
[1] + Base
;
1865 Charset
= String
[0];
1866 while (*StringPtr
!= 0 && !Found
) {
1868 while (Charset
[Index
] != 0) {
1869 if (*StringPtr
>= Charset
[Index
] && *StringPtr
<= Charset
[Index
+ 1]) {
1870 if (Flags
== EFI_IFR_FLAGS_FIRST_MATCHING
) {
1875 if (Flags
== EFI_IFR_FLAGS_FIRST_NON_MATCHING
) {
1881 // Skip characters pair representing low-end of a range and high-end of a range
1891 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1892 Result
->Value
.u64
= StringPtr
- String
[1];
1895 if (String
[0] != NULL
) {
1896 FreePool (String
[0]);
1898 if (String
[1] != NULL
) {
1899 FreePool (String
[1]);
1907 Zero extend integer/boolean/date/time to UINT64 for comparing.
1909 @param Value HII Value to be converted.
1914 IN EFI_HII_VALUE
*Value
1920 switch (Value
->Type
) {
1921 case EFI_IFR_TYPE_NUM_SIZE_8
:
1922 Temp
= Value
->Value
.u8
;
1925 case EFI_IFR_TYPE_NUM_SIZE_16
:
1926 Temp
= Value
->Value
.u16
;
1929 case EFI_IFR_TYPE_NUM_SIZE_32
:
1930 Temp
= Value
->Value
.u32
;
1933 case EFI_IFR_TYPE_BOOLEAN
:
1934 Temp
= Value
->Value
.b
;
1937 case EFI_IFR_TYPE_TIME
:
1938 Temp
= Value
->Value
.u32
& 0xffffff;
1941 case EFI_IFR_TYPE_DATE
:
1942 Temp
= Value
->Value
.u32
;
1949 Value
->Value
.u64
= Temp
;
1953 Get UINT64 type value.
1955 @param Value Input Hii value.
1957 @retval UINT64 Return the UINT64 type value.
1962 IN EFI_HII_VALUE
*Value
1969 switch (Value
->Type
) {
1970 case EFI_IFR_TYPE_NUM_SIZE_8
:
1971 RetVal
= Value
->Value
.u8
;
1974 case EFI_IFR_TYPE_NUM_SIZE_16
:
1975 RetVal
= Value
->Value
.u16
;
1978 case EFI_IFR_TYPE_NUM_SIZE_32
:
1979 RetVal
= Value
->Value
.u32
;
1982 case EFI_IFR_TYPE_BOOLEAN
:
1983 RetVal
= Value
->Value
.b
;
1986 case EFI_IFR_TYPE_DATE
:
1987 RetVal
= *(UINT64
*) &Value
->Value
.date
;
1990 case EFI_IFR_TYPE_TIME
:
1991 RetVal
= (*(UINT64
*) &Value
->Value
.time
) & 0xffffff;
1995 RetVal
= Value
->Value
.u64
;
2003 Compare two Hii value.
2005 @param Value1 Expression value to compare on left-hand.
2006 @param Value2 Expression value to compare on right-hand.
2007 @param Result Return value after compare.
2008 retval 0 Two operators equal.
2009 return Positive value if Value1 is greater than Value2.
2010 retval Negative value if Value1 is less than Value2.
2011 @param HiiHandle Only required for string compare.
2013 @retval other Could not perform compare on two values.
2014 @retval EFI_SUCCESS Compare the value success.
2019 IN EFI_HII_VALUE
*Value1
,
2020 IN EFI_HII_VALUE
*Value2
,
2022 IN EFI_HII_HANDLE HiiHandle OPTIONAL
2034 if (Value1
->Type
== EFI_IFR_TYPE_STRING
&& Value2
->Type
== EFI_IFR_TYPE_STRING
) {
2035 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
2037 // StringId 0 is reserved
2039 return EFI_INVALID_PARAMETER
;
2042 if (Value1
->Value
.string
== Value2
->Value
.string
) {
2047 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
2052 return EFI_NOT_FOUND
;
2055 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
2058 return EFI_NOT_FOUND
;
2061 *Result
= StrCmp (Str1
, Str2
);
2070 // Take types(date, time, ref, buffer) as buffer
2072 if (IsTypeInBuffer(Value1
) && IsTypeInBuffer(Value2
)) {
2073 Buf1
= GetBufferForValue(Value1
);
2074 Buf1Len
= GetLengthForValue(Value1
);
2075 Buf2
= GetBufferForValue(Value2
);
2076 Buf2Len
= GetLengthForValue(Value2
);
2078 Len
= Buf1Len
> Buf2Len
? Buf2Len
: Buf1Len
;
2079 *Result
= CompareMem (Buf1
, Buf2
, Len
);
2080 if ((*Result
== 0) && (Buf1Len
!= Buf2Len
)) {
2082 // In this case, means base on samll number buffer, the data is same
2083 // So which value has more data, which value is bigger.
2085 *Result
= Buf1Len
> Buf2Len
? 1 : -1;
2091 // Take types(integer, boolean) as integer
2093 if (IsTypeInUINT64(Value1
) && IsTypeInUINT64(Value2
)) {
2094 Temp64
= HiiValueToUINT64(Value1
) - HiiValueToUINT64(Value2
);
2097 } else if (Temp64
< 0) {
2106 return EFI_UNSUPPORTED
;
2110 Check if current user has the privilege specified by the permissions GUID.
2112 @param[in] Guid A GUID specifying setup access permissions.
2114 @retval TRUE Current user has the privilege.
2115 @retval FALSE Current user does not have the privilege.
2118 CheckUserPrivilege (
2123 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
2124 EFI_USER_INFO_HANDLE UserInfoHandle
;
2125 EFI_USER_INFO
*UserInfo
;
2126 EFI_GUID
*UserPermissionsGuid
;
2128 UINTN AccessControlDataSize
;
2129 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
2132 if (mUserManager
== NULL
) {
2133 Status
= gBS
->LocateProtocol (
2134 &gEfiUserManagerProtocolGuid
,
2136 (VOID
**) &mUserManager
2138 if (EFI_ERROR (Status
)) {
2140 /// If the system does not support user management, then it is assumed that
2141 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
2142 /// op-code is always TRUE.
2148 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
2149 ASSERT_EFI_ERROR (Status
);
2152 /// Enumerate all user information of the current user profile
2153 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
2156 for (UserInfoHandle
= NULL
;;) {
2157 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
2158 if (EFI_ERROR (Status
)) {
2163 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
2164 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2168 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
2169 if (UserInfo
== NULL
) {
2173 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
2174 if (EFI_ERROR (Status
) ||
2175 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
2176 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
2177 FreePool (UserInfo
);
2181 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
2182 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
2183 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2184 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2187 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
2189 /// Check if current user has the privilege specified by the permissions GUID.
2192 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
2193 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
2194 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
2195 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
2196 FreePool (UserInfo
);
2199 UserPermissionsGuid
++;
2200 AccessControlDataSize
-= sizeof (EFI_GUID
);
2203 RemainSize
-= AccessControl
->Size
;
2204 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
2207 FreePool (UserInfo
);
2213 Get question value from the predefined formset.
2215 @param DevicePath The driver's device path which produece the formset data.
2216 @param InputHiiHandle The hii handle associate with the formset data.
2217 @param FormSetGuid The formset guid which include the question.
2218 @param QuestionId The question id which need to get value from.
2219 @param Value The return data about question's value.
2221 @retval TRUE Get the question value success.
2222 @retval FALSE Get the question value failed.
2225 GetQuestionValueFromForm (
2226 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2227 IN EFI_HII_HANDLE InputHiiHandle
,
2228 IN EFI_GUID
*FormSetGuid
,
2229 IN EFI_QUESTION_ID QuestionId
,
2230 OUT EFI_HII_VALUE
*Value
2234 EFI_HII_HANDLE HiiHandle
;
2235 FORM_BROWSER_STATEMENT
*Question
;
2236 FORM_BROWSER_FORMSET
*FormSet
;
2237 FORM_BROWSER_FORM
*Form
;
2242 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2244 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
2245 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
2255 if (DevicePath
!= NULL
) {
2256 HiiHandle
= DevicePathToHiiHandle (DevicePath
, FormSetGuid
);
2257 if (HiiHandle
== NULL
) {
2261 HiiHandle
= InputHiiHandle
;
2263 ASSERT (HiiHandle
!= NULL
);
2266 // Get the formset data include this question.
2268 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2269 ASSERT (FormSet
!= NULL
);
2270 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
);
2271 if (EFI_ERROR (Status
)) {
2277 // Base on the Question Id to get the question info.
2279 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2280 if (Question
== NULL
) {
2286 // Search form in the formset scope
2288 Link
= GetFirstNode (&FormSet
->FormListHead
);
2289 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2290 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2292 Question
= IdToQuestion2 (Form
, QuestionId
);
2293 if (Question
!= NULL
) {
2297 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2300 ASSERT (Form
!= NULL
);
2303 // Get the question value.
2305 Status
= GetQuestionValue(FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
2306 if (EFI_ERROR (Status
)) {
2311 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2315 // Clean the formset structure and restore the global parameter.
2317 if (FormSet
!= NULL
) {
2318 DestroyFormSet (FormSet
);
2325 Evaluate the result of a HII expression.
2327 If Expression is NULL, then ASSERT.
2329 @param FormSet FormSet associated with this expression.
2330 @param Form Form associated with this expression.
2331 @param Expression Expression to be evaluated.
2333 @retval EFI_SUCCESS The expression evaluated successfuly
2334 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2336 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2338 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2339 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2343 EvaluateExpression (
2344 IN FORM_BROWSER_FORMSET
*FormSet
,
2345 IN FORM_BROWSER_FORM
*Form
,
2346 IN OUT FORM_EXPRESSION
*Expression
2351 EXPRESSION_OPCODE
*OpCode
;
2352 FORM_BROWSER_STATEMENT
*Question
;
2353 FORM_BROWSER_STATEMENT
*Question2
;
2355 EFI_HII_VALUE Data1
;
2356 EFI_HII_VALUE Data2
;
2357 EFI_HII_VALUE Data3
;
2358 FORM_EXPRESSION
*RuleExpression
;
2359 EFI_HII_VALUE
*Value
;
2364 LIST_ENTRY
*SubExpressionLink
;
2365 FORM_EXPRESSION
*SubExpression
;
2372 EFI_HII_VALUE QuestionVal
;
2373 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2376 // Save current stack offset.
2378 StackOffset
= SaveExpressionEvaluationStackOffset ();
2380 ASSERT (Expression
!= NULL
);
2381 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2383 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2384 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2385 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2387 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2389 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2390 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2391 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2394 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2395 Status
= EFI_SUCCESS
;
2397 switch (OpCode
->Operand
) {
2399 // Built-in functions
2401 case EFI_IFR_EQ_ID_VAL_OP
:
2402 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2403 if (Question
== NULL
) {
2404 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2408 Status
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, &Result
, NULL
);
2409 if (Status
== EFI_UNSUPPORTED
) {
2410 Status
= EFI_SUCCESS
;
2411 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2415 if (EFI_ERROR (Status
)) {
2418 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2421 case EFI_IFR_EQ_ID_ID_OP
:
2422 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2423 if (Question
== NULL
) {
2424 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2428 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2429 if (Question2
== NULL
) {
2430 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2434 Status
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, &Result
, FormSet
->HiiHandle
);
2435 if (Status
== EFI_UNSUPPORTED
) {
2436 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2437 Status
= EFI_SUCCESS
;
2440 if (EFI_ERROR (Status
)) {
2443 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2446 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2447 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2448 if (Question
== NULL
) {
2449 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2453 Value
->Value
.b
= FALSE
;
2454 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2455 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2456 Value
->Value
.b
= TRUE
;
2462 case EFI_IFR_DUP_OP
:
2463 Status
= PopExpression (Value
);
2464 if (EFI_ERROR (Status
)) {
2468 Status
= PushExpression (Value
);
2471 case EFI_IFR_QUESTION_REF1_OP
:
2472 case EFI_IFR_THIS_OP
:
2473 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2474 if (Question
== NULL
) {
2475 Status
= EFI_NOT_FOUND
;
2479 Value
= &Question
->HiiValue
;
2482 case EFI_IFR_SECURITY_OP
:
2483 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2486 case EFI_IFR_GET_OP
:
2488 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2490 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2491 Value
->Value
.u8
= 0;
2492 if (OpCode
->VarStorage
!= NULL
) {
2493 switch (OpCode
->VarStorage
->Type
) {
2494 case EFI_HII_VARSTORE_BUFFER
:
2495 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2497 // Get value from Edit Buffer
2499 Value
->Type
= OpCode
->ValueType
;
2500 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2502 case EFI_HII_VARSTORE_NAME_VALUE
:
2503 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2505 // Get value from string except for STRING value.
2507 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
, GetSetValueWithEditBuffer
);
2508 if (!EFI_ERROR (Status
)) {
2509 ASSERT (StrPtr
!= NULL
);
2510 TempLength
= StrLen (StrPtr
);
2511 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2512 Value
->Type
= OpCode
->ValueType
;
2513 TempBuffer
= (UINT8
*) &Value
->Value
;
2514 ZeroMem (TempStr
, sizeof (TempStr
));
2515 for (Index
= 0; Index
< TempLength
; Index
++) {
2516 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2517 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2518 if ((Index
& 1) == 0) {
2519 TempBuffer
[Index
/2] = DigitUint8
;
2521 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2528 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2530 // Get value from variable.
2532 TempLength
= OpCode
->ValueWidth
;
2533 Value
->Type
= OpCode
->ValueType
;
2534 Status
= gRT
->GetVariable (
2536 &OpCode
->VarStorage
->Guid
,
2541 if (EFI_ERROR (Status
)) {
2542 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2543 Value
->Value
.u8
= 0;
2548 // Not recognize storage.
2550 Status
= EFI_UNSUPPORTED
;
2555 // For Time/Date Data
2557 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2559 // Only support Data/Time data when storage doesn't exist.
2561 Status
= EFI_UNSUPPORTED
;
2564 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2565 if (!EFI_ERROR (Status
)) {
2566 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2567 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2569 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2570 Value
->Value
.u16
= EfiTime
.Year
;
2573 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2574 Value
->Value
.u8
= EfiTime
.Month
;
2577 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2578 Value
->Value
.u8
= EfiTime
.Day
;
2582 // Invalid Date field.
2584 Status
= EFI_INVALID_PARAMETER
;
2588 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2590 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2591 Value
->Value
.u8
= EfiTime
.Hour
;
2594 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2595 Value
->Value
.u8
= EfiTime
.Minute
;
2598 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2599 Value
->Value
.u8
= EfiTime
.Second
;
2603 // Invalid Time field.
2605 Status
= EFI_INVALID_PARAMETER
;
2614 case EFI_IFR_QUESTION_REF3_OP
:
2616 // EFI_IFR_QUESTION_REF3
2617 // Pop an expression from the expression stack
2619 Status
= PopExpression (Value
);
2620 if (EFI_ERROR (Status
)) {
2625 // Validate the expression value
2627 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2628 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2632 if (OpCode
->DevicePath
!= 0) {
2633 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2635 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2636 if (StrPtr
!= NULL
&& mPathFromText
!= NULL
) {
2637 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StrPtr
);
2638 if (DevicePath
!= NULL
&& GetQuestionValueFromForm(DevicePath
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)) {
2639 Value
= &QuestionVal
;
2641 if (DevicePath
!= NULL
) {
2642 FreePool (DevicePath
);
2646 if (StrPtr
!= NULL
) {
2649 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2650 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2651 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2654 Value
= &QuestionVal
;
2656 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2657 if (Question
== NULL
) {
2658 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2663 // push the questions' value on to the expression stack
2665 Value
= &Question
->HiiValue
;
2669 case EFI_IFR_RULE_REF_OP
:
2671 // Find expression for this rule
2673 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2674 if (RuleExpression
== NULL
) {
2675 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2680 // Evaluate this rule expression
2682 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2683 if (EFI_ERROR (Status
) || RuleExpression
->Result
.Type
== EFI_IFR_TYPE_UNDEFINED
) {
2684 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2688 Value
= &RuleExpression
->Result
;
2691 case EFI_IFR_STRING_REF1_OP
:
2692 Value
->Type
= EFI_IFR_TYPE_STRING
;
2693 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2699 case EFI_IFR_TRUE_OP
:
2700 case EFI_IFR_FALSE_OP
:
2701 case EFI_IFR_ONE_OP
:
2702 case EFI_IFR_ONES_OP
:
2703 case EFI_IFR_UINT8_OP
:
2704 case EFI_IFR_UINT16_OP
:
2705 case EFI_IFR_UINT32_OP
:
2706 case EFI_IFR_UINT64_OP
:
2707 case EFI_IFR_UNDEFINED_OP
:
2708 case EFI_IFR_VERSION_OP
:
2709 case EFI_IFR_ZERO_OP
:
2710 Value
= &OpCode
->Value
;
2716 case EFI_IFR_LENGTH_OP
:
2717 Status
= PopExpression (Value
);
2718 if (EFI_ERROR (Status
)) {
2721 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer (Value
)) {
2722 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2726 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2727 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2728 if (StrPtr
== NULL
) {
2729 Status
= EFI_INVALID_PARAMETER
;
2733 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2734 Value
->Value
.u64
= StrLen (StrPtr
);
2737 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2738 Value
->Value
.u64
= GetLengthForValue(Value
);
2739 FreePool (Value
->Buffer
);
2743 case EFI_IFR_NOT_OP
:
2744 Status
= PopExpression (Value
);
2745 if (EFI_ERROR (Status
)) {
2748 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2749 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2752 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2755 case EFI_IFR_QUESTION_REF2_OP
:
2757 // Pop an expression from the expression stack
2759 Status
= PopExpression (Value
);
2760 if (EFI_ERROR (Status
)) {
2765 // Validate the expression value
2767 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2768 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2772 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2773 if (Question
== NULL
) {
2774 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2778 Value
= &Question
->HiiValue
;
2781 case EFI_IFR_STRING_REF2_OP
:
2783 // Pop an expression from the expression stack
2785 Status
= PopExpression (Value
);
2786 if (EFI_ERROR (Status
)) {
2791 // Validate the expression value
2793 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2794 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2798 Value
->Type
= EFI_IFR_TYPE_STRING
;
2799 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2800 if (StrPtr
== NULL
) {
2802 // If String not exit, push an empty string
2804 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2806 Index
= (UINT16
) Value
->Value
.u64
;
2807 Value
->Value
.string
= Index
;
2812 case EFI_IFR_TO_BOOLEAN_OP
:
2814 // Pop an expression from the expression stack
2816 Status
= PopExpression (Value
);
2817 if (EFI_ERROR (Status
)) {
2822 // Convert an expression to a Boolean
2824 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
2826 // When converting from an unsigned integer, zero will be converted to
2827 // FALSE and any other value will be converted to TRUE.
2829 Value
->Value
.b
= (BOOLEAN
) (HiiValueToUINT64(Value
) != 0);
2831 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2832 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2834 // When converting from a string, if case-insensitive compare
2835 // with "true" is True, then push True. If a case-insensitive compare
2836 // with "false" is True, then push False. Otherwise, push Undefined.
2838 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2839 if (StrPtr
== NULL
) {
2840 Status
= EFI_INVALID_PARAMETER
;
2844 IfrStrToUpper (StrPtr
);
2845 if (StrCmp (StrPtr
, L
"TRUE") == 0){
2846 Value
->Value
.b
= TRUE
;
2847 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2848 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
2849 Value
->Value
.b
= FALSE
;
2850 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2852 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2855 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
2857 // When converting from a buffer, if the buffer is all zeroes,
2858 // then push False. Otherwise push True.
2860 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
2861 if (Value
->Buffer
[Index
] != 0) {
2866 if (Index
>= Value
->BufferLen
) {
2867 Value
->Value
.b
= FALSE
;
2869 Value
->Value
.b
= TRUE
;
2871 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2872 FreePool (Value
->Buffer
);
2876 case EFI_IFR_TO_STRING_OP
:
2877 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
2880 case EFI_IFR_TO_UINT_OP
:
2881 Status
= IfrToUint (FormSet
, Value
);
2884 case EFI_IFR_TO_LOWER_OP
:
2885 case EFI_IFR_TO_UPPER_OP
:
2886 Status
= InitializeUnicodeCollationProtocol ();
2887 if (EFI_ERROR (Status
)) {
2891 Status
= PopExpression (Value
);
2892 if (EFI_ERROR (Status
)) {
2896 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
2897 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2901 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2902 if (StrPtr
== NULL
) {
2903 Status
= EFI_NOT_FOUND
;
2907 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
2908 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
2910 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
2912 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
2916 case EFI_IFR_BITWISE_NOT_OP
:
2918 // Pop an expression from the expression stack
2920 Status
= PopExpression (Value
);
2921 if (EFI_ERROR (Status
)) {
2924 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
2925 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2929 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2930 Value
->Value
.u64
= ~ HiiValueToUINT64(Value
);
2933 case EFI_IFR_SET_OP
:
2935 // Pop an expression from the expression stack
2937 Status
= PopExpression (Value
);
2938 if (EFI_ERROR (Status
)) {
2941 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
2942 Data1
.Value
.b
= FALSE
;
2944 // Set value to var storage buffer
2946 if (OpCode
->VarStorage
!= NULL
) {
2947 switch (OpCode
->VarStorage
->Type
) {
2948 case EFI_HII_VARSTORE_BUFFER
:
2949 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2950 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
2951 Data1
.Value
.b
= TRUE
;
2953 case EFI_HII_VARSTORE_NAME_VALUE
:
2954 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2955 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
2956 ASSERT (Value
!= NULL
);
2958 // Convert Buffer to Hex String
2960 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
2962 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
2963 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
2965 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, GetSetValueWithEditBuffer
, NULL
);
2966 FreePool (NameValue
);
2967 if (!EFI_ERROR (Status
)) {
2968 Data1
.Value
.b
= TRUE
;
2972 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2973 Status
= gRT
->SetVariable (
2975 &OpCode
->VarStorage
->Guid
,
2976 OpCode
->VarStorage
->Attributes
,
2980 if (!EFI_ERROR (Status
)) {
2981 Data1
.Value
.b
= TRUE
;
2986 // Not recognize storage.
2988 Status
= EFI_UNSUPPORTED
;
2994 // For Time/Date Data
2996 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2998 // Only support Data/Time data when storage doesn't exist.
3000 Status
= EFI_UNSUPPORTED
;
3003 Status
= gRT
->GetTime (&EfiTime
, NULL
);
3004 if (!EFI_ERROR (Status
)) {
3005 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
3006 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3008 EfiTime
.Year
= Value
->Value
.u16
;
3011 EfiTime
.Month
= Value
->Value
.u8
;
3014 EfiTime
.Day
= Value
->Value
.u8
;
3018 // Invalid Date field.
3020 Status
= EFI_INVALID_PARAMETER
;
3024 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3026 EfiTime
.Hour
= Value
->Value
.u8
;
3029 EfiTime
.Minute
= Value
->Value
.u8
;
3032 EfiTime
.Second
= Value
->Value
.u8
;
3036 // Invalid Time field.
3038 Status
= EFI_INVALID_PARAMETER
;
3042 Status
= gRT
->SetTime (&EfiTime
);
3043 if (!EFI_ERROR (Status
)) {
3044 Data1
.Value
.b
= TRUE
;
3054 case EFI_IFR_ADD_OP
:
3055 case EFI_IFR_SUBTRACT_OP
:
3056 case EFI_IFR_MULTIPLY_OP
:
3057 case EFI_IFR_DIVIDE_OP
:
3058 case EFI_IFR_MODULO_OP
:
3059 case EFI_IFR_BITWISE_AND_OP
:
3060 case EFI_IFR_BITWISE_OR_OP
:
3061 case EFI_IFR_SHIFT_LEFT_OP
:
3062 case EFI_IFR_SHIFT_RIGHT_OP
:
3064 // Pop an expression from the expression stack
3066 Status
= PopExpression (&Data2
);
3067 if (EFI_ERROR (Status
)) {
3072 // Pop another expression from the expression stack
3074 Status
= PopExpression (&Data1
);
3075 if (EFI_ERROR (Status
)) {
3079 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
3080 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3085 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
3086 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3090 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
3092 switch (OpCode
->Operand
) {
3093 case EFI_IFR_ADD_OP
:
3094 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) + HiiValueToUINT64(&Data2
);
3097 case EFI_IFR_SUBTRACT_OP
:
3098 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) - HiiValueToUINT64(&Data2
);
3101 case EFI_IFR_MULTIPLY_OP
:
3102 Value
->Value
.u64
= MultU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3105 case EFI_IFR_DIVIDE_OP
:
3106 Value
->Value
.u64
= DivU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3109 case EFI_IFR_MODULO_OP
:
3110 DivU64x32Remainder (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
), &TempValue
);
3111 Value
->Value
.u64
= TempValue
;
3114 case EFI_IFR_BITWISE_AND_OP
:
3115 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) & HiiValueToUINT64(&Data2
);
3118 case EFI_IFR_BITWISE_OR_OP
:
3119 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) | HiiValueToUINT64(&Data2
);
3122 case EFI_IFR_SHIFT_LEFT_OP
:
3123 Value
->Value
.u64
= LShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3126 case EFI_IFR_SHIFT_RIGHT_OP
:
3127 Value
->Value
.u64
= RShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3135 case EFI_IFR_AND_OP
:
3138 // Two Boolean operator
3140 Status
= PopExpression (&Data2
);
3141 if (EFI_ERROR (Status
)) {
3146 // Pop another expression from the expression stack
3148 Status
= PopExpression (&Data1
);
3149 if (EFI_ERROR (Status
)) {
3153 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3154 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3158 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3159 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3163 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
3164 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
3166 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
3170 case EFI_IFR_EQUAL_OP
:
3171 case EFI_IFR_NOT_EQUAL_OP
:
3172 case EFI_IFR_GREATER_EQUAL_OP
:
3173 case EFI_IFR_GREATER_THAN_OP
:
3174 case EFI_IFR_LESS_EQUAL_OP
:
3175 case EFI_IFR_LESS_THAN_OP
:
3177 // Compare two integer, string, boolean or date/time
3179 Status
= PopExpression (&Data2
);
3180 if (EFI_ERROR (Status
)) {
3185 // Pop another expression from the expression stack
3187 Status
= PopExpression (&Data1
);
3188 if (EFI_ERROR (Status
)) {
3192 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3193 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
3194 !IsTypeInBuffer(&Data2
)) {
3195 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3199 if (Data1
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3200 Data1
.Type
!= EFI_IFR_TYPE_STRING
&&
3201 !IsTypeInBuffer(&Data1
)) {
3202 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3206 Status
= CompareHiiValue (&Data1
, &Data2
, &Result
, FormSet
->HiiHandle
);
3207 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
3208 FreePool (Data1
.Buffer
);
3210 if (Data2
.Type
== EFI_IFR_TYPE_BUFFER
) {
3211 FreePool (Data2
.Buffer
);
3214 if (Status
== EFI_UNSUPPORTED
) {
3215 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3216 Status
= EFI_SUCCESS
;
3220 if (EFI_ERROR (Status
)) {
3224 switch (OpCode
->Operand
) {
3225 case EFI_IFR_EQUAL_OP
:
3226 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
3229 case EFI_IFR_NOT_EQUAL_OP
:
3230 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
3233 case EFI_IFR_GREATER_EQUAL_OP
:
3234 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
3237 case EFI_IFR_GREATER_THAN_OP
:
3238 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
3241 case EFI_IFR_LESS_EQUAL_OP
:
3242 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
3245 case EFI_IFR_LESS_THAN_OP
:
3246 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
3254 case EFI_IFR_MATCH_OP
:
3255 Status
= InitializeUnicodeCollationProtocol ();
3256 if (EFI_ERROR (Status
)) {
3260 Status
= IfrMatch (FormSet
, Value
);
3263 case EFI_IFR_CATENATE_OP
:
3264 Status
= IfrCatenate (FormSet
, Value
);
3270 case EFI_IFR_CONDITIONAL_OP
:
3272 // Pop third expression from the expression stack
3274 Status
= PopExpression (&Data3
);
3275 if (EFI_ERROR (Status
)) {
3280 // Pop second expression from the expression stack
3282 Status
= PopExpression (&Data2
);
3283 if (EFI_ERROR (Status
)) {
3288 // Pop first expression from the expression stack
3290 Status
= PopExpression (&Data1
);
3291 if (EFI_ERROR (Status
)) {
3294 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3295 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3299 if (Data1
.Value
.b
) {
3306 case EFI_IFR_FIND_OP
:
3307 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3310 case EFI_IFR_MID_OP
:
3311 Status
= IfrMid (FormSet
, Value
);
3314 case EFI_IFR_TOKEN_OP
:
3315 Status
= IfrToken (FormSet
, Value
);
3318 case EFI_IFR_SPAN_OP
:
3319 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3322 case EFI_IFR_MAP_OP
:
3324 // Pop the check value
3326 Status
= PopExpression (&Data1
);
3327 if (EFI_ERROR (Status
)) {
3331 // Check MapExpression list is valid.
3333 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3334 Status
= EFI_INVALID_PARAMETER
;
3338 // Go through map expression list.
3340 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3341 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3342 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3344 // Evaluate the first expression in this pair.
3346 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3347 if (EFI_ERROR (Status
)) {
3351 // Compare the expression value with current value
3353 if ((CompareHiiValue (&Data1
, &SubExpression
->Result
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
3355 // Try get the map value.
3357 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3358 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3359 Status
= EFI_INVALID_PARAMETER
;
3362 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3363 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3364 if (EFI_ERROR (Status
)) {
3367 Value
= &SubExpression
->Result
;
3371 // Skip the second expression on this pair.
3373 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3374 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3375 Status
= EFI_INVALID_PARAMETER
;
3379 // Goto the first expression on next pair.
3381 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3385 // No map value is found.
3387 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3388 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3389 Value
->Value
.u8
= 0;
3396 if (EFI_ERROR (Status
) || Value
->Type
== EFI_IFR_TYPE_UNDEFINED
) {
3400 Status
= PushExpression (Value
);
3401 if (EFI_ERROR (Status
)) {
3407 // Pop the final result from expression stack
3410 Status
= PopExpression (Value
);
3411 if (EFI_ERROR (Status
)) {
3416 // After evaluating an expression, there should be only one value left on the expression stack
3418 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3419 Status
= EFI_INVALID_PARAMETER
;
3423 RestoreExpressionEvaluationStackOffset (StackOffset
);
3424 if (!EFI_ERROR (Status
)) {
3425 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3432 Check whether the result is TRUE or FALSE.
3434 For the EFI_HII_VALUE value type is numeric, return TRUE if the
3437 @param Result Input the result data.
3439 @retval TRUE The result is TRUE.
3440 @retval FALSE The result is FALSE.
3445 IN EFI_HII_VALUE
*Result
3448 switch (Result
->Type
) {
3449 case EFI_IFR_TYPE_BOOLEAN
:
3450 return Result
->Value
.b
;
3452 case EFI_IFR_TYPE_NUM_SIZE_8
:
3453 return (BOOLEAN
)(Result
->Value
.u8
!= 0);
3455 case EFI_IFR_TYPE_NUM_SIZE_16
:
3456 return (BOOLEAN
)(Result
->Value
.u16
!= 0);
3458 case EFI_IFR_TYPE_NUM_SIZE_32
:
3459 return (BOOLEAN
)(Result
->Value
.u32
!= 0);
3461 case EFI_IFR_TYPE_NUM_SIZE_64
:
3462 return (BOOLEAN
)(Result
->Value
.u64
!= 0);
3470 Return the result of the expression list. Check the expression list and
3471 return the highest priority express result.
3472 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3474 @param ExpList The input expression list.
3475 @param Evaluate Whether need to evaluate the expression first.
3476 @param FormSet FormSet associated with this expression.
3477 @param Form Form associated with this expression.
3479 @retval EXPRESS_RESULT Return the higher priority express result.
3480 DisableIf > SuppressIf > GrayOutIf > FALSE
3484 EvaluateExpressionList (
3485 IN FORM_EXPRESSION_LIST
*ExpList
,
3486 IN BOOLEAN Evaluate
,
3487 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3488 IN FORM_BROWSER_FORM
*Form OPTIONAL
3492 EXPRESS_RESULT ReturnVal
;
3493 EXPRESS_RESULT CompareOne
;
3496 if (ExpList
== NULL
) {
3497 return ExpressFalse
;
3500 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3504 // Check whether need to evaluate the expression first.
3507 while (ExpList
->Count
> Index
) {
3508 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3509 if (EFI_ERROR (Status
)) {
3510 return ExpressFalse
;
3516 // Run the list of expressions.
3518 ReturnVal
= ExpressFalse
;
3519 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3520 if (IsTrue (&ExpList
->Expression
[Index
]->Result
)) {
3521 switch (ExpList
->Expression
[Index
]->Type
) {
3522 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3523 CompareOne
= ExpressSuppress
;
3526 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3527 CompareOne
= ExpressGrayOut
;
3530 case EFI_HII_EXPRESSION_DISABLE_IF
:
3531 CompareOne
= ExpressDisable
;
3535 return ExpressFalse
;
3538 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;