2 HII Library implementation that uses DXE protocols and services.
4 Copyright (c) 2006 - 2017, 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.
15 #include "InternalHiiLib.h"
17 #define GUID_CONFIG_STRING_TYPE 0x00
18 #define NAME_CONFIG_STRING_TYPE 0x01
19 #define PATH_CONFIG_STRING_TYPE 0x02
21 #define ACTION_SET_DEFAUTL_VALUE 0x01
22 #define ACTION_VALIDATE_SETTING 0x02
24 #define HII_LIB_DEFAULT_VARSTORE_SIZE 0x200
27 LIST_ENTRY Entry
; // Link to Block array
35 EFI_VARSTORE_ID VarStoreId
;
37 } IFR_VARSTORAGE_DATA
;
40 // <ConfigHdr> Template
42 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR16 mConfigHdrTemplate
[] = L
"GUID=00000000000000000000000000000000&NAME=0000&PATH=00";
44 EFI_FORM_BROWSER2_PROTOCOL
*mUefiFormBrowser2
= NULL
;
47 // Template used to mark the end of a list of packages
49 GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_HII_PACKAGE_HEADER mEndOfPakageList
= {
50 sizeof (EFI_HII_PACKAGE_HEADER
),
55 Extract Hii package list GUID for given HII handle.
57 If HiiHandle could not be found in the HII database, then ASSERT.
58 If Guid is NULL, then ASSERT.
60 @param Handle Hii handle
61 @param Guid Package list GUID
63 @retval EFI_SUCCESS Successfully extract GUID from Hii database.
68 InternalHiiExtractGuidFromHiiHandle (
69 IN EFI_HII_HANDLE Handle
,
75 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
77 ASSERT (Guid
!= NULL
);
78 ASSERT (Handle
!= NULL
);
81 // Get HII PackageList
84 HiiPackageList
= NULL
;
86 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
87 ASSERT (Status
!= EFI_NOT_FOUND
);
89 if (Status
== EFI_BUFFER_TOO_SMALL
) {
90 HiiPackageList
= AllocatePool (BufferSize
);
91 ASSERT (HiiPackageList
!= NULL
);
93 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
95 if (EFI_ERROR (Status
)) {
96 FreePool (HiiPackageList
);
103 CopyGuid (Guid
, &HiiPackageList
->PackageListGuid
);
105 FreePool (HiiPackageList
);
111 Registers a list of packages in the HII Database and returns the HII Handle
112 associated with that registration. If an HII Handle has already been registered
113 with the same PackageListGuid and DeviceHandle, then NULL is returned. If there
114 are not enough resources to perform the registration, then NULL is returned.
115 If an empty list of packages is passed in, then NULL is returned. If the size of
116 the list of package is 0, then NULL is returned.
118 The variable arguments are pointers which point to package header that defined
119 by UEFI VFR compiler and StringGather tool.
121 #pragma pack (push, 1)
124 EFI_HII_PACKAGE_HEADER PackageHeader;
125 } EDKII_AUTOGEN_PACKAGES_HEADER;
128 @param[in] PackageListGuid The GUID of the package list.
129 @param[in] DeviceHandle If not NULL, the Device Handle on which
130 an instance of DEVICE_PATH_PROTOCOL is installed.
131 This Device Handle uniquely defines the device that
132 the added packages are associated with.
133 @param[in] ... The variable argument list that contains pointers
134 to packages terminated by a NULL.
136 @retval NULL A HII Handle has already been registered in the HII Database with
137 the same PackageListGuid and DeviceHandle.
138 @retval NULL The HII Handle could not be created.
139 @retval NULL An empty list of packages was passed in.
140 @retval NULL All packages are empty.
141 @retval Other The HII Handle associated with the newly registered package list.
147 IN CONST EFI_GUID
*PackageListGuid
,
148 IN EFI_HANDLE DeviceHandle OPTIONAL
,
155 EFI_HII_PACKAGE_LIST_HEADER
*PackageListHeader
;
156 EFI_HII_HANDLE HiiHandle
;
160 ASSERT (PackageListGuid
!= NULL
);
163 // Calculate the length of all the packages in the variable argument list
165 for (Length
= 0, VA_START (Args
, DeviceHandle
); (Package
= VA_ARG (Args
, UINT32
*)) != NULL
; ) {
166 Length
+= (ReadUnaligned32 (Package
) - sizeof (UINT32
));
171 // If there are no packages in the variable argument list or all the packages
172 // are empty, then return a NULL HII Handle
179 // Add the length of the Package List Header and the terminating Package Header
181 Length
+= sizeof (EFI_HII_PACKAGE_LIST_HEADER
) + sizeof (EFI_HII_PACKAGE_HEADER
);
184 // Allocate the storage for the entire Package List
186 PackageListHeader
= AllocateZeroPool (Length
);
189 // If the Package List can not be allocated, then return a NULL HII Handle
191 if (PackageListHeader
== NULL
) {
196 // Fill in the GUID and Length of the Package List Header
198 CopyGuid (&PackageListHeader
->PackageListGuid
, PackageListGuid
);
199 PackageListHeader
->PackageLength
= Length
;
202 // Initialize a pointer to the beginning if the Package List data
204 Data
= (UINT8
*)(PackageListHeader
+ 1);
207 // Copy the data from each package in the variable argument list
209 for (VA_START (Args
, DeviceHandle
); (Package
= VA_ARG (Args
, UINT32
*)) != NULL
; ) {
210 Length
= ReadUnaligned32 (Package
) - sizeof (UINT32
);
211 CopyMem (Data
, Package
+ 1, Length
);
217 // Append a package of type EFI_HII_PACKAGE_END to mark the end of the package list
219 CopyMem (Data
, &mEndOfPakageList
, sizeof (mEndOfPakageList
));
222 // Register the package list with the HII Database
224 Status
= gHiiDatabase
->NewPackageList (
230 if (EFI_ERROR (Status
)) {
235 // Free the allocated package list
237 FreePool (PackageListHeader
);
240 // Return the new HII Handle
246 Removes a package list from the HII database.
248 If HiiHandle is NULL, then ASSERT.
249 If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.
251 @param[in] HiiHandle The handle that was previously registered in the HII database
257 IN EFI_HII_HANDLE HiiHandle
262 ASSERT (HiiHandle
!= NULL
);
263 Status
= gHiiDatabase
->RemovePackageList (gHiiDatabase
, HiiHandle
);
264 ASSERT_EFI_ERROR (Status
);
269 Retrieves the array of all the HII Handles or the HII handles of a specific
270 package list GUID in the HII Database.
271 This array is terminated with a NULL HII Handle.
272 This function allocates the returned array using AllocatePool().
273 The caller is responsible for freeing the array with FreePool().
275 @param[in] PackageListGuid An optional parameter that is used to request
276 HII Handles associated with a specific
277 Package List GUID. If this parameter is NULL,
278 then all the HII Handles in the HII Database
279 are returned. If this parameter is not NULL,
280 then zero or more HII Handles associated with
281 PackageListGuid are returned.
283 @retval NULL No HII handles were found in the HII database
284 @retval NULL The array of HII Handles could not be retrieved
285 @retval Other A pointer to the NULL terminated array of HII Handles
291 IN CONST EFI_GUID
*PackageListGuid OPTIONAL
295 UINTN HandleBufferLength
;
296 EFI_HII_HANDLE TempHiiHandleBuffer
;
297 EFI_HII_HANDLE
*HiiHandleBuffer
;
303 // Retrieve the size required for the buffer of all HII handles.
305 HandleBufferLength
= 0;
306 Status
= gHiiDatabase
->ListPackageLists (
308 EFI_HII_PACKAGE_TYPE_ALL
,
315 // If ListPackageLists() returns EFI_SUCCESS for a zero size,
316 // then there are no HII handles in the HII database. If ListPackageLists()
317 // returns an error other than EFI_BUFFER_TOO_SMALL, then there are no HII
318 // handles in the HII database.
320 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
322 // Return NULL if the size can not be retrieved, or if there are no HII
323 // handles in the HII Database
329 // Allocate the array of HII handles to hold all the HII Handles and a NULL terminator
331 HiiHandleBuffer
= AllocateZeroPool (HandleBufferLength
+ sizeof (EFI_HII_HANDLE
));
332 if (HiiHandleBuffer
== NULL
) {
334 // Return NULL if allocation fails.
340 // Retrieve the array of HII Handles in the HII Database
342 Status
= gHiiDatabase
->ListPackageLists (
344 EFI_HII_PACKAGE_TYPE_ALL
,
349 if (EFI_ERROR (Status
)) {
351 // Free the buffer and return NULL if the HII handles can not be retrieved.
353 FreePool (HiiHandleBuffer
);
357 if (PackageListGuid
== NULL
) {
359 // Return the NULL terminated array of HII handles in the HII Database
361 return HiiHandleBuffer
;
363 for (Index1
= 0, Index2
= 0; HiiHandleBuffer
[Index1
] != NULL
; Index1
++) {
364 Status
= InternalHiiExtractGuidFromHiiHandle (HiiHandleBuffer
[Index1
], &Guid
);
365 ASSERT_EFI_ERROR (Status
);
366 if (CompareGuid (&Guid
, PackageListGuid
)) {
367 HiiHandleBuffer
[Index2
++] = HiiHandleBuffer
[Index1
];
371 HiiHandleBuffer
[Index2
] = NULL
;
372 return HiiHandleBuffer
;
374 FreePool (HiiHandleBuffer
);
381 This function allows a caller to extract the form set opcode form the Hii Handle.
382 The returned buffer is allocated using AllocatePool().The caller is responsible
383 for freeing the allocated buffer using FreePool().
385 @param Handle The HII handle.
386 @param Buffer On return, points to a pointer which point to the buffer that contain the formset opcode.
387 @param BufferSize On return, points to the length of the buffer.
389 @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.
390 @retval EFI_NOT_FOUND Can't find the package data for the input Handle.
391 @retval EFI_INVALID_PARAMETER The input parameters are not correct.
392 @retval EFI_SUCCESS Get the formset opcode from the hii handle successfully.
397 HiiGetFormSetFromHiiHandle(
398 IN EFI_HII_HANDLE Handle
,
399 OUT EFI_IFR_FORM_SET
**Buffer
,
400 OUT UINTN
*BufferSize
404 UINTN PackageListSize
;
406 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
409 UINT8
*FormSetBuffer
;
413 UINT32 PackageListLength
;
414 EFI_HII_PACKAGE_HEADER PackageHeader
;
417 FormSetBuffer
= NULL
;
421 // Get HII PackageList
424 HiiPackageList
= NULL
;
425 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, Handle
, &PackageListSize
, HiiPackageList
);
426 if (EFI_ERROR (Status
) && (Status
!= EFI_BUFFER_TOO_SMALL
)) {
430 HiiPackageList
= AllocatePool (PackageListSize
);
431 if (HiiPackageList
== NULL
) {
432 return EFI_OUT_OF_RESOURCES
;
435 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, Handle
, &PackageListSize
, HiiPackageList
);
436 ASSERT_EFI_ERROR (Status
);
439 // Get Form package from this HII package List
441 Status
= EFI_NOT_FOUND
;
442 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
443 PackageListLength
= ReadUnaligned32 (&HiiPackageList
->PackageLength
);
445 while (Offset
< PackageListLength
) {
446 Package
= ((UINT8
*) HiiPackageList
) + Offset
;
447 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
448 Offset
+= PackageHeader
.Length
;
450 if (PackageHeader
.Type
!= EFI_HII_PACKAGE_FORMS
) {
455 // Search FormSet Opcode in this Form Package
457 Offset2
= sizeof (EFI_HII_PACKAGE_HEADER
);
458 while (Offset2
< PackageHeader
.Length
) {
459 OpCodeData
= Package
+ Offset2
;
460 Offset2
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
462 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
!= EFI_IFR_FORM_SET_OP
) {
466 if (FormSetBuffer
!= NULL
){
467 TempBuffer
= AllocateCopyPool (TempSize
+ ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
, FormSetBuffer
);
468 FreePool(FormSetBuffer
);
469 FormSetBuffer
= NULL
;
470 if (TempBuffer
== NULL
) {
471 Status
= EFI_OUT_OF_RESOURCES
;
474 CopyMem (TempBuffer
+ TempSize
, OpCodeData
, ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
);
476 TempBuffer
= AllocateCopyPool (TempSize
+ ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
, OpCodeData
);
477 if (TempBuffer
== NULL
) {
478 Status
= EFI_OUT_OF_RESOURCES
;
482 TempSize
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
483 FormSetBuffer
= TempBuffer
;
485 Status
= EFI_SUCCESS
;
487 //One form package has one formset, exit current form package to search other form package in the packagelist.
493 FreePool (HiiPackageList
);
495 *BufferSize
= TempSize
;
496 *Buffer
= (EFI_IFR_FORM_SET
*)FormSetBuffer
;
502 Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for
503 hex digits that appear between a '=' and a '&' in a config string.
505 If ConfigString is NULL, then ASSERT().
507 @param[in] ConfigString Pointer to a Null-terminated Unicode string.
509 @return Pointer to the Null-terminated Unicode result string.
514 InternalHiiLowerConfigString (
515 IN EFI_STRING ConfigString
521 ASSERT (ConfigString
!= NULL
);
524 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
526 for (String
= ConfigString
, Lower
= FALSE
; *String
!= L
'\0'; String
++) {
527 if (*String
== L
'=') {
529 } else if (*String
== L
'&') {
531 } else if (Lower
&& *String
>= L
'A' && *String
<= L
'F') {
532 *String
= (CHAR16
) (*String
- L
'A' + L
'a');
540 Uses the BlockToConfig() service of the Config Routing Protocol to
541 convert <ConfigRequest> and a buffer to a <ConfigResp>
543 If ConfigRequest is NULL, then ASSERT().
544 If Block is NULL, then ASSERT().
546 @param[in] ConfigRequest Pointer to a Null-terminated Unicode string.
547 @param[in] Block Pointer to a block of data.
548 @param[in] BlockSize The zie, in bytes, of Block.
550 @retval NULL The <ConfigResp> string could not be generated.
551 @retval Other Pointer to the Null-terminated Unicode <ConfigResp> string.
556 InternalHiiBlockToConfig (
557 IN CONST EFI_STRING ConfigRequest
,
558 IN CONST UINT8
*Block
,
563 EFI_STRING ConfigResp
;
566 ASSERT (ConfigRequest
!= NULL
);
567 ASSERT (Block
!= NULL
);
570 // Convert <ConfigRequest> to <ConfigResp>
572 Status
= gHiiConfigRouting
->BlockToConfig (
580 if (EFI_ERROR (Status
)) {
587 Uses the BrowserCallback() service of the Form Browser Protocol to retrieve
588 or set uncommitted data. If sata i being retrieved, then the buffer is
589 allocated using AllocatePool(). The caller is then responsible for freeing
590 the buffer using FreePool().
592 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
593 parameter that may be NULL.
594 @param[in] VariableName Pointer to a Null-terminated Unicode string. This
595 is an optional parameter that may be NULL.
596 @param[in] SetResultsData If not NULL, then this parameter specified the buffer
597 of uncommited data to set. If this parameter is NULL,
598 then the caller is requesting to get the uncommited data
599 from the Form Browser.
601 @retval NULL The uncommitted data could not be retrieved.
602 @retval Other A pointer to a buffer containing the uncommitted data.
607 InternalHiiBrowserCallback (
608 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
609 IN CONST CHAR16
*VariableName
, OPTIONAL
610 IN CONST EFI_STRING SetResultsData OPTIONAL
614 UINTN ResultsDataSize
;
615 EFI_STRING ResultsData
;
616 CHAR16 TempResultsData
;
621 if (mUefiFormBrowser2
== NULL
) {
622 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &mUefiFormBrowser2
);
623 if (EFI_ERROR (Status
) || mUefiFormBrowser2
== NULL
) {
630 if (SetResultsData
!= NULL
) {
632 // Request to to set data in the uncommitted browser state information
634 ResultsData
= SetResultsData
;
637 // Retrieve the length of the buffer required ResultsData from the Browser Callback
639 Status
= mUefiFormBrowser2
->BrowserCallback (
648 if (!EFI_ERROR (Status
)) {
650 // No Resluts Data, only allocate one char for '\0'
652 ResultsData
= AllocateZeroPool (sizeof (CHAR16
));
656 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
661 // Allocate the ResultsData buffer
663 ResultsData
= AllocateZeroPool (ResultsDataSize
);
664 if (ResultsData
== NULL
) {
670 // Retrieve or set the ResultsData from the Browser Callback
672 Status
= mUefiFormBrowser2
->BrowserCallback (
676 (BOOLEAN
)(SetResultsData
== NULL
),
680 if (EFI_ERROR (Status
)) {
688 Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing
689 information that includes a GUID, an optional Unicode string name, and a device
690 path. The string returned is allocated with AllocatePool(). The caller is
691 responsible for freeing the allocated string with FreePool().
693 The format of a <ConfigHdr> is as follows:
695 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
697 @param[in] Guid Pointer to an EFI_GUID that is the routing information
698 GUID. Each of the 16 bytes in Guid is converted to
699 a 2 Unicode character hexadecimal string. This is
700 an optional parameter that may be NULL.
701 @param[in] Name Pointer to a Null-terminated Unicode string that is
702 the routing information NAME. This is an optional
703 parameter that may be NULL. Each 16-bit Unicode
704 character in Name is converted to a 4 character Unicode
706 @param[in] DriverHandle The driver handle which supports a Device Path Protocol
707 that is the routing information PATH. Each byte of
708 the Device Path associated with DriverHandle is converted
709 to a 2 Unicode character hexadecimal string.
711 @retval NULL DriverHandle does not support the Device Path Protocol.
712 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string
717 HiiConstructConfigHdr (
718 IN CONST EFI_GUID
*Guid
, OPTIONAL
719 IN CONST CHAR16
*Name
, OPTIONAL
720 IN EFI_HANDLE DriverHandle
724 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
725 UINTN DevicePathSize
;
727 CHAR16
*ReturnString
;
733 // Compute the length of Name in Unicode characters.
734 // If Name is NULL, then the length is 0.
738 NameLength
= StrLen (Name
);
744 // Retrieve DevicePath Protocol associated with DriverHandle
746 if (DriverHandle
!= NULL
) {
747 DevicePath
= DevicePathFromHandle (DriverHandle
);
748 if (DevicePath
== NULL
) {
752 // Compute the size of the device path in bytes
754 DevicePathSize
= GetDevicePathSize (DevicePath
);
758 // GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize <Null>
759 // | 5 | sizeof (EFI_GUID) * 2 | 6 | NameStrLen*4 | 6 | DevicePathSize * 2 | 1 |
761 MaxLen
= 5 + sizeof (EFI_GUID
) * 2 + 6 + NameLength
* 4 + 6 + DevicePathSize
* 2 + 1;
762 String
= AllocateZeroPool (MaxLen
* sizeof (CHAR16
));
763 if (String
== NULL
) {
768 // Start with L"GUID="
770 StrCpyS (String
, MaxLen
, L
"GUID=");
771 ReturnString
= String
;
772 String
+= StrLen (String
);
776 // Append Guid converted to <HexCh>32
778 for (Index
= 0, Buffer
= (UINT8
*)Guid
; Index
< sizeof (EFI_GUID
); Index
++) {
779 UnicodeValueToStringS (
781 MaxLen
* sizeof (CHAR16
) - ((UINTN
)String
- (UINTN
)ReturnString
),
782 PREFIX_ZERO
| RADIX_HEX
,
786 String
+= StrnLenS (String
, MaxLen
- ((UINTN
)String
- (UINTN
)ReturnString
) / sizeof (CHAR16
));
793 StrCatS (ReturnString
, MaxLen
, L
"&NAME=");
794 String
+= StrLen (String
);
798 // Append Name converted to <Char>NameLength
800 for (; *Name
!= L
'\0'; Name
++) {
801 UnicodeValueToStringS (
803 sizeof (CHAR16
) * MaxLen
- ((UINTN
)String
- (UINTN
)ReturnString
),
804 PREFIX_ZERO
| RADIX_HEX
,
808 String
+= StrnLenS (String
, MaxLen
- ((UINTN
)String
- (UINTN
)ReturnString
) / sizeof (CHAR16
));
815 StrCatS (ReturnString
, MaxLen
, L
"&PATH=");
816 String
+= StrLen (String
);
819 // Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize
821 for (Index
= 0, Buffer
= (UINT8
*)DevicePath
; Index
< DevicePathSize
; Index
++) {
822 UnicodeValueToStringS (
824 sizeof (CHAR16
) * MaxLen
- ((UINTN
)String
- (UINTN
)ReturnString
),
825 PREFIX_ZERO
| RADIX_HEX
,
829 String
+= StrnLenS (String
, MaxLen
- ((UINTN
)String
- (UINTN
)ReturnString
) / sizeof (CHAR16
));
833 // Null terminate the Unicode string
838 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
840 return InternalHiiLowerConfigString (ReturnString
);
844 Convert the hex UNICODE encoding string of UEFI GUID, NAME or device path
845 to binary buffer from <ConfigHdr>.
847 This is a internal function.
849 @param String UEFI configuration string.
850 @param Flag Flag specifies what type buffer will be retrieved.
851 @param Buffer Binary of Guid, Name or Device path.
853 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.
854 @retval EFI_OUT_OF_RESOURCES Lake of resources to store neccesary structures.
855 @retval EFI_SUCCESS The buffer data is retrieved and translated to
860 InternalHiiGetBufferFromString (
861 IN EFI_STRING String
,
867 EFI_STRING ConfigHdr
;
874 if (String
== NULL
|| Buffer
== NULL
) {
875 return EFI_INVALID_PARAMETER
;
882 // The content between 'GUID', 'NAME', 'PATH' of <ConfigHdr> and '&' of next element
883 // or '\0' (end of configuration string) is the UNICODE %02x bytes encoding string.
885 for (Length
= 0; *String
!= 0 && *String
!= L
'&'; String
++, Length
++);
888 case GUID_CONFIG_STRING_TYPE
:
889 case PATH_CONFIG_STRING_TYPE
:
891 // The data in <ConfigHdr> is encoded as hex UNICODE %02x bytes in the same order
892 // as the device path and Guid resides in RAM memory.
893 // Translate the data into binary.
895 DataBuffer
= (UINT8
*) AllocateZeroPool ((Length
+ 1) / 2);
896 if (DataBuffer
== NULL
) {
897 return EFI_OUT_OF_RESOURCES
;
900 // Convert binary byte one by one
902 ZeroMem (TemStr
, sizeof (TemStr
));
903 for (Index
= 0; Index
< Length
; Index
++) {
904 TemStr
[0] = ConfigHdr
[Index
];
905 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
906 if ((Index
& 1) == 0) {
907 DataBuffer
[Index
/2] = DigitUint8
;
909 DataBuffer
[Index
/2] = (UINT8
) ((DataBuffer
[Index
/2] << 4) + DigitUint8
);
913 *Buffer
= DataBuffer
;
916 case NAME_CONFIG_STRING_TYPE
:
918 // Convert Config String to Unicode String, e.g. "0041004200430044" => "ABCD"
922 // Add the tailling char L'\0'
924 DataBuffer
= (UINT8
*) AllocateZeroPool ((Length
/4 + 1) * sizeof (CHAR16
));
925 if (DataBuffer
== NULL
) {
926 return EFI_OUT_OF_RESOURCES
;
929 // Convert character one by one
931 StringPtr
= (CHAR16
*) DataBuffer
;
932 ZeroMem (TemStr
, sizeof (TemStr
));
933 for (Index
= 0; Index
< Length
; Index
+= 4) {
934 StrnCpyS (TemStr
, sizeof (TemStr
) / sizeof (CHAR16
), ConfigHdr
+ Index
, 4);
935 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
938 // Add tailing L'\0' character
940 StringPtr
[Index
/4] = L
'\0';
942 *Buffer
= DataBuffer
;
946 return EFI_INVALID_PARAMETER
;
953 This function checks VarOffset and VarWidth is in the block range.
955 @param BlockArray The block array is to be checked.
956 @param VarOffset Offset of var to the structure
957 @param VarWidth Width of var.
959 @retval TRUE This Var is in the block range.
960 @retval FALSE This Var is not in the block range.
964 IN IFR_BLOCK_DATA
*BlockArray
,
970 IFR_BLOCK_DATA
*BlockData
;
973 // No Request Block array, all vars are got.
975 if (BlockArray
== NULL
) {
980 // Check the input var is in the request block range.
982 for (Link
= BlockArray
->Entry
.ForwardLink
; Link
!= &BlockArray
->Entry
; Link
= Link
->ForwardLink
) {
983 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
984 if ((VarOffset
>= BlockData
->Offset
) && ((VarOffset
+ VarWidth
) <= (BlockData
->Offset
+ BlockData
->Width
))) {
993 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET
995 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
997 @param ValueString String in <BlockConfig> format and points to the
998 first character of <Number>.
999 @param ValueData The output value. Caller takes the responsibility
1001 @param ValueLength Length of the <Number>, in characters.
1003 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary
1005 @retval EFI_SUCCESS Value of <Number> is outputted in Number
1011 InternalHiiGetValueOfNumber (
1012 IN EFI_STRING ValueString
,
1013 OUT UINT8
**ValueData
,
1014 OUT UINTN
*ValueLength
1017 EFI_STRING StringPtr
;
1024 ASSERT (ValueString
!= NULL
&& ValueData
!= NULL
&& ValueLength
!= NULL
);
1025 ASSERT (*ValueString
!= L
'\0');
1028 // Get the length of value string
1030 StringPtr
= ValueString
;
1031 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
1034 Length
= StringPtr
- ValueString
;
1037 // Allocate buffer to store the value
1039 Buf
= (UINT8
*) AllocateZeroPool ((Length
+ 1) / 2);
1041 return EFI_OUT_OF_RESOURCES
;
1045 // Convert character one by one to the value buffer
1047 ZeroMem (TemStr
, sizeof (TemStr
));
1048 for (Index
= 0; Index
< Length
; Index
++) {
1049 TemStr
[0] = ValueString
[Length
- Index
- 1];
1050 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1051 if ((Index
& 1) == 0) {
1052 Buf
[Index
/2] = DigitUint8
;
1054 Buf
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Buf
[Index
/2]);
1059 // Set the converted value and string length.
1062 *ValueLength
= Length
;
1067 Get value from config request resp string.
1069 @param ConfigElement ConfigResp string contains the current setting.
1070 @param VarName The variable name which need to get value.
1071 @param VarValue The return value.
1073 @retval EFI_SUCCESS Get the value for the VarName
1074 @retval EFI_OUT_OF_RESOURCES The memory is not enough.
1077 GetValueFromRequest (
1078 IN CHAR16
*ConfigElement
,
1080 OUT UINT64
*VarValue
1089 // Find VarName related string.
1091 StringPtr
= StrStr (ConfigElement
, VarName
);
1092 ASSERT (StringPtr
!= NULL
);
1095 // Skip the "VarName=" string
1097 StringPtr
+= StrLen (VarName
) + 1;
1102 Status
= InternalHiiGetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1103 if (EFI_ERROR (Status
)) {
1108 CopyMem (VarValue
, TmpBuffer
, (((Length
+ 1) / 2) < sizeof (UINT64
)) ? ((Length
+ 1) / 2) : sizeof (UINT64
));
1110 FreePool (TmpBuffer
);
1116 This internal function parses IFR data to validate current setting.
1118 Base on the NameValueType, if it is TRUE, RequestElement and HiiHandle is valid;
1119 else the VarBuffer and CurrentBlockArray is valid.
1121 @param HiiPackageList Point to Hii package list.
1122 @param PackageListLength The length of the pacakge.
1123 @param VarGuid Guid of the buffer storage.
1124 @param VarName Name of the buffer storage.
1125 @param VarBuffer The data buffer for the storage.
1126 @param CurrentBlockArray The block array from the config Requst string.
1127 @param RequestElement The config string for this storage.
1128 @param HiiHandle The HiiHandle for this formset.
1129 @param NameValueType Whether current storage is name/value varstore or not.
1131 @retval EFI_SUCCESS The current setting is valid.
1132 @retval EFI_OUT_OF_RESOURCES The memory is not enough.
1133 @retval EFI_INVALID_PARAMETER The config string or the Hii package is invalid.
1136 ValidateQuestionFromVfr (
1137 IN EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
,
1138 IN UINTN PackageListLength
,
1139 IN EFI_GUID
*VarGuid
,
1141 IN UINT8
*VarBuffer
,
1142 IN IFR_BLOCK_DATA
*CurrentBlockArray
,
1143 IN CHAR16
*RequestElement
,
1144 IN EFI_HII_HANDLE HiiHandle
,
1145 IN BOOLEAN NameValueType
1148 IFR_BLOCK_DATA VarBlockData
;
1152 EFI_IFR_TYPE_VALUE TmpValue
;
1154 EFI_HII_PACKAGE_HEADER PackageHeader
;
1155 UINT32 PackageOffset
;
1158 EFI_IFR_OP_HEADER
*IfrOpHdr
;
1159 EFI_IFR_VARSTORE
*IfrVarStore
;
1160 EFI_IFR_VARSTORE_NAME_VALUE
*IfrNameValueStore
;
1161 EFI_IFR_VARSTORE_EFI
*IfrEfiVarStore
;
1162 IFR_VARSTORAGE_DATA VarStoreData
;
1163 EFI_IFR_ONE_OF
*IfrOneOf
;
1164 EFI_IFR_NUMERIC
*IfrNumeric
;
1165 EFI_IFR_ONE_OF_OPTION
*IfrOneOfOption
;
1166 EFI_IFR_CHECKBOX
*IfrCheckBox
;
1167 EFI_IFR_STRING
*IfrString
;
1168 CHAR8
*VarStoreName
;
1170 CHAR16
*QuestionName
;
1174 // Initialize the local variables.
1177 VarStoreName
= NULL
;
1178 Status
= EFI_SUCCESS
;
1181 IfrNameValueStore
= NULL
;
1182 IfrEfiVarStore
= NULL
;
1183 ZeroMem (&VarStoreData
, sizeof (IFR_VARSTORAGE_DATA
));
1184 ZeroMem (&VarBlockData
, sizeof (VarBlockData
));
1187 // Check IFR value is in block data, then Validate Value
1189 PackageOffset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
1190 while (PackageOffset
< PackageListLength
) {
1191 CopyMem (&PackageHeader
, (UINT8
*) HiiPackageList
+ PackageOffset
, sizeof (PackageHeader
));
1194 // Parse IFR opcode from the form package.
1196 if (PackageHeader
.Type
== EFI_HII_PACKAGE_FORMS
) {
1197 IfrOffset
= sizeof (PackageHeader
);
1198 PackageData
= (UINT8
*) HiiPackageList
+ PackageOffset
;
1199 while (IfrOffset
< PackageHeader
.Length
) {
1200 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) (PackageData
+ IfrOffset
);
1202 // Validate current setting to the value built in IFR opcode
1204 switch (IfrOpHdr
->OpCode
) {
1205 case EFI_IFR_VARSTORE_OP
:
1207 // VarStoreId has been found. No further found.
1209 if (VarStoreData
.VarStoreId
!= 0) {
1213 // Find the matched VarStoreId to the input VarGuid and VarName
1215 IfrVarStore
= (EFI_IFR_VARSTORE
*) IfrOpHdr
;
1216 if (CompareGuid ((EFI_GUID
*) (VOID
*) &IfrVarStore
->Guid
, VarGuid
)) {
1217 VarStoreName
= (CHAR8
*) IfrVarStore
->Name
;
1218 for (Index
= 0; VarStoreName
[Index
] != 0; Index
++) {
1219 if ((CHAR16
) VarStoreName
[Index
] != VarName
[Index
]) {
1224 // The matched VarStore is found.
1226 if ((VarStoreName
[Index
] != 0) || (VarName
[Index
] != 0)) {
1233 if (IfrVarStore
!= NULL
) {
1234 VarStoreData
.VarStoreId
= IfrVarStore
->VarStoreId
;
1235 VarStoreData
.Size
= IfrVarStore
->Size
;
1238 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1240 // VarStoreId has been found. No further found.
1242 if (VarStoreData
.VarStoreId
!= 0) {
1246 // Find the matched VarStoreId to the input VarGuid
1248 IfrNameValueStore
= (EFI_IFR_VARSTORE_NAME_VALUE
*) IfrOpHdr
;
1249 if (!CompareGuid ((EFI_GUID
*) (VOID
*) &IfrNameValueStore
->Guid
, VarGuid
)) {
1250 IfrNameValueStore
= NULL
;
1253 if (IfrNameValueStore
!= NULL
) {
1254 VarStoreData
.VarStoreId
= IfrNameValueStore
->VarStoreId
;
1257 case EFI_IFR_VARSTORE_EFI_OP
:
1259 // VarStore is found. Don't need to search any more.
1261 if (VarStoreData
.VarStoreId
!= 0) {
1265 IfrEfiVarStore
= (EFI_IFR_VARSTORE_EFI
*) IfrOpHdr
;
1268 // If the length is small than the structure, this is from old efi
1269 // varstore definition. Old efi varstore get config directly from
1270 // GetVariable function.
1272 if (IfrOpHdr
->Length
< sizeof (EFI_IFR_VARSTORE_EFI
)) {
1276 if (CompareGuid ((EFI_GUID
*) (VOID
*) &IfrEfiVarStore
->Guid
, VarGuid
)) {
1277 VarStoreName
= (CHAR8
*) IfrEfiVarStore
->Name
;
1278 for (Index
= 0; VarStoreName
[Index
] != 0; Index
++) {
1279 if ((CHAR16
) VarStoreName
[Index
] != VarName
[Index
]) {
1284 // The matched VarStore is found.
1286 if ((VarStoreName
[Index
] != 0) || (VarName
[Index
] != 0)) {
1287 IfrEfiVarStore
= NULL
;
1290 IfrEfiVarStore
= NULL
;
1293 if (IfrEfiVarStore
!= NULL
) {
1295 // Find the matched VarStore
1297 VarStoreData
.VarStoreId
= IfrEfiVarStore
->VarStoreId
;
1298 VarStoreData
.Size
= IfrEfiVarStore
->Size
;
1301 case EFI_IFR_FORM_OP
:
1302 case EFI_IFR_FORM_MAP_OP
:
1304 // Check the matched VarStoreId is found.
1306 if (VarStoreData
.VarStoreId
== 0) {
1310 case EFI_IFR_ONE_OF_OP
:
1312 // Check whether current value is the one of option.
1316 // OneOf question is not in IFR Form. This IFR form is not valid.
1318 if (VarStoreData
.VarStoreId
== 0) {
1319 return EFI_INVALID_PARAMETER
;
1322 // Check whether this question is for the requested varstore.
1324 IfrOneOf
= (EFI_IFR_ONE_OF
*) IfrOpHdr
;
1325 if (IfrOneOf
->Question
.VarStoreId
!= VarStoreData
.VarStoreId
) {
1329 if (NameValueType
) {
1330 QuestionName
= HiiGetString (HiiHandle
, IfrOneOf
->Question
.VarStoreInfo
.VarName
, NULL
);
1331 ASSERT (QuestionName
!= NULL
);
1333 if (StrStr (RequestElement
, QuestionName
) == NULL
) {
1335 // This question is not in the current configuration string. Skip it.
1340 Status
= GetValueFromRequest (RequestElement
, QuestionName
, &VarValue
);
1341 if (EFI_ERROR (Status
)) {
1346 // Get Offset by Question header and Width by DataType Flags
1348 Offset
= IfrOneOf
->Question
.VarStoreInfo
.VarOffset
;
1349 Width
= (UINT16
) (1 << (IfrOneOf
->Flags
& EFI_IFR_NUMERIC_SIZE
));
1351 // Check whether this question is in current block array.
1353 if (!BlockArrayCheck (CurrentBlockArray
, Offset
, Width
)) {
1355 // This question is not in the current configuration string. Skip it.
1360 // Check this var question is in the var storage
1362 if ((Offset
+ Width
) > VarStoreData
.Size
) {
1364 // This question exceeds the var store size.
1366 return EFI_INVALID_PARAMETER
;
1370 // Get the current value for oneof opcode
1373 CopyMem (&VarValue
, VarBuffer
+ Offset
, Width
);
1376 // Set Block Data, to be checked in the following Oneof option opcode.
1378 VarBlockData
.OpCode
= IfrOpHdr
->OpCode
;
1379 VarBlockData
.Scope
= IfrOpHdr
->Scope
;
1381 case EFI_IFR_NUMERIC_OP
:
1383 // Check the current value is in the numeric range.
1387 // Numeric question is not in IFR Form. This IFR form is not valid.
1389 if (VarStoreData
.VarStoreId
== 0) {
1390 return EFI_INVALID_PARAMETER
;
1393 // Check whether this question is for the requested varstore.
1395 IfrNumeric
= (EFI_IFR_NUMERIC
*) IfrOpHdr
;
1396 if (IfrNumeric
->Question
.VarStoreId
!= VarStoreData
.VarStoreId
) {
1400 if (NameValueType
) {
1401 QuestionName
= HiiGetString (HiiHandle
, IfrNumeric
->Question
.VarStoreInfo
.VarName
, NULL
);
1402 ASSERT (QuestionName
!= NULL
);
1404 if (StrStr (RequestElement
, QuestionName
) == NULL
) {
1406 // This question is not in the current configuration string. Skip it.
1411 Status
= GetValueFromRequest (RequestElement
, QuestionName
, &VarValue
);
1412 if (EFI_ERROR (Status
)) {
1417 // Get Offset by Question header and Width by DataType Flags
1419 Offset
= IfrNumeric
->Question
.VarStoreInfo
.VarOffset
;
1420 Width
= (UINT16
) (1 << (IfrNumeric
->Flags
& EFI_IFR_NUMERIC_SIZE
));
1422 // Check whether this question is in current block array.
1424 if (!BlockArrayCheck (CurrentBlockArray
, Offset
, Width
)) {
1426 // This question is not in the current configuration string. Skip it.
1431 // Check this var question is in the var storage
1433 if ((Offset
+ Width
) > VarStoreData
.Size
) {
1435 // This question exceeds the var store size.
1437 return EFI_INVALID_PARAMETER
;
1441 // Check the current value is in the numeric range.
1444 CopyMem (&VarValue
, VarBuffer
+ Offset
, Width
);
1446 if ((IfrNumeric
->Flags
& EFI_IFR_DISPLAY
) == 0) {
1447 switch (IfrNumeric
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1448 case EFI_IFR_NUMERIC_SIZE_1
:
1449 if ((INT8
) VarValue
< (INT8
) IfrNumeric
->data
.u8
.MinValue
|| (INT8
) VarValue
> (INT8
) IfrNumeric
->data
.u8
.MaxValue
) {
1451 // Not in the valid range.
1453 return EFI_INVALID_PARAMETER
;
1456 case EFI_IFR_NUMERIC_SIZE_2
:
1457 if ((INT16
) VarValue
< (INT16
) IfrNumeric
->data
.u16
.MinValue
|| (INT16
) VarValue
> (INT16
) IfrNumeric
->data
.u16
.MaxValue
) {
1459 // Not in the valid range.
1461 return EFI_INVALID_PARAMETER
;
1464 case EFI_IFR_NUMERIC_SIZE_4
:
1465 if ((INT32
) VarValue
< (INT32
) IfrNumeric
->data
.u32
.MinValue
|| (INT32
) VarValue
> (INT32
) IfrNumeric
->data
.u32
.MaxValue
) {
1467 // Not in the valid range.
1469 return EFI_INVALID_PARAMETER
;
1472 case EFI_IFR_NUMERIC_SIZE_8
:
1473 if ((INT64
) VarValue
< (INT64
) IfrNumeric
->data
.u64
.MinValue
|| (INT64
) VarValue
> (INT64
) IfrNumeric
->data
.u64
.MaxValue
) {
1475 // Not in the valid range.
1477 return EFI_INVALID_PARAMETER
;
1482 switch (IfrNumeric
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1483 case EFI_IFR_NUMERIC_SIZE_1
:
1484 if ((UINT8
) VarValue
< IfrNumeric
->data
.u8
.MinValue
|| (UINT8
) VarValue
> IfrNumeric
->data
.u8
.MaxValue
) {
1486 // Not in the valid range.
1488 return EFI_INVALID_PARAMETER
;
1491 case EFI_IFR_NUMERIC_SIZE_2
:
1492 if ((UINT16
) VarValue
< IfrNumeric
->data
.u16
.MinValue
|| (UINT16
) VarValue
> IfrNumeric
->data
.u16
.MaxValue
) {
1494 // Not in the valid range.
1496 return EFI_INVALID_PARAMETER
;
1499 case EFI_IFR_NUMERIC_SIZE_4
:
1500 if ((UINT32
) VarValue
< IfrNumeric
->data
.u32
.MinValue
|| (UINT32
) VarValue
> IfrNumeric
->data
.u32
.MaxValue
) {
1502 // Not in the valid range.
1504 return EFI_INVALID_PARAMETER
;
1507 case EFI_IFR_NUMERIC_SIZE_8
:
1508 if ((UINT64
) VarValue
< IfrNumeric
->data
.u64
.MinValue
|| (UINT64
) VarValue
> IfrNumeric
->data
.u64
.MaxValue
) {
1510 // Not in the valid range.
1512 return EFI_INVALID_PARAMETER
;
1518 case EFI_IFR_CHECKBOX_OP
:
1520 // Check value is BOOLEAN type, only 0 and 1 is valid.
1524 // CheckBox question is not in IFR Form. This IFR form is not valid.
1526 if (VarStoreData
.VarStoreId
== 0) {
1527 return EFI_INVALID_PARAMETER
;
1531 // Check whether this question is for the requested varstore.
1533 IfrCheckBox
= (EFI_IFR_CHECKBOX
*) IfrOpHdr
;
1534 if (IfrCheckBox
->Question
.VarStoreId
!= VarStoreData
.VarStoreId
) {
1538 if (NameValueType
) {
1539 QuestionName
= HiiGetString (HiiHandle
, IfrCheckBox
->Question
.VarStoreInfo
.VarName
, NULL
);
1540 ASSERT (QuestionName
!= NULL
);
1542 if (StrStr (RequestElement
, QuestionName
) == NULL
) {
1544 // This question is not in the current configuration string. Skip it.
1549 Status
= GetValueFromRequest (RequestElement
, QuestionName
, &VarValue
);
1550 if (EFI_ERROR (Status
)) {
1555 // Get Offset by Question header
1557 Offset
= IfrCheckBox
->Question
.VarStoreInfo
.VarOffset
;
1558 Width
= (UINT16
) sizeof (BOOLEAN
);
1560 // Check whether this question is in current block array.
1562 if (!BlockArrayCheck (CurrentBlockArray
, Offset
, Width
)) {
1564 // This question is not in the current configuration string. Skip it.
1569 // Check this var question is in the var storage
1571 if ((Offset
+ Width
) > VarStoreData
.Size
) {
1573 // This question exceeds the var store size.
1575 return EFI_INVALID_PARAMETER
;
1578 // Check the current value is in the numeric range.
1581 CopyMem (&VarValue
, VarBuffer
+ Offset
, Width
);
1584 // Boolean type, only 1 and 0 is valid.
1587 return EFI_INVALID_PARAMETER
;
1590 case EFI_IFR_STRING_OP
:
1592 // Check current string length is less than maxsize
1596 // CheckBox question is not in IFR Form. This IFR form is not valid.
1598 if (VarStoreData
.VarStoreId
== 0) {
1599 return EFI_INVALID_PARAMETER
;
1603 // Check whether this question is for the requested varstore.
1605 IfrString
= (EFI_IFR_STRING
*) IfrOpHdr
;
1606 if (IfrString
->Question
.VarStoreId
!= VarStoreData
.VarStoreId
) {
1610 // Get the Max size of the string.
1612 Width
= (UINT16
) (IfrString
->MaxSize
* sizeof (UINT16
));
1613 if (NameValueType
) {
1614 QuestionName
= HiiGetString (HiiHandle
, IfrString
->Question
.VarStoreInfo
.VarName
, NULL
);
1615 ASSERT (QuestionName
!= NULL
);
1617 StringPtr
= StrStr (RequestElement
, QuestionName
);
1618 if (StringPtr
== NULL
) {
1620 // This question is not in the current configuration string. Skip it.
1625 // Skip the VarName.
1627 StringPtr
+= StrLen (QuestionName
);
1635 // Check current string length is less than maxsize
1636 // e.g Config String: "0041004200430044", Unicode String: "ABCD". Unicode String length = Config String length / 4.
1637 // Config string format in UEFI spec.
1638 // <NvConfig> ::= <Label>'='<String>
1639 // <String> ::= [<Char>]+
1640 // <Char> ::= <HexCh>4
1642 if (StrLen (StringPtr
) / 4 > IfrString
->MaxSize
) {
1643 return EFI_INVALID_PARAMETER
;
1647 // Get Offset/Width by Question header and OneOf Flags
1649 Offset
= IfrString
->Question
.VarStoreInfo
.VarOffset
;
1651 // Check whether this question is in current block array.
1653 if (!BlockArrayCheck (CurrentBlockArray
, Offset
, Width
)) {
1655 // This question is not in the current configuration string. Skip it.
1660 // Check this var question is in the var storage
1662 if ((Offset
+ Width
) > VarStoreData
.Size
) {
1664 // This question exceeds the var store size.
1666 return EFI_INVALID_PARAMETER
;
1670 // Check current string length is less than maxsize
1672 if (StrLen ((CHAR16
*) (VarBuffer
+ Offset
)) > IfrString
->MaxSize
) {
1673 return EFI_INVALID_PARAMETER
;
1677 case EFI_IFR_ONE_OF_OPTION_OP
:
1679 // Opcode Scope is zero. This one of option is not to be checked.
1681 if (VarBlockData
.Scope
== 0) {
1686 // Only check for OneOf and OrderList opcode
1688 IfrOneOfOption
= (EFI_IFR_ONE_OF_OPTION
*) IfrOpHdr
;
1689 if (VarBlockData
.OpCode
== EFI_IFR_ONE_OF_OP
) {
1691 // Check current value is the value of one of option.
1693 ASSERT (IfrOneOfOption
->Type
<= EFI_IFR_TYPE_NUM_SIZE_64
);
1694 ZeroMem (&TmpValue
, sizeof (EFI_IFR_TYPE_VALUE
));
1695 CopyMem (&TmpValue
, &IfrOneOfOption
->Value
, IfrOneOfOption
->Header
.Length
- OFFSET_OF (EFI_IFR_ONE_OF_OPTION
, Value
));
1696 if (VarValue
== TmpValue
.u64
) {
1698 // The value is one of option value.
1699 // Set OpCode to Zero, don't need check again.
1701 VarBlockData
.OpCode
= 0;
1705 case EFI_IFR_END_OP
:
1707 // Decrease opcode scope for the validated opcode
1709 if (VarBlockData
.Scope
> 0) {
1710 VarBlockData
.Scope
--;
1714 // OneOf value doesn't belong to one of option value.
1716 if ((VarBlockData
.Scope
== 0) && (VarBlockData
.OpCode
== EFI_IFR_ONE_OF_OP
)) {
1717 return EFI_INVALID_PARAMETER
;
1722 // Increase Scope for the validated opcode
1724 if (VarBlockData
.Scope
> 0) {
1725 VarBlockData
.Scope
= (UINT8
) (VarBlockData
.Scope
+ IfrOpHdr
->Scope
);
1730 // Go to the next opcode
1732 IfrOffset
+= IfrOpHdr
->Length
;
1735 // Only one form is in a package list.
1741 // Go to next package.
1743 PackageOffset
+= PackageHeader
.Length
;
1750 This internal function parses IFR data to validate current setting.
1752 @param ConfigElement ConfigResp element string contains the current setting.
1753 @param CurrentBlockArray Current block array.
1754 @param VarBuffer Data buffer for this varstore.
1756 @retval EFI_SUCCESS The current setting is valid.
1757 @retval EFI_OUT_OF_RESOURCES The memory is not enough.
1758 @retval EFI_INVALID_PARAMETER The config string or the Hii package is invalid.
1762 IN CHAR16
*ConfigElement
,
1763 OUT IFR_BLOCK_DATA
**CurrentBlockArray
,
1764 OUT UINT8
**VarBuffer
1767 IFR_BLOCK_DATA
*BlockData
;
1768 IFR_BLOCK_DATA
*NewBlockData
;
1769 EFI_STRING StringPtr
;
1775 UINTN MaxBufferSize
;
1777 IFR_BLOCK_DATA
*BlockArray
;
1781 // Initialize the local variables.
1783 Status
= EFI_SUCCESS
;
1785 NewBlockData
= NULL
;
1788 MaxBufferSize
= HII_LIB_DEFAULT_VARSTORE_SIZE
;
1789 DataBuffer
= AllocateZeroPool (MaxBufferSize
);
1790 if (DataBuffer
== NULL
) {
1791 return EFI_OUT_OF_RESOURCES
;
1797 BlockArray
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1798 if (BlockArray
== NULL
) {
1799 Status
= EFI_OUT_OF_RESOURCES
;
1802 InitializeListHead (&BlockArray
->Entry
);
1804 StringPtr
= StrStr (ConfigElement
, L
"&OFFSET=");
1805 ASSERT (StringPtr
!= NULL
);
1808 // Parse each <RequestElement> if exists
1809 // Only <BlockName> format is supported by this help function.
1810 // <BlockName> ::= &'OFFSET='<Number>&'WIDTH='<Number>
1812 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) == 0) {
1814 // Skip the &OFFSET= string
1816 StringPtr
+= StrLen (L
"&OFFSET=");
1821 Status
= InternalHiiGetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1822 if (EFI_ERROR (Status
)) {
1829 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
1831 FreePool (TmpBuffer
);
1834 StringPtr
+= Length
;
1835 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
1836 Status
= EFI_INVALID_PARAMETER
;
1839 StringPtr
+= StrLen (L
"&WIDTH=");
1844 Status
= InternalHiiGetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1845 if (EFI_ERROR (Status
)) {
1852 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
1854 FreePool (TmpBuffer
);
1857 StringPtr
+= Length
;
1858 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
1859 Status
= EFI_INVALID_PARAMETER
;
1863 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) != 0) {
1864 Status
= EFI_INVALID_PARAMETER
;
1867 StringPtr
+= StrLen (L
"&VALUE=");
1872 Status
= InternalHiiGetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1873 if (EFI_ERROR (Status
)) {
1877 StringPtr
+= Length
;
1878 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
1879 Status
= EFI_INVALID_PARAMETER
;
1884 // Check whether VarBuffer is enough
1886 if ((UINT32
)Offset
+ Width
> MaxBufferSize
) {
1887 DataBuffer
= ReallocatePool (
1889 Offset
+ Width
+ HII_LIB_DEFAULT_VARSTORE_SIZE
,
1892 if (DataBuffer
== NULL
) {
1893 Status
= EFI_OUT_OF_RESOURCES
;
1896 MaxBufferSize
= Offset
+ Width
+ HII_LIB_DEFAULT_VARSTORE_SIZE
;
1900 // Update the Block with configuration info
1902 CopyMem (DataBuffer
+ Offset
, TmpBuffer
, Width
);
1903 FreePool (TmpBuffer
);
1907 // Set new Block Data
1909 NewBlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1910 if (NewBlockData
== NULL
) {
1911 Status
= EFI_OUT_OF_RESOURCES
;
1914 NewBlockData
->Offset
= Offset
;
1915 NewBlockData
->Width
= Width
;
1918 // Insert the new block data into the block data array.
1920 for (Link
= BlockArray
->Entry
.ForwardLink
; Link
!= &BlockArray
->Entry
; Link
= Link
->ForwardLink
) {
1921 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
1922 if (NewBlockData
->Offset
== BlockData
->Offset
) {
1923 if (NewBlockData
->Width
> BlockData
->Width
) {
1924 BlockData
->Width
= NewBlockData
->Width
;
1926 FreePool (NewBlockData
);
1928 } else if (NewBlockData
->Offset
< BlockData
->Offset
) {
1930 // Insert new block data as the previous one of this link.
1932 InsertTailList (Link
, &NewBlockData
->Entry
);
1938 // Insert new block data into the array tail.
1940 if (Link
== &BlockArray
->Entry
) {
1941 InsertTailList (Link
, &NewBlockData
->Entry
);
1945 // If '\0', parsing is finished.
1947 if (*StringPtr
== 0) {
1951 // Go to next ConfigBlock
1956 // Merge the aligned block data into the single block data.
1958 Link
= BlockArray
->Entry
.ForwardLink
;
1959 while ((Link
!= &BlockArray
->Entry
) && (Link
->ForwardLink
!= &BlockArray
->Entry
)) {
1960 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
1961 NewBlockData
= BASE_CR (Link
->ForwardLink
, IFR_BLOCK_DATA
, Entry
);
1962 if ((NewBlockData
->Offset
>= BlockData
->Offset
) && (NewBlockData
->Offset
<= (BlockData
->Offset
+ BlockData
->Width
))) {
1963 if ((NewBlockData
->Offset
+ NewBlockData
->Width
) > (BlockData
->Offset
+ BlockData
->Width
)) {
1964 BlockData
->Width
= (UINT16
) (NewBlockData
->Offset
+ NewBlockData
->Width
- BlockData
->Offset
);
1966 RemoveEntryList (Link
->ForwardLink
);
1967 FreePool (NewBlockData
);
1970 Link
= Link
->ForwardLink
;
1973 *VarBuffer
= DataBuffer
;
1974 *CurrentBlockArray
= BlockArray
;
1978 if (DataBuffer
!= NULL
) {
1979 FreePool (DataBuffer
);
1982 if (BlockArray
!= NULL
) {
1984 // Free Link Array CurrentBlockArray
1986 while (!IsListEmpty (&BlockArray
->Entry
)) {
1987 BlockData
= BASE_CR (BlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
1988 RemoveEntryList (&BlockData
->Entry
);
1989 FreePool (BlockData
);
1991 FreePool (BlockArray
);
1998 This internal function parses IFR data to validate current setting.
2000 @param ConfigResp ConfigResp string contains the current setting.
2001 @param HiiPackageList Point to Hii package list.
2002 @param PackageListLength The length of the pacakge.
2003 @param VarGuid Guid of the buffer storage.
2004 @param VarName Name of the buffer storage.
2005 @param HiiHandle The HiiHandle for this package.
2007 @retval EFI_SUCCESS The current setting is valid.
2008 @retval EFI_OUT_OF_RESOURCES The memory is not enough.
2009 @retval EFI_INVALID_PARAMETER The config string or the Hii package is invalid.
2013 InternalHiiValidateCurrentSetting (
2014 IN EFI_STRING ConfigResp
,
2015 IN EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
,
2016 IN UINTN PackageListLength
,
2017 IN EFI_GUID
*VarGuid
,
2019 IN EFI_HII_HANDLE HiiHandle
2024 IFR_BLOCK_DATA
*CurrentBlockArray
;
2025 IFR_BLOCK_DATA
*BlockData
;
2027 BOOLEAN NameValueType
;
2029 CurrentBlockArray
= NULL
;
2032 Status
= EFI_SUCCESS
;
2035 // If StringPtr != NULL, get the request elements.
2037 if (StrStr (ConfigResp
, L
"&OFFSET=") != NULL
) {
2038 Status
= GetBlockDataInfo(ConfigResp
, &CurrentBlockArray
, &VarBuffer
);
2039 if (EFI_ERROR (Status
)) {
2042 NameValueType
= FALSE
;
2045 // Skip header part.
2047 StringPtr
= StrStr (ConfigResp
, L
"PATH=");
2048 ASSERT (StringPtr
!= NULL
);
2050 if (StrStr (StringPtr
, L
"&") != NULL
) {
2051 NameValueType
= TRUE
;
2054 // Not found Request element, return success.
2060 Status
= ValidateQuestionFromVfr(
2072 if (VarBuffer
!= NULL
) {
2073 FreePool (VarBuffer
);
2076 if (CurrentBlockArray
!= NULL
) {
2078 // Free Link Array CurrentBlockArray
2080 while (!IsListEmpty (&CurrentBlockArray
->Entry
)) {
2081 BlockData
= BASE_CR (CurrentBlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2082 RemoveEntryList (&BlockData
->Entry
);
2083 FreePool (BlockData
);
2085 FreePool (CurrentBlockArray
);
2092 Check whether the ConfigRequest string has the request elements.
2093 For EFI_HII_VARSTORE_BUFFER type, the request has "&OFFSET=****&WIDTH=****..." format.
2094 For EFI_HII_VARSTORE_NAME_VALUE type, the request has "&NAME1**&NAME2..." format.
2096 @param ConfigRequest The input config request string.
2098 @retval TRUE The input include config request elements.
2099 @retval FALSE The input string not includes.
2103 GetElementsFromRequest (
2104 IN EFI_STRING ConfigRequest
2107 EFI_STRING TmpRequest
;
2109 TmpRequest
= StrStr (ConfigRequest
, L
"PATH=");
2110 ASSERT (TmpRequest
!= NULL
);
2112 if ((StrStr (TmpRequest
, L
"&OFFSET=") != NULL
) || (StrStr (TmpRequest
, L
"&") != NULL
)) {
2120 This function parses the input ConfigRequest string and its matched IFR code
2121 string for setting default value and validating current setting.
2123 1. For setting default action, Reset the default value specified by DefaultId
2124 to the driver configuration got by Request string.
2125 2. For validating current setting, Validate the current configuration
2126 by parsing HII form IFR opcode.
2128 NULL request string support depends on the ExportConfig interface of
2129 HiiConfigRouting protocol in UEFI specification.
2131 @param Request A null-terminated Unicode string in
2132 <MultiConfigRequest> format. It can be NULL.
2133 If it is NULL, all current configuration for the
2134 entirety of the current HII database will be validated.
2135 If it is NULL, all configuration for the
2136 entirety of the current HII database will be reset.
2137 @param DefaultId Specifies the type of defaults to retrieve only for setting default action.
2138 @param ActionType Action supports setting defaults and validate current setting.
2140 @retval TRUE Action runs successfully.
2141 @retval FALSE Action is not valid or Action can't be executed successfully..
2145 InternalHiiIfrValueAction (
2146 IN CONST EFI_STRING Request
, OPTIONAL
2147 IN UINT16 DefaultId
,
2151 EFI_STRING ConfigAltResp
;
2152 EFI_STRING ConfigAltHdr
;
2153 EFI_STRING ConfigResp
;
2154 EFI_STRING Progress
;
2155 EFI_STRING StringPtr
;
2156 EFI_STRING StringHdr
;
2158 EFI_HANDLE DriverHandle
;
2159 EFI_HANDLE TempDriverHandle
;
2160 EFI_HII_HANDLE
*HiiHandleBuffer
;
2161 EFI_HII_HANDLE HiiHandle
;
2166 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
2167 UINTN PackageListLength
;
2169 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2170 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2172 ConfigAltResp
= NULL
;
2177 ConfigAltHdr
= NULL
;
2178 HiiHandleBuffer
= NULL
;
2180 TempDriverHandle
= NULL
;
2182 HiiPackageList
= NULL
;
2185 // Only support set default and validate setting action.
2187 if ((ActionType
!= ACTION_SET_DEFAUTL_VALUE
) && (ActionType
!= ACTION_VALIDATE_SETTING
)) {
2192 // Get the full requested value and deault value string.
2194 if (Request
!= NULL
) {
2195 Status
= gHiiConfigRouting
->ExtractConfig (
2202 Status
= gHiiConfigRouting
->ExportConfig (
2208 if (EFI_ERROR (Status
)) {
2212 StringPtr
= ConfigAltResp
;
2213 ASSERT (StringPtr
!= NULL
);
2215 while (*StringPtr
!= L
'\0') {
2217 // 1. Find <ConfigHdr> GUID=...&NAME=...&PATH=...
2219 StringHdr
= StringPtr
;
2224 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
2225 Status
= EFI_INVALID_PARAMETER
;
2228 StringPtr
+= StrLen (L
"GUID=");
2229 Status
= InternalHiiGetBufferFromString (StringPtr
, GUID_CONFIG_STRING_TYPE
, (UINT8
**) &VarGuid
);
2230 if (EFI_ERROR (Status
)) {
2235 // Get Name value VarName
2237 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
2240 if (*StringPtr
== L
'\0') {
2241 Status
= EFI_INVALID_PARAMETER
;
2244 StringPtr
+= StrLen (L
"&NAME=");
2245 Status
= InternalHiiGetBufferFromString (StringPtr
, NAME_CONFIG_STRING_TYPE
, (UINT8
**) &VarName
);
2246 if (EFI_ERROR (Status
)) {
2251 // Get Path value DevicePath
2253 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
2256 if (*StringPtr
== L
'\0') {
2257 Status
= EFI_INVALID_PARAMETER
;
2260 StringPtr
+= StrLen (L
"&PATH=");
2261 Status
= InternalHiiGetBufferFromString (StringPtr
, PATH_CONFIG_STRING_TYPE
, (UINT8
**) &DevicePath
);
2262 if (EFI_ERROR (Status
)) {
2267 // Get the Driver handle by the got device path.
2269 TempDevicePath
= DevicePath
;
2270 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &TempDevicePath
, &DriverHandle
);
2271 if (EFI_ERROR (Status
)) {
2276 // Find the matched Hii Handle for the found Driver handle
2278 HiiHandleBuffer
= HiiGetHiiHandles (NULL
);
2279 if (HiiHandleBuffer
== NULL
) {
2280 Status
= EFI_NOT_FOUND
;
2284 for (Index
= 0; HiiHandleBuffer
[Index
] != NULL
; Index
++) {
2285 gHiiDatabase
->GetPackageListHandle (gHiiDatabase
, HiiHandleBuffer
[Index
], &TempDriverHandle
);
2286 if (TempDriverHandle
== DriverHandle
) {
2291 HiiHandle
= HiiHandleBuffer
[Index
];
2292 FreePool (HiiHandleBuffer
);
2294 if (HiiHandle
== NULL
) {
2296 // This request string has no its Hii package.
2297 // Its default value and validating can't execute by parsing IFR data.
2298 // Directly jump into the next ConfigAltResp string for another pair Guid, Name, and Path.
2300 Status
= EFI_SUCCESS
;
2301 goto NextConfigAltResp
;
2305 // 2. Get HiiPackage by HiiHandle
2307 PackageListLength
= 0;
2308 HiiPackageList
= NULL
;
2309 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, HiiHandle
, &PackageListLength
, HiiPackageList
);
2312 // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.
2314 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2315 Status
= EFI_INVALID_PARAMETER
;
2319 HiiPackageList
= AllocatePool (PackageListLength
);
2320 if (HiiPackageList
== NULL
) {
2321 Status
= EFI_OUT_OF_RESOURCES
;
2326 // Get PackageList on HiiHandle
2328 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, HiiHandle
, &PackageListLength
, HiiPackageList
);
2329 if (EFI_ERROR (Status
)) {
2334 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
2335 // Get the default configuration string according to the default ID.
2337 Status
= gHiiConfigRouting
->GetAltConfig (
2343 (ActionType
== ACTION_SET_DEFAUTL_VALUE
) ? &DefaultId
:NULL
, // it can be NULL to get the current setting.
2348 // The required setting can't be found. So, it is not required to be validated and set.
2350 if (EFI_ERROR (Status
)) {
2351 Status
= EFI_SUCCESS
;
2352 goto NextConfigAltResp
;
2355 // Only the ConfigHdr is found. Not any block data is found. No data is required to be validated and set.
2357 if (!GetElementsFromRequest (ConfigResp
)) {
2358 goto NextConfigAltResp
;
2362 // 4. Set the default configuration information or Validate current setting by parse IFR code.
2363 // Current Setting is in ConfigResp, will be set into buffer, then check it again.
2365 if (ActionType
== ACTION_SET_DEFAUTL_VALUE
) {
2367 // Set the default configuration information.
2369 Status
= gHiiConfigRouting
->RouteConfig (gHiiConfigRouting
, ConfigResp
, &Progress
);
2372 // Current Setting is in ConfigResp, will be set into buffer, then check it again.
2374 Status
= InternalHiiValidateCurrentSetting (ConfigResp
, HiiPackageList
, PackageListLength
, VarGuid
, VarName
, HiiHandle
);
2377 if (EFI_ERROR (Status
)) {
2383 // Free the allocated pacakge buffer and the got ConfigResp string.
2385 if (HiiPackageList
!= NULL
) {
2386 FreePool (HiiPackageList
);
2387 HiiPackageList
= NULL
;
2390 if (ConfigResp
!= NULL
) {
2391 FreePool (ConfigResp
);
2396 // Free the allocated buffer.
2404 FreePool (DevicePath
);
2408 // 5. Jump to next ConfigAltResp for another Guid, Name, Path.
2412 // Get and Skip ConfigHdr
2414 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
2417 if (*StringPtr
== L
'\0') {
2422 // Construct ConfigAltHdr string "&<ConfigHdr>&ALTCFG=\0"
2423 // | 1 | StrLen (ConfigHdr) | 8 | 1 |
2425 MaxLen
= 1 + StringPtr
- StringHdr
+ 8 + 1;
2426 ConfigAltHdr
= AllocateZeroPool ( MaxLen
* sizeof (CHAR16
));
2427 if (ConfigAltHdr
== NULL
) {
2428 Status
= EFI_OUT_OF_RESOURCES
;
2431 StrCpyS (ConfigAltHdr
, MaxLen
, L
"&");
2432 StrnCatS (ConfigAltHdr
, MaxLen
, StringHdr
, StringPtr
- StringHdr
);
2433 StrCatS (ConfigAltHdr
, MaxLen
, L
"&ALTCFG=");
2436 // Skip all AltResp (AltConfigHdr ConfigBody) for the same ConfigHdr
2438 while ((StringHdr
= StrStr (StringPtr
, ConfigAltHdr
)) != NULL
) {
2439 StringPtr
= StringHdr
+ StrLen (ConfigAltHdr
);
2440 if (*StringPtr
== L
'\0') {
2446 // Free the allocated ConfigAltHdr string
2448 FreePool (ConfigAltHdr
);
2449 if (*StringPtr
== L
'\0') {
2454 // Find &GUID as the next ConfigHdr
2456 StringPtr
= StrStr (StringPtr
, L
"&GUID");
2457 if (StringPtr
== NULL
) {
2468 if (VarGuid
!= NULL
) {
2472 if (VarName
!= NULL
) {
2476 if (DevicePath
!= NULL
) {
2477 FreePool (DevicePath
);
2480 if (ConfigResp
!= NULL
) {
2481 FreePool (ConfigResp
);
2484 if (ConfigAltResp
!= NULL
) {
2485 FreePool (ConfigAltResp
);
2488 if (HiiPackageList
!= NULL
) {
2489 FreePool (HiiPackageList
);
2492 if (EFI_ERROR (Status
)) {
2500 Validate the current configuration by parsing HII form IFR opcode.
2502 NULL request string support depends on the ExportConfig interface of
2503 HiiConfigRouting protocol in UEFI specification.
2505 @param Request A null-terminated Unicode string in
2506 <MultiConfigRequest> format. It can be NULL.
2507 If it is NULL, all current configuration for the
2508 entirety of the current HII database will be validated.
2510 @retval TRUE Current configuration is valid.
2511 @retval FALSE Current configuration is invalid.
2515 HiiValidateSettings (
2516 IN CONST EFI_STRING Request OPTIONAL
2519 return InternalHiiIfrValueAction (Request
, 0, ACTION_VALIDATE_SETTING
);
2523 Reset the default value specified by DefaultId to the driver
2524 configuration got by Request string.
2526 NULL request string support depends on the ExportConfig interface of
2527 HiiConfigRouting protocol in UEFI specification.
2529 @param Request A null-terminated Unicode string in
2530 <MultiConfigRequest> format. It can be NULL.
2531 If it is NULL, all configuration for the
2532 entirety of the current HII database will be reset.
2533 @param DefaultId Specifies the type of defaults to retrieve.
2535 @retval TRUE The default value is set successfully.
2536 @retval FALSE The default value can't be found and set.
2541 IN CONST EFI_STRING Request
, OPTIONAL
2545 return InternalHiiIfrValueAction (Request
, DefaultId
, ACTION_SET_DEFAUTL_VALUE
);
2549 Determines if two values in config strings match.
2551 Compares the substring between StartSearchString and StopSearchString in
2552 FirstString to the substring between StartSearchString and StopSearchString
2553 in SecondString. If the two substrings match, then TRUE is returned. If the
2554 two substrings do not match, then FALSE is returned.
2556 If FirstString is NULL, then ASSERT().
2557 If SecondString is NULL, then ASSERT().
2558 If StartSearchString is NULL, then ASSERT().
2559 If StopSearchString is NULL, then ASSERT().
2561 @param FirstString Pointer to the first Null-terminated Unicode string.
2562 @param SecondString Pointer to the second Null-terminated Unicode string.
2563 @param StartSearchString Pointer to the Null-terminated Unicode string that
2564 marks the start of the value string to compare.
2565 @param StopSearchString Pointer to the Null-terminated Unicode string that
2566 marks the end of the value string to compare.
2568 @retval FALSE StartSearchString is not present in FirstString.
2569 @retval FALSE StartSearchString is not present in SecondString.
2570 @retval FALSE StopSearchString is not present in FirstString.
2571 @retval FALSE StopSearchString is not present in SecondString.
2572 @retval FALSE The length of the substring in FirstString is not the
2573 same length as the substring in SecondString.
2574 @retval FALSE The value string in FirstString does not matche the
2575 value string in SecondString.
2576 @retval TRUE The value string in FirstString matches the value
2577 string in SecondString.
2582 InternalHiiCompareSubString (
2583 IN CHAR16
*FirstString
,
2584 IN CHAR16
*SecondString
,
2585 IN CHAR16
*StartSearchString
,
2586 IN CHAR16
*StopSearchString
2589 CHAR16
*EndFirstString
;
2590 CHAR16
*EndSecondString
;
2592 ASSERT (FirstString
!= NULL
);
2593 ASSERT (SecondString
!= NULL
);
2594 ASSERT (StartSearchString
!= NULL
);
2595 ASSERT (StopSearchString
!= NULL
);
2597 FirstString
= StrStr (FirstString
, StartSearchString
);
2598 if (FirstString
== NULL
) {
2602 SecondString
= StrStr (SecondString
, StartSearchString
);
2603 if (SecondString
== NULL
) {
2607 EndFirstString
= StrStr (FirstString
, StopSearchString
);
2608 if (EndFirstString
== NULL
) {
2612 EndSecondString
= StrStr (SecondString
, StopSearchString
);
2613 if (EndSecondString
== NULL
) {
2617 if ((EndFirstString
- FirstString
) != (EndSecondString
- SecondString
)) {
2621 return (BOOLEAN
)(StrnCmp (FirstString
, SecondString
, EndFirstString
- FirstString
) == 0);
2625 Determines if the routing data specified by GUID and NAME match a <ConfigHdr>.
2627 If ConfigHdr is NULL, then ASSERT().
2629 @param[in] ConfigHdr Either <ConfigRequest> or <ConfigResp>.
2630 @param[in] Guid GUID of the storage.
2631 @param[in] Name NAME of the storage.
2633 @retval TRUE Routing information matches <ConfigHdr>.
2634 @retval FALSE Routing information does not match <ConfigHdr>.
2639 HiiIsConfigHdrMatch (
2640 IN CONST EFI_STRING ConfigHdr
,
2641 IN CONST EFI_GUID
*Guid
, OPTIONAL
2642 IN CONST CHAR16
*Name OPTIONAL
2645 EFI_STRING CompareConfigHdr
;
2648 ASSERT (ConfigHdr
!= NULL
);
2651 // Use Guid and Name to generate a <ConfigHdr> string
2653 CompareConfigHdr
= HiiConstructConfigHdr (Guid
, Name
, NULL
);
2654 if (CompareConfigHdr
== NULL
) {
2661 // Compare GUID value strings
2663 Result
= InternalHiiCompareSubString (ConfigHdr
, CompareConfigHdr
, L
"GUID=", L
"&NAME=");
2666 if (Result
&& Name
!= NULL
) {
2668 // Compare NAME value strings
2670 Result
= InternalHiiCompareSubString (ConfigHdr
, CompareConfigHdr
, L
"&NAME=", L
"&PATH=");
2674 // Free the <ConfigHdr> string
2676 FreePool (CompareConfigHdr
);
2682 Retrieves uncommitted data from the Form Browser and converts it to a binary
2685 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
2686 parameter that may be NULL.
2687 @param[in] VariableName Pointer to a Null-terminated Unicode string. This
2688 is an optional parameter that may be NULL.
2689 @param[in] BufferSize Length in bytes of buffer to hold retrieved data.
2690 @param[out] Buffer Buffer of data to be updated.
2692 @retval FALSE The uncommitted data could not be retrieved.
2693 @retval TRUE The uncommitted data was retrieved.
2699 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
2700 IN CONST CHAR16
*VariableName
, OPTIONAL
2701 IN UINTN BufferSize
,
2705 EFI_STRING ResultsData
;
2707 EFI_STRING ConfigResp
;
2712 // Retrieve the results data from the Browser Callback
2714 ResultsData
= InternalHiiBrowserCallback (VariableGuid
, VariableName
, NULL
);
2715 if (ResultsData
== NULL
) {
2720 // Construct <ConfigResp> mConfigHdrTemplate L'&' ResultsData L'\0'
2722 Size
= (StrLen (mConfigHdrTemplate
) + 1) * sizeof (CHAR16
);
2723 Size
= Size
+ (StrLen (ResultsData
) + 1) * sizeof (CHAR16
);
2724 ConfigResp
= AllocateZeroPool (Size
);
2725 UnicodeSPrint (ConfigResp
, Size
, L
"%s&%s", mConfigHdrTemplate
, ResultsData
);
2728 // Free the allocated buffer
2730 FreePool (ResultsData
);
2731 if (ConfigResp
== NULL
) {
2736 // Convert <ConfigResp> to a buffer
2738 Status
= gHiiConfigRouting
->ConfigToBlock (
2746 // Free the allocated buffer
2748 FreePool (ConfigResp
);
2750 if (EFI_ERROR (Status
)) {
2758 Updates uncommitted data in the Form Browser.
2760 If Buffer is NULL, then ASSERT().
2762 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional
2763 parameter that may be NULL.
2764 @param[in] VariableName Pointer to a Null-terminated Unicode string. This
2765 is an optional parameter that may be NULL.
2766 @param[in] BufferSize Length, in bytes, of Buffer.
2767 @param[in] Buffer Buffer of data to commit.
2768 @param[in] RequestElement An optional field to specify which part of the
2769 buffer data will be send back to Browser. If NULL,
2770 the whole buffer of data will be committed to
2772 <RequestElement> ::= &OFFSET=<Number>&WIDTH=<Number>*
2774 @retval FALSE The uncommitted data could not be updated.
2775 @retval TRUE The uncommitted data was updated.
2781 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
2782 IN CONST CHAR16
*VariableName
, OPTIONAL
2783 IN UINTN BufferSize
,
2784 IN CONST UINT8
*Buffer
,
2785 IN CONST CHAR16
*RequestElement OPTIONAL
2789 EFI_STRING ConfigRequest
;
2790 EFI_STRING ConfigResp
;
2791 EFI_STRING ResultsData
;
2793 ASSERT (Buffer
!= NULL
);
2796 // Construct <ConfigRequest>
2798 if (RequestElement
== NULL
) {
2800 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
2801 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
2803 Size
= (StrLen (mConfigHdrTemplate
) + 32 + 1) * sizeof (CHAR16
);
2804 ConfigRequest
= AllocateZeroPool (Size
);
2805 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", mConfigHdrTemplate
, (UINT64
)BufferSize
);
2808 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
2809 // followed by <RequestElement> followed by a Null-terminator
2811 Size
= StrLen (mConfigHdrTemplate
) * sizeof (CHAR16
);
2812 Size
= Size
+ (StrLen (RequestElement
) + 1) * sizeof (CHAR16
);
2813 ConfigRequest
= AllocateZeroPool (Size
);
2814 UnicodeSPrint (ConfigRequest
, Size
, L
"%s%s", mConfigHdrTemplate
, RequestElement
);
2816 if (ConfigRequest
== NULL
) {
2821 // Convert <ConfigRequest> to <ConfigResp>
2823 ConfigResp
= InternalHiiBlockToConfig (ConfigRequest
, Buffer
, BufferSize
);
2824 FreePool (ConfigRequest
);
2825 if (ConfigResp
== NULL
) {
2830 // Set data in the uncommitted browser state information
2832 ResultsData
= InternalHiiBrowserCallback (VariableGuid
, VariableName
, ConfigResp
+ StrLen(mConfigHdrTemplate
) + 1);
2833 FreePool (ConfigResp
);
2835 return (BOOLEAN
)(ResultsData
!= NULL
);
2838 /////////////////////////////////////////
2839 /////////////////////////////////////////
2841 /////////////////////////////////////////
2842 /////////////////////////////////////////
2844 #define HII_LIB_OPCODE_ALLOCATION_SIZE 0x200
2850 } HII_LIB_OPCODE_BUFFER
;
2853 /// Lookup table that converts EFI_IFR_TYPE_X enum values to a width in bytes
2855 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 mHiiDefaultTypeToWidth
[] = {
2856 1, // EFI_IFR_TYPE_NUM_SIZE_8
2857 2, // EFI_IFR_TYPE_NUM_SIZE_16
2858 4, // EFI_IFR_TYPE_NUM_SIZE_32
2859 8, // EFI_IFR_TYPE_NUM_SIZE_64
2860 1, // EFI_IFR_TYPE_BOOLEAN
2861 3, // EFI_IFR_TYPE_TIME
2862 4, // EFI_IFR_TYPE_DATE
2863 2 // EFI_IFR_TYPE_STRING
2867 Allocates and returns a new OpCode Handle. OpCode Handles must be freed with
2868 HiiFreeOpCodeHandle().
2870 @retval NULL There are not enough resources to allocate a new OpCode Handle.
2871 @retval Other A new OpCode handle.
2876 HiiAllocateOpCodeHandle (
2880 HII_LIB_OPCODE_BUFFER
*OpCodeBuffer
;
2882 OpCodeBuffer
= (HII_LIB_OPCODE_BUFFER
*)AllocatePool (sizeof (HII_LIB_OPCODE_BUFFER
));
2883 if (OpCodeBuffer
== NULL
) {
2886 OpCodeBuffer
->Buffer
= (UINT8
*)AllocatePool (HII_LIB_OPCODE_ALLOCATION_SIZE
);
2887 if (OpCodeBuffer
->Buffer
== NULL
) {
2888 FreePool (OpCodeBuffer
);
2891 OpCodeBuffer
->BufferSize
= HII_LIB_OPCODE_ALLOCATION_SIZE
;
2892 OpCodeBuffer
->Position
= 0;
2893 return (VOID
*)OpCodeBuffer
;
2897 Frees an OpCode Handle that was previously allocated with HiiAllocateOpCodeHandle().
2898 When an OpCode Handle is freed, all of the opcodes associated with the OpCode
2899 Handle are also freed.
2901 If OpCodeHandle is NULL, then ASSERT().
2903 @param[in] OpCodeHandle Handle to the buffer of opcodes.
2908 HiiFreeOpCodeHandle (
2912 HII_LIB_OPCODE_BUFFER
*OpCodeBuffer
;
2914 ASSERT (OpCodeHandle
!= NULL
);
2916 OpCodeBuffer
= (HII_LIB_OPCODE_BUFFER
*)OpCodeHandle
;
2917 if (OpCodeBuffer
->Buffer
!= NULL
) {
2918 FreePool (OpCodeBuffer
->Buffer
);
2920 FreePool (OpCodeBuffer
);
2924 Internal function gets the current position of opcode buffer.
2926 @param[in] OpCodeHandle Handle to the buffer of opcodes.
2928 @return Current position of opcode buffer.
2932 InternalHiiOpCodeHandlePosition (
2933 IN VOID
*OpCodeHandle
2936 return ((HII_LIB_OPCODE_BUFFER
*)OpCodeHandle
)->Position
;
2940 Internal function gets the start pointer of opcode buffer.
2942 @param[in] OpCodeHandle Handle to the buffer of opcodes.
2944 @return Pointer to the opcode buffer base.
2948 InternalHiiOpCodeHandleBuffer (
2949 IN VOID
*OpCodeHandle
2952 return ((HII_LIB_OPCODE_BUFFER
*)OpCodeHandle
)->Buffer
;
2956 Internal function reserves the enough buffer for current opcode.
2957 When the buffer is not enough, Opcode buffer will be extended.
2959 @param[in] OpCodeHandle Handle to the buffer of opcodes.
2960 @param[in] Size Size of current opcode.
2962 @return Pointer to the current opcode.
2966 InternalHiiGrowOpCodeHandle (
2967 IN VOID
*OpCodeHandle
,
2971 HII_LIB_OPCODE_BUFFER
*OpCodeBuffer
;
2974 ASSERT (OpCodeHandle
!= NULL
);
2976 OpCodeBuffer
= (HII_LIB_OPCODE_BUFFER
*)OpCodeHandle
;
2977 if (OpCodeBuffer
->Position
+ Size
> OpCodeBuffer
->BufferSize
) {
2978 Buffer
= ReallocatePool (
2979 OpCodeBuffer
->BufferSize
,
2980 OpCodeBuffer
->BufferSize
+ (Size
+ HII_LIB_OPCODE_ALLOCATION_SIZE
),
2981 OpCodeBuffer
->Buffer
2983 ASSERT (Buffer
!= NULL
);
2984 OpCodeBuffer
->Buffer
= Buffer
;
2985 OpCodeBuffer
->BufferSize
+= (Size
+ HII_LIB_OPCODE_ALLOCATION_SIZE
);
2987 Buffer
= OpCodeBuffer
->Buffer
+ OpCodeBuffer
->Position
;
2988 OpCodeBuffer
->Position
+= Size
;
2993 Internal function creates opcode based on the template opcode.
2995 @param[in] OpCodeHandle Handle to the buffer of opcodes.
2996 @param[in] OpCodeTemplate Pointer to the template buffer of opcode.
2997 @param[in] OpCode OpCode IFR value.
2998 @param[in] OpCodeSize Size of opcode.
2999 @param[in] ExtensionSize Size of extended opcode.
3000 @param[in] Scope Scope bit of opcode.
3002 @return Pointer to the current opcode with opcode data.
3006 InternalHiiCreateOpCodeExtended (
3007 IN VOID
*OpCodeHandle
,
3008 IN VOID
*OpCodeTemplate
,
3010 IN UINTN OpCodeSize
,
3011 IN UINTN ExtensionSize
,
3015 EFI_IFR_OP_HEADER
*Header
;
3018 ASSERT (OpCodeTemplate
!= NULL
);
3019 ASSERT ((OpCodeSize
+ ExtensionSize
) <= 0x7F);
3021 Header
= (EFI_IFR_OP_HEADER
*)OpCodeTemplate
;
3022 Header
->OpCode
= OpCode
;
3023 Header
->Scope
= Scope
;
3024 Header
->Length
= (UINT8
)(OpCodeSize
+ ExtensionSize
);
3025 Buffer
= InternalHiiGrowOpCodeHandle (OpCodeHandle
, Header
->Length
);
3026 return (UINT8
*)CopyMem (Buffer
, Header
, OpCodeSize
);
3030 Internal function creates opcode based on the template opcode for the normal opcode.
3032 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3033 @param[in] OpCodeTemplate Pointer to the template buffer of opcode.
3034 @param[in] OpCode OpCode IFR value.
3035 @param[in] OpCodeSize Size of opcode.
3037 @return Pointer to the current opcode with opcode data.
3041 InternalHiiCreateOpCode (
3042 IN VOID
*OpCodeHandle
,
3043 IN VOID
*OpCodeTemplate
,
3048 return InternalHiiCreateOpCodeExtended (OpCodeHandle
, OpCodeTemplate
, OpCode
, OpCodeSize
, 0, 0);
3052 Append raw opcodes to an OpCodeHandle.
3054 If OpCodeHandle is NULL, then ASSERT().
3055 If RawBuffer is NULL, then ASSERT();
3057 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3058 @param[in] RawBuffer Buffer of opcodes to append.
3059 @param[in] RawBufferSize The size, in bytes, of Buffer.
3061 @retval NULL There is not enough space left in Buffer to add the opcode.
3062 @retval Other A pointer to the appended opcodes.
3067 HiiCreateRawOpCodes (
3068 IN VOID
*OpCodeHandle
,
3069 IN UINT8
*RawBuffer
,
3070 IN UINTN RawBufferSize
3075 ASSERT (RawBuffer
!= NULL
);
3077 Buffer
= InternalHiiGrowOpCodeHandle (OpCodeHandle
, RawBufferSize
);
3078 return (UINT8
*)CopyMem (Buffer
, RawBuffer
, RawBufferSize
);
3082 Append opcodes from one OpCode Handle to another OpCode handle.
3084 If OpCodeHandle is NULL, then ASSERT().
3085 If RawOpCodeHandle is NULL, then ASSERT();
3087 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3088 @param[in] RawOpCodeHandle Handle to the buffer of opcodes.
3090 @retval NULL There is not enough space left in Buffer to add the opcode.
3091 @retval Other A pointer to the appended opcodes.
3096 InternalHiiAppendOpCodes (
3097 IN VOID
*OpCodeHandle
,
3098 IN VOID
*RawOpCodeHandle
3101 HII_LIB_OPCODE_BUFFER
*RawOpCodeBuffer
;
3103 ASSERT (RawOpCodeHandle
!= NULL
);
3105 RawOpCodeBuffer
= (HII_LIB_OPCODE_BUFFER
*)RawOpCodeHandle
;
3106 return HiiCreateRawOpCodes (OpCodeHandle
, RawOpCodeBuffer
->Buffer
, RawOpCodeBuffer
->Position
);
3110 Create EFI_IFR_END_OP opcode.
3112 If OpCodeHandle is NULL, then ASSERT().
3114 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3116 @retval NULL There is not enough space left in Buffer to add the opcode.
3117 @retval Other A pointer to the created opcode.
3122 HiiCreateEndOpCode (
3123 IN VOID
*OpCodeHandle
3128 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_END_OP
, sizeof (OpCode
));
3132 Create EFI_IFR_ONE_OF_OPTION_OP opcode.
3134 If OpCodeHandle is NULL, then ASSERT().
3135 If Type is invalid, then ASSERT().
3136 If Flags is invalid, then ASSERT().
3138 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3139 @param[in] StringId StringId for the option
3140 @param[in] Flags Flags for the option
3141 @param[in] Type Type for the option
3142 @param[in] Value Value for the option
3144 @retval NULL There is not enough space left in Buffer to add the opcode.
3145 @retval Other A pointer to the created opcode.
3150 HiiCreateOneOfOptionOpCode (
3151 IN VOID
*OpCodeHandle
,
3158 EFI_IFR_ONE_OF_OPTION OpCode
;
3160 ASSERT (Type
< EFI_IFR_TYPE_OTHER
);
3162 ZeroMem (&OpCode
, sizeof (OpCode
));
3163 OpCode
.Option
= StringId
;
3164 OpCode
.Flags
= (UINT8
) (Flags
& (EFI_IFR_OPTION_DEFAULT
| EFI_IFR_OPTION_DEFAULT_MFG
));
3166 CopyMem (&OpCode
.Value
, &Value
, mHiiDefaultTypeToWidth
[Type
]);
3168 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_ONE_OF_OPTION_OP
, OFFSET_OF(EFI_IFR_ONE_OF_OPTION
, Value
) + mHiiDefaultTypeToWidth
[Type
]);
3172 Create EFI_IFR_DEFAULT_OP opcode.
3174 If OpCodeHandle is NULL, then ASSERT().
3175 If Type is invalid, then ASSERT().
3177 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3178 @param[in] DefaultId DefaultId for the default
3179 @param[in] Type Type for the default
3180 @param[in] Value Value for the default
3182 @retval NULL There is not enough space left in Buffer to add the opcode.
3183 @retval Other A pointer to the created opcode.
3188 HiiCreateDefaultOpCode (
3189 IN VOID
*OpCodeHandle
,
3190 IN UINT16 DefaultId
,
3195 EFI_IFR_DEFAULT OpCode
;
3197 ASSERT (Type
< EFI_IFR_TYPE_OTHER
);
3199 ZeroMem (&OpCode
, sizeof (OpCode
));
3201 OpCode
.DefaultId
= DefaultId
;
3202 CopyMem (&OpCode
.Value
, &Value
, mHiiDefaultTypeToWidth
[Type
]);
3204 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_DEFAULT_OP
, OFFSET_OF(EFI_IFR_DEFAULT
, Value
) + mHiiDefaultTypeToWidth
[Type
]);
3208 Create EFI_IFR_GUID opcode.
3210 If OpCodeHandle is NULL, then ASSERT().
3211 If Guid is NULL, then ASSERT().
3212 If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().
3214 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3215 @param[in] Guid Pointer to EFI_GUID of this guided opcode.
3216 @param[in] GuidOpCode Pointer to an EFI_IFR_GUID opcode. This is an
3217 optional parameter that may be NULL. If this
3218 parameter is NULL, then the GUID extension
3219 region of the created opcode is filled with zeros.
3220 If this parameter is not NULL, then the GUID
3221 extension region of GuidData will be copied to
3222 the GUID extension region of the created opcode.
3223 @param[in] OpCodeSize The size, in bytes, of created opcode. This value
3224 must be >= sizeof(EFI_IFR_GUID).
3226 @retval NULL There is not enough space left in Buffer to add the opcode.
3227 @retval Other A pointer to the created opcode.
3232 HiiCreateGuidOpCode (
3233 IN VOID
*OpCodeHandle
,
3234 IN CONST EFI_GUID
*Guid
,
3235 IN CONST VOID
*GuidOpCode
, OPTIONAL
3239 EFI_IFR_GUID OpCode
;
3240 EFI_IFR_GUID
*OpCodePointer
;
3242 ASSERT (Guid
!= NULL
);
3243 ASSERT (OpCodeSize
>= sizeof (OpCode
));
3245 ZeroMem (&OpCode
, sizeof (OpCode
));
3246 CopyGuid ((EFI_GUID
*)(VOID
*)&OpCode
.Guid
, Guid
);
3248 OpCodePointer
= (EFI_IFR_GUID
*)InternalHiiCreateOpCodeExtended (
3253 OpCodeSize
- sizeof (OpCode
),
3256 if (OpCodePointer
!= NULL
&& GuidOpCode
!= NULL
) {
3257 CopyMem (OpCodePointer
+ 1, (EFI_IFR_GUID
*)GuidOpCode
+ 1, OpCodeSize
- sizeof (OpCode
));
3259 return (UINT8
*)OpCodePointer
;
3263 Create EFI_IFR_ACTION_OP opcode.
3265 If OpCodeHandle is NULL, then ASSERT().
3266 If any reserved bits are set in QuestionFlags, then ASSERT().
3268 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3269 @param[in] QuestionId Question ID
3270 @param[in] Prompt String ID for Prompt
3271 @param[in] Help String ID for Help
3272 @param[in] QuestionFlags Flags in Question Header
3273 @param[in] QuestionConfig String ID for configuration
3275 @retval NULL There is not enough space left in Buffer to add the opcode.
3276 @retval Other A pointer to the created opcode.
3281 HiiCreateActionOpCode (
3282 IN VOID
*OpCodeHandle
,
3283 IN EFI_QUESTION_ID QuestionId
,
3284 IN EFI_STRING_ID Prompt
,
3285 IN EFI_STRING_ID Help
,
3286 IN UINT8 QuestionFlags
,
3287 IN EFI_STRING_ID QuestionConfig
3290 EFI_IFR_ACTION OpCode
;
3292 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3294 ZeroMem (&OpCode
, sizeof (OpCode
));
3295 OpCode
.Question
.QuestionId
= QuestionId
;
3296 OpCode
.Question
.Header
.Prompt
= Prompt
;
3297 OpCode
.Question
.Header
.Help
= Help
;
3298 OpCode
.Question
.Flags
= QuestionFlags
;
3299 OpCode
.QuestionConfig
= QuestionConfig
;
3301 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_ACTION_OP
, sizeof (OpCode
));
3305 Create EFI_IFR_SUBTITLE_OP opcode.
3307 If OpCodeHandle is NULL, then ASSERT().
3308 If any reserved bits are set in Flags, then ASSERT().
3309 If Scope > 1, then ASSERT().
3311 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3312 @param[in] Prompt String ID for Prompt
3313 @param[in] Help String ID for Help
3314 @param[in] Flags Subtitle opcode flags
3315 @param[in] Scope 1 if this opcpde is the beginning of a new scope.
3316 0 if this opcode is within the current scope.
3318 @retval NULL There is not enough space left in Buffer to add the opcode.
3319 @retval Other A pointer to the created opcode.
3324 HiiCreateSubTitleOpCode (
3325 IN VOID
*OpCodeHandle
,
3326 IN EFI_STRING_ID Prompt
,
3327 IN EFI_STRING_ID Help
,
3332 EFI_IFR_SUBTITLE OpCode
;
3334 ASSERT (Scope
<= 1);
3335 ASSERT ((Flags
& (~(EFI_IFR_FLAGS_HORIZONTAL
))) == 0);
3337 ZeroMem (&OpCode
, sizeof (OpCode
));
3338 OpCode
.Statement
.Prompt
= Prompt
;
3339 OpCode
.Statement
.Help
= Help
;
3340 OpCode
.Flags
= Flags
;
3342 return InternalHiiCreateOpCodeExtended (
3345 EFI_IFR_SUBTITLE_OP
,
3353 Create EFI_IFR_REF_OP opcode.
3355 If OpCodeHandle is NULL, then ASSERT().
3356 If any reserved bits are set in QuestionFlags, then ASSERT().
3358 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3359 @param[in] FormId Destination Form ID
3360 @param[in] Prompt String ID for Prompt
3361 @param[in] Help String ID for Help
3362 @param[in] QuestionFlags Flags in Question Header
3363 @param[in] QuestionId Question ID
3365 @retval NULL There is not enough space left in Buffer to add the opcode.
3366 @retval Other A pointer to the created opcode.
3371 HiiCreateGotoOpCode (
3372 IN VOID
*OpCodeHandle
,
3373 IN EFI_FORM_ID FormId
,
3374 IN EFI_STRING_ID Prompt
,
3375 IN EFI_STRING_ID Help
,
3376 IN UINT8 QuestionFlags
,
3377 IN EFI_QUESTION_ID QuestionId
3382 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3384 ZeroMem (&OpCode
, sizeof (OpCode
));
3385 OpCode
.Question
.Header
.Prompt
= Prompt
;
3386 OpCode
.Question
.Header
.Help
= Help
;
3387 OpCode
.Question
.QuestionId
= QuestionId
;
3388 OpCode
.Question
.Flags
= QuestionFlags
;
3389 OpCode
.FormId
= FormId
;
3391 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_REF_OP
, sizeof (OpCode
));
3395 Create EFI_IFR_REF_OP, EFI_IFR_REF2_OP, EFI_IFR_REF3_OP and EFI_IFR_REF4_OP opcode.
3397 When RefDevicePath is not zero, EFI_IFR_REF4 opcode will be created.
3398 When RefDevicePath is zero and RefFormSetId is not NULL, EFI_IFR_REF3 opcode will be created.
3399 When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is not zero, EFI_IFR_REF2 opcode will be created.
3400 When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is zero, EFI_IFR_REF opcode will be created.
3402 If OpCodeHandle is NULL, then ASSERT().
3403 If any reserved bits are set in QuestionFlags, then ASSERT().
3405 @param[in] OpCodeHandle The handle to the buffer of opcodes.
3406 @param[in] RefFormId The Destination Form ID.
3407 @param[in] Prompt The string ID for Prompt.
3408 @param[in] Help The string ID for Help.
3409 @param[in] QuestionFlags The flags in Question Header
3410 @param[in] QuestionId Question ID.
3411 @param[in] RefQuestionId The question on the form to which this link is referring.
3412 If its value is zero, then the link refers to the top of the form.
3413 @param[in] RefFormSetId The form set to which this link is referring. If its value is NULL, and RefDevicePath is
3414 zero, then the link is to the current form set.
3415 @param[in] RefDevicePath The string identifier that specifies the string containing the text representation of
3416 the device path to which the form set containing the form specified by FormId.
3417 If its value is zero, then the link refers to the current page.
3419 @retval NULL There is not enough space left in Buffer to add the opcode.
3420 @retval Other A pointer to the created opcode.
3425 HiiCreateGotoExOpCode (
3426 IN VOID
*OpCodeHandle
,
3427 IN EFI_FORM_ID RefFormId
,
3428 IN EFI_STRING_ID Prompt
,
3429 IN EFI_STRING_ID Help
,
3430 IN UINT8 QuestionFlags
,
3431 IN EFI_QUESTION_ID QuestionId
,
3432 IN EFI_QUESTION_ID RefQuestionId
,
3433 IN EFI_GUID
*RefFormSetId
, OPTIONAL
3434 IN EFI_STRING_ID RefDevicePath
3437 EFI_IFR_REF4 OpCode
;
3440 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3442 ZeroMem (&OpCode
, sizeof (OpCode
));
3443 OpCode
.Question
.Header
.Prompt
= Prompt
;
3444 OpCode
.Question
.Header
.Help
= Help
;
3445 OpCode
.Question
.QuestionId
= QuestionId
;
3446 OpCode
.Question
.Flags
= QuestionFlags
;
3447 OpCode
.FormId
= RefFormId
;
3448 OpCode
.QuestionId
= RefQuestionId
;
3449 OpCode
.DevicePath
= RefDevicePath
;
3450 if (RefFormSetId
!= NULL
) {
3451 CopyMem (&OpCode
.FormSetId
, RefFormSetId
, sizeof (OpCode
.FormSetId
));
3455 // Cacluate OpCodeSize based on the input Ref value.
3456 // Try to use the small OpCode to save size.
3458 OpCodeSize
= sizeof (EFI_IFR_REF
);
3459 if (RefDevicePath
!= 0) {
3460 OpCodeSize
= sizeof (EFI_IFR_REF4
);
3461 } else if (RefFormSetId
!= NULL
) {
3462 OpCodeSize
= sizeof (EFI_IFR_REF3
);
3463 } else if (RefQuestionId
!= 0) {
3464 OpCodeSize
= sizeof (EFI_IFR_REF2
);
3467 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_REF_OP
, OpCodeSize
);
3471 Create EFI_IFR_CHECKBOX_OP opcode.
3473 If OpCodeHandle is NULL, then ASSERT().
3474 If any reserved bits are set in QuestionFlags, then ASSERT().
3475 If any reserved bits are set in CheckBoxFlags, then ASSERT().
3477 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3478 @param[in] QuestionId Question ID
3479 @param[in] VarStoreId Storage ID
3480 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3481 for this name/value pair.
3482 @param[in] Prompt String ID for Prompt
3483 @param[in] Help String ID for Help
3484 @param[in] QuestionFlags Flags in Question Header
3485 @param[in] CheckBoxFlags Flags for checkbox opcode
3486 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3487 is an optional parameter that may be NULL.
3489 @retval NULL There is not enough space left in Buffer to add the opcode.
3490 @retval Other A pointer to the created opcode.
3495 HiiCreateCheckBoxOpCode (
3496 IN VOID
*OpCodeHandle
,
3497 IN EFI_QUESTION_ID QuestionId
,
3498 IN EFI_VARSTORE_ID VarStoreId
,
3499 IN UINT16 VarOffset
,
3500 IN EFI_STRING_ID Prompt
,
3501 IN EFI_STRING_ID Help
,
3502 IN UINT8 QuestionFlags
,
3503 IN UINT8 CheckBoxFlags
,
3504 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3507 EFI_IFR_CHECKBOX OpCode
;
3510 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3512 ZeroMem (&OpCode
, sizeof (OpCode
));
3513 OpCode
.Question
.QuestionId
= QuestionId
;
3514 OpCode
.Question
.VarStoreId
= VarStoreId
;
3515 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3516 OpCode
.Question
.Header
.Prompt
= Prompt
;
3517 OpCode
.Question
.Header
.Help
= Help
;
3518 OpCode
.Question
.Flags
= QuestionFlags
;
3519 OpCode
.Flags
= CheckBoxFlags
;
3521 if (DefaultsOpCodeHandle
== NULL
) {
3522 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_CHECKBOX_OP
, sizeof (OpCode
));
3525 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3526 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_CHECKBOX_OP
, sizeof (OpCode
), 0, 1);
3527 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3528 HiiCreateEndOpCode (OpCodeHandle
);
3529 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3533 Create EFI_IFR_NUMERIC_OP opcode.
3535 If OpCodeHandle is NULL, then ASSERT().
3536 If any reserved bits are set in QuestionFlags, then ASSERT().
3537 If any reserved bits are set in NumericFlags, then ASSERT().
3539 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3540 @param[in] QuestionId Question ID
3541 @param[in] VarStoreId Storage ID
3542 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3543 for this name/value pair.
3544 @param[in] Prompt String ID for Prompt
3545 @param[in] Help String ID for Help
3546 @param[in] QuestionFlags Flags in Question Header
3547 @param[in] NumericFlags Flags for numeric opcode
3548 @param[in] Minimum Numeric minimum value
3549 @param[in] Maximum Numeric maximum value
3550 @param[in] Step Numeric step for edit
3551 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3552 is an optional parameter that may be NULL.
3554 @retval NULL There is not enough space left in Buffer to add the opcode.
3555 @retval Other A pointer to the created opcode.
3560 HiiCreateNumericOpCode (
3561 IN VOID
*OpCodeHandle
,
3562 IN EFI_QUESTION_ID QuestionId
,
3563 IN EFI_VARSTORE_ID VarStoreId
,
3564 IN UINT16 VarOffset
,
3565 IN EFI_STRING_ID Prompt
,
3566 IN EFI_STRING_ID Help
,
3567 IN UINT8 QuestionFlags
,
3568 IN UINT8 NumericFlags
,
3572 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3575 EFI_IFR_NUMERIC OpCode
;
3579 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3582 ZeroMem (&OpCode
, sizeof (OpCode
));
3583 OpCode
.Question
.QuestionId
= QuestionId
;
3584 OpCode
.Question
.VarStoreId
= VarStoreId
;
3585 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3586 OpCode
.Question
.Header
.Prompt
= Prompt
;
3587 OpCode
.Question
.Header
.Help
= Help
;
3588 OpCode
.Question
.Flags
= QuestionFlags
;
3589 OpCode
.Flags
= NumericFlags
;
3591 switch (NumericFlags
& EFI_IFR_NUMERIC_SIZE
) {
3592 case EFI_IFR_NUMERIC_SIZE_1
:
3593 OpCode
.data
.u8
.MinValue
= (UINT8
)Minimum
;
3594 OpCode
.data
.u8
.MaxValue
= (UINT8
)Maximum
;
3595 OpCode
.data
.u8
.Step
= (UINT8
)Step
;
3599 case EFI_IFR_NUMERIC_SIZE_2
:
3600 OpCode
.data
.u16
.MinValue
= (UINT16
)Minimum
;
3601 OpCode
.data
.u16
.MaxValue
= (UINT16
)Maximum
;
3602 OpCode
.data
.u16
.Step
= (UINT16
)Step
;
3606 case EFI_IFR_NUMERIC_SIZE_4
:
3607 OpCode
.data
.u32
.MinValue
= (UINT32
)Minimum
;
3608 OpCode
.data
.u32
.MaxValue
= (UINT32
)Maximum
;
3609 OpCode
.data
.u32
.Step
= (UINT32
)Step
;
3613 case EFI_IFR_NUMERIC_SIZE_8
:
3614 OpCode
.data
.u64
.MinValue
= Minimum
;
3615 OpCode
.data
.u64
.MaxValue
= Maximum
;
3616 OpCode
.data
.u64
.Step
= Step
;
3621 Length
+= OFFSET_OF (EFI_IFR_NUMERIC
, data
);
3623 if (DefaultsOpCodeHandle
== NULL
) {
3624 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_NUMERIC_OP
, Length
);
3627 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3628 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_NUMERIC_OP
, Length
, 0, 1);
3629 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3630 HiiCreateEndOpCode (OpCodeHandle
);
3631 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3635 Create EFI_IFR_STRING_OP opcode.
3637 If OpCodeHandle is NULL, then ASSERT().
3638 If any reserved bits are set in QuestionFlags, then ASSERT().
3639 If any reserved bits are set in StringFlags, then ASSERT().
3641 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3642 @param[in] QuestionId Question ID
3643 @param[in] VarStoreId Storage ID
3644 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3645 for this name/value pair.
3646 @param[in] Prompt String ID for Prompt
3647 @param[in] Help String ID for Help
3648 @param[in] QuestionFlags Flags in Question Header
3649 @param[in] StringFlags Flags for string opcode
3650 @param[in] MinSize String minimum length
3651 @param[in] MaxSize String maximum length
3652 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3653 is an optional parameter that may be NULL.
3655 @retval NULL There is not enough space left in Buffer to add the opcode.
3656 @retval Other A pointer to the created opcode.
3661 HiiCreateStringOpCode (
3662 IN VOID
*OpCodeHandle
,
3663 IN EFI_QUESTION_ID QuestionId
,
3664 IN EFI_VARSTORE_ID VarStoreId
,
3665 IN UINT16 VarOffset
,
3666 IN EFI_STRING_ID Prompt
,
3667 IN EFI_STRING_ID Help
,
3668 IN UINT8 QuestionFlags
,
3669 IN UINT8 StringFlags
,
3672 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3675 EFI_IFR_STRING OpCode
;
3678 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3680 ZeroMem (&OpCode
, sizeof (OpCode
));
3681 OpCode
.Question
.Header
.Prompt
= Prompt
;
3682 OpCode
.Question
.Header
.Help
= Help
;
3683 OpCode
.Question
.QuestionId
= QuestionId
;
3684 OpCode
.Question
.VarStoreId
= VarStoreId
;
3685 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3686 OpCode
.Question
.Flags
= QuestionFlags
;
3687 OpCode
.MinSize
= MinSize
;
3688 OpCode
.MaxSize
= MaxSize
;
3689 OpCode
.Flags
= (UINT8
) (StringFlags
& EFI_IFR_STRING_MULTI_LINE
);
3691 if (DefaultsOpCodeHandle
== NULL
) {
3692 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_STRING_OP
, sizeof (OpCode
));
3695 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3696 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_STRING_OP
, sizeof (OpCode
), 0, 1);
3697 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3698 HiiCreateEndOpCode (OpCodeHandle
);
3699 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3703 Create EFI_IFR_ONE_OF_OP opcode.
3705 If OpCodeHandle is NULL, then ASSERT().
3706 If any reserved bits are set in QuestionFlags, then ASSERT().
3707 If any reserved bits are set in OneOfFlags, then ASSERT().
3709 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3710 @param[in] QuestionId Question ID
3711 @param[in] VarStoreId Storage ID
3712 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3713 for this name/value pair.
3714 @param[in] Prompt String ID for Prompt
3715 @param[in] Help String ID for Help
3716 @param[in] QuestionFlags Flags in Question Header
3717 @param[in] OneOfFlags Flags for oneof opcode
3718 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
3719 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3720 is an optional parameter that may be NULL.
3722 @retval NULL There is not enough space left in Buffer to add the opcode.
3723 @retval Other A pointer to the created opcode.
3728 HiiCreateOneOfOpCode (
3729 IN VOID
*OpCodeHandle
,
3730 IN EFI_QUESTION_ID QuestionId
,
3731 IN EFI_VARSTORE_ID VarStoreId
,
3732 IN UINT16 VarOffset
,
3733 IN EFI_STRING_ID Prompt
,
3734 IN EFI_STRING_ID Help
,
3735 IN UINT8 QuestionFlags
,
3736 IN UINT8 OneOfFlags
,
3737 IN VOID
*OptionsOpCodeHandle
,
3738 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3741 EFI_IFR_ONE_OF OpCode
;
3745 ASSERT (OptionsOpCodeHandle
!= NULL
);
3746 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
| EFI_IFR_FLAG_OPTIONS_ONLY
))) == 0);
3748 ZeroMem (&OpCode
, sizeof (OpCode
));
3749 OpCode
.Question
.Header
.Prompt
= Prompt
;
3750 OpCode
.Question
.Header
.Help
= Help
;
3751 OpCode
.Question
.QuestionId
= QuestionId
;
3752 OpCode
.Question
.VarStoreId
= VarStoreId
;
3753 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3754 OpCode
.Question
.Flags
= QuestionFlags
;
3755 OpCode
.Flags
= OneOfFlags
;
3757 Length
= OFFSET_OF (EFI_IFR_ONE_OF
, data
);
3758 Length
+= (1 << (OneOfFlags
& EFI_IFR_NUMERIC_SIZE
)) * 3;
3760 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3761 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_ONE_OF_OP
, Length
, 0, 1);
3762 InternalHiiAppendOpCodes (OpCodeHandle
, OptionsOpCodeHandle
);
3763 if (DefaultsOpCodeHandle
!= NULL
) {
3764 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3766 HiiCreateEndOpCode (OpCodeHandle
);
3767 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3771 Create EFI_IFR_ORDERED_LIST_OP opcode.
3773 If OpCodeHandle is NULL, then ASSERT().
3774 If any reserved bits are set in QuestionFlags, then ASSERT().
3775 If any reserved bits are set in OrderedListFlags, then ASSERT().
3777 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3778 @param[in] QuestionId Question ID
3779 @param[in] VarStoreId Storage ID
3780 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3781 for this name/value pair.
3782 @param[in] Prompt String ID for Prompt
3783 @param[in] Help String ID for Help
3784 @param[in] QuestionFlags Flags in Question Header
3785 @param[in] OrderedListFlags Flags for ordered list opcode
3786 @param[in] DataType Type for option value
3787 @param[in] MaxContainers Maximum count for options in this ordered list
3788 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.
3789 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3790 is an optional parameter that may be NULL.
3792 @retval NULL There is not enough space left in Buffer to add the opcode.
3793 @retval Other A pointer to the created opcode.
3798 HiiCreateOrderedListOpCode (
3799 IN VOID
*OpCodeHandle
,
3800 IN EFI_QUESTION_ID QuestionId
,
3801 IN EFI_VARSTORE_ID VarStoreId
,
3802 IN UINT16 VarOffset
,
3803 IN EFI_STRING_ID Prompt
,
3804 IN EFI_STRING_ID Help
,
3805 IN UINT8 QuestionFlags
,
3806 IN UINT8 OrderedListFlags
,
3808 IN UINT8 MaxContainers
,
3809 IN VOID
*OptionsOpCodeHandle
,
3810 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3813 EFI_IFR_ORDERED_LIST OpCode
;
3816 ASSERT (OptionsOpCodeHandle
!= NULL
);
3817 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
| EFI_IFR_FLAG_OPTIONS_ONLY
))) == 0);
3819 ZeroMem (&OpCode
, sizeof (OpCode
));
3820 OpCode
.Question
.Header
.Prompt
= Prompt
;
3821 OpCode
.Question
.Header
.Help
= Help
;
3822 OpCode
.Question
.QuestionId
= QuestionId
;
3823 OpCode
.Question
.VarStoreId
= VarStoreId
;
3824 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3825 OpCode
.Question
.Flags
= QuestionFlags
;
3826 OpCode
.MaxContainers
= MaxContainers
;
3827 OpCode
.Flags
= OrderedListFlags
;
3829 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3830 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_ORDERED_LIST_OP
, sizeof (OpCode
), 0, 1);
3831 InternalHiiAppendOpCodes (OpCodeHandle
, OptionsOpCodeHandle
);
3832 if (DefaultsOpCodeHandle
!= NULL
) {
3833 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3835 HiiCreateEndOpCode (OpCodeHandle
);
3836 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3840 Create EFI_IFR_TEXT_OP opcode.
3842 If OpCodeHandle is NULL, then ASSERT().
3844 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3845 @param[in] Prompt String ID for Prompt.
3846 @param[in] Help String ID for Help.
3847 @param[in] TextTwo String ID for TextTwo.
3849 @retval NULL There is not enough space left in Buffer to add the opcode.
3850 @retval Other A pointer to the created opcode.
3855 HiiCreateTextOpCode (
3856 IN VOID
*OpCodeHandle
,
3857 IN EFI_STRING_ID Prompt
,
3858 IN EFI_STRING_ID Help
,
3859 IN EFI_STRING_ID TextTwo
3862 EFI_IFR_TEXT OpCode
;
3864 ZeroMem (&OpCode
, sizeof (OpCode
));
3865 OpCode
.Statement
.Prompt
= Prompt
;
3866 OpCode
.Statement
.Help
= Help
;
3867 OpCode
.TextTwo
= TextTwo
;
3869 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_TEXT_OP
, sizeof (OpCode
));
3873 Create EFI_IFR_DATE_OP opcode.
3875 If OpCodeHandle is NULL, then ASSERT().
3876 If any reserved bits are set in QuestionFlags, then ASSERT().
3877 If any reserved bits are set in DateFlags, then ASSERT().
3879 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3880 @param[in] QuestionId Question ID
3881 @param[in] VarStoreId Storage ID, optional. If DateFlags is not
3882 QF_DATE_STORAGE_NORMAL, this parameter is ignored.
3883 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3884 for this name/value pair, optional. If DateFlags is not
3885 QF_DATE_STORAGE_NORMAL, this parameter is ignored.
3886 @param[in] Prompt String ID for Prompt
3887 @param[in] Help String ID for Help
3888 @param[in] QuestionFlags Flags in Question Header
3889 @param[in] DateFlags Flags for date opcode
3890 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3891 is an optional parameter that may be NULL.
3893 @retval NULL There is not enough space left in Buffer to add the opcode.
3894 @retval Other A pointer to the created opcode.
3899 HiiCreateDateOpCode (
3900 IN VOID
*OpCodeHandle
,
3901 IN EFI_QUESTION_ID QuestionId
,
3902 IN EFI_VARSTORE_ID VarStoreId
, OPTIONAL
3903 IN UINT16 VarOffset
, OPTIONAL
3904 IN EFI_STRING_ID Prompt
,
3905 IN EFI_STRING_ID Help
,
3906 IN UINT8 QuestionFlags
,
3908 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3911 EFI_IFR_DATE OpCode
;
3914 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3915 ASSERT ((DateFlags
& (~(EFI_QF_DATE_YEAR_SUPPRESS
| EFI_QF_DATE_MONTH_SUPPRESS
| EFI_QF_DATE_DAY_SUPPRESS
| EFI_QF_DATE_STORAGE
))) == 0);
3917 ZeroMem (&OpCode
, sizeof (OpCode
));
3918 OpCode
.Question
.Header
.Prompt
= Prompt
;
3919 OpCode
.Question
.Header
.Help
= Help
;
3920 OpCode
.Question
.QuestionId
= QuestionId
;
3921 OpCode
.Question
.VarStoreId
= VarStoreId
;
3922 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3923 OpCode
.Question
.Flags
= QuestionFlags
;
3924 OpCode
.Flags
= DateFlags
;
3926 if (DefaultsOpCodeHandle
== NULL
) {
3927 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_DATE_OP
, sizeof (OpCode
));
3930 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3931 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_DATE_OP
, sizeof (OpCode
), 0, 1);
3932 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3933 HiiCreateEndOpCode (OpCodeHandle
);
3934 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
3938 Create EFI_IFR_TIME_OP opcode.
3940 If OpCodeHandle is NULL, then ASSERT().
3941 If any reserved bits are set in QuestionFlags, then ASSERT().
3942 If any reserved bits are set in TimeFlags, then ASSERT().
3944 @param[in] OpCodeHandle Handle to the buffer of opcodes.
3945 @param[in] QuestionId Question ID
3946 @param[in] VarStoreId Storage ID, optional. If TimeFlags is not
3947 QF_TIME_STORAGE_NORMAL, this parameter is ignored.
3948 @param[in] VarOffset Offset in Storage or String ID of the name (VarName)
3949 for this name/value pair, optional. If TimeFlags is not
3950 QF_TIME_STORAGE_NORMAL, this parameter is ignored.
3951 @param[in] Prompt String ID for Prompt
3952 @param[in] Help String ID for Help
3953 @param[in] QuestionFlags Flags in Question Header
3954 @param[in] TimeFlags Flags for time opcode
3955 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This
3956 is an optional parameter that may be NULL.
3958 @retval NULL There is not enough space left in Buffer to add the opcode.
3959 @retval Other A pointer to the created opcode.
3964 HiiCreateTimeOpCode (
3965 IN VOID
*OpCodeHandle
,
3966 IN EFI_QUESTION_ID QuestionId
,
3967 IN EFI_VARSTORE_ID VarStoreId
, OPTIONAL
3968 IN UINT16 VarOffset
, OPTIONAL
3969 IN EFI_STRING_ID Prompt
,
3970 IN EFI_STRING_ID Help
,
3971 IN UINT8 QuestionFlags
,
3973 IN VOID
*DefaultsOpCodeHandle OPTIONAL
3976 EFI_IFR_TIME OpCode
;
3979 ASSERT ((QuestionFlags
& (~(EFI_IFR_FLAG_READ_ONLY
| EFI_IFR_FLAG_CALLBACK
| EFI_IFR_FLAG_RESET_REQUIRED
))) == 0);
3980 ASSERT ((TimeFlags
& (~(QF_TIME_HOUR_SUPPRESS
| QF_TIME_MINUTE_SUPPRESS
| QF_TIME_SECOND_SUPPRESS
| QF_TIME_STORAGE
))) == 0);
3982 ZeroMem (&OpCode
, sizeof (OpCode
));
3983 OpCode
.Question
.Header
.Prompt
= Prompt
;
3984 OpCode
.Question
.Header
.Help
= Help
;
3985 OpCode
.Question
.QuestionId
= QuestionId
;
3986 OpCode
.Question
.VarStoreId
= VarStoreId
;
3987 OpCode
.Question
.VarStoreInfo
.VarOffset
= VarOffset
;
3988 OpCode
.Question
.Flags
= QuestionFlags
;
3989 OpCode
.Flags
= TimeFlags
;
3991 if (DefaultsOpCodeHandle
== NULL
) {
3992 return InternalHiiCreateOpCode (OpCodeHandle
, &OpCode
, EFI_IFR_TIME_OP
, sizeof (OpCode
));
3995 Position
= InternalHiiOpCodeHandlePosition (OpCodeHandle
);
3996 InternalHiiCreateOpCodeExtended (OpCodeHandle
, &OpCode
, EFI_IFR_TIME_OP
, sizeof (OpCode
), 0, 1);
3997 InternalHiiAppendOpCodes (OpCodeHandle
, DefaultsOpCodeHandle
);
3998 HiiCreateEndOpCode (OpCodeHandle
);
3999 return InternalHiiOpCodeHandleBuffer (OpCodeHandle
) + Position
;
4003 This is the internal worker function to update the data in
4004 a form specified by FormSetGuid, FormId and Label.
4006 @param[in] FormSetGuid The optional Formset GUID.
4007 @param[in] FormId The Form ID.
4008 @param[in] Package The package header.
4009 @param[in] OpCodeBufferStart An OpCode buffer that contains the set of IFR
4010 opcodes to be inserted or replaced in the form.
4011 @param[in] OpCodeBufferEnd An OpCcode buffer that contains the IFR opcode
4012 that marks the end of a replace operation in the form.
4013 @param[out] TempPackage The resultant package.
4015 @retval EFI_SUCCESS The function completes successfully.
4016 @retval EFI_NOT_FOUND The updated opcode or endopcode is not found.
4021 InternalHiiUpdateFormPackageData (
4022 IN EFI_GUID
*FormSetGuid
, OPTIONAL
4023 IN EFI_FORM_ID FormId
,
4024 IN EFI_HII_PACKAGE_HEADER
*Package
,
4025 IN HII_LIB_OPCODE_BUFFER
*OpCodeBufferStart
,
4026 IN HII_LIB_OPCODE_BUFFER
*OpCodeBufferEnd
, OPTIONAL
4027 OUT EFI_HII_PACKAGE_HEADER
*TempPackage
4032 EFI_HII_PACKAGE_HEADER PackageHeader
;
4034 EFI_IFR_OP_HEADER
*IfrOpHdr
;
4035 EFI_IFR_OP_HEADER
*UpdateIfrOpHdr
;
4039 UINTN UpdatePackageLength
;
4041 CopyMem (TempPackage
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
4042 UpdatePackageLength
= sizeof (EFI_HII_PACKAGE_HEADER
);
4043 BufferPos
= (UINT8
*) (TempPackage
+ 1);
4045 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
4046 IfrOpHdr
= (EFI_IFR_OP_HEADER
*)((UINT8
*) Package
+ sizeof (EFI_HII_PACKAGE_HEADER
));
4047 Offset
= sizeof (EFI_HII_PACKAGE_HEADER
);
4048 GetFormSet
= (BOOLEAN
) ((FormSetGuid
== NULL
) ? TRUE
: FALSE
);
4052 while (Offset
< PackageHeader
.Length
) {
4053 CopyMem (BufferPos
, IfrOpHdr
, IfrOpHdr
->Length
);
4054 BufferPos
+= IfrOpHdr
->Length
;
4055 UpdatePackageLength
+= IfrOpHdr
->Length
;
4058 // Find the matched FormSet and Form
4060 if ((IfrOpHdr
->OpCode
== EFI_IFR_FORM_SET_OP
) && (FormSetGuid
!= NULL
)) {
4061 if (CompareGuid((GUID
*)(VOID
*)&((EFI_IFR_FORM_SET
*) IfrOpHdr
)->Guid
, FormSetGuid
)) {
4066 } else if (IfrOpHdr
->OpCode
== EFI_IFR_FORM_OP
|| IfrOpHdr
->OpCode
== EFI_IFR_FORM_MAP_OP
) {
4067 if (CompareMem (&((EFI_IFR_FORM
*) IfrOpHdr
)->FormId
, &FormId
, sizeof (EFI_FORM_ID
)) == 0) {
4075 // The matched Form is found, and Update data in this form
4077 if (GetFormSet
&& GetForm
) {
4078 UpdateIfrOpHdr
= (EFI_IFR_OP_HEADER
*) OpCodeBufferStart
->Buffer
;
4079 if ((UpdateIfrOpHdr
->Length
== IfrOpHdr
->Length
) && \
4080 (CompareMem (IfrOpHdr
, UpdateIfrOpHdr
, UpdateIfrOpHdr
->Length
) == 0)) {
4082 // Remove the original data when End OpCode buffer exist.
4084 if (OpCodeBufferEnd
!= NULL
) {
4085 Offset
+= IfrOpHdr
->Length
;
4086 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) ((UINT8
*) (IfrOpHdr
) + IfrOpHdr
->Length
);
4087 UpdateIfrOpHdr
= (EFI_IFR_OP_HEADER
*) OpCodeBufferEnd
->Buffer
;
4088 while (Offset
< PackageHeader
.Length
) {
4090 // Search the matched end opcode
4092 if ((UpdateIfrOpHdr
->Length
== IfrOpHdr
->Length
) && \
4093 (CompareMem (IfrOpHdr
, UpdateIfrOpHdr
, UpdateIfrOpHdr
->Length
) == 0)) {
4097 // Go to the next Op-Code
4099 Offset
+= IfrOpHdr
->Length
;
4100 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) ((UINT8
*) (IfrOpHdr
) + IfrOpHdr
->Length
);
4103 if (Offset
>= PackageHeader
.Length
) {
4105 // The end opcode is not found.
4107 return EFI_NOT_FOUND
;
4112 // Insert the updated data
4114 AddSize
= ((EFI_IFR_OP_HEADER
*) OpCodeBufferStart
->Buffer
)->Length
;
4115 CopyMem (BufferPos
, OpCodeBufferStart
->Buffer
+ AddSize
, OpCodeBufferStart
->Position
- AddSize
);
4116 BufferPos
+= OpCodeBufferStart
->Position
- AddSize
;
4117 UpdatePackageLength
+= OpCodeBufferStart
->Position
- AddSize
;
4119 if (OpCodeBufferEnd
!= NULL
) {
4121 // Add the end opcode
4123 CopyMem (BufferPos
, IfrOpHdr
, IfrOpHdr
->Length
);
4124 BufferPos
+= IfrOpHdr
->Length
;
4125 UpdatePackageLength
+= IfrOpHdr
->Length
;
4129 // Copy the left package data.
4131 Offset
+= IfrOpHdr
->Length
;
4132 CopyMem (BufferPos
, (UINT8
*) Package
+ Offset
, PackageHeader
.Length
- Offset
);
4133 UpdatePackageLength
+= PackageHeader
.Length
- Offset
;
4144 // Go to the next Op-Code
4146 Offset
+= IfrOpHdr
->Length
;
4147 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) ((CHAR8
*) (IfrOpHdr
) + IfrOpHdr
->Length
);
4152 // The updated opcode buffer is not found.
4154 return EFI_NOT_FOUND
;
4157 // Update the package length.
4159 PackageHeader
.Length
= (UINT32
) UpdatePackageLength
;
4160 CopyMem (TempPackage
, &PackageHeader
, sizeof (EFI_HII_PACKAGE_HEADER
));
4166 This function updates a form that has previously been registered with the HII
4167 Database. This function will perform at most one update operation.
4169 The form to update is specified by Handle, FormSetGuid, and FormId. Binary
4170 comparisons of IFR opcodes are performed from the beginning of the form being
4171 updated until an IFR opcode is found that exactly matches the first IFR opcode
4172 specified by StartOpCodeHandle. The following rules are used to determine if
4173 an insert, replace, or delete operation is performed.
4175 1) If no matches are found, then NULL is returned.
4176 2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes
4177 from StartOpCodeHandle except the first opcode are inserted immediately after
4178 the matching IFR opcode in the form to be updated.
4179 3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made
4180 from the matching IFR opcode until an IFR opcode exactly matches the first
4181 IFR opcode specified by EndOpCodeHandle. If no match is found for the first
4182 IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match
4183 is found, then all of the IFR opcodes between the start match and the end
4184 match are deleted from the form being updated and all of the IFR opcodes
4185 from StartOpCodeHandle except the first opcode are inserted immediately after
4186 the matching start IFR opcode. If StartOpCcodeHandle only contains one
4187 IFR instruction, then the result of this operation will delete all of the IFR
4188 opcodes between the start end matches.
4190 If HiiHandle is NULL, then ASSERT().
4191 If StartOpCodeHandle is NULL, then ASSERT().
4193 @param[in] HiiHandle The HII Handle of the form to update.
4194 @param[in] FormSetGuid The Formset GUID of the form to update. This
4195 is an optional parameter that may be NULL.
4196 If it is NULL, all FormSet will be updated.
4197 @param[in] FormId The ID of the form to update.
4198 @param[in] StartOpCodeHandle An OpCode Handle that contains the set of IFR
4199 opcodes to be inserted or replaced in the form.
4200 The first IFR instruction in StartOpCodeHandle
4201 is used to find matching IFR opcode in the
4203 @param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode
4204 that marks the end of a replace operation in
4205 the form. This is an optional parameter that
4206 may be NULL. If it is NULL, then an the IFR
4207 opcodes specified by StartOpCodeHandle are
4208 inserted into the form.
4210 @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.
4211 @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND.
4212 1) The form specified by HiiHandle, FormSetGuid,
4213 and FormId could not be found in the HII Database.
4214 2) No IFR opcodes in the target form match the first
4215 IFR opcode in StartOpCodeHandle.
4216 3) EndOpCOde is not NULL, and no IFR opcodes in the
4217 target form following a matching start opcode match
4218 the first IFR opcode in EndOpCodeHandle.
4219 @retval EFI_SUCCESS The matched form is updated by StartOpcode.
4225 IN EFI_HII_HANDLE HiiHandle
,
4226 IN EFI_GUID
*FormSetGuid
, OPTIONAL
4227 IN EFI_FORM_ID FormId
,
4228 IN VOID
*StartOpCodeHandle
,
4229 IN VOID
*EndOpCodeHandle OPTIONAL
4233 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
4234 UINT32 PackageListLength
;
4236 EFI_HII_PACKAGE_LIST_HEADER
*UpdatePackageList
;
4238 UINT8
*UpdateBufferPos
;
4239 EFI_HII_PACKAGE_HEADER
*Package
;
4240 EFI_HII_PACKAGE_HEADER
*TempPackage
;
4241 EFI_HII_PACKAGE_HEADER PackageHeader
;
4243 HII_LIB_OPCODE_BUFFER
*OpCodeBufferStart
;
4244 HII_LIB_OPCODE_BUFFER
*OpCodeBufferEnd
;
4247 // Input update data can't be NULL.
4249 ASSERT (HiiHandle
!= NULL
);
4250 ASSERT (StartOpCodeHandle
!= NULL
);
4251 UpdatePackageList
= NULL
;
4253 HiiPackageList
= NULL
;
4256 // Retrieve buffer data from Opcode Handle
4258 OpCodeBufferStart
= (HII_LIB_OPCODE_BUFFER
*) StartOpCodeHandle
;
4259 OpCodeBufferEnd
= (HII_LIB_OPCODE_BUFFER
*) EndOpCodeHandle
;
4262 // Get the original package list
4265 HiiPackageList
= NULL
;
4266 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, HiiHandle
, &BufferSize
, HiiPackageList
);
4268 // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.
4270 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
4274 HiiPackageList
= AllocatePool (BufferSize
);
4275 if (HiiPackageList
== NULL
) {
4276 Status
= EFI_OUT_OF_RESOURCES
;
4280 Status
= gHiiDatabase
->ExportPackageLists (gHiiDatabase
, HiiHandle
, &BufferSize
, HiiPackageList
);
4281 if (EFI_ERROR (Status
)) {
4286 // Calculate and allocate space for retrieval of IFR data
4288 BufferSize
+= OpCodeBufferStart
->Position
;
4289 UpdatePackageList
= AllocateZeroPool (BufferSize
);
4290 if (UpdatePackageList
== NULL
) {
4291 Status
= EFI_OUT_OF_RESOURCES
;
4296 // Allocate temp buffer to store the temp updated package buffer
4298 TempPackage
= AllocateZeroPool (BufferSize
);
4299 if (TempPackage
== NULL
) {
4300 Status
= EFI_OUT_OF_RESOURCES
;
4304 UpdateBufferPos
= (UINT8
*) UpdatePackageList
;
4307 // Copy the package list header
4309 CopyMem (UpdateBufferPos
, HiiPackageList
, sizeof (EFI_HII_PACKAGE_LIST_HEADER
));
4310 UpdateBufferPos
+= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
4313 // Go through each package to find the matched package and update one by one
4316 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
4317 PackageListLength
= ReadUnaligned32 (&HiiPackageList
->PackageLength
);
4318 while (Offset
< PackageListLength
) {
4319 Package
= (EFI_HII_PACKAGE_HEADER
*) (((UINT8
*) HiiPackageList
) + Offset
);
4320 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
4321 Offset
+= Package
->Length
;
4323 if (Package
->Type
== EFI_HII_PACKAGE_FORMS
) {
4325 // Check this package is the matched package.
4327 Status
= InternalHiiUpdateFormPackageData (FormSetGuid
, FormId
, Package
, OpCodeBufferStart
, OpCodeBufferEnd
, TempPackage
);
4329 // The matched package is found. Its package buffer will be updated by the input new data.
4331 if (!EFI_ERROR(Status
)) {
4337 // Add updated package buffer
4339 Package
= TempPackage
;
4344 // Add pacakge buffer
4346 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
4347 CopyMem (UpdateBufferPos
, Package
, PackageHeader
.Length
);
4348 UpdateBufferPos
+= PackageHeader
.Length
;
4353 // Update package list length
4355 BufferSize
= UpdateBufferPos
- (UINT8
*) UpdatePackageList
;
4356 WriteUnaligned32 (&UpdatePackageList
->PackageLength
, (UINT32
) BufferSize
);
4359 // Update Package to show form
4361 Status
= gHiiDatabase
->UpdatePackageList (gHiiDatabase
, HiiHandle
, UpdatePackageList
);
4364 // Not matched form is found and updated.
4366 Status
= EFI_NOT_FOUND
;
4370 if (HiiPackageList
!= NULL
) {
4371 FreePool (HiiPackageList
);
4374 if (UpdatePackageList
!= NULL
) {
4375 FreePool (UpdatePackageList
);
4378 if (TempPackage
!= NULL
) {
4379 FreePool (TempPackage
);