2 Common Library Routines to assist in IFR creation on-the-fly
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. 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.
15 #include "IfrSupportLibInternal.h"
18 Determine what is the current language setting
19 The setting is stored in language variable in flash. This routine
20 will get setting by accesssing that variable. If failed to access
21 language variable, then use default setting that 'eng' as current
24 @param Lang Pointer of system language
26 @return whether sucess to get setting from variable
39 // Getting the system language and placing it into our Global Data
41 Size
= sizeof (Language
);
43 Status
= gRT
->GetVariable (
45 &gEfiGlobalVariableGuid
,
51 if (EFI_ERROR (Status
)) {
52 AsciiStrCpy (Language
, "eng");
55 for (Index
= 0; Index
< 3; Index
++) {
57 // Bitwise AND ascii value with 0xDF yields an uppercase value.
58 // Sign extend into a unicode value
60 Lang
[Index
] = (CHAR16
) (Language
[Index
] & 0xDF);
64 // Null-terminate the value
72 Add a string to the incoming buffer and return the token and offset data
74 @param StringBuffer The incoming buffer
75 @param Language Currrent language
76 @param String The string to be added
77 @param StringToken The index where the string placed
79 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
80 @retval EFI_SUCCESS String successfully added to the incoming buffer
84 IN VOID
*StringBuffer
,
87 IN OUT STRING_REF
*StringToken
90 EFI_HII_STRING_PACK
*StringPack
;
91 EFI_HII_STRING_PACK
*StringPackBuffer
;
94 RELOFST
*PackDestination
;
102 StringPack
= (EFI_HII_STRING_PACK
*) StringBuffer
;
106 // Pre-allocate a buffer sufficient for us to work on.
107 // We will use it as a destination scratch pad to build data on
108 // and when complete shift the data back to the original buffer
110 NewBuffer
= AllocateZeroPool (DEFAULT_STRING_BUFFER_SIZE
);
111 if (NewBuffer
== NULL
) {
112 return EFI_OUT_OF_RESOURCES
;
115 StringPackBuffer
= (EFI_HII_STRING_PACK
*) NewBuffer
;
118 // StringPack is terminated with a length 0 entry
120 for (; StringPack
->Header
.Length
!= 0;) {
122 // If this stringpack's language is same as CurrentLanguage, use it
124 if (CompareMem ((VOID
*) ((CHAR8
*) (StringPack
) + StringPack
->LanguageNameString
), Language
, 3) == 0) {
126 // We have some data in this string pack, copy the string package up to the string data
128 CopyMem (&StringPackBuffer
->Header
, &StringPack
->Header
, sizeof (StringPack
));
131 // These are references in the structure to tokens, need to increase them by the space occupied by an additional StringPointer
133 StringPackBuffer
->LanguageNameString
= (UINT16
) (StringPackBuffer
->LanguageNameString
+ (UINT16
) sizeof (RELOFST
));
134 StringPackBuffer
->PrintableLanguageName
= (UINT16
) (StringPackBuffer
->PrintableLanguageName
+ (UINT16
) sizeof (RELOFST
));
136 PackSource
= (RELOFST
*) (StringPack
+ 1);
137 PackDestination
= (RELOFST
*) (StringPackBuffer
+ 1);
138 for (Index
= 0; PackSource
[Index
] != 0x0000; Index
++) {
140 // Copy the stringpointers from old to new buffer
141 // remember that we are adding a string, so the string offsets will all go up by sizeof (RELOFST)
143 PackDestination
[Index
] = (UINT16
) (PackDestination
[Index
] + sizeof (RELOFST
));
147 // Add a new stringpointer in the new buffer since we are adding a string. Null terminate it
149 PackDestination
[Index
] = (UINT16
)(PackDestination
[Index
-1] +
150 StrSize((CHAR16
*)((CHAR8
*)(StringPack
) + PackSource
[Index
-1])));
151 PackDestination
[Index
+ 1] = (UINT16
) 0;
154 // Index is the token value for the new string
156 *StringToken
= (UINT16
) Index
;
159 // Source now points to the beginning of the old buffer strings
160 // Destination now points to the beginning of the new buffer strings
162 Source
= (UINT8
*) &PackSource
[Index
+ 1];
163 Destination
= (UINT8
*) &PackDestination
[Index
+ 2];
166 // This should copy all the strings from the old buffer to the new buffer
168 for (; Index
!= 0; Index
--) {
170 // Copy Source string to destination buffer
172 StrCpy ((CHAR16
*) Destination
, (CHAR16
*) Source
);
175 // Adjust the source/destination to the next string location
177 Destination
= Destination
+ StrSize ((CHAR16
*) Source
);
178 Source
= Source
+ StrSize ((CHAR16
*) Source
);
182 // This copies the new string to the destination buffer
184 StrCpy ((CHAR16
*) Destination
, (CHAR16
*) String
);
187 // Adjust the size of the changed string pack by adding the size of the new string
188 // along with the size of the additional offset entry for the new string
190 StringPackBuffer
->Header
.Length
= (UINT32
) ((UINTN
) StringPackBuffer
->Header
.Length
+ StrSize (String
) + sizeof (RELOFST
));
193 // Advance the buffers to point to the next spots.
195 StringPackBuffer
= (EFI_HII_STRING_PACK
*) ((CHAR8
*) (StringPackBuffer
) + StringPackBuffer
->Header
.Length
);
196 StringPack
= (EFI_HII_STRING_PACK
*) ((CHAR8
*) (StringPack
) + StringPack
->Header
.Length
);
201 // This isn't the language of the stringpack we were asked to add a string to
202 // so we need to copy it to the new buffer.
204 CopyMem (&StringPackBuffer
->Header
, &StringPack
->Header
, StringPack
->Header
.Length
);
207 // Advance the buffers to point to the next spots.
209 StringPackBuffer
= (EFI_HII_STRING_PACK
*) ((CHAR8
*) (StringPackBuffer
) + StringPack
->Header
.Length
);
210 StringPack
= (EFI_HII_STRING_PACK
*) ((CHAR8
*) (StringPack
) + StringPack
->Header
.Length
);
214 // If we didn't copy the new data to a stringpack yet
217 PackDestination
= (RELOFST
*) (StringPackBuffer
+ 1);
219 // Pointing to a new string pack location
221 SizeofLanguage
= StrSize (Language
);
222 SizeofString
= StrSize (String
);
223 StringPackBuffer
->Header
.Length
= (UINT32
)
225 sizeof (EFI_HII_STRING_PACK
) -
226 sizeof (EFI_STRING
) +
232 StringPackBuffer
->Header
.Type
= EFI_HII_STRING
;
233 StringPackBuffer
->LanguageNameString
= (UINT16
) ((UINTN
) &PackDestination
[3] - (UINTN
) StringPackBuffer
);
234 StringPackBuffer
->PrintableLanguageName
= (UINT16
) ((UINTN
) &PackDestination
[3] - (UINTN
) StringPackBuffer
);
235 StringPackBuffer
->Attributes
= 0;
236 PackDestination
[0] = (UINT16
) ((UINTN
) &PackDestination
[3] - (UINTN
) StringPackBuffer
);
237 PackDestination
[1] = (UINT16
) (PackDestination
[0] + StrSize (Language
));
238 PackDestination
[2] = (UINT16
) 0;
241 // The first string location will be set to destination. The minimum number of strings
242 // associated with a stringpack will always be token 0 stored as the languagename (e.g. ENG, SPA, etc)
243 // and token 1 as the new string being added and and null entry for the stringpointers
245 Destination
= (UINT8
*) &PackDestination
[3];
248 // Copy the language name string to the new buffer
250 StrCpy ((CHAR16
*) Destination
, Language
);
253 // Advance the destination to the new empty spot
255 Destination
= Destination
+ StrSize (Language
);
258 // Copy the string to the new buffer
260 StrCpy ((CHAR16
*) Destination
, String
);
263 // Since we are starting with a new string pack - we know the new string is token 1
265 *StringToken
= (UINT16
) 1;
269 // Zero out the original buffer and copy the updated data in the new buffer to the old buffer
271 ZeroMem (StringBuffer
, DEFAULT_STRING_BUFFER_SIZE
);
272 CopyMem (StringBuffer
, NewBuffer
, DEFAULT_STRING_BUFFER_SIZE
);
275 // Free the newly created buffer since we don't need it anymore
277 gBS
->FreePool (NewBuffer
);
282 Add op-code data to the FormBuffer
284 @param FormBuffer Form buffer to be inserted to
285 @param OpCodeData Op-code data to be inserted
287 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
288 @retval EFI_SUCCESS Op-code data successfully inserted
293 IN OUT VOID
*OpCodeData
296 EFI_HII_PACK_HEADER
*NewBuffer
;
301 // Pre-allocate a buffer sufficient for us to work on.
302 // We will use it as a destination scratch pad to build data on
303 // and when complete shift the data back to the original buffer
305 NewBuffer
= AllocateZeroPool (DEFAULT_FORM_BUFFER_SIZE
);
306 if (NewBuffer
== NULL
) {
307 return EFI_OUT_OF_RESOURCES
;
310 Source
= (UINT8
*) FormBuffer
;
311 Destination
= (UINT8
*) NewBuffer
;
314 // Copy the IFR Package header to the new buffer
316 CopyMem (Destination
, Source
, sizeof (EFI_HII_PACK_HEADER
));
319 // Advance Source and Destination to next op-code
321 Source
= Source
+ sizeof (EFI_HII_PACK_HEADER
);
322 Destination
= Destination
+ sizeof (EFI_HII_PACK_HEADER
);
325 // Copy data to the new buffer until we run into the end_form
327 for (; ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->OpCode
!= FRAMEWORK_EFI_IFR_END_FORM_OP
;) {
329 // If the this opcode is an end_form_set we better be creating and endform
330 // Nonetheless, we will add data before the end_form_set. This also provides
331 // for interesting behavior in the code we will run, but has no bad side-effects
332 // since we will possibly do a 0 byte copy in this particular end-case.
334 if (((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->OpCode
== FRAMEWORK_EFI_IFR_END_FORM_SET_OP
) {
339 // Copy data to new buffer
341 CopyMem (Destination
, Source
, ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
);
344 // Adjust Source/Destination to next op-code location
346 Destination
= Destination
+ (UINTN
) ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
;
347 Source
= Source
+ (UINTN
) ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
;
351 // Prior to the end_form is where we insert the new op-code data
353 CopyMem (Destination
, OpCodeData
, ((FRAMEWORK_EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
);
354 Destination
= Destination
+ (UINTN
) ((FRAMEWORK_EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
356 NewBuffer
->Length
= (UINT32
) (NewBuffer
->Length
+ (UINT32
) (((FRAMEWORK_EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
));
359 // Copy end-form data to new buffer
361 CopyMem (Destination
, Source
, ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
);
364 // Adjust Source/Destination to next op-code location
366 Destination
= Destination
+ (UINTN
) ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
;
367 Source
= Source
+ (UINTN
) ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
;
370 // Copy end-formset data to new buffer
372 CopyMem (Destination
, Source
, ((FRAMEWORK_EFI_IFR_OP_HEADER
*) Source
)->Length
);
375 // Zero out the original buffer and copy the updated data in the new buffer to the old buffer
377 ZeroMem (FormBuffer
, DEFAULT_FORM_BUFFER_SIZE
);
378 CopyMem (FormBuffer
, NewBuffer
, DEFAULT_FORM_BUFFER_SIZE
);
381 // Free the newly created buffer since we don't need it anymore
383 gBS
->FreePool (NewBuffer
);
388 Get the HII protocol interface
390 @param Hii HII protocol interface
392 @return the statue of locating HII protocol
397 OUT EFI_HII_PROTOCOL
**Hii
403 // There should only be one HII protocol
405 Status
= gBS
->LocateProtocol (
406 &gEfiHiiProtocolGuid
,
415 Extract information pertaining to the HiiHandle
417 @param HiiHandle Hii handle
418 @param ImageLength For input, length of DefaultImage;
419 For output, length of actually required
420 @param DefaultImage Image buffer prepared by caller
421 @param Guid Guid information about the form
423 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
424 @retval EFI_BUFFER_TOO_SMALL DefualtImage has no enough ImageLength
425 @retval EFI_SUCCESS Successfully extract data from Hii database.
428 ExtractDataFromHiiHandle (
429 IN FRAMEWORK_EFI_HII_HANDLE HiiHandle
,
430 IN OUT UINT16
*ImageLength
,
431 OUT UINT8
*DefaultImage
,
436 EFI_HII_PROTOCOL
*Hii
;
445 DataLength
= DEFAULT_FORM_BUFFER_SIZE
;
449 Status
= GetHiiInterface (&Hii
);
451 if (EFI_ERROR (Status
)) {
456 // Allocate space for retrieval of IFR data
458 RawData
= AllocateZeroPool (DataLength
);
459 if (RawData
== NULL
) {
460 return EFI_OUT_OF_RESOURCES
;
464 // Get all the forms associated with this HiiHandle
466 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &DataLength
, RawData
);
468 if (EFI_ERROR (Status
)) {
469 gBS
->FreePool (RawData
);
472 // Allocate space for retrieval of IFR data
474 RawData
= AllocateZeroPool (DataLength
);
475 if (RawData
== NULL
) {
476 return EFI_OUT_OF_RESOURCES
;
480 // Get all the forms associated with this HiiHandle
482 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &DataLength
, RawData
);
488 // Point RawData to the beginning of the form data
490 RawData
= (UINT8
*) ((UINTN
) RawData
+ sizeof (EFI_HII_PACK_HEADER
));
492 for (Index
= 0; RawData
[Index
] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP
;) {
493 switch (RawData
[Index
]) {
494 case FRAMEWORK_EFI_IFR_FORM_SET_OP
:
496 // Copy the GUID information from this handle
498 CopyMem (Guid
, &((FRAMEWORK_EFI_IFR_FORM_SET
*) &RawData
[Index
])->Guid
, sizeof (EFI_GUID
));
501 case FRAMEWORK_EFI_IFR_ONE_OF_OP
:
502 case FRAMEWORK_EFI_IFR_CHECKBOX_OP
:
503 case FRAMEWORK_EFI_IFR_NUMERIC_OP
:
504 case FRAMEWORK_EFI_IFR_DATE_OP
:
505 case FRAMEWORK_EFI_IFR_TIME_OP
:
506 case FRAMEWORK_EFI_IFR_PASSWORD_OP
:
507 case FRAMEWORK_EFI_IFR_STRING_OP
:
509 // Remember, multiple op-codes may reference the same item, so let's keep a running
510 // marker of what the highest QuestionId that wasn't zero length. This will accurately
511 // maintain the Size of the NvStore
513 if (((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
!= 0) {
514 Temp
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
+ ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
;
515 if (SizeOfNvStore
< Temp
) {
516 SizeOfNvStore
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
+ ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
;
521 Index
= RawData
[Index
+ 1] + Index
;
525 // Return an error if buffer is too small
527 if (SizeOfNvStore
> *ImageLength
) {
528 gBS
->FreePool (OldData
);
529 *ImageLength
= (UINT16
) SizeOfNvStore
;
530 return EFI_BUFFER_TOO_SMALL
;
533 if (DefaultImage
!= NULL
) {
534 ZeroMem (DefaultImage
, SizeOfNvStore
);
538 // Copy the default image information to the user's buffer
540 for (Index
= 0; RawData
[Index
] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP
;) {
541 switch (RawData
[Index
]) {
542 case FRAMEWORK_EFI_IFR_ONE_OF_OP
:
543 CachedStart
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
;
546 case FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP
:
547 if (((FRAMEWORK_EFI_IFR_ONE_OF_OPTION
*) &RawData
[Index
])->Flags
& FRAMEWORK_EFI_IFR_FLAG_DEFAULT
) {
548 CopyMem (&DefaultImage
[CachedStart
], &((FRAMEWORK_EFI_IFR_ONE_OF_OPTION
*) &RawData
[Index
])->Value
, 2);
552 case FRAMEWORK_EFI_IFR_CHECKBOX_OP
:
553 DefaultImage
[((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
] = ((FRAMEWORK_EFI_IFR_CHECKBOX
*) &RawData
[Index
])->Flags
;
556 case FRAMEWORK_EFI_IFR_NUMERIC_OP
:
558 &DefaultImage
[((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
],
559 &((FRAMEWORK_EFI_IFR_NUMERIC
*) &RawData
[Index
])->Default
,
566 Index
= RawData
[Index
+ 1] + Index
;
569 *ImageLength
= (UINT16
) SizeOfNvStore
;
572 // Free our temporary repository of form data
574 gBS
->FreePool (OldData
);
580 Finds HII handle for given pack GUID previously registered with the HII.
582 @param HiiProtocol pointer to pointer to HII protocol interface.
583 If NULL, the interface will be found but not returned.
584 If it points to NULL, the interface will be found and
585 written back to the pointer that is pointed to.
586 @param Guid The GUID of the pack that registered with the HII.
588 @return Handle to the HII pack previously registered by the memory driver.
590 FRAMEWORK_EFI_HII_HANDLE
592 IN OUT EFI_HII_PROTOCOL
**HiiProtocol
, OPTIONAL
598 FRAMEWORK_EFI_HII_HANDLE
*HiiHandleBuffer
;
599 FRAMEWORK_EFI_HII_HANDLE HiiHandle
;
600 UINT16 HiiHandleBufferLength
;
601 UINT32 NumberOfHiiHandles
;
603 EFI_HII_PROTOCOL
*HiiProt
;
608 if ((HiiProtocol
!= NULL
) && (*HiiProtocol
!= NULL
)) {
610 // The protocol has been passed in
612 HiiProt
= *HiiProtocol
;
614 gBS
->LocateProtocol (
615 &gEfiHiiProtocolGuid
,
619 if (HiiProt
== NULL
) {
623 if (HiiProtocol
!= NULL
) {
625 // Return back the HII protocol for the caller as promissed
627 *HiiProtocol
= HiiProt
;
633 HiiHandleBufferLength
= 10;
634 HiiHandleBuffer
= AllocatePool (HiiHandleBufferLength
);
635 ASSERT (HiiHandleBuffer
!= NULL
);
638 // Get the Handles of the packages that were registered with Hii
640 Status
= HiiProt
->FindHandles (
642 &HiiHandleBufferLength
,
647 // Get a bigger bugffer if this one is to small, and try again
649 if (Status
== EFI_BUFFER_TOO_SMALL
) {
651 gBS
->FreePool (HiiHandleBuffer
);
653 HiiHandleBuffer
= AllocatePool (HiiHandleBufferLength
);
654 ASSERT (HiiHandleBuffer
!= NULL
);
656 Status
= HiiProt
->FindHandles (
658 &HiiHandleBufferLength
,
663 if (EFI_ERROR (Status
)) {
667 NumberOfHiiHandles
= HiiHandleBufferLength
/ sizeof (FRAMEWORK_EFI_HII_HANDLE
);
670 // Iterate Hii handles and look for the one that matches our Guid
672 for (Index
= 0; Index
< NumberOfHiiHandles
; Index
++) {
675 ExtractDataFromHiiHandle (HiiHandleBuffer
[Index
], &Length
, NULL
, &HiiGuid
);
677 if (CompareGuid (&HiiGuid
, Guid
)) {
679 HiiHandle
= HiiHandleBuffer
[Index
];
685 gBS
->FreePool (HiiHandleBuffer
);
690 Validate that the data associated with the HiiHandle in NVRAM is within
691 the reasonable parameters for that FormSet. Values for strings and passwords
692 are not verified due to their not having the equivalent of valid range settings.
694 @param HiiHandle Handle of the HII database entry to query
696 @param Results If return Status is EFI_SUCCESS, Results provides valid data
697 TRUE = NVRAM Data is within parameters
698 FALSE = NVRAM Data is NOT within parameters
699 @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate
700 @retval EFI_SUCCESS Data successfully validated
703 ValidateDataFromHiiHandle (
704 IN FRAMEWORK_EFI_HII_HANDLE HiiHandle
,
709 EFI_HII_PROTOCOL
*Hii
;
721 RawDataLength
= DEFAULT_FORM_BUFFER_SIZE
;
727 Status
= GetHiiInterface (&Hii
);
729 if (EFI_ERROR (Status
)) {
734 // Allocate space for retrieval of IFR data
736 RawData
= AllocateZeroPool (RawDataLength
);
737 if (RawData
== NULL
) {
738 return EFI_OUT_OF_RESOURCES
;
742 // Get all the forms associated with this HiiHandle
744 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &RawDataLength
, RawData
);
746 if (EFI_ERROR (Status
)) {
747 gBS
->FreePool (RawData
);
750 // Allocate space for retrieval of IFR data
752 RawData
= AllocateZeroPool (RawDataLength
);
753 if (RawData
== NULL
) {
754 return EFI_OUT_OF_RESOURCES
;
758 // Get all the forms associated with this HiiHandle
760 Status
= Hii
->GetForms (Hii
, HiiHandle
, 0, &RawDataLength
, RawData
);
766 // Point RawData to the beginning of the form data
768 RawData
= (UINT8
*) ((UINTN
) RawData
+ sizeof (EFI_HII_PACK_HEADER
));
770 for (Index
= 0; RawData
[Index
] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP
;) {
771 if (RawData
[Index
] == FRAMEWORK_EFI_IFR_FORM_SET_OP
) {
772 CopyMem (&Guid
, &((FRAMEWORK_EFI_IFR_FORM_SET
*) &RawData
[Index
])->Guid
, sizeof (EFI_GUID
));
776 Index
= RawData
[Index
+ 1] + Index
;
779 for (Index
= 0; RawData
[Index
] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP
;) {
780 switch (RawData
[Index
]) {
781 case FRAMEWORK_EFI_IFR_FORM_SET_OP
:
784 case FRAMEWORK_EFI_IFR_ONE_OF_OP
:
785 case FRAMEWORK_EFI_IFR_CHECKBOX_OP
:
786 case FRAMEWORK_EFI_IFR_NUMERIC_OP
:
787 case FRAMEWORK_EFI_IFR_DATE_OP
:
788 case FRAMEWORK_EFI_IFR_TIME_OP
:
789 case FRAMEWORK_EFI_IFR_PASSWORD_OP
:
790 case FRAMEWORK_EFI_IFR_STRING_OP
:
792 // Remember, multiple op-codes may reference the same item, so let's keep a running
793 // marker of what the highest QuestionId that wasn't zero length. This will accurately
794 // maintain the Size of the NvStore
796 if (((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
!= 0) {
797 Temp
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
+ ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
;
798 if (SizeOfNvStore
< Temp
) {
799 SizeOfNvStore
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
+ ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->Width
;
804 Index
= RawData
[Index
+ 1] + Index
;
808 // Allocate memory for our File Form Tags
810 VariableData
= AllocateZeroPool (SizeOfNvStore
);
811 if (VariableData
== NULL
) {
812 return EFI_OUT_OF_RESOURCES
;
815 Status
= gRT
->GetVariable (
820 (VOID
*) VariableData
823 if (EFI_ERROR (Status
)) {
826 // If there is a variable that exists already and it is larger than what we calculated the
827 // storage needs to be, we must assume the variable size from GetVariable is correct and not
828 // allow the truncation of the variable. It is very possible that the user who created the IFR
829 // we are cracking is not referring to a variable that was in a previous map, however we cannot
830 // allow it's truncation.
832 if (Status
== EFI_BUFFER_TOO_SMALL
) {
834 // Free the buffer that was allocated that was too small
836 gBS
->FreePool (VariableData
);
838 VariableData
= AllocatePool (SizeOfNvStore
);
839 if (VariableData
== NULL
) {
840 return EFI_OUT_OF_RESOURCES
;
843 Status
= gRT
->GetVariable (
848 (VOID
*) VariableData
854 // Walk through the form and see that the variable data it refers to is ok.
855 // This allows for the possibility of stale (obsoleted) data in the variable
856 // can be overlooked without causing an error
858 for (Index
= 0; RawData
[Index
] != FRAMEWORK_EFI_IFR_END_FORM_SET_OP
;) {
859 switch (RawData
[Index
]) {
860 case FRAMEWORK_EFI_IFR_ONE_OF_OP
:
862 // A one_of has no data, its the option that does - cache the storage Id
864 CachedStart
= ((FRAMEWORK_EFI_IFR_ONE_OF
*) &RawData
[Index
])->QuestionId
;
867 case FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP
:
869 // A one_of_option can be any value
871 if (VariableData
[CachedStart
] == ((FRAMEWORK_EFI_IFR_ONE_OF_OPTION
*) &RawData
[Index
])->Value
) {
876 case FRAMEWORK_EFI_IFR_END_ONE_OF_OP
:
878 // At this point lets make sure that the data value in the NVRAM matches one of the options
886 case FRAMEWORK_EFI_IFR_CHECKBOX_OP
:
888 // A checkbox is a boolean, so 0 and 1 are valid
889 // Remember, QuestionId corresponds to the offset location of the data in the variable
891 if (VariableData
[((FRAMEWORK_EFI_IFR_CHECKBOX
*) &RawData
[Index
])->QuestionId
] > 1) {
897 case FRAMEWORK_EFI_IFR_NUMERIC_OP
:
898 if ((VariableData
[((FRAMEWORK_EFI_IFR_NUMERIC
*)&RawData
[Index
])->QuestionId
] < ((FRAMEWORK_EFI_IFR_NUMERIC
*)&RawData
[Index
])->Minimum
) ||
899 (VariableData
[((FRAMEWORK_EFI_IFR_NUMERIC
*)&RawData
[Index
])->QuestionId
] > ((FRAMEWORK_EFI_IFR_NUMERIC
*)&RawData
[Index
])->Maximum
)) {
907 Index
= RawData
[Index
+ 1] + Index
;
911 // Free our temporary repository of form data
913 gBS
->FreePool (OldData
);
914 gBS
->FreePool (VariableData
);