2 Implementation of interfaces function for EFI_HII_CONFIG_ROUTING_PROTOCOL.
4 Copyright (c) 2007 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
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 Str 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 StrCpy (Str
, String
);
256 Length
= (BufferLen
* 2 + 1) * sizeof (CHAR16
);
258 StringHeader
= Str
+ StrLen (String
);
259 TemString
= (CHAR16
*) StringHeader
;
264 // Convert Buffer to Hex String in reverse order
266 TemBuffer
= ((UINT8
*) Buffer
);
267 for (Index
= 0; Index
< BufferLen
; Index
++, TemBuffer
++) {
268 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
273 // Check buffer is enough
275 TemName
= (CHAR16
*) Buffer
;
276 ASSERT ((BufferLen
* 2 + 1) >= (StrLen (TemName
) * 4 + 1));
278 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
280 for (; *TemName
!= L
'\0'; TemName
++) {
281 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
286 // Convert Buffer to Hex String
288 TemBuffer
= ((UINT8
*) Buffer
) + BufferLen
- 1;
289 for (Index
= 0; Index
< BufferLen
; Index
++, TemBuffer
--) {
290 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
298 // Convert the uppercase to lowercase since <HexAf> is defined in lowercase format.
308 Retrieve the <ConfigBody> from String then output it.
310 This is a internal function.
312 @param String A sub string of a configuration string in
313 <MultiConfigAltResp> format.
314 @param ConfigBody Points to the output string. It's caller's
315 responsibility to free this buffer.
317 @retval EFI_INVALID_PARAMETER There is no form package in current hii database.
318 @retval EFI_OUT_OF_RESOURCES Not enough memory to finish this operation.
319 @retval EFI_SUCCESS All existing storage is exported.
324 IN EFI_STRING String
,
325 OUT EFI_STRING
*ConfigBody
332 if (String
== NULL
|| ConfigBody
== NULL
) {
333 return EFI_INVALID_PARAMETER
;
337 // The setting information should start OFFSET, not ALTCFG.
339 if (StrnCmp (String
, L
"&ALTCFG=", StrLen (L
"&ALTCFG=")) == 0) {
340 return EFI_INVALID_PARAMETER
;
343 TmpPtr
= StrStr (String
, L
"GUID=");
344 if (TmpPtr
== NULL
) {
346 // It is the last <ConfigResp> of the incoming configuration string.
348 Result
= AllocateCopyPool (StrSize (String
), String
);
349 if (Result
== NULL
) {
350 return EFI_OUT_OF_RESOURCES
;
352 *ConfigBody
= Result
;
357 Length
= TmpPtr
- String
;
358 Result
= AllocateCopyPool (Length
* sizeof (CHAR16
), String
);
359 if (Result
== NULL
) {
360 return EFI_OUT_OF_RESOURCES
;
363 *(Result
+ Length
- 1) = 0;
364 *ConfigBody
= Result
;
369 Append a string to a multi-string format.
371 This is a internal function.
373 @param MultiString String in <MultiConfigRequest>,
374 <MultiConfigAltResp>, or <MultiConfigResp>. On
375 input, the buffer length of this string is
376 MAX_STRING_LENGTH. On output, the buffer length
378 @param AppendString NULL-terminated Unicode string.
380 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.
381 @retval EFI_SUCCESS AppendString is append to the end of MultiString
385 AppendToMultiString (
386 IN OUT EFI_STRING
*MultiString
,
387 IN EFI_STRING AppendString
390 UINTN AppendStringSize
;
391 UINTN MultiStringSize
;
393 if (MultiString
== NULL
|| *MultiString
== NULL
|| AppendString
== NULL
) {
394 return EFI_INVALID_PARAMETER
;
397 AppendStringSize
= StrSize (AppendString
);
398 MultiStringSize
= StrSize (*MultiString
);
401 // Enlarge the buffer each time when length exceeds MAX_STRING_LENGTH.
403 if (MultiStringSize
+ AppendStringSize
> MAX_STRING_LENGTH
||
404 MultiStringSize
> MAX_STRING_LENGTH
) {
405 *MultiString
= (EFI_STRING
) ReallocatePool (
407 MultiStringSize
+ AppendStringSize
,
408 (VOID
*) (*MultiString
)
410 ASSERT (*MultiString
!= NULL
);
413 // Append the incoming string
415 StrCat (*MultiString
, AppendString
);
422 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET
424 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
426 This is a internal function.
428 @param StringPtr String in <BlockConfig> format and points to the
429 first character of <Number>.
430 @param Number The output value. Caller takes the responsibility
432 @param Len Length of the <Number>, in characters.
434 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary
436 @retval EFI_SUCCESS Value of <Number> is outputted in Number
442 IN EFI_STRING StringPtr
,
456 ASSERT (StringPtr
!= NULL
&& Number
!= NULL
&& Len
!= NULL
);
457 ASSERT (*StringPtr
!= L
'\0');
462 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
465 *Len
= StringPtr
- TmpPtr
;
468 Str
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
470 Status
= EFI_OUT_OF_RESOURCES
;
473 CopyMem (Str
, TmpPtr
, *Len
* sizeof (CHAR16
));
474 *(Str
+ *Len
) = L
'\0';
476 Length
= (Length
+ 1) / 2;
477 Buf
= (UINT8
*) AllocateZeroPool (Length
);
479 Status
= EFI_OUT_OF_RESOURCES
;
484 ZeroMem (TemStr
, sizeof (TemStr
));
485 for (Index
= 0; Index
< Length
; Index
++) {
486 TemStr
[0] = Str
[Length
- Index
- 1];
487 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
488 if ((Index
& 1) == 0) {
489 Buf
[Index
/2] = DigitUint8
;
491 Buf
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Buf
[Index
/2]);
496 Status
= EFI_SUCCESS
;
507 This function merges DefaultAltCfgResp string into AltCfgResp string for
508 the missing AltCfgId in AltCfgResq.
510 @param AltCfgResp Pointer to a null-terminated Unicode string in
511 <ConfigAltResp> format. The default value string
512 will be merged into it.
513 @param DefaultAltCfgResp Pointer to a null-terminated Unicode string in
514 <MultiConfigAltResp> format. The default value
515 string may contain more than one ConfigAltResp
516 string for the different varstore buffer.
518 @retval EFI_SUCCESS The merged string returns.
519 @retval EFI_INVALID_PARAMETER *AltCfgResp is to NULL.
524 IN OUT EFI_STRING
*AltCfgResp
,
525 IN EFI_STRING DefaultAltCfgResp
528 EFI_STRING StringPtrDefault
;
529 EFI_STRING StringPtrEnd
;
531 EFI_STRING StringPtr
;
532 EFI_STRING AltConfigHdr
;
534 UINTN SizeAltCfgResp
;
536 if (*AltCfgResp
== NULL
) {
537 return EFI_INVALID_PARAMETER
;
541 // Get the requestr ConfigHdr
544 StringPtr
= *AltCfgResp
;
547 // Find <ConfigHdr> GUID=...&NAME=...&PATH=...
549 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
550 return EFI_INVALID_PARAMETER
;
552 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
555 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
558 if (*StringPtr
== L
'\0') {
559 return EFI_INVALID_PARAMETER
;
561 StringPtr
+= StrLen (L
"&PATH=");
562 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
565 HeaderLength
= StringPtr
- *AltCfgResp
;
568 // Construct AltConfigHdr string "&<ConfigHdr>&ALTCFG=XXXX\0"
569 // |1| StrLen (ConfigHdr) | 8 | 4 | 1 |
571 AltConfigHdr
= AllocateZeroPool ((1 + HeaderLength
+ 8 + 4 + 1) * sizeof (CHAR16
));
572 if (AltConfigHdr
== NULL
) {
573 return EFI_OUT_OF_RESOURCES
;
575 StrCpy (AltConfigHdr
, L
"&");
576 StrnCat (AltConfigHdr
, *AltCfgResp
, HeaderLength
);
577 StrCat (AltConfigHdr
, L
"&ALTCFG=");
578 HeaderLength
= StrLen (AltConfigHdr
);
580 StringPtrDefault
= StrStr (DefaultAltCfgResp
, AltConfigHdr
);
581 while (StringPtrDefault
!= NULL
) {
585 StrnCat (AltConfigHdr
, StringPtrDefault
+ HeaderLength
, 4);
586 StringPtr
= StrStr (*AltCfgResp
, AltConfigHdr
);
589 // Append the found default value string to the input AltCfgResp
591 if (StringPtr
== NULL
) {
592 StringPtrEnd
= StrStr (StringPtrDefault
+ 1, L
"&GUID");
593 SizeAltCfgResp
= StrSize (*AltCfgResp
);
594 if (StringPtrEnd
== NULL
) {
596 // No more default string is found.
598 *AltCfgResp
= (EFI_STRING
) ReallocatePool (
600 SizeAltCfgResp
+ StrSize (StringPtrDefault
),
601 (VOID
*) (*AltCfgResp
)
603 if (*AltCfgResp
== NULL
) {
604 FreePool (AltConfigHdr
);
605 return EFI_OUT_OF_RESOURCES
;
607 StrCat (*AltCfgResp
, StringPtrDefault
);
610 TempChar
= *StringPtrEnd
;
611 *StringPtrEnd
= L
'\0';
612 *AltCfgResp
= (EFI_STRING
) ReallocatePool (
614 SizeAltCfgResp
+ StrSize (StringPtrDefault
),
615 (VOID
*) (*AltCfgResp
)
617 if (*AltCfgResp
== NULL
) {
618 FreePool (AltConfigHdr
);
619 return EFI_OUT_OF_RESOURCES
;
621 StrCat (*AltCfgResp
, StringPtrDefault
);
622 *StringPtrEnd
= TempChar
;
627 // Find next AltCfg String
629 *(AltConfigHdr
+ HeaderLength
) = L
'\0';
630 StringPtrDefault
= StrStr (StringPtrDefault
+ 1, AltConfigHdr
);
633 FreePool (AltConfigHdr
);
638 This function finds the matched DefaultName for the input DefaultId
640 @param DefaultIdArray Array stores the map table between DefaultId and DefaultName.
641 @param VarDefaultId Default Id
642 @param VarDefaultName Default Name string ID for the input default ID.
644 @retval EFI_SUCCESS The mapped default name string ID is found.
645 @retval EFI_NOT_FOUND The mapped default name string ID is not found.
649 IN IFR_DEFAULT_DATA
*DefaultIdArray
,
650 IN UINT16 VarDefaultId
,
651 OUT EFI_STRING_ID
*VarDefaultName
655 IFR_DEFAULT_DATA
*DefaultData
;
657 for (Link
= DefaultIdArray
->Entry
.ForwardLink
; Link
!= &DefaultIdArray
->Entry
; Link
= Link
->ForwardLink
) {
658 DefaultData
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
659 if (DefaultData
->DefaultId
== VarDefaultId
) {
660 *VarDefaultName
= DefaultData
->DefaultName
;
665 return EFI_NOT_FOUND
;
669 This function inserts new DefaultValueData into the BlockData DefaultValue array.
671 @param BlockData The BlockData is updated to add new default value.
672 @param DefaultValueData The DefaultValue is added.
677 IN IFR_BLOCK_DATA
*BlockData
,
678 IN IFR_DEFAULT_DATA
*DefaultValueData
682 IFR_DEFAULT_DATA
*DefaultValueArray
;
684 for (Link
= BlockData
->DefaultValueEntry
.ForwardLink
; Link
!= &BlockData
->DefaultValueEntry
; Link
= Link
->ForwardLink
) {
685 DefaultValueArray
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
686 if (DefaultValueArray
->DefaultId
== DefaultValueData
->DefaultId
) {
687 if (DefaultValueData
->OpCode
== EFI_IFR_DEFAULT_OP
) {
689 // Update the default value array in BlockData.
691 DefaultValueArray
->Value
= DefaultValueData
->Value
;
692 } else if (DefaultValueArray
->OpCode
!= EFI_IFR_DEFAULT_OP
) {
694 // Update the default value array in BlockData.
696 DefaultValueArray
->Value
= DefaultValueData
->Value
;
698 FreePool (DefaultValueData
);
700 } else if (DefaultValueArray
->DefaultId
> DefaultValueData
->DefaultId
) {
702 // Insert new default value data in the front of this default value array.
704 InsertTailList (Link
, &DefaultValueData
->Entry
);
710 // Insert new default value data in tail.
712 InsertTailList (Link
, &DefaultValueData
->Entry
);
717 This function inserts new BlockData into the block link
719 @param BlockLink The list entry points to block array.
720 @param BlockData The point to BlockData is added.
725 IN LIST_ENTRY
*BlockLink
,
726 IN IFR_BLOCK_DATA
**BlockData
730 IFR_BLOCK_DATA
*BlockArray
;
731 IFR_BLOCK_DATA
*BlockSingleData
;
733 BlockSingleData
= *BlockData
;
736 // Insert block data in its Offset and Width order.
738 for (Link
= BlockLink
->ForwardLink
; Link
!= BlockLink
; Link
= Link
->ForwardLink
) {
739 BlockArray
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
740 if (BlockArray
->Offset
== BlockSingleData
->Offset
) {
741 if (BlockArray
->Width
> BlockSingleData
->Width
) {
743 // Insert this block data in the front of block array
745 InsertTailList (Link
, &BlockSingleData
->Entry
);
749 if (BlockArray
->Width
== BlockSingleData
->Width
) {
751 // The same block array has been added.
753 FreePool (BlockSingleData
);
754 *BlockData
= BlockArray
;
757 } else if (BlockArray
->Offset
> BlockSingleData
->Offset
) {
759 // Insert new block data in the front of block array
761 InsertTailList (Link
, &BlockSingleData
->Entry
);
767 // Add new block data into the tail.
769 InsertTailList (Link
, &BlockSingleData
->Entry
);
774 This function checks VarOffset and VarWidth is in the block range.
776 @param BlockArray The block array is to be checked.
777 @param VarOffset Offset of var to the structure
778 @param VarWidth Width of var.
780 @retval TRUE This Var is in the block range.
781 @retval FALSE This Var is not in the block range.
785 IN IFR_BLOCK_DATA
*RequestBlockArray
,
791 IFR_BLOCK_DATA
*BlockData
;
794 // No Request Block array, all vars are got.
796 if (RequestBlockArray
== NULL
) {
801 // Check the input var is in the request block range.
803 for (Link
= RequestBlockArray
->Entry
.ForwardLink
; Link
!= &RequestBlockArray
->Entry
; Link
= Link
->ForwardLink
) {
804 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
805 if ((VarOffset
>= BlockData
->Offset
) && ((VarOffset
+ VarWidth
) <= (BlockData
->Offset
+ BlockData
->Width
))) {
814 This function parses Form Package to get the block array and the default
815 value array according to the request ConfigHdr.
817 @param Package Pointer to the form package data.
818 @param PackageLength Length of the pacakge.
819 @param ConfigHdr Request string ConfigHdr. If it is NULL,
820 the first found varstore will be as ConfigHdr.
821 @param RequestBlockArray The block array is retrieved from the request string.
822 @param VarStorageData VarStorage structure contains the got block and default value.
823 @param PIfrDefaultIdArray Point to the got default id and default name array.
825 @retval EFI_SUCCESS The block array and the default value array are got.
826 @retval EFI_INVALID_PARAMETER The varstore defintion in the differnt form pacakges
828 @retval EFI_OUT_OF_RESOURCES No enough memory.
834 IN UINT32 PackageLenth
,
835 IN EFI_STRING ConfigHdr
,
836 IN IFR_BLOCK_DATA
*RequestBlockArray
,
837 IN OUT IFR_VARSTORAGE_DATA
*VarStorageData
,
838 OUT IFR_DEFAULT_DATA
*DefaultIdArray
843 EFI_IFR_VARSTORE
*IfrVarStore
;
844 EFI_IFR_OP_HEADER
*IfrOpHdr
;
845 EFI_IFR_ONE_OF
*IfrOneOf
;
846 EFI_IFR_ONE_OF_OPTION
*IfrOneOfOption
;
847 EFI_IFR_DEFAULT
*IfrDefault
;
848 EFI_IFR_ORDERED_LIST
*IfrOrderedList
;
849 EFI_IFR_CHECKBOX
*IfrCheckBox
;
850 EFI_IFR_PASSWORD
*IfrPassword
;
851 EFI_IFR_STRING
*IfrString
;
852 IFR_DEFAULT_DATA
*DefaultData
;
853 IFR_BLOCK_DATA
*BlockData
;
854 CHAR16
*VarStoreName
;
857 EFI_STRING_ID VarDefaultName
;
865 Status
= EFI_SUCCESS
;
874 // Go through the form package to parse OpCode one by one.
876 IfrOffset
= sizeof (EFI_HII_PACKAGE_HEADER
);
877 while (IfrOffset
< PackageLenth
) {
878 IfrOpHdr
= (EFI_IFR_OP_HEADER
*) (Package
+ IfrOffset
);
880 switch (IfrOpHdr
->OpCode
) {
881 case EFI_IFR_VARSTORE_OP
:
883 // VarStore is found. Don't need to search any more.
885 if (VarStorageData
->Size
!= 0) {
890 // Get the requied varstore information
891 // Add varstore by Guid and Name in ConfigHdr
892 // Make sure Offset is in varstore size and varstoreid
894 IfrVarStore
= (EFI_IFR_VARSTORE
*) IfrOpHdr
;
895 VarStoreName
= AllocateZeroPool (AsciiStrSize ((CHAR8
*)IfrVarStore
->Name
) * sizeof (CHAR16
));
896 if (VarStoreName
== NULL
) {
897 Status
= EFI_OUT_OF_RESOURCES
;
900 AsciiStrToUnicodeStr ((CHAR8
*) IfrVarStore
->Name
, VarStoreName
);
902 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) &IfrVarStore
->Guid
, 1, &GuidStr
);
903 GenerateSubStr (L
"NAME=", StrLen (VarStoreName
) * sizeof (CHAR16
), (VOID
*) VarStoreName
, 2, &NameStr
);
904 LengthString
= StrLen (GuidStr
);
905 LengthString
= LengthString
+ StrLen (NameStr
) + 1;
906 TempStr
= AllocateZeroPool (LengthString
* sizeof (CHAR16
));
907 if (TempStr
== NULL
) {
910 FreePool (VarStoreName
);
911 Status
= EFI_OUT_OF_RESOURCES
;
914 StrCpy (TempStr
, GuidStr
);
915 StrCat (TempStr
, NameStr
);
916 if (ConfigHdr
== NULL
|| StrnCmp (ConfigHdr
, TempStr
, StrLen (TempStr
)) == 0) {
918 // Find the matched VarStore
920 CopyGuid (&VarStorageData
->Guid
, (EFI_GUID
*) (VOID
*) &IfrVarStore
->Guid
);
921 VarStorageData
->VarStoreId
= IfrVarStore
->VarStoreId
;
922 VarStorageData
->Size
= IfrVarStore
->Size
;
923 VarStorageData
->Name
= VarStoreName
;
926 // No found, free the allocated memory
928 FreePool (VarStoreName
);
931 // Free alllocated temp string.
938 case EFI_IFR_DEFAULTSTORE_OP
:
940 // Add new the map between default id and default name.
942 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
943 if (DefaultData
== NULL
) {
944 Status
= EFI_OUT_OF_RESOURCES
;
947 DefaultData
->DefaultId
= ((EFI_IFR_DEFAULTSTORE
*) IfrOpHdr
)->DefaultId
;
948 DefaultData
->DefaultName
= ((EFI_IFR_DEFAULTSTORE
*) IfrOpHdr
)->DefaultName
;
949 InsertTailList (&DefaultIdArray
->Entry
, &DefaultData
->Entry
);
953 case EFI_IFR_FORM_OP
:
955 // No matched varstore is found and directly return.
957 if (VarStorageData
->Size
== 0) {
958 Status
= EFI_SUCCESS
;
963 case EFI_IFR_ONE_OF_OP
:
964 case EFI_IFR_NUMERIC_OP
:
966 // Numeric and OneOf has the same opcode structure.
970 // Numeric and OneOf question is not in IFR Form. This IFR form is not valid.
972 if (VarStorageData
->Size
== 0) {
973 Status
= EFI_INVALID_PARAMETER
;
977 // Check whether this question is for the requested varstore.
979 IfrOneOf
= (EFI_IFR_ONE_OF
*) IfrOpHdr
;
980 if (IfrOneOf
->Question
.VarStoreId
!= VarStorageData
->VarStoreId
) {
985 // Get Offset/Width by Question header and OneOf Flags
987 VarOffset
= IfrOneOf
->Question
.VarStoreInfo
.VarOffset
;
988 VarWidth
= (UINT16
) (1 << (IfrOneOf
->Flags
& EFI_IFR_NUMERIC_SIZE
));
990 // Check whether this question is in requested block array.
992 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
)) {
994 // This question is not in the requested string. Skip it.
1000 // Check this var question is in the var storage
1002 if ((VarOffset
+ VarWidth
) > VarStorageData
->Size
) {
1003 Status
= EFI_INVALID_PARAMETER
;
1010 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1011 if (BlockData
== NULL
) {
1012 Status
= EFI_OUT_OF_RESOURCES
;
1015 BlockData
->Offset
= VarOffset
;
1016 BlockData
->Width
= VarWidth
;
1017 BlockData
->QuestionId
= IfrOneOf
->Question
.QuestionId
;
1018 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1019 BlockData
->Scope
= IfrOpHdr
->Scope
;
1020 InitializeListHead (&BlockData
->DefaultValueEntry
);
1022 // Add Block Data into VarStorageData BlockEntry
1024 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1027 case EFI_IFR_ORDERED_LIST_OP
:
1029 // offset by question header
1030 // width by EFI_IFR_ORDERED_LIST MaxContainers * OneofOption Type
1031 // no default value and default id, how to define its default value?
1035 // OrderedList question is not in IFR Form. This IFR form is not valid.
1037 if (VarStorageData
->Size
== 0) {
1038 Status
= EFI_INVALID_PARAMETER
;
1042 // Check whether this question is for the requested varstore.
1044 IfrOrderedList
= (EFI_IFR_ORDERED_LIST
*) IfrOpHdr
;
1045 if (IfrOrderedList
->Question
.VarStoreId
!= VarStorageData
->VarStoreId
) {
1050 // Get Offset/Width by Question header and OneOf Flags
1052 VarOffset
= IfrOrderedList
->Question
.VarStoreInfo
.VarOffset
;
1053 VarWidth
= IfrOrderedList
->MaxContainers
;
1056 // Check whether this question is in requested block array.
1058 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
)) {
1060 // This question is not in the requested string. Skip it.
1066 // Check this var question is in the var storage
1068 if ((VarOffset
+ VarWidth
) > VarStorageData
->Size
) {
1069 Status
= EFI_INVALID_PARAMETER
;
1076 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1077 if (BlockData
== NULL
) {
1078 Status
= EFI_OUT_OF_RESOURCES
;
1081 BlockData
->Offset
= VarOffset
;
1082 BlockData
->Width
= VarWidth
;
1083 BlockData
->QuestionId
= IfrOrderedList
->Question
.QuestionId
;
1084 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1085 BlockData
->Scope
= IfrOpHdr
->Scope
;
1086 InitializeListHead (&BlockData
->DefaultValueEntry
);
1089 // Add Block Data into VarStorageData BlockEntry
1091 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1094 case EFI_IFR_CHECKBOX_OP
:
1096 // EFI_IFR_DEFAULT_OP
1097 // offset by question header
1098 // width is 1 sizeof (BOOLEAN)
1099 // default id by CheckBox Flags if CheckBox flags (Default or Mau) is set, the default value is 1 to be set.
1100 // value by DefaultOption
1101 // default id by DeaultOption DefaultId can override CheckBox Flags and Default value.
1105 // CheckBox question is not in IFR Form. This IFR form is not valid.
1107 if (VarStorageData
->Size
== 0) {
1108 Status
= EFI_INVALID_PARAMETER
;
1112 // Check whether this question is for the requested varstore.
1114 IfrCheckBox
= (EFI_IFR_CHECKBOX
*) IfrOpHdr
;
1115 if (IfrCheckBox
->Question
.VarStoreId
!= VarStorageData
->VarStoreId
) {
1120 // Get Offset/Width by Question header and OneOf Flags
1122 VarOffset
= IfrCheckBox
->Question
.VarStoreInfo
.VarOffset
;
1123 VarWidth
= sizeof (BOOLEAN
);
1126 // Check whether this question is in requested block array.
1128 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
)) {
1130 // This question is not in the requested string. Skip it.
1136 // Check this var question is in the var storage
1138 if ((VarOffset
+ VarWidth
) > VarStorageData
->Size
) {
1139 Status
= EFI_INVALID_PARAMETER
;
1146 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1147 if (BlockData
== NULL
) {
1148 Status
= EFI_OUT_OF_RESOURCES
;
1151 BlockData
->Offset
= VarOffset
;
1152 BlockData
->Width
= VarWidth
;
1153 BlockData
->QuestionId
= IfrCheckBox
->Question
.QuestionId
;
1154 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1155 BlockData
->Scope
= IfrOpHdr
->Scope
;
1156 InitializeListHead (&BlockData
->DefaultValueEntry
);
1158 // Add Block Data into VarStorageData BlockEntry
1160 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1163 // Add default value by CheckBox Flags
1165 if ((IfrCheckBox
->Flags
& EFI_IFR_CHECKBOX_DEFAULT
) == EFI_IFR_CHECKBOX_DEFAULT
) {
1167 // Set standard ID to Manufacture ID and Get DefaultName String ID
1169 VarDefaultId
= EFI_HII_DEFAULT_CLASS_STANDARD
;
1170 Status
= FindDefaultName (DefaultIdArray
, VarDefaultId
, &VarDefaultName
);
1171 if (EFI_ERROR (Status
)) {
1175 // Prepare new DefaultValue
1177 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1178 if (DefaultData
== NULL
) {
1179 Status
= EFI_OUT_OF_RESOURCES
;
1182 DefaultData
->OpCode
= IfrOpHdr
->OpCode
;
1183 DefaultData
->DefaultId
= VarDefaultId
;
1184 DefaultData
->DefaultName
= VarDefaultName
;
1185 DefaultData
->Value
= 1;
1187 // Add DefaultValue into current BlockData
1189 InsertDefaultValue (BlockData
, DefaultData
);
1192 if ((IfrCheckBox
->Flags
& EFI_IFR_CHECKBOX_DEFAULT_MFG
) == EFI_IFR_CHECKBOX_DEFAULT_MFG
) {
1194 // Set standard ID to Manufacture ID and Get DefaultName String ID
1196 VarDefaultId
= EFI_HII_DEFAULT_CLASS_MANUFACTURING
;
1197 Status
= FindDefaultName (DefaultIdArray
, VarDefaultId
, &VarDefaultName
);
1198 if (EFI_ERROR (Status
)) {
1202 // Prepare new DefaultValue
1204 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1205 if (DefaultData
== NULL
) {
1206 Status
= EFI_OUT_OF_RESOURCES
;
1209 DefaultData
->OpCode
= IfrOpHdr
->OpCode
;
1210 DefaultData
->DefaultId
= VarDefaultId
;
1211 DefaultData
->DefaultName
= VarDefaultName
;
1212 DefaultData
->Value
= 1;
1214 // Add DefaultValue into current BlockData
1216 InsertDefaultValue (BlockData
, DefaultData
);
1220 case EFI_IFR_STRING_OP
:
1222 // offset by question header
1223 // width MaxSize * sizeof (CHAR16)
1224 // no default value, only block array
1228 // String question is not in IFR Form. This IFR form is not valid.
1230 if (VarStorageData
->Size
== 0) {
1231 Status
= EFI_INVALID_PARAMETER
;
1235 // Check whether this question is for the requested varstore.
1237 IfrString
= (EFI_IFR_STRING
*) IfrOpHdr
;
1238 if (IfrString
->Question
.VarStoreId
!= VarStorageData
->VarStoreId
) {
1243 // Get Offset/Width by Question header and OneOf Flags
1245 VarOffset
= IfrString
->Question
.VarStoreInfo
.VarOffset
;
1246 VarWidth
= (UINT16
) (IfrString
->MaxSize
* sizeof (UINT16
));
1249 // Check whether this question is in requested block array.
1251 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
)) {
1253 // This question is not in the requested string. Skip it.
1259 // Check this var question is in the var storage
1261 if ((VarOffset
+ VarWidth
) > VarStorageData
->Size
) {
1262 Status
= EFI_INVALID_PARAMETER
;
1269 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1270 if (BlockData
== NULL
) {
1271 Status
= EFI_OUT_OF_RESOURCES
;
1274 BlockData
->Offset
= VarOffset
;
1275 BlockData
->Width
= VarWidth
;
1276 BlockData
->QuestionId
= IfrString
->Question
.QuestionId
;
1277 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1278 InitializeListHead (&BlockData
->DefaultValueEntry
);
1281 // Add Block Data into VarStorageData BlockEntry
1283 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1286 // No default value for string.
1291 case EFI_IFR_PASSWORD_OP
:
1293 // offset by question header
1294 // width MaxSize * sizeof (CHAR16)
1295 // no default value, only block array
1299 // Password question is not in IFR Form. This IFR form is not valid.
1301 if (VarStorageData
->Size
== 0) {
1302 Status
= EFI_INVALID_PARAMETER
;
1306 // Check whether this question is for the requested varstore.
1308 IfrPassword
= (EFI_IFR_PASSWORD
*) IfrOpHdr
;
1309 if (IfrPassword
->Question
.VarStoreId
!= VarStorageData
->VarStoreId
) {
1314 // Get Offset/Width by Question header and OneOf Flags
1316 VarOffset
= IfrPassword
->Question
.VarStoreInfo
.VarOffset
;
1317 VarWidth
= (UINT16
) (IfrPassword
->MaxSize
* sizeof (UINT16
));
1320 // Check whether this question is in requested block array.
1322 if (!BlockArrayCheck (RequestBlockArray
, VarOffset
, VarWidth
)) {
1324 // This question is not in the requested string. Skip it.
1330 // Check this var question is in the var storage
1332 if ((VarOffset
+ VarWidth
) > VarStorageData
->Size
) {
1333 Status
= EFI_INVALID_PARAMETER
;
1340 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1341 if (BlockData
== NULL
) {
1342 Status
= EFI_OUT_OF_RESOURCES
;
1345 BlockData
->Offset
= VarOffset
;
1346 BlockData
->Width
= VarWidth
;
1347 BlockData
->QuestionId
= IfrPassword
->Question
.QuestionId
;
1348 BlockData
->OpCode
= IfrOpHdr
->OpCode
;
1349 InitializeListHead (&BlockData
->DefaultValueEntry
);
1352 // Add Block Data into VarStorageData BlockEntry
1354 InsertBlockData (&VarStorageData
->BlockEntry
, &BlockData
);
1357 // No default value for string.
1362 case EFI_IFR_ONE_OF_OPTION_OP
:
1364 // No matched block data is ignored.
1366 if (BlockData
== NULL
|| BlockData
->Scope
== 0) {
1370 IfrOneOfOption
= (EFI_IFR_ONE_OF_OPTION
*) IfrOpHdr
;
1371 if (BlockData
->OpCode
== EFI_IFR_ORDERED_LIST_OP
) {
1373 // Get ordered list option data type.
1375 if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_8
|| IfrOneOfOption
->Type
== EFI_IFR_TYPE_BOOLEAN
) {
1377 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_16
) {
1379 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_32
) {
1381 } else if (IfrOneOfOption
->Type
== EFI_IFR_TYPE_NUM_SIZE_64
) {
1385 // Invalid ordered list option data type.
1387 Status
= EFI_INVALID_PARAMETER
;
1391 // Calculate Ordered list QuestionId width.
1393 BlockData
->Width
= (UINT16
) (BlockData
->Width
* VarWidth
);
1398 if ((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT
) == EFI_IFR_OPTION_DEFAULT
) {
1400 // Set standard ID to Manufacture ID and Get DefaultName String ID
1402 VarDefaultId
= EFI_HII_DEFAULT_CLASS_STANDARD
;
1403 Status
= FindDefaultName (DefaultIdArray
, VarDefaultId
, &VarDefaultName
);
1404 if (EFI_ERROR (Status
)) {
1408 // Prepare new DefaultValue
1410 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1411 if (DefaultData
== NULL
) {
1412 Status
= EFI_OUT_OF_RESOURCES
;
1415 DefaultData
->OpCode
= IfrOpHdr
->OpCode
;
1416 DefaultData
->DefaultId
= VarDefaultId
;
1417 DefaultData
->DefaultName
= VarDefaultName
;
1418 DefaultData
->Value
= IfrOneOfOption
->Value
.u64
;
1420 // Add DefaultValue into current BlockData
1422 InsertDefaultValue (BlockData
, DefaultData
);
1425 if ((IfrOneOfOption
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) == EFI_IFR_OPTION_DEFAULT_MFG
) {
1427 // Set default ID to Manufacture ID and Get DefaultName String ID
1429 VarDefaultId
= EFI_HII_DEFAULT_CLASS_MANUFACTURING
;
1430 Status
= FindDefaultName (DefaultIdArray
, VarDefaultId
, &VarDefaultName
);
1431 if (EFI_ERROR (Status
)) {
1435 // Prepare new DefaultValue
1437 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1438 if (DefaultData
== NULL
) {
1439 Status
= EFI_OUT_OF_RESOURCES
;
1442 DefaultData
->OpCode
= IfrOpHdr
->OpCode
;
1443 DefaultData
->DefaultId
= VarDefaultId
;
1444 DefaultData
->DefaultName
= VarDefaultName
;
1445 DefaultData
->Value
= IfrOneOfOption
->Value
.u64
;
1447 // Add DefaultValue into current BlockData
1449 InsertDefaultValue (BlockData
, DefaultData
);
1453 case EFI_IFR_DEFAULT_OP
:
1455 // Update Current BlockData to the default value.
1457 if (BlockData
== NULL
|| BlockData
->Scope
== 0) {
1459 // No matched block data is ignored.
1464 if (BlockData
->OpCode
== EFI_IFR_ORDERED_LIST_OP
) {
1466 // OrderedList Opcode is no default value.
1471 // Get the DefaultId and DefaultName String ID
1473 IfrDefault
= (EFI_IFR_DEFAULT
*) IfrOpHdr
;
1474 VarDefaultId
= IfrDefault
->DefaultId
;
1475 Status
= FindDefaultName (DefaultIdArray
, VarDefaultId
, &VarDefaultName
);
1476 if (EFI_ERROR (Status
)) {
1480 // Prepare new DefaultValue
1482 DefaultData
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1483 if (DefaultData
== NULL
) {
1484 Status
= EFI_OUT_OF_RESOURCES
;
1487 DefaultData
->OpCode
= IfrOpHdr
->OpCode
;
1488 DefaultData
->DefaultId
= VarDefaultId
;
1489 DefaultData
->DefaultName
= VarDefaultName
;
1490 DefaultData
->Value
= IfrDefault
->Value
.u64
;
1492 // Add DefaultValue into current BlockData
1494 InsertDefaultValue (BlockData
, DefaultData
);
1496 case EFI_IFR_END_OP
:
1498 // End Opcode is for Var question.
1500 if (BlockData
!= NULL
&& BlockData
->Scope
> 0) {
1505 if (BlockData
!= NULL
&& BlockData
->Scope
> 0) {
1506 BlockData
->Scope
= (UINT8
) (BlockData
->Scope
+ IfrOpHdr
->Scope
);
1511 IfrOffset
+= IfrOpHdr
->Length
;
1519 This function gets the full request string and full default value string by
1520 parsing IFR data in HII form packages.
1522 When Request points to NULL string, the request string and default value string
1523 for each varstore in form package will return.
1525 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
1526 @param DevicePath Device Path which Hii Config Access Protocol is registered.
1527 @param Request Pointer to a null-terminated Unicode string in
1528 <ConfigRequest> format. When it doesn't contain
1529 any RequestElement, it will be updated to return
1530 the full RequestElement retrieved from IFR data.
1531 If it points to NULL, the request string for the first
1532 varstore in form package will be merged into a
1533 <MultiConfigRequest> format string and return.
1534 @param AltCfgResp Pointer to a null-terminated Unicode string in
1535 <ConfigAltResp> format. When the pointer is to NULL,
1536 the full default value string retrieved from IFR data
1537 will return. When the pinter is to a string, the
1538 full default value string retrieved from IFR data
1539 will be merged into the input string and return.
1540 When Request points to NULL, the default value string
1541 for each varstore in form package will be merged into
1542 a <MultiConfigAltResp> format string and return.
1543 @param PointerProgress Optional parameter, it can be be NULL.
1544 When it is not NULL, if Request is NULL, it returns NULL.
1545 On return, points to a character in the Request
1546 string. Points to the string's null terminator if
1547 request was successful. Points to the most recent
1548 & before the first failing name / value pair (or
1549 the beginning of the string if the failure is in
1550 the first name / value pair) if the request was
1552 @retval EFI_SUCCESS The Results string is set to the full request string.
1553 And AltCfgResp contains all default value string.
1554 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
1555 @retval EFI_NOT_FOUND The varstore (Guid and Name) in Request string
1556 can't be found in Form package.
1557 @retval EFI_NOT_FOUND HiiPackage can't be got on the input HiiHandle.
1558 @retval EFI_INVALID_PARAMETER Request points to NULL.
1563 GetFullStringFromHiiFormPackages (
1564 IN HII_DATABASE_RECORD
*DataBaseRecord
,
1565 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1566 IN OUT EFI_STRING
*Request
,
1567 IN OUT EFI_STRING
*AltCfgResp
,
1568 OUT EFI_STRING
*PointerProgress OPTIONAL
1572 UINT8
*HiiFormPackage
;
1575 IFR_BLOCK_DATA
*RequestBlockArray
;
1576 IFR_BLOCK_DATA
*BlockData
;
1577 IFR_BLOCK_DATA
*NextBlockData
;
1578 IFR_DEFAULT_DATA
*DefaultValueData
;
1579 IFR_DEFAULT_DATA
*DefaultId
;
1580 IFR_DEFAULT_DATA
*DefaultIdArray
;
1581 IFR_VARSTORAGE_DATA
*VarStorageData
;
1582 EFI_STRING DefaultAltCfgResp
;
1583 EFI_STRING FullConfigRequest
;
1584 EFI_STRING ConfigHdr
;
1588 EFI_STRING StringPtr
;
1589 EFI_STRING Progress
;
1595 LIST_ENTRY
*LinkData
;
1596 LIST_ENTRY
*LinkDefault
;
1599 if (DataBaseRecord
== NULL
|| DevicePath
== NULL
|| Request
== NULL
|| AltCfgResp
== NULL
) {
1600 return EFI_INVALID_PARAMETER
;
1604 // Initialize the local variables.
1606 RequestBlockArray
= NULL
;
1607 DefaultIdArray
= NULL
;
1608 VarStorageData
= NULL
;
1609 DefaultAltCfgResp
= NULL
;
1610 FullConfigRequest
= NULL
;
1615 HiiFormPackage
= NULL
;
1619 Progress
= *Request
;
1622 // 0. Get Hii Form Package by HiiHandle
1624 Status
= ExportFormPackages (
1626 DataBaseRecord
->Handle
,
1627 DataBaseRecord
->PackageList
,
1633 if (EFI_ERROR (Status
)) {
1637 HiiFormPackage
= AllocatePool (ResultSize
);
1638 if (HiiFormPackage
== NULL
) {
1639 Status
= EFI_OUT_OF_RESOURCES
;
1644 // Get HiiFormPackage by HiiHandle
1646 PackageSize
= ResultSize
;
1648 Status
= ExportFormPackages (
1650 DataBaseRecord
->Handle
,
1651 DataBaseRecord
->PackageList
,
1657 if (EFI_ERROR (Status
)) {
1662 // 1. Get the request block array by Request String when Request string containts the block array.
1665 if (*Request
!= NULL
) {
1666 StringPtr
= *Request
;
1670 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
1671 Status
= EFI_INVALID_PARAMETER
;
1674 StringPtr
+= StrLen (L
"GUID=");
1675 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&NAME=", StrLen (L
"&NAME=")) != 0) {
1678 if (*StringPtr
== L
'\0') {
1679 Status
= EFI_INVALID_PARAMETER
;
1682 StringPtr
+= StrLen (L
"&NAME=");
1683 while (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&PATH=", StrLen (L
"&PATH=")) != 0) {
1686 if (*StringPtr
== L
'\0') {
1687 Status
= EFI_INVALID_PARAMETER
;
1690 StringPtr
+= StrLen (L
"&PATH=");
1691 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
1695 // Check the following string &OFFSET=
1697 if (*StringPtr
!= L
'\0' && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) != 0) {
1698 Progress
= StringPtr
;
1699 Status
= EFI_INVALID_PARAMETER
;
1701 } else if (*StringPtr
== L
'\0') {
1703 // No request block is found.
1708 if (StringPtr
!= NULL
) {
1710 // Init RequestBlockArray
1712 RequestBlockArray
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1713 if (RequestBlockArray
== NULL
) {
1714 Status
= EFI_OUT_OF_RESOURCES
;
1717 InitializeListHead (&RequestBlockArray
->Entry
);
1720 // Get the request Block array from the request string
1725 // Parse each <RequestElement> if exists
1726 // Only <BlockName> format is supported by this help function.
1727 // <BlockName> ::= &'OFFSET='<Number>&'WIDTH='<Number>
1729 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"&OFFSET=", StrLen (L
"&OFFSET=")) == 0) {
1731 // Skip the OFFSET string
1733 Progress
= StringPtr
;
1734 StringPtr
+= StrLen (L
"&OFFSET=");
1738 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1739 if (EFI_ERROR (Status
)) {
1746 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
1748 FreePool (TmpBuffer
);
1750 StringPtr
+= Length
;
1751 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
1752 Status
= EFI_INVALID_PARAMETER
;
1755 StringPtr
+= StrLen (L
"&WIDTH=");
1760 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1761 if (EFI_ERROR (Status
)) {
1768 (((Length
+ 1) / 2) < sizeof (UINT16
)) ? ((Length
+ 1) / 2) : sizeof (UINT16
)
1770 FreePool (TmpBuffer
);
1772 StringPtr
+= Length
;
1773 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
1774 Status
= EFI_INVALID_PARAMETER
;
1781 BlockData
= (IFR_BLOCK_DATA
*) AllocateZeroPool (sizeof (IFR_BLOCK_DATA
));
1782 if (BlockData
== NULL
) {
1783 Status
= EFI_OUT_OF_RESOURCES
;
1786 BlockData
->Offset
= Offset
;
1787 BlockData
->Width
= Width
;
1788 InsertBlockData (&RequestBlockArray
->Entry
, &BlockData
);
1791 // Skip &VALUE string if &VALUE does exists.
1793 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) == 0) {
1794 StringPtr
+= StrLen (L
"&VALUE=");
1799 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
1800 if (EFI_ERROR (Status
)) {
1801 Status
= EFI_INVALID_PARAMETER
;
1805 StringPtr
+= Length
;
1806 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
1807 Status
= EFI_INVALID_PARAMETER
;
1812 // If '\0', parsing is finished.
1814 if (*StringPtr
== 0) {
1820 // Merge the requested block data.
1822 Link
= RequestBlockArray
->Entry
.ForwardLink
;
1823 while ((Link
!= &RequestBlockArray
->Entry
) && (Link
->ForwardLink
!= &RequestBlockArray
->Entry
)) {
1824 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
1825 NextBlockData
= BASE_CR (Link
->ForwardLink
, IFR_BLOCK_DATA
, Entry
);
1826 if ((NextBlockData
->Offset
>= BlockData
->Offset
) && (NextBlockData
->Offset
<= (BlockData
->Offset
+ BlockData
->Width
))) {
1827 if ((NextBlockData
->Offset
+ NextBlockData
->Width
) > (BlockData
->Offset
+ BlockData
->Width
)) {
1828 BlockData
->Width
= (UINT16
) (NextBlockData
->Offset
+ NextBlockData
->Width
- BlockData
->Offset
);
1830 RemoveEntryList (Link
->ForwardLink
);
1831 FreePool (NextBlockData
);
1834 Link
= Link
->ForwardLink
;
1839 // 2. Parse FormPackage to get BlockArray and DefaultId Array for the request BlockArray.
1843 // Initialize DefaultIdArray to store the map between DeaultId and DefaultName
1845 DefaultIdArray
= (IFR_DEFAULT_DATA
*) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA
));
1846 if (DefaultIdArray
== NULL
) {
1847 Status
= EFI_OUT_OF_RESOURCES
;
1850 InitializeListHead (&DefaultIdArray
->Entry
);
1853 // Initialize VarStorageData to store the var store Block and Default value information.
1855 VarStorageData
= (IFR_VARSTORAGE_DATA
*) AllocateZeroPool (sizeof (IFR_VARSTORAGE_DATA
));
1856 if (VarStorageData
== NULL
) {
1857 Status
= EFI_OUT_OF_RESOURCES
;
1860 InitializeListHead (&VarStorageData
->Entry
);
1861 InitializeListHead (&VarStorageData
->BlockEntry
);
1864 // Parse the opcode in form pacakge to get the default setting.
1866 Status
= ParseIfrData (HiiFormPackage
, (UINT32
) PackageSize
, *Request
, RequestBlockArray
, VarStorageData
, DefaultIdArray
);
1867 if (EFI_ERROR (Status
)) {
1872 // No requested varstore in IFR data and directly return
1874 if (VarStorageData
->Size
== 0) {
1875 Status
= EFI_SUCCESS
;
1880 // 3. Construct Request Element (Block Name) for 2.1 and 2.2 case.
1884 // Construct <ConfigHdr> : "GUID=...&NAME=...&PATH=..." by VarStorageData Guid, Name and DriverHandle
1886 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) &VarStorageData
->Guid
, 1, &GuidStr
);
1887 GenerateSubStr (L
"NAME=", StrLen (VarStorageData
->Name
) * sizeof (CHAR16
), (VOID
*) VarStorageData
->Name
, 2, &NameStr
);
1890 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
1891 (VOID
*) DevicePath
,
1895 Length
= StrLen (GuidStr
);
1896 Length
= Length
+ StrLen (NameStr
);
1897 Length
= Length
+ StrLen (PathStr
) + 1;
1898 ConfigHdr
= AllocateZeroPool (Length
* sizeof (CHAR16
));
1899 if (ConfigHdr
== NULL
) {
1900 Status
= EFI_OUT_OF_RESOURCES
;
1903 StrCpy (ConfigHdr
, GuidStr
);
1904 StrCat (ConfigHdr
, NameStr
);
1905 StrCat (ConfigHdr
, PathStr
);
1908 // Remove the last character L'&'
1910 *(ConfigHdr
+ StrLen (ConfigHdr
) - 1) = L
'\0';
1912 if (RequestBlockArray
== NULL
) {
1914 // Append VarStorageData BlockEntry into *Request string
1915 // Now support only one varstore in a form package.
1919 // Go through all VarStorageData Entry and get BlockEntry for each one for the multiple varstore in a single form package
1920 // Then construct them all to return MultiRequest string : ConfigHdr BlockConfig
1924 // Compute the length of the entire request starting with <ConfigHdr> and a
1928 Length
= StrLen (ConfigHdr
) + 1;
1930 for (Link
= VarStorageData
->BlockEntry
.ForwardLink
; Link
!= &VarStorageData
->BlockEntry
; Link
= Link
->ForwardLink
) {
1932 // Add <BlockName> length for each Offset/Width pair
1934 // <BlockName> ::= &OFFSET=1234&WIDTH=1234
1935 // | 8 | 4 | 7 | 4 |
1938 Length
= Length
+ (8 + 4 + 7 + 4);
1942 // No any request block data is found. The request string can't be constructed.
1945 Status
= EFI_SUCCESS
;
1950 // Allocate buffer for the entire <ConfigRequest>
1952 FullConfigRequest
= AllocateZeroPool (Length
* sizeof (CHAR16
));
1953 if (FullConfigRequest
== NULL
) {
1954 Status
= EFI_OUT_OF_RESOURCES
;
1957 StringPtr
= FullConfigRequest
;
1960 // Start with <ConfigHdr>
1962 StrCpy (StringPtr
, ConfigHdr
);
1963 StringPtr
+= StrLen (StringPtr
);
1966 // Loop through all the Offset/Width pairs and append them to ConfigRequest
1968 for (Link
= VarStorageData
->BlockEntry
.ForwardLink
; Link
!= &VarStorageData
->BlockEntry
; Link
= Link
->ForwardLink
) {
1969 BlockData
= BASE_CR (Link
, IFR_BLOCK_DATA
, Entry
);
1971 // Append &OFFSET=XXXX&WIDTH=YYYY\0
1975 (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16
),
1976 L
"&OFFSET=%04X&WIDTH=%04X",
1980 StringPtr
+= StrLen (StringPtr
);
1983 // Set to the got full request string.
1985 HiiToLower (FullConfigRequest
);
1986 if (*Request
!= NULL
) {
1987 FreePool (*Request
);
1989 *Request
= FullConfigRequest
;
1993 // 4. Construct Default Value string in AltResp according to request element.
1994 // Go through all VarStorageData Entry and get the DefaultId array for each one
1995 // Then construct them all to : ConfigHdr AltConfigHdr ConfigBody AltConfigHdr ConfigBody
1999 // Add length for <ConfigHdr> + '\0'
2001 Length
= StrLen (ConfigHdr
) + 1;
2003 for (Link
= DefaultIdArray
->Entry
.ForwardLink
; Link
!= &DefaultIdArray
->Entry
; Link
= Link
->ForwardLink
) {
2004 DefaultId
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
2006 // Add length for "&<ConfigHdr>&ALTCFG=XXXX"
2007 // |1| StrLen (ConfigHdr) | 8 | 4 |
2009 Length
+= (1 + StrLen (ConfigHdr
) + 8 + 4);
2011 for (LinkData
= VarStorageData
->BlockEntry
.ForwardLink
; LinkData
!= &VarStorageData
->BlockEntry
; LinkData
= LinkData
->ForwardLink
) {
2012 BlockData
= BASE_CR (LinkData
, IFR_BLOCK_DATA
, Entry
);
2013 for (LinkDefault
= BlockData
->DefaultValueEntry
.ForwardLink
; LinkDefault
!= &BlockData
->DefaultValueEntry
; LinkDefault
= LinkDefault
->ForwardLink
) {
2014 DefaultValueData
= BASE_CR (LinkDefault
, IFR_DEFAULT_DATA
, Entry
);
2015 if (DefaultValueData
->DefaultId
== DefaultId
->DefaultId
) {
2017 // Add length for "&OFFSET=XXXX&WIDTH=YYYY&VALUE=zzzzzzzzzzzz"
2018 // | 8 | 4 | 7 | 4 | 7 | Width * 2 |
2020 Length
+= (8 + 4 + 7 + 4 + 7 + BlockData
->Width
* 2);
2028 // No default value is found. The default string doesn't exist.
2031 Status
= EFI_SUCCESS
;
2036 // Allocate buffer for the entire <DefaultAltCfgResp>
2038 DefaultAltCfgResp
= AllocateZeroPool (Length
* sizeof (CHAR16
));
2039 if (DefaultAltCfgResp
== NULL
) {
2040 Status
= EFI_OUT_OF_RESOURCES
;
2043 StringPtr
= DefaultAltCfgResp
;
2046 // Start with <ConfigHdr>
2048 StrCpy (StringPtr
, ConfigHdr
);
2049 StringPtr
+= StrLen (StringPtr
);
2051 for (Link
= DefaultIdArray
->Entry
.ForwardLink
; Link
!= &DefaultIdArray
->Entry
; Link
= Link
->ForwardLink
) {
2052 DefaultId
= BASE_CR (Link
, IFR_DEFAULT_DATA
, Entry
);
2054 // Add <AltConfigHdr> of the form "&<ConfigHdr>&ALTCFG=XXXX\0"
2055 // |1| StrLen (ConfigHdr) | 8 | 4 |
2059 (1 + StrLen (ConfigHdr
) + 8 + 4 + 1) * sizeof (CHAR16
),
2062 DefaultId
->DefaultName
2064 StringPtr
+= StrLen (StringPtr
);
2066 for (LinkData
= VarStorageData
->BlockEntry
.ForwardLink
; LinkData
!= &VarStorageData
->BlockEntry
; LinkData
= LinkData
->ForwardLink
) {
2067 BlockData
= BASE_CR (LinkData
, IFR_BLOCK_DATA
, Entry
);
2068 for (LinkDefault
= BlockData
->DefaultValueEntry
.ForwardLink
; LinkDefault
!= &BlockData
->DefaultValueEntry
; LinkDefault
= LinkDefault
->ForwardLink
) {
2069 DefaultValueData
= BASE_CR (LinkDefault
, IFR_DEFAULT_DATA
, Entry
);
2070 if (DefaultValueData
->DefaultId
== DefaultId
->DefaultId
) {
2072 // Add <BlockConfig>
2073 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
2077 (8 + 4 + 7 + 4 + 7 + 1) * sizeof (CHAR16
),
2078 L
"&OFFSET=%04X&WIDTH=%04X&VALUE=",
2082 StringPtr
+= StrLen (StringPtr
);
2085 // Convert Value to a hex string in "%x" format
2086 // NOTE: This is in the opposite byte that GUID and PATH use
2088 Width
= BlockData
->Width
;
2089 TmpBuffer
= (UINT8
*) &(DefaultValueData
->Value
);
2090 for (; Width
> 0; Width
--) {
2091 StringPtr
+= UnicodeValueToString (StringPtr
, PREFIX_ZERO
| RADIX_HEX
, TmpBuffer
[Width
- 1], 2);
2097 HiiToLower (DefaultAltCfgResp
);
2100 // 5. Merge string into the input AltCfgResp if the iput *AltCfgResp is not NULL.
2102 if (*AltCfgResp
!= NULL
&& DefaultAltCfgResp
!= NULL
) {
2103 Status
= MergeDefaultString (AltCfgResp
, DefaultAltCfgResp
);
2104 FreePool (DefaultAltCfgResp
);
2105 } else if (*AltCfgResp
== NULL
) {
2106 *AltCfgResp
= DefaultAltCfgResp
;
2110 if (RequestBlockArray
!= NULL
) {
2112 // Free Link Array RequestBlockArray
2114 while (!IsListEmpty (&RequestBlockArray
->Entry
)) {
2115 BlockData
= BASE_CR (RequestBlockArray
->Entry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2116 RemoveEntryList (&BlockData
->Entry
);
2117 FreePool (BlockData
);
2120 FreePool (RequestBlockArray
);
2123 if (VarStorageData
!= NULL
) {
2125 // Free link array VarStorageData
2127 while (!IsListEmpty (&VarStorageData
->BlockEntry
)) {
2128 BlockData
= BASE_CR (VarStorageData
->BlockEntry
.ForwardLink
, IFR_BLOCK_DATA
, Entry
);
2129 RemoveEntryList (&BlockData
->Entry
);
2131 // Free default value link array
2133 while (!IsListEmpty (&BlockData
->DefaultValueEntry
)) {
2134 DefaultValueData
= BASE_CR (BlockData
->DefaultValueEntry
.ForwardLink
, IFR_DEFAULT_DATA
, Entry
);
2135 RemoveEntryList (&DefaultValueData
->Entry
);
2136 FreePool (DefaultValueData
);
2138 FreePool (BlockData
);
2140 FreePool (VarStorageData
);
2143 if (DefaultIdArray
!= NULL
) {
2145 // Free DefaultId Array
2147 while (!IsListEmpty (&DefaultIdArray
->Entry
)) {
2148 DefaultId
= BASE_CR (DefaultIdArray
->Entry
.ForwardLink
, IFR_DEFAULT_DATA
, Entry
);
2149 RemoveEntryList (&DefaultId
->Entry
);
2150 FreePool (DefaultId
);
2152 FreePool (DefaultIdArray
);
2156 // Free the allocated string
2158 if (GuidStr
!= NULL
) {
2161 if (NameStr
!= NULL
) {
2164 if (PathStr
!= NULL
) {
2167 if (ConfigHdr
!= NULL
) {
2168 FreePool (ConfigHdr
);
2172 // Free Pacakge data
2174 if (HiiFormPackage
!= NULL
) {
2175 FreePool (HiiFormPackage
);
2178 if (PointerProgress
!= NULL
) {
2179 if (*Request
== NULL
) {
2180 *PointerProgress
= NULL
;
2181 } else if (EFI_ERROR (Status
)) {
2182 *PointerProgress
= Progress
;
2184 *PointerProgress
= *Request
+ StrLen (*Request
);
2192 This function allows a caller to extract the current configuration
2193 for one or more named elements from one or more drivers.
2195 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
2197 @param Request A null-terminated Unicode string in
2198 <MultiConfigRequest> format.
2199 @param Progress On return, points to a character in the Request
2200 string. Points to the string's null terminator if
2201 request was successful. Points to the most recent
2202 & before the first failing name / value pair (or
2203 the beginning of the string if the failure is in
2204 the first name / value pair) if the request was
2206 @param Results Null-terminated Unicode string in
2207 <MultiConfigAltResp> format which has all values
2208 filled in for the names in the Request string.
2209 String to be allocated by the called function.
2211 @retval EFI_SUCCESS The Results string is filled with the values
2212 corresponding to all requested names.
2213 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
2214 results that must be stored awaiting possible
2216 @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
2217 Progress set to the "G" in "GUID" of the routing
2218 header that doesn't match. Note: There is no
2219 requirement that all routing data be validated
2220 before any configuration extraction.
2221 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
2222 parameter would result in this type of error. The
2223 Progress parameter is set to NULL.
2224 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
2225 before the error or the beginning of the string.
2226 @retval EFI_INVALID_PARAMETER Unknown name. Progress points to the & before the
2232 HiiConfigRoutingExtractConfig (
2233 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
2234 IN CONST EFI_STRING Request
,
2235 OUT EFI_STRING
*Progress
,
2236 OUT EFI_STRING
*Results
2239 HII_DATABASE_PRIVATE_DATA
*Private
;
2240 EFI_STRING StringPtr
;
2241 EFI_STRING ConfigRequest
;
2243 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2244 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2247 HII_DATABASE_RECORD
*Database
;
2248 UINT8
*DevicePathPkg
;
2249 UINT8
*CurrentDevicePath
;
2250 EFI_HANDLE DriverHandle
;
2251 EFI_HII_HANDLE HiiHandle
;
2252 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2253 EFI_STRING AccessProgress
;
2254 EFI_STRING AccessResults
;
2255 EFI_STRING DefaultResults
;
2256 BOOLEAN FirstElement
;
2257 BOOLEAN IfrDataParsedFlag
;
2259 if (This
== NULL
|| Progress
== NULL
|| Results
== NULL
) {
2260 return EFI_INVALID_PARAMETER
;
2263 if (Request
== NULL
) {
2265 return EFI_INVALID_PARAMETER
;
2268 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2269 StringPtr
= Request
;
2270 *Progress
= StringPtr
;
2271 DefaultResults
= NULL
;
2272 ConfigRequest
= NULL
;
2273 Status
= EFI_SUCCESS
;
2274 AccessResults
= NULL
;
2276 IfrDataParsedFlag
= FALSE
;
2279 // The first element of <MultiConfigRequest> should be
2280 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
2282 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
2283 return EFI_INVALID_PARAMETER
;
2286 FirstElement
= TRUE
;
2289 // Allocate a fix length of memory to store Results. Reallocate memory for
2290 // Results if this fix length is insufficient.
2292 *Results
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
2293 if (*Results
== NULL
) {
2294 return EFI_OUT_OF_RESOURCES
;
2297 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) == 0) {
2299 // If parsing error, set Progress to the beginning of the <MultiConfigRequest>
2300 // or most recent & before the error.
2302 if (StringPtr
== Request
) {
2303 *Progress
= StringPtr
;
2305 *Progress
= StringPtr
- 1;
2309 // Process each <ConfigRequest> of <MultiConfigRequest>
2311 Length
= CalculateConfigStringLen (StringPtr
);
2312 ConfigRequest
= AllocateCopyPool ((Length
+ 1) * sizeof (CHAR16
), StringPtr
);
2313 if (ConfigRequest
== NULL
) {
2314 Status
= EFI_OUT_OF_RESOURCES
;
2317 *(ConfigRequest
+ Length
) = 0;
2320 // Get the UEFI device path
2322 Status
= GetDevicePath (ConfigRequest
, (UINT8
**) &DevicePath
);
2323 if (EFI_ERROR (Status
)) {
2328 // Find driver which matches the routing data.
2330 DriverHandle
= NULL
;
2333 for (Link
= Private
->DatabaseList
.ForwardLink
;
2334 Link
!= &Private
->DatabaseList
;
2335 Link
= Link
->ForwardLink
2337 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2338 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
2339 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
2343 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
)
2345 DriverHandle
= Database
->DriverHandle
;
2346 HiiHandle
= Database
->Handle
;
2353 // Try to find driver handle by device path.
2355 if (DriverHandle
== NULL
) {
2356 TempDevicePath
= DevicePath
;
2357 Status
= gBS
->LocateDevicePath (
2358 &gEfiDevicePathProtocolGuid
,
2362 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
2364 // Routing data does not match any known driver.
2365 // Set Progress to the 'G' in "GUID" of the routing header.
2367 *Progress
= StringPtr
;
2368 Status
= EFI_NOT_FOUND
;
2374 // Check whether ConfigRequest contains request string OFFSET/WIDTH
2376 IfrDataParsedFlag
= FALSE
;
2377 if ((HiiHandle
!= NULL
) && (StrStr (ConfigRequest
, L
"&OFFSET=") == NULL
)) {
2379 // Get the full request string from IFR when HiiPackage is registered to HiiHandle
2381 IfrDataParsedFlag
= TRUE
;
2382 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, &AccessProgress
);
2383 if (EFI_ERROR (Status
)) {
2385 // AccessProgress indicates the parsing progress on <ConfigRequest>.
2386 // Map it to the progress on <MultiConfigRequest> then return it.
2388 *Progress
= StrStr (StringPtr
, AccessProgress
);
2392 // Not any request block is found.
2394 if (StrStr (ConfigRequest
, L
"&OFFSET=") == NULL
) {
2395 AccessResults
= AllocateCopyPool (StrSize (ConfigRequest
), ConfigRequest
);
2396 goto NextConfigString
;
2401 // Call corresponding ConfigAccess protocol to extract settings
2403 Status
= gBS
->HandleProtocol (
2405 &gEfiHiiConfigAccessProtocolGuid
,
2406 (VOID
**) &ConfigAccess
2408 ASSERT_EFI_ERROR (Status
);
2410 Status
= ConfigAccess
->ExtractConfig (
2416 if (EFI_ERROR (Status
)) {
2418 // AccessProgress indicates the parsing progress on <ConfigRequest>.
2419 // Map it to the progress on <MultiConfigRequest> then return it.
2421 *Progress
= StrStr (StringPtr
, AccessProgress
);
2426 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
2427 // which seperates the first <ConfigAltResp> and the following ones.
2429 ASSERT (*AccessProgress
== 0);
2432 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
2434 if (!IfrDataParsedFlag
&& HiiHandle
!= NULL
) {
2435 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, NULL
);
2436 ASSERT_EFI_ERROR (Status
);
2439 FreePool (DevicePath
);
2442 if (DefaultResults
!= NULL
) {
2443 Status
= MergeDefaultString (&AccessResults
, DefaultResults
);
2444 ASSERT_EFI_ERROR (Status
);
2445 FreePool (DefaultResults
);
2446 DefaultResults
= NULL
;
2450 if (!FirstElement
) {
2451 Status
= AppendToMultiString (Results
, L
"&");
2452 ASSERT_EFI_ERROR (Status
);
2455 Status
= AppendToMultiString (Results
, AccessResults
);
2456 ASSERT_EFI_ERROR (Status
);
2458 FirstElement
= FALSE
;
2460 FreePool (AccessResults
);
2461 AccessResults
= NULL
;
2462 FreePool (ConfigRequest
);
2463 ConfigRequest
= NULL
;
2466 // Go to next <ConfigRequest> (skip '&').
2468 StringPtr
+= Length
;
2469 if (*StringPtr
== 0) {
2470 *Progress
= StringPtr
;
2478 if (EFI_ERROR (Status
)) {
2479 FreePool (*Results
);
2483 if (ConfigRequest
!= NULL
) {
2484 FreePool (ConfigRequest
);
2487 if (AccessResults
!= NULL
) {
2488 FreePool (AccessResults
);
2491 if (DefaultResults
!= NULL
) {
2492 FreePool (DefaultResults
);
2495 if (DevicePath
!= NULL
) {
2496 FreePool (DevicePath
);
2504 This function allows the caller to request the current configuration for the
2505 entirety of the current HII database and returns the data in a
2506 null-terminated Unicode string.
2508 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
2510 @param Results Null-terminated Unicode string in
2511 <MultiConfigAltResp> format which has all values
2512 filled in for the names in the Request string.
2513 String to be allocated by the called function.
2514 De-allocation is up to the caller.
2516 @retval EFI_SUCCESS The Results string is filled with the values
2517 corresponding to all requested names.
2518 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
2519 results that must be stored awaiting possible
2521 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
2522 parameter would result in this type of error.
2527 HiiConfigRoutingExportConfig (
2528 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
2529 OUT EFI_STRING
*Results
2533 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2534 EFI_STRING AccessResults
;
2535 EFI_STRING Progress
;
2536 EFI_STRING StringPtr
;
2537 EFI_STRING ConfigRequest
;
2539 EFI_HANDLE
*ConfigAccessHandles
;
2540 UINTN NumberConfigAccessHandles
;
2541 BOOLEAN FirstElement
;
2542 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2543 EFI_HII_HANDLE HiiHandle
;
2544 EFI_STRING DefaultResults
;
2545 HII_DATABASE_PRIVATE_DATA
*Private
;
2547 HII_DATABASE_RECORD
*Database
;
2548 UINT8
*DevicePathPkg
;
2549 UINT8
*CurrentDevicePath
;
2550 BOOLEAN IfrDataParsedFlag
;
2552 if (This
== NULL
|| Results
== NULL
) {
2553 return EFI_INVALID_PARAMETER
;
2556 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2559 // Allocate a fix length of memory to store Results. Reallocate memory for
2560 // Results if this fix length is insufficient.
2562 *Results
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
2563 if (*Results
== NULL
) {
2564 return EFI_OUT_OF_RESOURCES
;
2567 NumberConfigAccessHandles
= 0;
2568 Status
= gBS
->LocateHandleBuffer (
2570 &gEfiHiiConfigAccessProtocolGuid
,
2572 &NumberConfigAccessHandles
,
2573 &ConfigAccessHandles
2575 if (EFI_ERROR (Status
)) {
2579 FirstElement
= TRUE
;
2581 for (Index
= 0; Index
< NumberConfigAccessHandles
; Index
++) {
2582 Status
= gBS
->HandleProtocol (
2583 ConfigAccessHandles
[Index
],
2584 &gEfiHiiConfigAccessProtocolGuid
,
2585 (VOID
**) &ConfigAccess
2587 if (EFI_ERROR (Status
)) {
2592 // Get DevicePath and HiiHandle for this ConfigAccess driver handle
2594 IfrDataParsedFlag
= FALSE
;
2597 DefaultResults
= NULL
;
2599 ConfigRequest
= NULL
;
2600 DevicePath
= DevicePathFromHandle (ConfigAccessHandles
[Index
]);
2601 if (DevicePath
!= NULL
) {
2602 for (Link
= Private
->DatabaseList
.ForwardLink
;
2603 Link
!= &Private
->DatabaseList
;
2604 Link
= Link
->ForwardLink
2606 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2607 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
2608 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
2612 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
)
2614 HiiHandle
= Database
->Handle
;
2621 Status
= ConfigAccess
->ExtractConfig (
2627 if (EFI_ERROR (Status
)) {
2629 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
2631 if (HiiHandle
!= NULL
&& DevicePath
!= NULL
) {
2632 IfrDataParsedFlag
= TRUE
;
2633 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &ConfigRequest
, &DefaultResults
, NULL
);
2635 // Get the full request string to get the Current setting again.
2637 if (!EFI_ERROR (Status
) && ConfigRequest
!= NULL
) {
2638 Status
= ConfigAccess
->ExtractConfig (
2644 FreePool (ConfigRequest
);
2646 Status
= EFI_NOT_FOUND
;
2651 if (!EFI_ERROR (Status
)) {
2653 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
2655 if (!IfrDataParsedFlag
&& HiiHandle
!= NULL
&& DevicePath
!= NULL
) {
2656 StringPtr
= StrStr (AccessResults
, L
"&GUID=");
2657 if (StringPtr
!= NULL
) {
2660 if (StrStr (AccessResults
, L
"&OFFSET=") != NULL
) {
2661 Status
= GetFullStringFromHiiFormPackages (Database
, DevicePath
, &AccessResults
, &DefaultResults
, NULL
);
2662 ASSERT_EFI_ERROR (Status
);
2664 if (StringPtr
!= NULL
) {
2669 // Merge the default sting from IFR code into the got setting from driver.
2671 if (DefaultResults
!= NULL
) {
2672 Status
= MergeDefaultString (&AccessResults
, DefaultResults
);
2673 ASSERT_EFI_ERROR (Status
);
2674 FreePool (DefaultResults
);
2675 DefaultResults
= NULL
;
2679 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
2680 // which seperates the first <ConfigAltResp> and the following ones.
2682 if (!FirstElement
) {
2683 Status
= AppendToMultiString (Results
, L
"&");
2684 ASSERT_EFI_ERROR (Status
);
2687 Status
= AppendToMultiString (Results
, AccessResults
);
2688 ASSERT_EFI_ERROR (Status
);
2690 FirstElement
= FALSE
;
2692 FreePool (AccessResults
);
2693 AccessResults
= NULL
;
2696 FreePool (ConfigAccessHandles
);
2703 This function processes the results of processing forms and routes it to the
2704 appropriate handlers or storage.
2706 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
2708 @param Configuration A null-terminated Unicode string in
2709 <MulltiConfigResp> format.
2710 @param Progress A pointer to a string filled in with the offset of
2711 the most recent & before the first failing name /
2712 value pair (or the beginning of the string if the
2713 failure is in the first name / value pair) or the
2714 terminating NULL if all was successful.
2716 @retval EFI_SUCCESS The results have been distributed or are awaiting
2718 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
2719 results that must be stored awaiting possible
2721 @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
2722 would result in this type of error.
2723 @retval EFI_NOT_FOUND Target for the specified routing data was not
2729 HiiConfigRoutingRouteConfig (
2730 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
2731 IN CONST EFI_STRING Configuration
,
2732 OUT EFI_STRING
*Progress
2735 HII_DATABASE_PRIVATE_DATA
*Private
;
2736 EFI_STRING StringPtr
;
2737 EFI_STRING ConfigResp
;
2740 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2741 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath
;
2743 HII_DATABASE_RECORD
*Database
;
2744 UINT8
*DevicePathPkg
;
2745 UINT8
*CurrentDevicePath
;
2746 EFI_HANDLE DriverHandle
;
2747 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2748 EFI_STRING AccessProgress
;
2750 if (This
== NULL
|| Progress
== NULL
) {
2751 return EFI_INVALID_PARAMETER
;
2754 if (Configuration
== NULL
) {
2756 return EFI_INVALID_PARAMETER
;
2759 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2760 StringPtr
= Configuration
;
2761 *Progress
= StringPtr
;
2764 // The first element of <MultiConfigResp> should be
2765 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
2767 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
2768 return EFI_INVALID_PARAMETER
;
2771 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) == 0) {
2773 // If parsing error, set Progress to the beginning of the <MultiConfigResp>
2774 // or most recent & before the error.
2776 if (StringPtr
== Configuration
) {
2777 *Progress
= StringPtr
;
2779 *Progress
= StringPtr
- 1;
2783 // Process each <ConfigResp> of <MultiConfigResp>
2785 Length
= CalculateConfigStringLen (StringPtr
);
2786 ConfigResp
= AllocateCopyPool ((Length
+ 1) * sizeof (CHAR16
), StringPtr
);
2787 if (ConfigResp
== NULL
) {
2788 return EFI_OUT_OF_RESOURCES
;
2791 // Append '\0' to the end of ConfigRequest
2793 *(ConfigResp
+ Length
) = 0;
2796 // Get the UEFI device path
2798 Status
= GetDevicePath (ConfigResp
, (UINT8
**) &DevicePath
);
2799 if (EFI_ERROR (Status
)) {
2800 FreePool (ConfigResp
);
2805 // Find driver which matches the routing data.
2807 DriverHandle
= NULL
;
2808 for (Link
= Private
->DatabaseList
.ForwardLink
;
2809 Link
!= &Private
->DatabaseList
;
2810 Link
= Link
->ForwardLink
2812 Database
= CR (Link
, HII_DATABASE_RECORD
, DatabaseEntry
, HII_DATABASE_RECORD_SIGNATURE
);
2814 if ((DevicePathPkg
= Database
->PackageList
->DevicePathPkg
) != NULL
) {
2815 CurrentDevicePath
= DevicePathPkg
+ sizeof (EFI_HII_PACKAGE_HEADER
);
2819 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) CurrentDevicePath
)
2821 DriverHandle
= Database
->DriverHandle
;
2828 // Try to find driver handle by device path.
2830 if (DriverHandle
== NULL
) {
2831 TempDevicePath
= DevicePath
;
2832 Status
= gBS
->LocateDevicePath (
2833 &gEfiDevicePathProtocolGuid
,
2837 if (EFI_ERROR (Status
) || (DriverHandle
== NULL
)) {
2839 // Routing data does not match any known driver.
2840 // Set Progress to the 'G' in "GUID" of the routing header.
2842 FreePool (DevicePath
);
2843 *Progress
= StringPtr
;
2844 FreePool (ConfigResp
);
2845 return EFI_NOT_FOUND
;
2849 FreePool (DevicePath
);
2852 // Call corresponding ConfigAccess protocol to route settings
2854 Status
= gBS
->HandleProtocol (
2856 &gEfiHiiConfigAccessProtocolGuid
,
2857 (VOID
**) &ConfigAccess
2859 ASSERT_EFI_ERROR (Status
);
2861 Status
= ConfigAccess
->RouteConfig (
2867 if (EFI_ERROR (Status
)) {
2869 // AccessProgress indicates the parsing progress on <ConfigResp>.
2870 // Map it to the progress on <MultiConfigResp> then return it.
2872 *Progress
= StrStr (StringPtr
, AccessProgress
);
2874 FreePool (ConfigResp
);
2878 FreePool (ConfigResp
);
2882 // Go to next <ConfigResp> (skip '&').
2884 StringPtr
+= Length
;
2885 if (*StringPtr
== 0) {
2886 *Progress
= StringPtr
;
2899 This helper function is to be called by drivers to map configuration data
2900 stored in byte array ("block") formats such as UEFI Variables into current
2901 configuration strings.
2903 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
2905 @param ConfigRequest A null-terminated Unicode string in
2906 <ConfigRequest> format.
2907 @param Block Array of bytes defining the block's configuration.
2908 @param BlockSize Length in bytes of Block.
2909 @param Config Filled-in configuration string. String allocated
2910 by the function. Returned only if call is
2911 successful. It is <ConfigResp> string format.
2912 @param Progress A pointer to a string filled in with the offset of
2913 the most recent & before the first failing
2914 name/value pair (or the beginning of the string if
2915 the failure is in the first name / value pair) or
2916 the terminating NULL if all was successful.
2918 @retval EFI_SUCCESS The request succeeded. Progress points to the null
2919 terminator at the end of the ConfigRequest
2921 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
2922 points to the first character of ConfigRequest.
2923 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
2924 Block parameter would result in this type of
2925 error. Progress points to the first character of
2927 @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
2928 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
2929 Block is left updated and Progress points at
2930 the "&" preceding the first non-<BlockName>.
2936 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
2937 IN CONST EFI_STRING ConfigRequest
,
2938 IN CONST UINT8
*Block
,
2939 IN CONST UINTN BlockSize
,
2940 OUT EFI_STRING
*Config
,
2941 OUT EFI_STRING
*Progress
2944 HII_DATABASE_PRIVATE_DATA
*Private
;
2945 EFI_STRING StringPtr
;
2953 EFI_STRING ValueStr
;
2954 EFI_STRING ConfigElement
;
2959 if (This
== NULL
|| Progress
== NULL
|| Config
== NULL
) {
2960 return EFI_INVALID_PARAMETER
;
2963 if (Block
== NULL
|| ConfigRequest
== NULL
) {
2964 *Progress
= ConfigRequest
;
2965 return EFI_INVALID_PARAMETER
;
2969 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
2970 ASSERT (Private
!= NULL
);
2972 StringPtr
= ConfigRequest
;
2975 ConfigElement
= NULL
;
2978 // Allocate a fix length of memory to store Results. Reallocate memory for
2979 // Results if this fix length is insufficient.
2981 *Config
= (EFI_STRING
) AllocateZeroPool (MAX_STRING_LENGTH
);
2982 if (*Config
== NULL
) {
2983 return EFI_OUT_OF_RESOURCES
;
2989 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
2990 *Progress
= StringPtr
;
2991 Status
= EFI_INVALID_PARAMETER
;
2994 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"PATH=", StrLen (L
"PATH=")) != 0) {
2997 if (*StringPtr
== 0) {
2998 *Progress
= StringPtr
- 1;
2999 Status
= EFI_INVALID_PARAMETER
;
3003 while (*StringPtr
!= L
'&' && *StringPtr
!= 0) {
3006 if (*StringPtr
== 0) {
3007 *Progress
= StringPtr
- 1;
3008 Status
= EFI_INVALID_PARAMETER
;
3017 // Copy <ConfigHdr> and an additional '&' to <ConfigResp>
3019 Length
= StringPtr
- ConfigRequest
;
3020 CopyMem (*Config
, ConfigRequest
, Length
* sizeof (CHAR16
));
3023 // Parse each <RequestElement> if exists
3024 // Only <BlockName> format is supported by this help function.
3025 // <BlockName> ::= 'OFFSET='<Number>&'WIDTH='<Number>
3027 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"OFFSET=", StrLen (L
"OFFSET=")) == 0) {
3029 // Back up the header of one <BlockName>
3033 StringPtr
+= StrLen (L
"OFFSET=");
3037 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
3038 if (Status
== EFI_OUT_OF_RESOURCES
) {
3039 *Progress
= ConfigRequest
;
3046 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
3048 FreePool (TmpBuffer
);
3050 StringPtr
+= Length
;
3051 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
3052 *Progress
= StringPtr
- Length
- StrLen (L
"OFFSET=") - 1;
3053 Status
= EFI_INVALID_PARAMETER
;
3056 StringPtr
+= StrLen (L
"&WIDTH=");
3061 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
3062 if (Status
== EFI_OUT_OF_RESOURCES
) {
3063 *Progress
= ConfigRequest
;
3070 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
3072 FreePool (TmpBuffer
);
3074 StringPtr
+= Length
;
3075 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
3076 *Progress
= StringPtr
- Length
- StrLen (L
"&WIDTH=");
3077 Status
= EFI_INVALID_PARAMETER
;
3082 // Calculate Value and convert it to hex string.
3084 if (Offset
+ Width
> BlockSize
) {
3085 *Progress
= StringPtr
;
3086 Status
= EFI_DEVICE_ERROR
;
3090 Value
= (UINT8
*) AllocateZeroPool (Width
);
3091 if (Value
== NULL
) {
3092 *Progress
= ConfigRequest
;
3093 Status
= EFI_OUT_OF_RESOURCES
;
3097 CopyMem (Value
, (UINT8
*) Block
+ Offset
, Width
);
3099 Length
= Width
* 2 + 1;
3100 ValueStr
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
3101 if (ValueStr
== NULL
) {
3102 *Progress
= ConfigRequest
;
3103 Status
= EFI_OUT_OF_RESOURCES
;
3107 TemString
= ValueStr
;
3108 TemBuffer
= Value
+ Width
- 1;
3109 for (Index
= 0; Index
< Width
; Index
++, TemBuffer
--) {
3110 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
3117 // Build a ConfigElement
3119 Length
+= StringPtr
- TmpPtr
+ 1 + StrLen (L
"VALUE=");
3120 ConfigElement
= (EFI_STRING
) AllocateZeroPool (Length
* sizeof (CHAR16
));
3121 if (ConfigElement
== NULL
) {
3122 Status
= EFI_OUT_OF_RESOURCES
;
3125 CopyMem (ConfigElement
, TmpPtr
, (StringPtr
- TmpPtr
+ 1) * sizeof (CHAR16
));
3126 if (*StringPtr
== 0) {
3127 *(ConfigElement
+ (StringPtr
- TmpPtr
)) = L
'&';
3129 *(ConfigElement
+ (StringPtr
- TmpPtr
) + 1) = 0;
3130 StrCat (ConfigElement
, L
"VALUE=");
3131 StrCat (ConfigElement
, ValueStr
);
3133 AppendToMultiString (Config
, ConfigElement
);
3135 FreePool (ConfigElement
);
3136 FreePool (ValueStr
);
3137 ConfigElement
= NULL
;
3141 // If '\0', parsing is finished. Otherwise skip '&' to continue
3143 if (*StringPtr
== 0) {
3146 AppendToMultiString (Config
, L
"&");
3151 if (*StringPtr
!= 0) {
3152 *Progress
= StringPtr
- 1;
3153 Status
= EFI_INVALID_PARAMETER
;
3157 HiiToLower (*Config
);
3158 *Progress
= StringPtr
;
3162 if (*Config
!= NULL
) {
3166 if (ValueStr
!= NULL
) {
3167 FreePool (ValueStr
);
3169 if (Value
!= NULL
) {
3172 if (ConfigElement
!= NULL
) {
3173 FreePool (ConfigElement
);
3182 This helper function is to be called by drivers to map configuration strings
3183 to configurations stored in byte array ("block") formats such as UEFI Variables.
3185 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3187 @param ConfigResp A null-terminated Unicode string in <ConfigResp>
3188 format. It can be ConfigAltResp format string.
3189 @param Block A possibly null array of bytes representing the
3190 current block. Only bytes referenced in the
3191 ConfigResp string in the block are modified. If
3192 this parameter is null or if the *BlockSize
3193 parameter is (on input) shorter than required by
3194 the Configuration string, only the BlockSize
3195 parameter is updated and an appropriate status
3196 (see below) is returned.
3197 @param BlockSize The length of the Block in units of UINT8. On
3198 input, this is the size of the Block. On output,
3199 if successful, contains the index of the last
3200 modified byte in the Block.
3201 @param Progress On return, points to an element of the ConfigResp
3202 string filled in with the offset of the most
3203 recent '&' before the first failing name / value
3204 pair (or the beginning of the string if the
3205 failure is in the first name / value pair) or the
3206 terminating NULL if all was successful.
3208 @retval EFI_SUCCESS The request succeeded. Progress points to the null
3209 terminator at the end of the ConfigResp string.
3210 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
3211 points to the first character of ConfigResp.
3212 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
3213 Block parameter would result in this type of
3214 error. Progress points to the first character of
3216 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
3217 value pair. Block is left updated and
3218 Progress points at the '&' preceding the first
3225 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
3226 IN CONST EFI_STRING ConfigResp
,
3227 IN OUT UINT8
*Block
,
3228 IN OUT UINTN
*BlockSize
,
3229 OUT EFI_STRING
*Progress
3232 HII_DATABASE_PRIVATE_DATA
*Private
;
3233 EFI_STRING StringPtr
;
3242 if (This
== NULL
|| BlockSize
== NULL
|| Progress
== NULL
) {
3243 return EFI_INVALID_PARAMETER
;
3246 if (ConfigResp
== NULL
|| Block
== NULL
) {
3247 *Progress
= ConfigResp
;
3248 return EFI_INVALID_PARAMETER
;
3251 Private
= CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This
);
3252 ASSERT (Private
!= NULL
);
3254 StringPtr
= ConfigResp
;
3255 BufferSize
= *BlockSize
;
3261 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
3262 *Progress
= StringPtr
;
3263 Status
= EFI_INVALID_PARAMETER
;
3266 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"PATH=", StrLen (L
"PATH=")) != 0) {
3269 if (*StringPtr
== 0) {
3270 *Progress
= StringPtr
;
3271 Status
= EFI_INVALID_PARAMETER
;
3275 while (*StringPtr
!= L
'&' && *StringPtr
!= 0) {
3278 if (*StringPtr
== 0) {
3279 *Progress
= StringPtr
;
3280 Status
= EFI_INVALID_PARAMETER
;
3289 // Parse each <ConfigElement> if exists
3290 // Only <BlockConfig> format is supported by this help function.
3291 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE='<Number>
3293 while (*StringPtr
!= 0 && StrnCmp (StringPtr
, L
"OFFSET=", StrLen (L
"OFFSET=")) == 0) {
3294 StringPtr
+= StrLen (L
"OFFSET=");
3298 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
3299 if (EFI_ERROR (Status
)) {
3300 *Progress
= ConfigResp
;
3307 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
3309 FreePool (TmpBuffer
);
3311 StringPtr
+= Length
;
3312 if (StrnCmp (StringPtr
, L
"&WIDTH=", StrLen (L
"&WIDTH=")) != 0) {
3313 *Progress
= StringPtr
- Length
- StrLen (L
"OFFSET=") - 1;
3314 Status
= EFI_INVALID_PARAMETER
;
3317 StringPtr
+= StrLen (L
"&WIDTH=");
3322 Status
= GetValueOfNumber (StringPtr
, &TmpBuffer
, &Length
);
3323 if (Status
== EFI_OUT_OF_RESOURCES
) {
3324 *Progress
= ConfigResp
;
3331 (((Length
+ 1) / 2) < sizeof (UINTN
)) ? ((Length
+ 1) / 2) : sizeof (UINTN
)
3333 FreePool (TmpBuffer
);
3335 StringPtr
+= Length
;
3336 if (StrnCmp (StringPtr
, L
"&VALUE=", StrLen (L
"&VALUE=")) != 0) {
3337 *Progress
= StringPtr
- Length
- StrLen (L
"&WIDTH=");
3338 Status
= EFI_INVALID_PARAMETER
;
3341 StringPtr
+= StrLen (L
"&VALUE=");
3346 Status
= GetValueOfNumber (StringPtr
, &Value
, &Length
);
3347 if (EFI_ERROR (Status
)) {
3348 *Progress
= ConfigResp
;
3352 StringPtr
+= Length
;
3353 if (*StringPtr
!= 0 && *StringPtr
!= L
'&') {
3354 *Progress
= StringPtr
- Length
- 7;
3355 Status
= EFI_INVALID_PARAMETER
;
3360 // Update the Block with configuration info
3363 if (Offset
+ Width
> BufferSize
) {
3364 return EFI_DEVICE_ERROR
;
3367 CopyMem (Block
+ Offset
, Value
, Width
);
3368 *BlockSize
= Offset
+ Width
- 1;
3374 // If '\0', parsing is finished. Otherwise skip '&' to continue
3376 if (*StringPtr
== 0) {
3384 // The input string is ConfigAltResp format.
3386 if ((*StringPtr
!= 0) && (StrnCmp (StringPtr
, L
"&GUID=", StrLen (L
"&GUID=")) != 0)) {
3387 *Progress
= StringPtr
- 1;
3388 Status
= EFI_INVALID_PARAMETER
;
3392 *Progress
= StringPtr
+ StrLen (StringPtr
);
3397 if (Value
!= NULL
) {
3405 This helper function is to be called by drivers to extract portions of
3406 a larger configuration string.
3408 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3410 @param Configuration A null-terminated Unicode string in
3411 <MultiConfigAltResp> format. It is <ConfigAltResp> format.
3412 @param Guid A pointer to the GUID value to search for in the
3413 routing portion of the ConfigResp string when
3414 retrieving the requested data. If Guid is NULL,
3415 then all GUID values will be searched for.
3416 @param Name A pointer to the NAME value to search for in the
3417 routing portion of the ConfigResp string when
3418 retrieving the requested data. If Name is NULL,
3419 then all Name values will be searched for.
3420 @param DevicePath A pointer to the PATH value to search for in the
3421 routing portion of the ConfigResp string when
3422 retrieving the requested data. If DevicePath is
3423 NULL, then all DevicePath values will be searched
3425 @param AltCfgId A pointer to the ALTCFG value to search for in the
3426 routing portion of the ConfigResp string when
3427 retrieving the requested data. If this parameter
3428 is NULL, then the current setting will be
3430 @param AltCfgResp A pointer to a buffer which will be allocated by
3431 the function which contains the retrieved string
3432 as requested. This buffer is only allocated if
3433 the call was successful. It is <ConfigResp> format.
3435 @retval EFI_SUCCESS The request succeeded. The requested data was
3436 extracted and placed in the newly allocated
3438 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
3439 @retval EFI_INVALID_PARAMETER Any parameter is invalid.
3440 @retval EFI_NOT_FOUND Target for the specified routing data was not
3447 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL
*This
,
3448 IN CONST EFI_STRING Configuration
,
3449 IN CONST EFI_GUID
*Guid
,
3450 IN CONST EFI_STRING Name
,
3451 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
3452 IN CONST UINT16
*AltCfgId
,
3453 OUT EFI_STRING
*AltCfgResp
3457 EFI_STRING StringPtr
;
3458 EFI_STRING HdrStart
;
3465 EFI_STRING AltIdStr
;
3482 if (This
== NULL
|| Configuration
== NULL
|| AltCfgResp
== NULL
) {
3483 return EFI_INVALID_PARAMETER
;
3486 StringPtr
= Configuration
;
3487 if (StrnCmp (StringPtr
, L
"GUID=", StrLen (L
"GUID=")) != 0) {
3488 return EFI_INVALID_PARAMETER
;
3492 // Generate the sub string for later matching.
3494 GenerateSubStr (L
"GUID=", sizeof (EFI_GUID
), (VOID
*) Guid
, 1, &GuidStr
);
3497 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
),
3498 (VOID
*) DevicePath
,
3502 if (AltCfgId
!= NULL
) {
3503 GenerateSubStr (L
"ALTCFG=", sizeof (UINT16
), (VOID
*) AltCfgId
, 3, &AltIdStr
);
3506 GenerateSubStr (L
"NAME=", StrLen (Name
) * sizeof (CHAR16
), (VOID
*) Name
, 2, &NameStr
);
3508 GenerateSubStr (L
"NAME=", 0, NULL
, 2, &NameStr
);
3511 while (*StringPtr
!= 0) {
3513 // Try to match the GUID
3516 TmpPtr
= StrStr (StringPtr
, GuidStr
);
3517 if (TmpPtr
== NULL
) {
3518 Status
= EFI_NOT_FOUND
;
3524 // Jump to <NameHdr>
3527 StringPtr
= TmpPtr
+ StrLen (GuidStr
);
3529 StringPtr
= StrStr (TmpPtr
, L
"NAME=");
3530 if (StringPtr
== NULL
) {
3531 Status
= EFI_NOT_FOUND
;
3539 // Try to match the NAME
3541 if (GuidFlag
&& !NameFlag
) {
3542 if (StrnCmp (StringPtr
, NameStr
, StrLen (NameStr
)) != 0) {
3546 // Jump to <PathHdr>
3549 StringPtr
+= StrLen (NameStr
);
3551 StringPtr
= StrStr (StringPtr
, L
"PATH=");
3552 if (StringPtr
== NULL
) {
3553 Status
= EFI_NOT_FOUND
;
3562 // Try to match the DevicePath
3564 if (GuidFlag
&& NameFlag
&& !PathFlag
) {
3565 if (StrnCmp (StringPtr
, PathStr
, StrLen (PathStr
)) != 0) {
3570 // Jump to '&' before <DescHdr> or <ConfigBody>
3572 if (DevicePath
!= NULL
) {
3573 StringPtr
+= StrLen (PathStr
);
3575 StringPtr
= StrStr (StringPtr
, L
"&");
3576 if (StringPtr
== NULL
) {
3577 Status
= EFI_NOT_FOUND
;
3588 // Try to match the AltCfgId
3590 if (GuidFlag
&& NameFlag
&& PathFlag
) {
3591 if (AltCfgId
== NULL
) {
3593 // Return Current Setting when AltCfgId is NULL.
3595 Status
= OutputConfigBody (StringPtr
, &Result
);
3599 // Search the <ConfigAltResp> to get the <AltResp> with AltCfgId.
3601 if (StrnCmp (StringPtr
, AltIdStr
, StrLen (AltIdStr
)) != 0) {
3607 // Skip AltIdStr and &
3609 StringPtr
= StringPtr
+ StrLen (AltIdStr
);
3610 Status
= OutputConfigBody (StringPtr
, &Result
);
3616 Status
= EFI_NOT_FOUND
;
3620 if (!EFI_ERROR (Status
) && (Result
!= NULL
)) {
3622 // Copy the <ConfigHdr> and <ConfigBody>
3624 Length
= HdrEnd
- HdrStart
+ StrLen (Result
) + 1;
3625 *AltCfgResp
= AllocateZeroPool (Length
* sizeof (CHAR16
));
3626 if (*AltCfgResp
== NULL
) {
3627 Status
= EFI_OUT_OF_RESOURCES
;
3629 StrnCpy (*AltCfgResp
, HdrStart
, HdrEnd
- HdrStart
);
3630 StrCat (*AltCfgResp
, Result
);
3631 Status
= EFI_SUCCESS
;
3635 if (GuidStr
!= NULL
) {
3638 if (NameStr
!= NULL
) {
3641 if (PathStr
!= NULL
) {
3644 if (AltIdStr
!= NULL
) {
3645 FreePool (AltIdStr
);
3647 if (Result
!= NULL
) {