2 Implementation of interfaces function for EFI_HII_CONFIG_ROUTING_PROTOCOL.
4 Copyright (c) 2007 - 2015, 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.
16 #include "HiiDatabase.h"
17 extern HII_DATABASE_PRIVATE_DATA mPrivate
;
20 Calculate the number of Unicode characters of the incoming Configuration string,
21 not including NULL terminator.
23 This is a internal function.
25 @param String String in <MultiConfigRequest> or
26 <MultiConfigResp> format.
28 @return The number of Unicode characters.
32 CalculateConfigStringLen (
39 // "GUID=" should be the first element of incoming string.
41 ASSERT (String
!= NULL
);
42 ASSERT (StrnCmp (String
, L
"GUID=", StrLen (L
"GUID=")) == 0);
45 // The beginning of next <ConfigRequest>/<ConfigResp> should be "&GUID=".
46 // Will meet '\0' if there is only one <ConfigRequest>/<ConfigResp>.
48 TmpPtr
= StrStr (String
, L
"&GUID=");
50 return StrLen (String
);
53 return (TmpPtr
- String
);
58 Convert the hex UNICODE %02x encoding of a UEFI device path to binary
59 from <PathHdr> of <ConfigHdr>.
61 This is a internal function.
63 @param String UEFI configuration string
64 @param DevicePathData Binary of a UEFI device path.
66 @retval EFI_NOT_FOUND The device path is not invalid.
67 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.
68 @retval EFI_OUT_OF_RESOURCES Lake of resources to store neccesary structures.
69 @retval EFI_SUCCESS The device path is retrieved and translated to
76 OUT UINT8
**DevicePathData
81 UINT8
*DevicePathBuffer
;
85 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
88 if (String
== NULL
|| DevicePathData
== NULL
) {
89 return EFI_INVALID_PARAMETER
;
93 // Find the 'PATH=' of <PathHdr> and skip it.
95 for (; (*String
!= 0 && StrnCmp (String
, L
"PATH=", StrLen (L
"PATH=")) != 0); String
++);
97 return EFI_INVALID_PARAMETER
;
100 // Check whether path data does exist.
102 String
+= StrLen (L
"PATH=");
104 return EFI_INVALID_PARAMETER
;
109 // The content between 'PATH=' of <ConfigHdr> and '&' of next element
110 // or '\0' (end of configuration string) is the UNICODE %02x bytes encoding
111 // of UEFI device path.
113 for (Length
= 0; *String
!= 0 && *String
!= L
'&'; String
++, Length
++);
115 // Check DevicePath Length
117 if (((Length
+ 1) / 2) < sizeof (EFI_DEVICE_PATH_PROTOCOL
)) {
118 return EFI_NOT_FOUND
;
122 // The data in <PathHdr> is encoded as hex UNICODE %02x bytes in the same order
123 // as the device path resides in RAM memory.
124 // Translate the data into binary.
126 DevicePathBuffer
= (UINT8
*) AllocateZeroPool ((Length
+ 1) / 2);
127 if (DevicePathBuffer
== NULL
) {
128 return EFI_OUT_OF_RESOURCES
;
132 // Convert DevicePath
134 ZeroMem (TemStr
, sizeof (TemStr
));
135 for (Index
= 0; Index
< Length
; Index
++) {
136 TemStr
[0] = PathHdr
[Index
];
137 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
138 if ((Index
& 1) == 0) {
139 DevicePathBuffer
[Index
/2] = DigitUint8
;
141 DevicePathBuffer
[Index
/2] = (UINT8
) ((DevicePathBuffer
[Index
/2] << 4) + DigitUint8
);
146 // Validate DevicePath
148 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePathBuffer
;
149 while (!IsDevicePathEnd (DevicePath
)) {
150 if ((DevicePath
->Type
== 0) || (DevicePath
->SubType
== 0) || (DevicePathNodeLength (DevicePath
) < sizeof (EFI_DEVICE_PATH_PROTOCOL
))) {
152 // Invalid device path
154 FreePool (DevicePathBuffer
);
155 return EFI_NOT_FOUND
;
157 DevicePath
= NextDevicePathNode (DevicePath
);
161 // return the device path
163 *DevicePathData
= DevicePathBuffer
;
168 Converts the unicode character of the string from uppercase to lowercase.
169 This is a internal function.
171 @param ConfigString String to be converted
177 IN EFI_STRING ConfigString
183 ASSERT (ConfigString
!= NULL
);
186 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
188 for (String
= ConfigString
, Lower
= FALSE
; *String
!= L
'\0'; String
++) {
189 if (*String
== L
'=') {
191 } else if (*String
== L
'&') {
193 } else if (Lower
&& *String
>= L
'A' && *String
<= L
'F') {
194 *String
= (CHAR16
) (*String
- L
'A' + L
'a');
202 Generate a sub string then output it.
204 This is a internal function.
206 @param String A constant string which is the prefix of the to be
207 generated string, e.g. GUID=
209 @param BufferLen The length of the Buffer in bytes.
211 @param Buffer Points to a buffer which will be converted to be the
212 content of the generated string.
214 @param Flag If 1, the buffer contains data for the value of GUID or PATH stored in
215 UINT8 *; if 2, the buffer contains unicode string for the value of NAME;
216 if 3, the buffer contains other data.
218 @param SubStr Points to the output string. It's caller's
219 responsibility to free this buffer.
225 IN CONST EFI_STRING String
,
229 OUT EFI_STRING
*SubStr
234 EFI_STRING StringHeader
;
240 ASSERT (String
!= NULL
&& SubStr
!= NULL
);
242 if (Buffer
== NULL
) {
243 *SubStr
= AllocateCopyPool (StrSize (String
), String
);
244 ASSERT (*SubStr
!= NULL
);
249 // Header + Data + '&' + '\0'
251 Length
= StrLen (String
) + BufferLen
* 2 + 1 + 1;
252 Str
= AllocateZeroPool (Length
* sizeof (CHAR16
));
253 ASSERT (Str
!= NULL
);
255 StrCpyS (Str
, Length
, String
);
257 StringHeader
= Str
+ StrLen (String
);
258 TemString
= (CHAR16
*) StringHeader
;
263 // Convert Buffer to Hex String in reverse order
265 TemBuffer
= ((UINT8
*) Buffer
);
266 for (Index
= 0; Index
< BufferLen
; Index
++, TemBuffer
++) {
267 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
272 // Check buffer is enough
274 TemName
= (CHAR16
*) Buffer
;
275 ASSERT ((BufferLen
* 2 + 1) >= (StrLen (TemName
) * 4 + 1));
277 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
279 for (; *TemName
!= L
'\0'; TemName
++) {
280 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
285 // Convert Buffer to Hex String
287 TemBuffer
= ((UINT8
*) Buffer
) + BufferLen
- 1;
288 for (Index
= 0; Index
< BufferLen
; Index
++, TemBuffer
--) {
289 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
297 // Convert the uppercase to lowercase since <HexAf> is defined in lowercase format.
299 StrCatS (Str
, Length
, L
"&");
307 Retrieve the <ConfigBody> from String then output it.
309 This is a internal function.
311 @param String A sub string of a configuration string in
312 <MultiConfigAltResp> format.
313 @param ConfigBody Points to the output string. It's caller's
314 responsibility to free this buffer.
316 @retval EFI_INVALID_PARAMETER There is no form package in current hii database.
317 @retval EFI_OUT_OF_RESOURCES Not enough memory to finish this operation.
318 @retval EFI_SUCCESS All existing storage is exported.
323 IN EFI_STRING String
,
324 OUT EFI_STRING
*ConfigBody
331 if (String
== NULL
|| ConfigBody
== NULL
) {
332 return EFI_INVALID_PARAMETER
;
336 // The setting information should start OFFSET, not ALTCFG.
338 if (StrnCmp (String
, L
"&ALTCFG=", StrLen (L
"&ALTCFG=")) == 0) {
339 return EFI_INVALID_PARAMETER
;
342 TmpPtr
= StrStr (String
, L
"GUID=");
343 if (TmpPtr
== NULL
) {
345 // It is the last <ConfigResp> of the incoming configuration string.
347 Result
= AllocateCopyPool (StrSize (String
), String
);
348 if (Result
== NULL
) {
349 return EFI_OUT_OF_RESOURCES
;
351 *ConfigBody
= Result
;
356 Length
= TmpPtr
- String
;
358 return EFI_NOT_FOUND
;
360 Result
= AllocateCopyPool (Length
* sizeof (CHAR16
), String
);
361 if (Result
== NULL
) {
362 return EFI_OUT_OF_RESOURCES
;
365 *(Result
+ Length
- 1) = 0;
366 *ConfigBody
= Result
;
371 Append a string to a multi-string format.
373 This is a internal function.
375 @param MultiString String in <MultiConfigRequest>,
376 <MultiConfigAltResp>, or <MultiConfigResp>. On
377 input, the buffer length of this string is
378 MAX_STRING_LENGTH. On output, the buffer length
380 @param AppendString NULL-terminated Unicode string.
382 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.
383 @retval EFI_SUCCESS AppendString is append to the end of MultiString
387 AppendToMultiString (
388 IN OUT EFI_STRING
*MultiString
,
389 IN EFI_STRING AppendString
392 UINTN AppendStringSize
;
393 UINTN MultiStringSize
;
396 if (MultiString
== NULL
|| *MultiString
== NULL
|| AppendString
== NULL
) {
397 return EFI_INVALID_PARAMETER
;
400 AppendStringSize
= StrSize (AppendString
);
401 MultiStringSize
= StrSize (*MultiString
);
402 MaxLen
= MAX_STRING_LENGTH
/ sizeof (CHAR16
);
405 // Enlarge the buffer each time when length exceeds MAX_STRING_LENGTH.
407 if (MultiStringSize
+ AppendStringSize
> MAX_STRING_LENGTH
||
408 MultiStringSize
> MAX_STRING_LENGTH
) {
409 *MultiString
= (EFI_STRING
) ReallocatePool (
411 MultiStringSize
+ AppendStringSize
,
412 (VOID
*) (*MultiString
)
414 MaxLen
= (MultiStringSize
+ AppendStringSize
) / sizeof (CHAR16
);
415 ASSERT (*MultiString
!= NULL
);
418 // Append the incoming string
420 StrCatS (*MultiString
, MaxLen
, AppendString
);
427 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET
429 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
431 This is a internal function.
433 @param StringPtr String in <BlockConfig> format and points to the
434 first character of <Number>.
435 @param Number The output value. Caller takes the responsibility
437 @param Len Length of the <Number>, in characters.
439 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary
441 @retval EFI_SUCCESS Value of <Number> is outputted in Number
447 IN EFI_STRING StringPtr
,
461 if (StringPtr
== NULL
|| *StringPtr
== L
'\0' || Number
== NULL
|| Len
== NULL
) {
462 return EFI_INVALID_PARAMETER
;
468 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
471 *Len
= StringPtr
- TmpPtr
;
474 Str
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
476 Status
= EFI_OUT_OF_RESOURCES
;
479 CopyMem (Str
, TmpPtr
, *Len
* sizeof (CHAR16
));
480 *(Str
+ *Len
) = L
'\0';
482 Length
= (Length
+ 1) / 2;
483 Buf
= (UINT8
*) AllocateZeroPool (Length
);
485 Status
= EFI_OUT_OF_RESOURCES
;
490 ZeroMem (TemStr
, sizeof (TemStr
));
491 for (Index
= 0; Index
< Length
; Index
++) {
492 TemStr
[0] = Str
[Length
- Index
- 1];
493 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
494 if ((Index
& 1) == 0) {
495 Buf
[Index
/2] = DigitUint8
;
497 Buf
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Buf
[Index
/2]);
502 Status
= EFI_SUCCESS
;
513 This function merges DefaultAltCfgResp string into AltCfgResp string for
514 the missing AltCfgId in AltCfgResq.
516 @param AltCfgResp Pointer to a null-terminated Unicode string in
517 <ConfigAltResp> format. The default value string
518 will be merged into it.
519 @param DefaultAltCfgResp Pointer to a null-terminated Unicode string in
520 <MultiConfigAltResp> format. The default value
521 string may contain more than one ConfigAltResp
522 string for the different varstore buffer.
524 @retval EFI_SUCCESS The merged string returns.
525 @retval EFI_INVALID_PARAMETER *AltCfgResp is to NULL.
530 IN OUT EFI_STRING
*AltCfgResp
,
531 IN EFI_STRING DefaultAltCfgResp
534 EFI_STRING StringPtrDefault
;
535 EFI_STRING StringPtrEnd
;
537 EFI_STRING StringPtr
;
538 EFI_STRING AltConfigHdr
;
540 UINTN SizeAltCfgResp
;
544 if (*AltCfgResp
== NULL
) {
545 return EFI_INVALID_PARAMETER
;
549 // Get the requestr ConfigHdr
552 StringPtr
= *AltCfgResp
;
555 // Find <ConfigHdr> GUID=...&NAME=...&PATH=...
557 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
558 return EFI_INVALID_PARAMETER
;
560 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
563 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
566 if (*StringPtr
== L
'\0') {
567 return EFI_INVALID_PARAMETER
;
569 StringPtr
+= StrLen (L
"&PATH=");
570 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
573 HeaderLength
= StringPtr
- *AltCfgResp
;
576 // Construct AltConfigHdr string "&<ConfigHdr>&ALTCFG=XXXX\0"
577 // |1| StrLen (ConfigHdr) | 8 | 4 | 1 |
579 MaxLen
= 1 + HeaderLength
+ 8 + 4 + 1;
580 AltConfigHdr
= AllocateZeroPool (MaxLen
* sizeof (CHAR16
));
581 if (AltConfigHdr
== NULL
) {
582 return EFI_OUT_OF_RESOURCES
;
584 StrCpyS (AltConfigHdr
, MaxLen
, L
"&");
585 StrnCatS (AltConfigHdr
, MaxLen
, *AltCfgResp
, HeaderLength
);
586 StrCatS (AltConfigHdr
, MaxLen
, L
"&ALTCFG=");
587 HeaderLength
= StrLen (AltConfigHdr
);
589 StringPtrDefault
= StrStr (DefaultAltCfgResp
, AltConfigHdr
);
590 while (StringPtrDefault
!= NULL
) {
594 StrnCatS (AltConfigHdr
, MaxLen
, StringPtrDefault
+ HeaderLength
, 4);
595 StringPtr
= StrStr (*AltCfgResp
, AltConfigHdr
);
598 // Append the found default value string to the input AltCfgResp
600 if (StringPtr
== NULL
) {
601 StringPtrEnd
= StrStr (StringPtrDefault
+ 1, L
"&GUID");
602 SizeAltCfgResp
= StrSize (*AltCfgResp
);
603 TotalSize
= SizeAltCfgResp
+ StrSize (StringPtrDefault
);
604 if (StringPtrEnd
== NULL
) {
606 // No more default string is found.
608 *AltCfgResp
= (EFI_STRING
) ReallocatePool (
611 (VOID
*) (*AltCfgResp
)
613 if (*AltCfgResp
== NULL
) {
614 FreePool (AltConfigHdr
);
615 return EFI_OUT_OF_RESOURCES
;
617 StrCatS (*AltCfgResp
, TotalSize
/ sizeof (CHAR16
), StringPtrDefault
);
620 TempChar
= *StringPtrEnd
;
621 *StringPtrEnd
= L
'\0';
622 *AltCfgResp
= (EFI_STRING
) ReallocatePool (
625 (VOID
*) (*AltCfgResp
)
627 if (*AltCfgResp
== NULL
) {
628 FreePool (AltConfigHdr
);
629 return EFI_OUT_OF_RESOURCES
;
631 StrCatS (*AltCfgResp
, TotalSize
/ sizeof (CHAR16
), StringPtrDefault
);
632 *StringPtrEnd
= TempChar
;
637 // Find next AltCfg String
639 *(AltConfigHdr
+ HeaderLength
) = L
'\0';
640 StringPtrDefault
= StrStr (StringPtrDefault
+ 1, AltConfigHdr
);
643 FreePool (AltConfigHdr
);
648 This function inserts new DefaultValueData into the BlockData DefaultValue array.
650 @param BlockData The BlockData is updated to add new default value.
651 @param DefaultValueData The DefaultValue is added.
656 IN IFR_BLOCK_DATA
*BlockData
,
657 IN IFR_DEFAULT_DATA
*DefaultValueData
661 IFR_DEFAULT_DATA
*DefaultValueArray
;
662 LIST_ENTRY
*DefaultLink
;
664 DefaultLink
= &BlockData
->DefaultValueEntry
;
666 for (Link
= DefaultLink
->ForwardLink
; Link
!= DefaultLink
; Link
= Link
->ForwardLink
) {
667 DefaultValueArray
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
668 if (DefaultValueArray
->DefaultId
== DefaultValueData
->DefaultId
) {
670 // DEFAULT_VALUE_FROM_OPCODE has high priority, DEFAULT_VALUE_FROM_DEFAULT has low priority.
672 if (DefaultValueData
->Type
> DefaultValueArray
->Type
) {
674 // Update the default value array in BlockData.
676 CopyMem (&DefaultValueArray
->Value
, &DefaultValueData
->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
677 DefaultValueArray
->Type
= DefaultValueData
->Type
;
678 DefaultValueArray
->Cleaned
= DefaultValueData
->Cleaned
;
685 // Insert new default value data in tail.
687 DefaultValueArray
= AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
688 ASSERT (DefaultValueArray
!= NULL
);
689 CopyMem (DefaultValueArray
, DefaultValueData
, sizeof (IFR_DEFAULT_DATA
));
690 InsertTailList (Link
, &DefaultValueArray
->Entry
);
694 This function inserts new BlockData into the block link
696 @param BlockLink The list entry points to block array.
697 @param BlockData The point to BlockData is added.
702 IN LIST_ENTRY
*BlockLink
,
703 IN IFR_BLOCK_DATA
**BlockData
707 IFR_BLOCK_DATA
*BlockArray
;
708 IFR_BLOCK_DATA
*BlockSingleData
;
710 BlockSingleData
= *BlockData
;
712 if (BlockSingleData
->Name
!= NULL
) {
713 InsertTailList (BlockLink
, &BlockSingleData
->Entry
);
718 // Insert block data in its Offset and Width order.
720 for (Link
= BlockLink
->ForwardLink
; Link
!= BlockLink
; Link
= Link
->ForwardLink
) {
721 BlockArray
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
722 if (BlockArray
->Offset
== BlockSingleData
->Offset
) {
723 if (BlockArray
->Width
> BlockSingleData
->Width
) {
725 // Insert this block data in the front of block array
727 InsertTailList (Link
, &BlockSingleData
->Entry
);
731 if (BlockArray
->Width
== BlockSingleData
->Width
) {
733 // The same block array has been added.
735 if (BlockSingleData
!= BlockArray
) {
736 FreePool (BlockSingleData
);
737 *BlockData
= BlockArray
;
741 } else if (BlockArray
->Offset
> BlockSingleData
->Offset
) {
743 // Insert new block data in the front of block array
745 InsertTailList (Link
, &BlockSingleData
->Entry
);
751 // Add new block data into the tail.
753 InsertTailList (Link
, &BlockSingleData
->Entry
);
757 Retrieves a pointer to the a Null-terminated ASCII string containing the list
758 of languages that an HII handle in the HII Database supports. The returned
759 string is allocated using AllocatePool(). The caller is responsible for freeing
760 the returned string using FreePool(). The format of the returned string follows
761 the language format assumed the HII Database.
763 If HiiHandle is NULL, then ASSERT().
765 @param[in] HiiHandle A handle that was previously registered in the HII Database.
767 @retval NULL HiiHandle is not registered in the HII database
768 @retval NULL There are not enough resources available to retrieve the suported
770 @retval NULL The list of suported languages could not be retrieved.
771 @retval Other A pointer to the Null-terminated ASCII string of supported languages.
775 GetSupportedLanguages (
776 IN EFI_HII_HANDLE HiiHandle
781 CHAR8 TempSupportedLanguages
;
782 CHAR8
*SupportedLanguages
;
784 ASSERT (HiiHandle
!= NULL
);
787 // Retrieve the size required for the supported languages buffer.
790 Status
= mPrivate
.HiiString
.GetLanguages (&mPrivate
.HiiString
, HiiHandle
, &TempSupportedLanguages
, &LanguageSize
);
793 // If GetLanguages() returns EFI_SUCCESS for a zero size,
794 // then there are no supported languages registered for HiiHandle. If GetLanguages()
795 // returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present
796 // in the HII Database
798 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
800 // Return NULL if the size can not be retrieved, or if HiiHandle is not in the HII Database
806 // Allocate the supported languages buffer.
808 SupportedLanguages
= AllocateZeroPool (LanguageSize
);
809 if (SupportedLanguages
== NULL
) {
811 // Return NULL if allocation fails.
817 // Retrieve the supported languages string
819 Status
= mPrivate
.HiiString
.GetLanguages (&mPrivate
.HiiString
, HiiHandle
, SupportedLanguages
, &LanguageSize
);
820 if (EFI_ERROR (Status
)) {
822 // Free the buffer and return NULL if the supported languages can not be retrieved.
824 FreePool (SupportedLanguages
);
829 // Return the Null-terminated ASCII string of supported languages
831 return SupportedLanguages
;
835 Retrieves a string from a string package.
837 If HiiHandle is NULL, then ASSERT().
838 If StringId is 0, then ASSET.
840 @param[in] HiiHandle A handle that was previously registered in the HII Database.
841 @param[in] StringId The identifier of the string to retrieved from the string
842 package associated with HiiHandle.
844 @retval NULL The string specified by StringId is not present in the string package.
845 @retval Other The string was returned.
850 IN EFI_HII_HANDLE HiiHandle
,
851 IN EFI_STRING_ID StringId
858 CHAR8
*SupportedLanguages
;
859 CHAR8
*PlatformLanguage
;
863 ASSERT (HiiHandle
!= NULL
);
864 ASSERT (StringId
!= 0);
867 // Initialize all allocated buffers to NULL
869 SupportedLanguages
= NULL
;
870 PlatformLanguage
= NULL
;
876 // Get the languages that the package specified by HiiHandle supports
878 SupportedLanguages
= GetSupportedLanguages (HiiHandle
);
879 if (SupportedLanguages
== NULL
) {
884 // Get the current platform language setting
886 GetEfiGlobalVariable2 (L
"PlatformLang", (VOID
**)&PlatformLanguage
, NULL
);
889 // Get the best matching language from SupportedLanguages
891 BestLanguage
= GetBestLanguage (
893 FALSE
, // RFC 4646 mode
894 Language
, // Highest priority
895 PlatformLanguage
!= NULL
? PlatformLanguage
: "", // Next highest priority
896 SupportedLanguages
, // Lowest priority
899 if (BestLanguage
== NULL
) {
904 // Retrieve the size of the string in the string package for the BestLanguage
907 Status
= mPrivate
.HiiString
.GetString (
917 // If GetString() returns EFI_SUCCESS for a zero size,
918 // then there are no supported languages registered for HiiHandle. If GetString()
919 // returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present
920 // in the HII Database
922 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
927 // Allocate a buffer for the return string
929 String
= AllocateZeroPool (StringSize
);
930 if (String
== NULL
) {
935 // Retrieve the string from the string package
937 Status
= mPrivate
.HiiString
.GetString (
946 if (EFI_ERROR (Status
)) {
948 // Free the buffer and return NULL if the supported languages can not be retrieved.
956 // Free allocated buffers
958 if (SupportedLanguages
!= NULL
) {
959 FreePool (SupportedLanguages
);
961 if (PlatformLanguage
!= NULL
) {
962 FreePool (PlatformLanguage
);
964 if (BestLanguage
!= NULL
) {
965 FreePool (BestLanguage
);
969 // Return the Null-terminated Unicode string
975 This function checks VarOffset and VarWidth is in the block range.
977 @param RequestBlockArray The block array is to be checked.
978 @param VarOffset Offset of var to the structure
979 @param VarWidth Width of var.
980 @param IsNameValueType Whether this varstore is name/value varstore or not.
981 @param HiiHandle Hii handle for this hii package.
983 @retval TRUE This Var is in the block range.
984 @retval FALSE This Var is not in the block range.
988 IN IFR_BLOCK_DATA
*RequestBlockArray
,
991 IN BOOLEAN IsNameValueType
,
992 IN EFI_HII_HANDLE HiiHandle
996 IFR_BLOCK_DATA
*BlockData
;
1000 // No Request Block array, all vars are got.
1002 if (RequestBlockArray
== NULL
) {
1007 // Check the input var is in the request block range.
1009 for (Link
= RequestBlockArray
->Entry
.ForwardLink
; Link
!= &RequestBlockArray
->Entry
; Link
= Link
->ForwardLink
) {
1010 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
1012 if (IsNameValueType
) {
1013 Name
= InternalGetString (HiiHandle
, VarOffset
);
1014 ASSERT (Name
!= NULL
);
1016 if (StrnCmp (BlockData
->Name
, Name
, StrLen (Name
)) == 0) {
1022 if ((VarOffset
>= BlockData
->Offset
) && ((VarOffset
+ VarWidth
) <= (BlockData
->Offset
+ BlockData
->Width
))) {
1032 Get form package data from data base.
1034 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
1035 @param HiiFormPackage The buffer saves the package data.
1036 @param PackageSize The buffer size of the package data.
1040 GetFormPackageData (
1041 IN HII_DATABASE_RECORD
*DataBaseRecord
,
1042 IN OUT UINT8
**HiiFormPackage
,
1043 OUT UINTN
*PackageSize
1050 if (DataBaseRecord
== NULL
|| HiiFormPackage
== NULL
|| PackageSize
== NULL
) {
1051 return EFI_INVALID_PARAMETER
;
1057 // 0. Get Hii Form Package by HiiHandle
1059 Status
= ExportFormPackages (
1061 DataBaseRecord
->Handle
,
1062 DataBaseRecord
->PackageList
,
1068 if (EFI_ERROR (Status
)) {
1072 (*HiiFormPackage
) = AllocatePool (ResultSize
);
1073 if (*HiiFormPackage
== NULL
) {
1074 Status
= EFI_OUT_OF_RESOURCES
;
1079 // Get HiiFormPackage by HiiHandle
1083 Status
= ExportFormPackages (
1085 DataBaseRecord
->Handle
,
1086 DataBaseRecord
->PackageList
,
1092 if (EFI_ERROR (Status
)) {
1093 FreePool (*HiiFormPackage
);
1096 *PackageSize
= Size
;
1103 This function parses Form Package to get the efi varstore info according to the request ConfigHdr.
1105 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
1106 @param ConfigHdr Request string ConfigHdr. If it is NULL,
1107 the first found varstore will be as ConfigHdr.
1108 @param IsEfiVarstore Whether the request storage type is efi varstore type.
1109 @param EfiVarStore The efi varstore info which will return.
1113 IN HII_DATABASE_RECORD
*DataBaseRecord
,
1114 IN EFI_STRING ConfigHdr
,
1115 OUT BOOLEAN
*IsEfiVarstore
,
1116 OUT EFI_IFR_VARSTORE_EFI
**EfiVarStore
1121 UINTN PackageOffset
;
1122 EFI_IFR_OP_HEADER
*IfrOpHdr
;
1123 CHAR16
*VarStoreName
;
1128 UINT8
*HiiFormPackage
;
1130 EFI_IFR_VARSTORE_EFI
*IfrEfiVarStore
;
1131 EFI_HII_PACKAGE_HEADER
*PackageHeader
;
1133 HiiFormPackage
= NULL
;
1135 Status
= EFI_SUCCESS
;
1139 *IsEfiVarstore
= FALSE
;
1141 Status
= GetFormPackageData(DataBaseRecord
, &HiiFormPackage
, &PackageSize
);
1142 if (EFI_ERROR (Status
)) {
1146 IfrOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1147 PackageOffset
= IfrOffset
;
1148 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) HiiFormPackage
;
1150 while (IfrOffset
< PackageSize
) {
1152 // More than one form packages exist.
1154 if (PackageOffset
>= PackageHeader
->Length
) {
1156 // Process the new form package.
1158 PackageOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1159 IfrOffset
+= PackageOffset
;
1160 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) (HiiFormPackage
+ IfrOffset
);
1163 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) (HiiFormPackage
+ IfrOffset
);
1164 IfrOffset
+= IfrOpHdr
->Length
;
1165 PackageOffset
+= IfrOpHdr
->Length
;
1167 if (IfrOpHdr
->OpCode
== EFI_IFR_VARSTORE_EFI_OP
) {
1168 IfrEfiVarStore
= (EFI_IFR_VARSTORE_EFI
*) IfrOpHdr
;
1170 // If the length is small than the structure, this is from old efi
1171 // varstore definition. Old efi varstore get config directly from
1172 // GetVariable function.
1174 if (IfrOpHdr
->Length
< sizeof (EFI_IFR_VARSTORE_EFI
)) {
1178 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrEfiVarStore
->Name
) * sizeof (CHAR16
));
1179 if (VarStoreName
== NULL
) {
1180 Status
= EFI_OUT_OF_RESOURCES
;
1183 AsciiStrToUnicodeStr ((CHAR8
*) IfrEfiVarStore
->Name
, VarStoreName
);
1185 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) &IfrEfiVarStore
->Guid
, 1, &GuidStr
);
1186 GenerateSubStr (L
"NAME=", StrLen (VarStoreName
) * sizeof (CHAR16
), (VOID
*) VarStoreName
, 2, &NameStr
);
1187 LengthString
= StrLen (GuidStr
);
1188 LengthString
= LengthString
+ StrLen (NameStr
) + 1;
1189 TempStr
= AllocateZeroPool (LengthString
* sizeof (CHAR16
));
1190 if (TempStr
== NULL
) {
1193 FreePool (VarStoreName
);
1194 Status
= EFI_OUT_OF_RESOURCES
;
1197 StrCpyS (TempStr
, LengthString
, GuidStr
);
1198 StrCatS (TempStr
, LengthString
, NameStr
);
1199 if (ConfigHdr
== NULL
|| StrnCmp (ConfigHdr
, TempStr
, StrLen (TempStr
)) == 0) {
1200 *EfiVarStore
= (EFI_IFR_VARSTORE_EFI
*) AllocateZeroPool (IfrOpHdr
->Length
);
1201 if (*EfiVarStore
== NULL
) {
1202 FreePool (VarStoreName
);
1206 Status
= EFI_OUT_OF_RESOURCES
;
1209 *IsEfiVarstore
= TRUE
;
1210 CopyMem (*EfiVarStore
, IfrEfiVarStore
, IfrOpHdr
->Length
);
1214 // Free alllocated temp string.
1216 FreePool (VarStoreName
);
1222 // Already found the varstore, break;
1224 if (*IsEfiVarstore
) {
1230 if (HiiFormPackage
!= NULL
) {
1231 FreePool (HiiFormPackage
);
1238 Check whether the ConfigRequest string has the request elements.
1239 For EFI_HII_VARSTORE_BUFFER type, the request has "&OFFSET=****&WIDTH=****..." format.
1240 For EFI_HII_VARSTORE_NAME_VALUE type, the request has "&NAME1**&NAME2..." format.
1242 @param ConfigRequest The input config request string.
1244 @retval TRUE The input include config request elements.
1245 @retval FALSE The input string not includes.
1249 GetElementsFromRequest (
1250 IN EFI_STRING ConfigRequest
1253 EFI_STRING TmpRequest
;
1255 TmpRequest
= StrStr (ConfigRequest
, L
"PATH=");
1256 ASSERT (TmpRequest
!= NULL
);
1258 if ((StrStr (TmpRequest
, L
"&OFFSET=") != NULL
) || (StrStr (TmpRequest
, L
"&") != NULL
)) {
1266 Check whether the this varstore is the request varstore.
1268 @param VarstoreGuid Varstore guid.
1269 @param Name Varstore name.
1270 @param ConfigHdr Current configRequest info.
1272 @retval TRUE This varstore is the requst one.
1273 @retval FALSE This varstore is not the requst one.
1278 IN EFI_GUID
*VarstoreGuid
,
1280 IN CHAR16
*ConfigHdr
1294 // If ConfigHdr has name field and varstore not has name, return FALSE.
1296 if (Name
== NULL
&& ConfigHdr
!= NULL
&& StrStr (ConfigHdr
, L
"NAME=&") == NULL
) {
1300 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*)VarstoreGuid
, 1, &GuidStr
);
1302 GenerateSubStr (L
"NAME=", StrLen (Name
) * sizeof (CHAR16
), (VOID
*) Name
, 2, &NameStr
);
1304 GenerateSubStr (L
"NAME=", 0, NULL
, 2, &NameStr
);
1306 LengthString
= StrLen (GuidStr
);
1307 LengthString
= LengthString
+ StrLen (NameStr
) + 1;
1308 TempStr
= AllocateZeroPool (LengthString
* sizeof (CHAR16
));
1309 if (TempStr
== NULL
) {
1313 StrCpyS (TempStr
, LengthString
, GuidStr
);
1314 StrCatS (TempStr
, LengthString
, NameStr
);
1316 if (ConfigHdr
== NULL
|| StrnCmp (ConfigHdr
, TempStr
, StrLen (TempStr
)) == 0) {
1321 if (GuidStr
!= NULL
) {
1325 if (NameStr
!= NULL
) {
1329 if (TempStr
!= NULL
) {
1337 This function parses Form Package to get the efi varstore info according to the request ConfigHdr.
1339 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
1340 @param ConfigHdr Request string ConfigHdr. If it is NULL,
1341 the first found varstore will be as ConfigHdr.
1342 @retval TRUE This hii package is the reqeust one.
1343 @retval FALSE This hii package is not the reqeust one.
1347 IN HII_DATABASE_RECORD
*DataBaseRecord
,
1348 IN EFI_STRING ConfigHdr
1353 UINTN PackageOffset
;
1354 EFI_IFR_OP_HEADER
*IfrOpHdr
;
1355 CHAR16
*VarStoreName
;
1356 UINT8
*HiiFormPackage
;
1358 EFI_IFR_VARSTORE_EFI
*IfrEfiVarStore
;
1359 EFI_HII_PACKAGE_HEADER
*PackageHeader
;
1360 EFI_IFR_VARSTORE
*IfrVarStore
;
1361 EFI_IFR_VARSTORE_NAME_VALUE
*IfrNameValueVarStore
;
1362 BOOLEAN FindVarstore
;
1364 HiiFormPackage
= NULL
;
1365 VarStoreName
= NULL
;
1366 Status
= EFI_SUCCESS
;
1367 FindVarstore
= FALSE
;
1369 Status
= GetFormPackageData(DataBaseRecord
, &HiiFormPackage
, &PackageSize
);
1370 if (EFI_ERROR (Status
)) {
1374 IfrOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1375 PackageOffset
= IfrOffset
;
1376 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) HiiFormPackage
;
1378 while (IfrOffset
< PackageSize
) {
1380 // More than one form packages exist.
1382 if (PackageOffset
>= PackageHeader
->Length
) {
1384 // Process the new form package.
1386 PackageOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1387 IfrOffset
+= PackageOffset
;
1388 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) (HiiFormPackage
+ IfrOffset
);
1391 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) (HiiFormPackage
+ IfrOffset
);
1392 IfrOffset
+= IfrOpHdr
->Length
;
1393 PackageOffset
+= IfrOpHdr
->Length
;
1395 switch (IfrOpHdr
->OpCode
) {
1397 case EFI_IFR_VARSTORE_OP
:
1398 IfrVarStore
= (EFI_IFR_VARSTORE
*) IfrOpHdr
;
1400 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrVarStore
->Name
) * sizeof (CHAR16
));
1401 if (VarStoreName
== NULL
) {
1404 AsciiStrToUnicodeStr ((CHAR8
*)IfrVarStore
->Name
, VarStoreName
);
1406 if (IsThisVarstore((VOID
*)&IfrVarStore
->Guid
, VarStoreName
, ConfigHdr
)) {
1407 FindVarstore
= TRUE
;
1412 case EFI_IFR_VARSTORE_EFI_OP
:
1413 IfrEfiVarStore
= (EFI_IFR_VARSTORE_EFI
*) IfrOpHdr
;
1414 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrEfiVarStore
->Name
) * sizeof (CHAR16
));
1415 if (VarStoreName
== NULL
) {
1418 AsciiStrToUnicodeStr ((CHAR8
*)IfrEfiVarStore
->Name
, VarStoreName
);
1420 if (IsThisVarstore (&IfrEfiVarStore
->Guid
, VarStoreName
, ConfigHdr
)) {
1421 FindVarstore
= TRUE
;
1426 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1427 IfrNameValueVarStore
= (EFI_IFR_VARSTORE_NAME_VALUE
*) IfrOpHdr
;
1429 if (IsThisVarstore (&IfrNameValueVarStore
->Guid
, NULL
, ConfigHdr
)) {
1430 FindVarstore
= TRUE
;
1435 case EFI_IFR_FORM_OP
:
1436 case EFI_IFR_FORM_MAP_OP
:
1438 // No matched varstore is found and directly return.
1447 if (HiiFormPackage
!= NULL
) {
1448 FreePool (HiiFormPackage
);
1451 if (VarStoreName
!= NULL
) {
1452 FreePool (VarStoreName
);
1455 return FindVarstore
;
1459 Check whether the this op code is required.
1461 @param RequestBlockArray The array includes all the request info or NULL.
1462 @param HiiHandle The hii handle for this form package.
1463 @param VarStorageData The varstore data strucure.
1464 @param IfrOpHdr Ifr opcode header for this opcode.
1465 @param VarWidth The buffer width for this opcode.
1466 @param ReturnData The data block added for this opcode.
1468 @retval EFI_SUCCESS This opcode is required.
1469 @retval Others This opcode is not required or error occur.
1473 IsThisOpcodeRequired (
1474 IN IFR_BLOCK_DATA
*RequestBlockArray
,
1475 IN EFI_HII_HANDLE HiiHandle
,
1476 IN OUT IFR_VARSTORAGE_DATA
*VarStorageData
,
1477 IN EFI_IFR_OP_HEADER
*IfrOpHdr
,
1479 OUT IFR_BLOCK_DATA
**ReturnData
1482 IFR_BLOCK_DATA
*BlockData
;
1484 EFI_STRING_ID NameId
;
1485 EFI_IFR_QUESTION_HEADER
*IfrQuestionHdr
;
1489 IfrQuestionHdr
= (EFI_IFR_QUESTION_HEADER
*)((CHAR8
*) IfrOpHdr
+ sizeof (EFI_IFR_OP_HEADER
));
1491 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
1492 NameId
= IfrQuestionHdr
->VarStoreInfo
.VarName
;
1495 // Check whether this question is in requested block array.
1497 if (!BlockArrayCheck (RequestBlockArray
, NameId
, 0, TRUE
, HiiHandle
)) {
1499 // This question is not in the requested string. Skip it.
1504 VarOffset
= IfrQuestionHdr
->VarStoreInfo
.VarOffset
;
1507 // Check whether this question is in requested block array.
1509 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
, FALSE
, HiiHandle
)) {
1511 // This question is not in the requested string. Skip it.
1517 // Check this var question is in the var storage
1519 if (((VarOffset
+ VarWidth
) > VarStorageData
->Size
)) {
1520 return EFI_INVALID_PARAMETER
;
1524 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1525 if (BlockData
== NULL
) {
1526 return EFI_OUT_OF_RESOURCES
;
1529 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
1530 BlockData
->Name
= InternalGetString(HiiHandle
, NameId
);
1532 BlockData
->Offset
= VarOffset
;
1535 BlockData
->Width
= VarWidth
;
1536 BlockData
->QuestionId
= IfrQuestionHdr
->QuestionId
;
1537 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1538 BlockData
->Scope
= IfrOpHdr
->Scope
;
1539 InitializeListHead (&BlockData
->DefaultValueEntry
);
1541 // Add Block Data into VarStorageData BlockEntry
1543 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1544 *ReturnData
= BlockData
;
1550 This function parses Form Package to get the block array and the default
1551 value array according to the request ConfigHdr.
1553 @param HiiHandle Hii Handle for this hii package.
1554 @param Package Pointer to the form package data.
1555 @param PackageLength Length of the pacakge.
1556 @param ConfigHdr Request string ConfigHdr. If it is NULL,
1557 the first found varstore will be as ConfigHdr.
1558 @param RequestBlockArray The block array is retrieved from the request string.
1559 @param VarStorageData VarStorage structure contains the got block and default value.
1560 @param DefaultIdArray Point to the got default id and default name array.
1562 @retval EFI_SUCCESS The block array and the default value array are got.
1563 @retval EFI_INVALID_PARAMETER The varstore defintion in the differnt form pacakges
1565 @retval EFI_OUT_OF_RESOURCES No enough memory.
1570 IN EFI_HII_HANDLE HiiHandle
,
1572 IN UINT32 PackageLength
,
1573 IN EFI_STRING ConfigHdr
,
1574 IN IFR_BLOCK_DATA
*RequestBlockArray
,
1575 IN OUT IFR_VARSTORAGE_DATA
*VarStorageData
,
1576 OUT IFR_DEFAULT_DATA
*DefaultIdArray
1581 UINTN PackageOffset
;
1582 EFI_IFR_VARSTORE
*IfrVarStore
;
1583 EFI_IFR_VARSTORE_EFI
*IfrEfiVarStore
;
1584 EFI_IFR_OP_HEADER
*IfrOpHdr
;
1585 EFI_IFR_ONE_OF
*IfrOneOf
;
1586 EFI_IFR_REF4
*IfrRef
;
1587 EFI_IFR_ONE_OF_OPTION
*IfrOneOfOption
;
1588 EFI_IFR_DEFAULT
*IfrDefault
;
1589 EFI_IFR_ORDERED_LIST
*IfrOrderedList
;
1590 EFI_IFR_CHECKBOX
*IfrCheckBox
;
1591 EFI_IFR_PASSWORD
*IfrPassword
;
1592 EFI_IFR_STRING
*IfrString
;
1593 EFI_IFR_DATE
*IfrDate
;
1594 EFI_IFR_TIME
*IfrTime
;
1595 IFR_DEFAULT_DATA DefaultData
;
1596 IFR_DEFAULT_DATA
*DefaultDataPtr
;
1597 IFR_BLOCK_DATA
*BlockData
;
1598 CHAR16
*VarStoreName
;
1600 UINT16 VarDefaultId
;
1601 BOOLEAN FirstOneOfOption
;
1602 BOOLEAN FirstOrderedList
;
1603 LIST_ENTRY
*LinkData
;
1604 LIST_ENTRY
*LinkDefault
;
1605 EFI_IFR_VARSTORE_NAME_VALUE
*IfrNameValueVarStore
;
1606 EFI_HII_PACKAGE_HEADER
*PackageHeader
;
1607 EFI_VARSTORE_ID VarStoreId
;
1609 Status
= EFI_SUCCESS
;
1611 DefaultDataPtr
= NULL
;
1612 FirstOneOfOption
= FALSE
;
1614 FirstOrderedList
= FALSE
;
1615 ZeroMem (&DefaultData
, sizeof (IFR_DEFAULT_DATA
));
1618 // Go through the form package to parse OpCode one by one.
1620 PackageOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1621 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) Package
;
1622 IfrOffset
= PackageOffset
;
1623 while (IfrOffset
< PackageLength
) {
1626 // More than one form package found.
1628 if (PackageOffset
>= PackageHeader
->Length
) {
1630 // Already found varstore for this request, break;
1632 if (VarStoreId
!= 0) {
1637 // Get next package header info.
1639 IfrOffset
+= sizeof (EFI_HII_PACKAGE_HEADER
);
1640 PackageOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
1641 PackageHeader
= (EFI_HII_PACKAGE_HEADER
*) (Package
+ IfrOffset
);
1644 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) (Package
+ IfrOffset
);
1645 switch (IfrOpHdr
->OpCode
) {
1646 case EFI_IFR_VARSTORE_OP
:
1648 // VarStore is found. Don't need to search any more.
1650 if (VarStoreId
!= 0) {
1654 IfrVarStore
= (EFI_IFR_VARSTORE
*) IfrOpHdr
;
1656 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrVarStore
->Name
) * sizeof (CHAR16
));
1657 if (VarStoreName
== NULL
) {
1658 Status
= EFI_OUT_OF_RESOURCES
;
1661 AsciiStrToUnicodeStr ((CHAR8
*)IfrVarStore
->Name
, VarStoreName
);
1663 if (IsThisVarstore((VOID
*)&IfrVarStore
->Guid
, VarStoreName
, ConfigHdr
)) {
1665 // Find the matched VarStore
1667 CopyGuid (&VarStorageData
->Guid
, (EFI_GUID
*) (VOID
*) &IfrVarStore
->Guid
);
1668 VarStorageData
->Size
= IfrVarStore
->Size
;
1669 VarStorageData
->Name
= VarStoreName
;
1670 VarStorageData
->Type
= EFI_HII_VARSTORE_BUFFER
;
1671 VarStoreId
= IfrVarStore
->VarStoreId
;
1675 case EFI_IFR_VARSTORE_EFI_OP
:
1677 // VarStore is found. Don't need to search any more.
1679 if (VarStoreId
!= 0) {
1683 IfrEfiVarStore
= (EFI_IFR_VARSTORE_EFI
*) IfrOpHdr
;
1686 // If the length is small than the structure, this is from old efi
1687 // varstore definition. Old efi varstore get config directly from
1688 // GetVariable function.
1690 if (IfrOpHdr
->Length
< sizeof (EFI_IFR_VARSTORE_EFI
)) {
1694 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrEfiVarStore
->Name
) * sizeof (CHAR16
));
1695 if (VarStoreName
== NULL
) {
1696 Status
= EFI_OUT_OF_RESOURCES
;
1699 AsciiStrToUnicodeStr ((CHAR8
*)IfrEfiVarStore
->Name
, VarStoreName
);
1701 if (IsThisVarstore (&IfrEfiVarStore
->Guid
, VarStoreName
, ConfigHdr
)) {
1703 // Find the matched VarStore
1705 CopyGuid (&VarStorageData
->Guid
, (EFI_GUID
*) (VOID
*) &IfrEfiVarStore
->Guid
);
1706 VarStorageData
->Size
= IfrEfiVarStore
->Size
;
1707 VarStorageData
->Name
= VarStoreName
;
1708 VarStorageData
->Type
= EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
;
1709 VarStoreId
= IfrEfiVarStore
->VarStoreId
;
1713 case EFI_IFR_VARSTORE_NAME_VALUE_OP
:
1715 // VarStore is found. Don't need to search any more.
1717 if (VarStoreId
!= 0) {
1721 IfrNameValueVarStore
= (EFI_IFR_VARSTORE_NAME_VALUE
*) IfrOpHdr
;
1723 if (IsThisVarstore (&IfrNameValueVarStore
->Guid
, NULL
, ConfigHdr
)) {
1725 // Find the matched VarStore
1727 CopyGuid (&VarStorageData
->Guid
, (EFI_GUID
*) (VOID
*) &IfrNameValueVarStore
->Guid
);
1728 VarStorageData
->Type
= EFI_HII_VARSTORE_NAME_VALUE
;
1729 VarStoreId
= IfrNameValueVarStore
->VarStoreId
;
1733 case EFI_IFR_DEFAULTSTORE_OP
:
1735 // Add new the map between default id and default name.
1737 DefaultDataPtr
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1738 if (DefaultDataPtr
== NULL
) {
1739 Status
= EFI_OUT_OF_RESOURCES
;
1742 DefaultDataPtr
->DefaultId
= ((EFI_IFR_DEFAULTSTORE
*) IfrOpHdr
)->DefaultId
;
1743 InsertTailList (&DefaultIdArray
->Entry
, &DefaultDataPtr
->Entry
);
1744 DefaultDataPtr
= NULL
;
1747 case EFI_IFR_FORM_OP
:
1748 case EFI_IFR_FORM_MAP_OP
:
1750 // No matched varstore is found and directly return.
1752 if ( VarStoreId
== 0) {
1753 Status
= EFI_SUCCESS
;
1758 case EFI_IFR_REF_OP
:
1760 // Ref question is not in IFR Form. This IFR form is not valid.
1762 if ( VarStoreId
== 0) {
1763 Status
= EFI_INVALID_PARAMETER
;
1767 // Check whether this question is for the requested varstore.
1769 IfrRef
= (EFI_IFR_REF4
*) IfrOpHdr
;
1770 if (IfrRef
->Question
.VarStoreId
!= VarStoreId
) {
1773 VarWidth
= (UINT16
) (sizeof (EFI_HII_REF
));
1775 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
1776 if (EFI_ERROR (Status
)) {
1781 case EFI_IFR_ONE_OF_OP
:
1782 case EFI_IFR_NUMERIC_OP
:
1784 // Numeric and OneOf has the same opcode structure.
1788 // Numeric and OneOf question is not in IFR Form. This IFR form is not valid.
1790 if (VarStoreId
== 0) {
1791 Status
= EFI_INVALID_PARAMETER
;
1795 // Check whether this question is for the requested varstore.
1797 IfrOneOf
= (EFI_IFR_ONE_OF
*) IfrOpHdr
;
1798 if (IfrOneOf
->Question
.VarStoreId
!= VarStoreId
) {
1801 VarWidth
= (UINT16
) (1 << (IfrOneOf
->Flags
& EFI_IFR_NUMERIC_SIZE
));
1803 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
1804 if (EFI_ERROR (Status
)) {
1808 if (BlockData
== NULL
) {
1810 // BlockData == NULL means this opcode is not in the requst array.
1815 if (IfrOpHdr
->OpCode
== EFI_IFR_ONE_OF_OP
) {
1817 // Set this flag to TRUE for the first oneof option.
1819 FirstOneOfOption
= TRUE
;
1820 } else if (IfrOpHdr
->OpCode
== EFI_IFR_NUMERIC_OP
) {
1822 // Numeric minimum value will be used as default value when no default is specified.
1824 DefaultData
.Type
= DefaultValueFromDefault
;
1825 switch (IfrOneOf
->Flags
& EFI_IFR_NUMERIC_SIZE
) {
1826 case EFI_IFR_NUMERIC_SIZE_1
:
1827 DefaultData
.Value
.u8
= IfrOneOf
->data
.u8
.MinValue
;
1830 case EFI_IFR_NUMERIC_SIZE_2
:
1831 CopyMem (&DefaultData
.Value
.u16
, &IfrOneOf
->data
.u16
.MinValue
, sizeof (UINT16
));
1834 case EFI_IFR_NUMERIC_SIZE_4
:
1835 CopyMem (&DefaultData
.Value
.u32
, &IfrOneOf
->data
.u32
.MinValue
, sizeof (UINT32
));
1838 case EFI_IFR_NUMERIC_SIZE_8
:
1839 CopyMem (&DefaultData
.Value
.u64
, &IfrOneOf
->data
.u64
.MinValue
, sizeof (UINT64
));
1843 Status
= EFI_INVALID_PARAMETER
;
1847 // Set default value base on the DefaultId list get from IFR data.
1849 for (LinkData
= DefaultIdArray
->Entry
.ForwardLink
; LinkData
!= &DefaultIdArray
->Entry
; LinkData
= LinkData
->ForwardLink
) {
1850 DefaultDataPtr
= BASE_CR (LinkData
, IFR_DEFAULT_DATA
, Entry
);
1851 DefaultData
.DefaultId
= DefaultDataPtr
->DefaultId
;
1852 InsertDefaultValue (BlockData
, &DefaultData
);
1857 case EFI_IFR_ORDERED_LIST_OP
:
1859 // offset by question header
1860 // width by EFI_IFR_ORDERED_LIST MaxContainers * OneofOption Type
1863 FirstOrderedList
= TRUE
;
1865 // OrderedList question is not in IFR Form. This IFR form is not valid.
1867 if (VarStoreId
== 0) {
1868 Status
= EFI_INVALID_PARAMETER
;
1872 // Check whether this question is for the requested varstore.
1874 IfrOrderedList
= (EFI_IFR_ORDERED_LIST
*) IfrOpHdr
;
1875 if (IfrOrderedList
->Question
.VarStoreId
!= VarStoreId
) {
1879 VarWidth
= IfrOrderedList
->MaxContainers
;
1880 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
1881 if (EFI_ERROR (Status
)) {
1886 case EFI_IFR_CHECKBOX_OP
:
1888 // EFI_IFR_DEFAULT_OP
1889 // offset by question header
1890 // width is 1 sizeof (BOOLEAN)
1891 // default id by CheckBox Flags if CheckBox flags (Default or Mau) is set, the default value is 1 to be set.
1892 // value by DefaultOption
1893 // default id by DeaultOption DefaultId can override CheckBox Flags and Default value.
1897 // CheckBox question is not in IFR Form. This IFR form is not valid.
1899 if (VarStoreId
== 0) {
1900 Status
= EFI_INVALID_PARAMETER
;
1904 // Check whether this question is for the requested varstore.
1906 IfrCheckBox
= (EFI_IFR_CHECKBOX
*) IfrOpHdr
;
1907 if (IfrCheckBox
->Question
.VarStoreId
!= VarStoreId
) {
1910 VarWidth
= (UINT16
) sizeof (BOOLEAN
);
1911 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
1912 if (EFI_ERROR (Status
)) {
1916 if (BlockData
== NULL
) {
1918 // BlockData == NULL means this opcode is not in the requst array.
1924 // Add default value for standard ID by CheckBox Flag
1926 VarDefaultId
= EFI_HII_DEFAULT_CLASS_STANDARD
;
1928 // Prepare new DefaultValue
1930 DefaultData
.DefaultId
= VarDefaultId
;
1931 if ((IfrCheckBox
->Flags
& EFI_IFR_CHECKBOX_DEFAULT
) == EFI_IFR_CHECKBOX_DEFAULT
) {
1933 // When flag is set, defautl value is TRUE.
1935 DefaultData
.Type
= DefaultValueFromFlag
;
1936 DefaultData
.Value
.b
= TRUE
;
1939 // When flag is not set, defautl value is FASLE.
1941 DefaultData
.Type
= DefaultValueFromDefault
;
1942 DefaultData
.Value
.b
= FALSE
;
1945 // Add DefaultValue into current BlockData
1947 InsertDefaultValue (BlockData
, &DefaultData
);
1950 // Add default value for Manufacture ID by CheckBox Flag
1952 VarDefaultId
= EFI_HII_DEFAULT_CLASS_MANUFACTURING
;
1954 // Prepare new DefaultValue
1956 DefaultData
.DefaultId
= VarDefaultId
;
1957 if ((IfrCheckBox
->Flags
& EFI_IFR_CHECKBOX_DEFAULT_MFG
) == EFI_IFR_CHECKBOX_DEFAULT_MFG
) {
1959 // When flag is set, defautl value is TRUE.
1961 DefaultData
.Type
= DefaultValueFromFlag
;
1962 DefaultData
.Value
.b
= TRUE
;
1965 // When flag is not set, defautl value is FASLE.
1967 DefaultData
.Type
= DefaultValueFromDefault
;
1968 DefaultData
.Value
.b
= FALSE
;
1971 // Add DefaultValue into current BlockData
1973 InsertDefaultValue (BlockData
, &DefaultData
);
1976 case EFI_IFR_DATE_OP
:
1978 // offset by question header
1979 // width MaxSize * sizeof (CHAR16)
1980 // no default value, only block array
1984 // Date question is not in IFR Form. This IFR form is not valid.
1986 if (VarStoreId
== 0) {
1987 Status
= EFI_INVALID_PARAMETER
;
1991 // Check whether this question is for the requested varstore.
1993 IfrDate
= (EFI_IFR_DATE
*) IfrOpHdr
;
1994 if (IfrDate
->Question
.VarStoreId
!= VarStoreId
) {
1998 VarWidth
= (UINT16
) sizeof (EFI_HII_DATE
);
1999 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
2000 if (EFI_ERROR (Status
)) {
2005 case EFI_IFR_TIME_OP
:
2007 // offset by question header
2008 // width MaxSize * sizeof (CHAR16)
2009 // no default value, only block array
2013 // Time question is not in IFR Form. This IFR form is not valid.
2015 if (VarStoreId
== 0) {
2016 Status
= EFI_INVALID_PARAMETER
;
2020 // Check whether this question is for the requested varstore.
2022 IfrTime
= (EFI_IFR_TIME
*) IfrOpHdr
;
2023 if (IfrTime
->Question
.VarStoreId
!= VarStoreId
) {
2027 VarWidth
= (UINT16
) sizeof (EFI_HII_TIME
);
2028 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
2029 if (EFI_ERROR (Status
)) {
2034 case EFI_IFR_STRING_OP
:
2036 // offset by question header
2037 // width MaxSize * sizeof (CHAR16)
2038 // no default value, only block array
2042 // String question is not in IFR Form. This IFR form is not valid.
2044 if (VarStoreId
== 0) {
2045 Status
= EFI_INVALID_PARAMETER
;
2049 // Check whether this question is for the requested varstore.
2051 IfrString
= (EFI_IFR_STRING
*) IfrOpHdr
;
2052 if (IfrString
->Question
.VarStoreId
!= VarStoreId
) {
2056 VarWidth
= (UINT16
) (IfrString
->MaxSize
* sizeof (UINT16
));
2057 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
2058 if (EFI_ERROR (Status
)) {
2063 case EFI_IFR_PASSWORD_OP
:
2065 // offset by question header
2066 // width MaxSize * sizeof (CHAR16)
2067 // no default value, only block array
2071 // Password question is not in IFR Form. This IFR form is not valid.
2073 if (VarStoreId
== 0) {
2074 Status
= EFI_INVALID_PARAMETER
;
2078 // Check whether this question is for the requested varstore.
2080 IfrPassword
= (EFI_IFR_PASSWORD
*) IfrOpHdr
;
2081 if (IfrPassword
->Question
.VarStoreId
!= VarStoreId
) {
2085 VarWidth
= (UINT16
) (IfrPassword
->MaxSize
* sizeof (UINT16
));
2086 Status
= IsThisOpcodeRequired(RequestBlockArray
, HiiHandle
, VarStorageData
, IfrOpHdr
, VarWidth
, &BlockData
);
2087 if (EFI_ERROR (Status
)) {
2092 // No default value for string.
2097 case EFI_IFR_ONE_OF_OPTION_OP
:
2099 // No matched block data is ignored.
2101 if (BlockData
== NULL
|| BlockData
->Scope
== 0) {
2105 IfrOneOfOption
= (EFI_IFR_ONE_OF_OPTION
*) IfrOpHdr
;
2106 if (BlockData
->OpCode
== EFI_IFR_ORDERED_LIST_OP
) {
2108 if (!FirstOrderedList
){
2112 // Get ordered list option data type.
2114 if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_8
|| IfrOneOfOption
->Type
== EFI_IFR_TYPE_BOOLEAN
) {
2116 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_16
) {
2118 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_32
) {
2120 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_64
) {
2124 // Invalid ordered list option data type.
2126 Status
= EFI_INVALID_PARAMETER
;
2127 if (BlockData
->Name
!= NULL
) {
2128 FreePool (BlockData
->Name
);
2130 FreePool (BlockData
);
2135 // Calculate Ordered list QuestionId width.
2137 BlockData
->Width
= (UINT16
) (BlockData
->Width
* VarWidth
);
2139 // Check whether this question is in requested block array.
2141 if (!BlockArrayCheck (RequestBlockArray
, BlockData
->Offset
, BlockData
->Width
, (BOOLEAN
)(BlockData
->Name
!= NULL
), HiiHandle
)) {
2143 // This question is not in the requested string. Skip it.
2145 if (BlockData
->Name
!= NULL
) {
2146 FreePool (BlockData
->Name
);
2148 FreePool (BlockData
);
2153 // Check this var question is in the var storage
2155 if ((BlockData
->Name
== NULL
) && ((BlockData
->Offset
+ BlockData
->Width
) > VarStorageData
->Size
)) {
2156 Status
= EFI_INVALID_PARAMETER
;
2157 if (BlockData
->Name
!= NULL
) {
2158 FreePool (BlockData
->Name
);
2160 FreePool (BlockData
);
2164 // Add Block Data into VarStorageData BlockEntry
2166 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
2168 FirstOrderedList
= FALSE
;
2174 // 1. Set default value for OneOf option when flag field has default attribute.
2176 if (((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT
) == EFI_IFR_OPTION_DEFAULT
) ||
2177 ((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) == EFI_IFR_OPTION_DEFAULT_MFG
)) {
2179 // This flag is used to specify whether this option is the first. Set it to FALSE for the following options.
2180 // The first oneof option value will be used as default value when no default value is specified.
2182 FirstOneOfOption
= FALSE
;
2184 // Prepare new DefaultValue
2186 DefaultData
.Type
= DefaultValueFromFlag
;
2187 CopyMem (&DefaultData
.Value
, &IfrOneOfOption
->Value
, IfrOneOfOption
->Header
.Length
- OFFSET_OF (EFI_IFR_ONE_OF_OPTION
, Value
));
2188 if ((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT
) == EFI_IFR_OPTION_DEFAULT
) {
2189 DefaultData
.DefaultId
= EFI_HII_DEFAULT_CLASS_STANDARD
;
2190 InsertDefaultValue (BlockData
, &DefaultData
);
2192 if ((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) == EFI_IFR_OPTION_DEFAULT_MFG
) {
2193 DefaultData
.DefaultId
= EFI_HII_DEFAULT_CLASS_MANUFACTURING
;
2194 InsertDefaultValue (BlockData
, &DefaultData
);
2199 // 2. Set as the default value when this is the first option.
2200 // The first oneof option value will be used as default value when no default value is specified.
2202 if (FirstOneOfOption
) {
2203 // This flag is used to specify whether this option is the first. Set it to FALSE for the following options.
2204 FirstOneOfOption
= FALSE
;
2207 // Prepare new DefaultValue
2209 DefaultData
.Type
= DefaultValueFromDefault
;
2210 CopyMem (&DefaultData
.Value
, &IfrOneOfOption
->Value
, IfrOneOfOption
->Header
.Length
- OFFSET_OF (EFI_IFR_ONE_OF_OPTION
, Value
));
2211 for (LinkData
= DefaultIdArray
->Entry
.ForwardLink
; LinkData
!= &DefaultIdArray
->Entry
; LinkData
= LinkData
->ForwardLink
) {
2212 DefaultDataPtr
= BASE_CR (LinkData
, IFR_DEFAULT_DATA
, Entry
);
2213 DefaultData
.DefaultId
= DefaultDataPtr
->DefaultId
;
2214 InsertDefaultValue (BlockData
, &DefaultData
);
2219 case EFI_IFR_DEFAULT_OP
:
2221 // Update Current BlockData to the default value.
2223 if (BlockData
== NULL
|| BlockData
->Scope
== 0) {
2225 // No matched block data is ignored.
2231 // Get the DefaultId
2233 IfrDefault
= (EFI_IFR_DEFAULT
*) IfrOpHdr
;
2234 VarDefaultId
= IfrDefault
->DefaultId
;
2236 // Prepare new DefaultValue
2238 DefaultData
.Type
= DefaultValueFromOpcode
;
2239 DefaultData
.DefaultId
= VarDefaultId
;
2240 CopyMem (&DefaultData
.Value
, &IfrDefault
->Value
, IfrDefault
->Header
.Length
- OFFSET_OF (EFI_IFR_DEFAULT
, Value
));
2242 // If the value field is expression, set the cleaned flag.
2243 if (IfrDefault
->Type
== EFI_IFR_TYPE_OTHER
) {
2244 DefaultData
.Cleaned
= TRUE
;
2247 // Add DefaultValue into current BlockData
2249 InsertDefaultValue (BlockData
, &DefaultData
);
2252 // After insert the default value, reset the cleaned value for next
2253 // time used. If not set here, need to set the value before everytime
2256 DefaultData
.Cleaned
= FALSE
;
2259 case EFI_IFR_END_OP
:
2261 // End Opcode is for Var question.
2263 if (BlockData
!= NULL
) {
2264 if (BlockData
->Scope
> 0) {
2267 if (BlockData
->Scope
== 0) {
2275 if (BlockData
!= NULL
) {
2276 if (BlockData
->Scope
> 0) {
2277 BlockData
->Scope
= (UINT8
) (BlockData
->Scope
+ IfrOpHdr
->Scope
);
2280 if (BlockData
->Scope
== 0) {
2287 IfrOffset
+= IfrOpHdr
->Length
;
2288 PackageOffset
+= IfrOpHdr
->Length
;
2292 for (LinkData
= VarStorageData
->BlockEntry
.ForwardLink
; LinkData
!= &VarStorageData
->BlockEntry
; LinkData
= LinkData
->ForwardLink
) {
2293 BlockData
= BASE_CR (LinkData
, IFR_BLOCK_DATA
, Entry
);
2294 for (LinkDefault
= BlockData
->DefaultValueEntry
.ForwardLink
; LinkDefault
!= &BlockData
->DefaultValueEntry
; ) {
2295 DefaultDataPtr
= BASE_CR (LinkDefault
, IFR_DEFAULT_DATA
, Entry
);
2296 LinkDefault
= LinkDefault
->ForwardLink
;
2297 if (DefaultDataPtr
->Cleaned
== TRUE
) {
2298 RemoveEntryList (&DefaultDataPtr
->Entry
);
2299 FreePool (DefaultDataPtr
);
2308 parse the configrequest string, get the elements.
2310 @param ConfigRequest The input configrequest string.
2311 @param Progress Return the progress data.
2313 @retval Block data pointer.
2317 IN EFI_STRING ConfigRequest
,
2318 OUT EFI_STRING
*Progress
2321 EFI_STRING StringPtr
;
2322 IFR_BLOCK_DATA
*BlockData
;
2323 IFR_BLOCK_DATA
*RequestBlockArray
;
2329 IFR_BLOCK_DATA
*NextBlockData
;
2335 // Init RequestBlockArray
2337 RequestBlockArray
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
2338 if (RequestBlockArray
== NULL
) {
2341 InitializeListHead (&RequestBlockArray
->Entry
);
2344 // Get the request Block array from the request string
2349 // Parse each <RequestElement> if exists
2350 // Only <BlockName> format is supported by this help function.
2351 // <BlockName> ::= &'OFFSET='<Number>&'WIDTH='<Number>
2353 StringPtr
= ConfigRequest
;
2354 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) == 0) {
2356 // Skip the OFFSET string
2358 *Progress
= StringPtr
;
2359 StringPtr
+= StrLen (L
"&OFFSET=");
2363 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
2364 if (EFI_ERROR (Status
)) {
2371 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
2373 FreePool (TmpBuffer
);
2375 StringPtr
+= Length
;
2376 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
2379 StringPtr
+= StrLen (L
"&WIDTH=");
2384 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
2385 if (EFI_ERROR (Status
)) {
2392 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
2394 FreePool (TmpBuffer
);
2396 StringPtr
+= Length
;
2397 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
2404 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
2405 if (BlockData
== NULL
) {
2408 BlockData
->Offset
= Offset
;
2409 BlockData
->Width
= Width
;
2410 InsertBlockData (&RequestBlockArray
->Entry
, &BlockData
);
2413 // Skip &VALUE string if &VALUE does exists.
2415 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) == 0) {
2416 StringPtr
+= StrLen (L
"&VALUE=");
2421 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
2422 if (EFI_ERROR (Status
)) {
2426 StringPtr
+= Length
;
2427 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
2432 // If '\0', parsing is finished.
2434 if (*StringPtr
== 0) {
2440 // Merge the requested block data.
2442 Link
= RequestBlockArray
->Entry
.ForwardLink
;
2443 while ((Link
!= &RequestBlockArray
->Entry
) && (Link
->ForwardLink
!= &RequestBlockArray
->Entry
)) {
2444 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
2445 NextBlockData
= BASE_CR (Link
->ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2446 if ((NextBlockData
->Offset
>= BlockData
->Offset
) && (NextBlockData
->Offset
<= (BlockData
->Offset
+ BlockData
->Width
))) {
2447 if ((NextBlockData
->Offset
+ NextBlockData
->Width
) > (BlockData
->Offset
+ BlockData
->Width
)) {
2448 BlockData
->Width
= (UINT16
) (NextBlockData
->Offset
+ NextBlockData
->Width
- BlockData
->Offset
);
2450 RemoveEntryList (Link
->ForwardLink
);
2451 FreePool (NextBlockData
);
2454 Link
= Link
->ForwardLink
;
2457 return RequestBlockArray
;
2460 if (RequestBlockArray
!= NULL
) {
2462 // Free Link Array RequestBlockArray
2464 while (!IsListEmpty (&RequestBlockArray
->Entry
)) {
2465 BlockData
= BASE_CR (RequestBlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2466 RemoveEntryList (&BlockData
->Entry
);
2467 FreePool (BlockData
);
2470 FreePool (RequestBlockArray
);
2477 parse the configrequest string, get the elements.
2479 @param ConfigRequest The input config request string.
2480 @param Progress Return the progress data.
2482 @retval return data block array.
2486 IN EFI_STRING ConfigRequest
,
2487 OUT EFI_STRING
*Progress
2490 EFI_STRING StringPtr
;
2492 IFR_BLOCK_DATA
*BlockData
;
2493 IFR_BLOCK_DATA
*RequestBlockArray
;
2496 StringPtr
= ConfigRequest
;
2499 // Init RequestBlockArray
2501 RequestBlockArray
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
2502 if (RequestBlockArray
== NULL
) {
2505 InitializeListHead (&RequestBlockArray
->Entry
);
2508 // Get the request Block array from the request string
2512 // Parse each <RequestElement> if exists
2513 // Only <BlockName> format is supported by this help function.
2514 // <BlockName> ::= &'Name***=***
2516 while (StringPtr
!= NULL
&& *StringPtr
== L
'&') {
2518 *Progress
= StringPtr
;
2520 // Skip the L"&" string
2525 if ((NextTag
= StrStr (StringPtr
, L
"=")) != NULL
) {
2528 } else if ((NextTag
= StrStr (StringPtr
, L
"&")) != NULL
) {
2535 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
2536 if (BlockData
== NULL
) {
2543 BlockData
->Name
= AllocateCopyPool(StrSize (StringPtr
), StringPtr
);
2544 InsertBlockData (&RequestBlockArray
->Entry
, &BlockData
);
2548 // If has value, skip the value.
2550 StringPtr
= NextTag
+ 1;
2552 StringPtr
= StrStr (StringPtr
, L
"&");
2553 } else if (NextTag
!= NULL
) {
2555 // restore the '&' text.
2557 StringPtr
= NextTag
;
2562 return RequestBlockArray
;
2565 if (RequestBlockArray
!= NULL
) {
2567 // Free Link Array RequestBlockArray
2569 while (!IsListEmpty (&RequestBlockArray
->Entry
)) {
2570 BlockData
= BASE_CR (RequestBlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2571 RemoveEntryList (&BlockData
->Entry
);
2572 if (BlockData
->Name
!= NULL
) {
2573 FreePool (BlockData
->Name
);
2575 FreePool (BlockData
);
2578 FreePool (RequestBlockArray
);
2585 Generate ConfigRequest string base on the varstore info.
2587 @param ConfigHdr The config header for this varstore.
2588 @param VarStorageData The varstore info.
2589 @param Status Return Status.
2590 @param ConfigRequest The ConfigRequest info may be return.
2592 @retval TRUE Need to continue
2593 @retval Others NO need to continue or error occur.
2596 GenerateConfigRequest (
2597 IN CHAR16
*ConfigHdr
,
2598 IN IFR_VARSTORAGE_DATA
*VarStorageData
,
2599 OUT EFI_STATUS
*Status
,
2600 IN OUT EFI_STRING
*ConfigRequest
2606 CHAR16
*FullConfigRequest
;
2608 IFR_BLOCK_DATA
*BlockData
;
2611 // Append VarStorageData BlockEntry into *Request string
2612 // Now support only one varstore in a form package.
2616 // Go through all VarStorageData Entry and get BlockEntry for each one for the multiple varstore in a single form package
2617 // Then construct them all to return MultiRequest string : ConfigHdr BlockConfig
2621 // Compute the length of the entire request starting with <ConfigHdr> and a
2625 Length
= StrLen (ConfigHdr
) + 1;
2627 for (Link
= VarStorageData
->BlockEntry
.ForwardLink
; Link
!= &VarStorageData
->BlockEntry
; Link
= Link
->ForwardLink
) {
2629 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
2630 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
2632 // Add <BlockName> length for each Name
2634 // <BlockName> ::= &Name1&Name2&...
2635 // |1| StrLen(Name1)
2637 Length
= Length
+ (1 + StrLen (BlockData
->Name
));
2640 // Add <BlockName> length for each Offset/Width pair
2642 // <BlockName> ::= &OFFSET=1234&WIDTH=1234
2643 // | 8 | 4 | 7 | 4 |
2645 Length
= Length
+ (8 + 4 + 7 + 4);
2649 // No any request block data is found. The request string can't be constructed.
2652 *Status
= EFI_SUCCESS
;
2657 // Allocate buffer for the entire <ConfigRequest>
2659 FullConfigRequest
= AllocateZeroPool (Length
* sizeof (CHAR16
));
2660 if (FullConfigRequest
== NULL
) {
2661 *Status
= EFI_OUT_OF_RESOURCES
;
2664 StringPtr
= FullConfigRequest
;
2667 // Start with <ConfigHdr>
2669 StrCpyS (StringPtr
, Length
, ConfigHdr
);
2670 StringPtr
+= StrLen (StringPtr
);
2673 // Loop through all the Offset/Width pairs and append them to ConfigRequest
2675 for (Link
= VarStorageData
->BlockEntry
.ForwardLink
; Link
!= &VarStorageData
->BlockEntry
; Link
= Link
->ForwardLink
) {
2676 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
2677 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
2683 (1 + StrLen (BlockData
->Name
) + 1) * sizeof (CHAR16
),
2689 // Append &OFFSET=XXXX&WIDTH=YYYY\0
2693 (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
2694 L
"&OFFSET=%04X&WIDTH=%04X",
2699 StringPtr
+= StrLen (StringPtr
);
2702 // Set to the got full request string.
2704 HiiToLower (FullConfigRequest
);
2706 if (*ConfigRequest
!= NULL
) {
2707 FreePool (*ConfigRequest
);
2709 *ConfigRequest
= FullConfigRequest
;
2715 Generate ConfigRequest Header base on the varstore info.
2717 @param VarStorageData The varstore info.
2718 @param DevicePath Device path for this varstore.
2719 @param ConfigHdr The config header for this varstore.
2721 @retval EFI_SUCCESS Generate the header success.
2722 @retval EFI_OUT_OF_RESOURCES Allocate buffer fail.
2726 IN IFR_VARSTORAGE_DATA
*VarStorageData
,
2727 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2728 OUT EFI_STRING
*ConfigHdr
2737 Status
= EFI_SUCCESS
;
2743 // Construct <ConfigHdr> : "GUID=...&NAME=...&PATH=..." by VarStorageData Guid, Name and DriverHandle
2745 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) &VarStorageData
->Guid
, 1, &GuidStr
);
2746 if (VarStorageData
->Name
!= NULL
) {
2747 GenerateSubStr (L
"NAME=", StrLen (VarStorageData
->Name
) * sizeof (CHAR16
), (VOID
*) VarStorageData
->Name
, 2, &NameStr
);
2749 GenerateSubStr (L
"NAME=", 0, NULL
, 2, &NameStr
);
2753 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
2754 (VOID
*) DevicePath
,
2758 Length
= StrLen (GuidStr
) + StrLen (NameStr
) + StrLen (PathStr
) + 1;
2759 if (VarStorageData
->Name
== NULL
) {
2763 *ConfigHdr
= AllocateZeroPool (Length
* sizeof (CHAR16
));
2764 if (*ConfigHdr
== NULL
) {
2765 Status
= EFI_OUT_OF_RESOURCES
;
2768 StrCpyS (*ConfigHdr
, Length
, GuidStr
);
2769 StrCatS (*ConfigHdr
, Length
, NameStr
);
2770 if (VarStorageData
->Name
== NULL
) {
2771 StrCatS (*ConfigHdr
, Length
, L
"&");
2773 StrCatS (*ConfigHdr
, Length
, PathStr
);
2776 // Remove the last character L'&'
2778 *(*ConfigHdr
+ StrLen (*ConfigHdr
) - 1) = L
'\0';
2781 if (GuidStr
!= NULL
) {
2785 if (NameStr
!= NULL
) {
2789 if (PathStr
!= NULL
) {
2797 Get Data buffer size based on data type.
2799 @param ValueType The input data type.
2801 @retval The data buffer size for the input type.
2808 UINT16 StorageWidth
;
2810 switch (ValueType
) {
2811 case EFI_IFR_NUMERIC_SIZE_1
:
2812 case EFI_IFR_TYPE_BOOLEAN
:
2813 StorageWidth
= (UINT16
) sizeof (UINT8
);
2816 case EFI_IFR_NUMERIC_SIZE_2
:
2817 StorageWidth
= (UINT16
) sizeof (UINT16
);
2820 case EFI_IFR_NUMERIC_SIZE_4
:
2821 StorageWidth
= (UINT16
) sizeof (UINT32
);
2824 case EFI_IFR_NUMERIC_SIZE_8
:
2825 StorageWidth
= (UINT16
) sizeof (UINT64
);
2828 case EFI_IFR_TYPE_TIME
:
2829 StorageWidth
= (UINT16
) sizeof (EFI_IFR_TIME
);
2832 case EFI_IFR_TYPE_DATE
:
2833 StorageWidth
= (UINT16
) sizeof (EFI_IFR_DATE
);
2841 return StorageWidth
;
2845 Generate ConfigAltResp string base on the varstore info.
2847 @param HiiHandle Hii Handle for this hii package.
2848 @param ConfigHdr The config header for this varstore.
2849 @param VarStorageData The varstore info.
2850 @param DefaultIdArray The Default id array.
2851 @param DefaultAltCfgResp The DefaultAltCfgResp info may be return.
2853 @retval TRUE Need to continue
2854 @retval Others NO need to continue or error occur.
2857 GenerateAltConfigResp (
2858 IN EFI_HII_HANDLE HiiHandle
,
2859 IN CHAR16
*ConfigHdr
,
2860 IN IFR_VARSTORAGE_DATA
*VarStorageData
,
2861 IN IFR_DEFAULT_DATA
*DefaultIdArray
,
2862 IN OUT EFI_STRING
*DefaultAltCfgResp
2868 LIST_ENTRY
*LinkData
;
2869 LIST_ENTRY
*LinkDefault
;
2870 LIST_ENTRY
*ListEntry
;
2872 IFR_BLOCK_DATA
*BlockData
;
2873 IFR_DEFAULT_DATA
*DefaultId
;
2874 IFR_DEFAULT_DATA
*DefaultValueData
;
2877 CHAR16
*DefaultString
;
2881 DefaultString
= NULL
;
2883 // Add length for <ConfigHdr> + '\0'
2885 Length
= StrLen (ConfigHdr
) + 1;
2887 for (Link
= DefaultIdArray
->Entry
.ForwardLink
; Link
!= &DefaultIdArray
->Entry
; Link
= Link
->ForwardLink
) {
2888 DefaultId
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
2890 // Add length for "&<ConfigHdr>&ALTCFG=XXXX"
2891 // |1| StrLen (ConfigHdr) | 8 | 4 |
2893 Length
+= (1 + StrLen (ConfigHdr
) + 8 + 4);
2895 for (LinkData
= VarStorageData
->BlockEntry
.ForwardLink
; LinkData
!= &VarStorageData
->BlockEntry
; LinkData
= LinkData
->ForwardLink
) {
2896 BlockData
= BASE_CR (LinkData
, IFR_BLOCK_DATA
, Entry
);
2897 ListEntry
= &BlockData
->DefaultValueEntry
;
2898 for (LinkDefault
= ListEntry
->ForwardLink
; LinkDefault
!= ListEntry
; LinkDefault
= LinkDefault
->ForwardLink
) {
2899 DefaultValueData
= BASE_CR (LinkDefault
, IFR_DEFAULT_DATA
, Entry
);
2900 if (DefaultValueData
->DefaultId
!= DefaultId
->DefaultId
) {
2903 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
2905 // Add length for "&Name1=zzzzzzzzzzzz"
2908 Length
+= (1 + StrLen (BlockData
->Name
) + 1 + BlockData
->Width
* 2);
2911 // Add length for "&OFFSET=XXXX&WIDTH=YYYY&VALUE=zzzzzzzzzzzz"
2912 // | 8 | 4 | 7 | 4 | 7 | Width * 2 |
2914 Length
+= (8 + 4 + 7 + 4 + 7 + BlockData
->Width
* 2);
2922 // No default value is found. The default string doesn't exist.
2929 // Allocate buffer for the entire <DefaultAltCfgResp>
2931 *DefaultAltCfgResp
= AllocateZeroPool (Length
* sizeof (CHAR16
));
2932 if (*DefaultAltCfgResp
== NULL
) {
2933 return EFI_OUT_OF_RESOURCES
;
2935 StringPtr
= *DefaultAltCfgResp
;
2938 // Start with <ConfigHdr>
2940 StrCpyS (StringPtr
, Length
, ConfigHdr
);
2941 StringPtr
+= StrLen (StringPtr
);
2943 for (Link
= DefaultIdArray
->Entry
.ForwardLink
; Link
!= &DefaultIdArray
->Entry
; Link
= Link
->ForwardLink
) {
2944 DefaultId
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
2946 // Add <AltConfigHdr> of the form "&<ConfigHdr>&ALTCFG=XXXX\0"
2947 // |1| StrLen (ConfigHdr) | 8 | 4 |
2951 (1 + StrLen (ConfigHdr
) + 8 + 4 + 1) * sizeof (CHAR16
),
2954 DefaultId
->DefaultId
2956 StringPtr
+= StrLen (StringPtr
);
2958 for (LinkData
= VarStorageData
->BlockEntry
.ForwardLink
; LinkData
!= &VarStorageData
->BlockEntry
; LinkData
= LinkData
->ForwardLink
) {
2959 BlockData
= BASE_CR (LinkData
, IFR_BLOCK_DATA
, Entry
);
2960 ListEntry
= &BlockData
->DefaultValueEntry
;
2961 for (LinkDefault
= ListEntry
->ForwardLink
; LinkDefault
!= ListEntry
; LinkDefault
= LinkDefault
->ForwardLink
) {
2962 DefaultValueData
= BASE_CR (LinkDefault
, IFR_DEFAULT_DATA
, Entry
);
2963 if (DefaultValueData
->DefaultId
!= DefaultId
->DefaultId
) {
2966 if (VarStorageData
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
2969 (1 + StrLen (ConfigHdr
) + 1) * sizeof (CHAR16
),
2973 StringPtr
+= StrLen (StringPtr
);
2976 // Add <BlockConfig>
2977 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
2981 (8 + 4 + 7 + 4 + 7 + 1) * sizeof (CHAR16
),
2982 L
"&OFFSET=%04X&WIDTH=%04X&VALUE=",
2986 StringPtr
+= StrLen (StringPtr
);
2988 Width
= BlockData
->Width
;
2990 // Convert Value to a hex string in "%x" format
2991 // NOTE: This is in the opposite byte that GUID and PATH use
2993 if (BlockData
->OpCode
== EFI_IFR_STRING_OP
){
2994 DefaultString
= InternalGetString(HiiHandle
, DefaultValueData
->Value
.string
);
2995 TmpBuffer
= (UINT8
*) DefaultString
;
2997 TmpBuffer
= (UINT8
*) &(DefaultValueData
->Value
);
2999 for (; Width
> 0 && (TmpBuffer
!= NULL
); Width
--) {
3000 StringPtr
+= UnicodeValueToString (StringPtr
, PREFIX_ZERO
| RADIX_HEX
, TmpBuffer
[Width
- 1], 2);
3002 if (DefaultString
!= NULL
){
3003 FreePool(DefaultString
);
3004 DefaultString
= NULL
;
3010 HiiToLower (*DefaultAltCfgResp
);
3016 This function gets the full request string and full default value string by
3017 parsing IFR data in HII form packages.
3019 When Request points to NULL string, the request string and default value string
3020 for each varstore in form package will return.
3022 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
3023 @param DevicePath Device Path which Hii Config Access Protocol is registered.
3024 @param Request Pointer to a null-terminated Unicode string in
3025 <ConfigRequest> format. When it doesn't contain
3026 any RequestElement, it will be updated to return
3027 the full RequestElement retrieved from IFR data.
3028 If it points to NULL, the request string for the first
3029 varstore in form package will be merged into a
3030 <MultiConfigRequest> format string and return.
3031 @param AltCfgResp Pointer to a null-terminated Unicode string in
3032 <ConfigAltResp> format. When the pointer is to NULL,
3033 the full default value string retrieved from IFR data
3034 will return. When the pinter is to a string, the
3035 full default value string retrieved from IFR data
3036 will be merged into the input string and return.
3037 When Request points to NULL, the default value string
3038 for each varstore in form package will be merged into
3039 a <MultiConfigAltResp> format string and return.
3040 @param PointerProgress Optional parameter, it can be be NULL.
3041 When it is not NULL, if Request is NULL, it returns NULL.
3042 On return, points to a character in the Request
3043 string. Points to the string's null terminator if
3044 request was successful. Points to the most recent
3045 & before the first failing name / value pair (or
3046 the beginning of the string if the failure is in
3047 the first name / value pair) if the request was
3049 @retval EFI_SUCCESS The Results string is set to the full request string.
3050 And AltCfgResp contains all default value string.
3051 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3052 @retval EFI_NOT_FOUND The varstore (Guid and Name) in Request string
3053 can't be found in Form package.
3054 @retval EFI_NOT_FOUND HiiPackage can't be got on the input HiiHandle.
3055 @retval EFI_INVALID_PARAMETER Request points to NULL.
3060 GetFullStringFromHiiFormPackages (
3061 IN HII_DATABASE_RECORD
*DataBaseRecord
,
3062 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
3063 IN OUT EFI_STRING
*Request
,
3064 IN OUT EFI_STRING
*AltCfgResp
,
3065 OUT EFI_STRING
*PointerProgress OPTIONAL
3069 UINT8
*HiiFormPackage
;
3071 IFR_BLOCK_DATA
*RequestBlockArray
;
3072 IFR_BLOCK_DATA
*BlockData
;
3073 IFR_DEFAULT_DATA
*DefaultValueData
;
3074 IFR_DEFAULT_DATA
*DefaultId
;
3075 IFR_DEFAULT_DATA
*DefaultIdArray
;
3076 IFR_VARSTORAGE_DATA
*VarStorageData
;
3077 EFI_STRING DefaultAltCfgResp
;
3078 EFI_STRING ConfigHdr
;
3079 EFI_STRING StringPtr
;
3080 EFI_STRING Progress
;
3082 if (DataBaseRecord
== NULL
|| DevicePath
== NULL
|| Request
== NULL
|| AltCfgResp
== NULL
) {
3083 return EFI_INVALID_PARAMETER
;
3087 // Initialize the local variables.
3089 RequestBlockArray
= NULL
;
3090 DefaultIdArray
= NULL
;
3091 VarStorageData
= NULL
;
3092 DefaultAltCfgResp
= NULL
;
3094 HiiFormPackage
= NULL
;
3096 Progress
= *Request
;
3098 Status
= GetFormPackageData (DataBaseRecord
, &HiiFormPackage
, &PackageSize
);
3099 if (EFI_ERROR (Status
)) {
3104 // 1. Get the request block array by Request String when Request string containts the block array.
3107 if (*Request
!= NULL
) {
3108 StringPtr
= *Request
;
3112 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
3113 Status
= EFI_INVALID_PARAMETER
;
3116 StringPtr
+= StrLen (L
"GUID=");
3117 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
3120 if (*StringPtr
== L
'\0') {
3121 Status
= EFI_INVALID_PARAMETER
;
3124 StringPtr
+= StrLen (L
"&NAME=");
3125 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
3128 if (*StringPtr
== L
'\0') {
3129 Status
= EFI_INVALID_PARAMETER
;
3132 StringPtr
+= StrLen (L
"&PATH=");
3133 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
3137 if (*StringPtr
== L
'\0') {
3139 // No request block is found.
3146 // If StringPtr != NULL, get the request elements.
3148 if (StringPtr
!= NULL
) {
3149 if (StrStr (StringPtr
, L
"&OFFSET=") != NULL
) {
3150 RequestBlockArray
= GetBlockElement(StringPtr
, &Progress
);
3152 RequestBlockArray
= GetNameElement(StringPtr
, &Progress
);
3155 if (RequestBlockArray
== NULL
) {
3156 Status
= EFI_INVALID_PARAMETER
;
3162 // Initialize DefaultIdArray to store the map between DeaultId and DefaultName
3164 DefaultIdArray
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
3165 if (DefaultIdArray
== NULL
) {
3166 Status
= EFI_OUT_OF_RESOURCES
;
3169 InitializeListHead (&DefaultIdArray
->Entry
);
3172 // Initialize VarStorageData to store the var store Block and Default value information.
3174 VarStorageData
= (IFR_VARSTORAGE_DATA
*) AllocateZeroPool (sizeof (IFR_VARSTORAGE_DATA
));
3175 if (VarStorageData
== NULL
) {
3176 Status
= EFI_OUT_OF_RESOURCES
;
3179 InitializeListHead (&VarStorageData
->Entry
);
3180 InitializeListHead (&VarStorageData
->BlockEntry
);
3183 // 2. Parse FormPackage to get BlockArray and DefaultId Array for the request BlockArray.
3187 // Parse the opcode in form pacakge to get the default setting.
3189 Status
= ParseIfrData (DataBaseRecord
->Handle
,
3191 (UINT32
) PackageSize
,
3196 if (EFI_ERROR (Status
)) {
3201 // No requested varstore in IFR data and directly return
3203 if (VarStorageData
->Type
== 0 && VarStorageData
->Name
== NULL
) {
3204 Status
= EFI_SUCCESS
;
3209 // 3. Construct Request Element (Block Name) for 2.1 and 2.2 case.
3211 Status
= GenerateHdr (VarStorageData
, DevicePath
, &ConfigHdr
);
3212 if (EFI_ERROR (Status
)) {
3216 if (RequestBlockArray
== NULL
) {
3217 if (!GenerateConfigRequest(ConfigHdr
, VarStorageData
, &Status
, Request
)) {
3223 // 4. Construct Default Value string in AltResp according to request element.
3224 // Go through all VarStorageData Entry and get the DefaultId array for each one
3225 // Then construct them all to : ConfigHdr AltConfigHdr ConfigBody AltConfigHdr ConfigBody
3227 Status
= GenerateAltConfigResp (DataBaseRecord
->Handle
,ConfigHdr
, VarStorageData
, DefaultIdArray
, &DefaultAltCfgResp
);
3228 if (EFI_ERROR (Status
)) {
3233 // 5. Merge string into the input AltCfgResp if the iput *AltCfgResp is not NULL.
3235 if (*AltCfgResp
!= NULL
&& DefaultAltCfgResp
!= NULL
) {
3236 Status
= MergeDefaultString (AltCfgResp
, DefaultAltCfgResp
);
3237 FreePool (DefaultAltCfgResp
);
3238 } else if (*AltCfgResp
== NULL
) {
3239 *AltCfgResp
= DefaultAltCfgResp
;
3243 if (RequestBlockArray
!= NULL
) {
3245 // Free Link Array RequestBlockArray
3247 while (!IsListEmpty (&RequestBlockArray
->Entry
)) {
3248 BlockData
= BASE_CR (RequestBlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
3249 RemoveEntryList (&BlockData
->Entry
);
3250 if (BlockData
->Name
!= NULL
) {
3251 FreePool (BlockData
->Name
);
3253 FreePool (BlockData
);
3256 FreePool (RequestBlockArray
);
3259 if (VarStorageData
!= NULL
) {
3261 // Free link array VarStorageData
3263 while (!IsListEmpty (&VarStorageData
->BlockEntry
)) {
3264 BlockData
= BASE_CR (VarStorageData
->BlockEntry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
3265 RemoveEntryList (&BlockData
->Entry
);
3266 if (BlockData
->Name
!= NULL
) {
3267 FreePool (BlockData
->Name
);
3270 // Free default value link array
3272 while (!IsListEmpty (&BlockData
->DefaultValueEntry
)) {
3273 DefaultValueData
= BASE_CR (BlockData
->DefaultValueEntry
.ForwardLink
, IFR_DEFAULT_DATA
, Entry
);
3274 RemoveEntryList (&DefaultValueData
->Entry
);
3275 FreePool (DefaultValueData
);
3277 FreePool (BlockData
);
3279 FreePool (VarStorageData
);
3282 if (DefaultIdArray
!= NULL
) {
3284 // Free DefaultId Array
3286 while (!IsListEmpty (&DefaultIdArray
->Entry
)) {
3287 DefaultId
= BASE_CR (DefaultIdArray
->Entry
.ForwardLink
, IFR_DEFAULT_DATA
, Entry
);
3288 RemoveEntryList (&DefaultId
->Entry
);
3289 FreePool (DefaultId
);
3291 FreePool (DefaultIdArray
);
3295 // Free the allocated string
3297 if (ConfigHdr
!= NULL
) {
3298 FreePool (ConfigHdr
);
3302 // Free Pacakge data
3304 if (HiiFormPackage
!= NULL
) {
3305 FreePool (HiiFormPackage
);
3308 if (PointerProgress
!= NULL
) {
3309 if (*Request
== NULL
) {
3310 *PointerProgress
= NULL
;
3311 } else if (EFI_ERROR (Status
)) {
3312 *PointerProgress
= *Request
;
3314 *PointerProgress
= *Request
+ StrLen (*Request
);
3322 This function gets the full request resp string by
3323 parsing IFR data in HII form packages.
3325 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3327 @param EfiVarStoreInfo The efi varstore info which is save in the EFI
3328 varstore data structure.
3329 @param Request Pointer to a null-terminated Unicode string in
3330 <ConfigRequest> format.
3331 @param RequestResp Pointer to a null-terminated Unicode string in
3332 <ConfigResp> format.
3333 @param AccessProgress On return, points to a character in the Request
3334 string. Points to the string's null terminator if
3335 request was successful. Points to the most recent
3336 & before the first failing name / value pair (or
3337 the beginning of the string if the failure is in
3338 the first name / value pair) if the request was
3341 @retval EFI_SUCCESS The Results string is set to the full request string.
3342 And AltCfgResp contains all default value string.
3343 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3344 @retval EFI_INVALID_PARAMETER Request points to NULL.
3348 GetConfigRespFromEfiVarStore (
3349 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
3350 IN EFI_IFR_VARSTORE_EFI
*EfiVarStoreInfo
,
3351 IN EFI_STRING Request
,
3352 OUT EFI_STRING
*RequestResp
,
3353 OUT EFI_STRING
*AccessProgress
3357 EFI_STRING VarStoreName
;
3361 Status
= EFI_SUCCESS
;
3364 VarStoreName
= NULL
;
3365 *AccessProgress
= Request
;
3367 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)EfiVarStoreInfo
->Name
) * sizeof (CHAR16
));
3368 if (VarStoreName
== NULL
) {
3369 Status
= EFI_OUT_OF_RESOURCES
;
3372 AsciiStrToUnicodeStr ((CHAR8
*) EfiVarStoreInfo
->Name
, VarStoreName
);
3375 Status
= gRT
->GetVariable (VarStoreName
, &EfiVarStoreInfo
->Guid
, NULL
, &BufferSize
, NULL
);
3376 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
3380 VarStore
= AllocateZeroPool (BufferSize
);
3381 ASSERT (VarStore
!= NULL
);
3382 Status
= gRT
->GetVariable (VarStoreName
, &EfiVarStoreInfo
->Guid
, NULL
, &BufferSize
, VarStore
);
3383 if (EFI_ERROR (Status
)) {
3387 Status
= HiiBlockToConfig(This
, Request
, VarStore
, BufferSize
, RequestResp
, AccessProgress
);
3388 if (EFI_ERROR (Status
)) {
3393 if (VarStoreName
!= NULL
) {
3394 FreePool (VarStoreName
);
3397 if (VarStore
!= NULL
) {
3398 FreePool (VarStore
);
3406 This function route the full request resp string for efi varstore.
3408 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3410 @param EfiVarStoreInfo The efi varstore info which is save in the EFI
3411 varstore data structure.
3412 @param RequestResp Pointer to a null-terminated Unicode string in
3413 <ConfigResp> format.
3414 @param Result Pointer to a null-terminated Unicode string in
3415 <ConfigResp> format.
3417 @retval EFI_SUCCESS The Results string is set to the full request string.
3418 And AltCfgResp contains all default value string.
3419 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3420 @retval EFI_INVALID_PARAMETER Request points to NULL.
3424 RouteConfigRespForEfiVarStore (
3425 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
3426 IN EFI_IFR_VARSTORE_EFI
*EfiVarStoreInfo
,
3427 IN EFI_STRING RequestResp
,
3428 OUT EFI_STRING
*Result
3432 EFI_STRING VarStoreName
;
3437 Status
= EFI_SUCCESS
;
3440 VarStoreName
= NULL
;
3442 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)EfiVarStoreInfo
->Name
) * sizeof (CHAR16
));
3443 if (VarStoreName
== NULL
) {
3444 Status
= EFI_OUT_OF_RESOURCES
;
3447 AsciiStrToUnicodeStr ((CHAR8
*) EfiVarStoreInfo
->Name
, VarStoreName
);
3449 Status
= gRT
->GetVariable (VarStoreName
, &EfiVarStoreInfo
->Guid
, NULL
, &BufferSize
, NULL
);
3450 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
3454 BlockSize
= BufferSize
;
3455 VarStore
= AllocateZeroPool (BufferSize
);
3456 ASSERT (VarStore
!= NULL
);
3457 Status
= gRT
->GetVariable (VarStoreName
, &EfiVarStoreInfo
->Guid
, NULL
, &BufferSize
, VarStore
);
3458 if (EFI_ERROR (Status
)) {
3462 Status
= HiiConfigToBlock(This
, RequestResp
, VarStore
, &BlockSize
, Result
);
3463 if (EFI_ERROR (Status
)) {
3467 Status
= gRT
->SetVariable (VarStoreName
, &EfiVarStoreInfo
->Guid
, EfiVarStoreInfo
->Attributes
, BufferSize
, VarStore
);
3468 if (EFI_ERROR (Status
)) {
3473 if (VarStoreName
!= NULL
) {
3474 FreePool (VarStoreName
);
3477 if (VarStore
!= NULL
) {
3478 FreePool (VarStore
);
3485 Validate the config request elements.
3487 @param ConfigElements A null-terminated Unicode string in <ConfigRequest> format,
3488 without configHdr field.
3490 @retval CHAR16 * THE first Name/value pair not correct.
3491 @retval NULL Success parse the name/value pair
3494 OffsetWidthValidate (
3495 CHAR16
*ConfigElements
3501 StringPtr
= ConfigElements
;
3505 if (StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) != 0) {
3509 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
3512 if (*StringPtr
== L
'\0') {
3516 StringPtr
+= StrLen (L
"&WIDTH=");
3517 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) != 0) {
3521 if (*StringPtr
== L
'\0') {
3528 Validate the config request elements.
3530 @param ConfigElements A null-terminated Unicode string in <ConfigRequest> format,
3531 without configHdr field.
3533 @retval CHAR16 * THE first Name/value pair not correct.
3534 @retval NULL Success parse the name/value pair
3539 CHAR16
*ConfigElements
3545 StringPtr
= ConfigElements
;
3549 if (*StringPtr
!= L
'&') {
3554 StringPtr
= StrStr (StringPtr
, L
"&");
3556 if (StringPtr
== NULL
) {
3563 Validate the config request string.
3565 @param ConfigRequest A null-terminated Unicode string in <ConfigRequest> format.
3567 @retval CHAR16 * THE first element not correct.
3568 @retval NULL Success parse the name/value pair
3572 ConfigRequestValidate (
3573 CHAR16
*ConfigRequest
3576 BOOLEAN HasNameField
;
3579 HasNameField
= TRUE
;
3580 StringPtr
= ConfigRequest
;
3583 // Check <ConfigHdr>
3585 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
3586 return ConfigRequest
;
3588 StringPtr
+= StrLen (L
"GUID=");
3589 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
3592 if (*StringPtr
== L
'\0') {
3593 return ConfigRequest
;
3595 StringPtr
+= StrLen (L
"&NAME=");
3596 if (*StringPtr
== L
'&') {
3597 HasNameField
= FALSE
;
3599 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
3602 if (*StringPtr
== L
'\0') {
3603 return ConfigRequest
;
3605 StringPtr
+= StrLen (L
"&PATH=");
3606 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
3610 if (*StringPtr
== L
'\0') {
3616 // Should be Buffer varstore, config request should be "OFFSET/Width" pairs.
3618 return OffsetWidthValidate(StringPtr
);
3621 // Should be Name/Value varstore, config request should be "&name1&name2..." pairs.
3623 return NameValueValidate(StringPtr
);
3628 This function allows a caller to extract the current configuration
3629 for one or more named elements from one or more drivers.
3631 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3633 @param Request A null-terminated Unicode string in
3634 <MultiConfigRequest> format.
3635 @param Progress On return, points to a character in the Request
3636 string. Points to the string's null terminator if
3637 request was successful. Points to the most recent
3638 & before the first failing name / value pair (or
3639 the beginning of the string if the failure is in
3640 the first name / value pair) if the request was
3642 @param Results Null-terminated Unicode string in
3643 <MultiConfigAltResp> format which has all values
3644 filled in for the names in the Request string.
3645 String to be allocated by the called function.
3647 @retval EFI_SUCCESS The Results string is filled with the values
3648 corresponding to all requested names.
3649 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
3650 results that must be stored awaiting possible
3652 @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
3653 Progress set to the "G" in "GUID" of the routing
3654 header that doesn't match. Note: There is no
3655 requirement that all routing data be validated
3656 before any configuration extraction.
3657 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
3658 parameter would result in this type of error. The
3659 Progress parameter is set to NULL.
3660 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
3661 before the error or the beginning of the string.
3662 @retval EFI_INVALID_PARAMETER The ExtractConfig function of the underlying HII
3663 Configuration Access Protocol returned
3664 EFI_INVALID_PARAMETER. Progress set to most recent
3665 & before the error or the beginning of the string.
3670 HiiConfigRoutingExtractConfig (
3671 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
3672 IN CONST EFI_STRING Request
,
3673 OUT EFI_STRING
*Progress
,
3674 OUT EFI_STRING
*Results
3677 HII_DATABASE_PRIVATE_DATA
*Private
;
3678 EFI_STRING StringPtr
;
3679 EFI_STRING ConfigRequest
;
3681 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
3682 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
3685 HII_DATABASE_RECORD
*Database
;
3686 UINT8
*DevicePathPkg
;
3687 UINT8
*CurrentDevicePath
;
3688 EFI_HANDLE DriverHandle
;
3689 EFI_HII_HANDLE HiiHandle
;
3690 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
3691 EFI_STRING AccessProgress
;
3692 EFI_STRING AccessResults
;
3693 EFI_STRING DefaultResults
;
3694 BOOLEAN FirstElement
;
3695 BOOLEAN IfrDataParsedFlag
;
3696 BOOLEAN IsEfiVarStore
;
3697 EFI_IFR_VARSTORE_EFI
*EfiVarStoreInfo
;
3698 EFI_STRING ErrorPtr
;
3699 UINTN DevicePathSize
;
3701 if (This
== NULL
|| Progress
== NULL
|| Results
== NULL
) {
3702 return EFI_INVALID_PARAMETER
;
3705 if (Request
== NULL
) {
3707 return EFI_INVALID_PARAMETER
;
3710 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
3711 StringPtr
= Request
;
3712 *Progress
= StringPtr
;
3713 DefaultResults
= NULL
;
3714 ConfigRequest
= NULL
;
3715 Status
= EFI_SUCCESS
;
3716 AccessResults
= NULL
;
3717 AccessProgress
= NULL
;
3719 IfrDataParsedFlag
= FALSE
;
3720 IsEfiVarStore
= FALSE
;
3721 EfiVarStoreInfo
= NULL
;
3724 // The first element of <MultiConfigRequest> should be
3725 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
3727 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
3728 return EFI_INVALID_PARAMETER
;
3731 FirstElement
= TRUE
;
3734 // Allocate a fix length of memory to store Results. Reallocate memory for
3735 // Results if this fix length is insufficient.
3737 *Results
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
3738 if (*Results
== NULL
) {
3739 return EFI_OUT_OF_RESOURCES
;
3742 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) == 0) {
3744 // If parsing error, set Progress to the beginning of the <MultiConfigRequest>
3745 // or most recent & before the error.
3747 if (StringPtr
== Request
) {
3748 *Progress
= StringPtr
;
3750 *Progress
= StringPtr
- 1;
3754 // Process each <ConfigRequest> of <MultiConfigRequest>
3756 Length
= CalculateConfigStringLen (StringPtr
);
3757 ConfigRequest
= AllocateCopyPool ((Length
+ 1) * sizeof (CHAR16
), StringPtr
);
3758 if (ConfigRequest
== NULL
) {
3759 Status
= EFI_OUT_OF_RESOURCES
;
3762 *(ConfigRequest
+ Length
) = 0;
3765 // Get the UEFI device path
3767 Status
= GetDevicePath (ConfigRequest
, (UINT8
**) &DevicePath
);
3768 if (EFI_ERROR (Status
)) {
3773 // Find driver which matches the routing data.
3775 DriverHandle
= NULL
;
3778 for (Link
= Private
->DatabaseList
.ForwardLink
;
3779 Link
!= &Private
->DatabaseList
;
3780 Link
= Link
->ForwardLink
3782 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
3783 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
3784 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
3785 DevicePathSize
= GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
);
3786 if ((CompareMem (DevicePath
,CurrentDevicePath
,DevicePathSize
) == 0) && IsThisPackageList(Database
, ConfigRequest
)) {
3787 DriverHandle
= Database
->DriverHandle
;
3788 HiiHandle
= Database
->Handle
;
3795 // Try to find driver handle by device path.
3797 if (DriverHandle
== NULL
) {
3798 TempDevicePath
= DevicePath
;
3799 Status
= gBS
->LocateDevicePath (
3800 &gEfiDevicePathProtocolGuid
,
3804 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
3806 // Routing data does not match any known driver.
3807 // Set Progress to the 'G' in "GUID" of the routing header.
3809 *Progress
= StringPtr
;
3810 Status
= EFI_NOT_FOUND
;
3816 // Validate ConfigRequest String.
3818 ErrorPtr
= ConfigRequestValidate(ConfigRequest
);
3819 if (ErrorPtr
!= NULL
) {
3820 *Progress
= StrStr (StringPtr
, ErrorPtr
);
3821 Status
= EFI_INVALID_PARAMETER
;
3826 // Check whether ConfigRequest contains request string.
3828 IfrDataParsedFlag
= FALSE
;
3829 if ((HiiHandle
!= NULL
) && !GetElementsFromRequest(ConfigRequest
)) {
3831 // Get the full request string from IFR when HiiPackage is registered to HiiHandle
3833 IfrDataParsedFlag
= TRUE
;
3834 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, &AccessProgress
);
3835 if (EFI_ERROR (Status
)) {
3837 // AccessProgress indicates the parsing progress on <ConfigRequest>.
3838 // Map it to the progress on <MultiConfigRequest> then return it.
3840 ASSERT (AccessProgress
!= NULL
);
3841 *Progress
= StrStr (StringPtr
, AccessProgress
);
3845 // Not any request block is found.
3847 if (!GetElementsFromRequest(ConfigRequest
)) {
3848 AccessResults
= AllocateCopyPool (StrSize (ConfigRequest
), ConfigRequest
);
3849 goto NextConfigString
;
3854 // Check whether this ConfigRequest is search from Efi varstore type storage.
3856 Status
= GetVarStoreType(Database
, ConfigRequest
, &IsEfiVarStore
, &EfiVarStoreInfo
);
3857 if (EFI_ERROR (Status
)) {
3861 if (IsEfiVarStore
) {
3863 // Call the GetVariable function to extract settings.
3865 Status
= GetConfigRespFromEfiVarStore(This
, EfiVarStoreInfo
, ConfigRequest
, &AccessResults
, &AccessProgress
);
3866 FreePool (EfiVarStoreInfo
);
3869 // Call corresponding ConfigAccess protocol to extract settings
3871 Status
= gBS
->HandleProtocol (
3873 &gEfiHiiConfigAccessProtocolGuid
,
3874 (VOID
**) &ConfigAccess
3876 if (EFI_ERROR (Status
)) {
3880 Status
= ConfigAccess
->ExtractConfig (
3887 if (EFI_ERROR (Status
)) {
3889 // AccessProgress indicates the parsing progress on <ConfigRequest>.
3890 // Map it to the progress on <MultiConfigRequest> then return it.
3892 *Progress
= StrStr (StringPtr
, AccessProgress
);
3897 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
3898 // which seperates the first <ConfigAltResp> and the following ones.
3900 ASSERT (*AccessProgress
== 0);
3903 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
3905 if (!IfrDataParsedFlag
&& HiiHandle
!= NULL
) {
3906 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, NULL
);
3907 ASSERT_EFI_ERROR (Status
);
3910 FreePool (DevicePath
);
3913 if (DefaultResults
!= NULL
) {
3914 Status
= MergeDefaultString (&AccessResults
, DefaultResults
);
3915 ASSERT_EFI_ERROR (Status
);
3916 FreePool (DefaultResults
);
3917 DefaultResults
= NULL
;
3921 if (!FirstElement
) {
3922 Status
= AppendToMultiString (Results
, L
"&");
3923 ASSERT_EFI_ERROR (Status
);
3926 Status
= AppendToMultiString (Results
, AccessResults
);
3927 ASSERT_EFI_ERROR (Status
);
3929 FirstElement
= FALSE
;
3931 FreePool (AccessResults
);
3932 AccessResults
= NULL
;
3933 FreePool (ConfigRequest
);
3934 ConfigRequest
= NULL
;
3937 // Go to next <ConfigRequest> (skip '&').
3939 StringPtr
+= Length
;
3940 if (*StringPtr
== 0) {
3941 *Progress
= StringPtr
;
3949 if (EFI_ERROR (Status
)) {
3950 FreePool (*Results
);
3954 if (ConfigRequest
!= NULL
) {
3955 FreePool (ConfigRequest
);
3958 if (AccessResults
!= NULL
) {
3959 FreePool (AccessResults
);
3962 if (DefaultResults
!= NULL
) {
3963 FreePool (DefaultResults
);
3966 if (DevicePath
!= NULL
) {
3967 FreePool (DevicePath
);
3975 This function allows the caller to request the current configuration for the
3976 entirety of the current HII database and returns the data in a
3977 null-terminated Unicode string.
3979 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3981 @param Results Null-terminated Unicode string in
3982 <MultiConfigAltResp> format which has all values
3983 filled in for the entirety of the current HII
3984 database. String to be allocated by the called
3985 function. De-allocation is up to the caller.
3987 @retval EFI_SUCCESS The Results string is filled with the values
3988 corresponding to all requested names.
3989 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
3990 results that must be stored awaiting possible
3992 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
3993 parameter would result in this type of error.
3998 HiiConfigRoutingExportConfig (
3999 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
4000 OUT EFI_STRING
*Results
4004 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
4005 EFI_STRING AccessResults
;
4006 EFI_STRING Progress
;
4007 EFI_STRING StringPtr
;
4008 EFI_STRING ConfigRequest
;
4010 EFI_HANDLE
*ConfigAccessHandles
;
4011 UINTN NumberConfigAccessHandles
;
4012 BOOLEAN FirstElement
;
4013 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
4014 EFI_HII_HANDLE HiiHandle
;
4015 EFI_STRING DefaultResults
;
4016 HII_DATABASE_PRIVATE_DATA
*Private
;
4018 HII_DATABASE_RECORD
*Database
;
4019 UINT8
*DevicePathPkg
;
4020 UINT8
*CurrentDevicePath
;
4021 BOOLEAN IfrDataParsedFlag
;
4023 if (This
== NULL
|| Results
== NULL
) {
4024 return EFI_INVALID_PARAMETER
;
4027 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
4030 // Allocate a fix length of memory to store Results. Reallocate memory for
4031 // Results if this fix length is insufficient.
4033 *Results
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
4034 if (*Results
== NULL
) {
4035 return EFI_OUT_OF_RESOURCES
;
4038 NumberConfigAccessHandles
= 0;
4039 Status
= gBS
->LocateHandleBuffer (
4041 &gEfiHiiConfigAccessProtocolGuid
,
4043 &NumberConfigAccessHandles
,
4044 &ConfigAccessHandles
4046 if (EFI_ERROR (Status
)) {
4050 FirstElement
= TRUE
;
4052 for (Index
= 0; Index
< NumberConfigAccessHandles
; Index
++) {
4053 Status
= gBS
->HandleProtocol (
4054 ConfigAccessHandles
[Index
],
4055 &gEfiHiiConfigAccessProtocolGuid
,
4056 (VOID
**) &ConfigAccess
4058 if (EFI_ERROR (Status
)) {
4063 // Get DevicePath and HiiHandle for this ConfigAccess driver handle
4065 IfrDataParsedFlag
= FALSE
;
4068 DefaultResults
= NULL
;
4070 ConfigRequest
= NULL
;
4071 DevicePath
= DevicePathFromHandle (ConfigAccessHandles
[Index
]);
4072 if (DevicePath
!= NULL
) {
4073 for (Link
= Private
->DatabaseList
.ForwardLink
;
4074 Link
!= &Private
->DatabaseList
;
4075 Link
= Link
->ForwardLink
4077 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
4078 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
4079 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
4083 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
)
4085 HiiHandle
= Database
->Handle
;
4092 Status
= ConfigAccess
->ExtractConfig (
4098 if (EFI_ERROR (Status
)) {
4100 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
4102 if (HiiHandle
!= NULL
&& DevicePath
!= NULL
) {
4103 IfrDataParsedFlag
= TRUE
;
4104 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, NULL
);
4106 // Get the full request string to get the Current setting again.
4108 if (!EFI_ERROR (Status
) && ConfigRequest
!= NULL
) {
4109 Status
= ConfigAccess
->ExtractConfig (
4115 FreePool (ConfigRequest
);
4117 Status
= EFI_NOT_FOUND
;
4122 if (!EFI_ERROR (Status
)) {
4124 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
4126 if (!IfrDataParsedFlag
&& HiiHandle
!= NULL
&& DevicePath
!= NULL
) {
4127 StringPtr
= StrStr (AccessResults
, L
"&GUID=");
4128 if (StringPtr
!= NULL
) {
4131 if (GetElementsFromRequest (AccessResults
)) {
4132 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &AccessResults
, &DefaultResults
, NULL
);
4133 ASSERT_EFI_ERROR (Status
);
4135 if (StringPtr
!= NULL
) {
4140 // Merge the default sting from IFR code into the got setting from driver.
4142 if (DefaultResults
!= NULL
) {
4143 Status
= MergeDefaultString (&AccessResults
, DefaultResults
);
4144 ASSERT_EFI_ERROR (Status
);
4145 FreePool (DefaultResults
);
4146 DefaultResults
= NULL
;
4150 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
4151 // which seperates the first <ConfigAltResp> and the following ones.
4153 if (!FirstElement
) {
4154 Status
= AppendToMultiString (Results
, L
"&");
4155 ASSERT_EFI_ERROR (Status
);
4158 Status
= AppendToMultiString (Results
, AccessResults
);
4159 ASSERT_EFI_ERROR (Status
);
4161 FirstElement
= FALSE
;
4163 FreePool (AccessResults
);
4164 AccessResults
= NULL
;
4167 FreePool (ConfigAccessHandles
);
4174 This function processes the results of processing forms and routes it to the
4175 appropriate handlers or storage.
4177 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4179 @param Configuration A null-terminated Unicode string in
4180 <MulltiConfigResp> format.
4181 @param Progress A pointer to a string filled in with the offset of
4182 the most recent & before the first failing name /
4183 value pair (or the beginning of the string if the
4184 failure is in the first name / value pair) or the
4185 terminating NULL if all was successful.
4187 @retval EFI_SUCCESS The results have been distributed or are awaiting
4189 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
4190 results that must be stored awaiting possible
4192 @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
4193 would result in this type of error.
4194 @retval EFI_NOT_FOUND Target for the specified routing data was not
4200 HiiConfigRoutingRouteConfig (
4201 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
4202 IN CONST EFI_STRING Configuration
,
4203 OUT EFI_STRING
*Progress
4206 HII_DATABASE_PRIVATE_DATA
*Private
;
4207 EFI_STRING StringPtr
;
4208 EFI_STRING ConfigResp
;
4211 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
4212 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
4214 HII_DATABASE_RECORD
*Database
;
4215 UINT8
*DevicePathPkg
;
4216 UINT8
*CurrentDevicePath
;
4217 EFI_HANDLE DriverHandle
;
4218 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
4219 EFI_STRING AccessProgress
;
4220 EFI_IFR_VARSTORE_EFI
*EfiVarStoreInfo
;
4221 BOOLEAN IsEfiVarstore
;
4222 UINTN DevicePathSize
;
4224 if (This
== NULL
|| Progress
== NULL
) {
4225 return EFI_INVALID_PARAMETER
;
4228 if (Configuration
== NULL
) {
4230 return EFI_INVALID_PARAMETER
;
4233 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
4234 StringPtr
= Configuration
;
4235 *Progress
= StringPtr
;
4237 AccessProgress
= NULL
;
4238 EfiVarStoreInfo
= NULL
;
4239 IsEfiVarstore
= FALSE
;
4242 // The first element of <MultiConfigResp> should be
4243 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
4245 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
4246 return EFI_INVALID_PARAMETER
;
4249 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) == 0) {
4251 // If parsing error, set Progress to the beginning of the <MultiConfigResp>
4252 // or most recent & before the error.
4254 if (StringPtr
== Configuration
) {
4255 *Progress
= StringPtr
;
4257 *Progress
= StringPtr
- 1;
4261 // Process each <ConfigResp> of <MultiConfigResp>
4263 Length
= CalculateConfigStringLen (StringPtr
);
4264 ConfigResp
= AllocateCopyPool ((Length
+ 1) * sizeof (CHAR16
), StringPtr
);
4265 if (ConfigResp
== NULL
) {
4266 return EFI_OUT_OF_RESOURCES
;
4269 // Append '\0' to the end of ConfigRequest
4271 *(ConfigResp
+ Length
) = 0;
4274 // Get the UEFI device path
4276 Status
= GetDevicePath (ConfigResp
, (UINT8
**) &DevicePath
);
4277 if (EFI_ERROR (Status
)) {
4278 FreePool (ConfigResp
);
4283 // Find driver which matches the routing data.
4285 DriverHandle
= NULL
;
4286 for (Link
= Private
->DatabaseList
.ForwardLink
;
4287 Link
!= &Private
->DatabaseList
;
4288 Link
= Link
->ForwardLink
4290 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
4292 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
4293 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
4294 DevicePathSize
= GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
);
4295 if ((CompareMem (DevicePath
,CurrentDevicePath
,DevicePathSize
) == 0) && IsThisPackageList(Database
, ConfigResp
)) {
4296 DriverHandle
= Database
->DriverHandle
;
4303 // Try to find driver handle by device path.
4305 if (DriverHandle
== NULL
) {
4306 TempDevicePath
= DevicePath
;
4307 Status
= gBS
->LocateDevicePath (
4308 &gEfiDevicePathProtocolGuid
,
4312 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
4314 // Routing data does not match any known driver.
4315 // Set Progress to the 'G' in "GUID" of the routing header.
4317 FreePool (DevicePath
);
4318 *Progress
= StringPtr
;
4319 FreePool (ConfigResp
);
4320 return EFI_NOT_FOUND
;
4324 FreePool (DevicePath
);
4327 // Check whether this ConfigRequest is search from Efi varstore type storage.
4329 Status
= GetVarStoreType(Database
, ConfigResp
, &IsEfiVarstore
, &EfiVarStoreInfo
);
4330 if (EFI_ERROR (Status
)) {
4334 if (IsEfiVarstore
) {
4336 // Call the SetVariable function to route settings.
4338 Status
= RouteConfigRespForEfiVarStore(This
, EfiVarStoreInfo
, ConfigResp
, &AccessProgress
);
4339 FreePool (EfiVarStoreInfo
);
4342 // Call corresponding ConfigAccess protocol to route settings
4344 Status
= gBS
->HandleProtocol (
4346 &gEfiHiiConfigAccessProtocolGuid
,
4347 (VOID
**) &ConfigAccess
4349 if (EFI_ERROR (Status
)) {
4350 *Progress
= StringPtr
;
4351 FreePool (ConfigResp
);
4352 return EFI_NOT_FOUND
;
4355 Status
= ConfigAccess
->RouteConfig (
4361 if (EFI_ERROR (Status
)) {
4362 ASSERT (AccessProgress
!= NULL
);
4364 // AccessProgress indicates the parsing progress on <ConfigResp>.
4365 // Map it to the progress on <MultiConfigResp> then return it.
4367 *Progress
= StrStr (StringPtr
, AccessProgress
);
4369 FreePool (ConfigResp
);
4373 FreePool (ConfigResp
);
4377 // Go to next <ConfigResp> (skip '&').
4379 StringPtr
+= Length
;
4380 if (*StringPtr
== 0) {
4381 *Progress
= StringPtr
;
4394 This helper function is to be called by drivers to map configuration data
4395 stored in byte array ("block") formats such as UEFI Variables into current
4396 configuration strings.
4398 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4400 @param ConfigRequest A null-terminated Unicode string in
4401 <ConfigRequest> format.
4402 @param Block Array of bytes defining the block's configuration.
4403 @param BlockSize Length in bytes of Block.
4404 @param Config Filled-in configuration string. String allocated
4405 by the function. Returned only if call is
4406 successful. It is <ConfigResp> string format.
4407 @param Progress A pointer to a string filled in with the offset of
4408 the most recent & before the first failing
4409 name/value pair (or the beginning of the string if
4410 the failure is in the first name / value pair) or
4411 the terminating NULL if all was successful.
4413 @retval EFI_SUCCESS The request succeeded. Progress points to the null
4414 terminator at the end of the ConfigRequest
4416 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
4417 points to the first character of ConfigRequest.
4418 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
4419 Block parameter would result in this type of
4420 error. Progress points to the first character of
4422 @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
4423 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
4424 Block is left updated and Progress points at
4425 the "&" preceding the first non-<BlockName>.
4431 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
4432 IN CONST EFI_STRING ConfigRequest
,
4433 IN CONST UINT8
*Block
,
4434 IN CONST UINTN BlockSize
,
4435 OUT EFI_STRING
*Config
,
4436 OUT EFI_STRING
*Progress
4439 HII_DATABASE_PRIVATE_DATA
*Private
;
4440 EFI_STRING StringPtr
;
4448 EFI_STRING ValueStr
;
4449 EFI_STRING ConfigElement
;
4457 if (This
== NULL
|| Progress
== NULL
|| Config
== NULL
) {
4458 return EFI_INVALID_PARAMETER
;
4461 if (Block
== NULL
|| ConfigRequest
== NULL
) {
4462 *Progress
= ConfigRequest
;
4463 return EFI_INVALID_PARAMETER
;
4467 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
4468 ASSERT (Private
!= NULL
);
4470 StringPtr
= ConfigRequest
;
4473 ConfigElement
= NULL
;
4476 // Allocate a fix length of memory to store Results. Reallocate memory for
4477 // Results if this fix length is insufficient.
4479 *Config
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
4480 if (*Config
== NULL
) {
4481 return EFI_OUT_OF_RESOURCES
;
4487 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
4488 *Progress
= StringPtr
;
4489 Status
= EFI_INVALID_PARAMETER
;
4492 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"PATH=", StrLen (L
"PATH=")) != 0) {
4495 if (*StringPtr
== 0) {
4496 *Progress
= StringPtr
- 1;
4497 Status
= EFI_INVALID_PARAMETER
;
4501 while (*StringPtr
!= L
'&' && *StringPtr
!= 0) {
4504 if (*StringPtr
== 0) {
4505 *Progress
= StringPtr
;
4507 AppendToMultiString(Config
, ConfigRequest
);
4508 HiiToLower (*Config
);
4518 // Copy <ConfigHdr> and an additional '&' to <ConfigResp>
4520 TemChar
= *StringPtr
;
4522 AppendToMultiString(Config
, ConfigRequest
);
4523 *StringPtr
= TemChar
;
4526 // Parse each <RequestElement> if exists
4527 // Only <BlockName> format is supported by this help function.
4528 // <BlockName> ::= 'OFFSET='<Number>&'WIDTH='<Number>
4530 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"OFFSET=", StrLen (L
"OFFSET=")) == 0) {
4532 // Back up the header of one <BlockName>
4536 StringPtr
+= StrLen (L
"OFFSET=");
4540 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
4541 if (EFI_ERROR (Status
)) {
4542 *Progress
= TmpPtr
- 1;
4549 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
4551 FreePool (TmpBuffer
);
4553 StringPtr
+= Length
;
4554 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
4555 *Progress
= TmpPtr
- 1;
4556 Status
= EFI_INVALID_PARAMETER
;
4559 StringPtr
+= StrLen (L
"&WIDTH=");
4564 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
4565 if (EFI_ERROR (Status
)) {
4566 *Progress
= TmpPtr
- 1;
4573 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
4575 FreePool (TmpBuffer
);
4577 StringPtr
+= Length
;
4578 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
4579 *Progress
= TmpPtr
- 1;
4580 Status
= EFI_INVALID_PARAMETER
;
4585 // Calculate Value and convert it to hex string.
4587 if (Offset
+ Width
> BlockSize
) {
4588 *Progress
= StringPtr
;
4589 Status
= EFI_DEVICE_ERROR
;
4593 Value
= (UINT8
*) AllocateZeroPool (Width
);
4594 if (Value
== NULL
) {
4595 *Progress
= ConfigRequest
;
4596 Status
= EFI_OUT_OF_RESOURCES
;
4600 CopyMem (Value
, (UINT8
*) Block
+ Offset
, Width
);
4602 Length
= Width
* 2 + 1;
4603 ValueStr
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
4604 if (ValueStr
== NULL
) {
4605 *Progress
= ConfigRequest
;
4606 Status
= EFI_OUT_OF_RESOURCES
;
4610 TemString
= ValueStr
;
4611 TemBuffer
= Value
+ Width
- 1;
4612 for (Index
= 0; Index
< Width
; Index
++, TemBuffer
--) {
4613 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
4620 // Build a ConfigElement
4622 Length
+= StringPtr
- TmpPtr
+ 1 + StrLen (L
"VALUE=");
4623 ConfigElement
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
4624 if (ConfigElement
== NULL
) {
4625 Status
= EFI_OUT_OF_RESOURCES
;
4628 CopyMem (ConfigElement
, TmpPtr
, (StringPtr
- TmpPtr
+ 1) * sizeof (CHAR16
));
4629 if (*StringPtr
== 0) {
4630 *(ConfigElement
+ (StringPtr
- TmpPtr
)) = L
'&';
4632 *(ConfigElement
+ (StringPtr
- TmpPtr
) + 1) = 0;
4633 StrCatS (ConfigElement
, Length
, L
"VALUE=");
4634 StrCatS (ConfigElement
, Length
, ValueStr
);
4636 AppendToMultiString (Config
, ConfigElement
);
4638 FreePool (ConfigElement
);
4639 FreePool (ValueStr
);
4640 ConfigElement
= NULL
;
4644 // If '\0', parsing is finished. Otherwise skip '&' to continue
4646 if (*StringPtr
== 0) {
4649 AppendToMultiString (Config
, L
"&");
4654 if (*StringPtr
!= 0) {
4655 *Progress
= StringPtr
- 1;
4656 Status
= EFI_INVALID_PARAMETER
;
4660 HiiToLower (*Config
);
4661 *Progress
= StringPtr
;
4665 if (*Config
!= NULL
) {
4669 if (ValueStr
!= NULL
) {
4670 FreePool (ValueStr
);
4672 if (Value
!= NULL
) {
4675 if (ConfigElement
!= NULL
) {
4676 FreePool (ConfigElement
);
4685 This helper function is to be called by drivers to map configuration strings
4686 to configurations stored in byte array ("block") formats such as UEFI Variables.
4688 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4690 @param ConfigResp A null-terminated Unicode string in <ConfigResp>
4692 @param Block A possibly null array of bytes representing the
4693 current block. Only bytes referenced in the
4694 ConfigResp string in the block are modified. If
4695 this parameter is null or if the *BlockSize
4696 parameter is (on input) shorter than required by
4697 the Configuration string, only the BlockSize
4698 parameter is updated and an appropriate status
4699 (see below) is returned.
4700 @param BlockSize The length of the Block in units of UINT8. On
4701 input, this is the size of the Block. On output,
4702 if successful, contains the largest index of the
4703 modified byte in the Block, or the required buffer
4704 size if the Block is not large enough.
4705 @param Progress On return, points to an element of the ConfigResp
4706 string filled in with the offset of the most
4707 recent '&' before the first failing name / value
4708 pair (or the beginning of the string if the
4709 failure is in the first name / value pair) or the
4710 terminating NULL if all was successful.
4712 @retval EFI_SUCCESS The request succeeded. Progress points to the null
4713 terminator at the end of the ConfigResp string.
4714 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
4715 points to the first character of ConfigResp.
4716 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
4717 Block parameter would result in this type of
4718 error. Progress points to the first character of
4720 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
4721 value pair. Block is left updated and
4722 Progress points at the '&' preceding the first
4724 @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined.
4725 BlockSize is updated with the required buffer size.
4726 @retval EFI_NOT_FOUND Target for the specified routing data was not found.
4727 Progress points to the "G" in "GUID" of the errant
4734 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
4735 IN CONST EFI_STRING ConfigResp
,
4736 IN OUT UINT8
*Block
,
4737 IN OUT UINTN
*BlockSize
,
4738 OUT EFI_STRING
*Progress
4741 HII_DATABASE_PRIVATE_DATA
*Private
;
4742 EFI_STRING StringPtr
;
4755 if (This
== NULL
|| BlockSize
== NULL
|| Progress
== NULL
) {
4756 return EFI_INVALID_PARAMETER
;
4759 *Progress
= ConfigResp
;
4760 if (ConfigResp
== NULL
) {
4761 return EFI_INVALID_PARAMETER
;
4764 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
4765 ASSERT (Private
!= NULL
);
4767 StringPtr
= ConfigResp
;
4768 BufferSize
= *BlockSize
;
4775 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
4776 *Progress
= StringPtr
;
4777 Status
= EFI_INVALID_PARAMETER
;
4780 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"PATH=", StrLen (L
"PATH=")) != 0) {
4783 if (*StringPtr
== 0) {
4784 *Progress
= StringPtr
;
4785 Status
= EFI_INVALID_PARAMETER
;
4789 while (*StringPtr
!= L
'&' && *StringPtr
!= 0) {
4792 if (*StringPtr
== 0) {
4793 *Progress
= StringPtr
;
4794 Status
= EFI_INVALID_PARAMETER
;
4799 // Parse each <ConfigElement> if exists
4800 // Only '&'<BlockConfig> format is supported by this help function.
4801 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE='<Number>
4803 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) == 0) {
4805 StringPtr
+= StrLen (L
"&OFFSET=");
4809 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
4810 if (EFI_ERROR (Status
)) {
4818 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
4820 FreePool (TmpBuffer
);
4822 StringPtr
+= Length
;
4823 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
4825 Status
= EFI_INVALID_PARAMETER
;
4828 StringPtr
+= StrLen (L
"&WIDTH=");
4833 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
4834 if (EFI_ERROR (Status
)) {
4842 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
4844 FreePool (TmpBuffer
);
4846 StringPtr
+= Length
;
4847 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) != 0) {
4849 Status
= EFI_INVALID_PARAMETER
;
4852 StringPtr
+= StrLen (L
"&VALUE=");
4857 Status
= GetValueOfNumber (StringPtr
, &Value
, &Length
);
4858 if (EFI_ERROR (Status
)) {
4863 StringPtr
+= Length
;
4864 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
4866 Status
= EFI_INVALID_PARAMETER
;
4871 // Update the Block with configuration info
4873 if ((Block
!= NULL
) && (Offset
+ Width
<= BufferSize
)) {
4874 CopyMem (Block
+ Offset
, Value
, Width
);
4876 if (Offset
+ Width
> MaxBlockSize
) {
4877 MaxBlockSize
= Offset
+ Width
;
4884 // If '\0', parsing is finished.
4886 if (*StringPtr
== 0) {
4892 // The input string is not ConfigResp format, return error.
4894 if (*StringPtr
!= 0) {
4895 *Progress
= StringPtr
;
4896 Status
= EFI_INVALID_PARAMETER
;
4900 *Progress
= StringPtr
+ StrLen (StringPtr
);
4901 *BlockSize
= MaxBlockSize
- 1;
4903 if (MaxBlockSize
> BufferSize
) {
4904 *BlockSize
= MaxBlockSize
;
4905 if (Block
!= NULL
) {
4906 return EFI_BUFFER_TOO_SMALL
;
4910 if (Block
== NULL
) {
4911 *Progress
= ConfigResp
;
4912 return EFI_INVALID_PARAMETER
;
4919 if (Value
!= NULL
) {
4927 This helper function is to be called by drivers to extract portions of
4928 a larger configuration string.
4930 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4932 @param Configuration A null-terminated Unicode string in
4933 <MultiConfigAltResp> format.
4934 @param Guid A pointer to the GUID value to search for in the
4935 routing portion of the ConfigResp string when
4936 retrieving the requested data. If Guid is NULL,
4937 then all GUID values will be searched for.
4938 @param Name A pointer to the NAME value to search for in the
4939 routing portion of the ConfigResp string when
4940 retrieving the requested data. If Name is NULL,
4941 then all Name values will be searched for.
4942 @param DevicePath A pointer to the PATH value to search for in the
4943 routing portion of the ConfigResp string when
4944 retrieving the requested data. If DevicePath is
4945 NULL, then all DevicePath values will be searched
4947 @param AltCfgId A pointer to the ALTCFG value to search for in the
4948 routing portion of the ConfigResp string when
4949 retrieving the requested data. If this parameter
4950 is NULL, then the current setting will be
4952 @param AltCfgResp A pointer to a buffer which will be allocated by
4953 the function which contains the retrieved string
4954 as requested. This buffer is only allocated if
4955 the call was successful. It is <ConfigResp> format.
4957 @retval EFI_SUCCESS The request succeeded. The requested data was
4958 extracted and placed in the newly allocated
4960 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
4961 @retval EFI_INVALID_PARAMETER Any parameter is invalid.
4962 @retval EFI_NOT_FOUND Target for the specified routing data was not
4969 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
4970 IN CONST EFI_STRING Configuration
,
4971 IN CONST EFI_GUID
*Guid
,
4972 IN CONST EFI_STRING Name
,
4973 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
4974 IN CONST UINT16
*AltCfgId
,
4975 OUT EFI_STRING
*AltCfgResp
4979 EFI_STRING StringPtr
;
4980 EFI_STRING HdrStart
;
4987 EFI_STRING AltIdStr
;
5004 if (This
== NULL
|| Configuration
== NULL
|| AltCfgResp
== NULL
) {
5005 return EFI_INVALID_PARAMETER
;
5008 StringPtr
= Configuration
;
5009 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
5010 return EFI_INVALID_PARAMETER
;
5014 // Generate the sub string for later matching.
5016 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) Guid
, 1, &GuidStr
);
5019 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
5020 (VOID
*) DevicePath
,
5024 if (AltCfgId
!= NULL
) {
5025 GenerateSubStr (L
"ALTCFG=", sizeof (UINT16
), (VOID
*) AltCfgId
, 3, &AltIdStr
);
5028 GenerateSubStr (L
"NAME=", StrLen (Name
) * sizeof (CHAR16
), (VOID
*) Name
, 2, &NameStr
);
5030 GenerateSubStr (L
"NAME=", 0, NULL
, 2, &NameStr
);
5033 while (*StringPtr
!= 0) {
5035 // Try to match the GUID
5038 TmpPtr
= StrStr (StringPtr
, GuidStr
);
5039 if (TmpPtr
== NULL
) {
5040 Status
= EFI_NOT_FOUND
;
5046 // Jump to <NameHdr>
5049 StringPtr
= TmpPtr
+ StrLen (GuidStr
);
5051 StringPtr
= StrStr (TmpPtr
, L
"NAME=");
5052 if (StringPtr
== NULL
) {
5053 Status
= EFI_NOT_FOUND
;
5061 // Try to match the NAME
5063 if (GuidFlag
&& !NameFlag
) {
5064 if (StrnCmp (StringPtr
, NameStr
, StrLen (NameStr
)) != 0) {
5068 // Jump to <PathHdr>
5071 StringPtr
+= StrLen (NameStr
);
5073 StringPtr
= StrStr (StringPtr
, L
"PATH=");
5074 if (StringPtr
== NULL
) {
5075 Status
= EFI_NOT_FOUND
;
5084 // Try to match the DevicePath
5086 if (GuidFlag
&& NameFlag
&& !PathFlag
) {
5087 if (StrnCmp (StringPtr
, PathStr
, StrLen (PathStr
)) != 0) {
5092 // Jump to '&' before <DescHdr> or <ConfigBody>
5094 if (DevicePath
!= NULL
) {
5095 StringPtr
+= StrLen (PathStr
);
5097 StringPtr
= StrStr (StringPtr
, L
"&");
5098 if (StringPtr
== NULL
) {
5099 Status
= EFI_NOT_FOUND
;
5110 // Try to match the AltCfgId
5112 if (GuidFlag
&& NameFlag
&& PathFlag
) {
5113 if (AltCfgId
== NULL
) {
5115 // Return Current Setting when AltCfgId is NULL.
5117 Status
= OutputConfigBody (StringPtr
, &Result
);
5121 // Search the <ConfigAltResp> to get the <AltResp> with AltCfgId.
5123 if (StrnCmp (StringPtr
, AltIdStr
, StrLen (AltIdStr
)) != 0) {
5129 // Skip AltIdStr and &
5131 StringPtr
= StringPtr
+ StrLen (AltIdStr
);
5132 Status
= OutputConfigBody (StringPtr
, &Result
);
5138 Status
= EFI_NOT_FOUND
;
5142 if (!EFI_ERROR (Status
) && (Result
!= NULL
)) {
5144 // Copy the <ConfigHdr> and <ConfigBody>
5146 Length
= HdrEnd
- HdrStart
+ StrLen (Result
) + 1;
5147 *AltCfgResp
= AllocateZeroPool (Length
* sizeof (CHAR16
));
5148 if (*AltCfgResp
== NULL
) {
5149 Status
= EFI_OUT_OF_RESOURCES
;
5151 StrnCpyS (*AltCfgResp
, Length
, HdrStart
, HdrEnd
- HdrStart
);
5152 StrCatS (*AltCfgResp
, Length
, Result
);
5153 Status
= EFI_SUCCESS
;
5157 if (GuidStr
!= NULL
) {
5160 if (NameStr
!= NULL
) {
5163 if (PathStr
!= NULL
) {
5166 if (AltIdStr
!= NULL
) {
5167 FreePool (AltIdStr
);
5169 if (Result
!= NULL
) {