3 The definition of CFormPkg's member function
5 Copyright (c) 2004 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "VfrFormPkg.h"
20 * The definition of CFormPkg's member function
23 SPendingAssign::SPendingAssign (
39 mKey
= new CHAR8
[strlen (Key
) + 1];
46 mMsg
= new CHAR8
[strlen (Msg
) + 1];
53 SPendingAssign::~SPendingAssign (
70 SPendingAssign::SetAddrAndLen (
80 SPendingAssign::AssignValue (
85 memcpy (mAddr
, Addr
, (mLen
< Len
? mLen
: Len
));
90 SPendingAssign::GetKey (
98 IN UINT32 BufferSize
= 4096
106 mBufferNodeQueueHead
= NULL
;
107 mCurrBufferNode
= NULL
;
109 Node
= new SBufferNode
;
113 BufferStart
= new CHAR8
[BufferSize
];
114 if (BufferStart
== NULL
) {
117 BufferEnd
= BufferStart
+ BufferSize
;
119 memset (BufferStart
, 0, BufferSize
);
120 Node
->mBufferStart
= BufferStart
;
121 Node
->mBufferEnd
= BufferEnd
;
122 Node
->mBufferFree
= BufferStart
;
125 mBufferSize
= BufferSize
;
126 mBufferNodeQueueHead
= Node
;
127 mBufferNodeQueueTail
= Node
;
128 mCurrBufferNode
= Node
;
131 CFormPkg::~CFormPkg ()
134 SPendingAssign
*pPNode
;
136 while (mBufferNodeQueueHead
!= NULL
) {
137 pBNode
= mBufferNodeQueueHead
;
138 mBufferNodeQueueHead
= mBufferNodeQueueHead
->mNext
;
139 if (pBNode
->mBufferStart
!= NULL
) {
140 delete pBNode
->mBufferStart
;
144 mBufferNodeQueueTail
= NULL
;
145 mCurrBufferNode
= NULL
;
147 while (PendingAssignList
!= NULL
) {
148 pPNode
= PendingAssignList
;
149 PendingAssignList
= PendingAssignList
->mNext
;
152 PendingAssignList
= NULL
;
156 CFormPkg::IfrBinBufferGet (
160 CHAR8
*BinBuffer
= NULL
;
162 if ((Len
== 0) || (Len
> mBufferSize
)) {
166 if ((mCurrBufferNode
->mBufferFree
+ Len
) <= mCurrBufferNode
->mBufferEnd
) {
167 BinBuffer
= mCurrBufferNode
->mBufferFree
;
168 mCurrBufferNode
->mBufferFree
+= Len
;
172 Node
= new SBufferNode
;
177 Node
->mBufferStart
= new CHAR8
[mBufferSize
];
178 if (Node
->mBufferStart
== NULL
) {
182 memset (Node
->mBufferStart
, 0, mBufferSize
);
183 Node
->mBufferEnd
= Node
->mBufferStart
+ mBufferSize
;
184 Node
->mBufferFree
= Node
->mBufferStart
;
188 if (mBufferNodeQueueTail
== NULL
) {
189 mBufferNodeQueueHead
= mBufferNodeQueueTail
= Node
;
191 mBufferNodeQueueTail
->mNext
= Node
;
192 mBufferNodeQueueTail
= Node
;
194 mCurrBufferNode
= Node
;
199 BinBuffer
= mCurrBufferNode
->mBufferFree
;
200 mCurrBufferNode
->mBufferFree
+= Len
;
210 CFormPkg::GetPkgLength (
222 mReadBufferNode
= mBufferNodeQueueHead
;
223 mReadBufferOffset
= 0;
231 mReadBufferNode
= NULL
;
232 mReadBufferOffset
= 0;
243 if ((Size
== 0) || (Buffer
== NULL
)) {
247 if (mReadBufferNode
== NULL
) {
251 for (Index
= 0; Index
< Size
; Index
++) {
252 if ((mReadBufferNode
->mBufferStart
+ mReadBufferOffset
) < mReadBufferNode
->mBufferFree
) {
253 Buffer
[Index
] = mReadBufferNode
->mBufferStart
[mReadBufferOffset
++];
255 if ((mReadBufferNode
= mReadBufferNode
->mNext
) == NULL
) {
258 mReadBufferOffset
= 0;
259 Buffer
[Index
] = mReadBufferNode
->mBufferStart
[mReadBufferOffset
++];
268 CFormPkg::BuildPkgHdr (
269 OUT EFI_HII_PACKAGE_HEADER
**PkgHdr
272 if (PkgHdr
== NULL
) {
273 return VFR_RETURN_FATAL_ERROR
;
276 if (((*PkgHdr
) = new EFI_HII_PACKAGE_HEADER
) == NULL
) {
277 return VFR_RETURN_OUT_FOR_RESOURCES
;
280 (*PkgHdr
)->Type
= EFI_HII_PACKAGE_FORM
;
281 (*PkgHdr
)->Length
= mPkgLength
+ sizeof (EFI_HII_PACKAGE_HEADER
);
283 return VFR_RETURN_SUCCESS
;
288 OUT PACKAGE_DATA
&TBuffer
296 if (TBuffer
.Buffer
!= NULL
) {
297 delete TBuffer
.Buffer
;
300 TBuffer
.Size
= mPkgLength
;
301 TBuffer
.Buffer
= NULL
;
302 if (TBuffer
.Size
!= 0) {
303 TBuffer
.Buffer
= new CHAR8
[TBuffer
.Size
];
305 return VFR_RETURN_SUCCESS
;
308 Temp
= TBuffer
.Buffer
;
310 while ((Size
= Read (Buffer
, 1024)) != 0) {
311 memcpy (Temp
, Buffer
, Size
);
315 return VFR_RETURN_SUCCESS
;
322 IN PACKAGE_DATA
*PkgData
325 EFI_VFR_RETURN_CODE Ret
;
328 EFI_HII_PACKAGE_HEADER
*PkgHdr
;
330 if (Output
== NULL
) {
331 return VFR_RETURN_FATAL_ERROR
;
334 if ((Ret
= BuildPkgHdr(&PkgHdr
)) != VFR_RETURN_SUCCESS
) {
337 fwrite (PkgHdr
, sizeof (EFI_HII_PACKAGE_HEADER
), 1, Output
);
340 if (PkgData
== NULL
) {
342 while ((Size
= Read (Buffer
, 1024)) != 0) {
343 fwrite (Buffer
, Size
, 1, Output
);
347 fwrite (PkgData
->Buffer
, PkgData
->Size
, 1, Output
);
350 return VFR_RETURN_SUCCESS
;
354 CFormPkg::_WRITE_PKG_LINE (
357 IN CHAR8
*LineHeader
,
364 if ((pFile
== NULL
) || (LineHeader
== NULL
) || (BlkBuf
== NULL
)) {
368 for (Index
= 0; Index
< BlkSize
; Index
++) {
369 if ((Index
% LineBytes
) == 0) {
370 fprintf (pFile
, "\n%s", LineHeader
);
372 fprintf (pFile
, "0x%02X, ", (UINT8
)BlkBuf
[Index
]);
377 CFormPkg::_WRITE_PKG_END (
380 IN CHAR8
*LineHeader
,
387 if ((BlkSize
== 0) || (pFile
== NULL
) || (LineHeader
== NULL
) || (BlkBuf
== NULL
)) {
391 for (Index
= 0; Index
< BlkSize
- 1; Index
++) {
392 if ((Index
% LineBytes
) == 0) {
393 fprintf (pFile
, "\n%s", LineHeader
);
395 fprintf (pFile
, "0x%02X, ", (UINT8
)BlkBuf
[Index
]);
398 if ((Index
% LineBytes
) == 0) {
399 fprintf (pFile
, "\n%s", LineHeader
);
401 fprintf (pFile
, "0x%02X\n", (UINT8
)BlkBuf
[Index
]);
404 #define BYTES_PRE_LINE 0x10
410 IN PACKAGE_DATA
*PkgData
413 EFI_VFR_RETURN_CODE Ret
;
414 CHAR8 Buffer
[BYTES_PRE_LINE
* 8];
415 EFI_HII_PACKAGE_HEADER
*PkgHdr
;
416 UINT32 PkgLength
= 0;
419 if ((BaseName
== NULL
) || (pFile
== NULL
)) {
420 return VFR_RETURN_FATAL_ERROR
;
423 fprintf (pFile
, "\nunsigned char %sBin[] = {\n", BaseName
);
425 if ((Ret
= BuildPkgHdr(&PkgHdr
)) != VFR_RETURN_SUCCESS
) {
430 // For framework vfr file, the extension framework header will be added.
432 if (VfrCompatibleMode
) {
433 fprintf (pFile
, " // FRAMEWORK PACKAGE HEADER Length\n");
434 PkgLength
= PkgHdr
->Length
+ sizeof (UINT32
) + 2;
435 _WRITE_PKG_LINE(pFile
, BYTES_PRE_LINE
, " ", (CHAR8
*)&PkgLength
, sizeof (UINT32
));
436 fprintf (pFile
, "\n\n // FRAMEWORK PACKAGE HEADER Type\n");
438 _WRITE_PKG_LINE(pFile
, BYTES_PRE_LINE
, " ", (CHAR8
*)&PkgLength
, sizeof (UINT16
));
440 fprintf (pFile
, " // ARRAY LENGTH\n");
441 PkgLength
= PkgHdr
->Length
+ sizeof (UINT32
);
442 _WRITE_PKG_LINE(pFile
, BYTES_PRE_LINE
, " ", (CHAR8
*)&PkgLength
, sizeof (UINT32
));
445 fprintf (pFile
, "\n\n // PACKAGE HEADER\n");
446 _WRITE_PKG_LINE(pFile
, BYTES_PRE_LINE
, " ", (CHAR8
*)PkgHdr
, sizeof (EFI_HII_PACKAGE_HEADER
));
447 PkgLength
= sizeof (EFI_HII_PACKAGE_HEADER
);
449 fprintf (pFile
, "\n\n // PACKAGE DATA\n");
451 if (PkgData
== NULL
) {
453 while ((ReadSize
= Read ((CHAR8
*)Buffer
, BYTES_PRE_LINE
* 8)) != 0) {
454 PkgLength
+= ReadSize
;
455 if (PkgLength
< PkgHdr
->Length
) {
456 _WRITE_PKG_LINE (pFile
, BYTES_PRE_LINE
, " ", Buffer
, ReadSize
);
458 _WRITE_PKG_END (pFile
, BYTES_PRE_LINE
, " ", Buffer
, ReadSize
);
463 if (PkgData
->Size
% BYTES_PRE_LINE
!= 0) {
464 PkgLength
= PkgData
->Size
- (PkgData
->Size
% BYTES_PRE_LINE
);
465 _WRITE_PKG_LINE (pFile
, BYTES_PRE_LINE
, " ", PkgData
->Buffer
, PkgLength
);
466 _WRITE_PKG_END (pFile
, BYTES_PRE_LINE
, " ", PkgData
->Buffer
+ PkgLength
, PkgData
->Size
% BYTES_PRE_LINE
);
468 PkgLength
= PkgData
->Size
- BYTES_PRE_LINE
;
469 _WRITE_PKG_LINE (pFile
, BYTES_PRE_LINE
, " ", PkgData
->Buffer
, PkgLength
);
470 _WRITE_PKG_END (pFile
, BYTES_PRE_LINE
, " ", PkgData
->Buffer
+ PkgLength
, BYTES_PRE_LINE
);
475 fprintf (pFile
, "\n};\n");
477 return VFR_RETURN_SUCCESS
;
481 CFormPkg::AssignPending (
489 SPendingAssign
*pNew
;
491 pNew
= new SPendingAssign (Key
, ValAddr
, ValLen
, LineNo
, Msg
);
493 return VFR_RETURN_OUT_FOR_RESOURCES
;
496 pNew
->mNext
= PendingAssignList
;
497 PendingAssignList
= pNew
;
498 return VFR_RETURN_SUCCESS
;
502 CFormPkg::DoPendingAssign (
508 SPendingAssign
*pNode
;
510 if ((Key
== NULL
) || (ValAddr
== NULL
)) {
514 for (pNode
= PendingAssignList
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
515 if (strcmp (pNode
->mKey
, Key
) == 0) {
516 pNode
->AssignValue (ValAddr
, ValLen
);
522 CFormPkg::HavePendingUnassigned (
526 SPendingAssign
*pNode
;
528 for (pNode
= PendingAssignList
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
529 if (pNode
->mFlag
== PENDING
) {
538 CFormPkg::PendingAssignPrintAll (
542 SPendingAssign
*pNode
;
544 for (pNode
= PendingAssignList
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
545 if (pNode
->mFlag
== PENDING
) {
546 gCVfrErrorHandle
.PrintMsg (pNode
->mLineNo
, pNode
->mKey
, "Error", pNode
->mMsg
);
552 CFormPkg::DeclarePendingQuestion (
553 IN CVfrVarDataTypeDB
&lCVfrVarDataTypeDB
,
554 IN CVfrDataStorage
&lCVfrDataStorage
,
555 IN CVfrQuestionDB
&lCVfrQuestionDB
,
556 IN EFI_GUID
*LocalFormSetGuid
,
560 SPendingAssign
*pNode
;
563 CHAR8 FName
[MAX_NAME_LEN
];
564 EFI_VFR_RETURN_CODE ReturnCode
;
565 EFI_VFR_VARSTORE_TYPE VarStoreType
= EFI_VFR_VARSTORE_INVALID
;
567 for (pNode
= PendingAssignList
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
568 if (pNode
->mFlag
== PENDING
) {
570 // declare this question as Numeric in SuppressIf True
573 CIfrSuppressIf SIObj
;
574 SIObj
.SetLineNo (LineNo
);
577 CIfrTrue
TObj (LineNo
);
581 EFI_VARSTORE_INFO Info
;
582 EFI_QUESTION_ID QId
= EFI_QUESTION_ID_INVALID
;
584 CNObj
.SetLineNo (LineNo
);
585 CNObj
.SetPrompt (0x0);
589 // Register this question, assume it is normal question, not date or time question
591 VarStr
= pNode
->mKey
;
592 ReturnCode
= lCVfrQuestionDB
.RegisterQuestion (NULL
, VarStr
, QId
);
593 if (ReturnCode
!= VFR_RETURN_SUCCESS
) {
594 gCVfrErrorHandle
.HandleError (ReturnCode
, pNode
->mLineNo
, pNode
->mKey
);
599 printf ("Undefined Question name is %s and Id is 0x%x\n", VarStr
, QId
);
602 // Get Question Info, framework vfr VarName == StructName
604 ReturnCode
= lCVfrVarDataTypeDB
.ExtractFieldNameAndArrary (VarStr
, FName
, ArrayIdx
);
605 if (ReturnCode
!= VFR_RETURN_SUCCESS
) {
606 gCVfrErrorHandle
.PrintMsg (pNode
->mLineNo
, pNode
->mKey
, "Error", "Var string is not the valid C variable");
612 ReturnCode
= lCVfrDataStorage
.GetVarStoreType (FName
, VarStoreType
);
613 if (ReturnCode
== VFR_RETURN_UNDEFINED
) {
614 lCVfrDataStorage
.DeclareBufferVarStore (
619 EFI_VARSTORE_ID_INVALID
,
622 ReturnCode
= lCVfrDataStorage
.GetVarStoreType (FName
, VarStoreType
);
624 if (ReturnCode
!= VFR_RETURN_SUCCESS
) {
625 gCVfrErrorHandle
.PrintMsg (pNode
->mLineNo
, FName
, "Error", "Var Store Type is not defined");
629 ReturnCode
= lCVfrDataStorage
.GetVarStoreId (FName
, &Info
.mVarStoreId
);
630 if (ReturnCode
!= VFR_RETURN_SUCCESS
) {
631 gCVfrErrorHandle
.PrintMsg (pNode
->mLineNo
, FName
, "Error", "Var Store Type is not defined");
635 if (*VarStr
== '\0' && ArrayIdx
!= INVALID_ARRAY_INDEX
) {
636 ReturnCode
= lCVfrDataStorage
.GetNameVarStoreInfo (&Info
, ArrayIdx
);
638 if (VarStoreType
== EFI_VFR_VARSTORE_EFI
) {
639 ReturnCode
= lCVfrDataStorage
.GetEfiVarStoreInfo (&Info
);
640 } else if (VarStoreType
== EFI_VFR_VARSTORE_BUFFER
) {
641 VarStr
= pNode
->mKey
;
642 ReturnCode
= lCVfrVarDataTypeDB
.GetDataFieldInfo (VarStr
, Info
.mInfo
.mVarOffset
, Info
.mVarType
, Info
.mVarTotalSize
);
644 ReturnCode
= VFR_RETURN_UNSUPPORTED
;
647 if (ReturnCode
!= VFR_RETURN_SUCCESS
) {
648 gCVfrErrorHandle
.HandleError (ReturnCode
, pNode
->mLineNo
, pNode
->mKey
);
652 CNObj
.SetQuestionId (QId
);
653 CNObj
.SetVarStoreInfo (&Info
);
654 CNObj
.SetFlags (0, Info
.mVarType
);
657 // For undefined Efi VarStore type question
658 // Append the extended guided opcode to contain VarName
660 if (VarStoreType
== EFI_VFR_VARSTORE_EFI
) {
661 CIfrVarEqName
CVNObj (QId
, Info
.mInfo
.mVarName
);
662 CVNObj
.SetLineNo (LineNo
);
669 CEObj
.SetLineNo (LineNo
);
671 // End for SuppressIf
674 SEObj
.SetLineNo (LineNo
);
677 return VFR_RETURN_SUCCESS
;
682 SIfrRecord::SIfrRecord (
688 mLineNo
= 0xFFFFFFFF;
689 mOffset
= 0xFFFFFFFF;
693 SIfrRecord::~SIfrRecord (
697 if (mIfrBinBuf
!= NULL
) {
701 mLineNo
= 0xFFFFFFFF;
702 mOffset
= 0xFFFFFFFF;
707 CIfrRecordInfoDB::CIfrRecordInfoDB (
712 mRecordCount
= EFI_IFR_RECORDINFO_IDX_START
;
713 mIfrRecordListHead
= NULL
;
714 mIfrRecordListTail
= NULL
;
717 CIfrRecordInfoDB::~CIfrRecordInfoDB (
723 while (mIfrRecordListHead
!= NULL
) {
724 pNode
= mIfrRecordListHead
;
725 mIfrRecordListHead
= mIfrRecordListHead
->mNext
;
731 CIfrRecordInfoDB::GetRecordInfoFromIdx (
736 SIfrRecord
*pNode
= NULL
;
738 if (RecordIdx
== EFI_IFR_RECORDINFO_IDX_INVALUD
) {
742 for (Idx
= (EFI_IFR_RECORDINFO_IDX_START
+ 1), pNode
= mIfrRecordListHead
;
743 (Idx
!= RecordIdx
) && (pNode
!= NULL
);
744 Idx
++, pNode
= pNode
->mNext
)
751 CIfrRecordInfoDB::IfrRecordRegister (
760 if (mSwitch
== FALSE
) {
761 return EFI_IFR_RECORDINFO_IDX_INVALUD
;
764 if ((pNew
= new SIfrRecord
) == NULL
) {
765 return EFI_IFR_RECORDINFO_IDX_INVALUD
;
768 if (mIfrRecordListHead
== NULL
) {
769 mIfrRecordListHead
= pNew
;
770 mIfrRecordListTail
= pNew
;
772 mIfrRecordListTail
->mNext
= pNew
;
773 mIfrRecordListTail
= pNew
;
781 CIfrRecordInfoDB::IfrRecordInfoUpdate (
791 if ((pNode
= GetRecordInfoFromIdx (RecordIdx
)) == NULL
) {
795 pNode
->mLineNo
= LineNo
;
796 pNode
->mOffset
= Offset
;
797 pNode
->mBinBufLen
= BinBufLen
;
798 pNode
->mIfrBinBuf
= BinBuf
;
803 CIfrRecordInfoDB::IfrRecordOutput (
804 OUT PACKAGE_DATA
&TBuffer
810 if (TBuffer
.Buffer
!= NULL
) {
811 delete TBuffer
.Buffer
;
815 TBuffer
.Buffer
= NULL
;
818 if (mSwitch
== FALSE
) {
822 for (pNode
= mIfrRecordListHead
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
823 TBuffer
.Size
+= pNode
->mBinBufLen
;
826 if (TBuffer
.Size
!= 0) {
827 TBuffer
.Buffer
= new CHAR8
[TBuffer
.Size
];
832 Temp
= TBuffer
.Buffer
;
834 for (pNode
= mIfrRecordListHead
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
835 if (pNode
->mIfrBinBuf
!= NULL
) {
836 memcpy (Temp
, pNode
->mIfrBinBuf
, pNode
->mBinBufLen
);
837 Temp
+= pNode
->mBinBufLen
;
845 CIfrRecordInfoDB::IfrRecordOutput (
854 if (mSwitch
== FALSE
) {
864 for (pNode
= mIfrRecordListHead
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
865 if (pNode
->mLineNo
== LineNo
|| LineNo
== 0) {
866 fprintf (File
, ">%08X: ", pNode
->mOffset
);
867 TotalSize
+= pNode
->mBinBufLen
;
868 if (pNode
->mIfrBinBuf
!= NULL
) {
869 for (Index
= 0; Index
< pNode
->mBinBufLen
; Index
++) {
870 fprintf (File
, "%02X ", (UINT8
)(pNode
->mIfrBinBuf
[Index
]));
873 fprintf (File
, "\n");
878 fprintf (File
, "\nTotal Size of all record is 0x%08X\n", TotalSize
);
883 // for framework vfr file
884 // adjust opcode sequence for uefi IFR format
885 // adjust inconsistent and varstore into the right position.
888 CIfrRecordInfoDB::CheckQuestionOpCode (
893 case EFI_IFR_CHECKBOX_OP
:
894 case EFI_IFR_NUMERIC_OP
:
895 case EFI_IFR_PASSWORD_OP
:
896 case EFI_IFR_ONE_OF_OP
:
897 case EFI_IFR_ACTION_OP
:
898 case EFI_IFR_STRING_OP
:
899 case EFI_IFR_DATE_OP
:
900 case EFI_IFR_TIME_OP
:
901 case EFI_IFR_ORDERED_LIST_OP
:
909 CIfrRecordInfoDB::CheckIdOpCode (
914 case EFI_IFR_EQ_ID_VAL_OP
:
915 case EFI_IFR_EQ_ID_ID_OP
:
916 case EFI_IFR_EQ_ID_LIST_OP
:
917 case EFI_IFR_QUESTION_REF1_OP
:
925 CIfrRecordInfoDB::GetOpcodeQuestionId (
926 IN EFI_IFR_OP_HEADER
*OpHead
929 EFI_IFR_QUESTION_HEADER
*QuestionHead
;
931 QuestionHead
= (EFI_IFR_QUESTION_HEADER
*) (OpHead
+ 1);
933 return QuestionHead
->QuestionId
;
937 CIfrRecordInfoDB::IfrRecordAdjust (
941 SIfrRecord
*pNode
, *preNode
;
942 SIfrRecord
*uNode
, *tNode
;
943 EFI_IFR_OP_HEADER
*OpHead
, *tOpHead
;
944 EFI_QUESTION_ID QuestionId
;
946 UINT32 QuestionScope
;
948 CHAR8 ErrorMsg
[MAX_STRING_LEN
] = {0, };
949 EFI_VFR_RETURN_CODE Status
;
952 // Init local variable
954 Status
= VFR_RETURN_SUCCESS
;
955 pNode
= mIfrRecordListHead
;
958 while (pNode
!= NULL
) {
959 OpHead
= (EFI_IFR_OP_HEADER
*) pNode
->mIfrBinBuf
;
962 // make sure the inconsistent opcode in question scope
964 if (QuestionScope
> 0) {
965 QuestionScope
+= OpHead
->Scope
;
966 if (OpHead
->OpCode
== EFI_IFR_END_OP
) {
971 if (CheckQuestionOpCode (OpHead
->OpCode
)) {
975 // for the inconsistent opcode not in question scope, adjust it
977 if (OpHead
->OpCode
== EFI_IFR_INCONSISTENT_IF_OP
&& QuestionScope
== 0) {
979 // for inconsistent opcode not in question scope
983 // Count inconsistent opcode Scope
985 StackCount
= OpHead
->Scope
;
986 QuestionId
= EFI_QUESTION_ID_INVALID
;
988 while (tNode
!= NULL
&& StackCount
> 0) {
989 tNode
= tNode
->mNext
;
990 tOpHead
= (EFI_IFR_OP_HEADER
*) tNode
->mIfrBinBuf
;
992 // Calculate Scope Number
994 StackCount
+= tOpHead
->Scope
;
995 if (tOpHead
->OpCode
== EFI_IFR_END_OP
) {
999 // by IdEqual opcode to get QuestionId
1001 if (QuestionId
== EFI_QUESTION_ID_INVALID
&&
1002 CheckIdOpCode (tOpHead
->OpCode
)) {
1003 QuestionId
= *(EFI_QUESTION_ID
*) (tOpHead
+ 1);
1006 if (tNode
== NULL
|| QuestionId
== EFI_QUESTION_ID_INVALID
) {
1008 // report error; not found
1010 sprintf (ErrorMsg
, "Inconsistent OpCode Record list invalid QuestionId is 0x%X", QuestionId
);
1011 gCVfrErrorHandle
.PrintMsg (0, NULL
, "Error", ErrorMsg
);
1012 Status
= VFR_RETURN_MISMATCHED
;
1016 // extract inconsistent opcode list
1017 // pNode is Incosistent opcode, tNode is End Opcode
1021 // insert inconsistent opcode list into the right question scope by questionid
1023 for (uNode
= mIfrRecordListHead
; uNode
!= NULL
; uNode
= uNode
->mNext
) {
1024 tOpHead
= (EFI_IFR_OP_HEADER
*) uNode
->mIfrBinBuf
;
1025 if (CheckQuestionOpCode (tOpHead
->OpCode
) &&
1026 (QuestionId
== GetOpcodeQuestionId (tOpHead
))) {
1031 // insert inconsistent opcode list and check LATE_CHECK flag
1033 if (uNode
!= NULL
) {
1034 if ((((EFI_IFR_QUESTION_HEADER
*)(tOpHead
+ 1))->Flags
& 0x20) != 0) {
1036 // if LATE_CHECK flag is set, change inconsistent to nosumbit
1038 OpHead
->OpCode
= EFI_IFR_NO_SUBMIT_IF_OP
;
1042 // skip the default storage for Date and Time
1044 if ((uNode
->mNext
!= NULL
) && (*uNode
->mNext
->mIfrBinBuf
== EFI_IFR_DEFAULT_OP
)) {
1045 uNode
= uNode
->mNext
;
1048 preNode
->mNext
= tNode
->mNext
;
1049 tNode
->mNext
= uNode
->mNext
;
1050 uNode
->mNext
= pNode
;
1052 // reset pNode to head list, scan the whole list again.
1054 pNode
= mIfrRecordListHead
;
1060 // not found matched question id, report error
1062 sprintf (ErrorMsg
, "QuestionId required by Inconsistent OpCode is not found. QuestionId is 0x%X", QuestionId
);
1063 gCVfrErrorHandle
.PrintMsg (0, NULL
, "Error", ErrorMsg
);
1064 Status
= VFR_RETURN_MISMATCHED
;
1067 } else if (OpHead
->OpCode
== EFI_IFR_VARSTORE_OP
||
1068 OpHead
->OpCode
== EFI_IFR_VARSTORE_EFI_OP
) {
1070 // for new added group of varstore opcode
1073 while (tNode
->mNext
!= NULL
) {
1074 tOpHead
= (EFI_IFR_OP_HEADER
*) tNode
->mNext
->mIfrBinBuf
;
1075 if (tOpHead
->OpCode
!= EFI_IFR_VARSTORE_OP
&&
1076 tOpHead
->OpCode
!= EFI_IFR_VARSTORE_EFI_OP
) {
1079 tNode
= tNode
->mNext
;
1082 if (tNode
->mNext
== NULL
) {
1084 // invalid IfrCode, IfrCode end by EndOpCode
1086 gCVfrErrorHandle
.PrintMsg (0, NULL
, "Error", "No found End Opcode in the end");
1087 Status
= VFR_RETURN_MISMATCHED
;
1091 if (tOpHead
->OpCode
!= EFI_IFR_END_OP
) {
1093 // not new added varstore, which are not needed to be adjust.
1096 pNode
= tNode
->mNext
;
1100 // move new added varstore opcode to the position befor form opcode
1101 // varstore opcode between pNode and tNode
1105 // search form opcode from begin
1107 for (uNode
= mIfrRecordListHead
; uNode
->mNext
!= NULL
; uNode
= uNode
->mNext
) {
1108 tOpHead
= (EFI_IFR_OP_HEADER
*) uNode
->mNext
->mIfrBinBuf
;
1109 if (tOpHead
->OpCode
== EFI_IFR_FORM_OP
) {
1114 // Insert varstore opcode beform form opcode if form opcode is found
1116 if (uNode
->mNext
!= NULL
) {
1117 preNode
->mNext
= tNode
->mNext
;
1118 tNode
->mNext
= uNode
->mNext
;
1119 uNode
->mNext
= pNode
;
1121 // reset pNode to head list, scan the whole list again.
1123 pNode
= mIfrRecordListHead
;
1129 // not found form, continue scan IfrRecord list
1132 pNode
= tNode
->mNext
;
1141 pNode
= pNode
->mNext
;
1145 // Update Ifr Opcode Offset
1147 if (Status
== VFR_RETURN_SUCCESS
) {
1149 for (pNode
= mIfrRecordListHead
; pNode
!= NULL
; pNode
= pNode
->mNext
) {
1150 pNode
->mOffset
= OpcodeOffset
;
1151 OpcodeOffset
+= pNode
->mBinBufLen
;
1157 CIfrRecordInfoDB gCIfrRecordInfoDB
;
1160 CIfrObj::_EMIT_PENDING_OBJ (
1164 CHAR8
*ObjBinBuf
= NULL
;
1169 if (!mDelayEmit
|| !gCreateOp
) {
1173 mPkgOffset
= gCFormPkg
.GetPkgLength ();
1175 // update data buffer to package data
1177 ObjBinBuf
= gCFormPkg
.IfrBinBufferGet (mObjBinLen
);
1178 if (ObjBinBuf
!= NULL
) {
1179 memcpy (ObjBinBuf
, mObjBinBuf
, mObjBinLen
);
1183 // update bin buffer to package data buffer
1185 if (mObjBinBuf
!= NULL
) {
1187 mObjBinBuf
= ObjBinBuf
;
1194 * The definition of CIfrObj's member function
1199 } gOpcodeSizesScopeTable
[] = {
1200 { 0, 0 }, // EFI_IFR_INVALID - 0x00
1201 { sizeof (EFI_IFR_FORM
), 1 }, // EFI_IFR_FORM_OP
1202 { sizeof (EFI_IFR_SUBTITLE
), 1 }, // EFI_IFR_SUBTITLE_OP
1203 { sizeof (EFI_IFR_TEXT
), 0 }, // EFI_IFR_TEXT_OP
1204 { sizeof (EFI_IFR_IMAGE
), 0 }, // EFI_IFR_IMAGE_OP
1205 { sizeof (EFI_IFR_ONE_OF
), 1 }, // EFI_IFR_ONE_OF_OP - 0x05
1206 { sizeof (EFI_IFR_CHECKBOX
), 1}, // EFI_IFR_CHECKBOX_OP
1207 { sizeof (EFI_IFR_NUMERIC
), 1 }, // EFI_IFR_NUMERIC_OP
1208 { sizeof (EFI_IFR_PASSWORD
), 1 }, // EFI_IFR_PASSWORD_OP
1209 { sizeof (EFI_IFR_ONE_OF_OPTION
), 0 }, // EFI_IFR_ONE_OF_OPTION_OP
1210 { sizeof (EFI_IFR_SUPPRESS_IF
), 1 }, // EFI_IFR_SUPPRESS_IF - 0x0A
1211 { sizeof (EFI_IFR_LOCKED
), 0 }, // EFI_IFR_LOCKED_OP
1212 { sizeof (EFI_IFR_ACTION
), 1 }, // EFI_IFR_ACTION_OP
1213 { sizeof (EFI_IFR_RESET_BUTTON
), 1 }, // EFI_IFR_RESET_BUTTON_OP
1214 { sizeof (EFI_IFR_FORM_SET
), 1 }, // EFI_IFR_FORM_SET_OP -0xE
1215 { sizeof (EFI_IFR_REF
), 0 }, // EFI_IFR_REF_OP
1216 { sizeof (EFI_IFR_NO_SUBMIT_IF
), 1}, // EFI_IFR_NO_SUBMIT_IF_OP -0x10
1217 { sizeof (EFI_IFR_INCONSISTENT_IF
), 1 }, // EFI_IFR_INCONSISTENT_IF_OP
1218 { sizeof (EFI_IFR_EQ_ID_VAL
), 0 }, // EFI_IFR_EQ_ID_VAL_OP
1219 { sizeof (EFI_IFR_EQ_ID_ID
), 0 }, // EFI_IFR_EQ_ID_ID_OP
1220 { sizeof (EFI_IFR_EQ_ID_LIST
), 0 }, // EFI_IFR_EQ_ID_LIST_OP - 0x14
1221 { sizeof (EFI_IFR_AND
), 0 }, // EFI_IFR_AND_OP
1222 { sizeof (EFI_IFR_OR
), 0 }, // EFI_IFR_OR_OP
1223 { sizeof (EFI_IFR_NOT
), 0 }, // EFI_IFR_NOT_OP
1224 { sizeof (EFI_IFR_RULE
), 1 }, // EFI_IFR_RULE_OP
1225 { sizeof (EFI_IFR_GRAY_OUT_IF
), 1 }, // EFI_IFR_GRAYOUT_IF_OP - 0x19
1226 { sizeof (EFI_IFR_DATE
), 1 }, // EFI_IFR_DATE_OP
1227 { sizeof (EFI_IFR_TIME
), 1 }, // EFI_IFR_TIME_OP
1228 { sizeof (EFI_IFR_STRING
), 1 }, // EFI_IFR_STRING_OP
1229 { sizeof (EFI_IFR_REFRESH
), 0 }, // EFI_IFR_REFRESH_OP
1230 { sizeof (EFI_IFR_DISABLE_IF
), 1 }, // EFI_IFR_DISABLE_IF_OP - 0x1E
1232 { sizeof (EFI_IFR_TO_LOWER
), 0 }, // EFI_IFR_TO_LOWER_OP - 0x20
1233 { sizeof (EFI_IFR_TO_UPPER
), 0 }, // EFI_IFR_TO_UPPER_OP - 0x21
1235 { sizeof (EFI_IFR_ORDERED_LIST
), 1 }, // EFI_IFR_ORDERED_LIST_OP - 0x23
1236 { sizeof (EFI_IFR_VARSTORE
), 0 }, // EFI_IFR_VARSTORE_OP
1237 { sizeof (EFI_IFR_VARSTORE_NAME_VALUE
), 0 }, // EFI_IFR_VARSTORE_NAME_VALUE_OP
1238 { sizeof (EFI_IFR_VARSTORE_EFI
), 0 }, // EFI_IFR_VARSTORE_EFI_OP
1239 { sizeof (EFI_IFR_VARSTORE_DEVICE
), 1 }, // EFI_IFR_VARSTORE_DEVICE_OP
1240 { sizeof (EFI_IFR_VERSION
), 0 }, // EFI_IFR_VERSION_OP - 0x28
1241 { sizeof (EFI_IFR_END
), 0 }, // EFI_IFR_END_OP
1242 { sizeof (EFI_IFR_MATCH
), 1 }, // EFI_IFR_MATCH_OP - 0x2A
1243 { 0, 0 }, { 0, 0} , { 0, 0} , { 0, 0} , // 0x2B ~ 0x2E
1244 { sizeof (EFI_IFR_EQUAL
), 0 }, // EFI_IFR_EQUAL_OP - 0x2F
1245 { sizeof (EFI_IFR_NOT_EQUAL
), 0 }, // EFI_IFR_NOT_EQUAL_OP
1246 { sizeof (EFI_IFR_GREATER_THAN
), 0 }, // EFI_IFR_GREATER_THAN_OP
1247 { sizeof (EFI_IFR_GREATER_EQUAL
), 0 }, // EFI_IFR_GREATER_EQUAL_OP
1248 { sizeof (EFI_IFR_LESS_THAN
), 0 }, // EFI_IFR_LESS_THAN_OP
1249 { sizeof (EFI_IFR_LESS_EQUAL
), 0 }, // EFI_IFR_LESS_EQUAL_OP - 0x34
1250 { sizeof (EFI_IFR_BITWISE_AND
), 0 }, // EFI_IFR_BITWISE_AND_OP
1251 { sizeof (EFI_IFR_BITWISE_OR
), 0 }, // EFI_IFR_BITWISE_OR_OP
1252 { sizeof (EFI_IFR_BITWISE_NOT
), 0 }, // EFI_IFR_BITWISE_NOT_OP
1253 { sizeof (EFI_IFR_SHIFT_LEFT
), 0 }, // EFI_IFR_SHIFT_LEFT_OP
1254 { sizeof (EFI_IFR_SHIFT_RIGHT
), 0 }, // EFI_IFR_SHIFT_RIGHT_OP
1255 { sizeof (EFI_IFR_ADD
), 0 }, // EFI_IFR_ADD_OP - 0x3A
1256 { sizeof (EFI_IFR_SUBTRACT
), 0 }, // EFI_IFR_SUBTRACT_OP
1257 { sizeof (EFI_IFR_MULTIPLY
), 0 }, // EFI_IFR_MULTIPLY_OP
1258 { sizeof (EFI_IFR_DIVIDE
), 0 }, // EFI_IFR_DIVIDE_OP
1259 { sizeof (EFI_IFR_MODULO
), 0 }, // EFI_IFR_MODULO_OP - 0x3E
1260 { sizeof (EFI_IFR_RULE_REF
), 0 }, // EFI_IFR_RULE_REF_OP
1261 { sizeof (EFI_IFR_QUESTION_REF1
), 0 }, // EFI_IFR_QUESTION_REF1_OP
1262 { sizeof (EFI_IFR_QUESTION_REF2
), 0 }, // EFI_IFR_QUESTION_REF2_OP - 0x41
1263 { sizeof (EFI_IFR_UINT8
), 0}, // EFI_IFR_UINT8
1264 { sizeof (EFI_IFR_UINT16
), 0}, // EFI_IFR_UINT16
1265 { sizeof (EFI_IFR_UINT32
), 0}, // EFI_IFR_UINT32
1266 { sizeof (EFI_IFR_UINT64
), 0}, // EFI_IFR_UTNT64
1267 { sizeof (EFI_IFR_TRUE
), 0 }, // EFI_IFR_TRUE_OP - 0x46
1268 { sizeof (EFI_IFR_FALSE
), 0 }, // EFI_IFR_FALSE_OP
1269 { sizeof (EFI_IFR_TO_UINT
), 0 }, // EFI_IFR_TO_UINT_OP
1270 { sizeof (EFI_IFR_TO_STRING
), 0 }, // EFI_IFR_TO_STRING_OP
1271 { sizeof (EFI_IFR_TO_BOOLEAN
), 0 }, // EFI_IFR_TO_BOOLEAN_OP
1272 { sizeof (EFI_IFR_MID
), 0 }, // EFI_IFR_MID_OP
1273 { sizeof (EFI_IFR_FIND
), 0 }, // EFI_IFR_FIND_OP
1274 { sizeof (EFI_IFR_TOKEN
), 0 }, // EFI_IFR_TOKEN_OP
1275 { sizeof (EFI_IFR_STRING_REF1
), 0 }, // EFI_IFR_STRING_REF1_OP - 0x4E
1276 { sizeof (EFI_IFR_STRING_REF2
), 0 }, // EFI_IFR_STRING_REF2_OP
1277 { sizeof (EFI_IFR_CONDITIONAL
), 0 }, // EFI_IFR_CONDITIONAL_OP
1278 { sizeof (EFI_IFR_QUESTION_REF3
), 0 }, // EFI_IFR_QUESTION_REF3_OP
1279 { sizeof (EFI_IFR_ZERO
), 0 }, // EFI_IFR_ZERO_OP
1280 { sizeof (EFI_IFR_ONE
), 0 }, // EFI_IFR_ONE_OP
1281 { sizeof (EFI_IFR_ONES
), 0 }, // EFI_IFR_ONES_OP
1282 { sizeof (EFI_IFR_UNDEFINED
), 0 }, // EFI_IFR_UNDEFINED_OP
1283 { sizeof (EFI_IFR_LENGTH
), 0 }, // EFI_IFR_LENGTH_OP
1284 { sizeof (EFI_IFR_DUP
), 0 }, // EFI_IFR_DUP_OP - 0x57
1285 { sizeof (EFI_IFR_THIS
), 0 }, // EFI_IFR_THIS_OP
1286 { sizeof (EFI_IFR_SPAN
), 0 }, // EFI_IFR_SPAN_OP
1287 { sizeof (EFI_IFR_VALUE
), 1 }, // EFI_IFR_VALUE_OP
1288 { sizeof (EFI_IFR_DEFAULT
), 0 }, // EFI_IFR_DEFAULT_OP
1289 { sizeof (EFI_IFR_DEFAULTSTORE
), 0 }, // EFI_IFR_DEFAULTSTORE_OP - 0x5C
1291 { sizeof (EFI_IFR_CATENATE
), 0 }, // EFI_IFR_CATENATE_OP
1292 { sizeof (EFI_IFR_GUID
), 0 }, // EFI_IFR_GUID_OP
1295 #ifdef CIFROBJ_DEUBG
1298 } gIfrObjPrintDebugTable
[] = {
1299 "EFI_IFR_INVALID", "EFI_IFR_FORM", "EFI_IFR_SUBTITLE", "EFI_IFR_TEXT", "EFI_IFR_IMAGE", "EFI_IFR_ONE_OF",
1300 "EFI_IFR_CHECKBOX", "EFI_IFR_NUMERIC", "EFI_IFR_PASSWORD", "EFI_IFR_ONE_OF_OPTION", "EFI_IFR_SUPPRESS_IF", "EFI_IFR_LOCKED",
1301 "EFI_IFR_ACTION", "EFI_IFR_RESET_BUTTON", "EFI_IFR_FORM_SET", "EFI_IFR_REF", "EFI_IFR_NO_SUBMIT_IF", "EFI_IFR_INCONSISTENT_IF",
1302 "EFI_IFR_EQ_ID_VAL", "EFI_IFR_EQ_ID_ID", "EFI_IFR_EQ_ID_LIST", "EFI_IFR_AND", "EFI_IFR_OR", "EFI_IFR_NOT",
1303 "EFI_IFR_RULE", "EFI_IFR_GRAY_OUT_IF", "EFI_IFR_DATE", "EFI_IFR_TIME", "EFI_IFR_STRING", "EFI_IFR_REFRESH",
1304 "EFI_IFR_DISABLE_IF", "EFI_IFR_INVALID", "EFI_IFR_TO_LOWER", "EFI_IFR_TO_UPPER", "EFI_IFR_INVALID", "EFI_IFR_ORDERED_LIST",
1305 "EFI_IFR_VARSTORE", "EFI_IFR_VARSTORE_NAME_VALUE", "EFI_IFR_VARSTORE_EFI", "EFI_IFR_VARSTORE_DEVICE", "EFI_IFR_VERSION", "EFI_IFR_END",
1306 "EFI_IFR_MATCH", "EFI_IFR_INVALID", "EFI_IFR_INVALID", "EFI_IFR_INVALID", "EFI_IFR_INVALID", "EFI_IFR_EQUAL",
1307 "EFI_IFR_NOT_EQUAL", "EFI_IFR_GREATER_THAN", "EFI_IFR_GREATER_EQUAL", "EFI_IFR_LESS_THAN", "EFI_IFR_LESS_EQUAL", "EFI_IFR_BITWISE_AND",
1308 "EFI_IFR_BITWISE_OR", "EFI_IFR_BITWISE_NOT", "EFI_IFR_SHIFT_LEFT", "EFI_IFR_SHIFT_RIGHT", "EFI_IFR_ADD", "EFI_IFR_SUBTRACT",
1309 "EFI_IFR_MULTIPLY", "EFI_IFR_DIVIDE", "EFI_IFR_MODULO", "EFI_IFR_RULE_REF", "EFI_IFR_QUESTION_REF1", "EFI_IFR_QUESTION_REF2",
1310 "EFI_IFR_UINT8", "EFI_IFR_UINT16", "EFI_IFR_UINT32", "EFI_IFR_UINT64", "EFI_IFR_TRUE", "EFI_IFR_FALSE",
1311 "EFI_IFR_TO_UINT", "EFI_IFR_TO_STRING", "EFI_IFR_TO_BOOLEAN", "EFI_IFR_MID", "EFI_IFR_FIND", "EFI_IFR_TOKEN",
1312 "EFI_IFR_STRING_REF1","EFI_IFR_STRING_REF2", "EFI_IFR_CONDITIONAL", "EFI_IFR_QUESTION_REF3", "EFI_IFR_ZERO", "EFI_IFR_ONE",
1313 "EFI_IFR_ONES", "EFI_IFR_UNDEFINED", "EFI_IFR_LENGTH", "EFI_IFR_DUP", "EFI_IFR_THIS", "EFI_IFR_SPAN",
1314 "EFI_IFR_VALUE", "EFI_IFR_DEFAULT", "EFI_IFR_DEFAULTSTORE", "EFI_IFR_INVALID", "EFI_IFR_CATENATE", "EFI_IFR_GUID",
1318 CIFROBJ_DEBUG_PRINT (
1322 printf ("======Create IFR [%s]\n", gIfrObjPrintDebugTable
[OpCode
].mIfrName
);
1326 #define CIFROBJ_DEBUG_PRINT(OpCode)
1330 bool gCreateOp
= TRUE
;
1336 IN BOOLEAN DelayEmit
1339 mDelayEmit
= DelayEmit
;
1340 mPkgOffset
= gCFormPkg
.GetPkgLength ();
1341 mObjBinLen
= (ObjBinLen
== 0) ? gOpcodeSizesScopeTable
[OpCode
].mSize
: ObjBinLen
;
1342 mObjBinBuf
= ((DelayEmit
== FALSE
) && (gCreateOp
== TRUE
)) ? gCFormPkg
.IfrBinBufferGet (mObjBinLen
) : new CHAR8
[EFI_IFR_MAX_LENGTH
];
1343 mRecordIdx
= (gCreateOp
== TRUE
) ? gCIfrRecordInfoDB
.IfrRecordRegister (0xFFFFFFFF, mObjBinBuf
, mObjBinLen
, mPkgOffset
) : EFI_IFR_RECORDINFO_IDX_INVALUD
;
1345 if (IfrObj
!= NULL
) {
1346 *IfrObj
= mObjBinBuf
;
1349 CIFROBJ_DEBUG_PRINT (OpCode
);
1356 if ((mDelayEmit
== TRUE
) && ((gCreateOp
== TRUE
))) {
1357 _EMIT_PENDING_OBJ ();
1360 gCIfrRecordInfoDB
.IfrRecordInfoUpdate (mRecordIdx
, mLineNo
, mObjBinBuf
, mObjBinLen
, mPkgOffset
);
1364 * The definition of CIfrObj's member function
1366 UINT8 gScopeCount
= 0;
1368 CIfrOpHeader::CIfrOpHeader (
1372 ) : mHeader ((EFI_IFR_OP_HEADER
*)StartAddr
)
1374 mHeader
->OpCode
= OpCode
;
1375 mHeader
->Length
= (Length
== 0) ? gOpcodeSizesScopeTable
[OpCode
].mSize
: Length
;
1376 mHeader
->Scope
= (gOpcodeSizesScopeTable
[OpCode
].mScope
+ gScopeCount
> 0) ? 1 : 0;
1379 CIfrOpHeader::CIfrOpHeader (
1380 IN CIfrOpHeader
&OpHdr
1383 mHeader
= OpHdr
.mHeader
;
1386 UINT32
CIfrForm::FormIdBitMap
[EFI_FREE_FORM_ID_BITMAP_SIZE
] = {0, };