]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/HiiDatabaseDxe/ConfigRouting.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
BaseTools:To generate string default type correctly in VfrCompiler
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / ConfigRouting.c
1 /** @file
2 Implementation of interfaces function for EFI_HII_CONFIG_ROUTING_PROTOCOL.
3
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
9
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.
12
13 **/
14
15
16 #include "HiiDatabase.h"
17 extern HII_DATABASE_PRIVATE_DATA mPrivate;
18
19 /**
20 Calculate the number of Unicode characters of the incoming Configuration string,
21 not including NULL terminator.
22
23 This is a internal function.
24
25 @param String String in <MultiConfigRequest> or
26 <MultiConfigResp> format.
27
28 @return The number of Unicode characters.
29
30 **/
31 UINTN
32 CalculateConfigStringLen (
33 IN EFI_STRING String
34 )
35 {
36 EFI_STRING TmpPtr;
37
38 //
39 // "GUID=" should be the first element of incoming string.
40 //
41 ASSERT (String != NULL);
42 ASSERT (StrnCmp (String, L"GUID=", StrLen (L"GUID=")) == 0);
43
44 //
45 // The beginning of next <ConfigRequest>/<ConfigResp> should be "&GUID=".
46 // Will meet '\0' if there is only one <ConfigRequest>/<ConfigResp>.
47 //
48 TmpPtr = StrStr (String, L"&GUID=");
49 if (TmpPtr == NULL) {
50 return StrLen (String);
51 }
52
53 return (TmpPtr - String);
54 }
55
56
57 /**
58 Convert the hex UNICODE %02x encoding of a UEFI device path to binary
59 from <PathHdr> of <ConfigHdr>.
60
61 This is a internal function.
62
63 @param String UEFI configuration string
64 @param DevicePathData Binary of a UEFI device path.
65
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
70 binary format.
71
72 **/
73 EFI_STATUS
74 GetDevicePath (
75 IN EFI_STRING String,
76 OUT UINT8 **DevicePathData
77 )
78 {
79 UINTN Length;
80 EFI_STRING PathHdr;
81 UINT8 *DevicePathBuffer;
82 CHAR16 TemStr[2];
83 UINTN Index;
84 UINT8 DigitUint8;
85 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
86
87
88 if (String == NULL || DevicePathData == NULL) {
89 return EFI_INVALID_PARAMETER;
90 }
91
92 //
93 // Find the 'PATH=' of <PathHdr> and skip it.
94 //
95 for (; (*String != 0 && StrnCmp (String, L"PATH=", StrLen (L"PATH=")) != 0); String++);
96 if (*String == 0) {
97 return EFI_INVALID_PARAMETER;
98 }
99 //
100 // Check whether path data does exist.
101 //
102 String += StrLen (L"PATH=");
103 if (*String == 0) {
104 return EFI_INVALID_PARAMETER;
105 }
106 PathHdr = String;
107
108 //
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.
112 //
113 for (Length = 0; *String != 0 && *String != L'&'; String++, Length++);
114 //
115 // Check DevicePath Length
116 //
117 if (((Length + 1) / 2) < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {
118 return EFI_NOT_FOUND;
119 }
120
121 //
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.
125 //
126 DevicePathBuffer = (UINT8 *) AllocateZeroPool ((Length + 1) / 2);
127 if (DevicePathBuffer == NULL) {
128 return EFI_OUT_OF_RESOURCES;
129 }
130
131 //
132 // Convert DevicePath
133 //
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;
140 } else {
141 DevicePathBuffer [Index/2] = (UINT8) ((DevicePathBuffer [Index/2] << 4) + DigitUint8);
142 }
143 }
144
145 //
146 // Validate DevicePath
147 //
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))) {
151 //
152 // Invalid device path
153 //
154 FreePool (DevicePathBuffer);
155 return EFI_NOT_FOUND;
156 }
157 DevicePath = NextDevicePathNode (DevicePath);
158 }
159
160 //
161 // return the device path
162 //
163 *DevicePathData = DevicePathBuffer;
164 return EFI_SUCCESS;
165 }
166
167 /**
168 Converts the unicode character of the string from uppercase to lowercase.
169 This is a internal function.
170
171 @param ConfigString String to be converted
172
173 **/
174 VOID
175 EFIAPI
176 HiiToLower (
177 IN EFI_STRING ConfigString
178 )
179 {
180 EFI_STRING String;
181 BOOLEAN Lower;
182
183 ASSERT (ConfigString != NULL);
184
185 //
186 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
187 //
188 for (String = ConfigString, Lower = FALSE; *String != L'\0'; String++) {
189 if (*String == L'=') {
190 Lower = TRUE;
191 } else if (*String == L'&') {
192 Lower = FALSE;
193 } else if (Lower && *String >= L'A' && *String <= L'F') {
194 *String = (CHAR16) (*String - L'A' + L'a');
195 }
196 }
197
198 return;
199 }
200
201 /**
202 Generate a sub string then output it.
203
204 This is a internal function.
205
206 @param String A constant string which is the prefix of the to be
207 generated string, e.g. GUID=
208
209 @param BufferLen The length of the Buffer in bytes.
210
211 @param Buffer Points to a buffer which will be converted to be the
212 content of the generated string.
213
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.
217
218 @param SubStr Points to the output string. It's caller's
219 responsibility to free this buffer.
220
221
222 **/
223 VOID
224 GenerateSubStr (
225 IN CONST EFI_STRING String,
226 IN UINTN BufferLen,
227 IN VOID *Buffer,
228 IN UINT8 Flag,
229 OUT EFI_STRING *SubStr
230 )
231 {
232 UINTN Length;
233 EFI_STRING Str;
234 EFI_STRING StringHeader;
235 CHAR16 *TemString;
236 CHAR16 *TemName;
237 UINT8 *TemBuffer;
238 UINTN Index;
239
240 ASSERT (String != NULL && SubStr != NULL);
241
242 if (Buffer == NULL) {
243 *SubStr = AllocateCopyPool (StrSize (String), String);
244 ASSERT (*SubStr != NULL);
245 return;
246 }
247
248 //
249 // Header + Data + '&' + '\0'
250 //
251 Length = StrLen (String) + BufferLen * 2 + 1 + 1;
252 Str = AllocateZeroPool (Length * sizeof (CHAR16));
253 ASSERT (Str != NULL);
254
255 StrCpyS (Str, Length, String);
256
257 StringHeader = Str + StrLen (String);
258 TemString = (CHAR16 *) StringHeader;
259
260 switch (Flag) {
261 case 1:
262 //
263 // Convert Buffer to Hex String in reverse order
264 //
265 TemBuffer = ((UINT8 *) Buffer);
266 for (Index = 0; Index < BufferLen; Index ++, TemBuffer ++) {
267 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
268 }
269 break;
270 case 2:
271 //
272 // Check buffer is enough
273 //
274 TemName = (CHAR16 *) Buffer;
275 ASSERT ((BufferLen * 2 + 1) >= (StrLen (TemName) * 4 + 1));
276 //
277 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
278 //
279 for (; *TemName != L'\0'; TemName++) {
280 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemName, 4);
281 }
282 break;
283 case 3:
284 //
285 // Convert Buffer to Hex String
286 //
287 TemBuffer = ((UINT8 *) Buffer) + BufferLen - 1;
288 for (Index = 0; Index < BufferLen; Index ++, TemBuffer --) {
289 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
290 }
291 break;
292 default:
293 break;
294 }
295
296 //
297 // Convert the uppercase to lowercase since <HexAf> is defined in lowercase format.
298 //
299 StrCatS (Str, Length, L"&");
300 HiiToLower (Str);
301
302 *SubStr = Str;
303 }
304
305
306 /**
307 Retrieve the <ConfigBody> from String then output it.
308
309 This is a internal function.
310
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.
315
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.
319
320 **/
321 EFI_STATUS
322 OutputConfigBody (
323 IN EFI_STRING String,
324 OUT EFI_STRING *ConfigBody
325 )
326 {
327 EFI_STRING TmpPtr;
328 EFI_STRING Result;
329 UINTN Length;
330
331 if (String == NULL || ConfigBody == NULL) {
332 return EFI_INVALID_PARAMETER;
333 }
334
335 //
336 // The setting information should start OFFSET, not ALTCFG.
337 //
338 if (StrnCmp (String, L"&ALTCFG=", StrLen (L"&ALTCFG=")) == 0) {
339 return EFI_INVALID_PARAMETER;
340 }
341
342 TmpPtr = StrStr (String, L"GUID=");
343 if (TmpPtr == NULL) {
344 //
345 // It is the last <ConfigResp> of the incoming configuration string.
346 //
347 Result = AllocateCopyPool (StrSize (String), String);
348 if (Result == NULL) {
349 return EFI_OUT_OF_RESOURCES;
350 } else {
351 *ConfigBody = Result;
352 return EFI_SUCCESS;
353 }
354 }
355
356 Length = TmpPtr - String;
357 if (Length == 0) {
358 return EFI_NOT_FOUND;
359 }
360 Result = AllocateCopyPool (Length * sizeof (CHAR16), String);
361 if (Result == NULL) {
362 return EFI_OUT_OF_RESOURCES;
363 }
364
365 *(Result + Length - 1) = 0;
366 *ConfigBody = Result;
367 return EFI_SUCCESS;
368 }
369
370 /**
371 Append a string to a multi-string format.
372
373 This is a internal function.
374
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
379 might be updated.
380 @param AppendString NULL-terminated Unicode string.
381
382 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.
383 @retval EFI_SUCCESS AppendString is append to the end of MultiString
384
385 **/
386 EFI_STATUS
387 AppendToMultiString (
388 IN OUT EFI_STRING *MultiString,
389 IN EFI_STRING AppendString
390 )
391 {
392 UINTN AppendStringSize;
393 UINTN MultiStringSize;
394 UINTN MaxLen;
395
396 if (MultiString == NULL || *MultiString == NULL || AppendString == NULL) {
397 return EFI_INVALID_PARAMETER;
398 }
399
400 AppendStringSize = StrSize (AppendString);
401 MultiStringSize = StrSize (*MultiString);
402 MaxLen = MAX_STRING_LENGTH / sizeof (CHAR16);
403
404 //
405 // Enlarge the buffer each time when length exceeds MAX_STRING_LENGTH.
406 //
407 if (MultiStringSize + AppendStringSize > MAX_STRING_LENGTH ||
408 MultiStringSize > MAX_STRING_LENGTH) {
409 *MultiString = (EFI_STRING) ReallocatePool (
410 MultiStringSize,
411 MultiStringSize + AppendStringSize,
412 (VOID *) (*MultiString)
413 );
414 MaxLen = (MultiStringSize + AppendStringSize) / sizeof (CHAR16);
415 ASSERT (*MultiString != NULL);
416 }
417 //
418 // Append the incoming string
419 //
420 StrCatS (*MultiString, MaxLen, AppendString);
421
422 return EFI_SUCCESS;
423 }
424
425
426 /**
427 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET
428 or WIDTH or VALUE.
429 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
430
431 This is a internal function.
432
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
436 to free memory.
437 @param Len Length of the <Number>, in characters.
438
439 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary
440 structures.
441 @retval EFI_SUCCESS Value of <Number> is outputted in Number
442 successfully.
443
444 **/
445 EFI_STATUS
446 GetValueOfNumber (
447 IN EFI_STRING StringPtr,
448 OUT UINT8 **Number,
449 OUT UINTN *Len
450 )
451 {
452 EFI_STRING TmpPtr;
453 UINTN Length;
454 EFI_STRING Str;
455 UINT8 *Buf;
456 EFI_STATUS Status;
457 UINT8 DigitUint8;
458 UINTN Index;
459 CHAR16 TemStr[2];
460
461 if (StringPtr == NULL || *StringPtr == L'\0' || Number == NULL || Len == NULL) {
462 return EFI_INVALID_PARAMETER;
463 }
464
465 Buf = NULL;
466
467 TmpPtr = StringPtr;
468 while (*StringPtr != L'\0' && *StringPtr != L'&') {
469 StringPtr++;
470 }
471 *Len = StringPtr - TmpPtr;
472 Length = *Len + 1;
473
474 Str = (EFI_STRING) AllocateZeroPool (Length * sizeof (CHAR16));
475 if (Str == NULL) {
476 Status = EFI_OUT_OF_RESOURCES;
477 goto Exit;
478 }
479 CopyMem (Str, TmpPtr, *Len * sizeof (CHAR16));
480 *(Str + *Len) = L'\0';
481
482 Length = (Length + 1) / 2;
483 Buf = (UINT8 *) AllocateZeroPool (Length);
484 if (Buf == NULL) {
485 Status = EFI_OUT_OF_RESOURCES;
486 goto Exit;
487 }
488
489 Length = *Len;
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;
496 } else {
497 Buf [Index/2] = (UINT8) ((DigitUint8 << 4) + Buf [Index/2]);
498 }
499 }
500
501 *Number = Buf;
502 Status = EFI_SUCCESS;
503
504 Exit:
505 if (Str != NULL) {
506 FreePool (Str);
507 }
508
509 return Status;
510 }
511
512 /**
513 This function merges DefaultAltCfgResp string into AltCfgResp string for
514 the missing AltCfgId in AltCfgResq.
515
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.
523
524 @retval EFI_SUCCESS The merged string returns.
525 @retval EFI_INVALID_PARAMETER *AltCfgResp is to NULL.
526 **/
527 EFI_STATUS
528 EFIAPI
529 MergeDefaultString (
530 IN OUT EFI_STRING *AltCfgResp,
531 IN EFI_STRING DefaultAltCfgResp
532 )
533 {
534 EFI_STRING StringPtrDefault;
535 EFI_STRING StringPtrEnd;
536 CHAR16 TempChar;
537 EFI_STRING StringPtr;
538 EFI_STRING AltConfigHdr;
539 UINTN HeaderLength;
540 UINTN SizeAltCfgResp;
541 UINTN MaxLen;
542 UINTN TotalSize;
543
544 if (*AltCfgResp == NULL) {
545 return EFI_INVALID_PARAMETER;
546 }
547
548 //
549 // Get the requestr ConfigHdr
550 //
551 SizeAltCfgResp = 0;
552 StringPtr = *AltCfgResp;
553
554 //
555 // Find <ConfigHdr> GUID=...&NAME=...&PATH=...
556 //
557 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
558 return EFI_INVALID_PARAMETER;
559 }
560 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&NAME=", StrLen (L"&NAME=")) != 0) {
561 StringPtr++;
562 }
563 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&PATH=", StrLen (L"&PATH=")) != 0) {
564 StringPtr++;
565 }
566 if (*StringPtr == L'\0') {
567 return EFI_INVALID_PARAMETER;
568 }
569 StringPtr += StrLen (L"&PATH=");
570 while (*StringPtr != L'\0' && *StringPtr != L'&') {
571 StringPtr ++;
572 }
573 HeaderLength = StringPtr - *AltCfgResp;
574
575 //
576 // Construct AltConfigHdr string "&<ConfigHdr>&ALTCFG=XXXX\0"
577 // |1| StrLen (ConfigHdr) | 8 | 4 | 1 |
578 //
579 MaxLen = 1 + HeaderLength + 8 + 4 + 1;
580 AltConfigHdr = AllocateZeroPool (MaxLen * sizeof (CHAR16));
581 if (AltConfigHdr == NULL) {
582 return EFI_OUT_OF_RESOURCES;
583 }
584 StrCpyS (AltConfigHdr, MaxLen, L"&");
585 StrnCatS (AltConfigHdr, MaxLen, *AltCfgResp, HeaderLength);
586 StrCatS (AltConfigHdr, MaxLen, L"&ALTCFG=");
587 HeaderLength = StrLen (AltConfigHdr);
588
589 StringPtrDefault = StrStr (DefaultAltCfgResp, AltConfigHdr);
590 while (StringPtrDefault != NULL) {
591 //
592 // Get AltCfg Name
593 //
594 StrnCatS (AltConfigHdr, MaxLen, StringPtrDefault + HeaderLength, 4);
595 StringPtr = StrStr (*AltCfgResp, AltConfigHdr);
596
597 //
598 // Append the found default value string to the input AltCfgResp
599 //
600 if (StringPtr == NULL) {
601 StringPtrEnd = StrStr (StringPtrDefault + 1, L"&GUID");
602 SizeAltCfgResp = StrSize (*AltCfgResp);
603 TotalSize = SizeAltCfgResp + StrSize (StringPtrDefault);
604 if (StringPtrEnd == NULL) {
605 //
606 // No more default string is found.
607 //
608 *AltCfgResp = (EFI_STRING) ReallocatePool (
609 SizeAltCfgResp,
610 TotalSize,
611 (VOID *) (*AltCfgResp)
612 );
613 if (*AltCfgResp == NULL) {
614 FreePool (AltConfigHdr);
615 return EFI_OUT_OF_RESOURCES;
616 }
617 StrCatS (*AltCfgResp, TotalSize / sizeof (CHAR16), StringPtrDefault);
618 break;
619 } else {
620 TempChar = *StringPtrEnd;
621 *StringPtrEnd = L'\0';
622 *AltCfgResp = (EFI_STRING) ReallocatePool (
623 SizeAltCfgResp,
624 TotalSize,
625 (VOID *) (*AltCfgResp)
626 );
627 if (*AltCfgResp == NULL) {
628 FreePool (AltConfigHdr);
629 return EFI_OUT_OF_RESOURCES;
630 }
631 StrCatS (*AltCfgResp, TotalSize / sizeof (CHAR16), StringPtrDefault);
632 *StringPtrEnd = TempChar;
633 }
634 }
635
636 //
637 // Find next AltCfg String
638 //
639 *(AltConfigHdr + HeaderLength) = L'\0';
640 StringPtrDefault = StrStr (StringPtrDefault + 1, AltConfigHdr);
641 }
642
643 FreePool (AltConfigHdr);
644 return EFI_SUCCESS;
645 }
646
647 /**
648 This function inserts new DefaultValueData into the BlockData DefaultValue array.
649
650 @param BlockData The BlockData is updated to add new default value.
651 @param DefaultValueData The DefaultValue is added.
652
653 **/
654 VOID
655 InsertDefaultValue (
656 IN IFR_BLOCK_DATA *BlockData,
657 IN IFR_DEFAULT_DATA *DefaultValueData
658 )
659 {
660 LIST_ENTRY *Link;
661 IFR_DEFAULT_DATA *DefaultValueArray;
662 LIST_ENTRY *DefaultLink;
663
664 DefaultLink = &BlockData->DefaultValueEntry;
665
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) {
669 //
670 // DEFAULT_VALUE_FROM_OPCODE has high priority, DEFAULT_VALUE_FROM_DEFAULT has low priority.
671 //
672 if (DefaultValueData->Type > DefaultValueArray->Type) {
673 //
674 // Update the default value array in BlockData.
675 //
676 CopyMem (&DefaultValueArray->Value, &DefaultValueData->Value, sizeof (EFI_IFR_TYPE_VALUE));
677 DefaultValueArray->Type = DefaultValueData->Type;
678 DefaultValueArray->Cleaned = DefaultValueData->Cleaned;
679 }
680 return;
681 }
682 }
683
684 //
685 // Insert new default value data in tail.
686 //
687 DefaultValueArray = AllocateZeroPool (sizeof (IFR_DEFAULT_DATA));
688 ASSERT (DefaultValueArray != NULL);
689 CopyMem (DefaultValueArray, DefaultValueData, sizeof (IFR_DEFAULT_DATA));
690 InsertTailList (Link, &DefaultValueArray->Entry);
691 }
692
693 /**
694 This function inserts new BlockData into the block link
695
696 @param BlockLink The list entry points to block array.
697 @param BlockData The point to BlockData is added.
698
699 **/
700 VOID
701 InsertBlockData (
702 IN LIST_ENTRY *BlockLink,
703 IN IFR_BLOCK_DATA **BlockData
704 )
705 {
706 LIST_ENTRY *Link;
707 IFR_BLOCK_DATA *BlockArray;
708 IFR_BLOCK_DATA *BlockSingleData;
709
710 BlockSingleData = *BlockData;
711
712 if (BlockSingleData->Name != NULL) {
713 InsertTailList (BlockLink, &BlockSingleData->Entry);
714 return;
715 }
716
717 //
718 // Insert block data in its Offset and Width order.
719 //
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) {
724 //
725 // Insert this block data in the front of block array
726 //
727 InsertTailList (Link, &BlockSingleData->Entry);
728 return;
729 }
730
731 if (BlockArray->Width == BlockSingleData->Width) {
732 //
733 // The same block array has been added.
734 //
735 if (BlockSingleData != BlockArray) {
736 FreePool (BlockSingleData);
737 *BlockData = BlockArray;
738 }
739 return;
740 }
741 } else if (BlockArray->Offset > BlockSingleData->Offset) {
742 //
743 // Insert new block data in the front of block array
744 //
745 InsertTailList (Link, &BlockSingleData->Entry);
746 return;
747 }
748 }
749
750 //
751 // Add new block data into the tail.
752 //
753 InsertTailList (Link, &BlockSingleData->Entry);
754 }
755
756 /**
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.
762
763 If HiiHandle is NULL, then ASSERT().
764
765 @param[in] HiiHandle A handle that was previously registered in the HII Database.
766
767 @retval NULL HiiHandle is not registered in the HII database
768 @retval NULL There are not enough resources available to retrieve the suported
769 languages.
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.
772
773 **/
774 CHAR8 *
775 GetSupportedLanguages (
776 IN EFI_HII_HANDLE HiiHandle
777 )
778 {
779 EFI_STATUS Status;
780 UINTN LanguageSize;
781 CHAR8 TempSupportedLanguages;
782 CHAR8 *SupportedLanguages;
783
784 ASSERT (HiiHandle != NULL);
785
786 //
787 // Retrieve the size required for the supported languages buffer.
788 //
789 LanguageSize = 0;
790 Status = mPrivate.HiiString.GetLanguages (&mPrivate.HiiString, HiiHandle, &TempSupportedLanguages, &LanguageSize);
791
792 //
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
797 //
798 if (Status != EFI_BUFFER_TOO_SMALL) {
799 //
800 // Return NULL if the size can not be retrieved, or if HiiHandle is not in the HII Database
801 //
802 return NULL;
803 }
804
805 //
806 // Allocate the supported languages buffer.
807 //
808 SupportedLanguages = AllocateZeroPool (LanguageSize);
809 if (SupportedLanguages == NULL) {
810 //
811 // Return NULL if allocation fails.
812 //
813 return NULL;
814 }
815
816 //
817 // Retrieve the supported languages string
818 //
819 Status = mPrivate.HiiString.GetLanguages (&mPrivate.HiiString, HiiHandle, SupportedLanguages, &LanguageSize);
820 if (EFI_ERROR (Status)) {
821 //
822 // Free the buffer and return NULL if the supported languages can not be retrieved.
823 //
824 FreePool (SupportedLanguages);
825 return NULL;
826 }
827
828 //
829 // Return the Null-terminated ASCII string of supported languages
830 //
831 return SupportedLanguages;
832 }
833
834 /**
835 Retrieves a string from a string package.
836
837 If HiiHandle is NULL, then ASSERT().
838 If StringId is 0, then ASSET.
839
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.
843
844 @retval NULL The string specified by StringId is not present in the string package.
845 @retval Other The string was returned.
846
847 **/
848 EFI_STRING
849 InternalGetString (
850 IN EFI_HII_HANDLE HiiHandle,
851 IN EFI_STRING_ID StringId
852 )
853 {
854 EFI_STATUS Status;
855 UINTN StringSize;
856 CHAR16 TempString;
857 EFI_STRING String;
858 CHAR8 *SupportedLanguages;
859 CHAR8 *PlatformLanguage;
860 CHAR8 *BestLanguage;
861 CHAR8 *Language;
862
863 ASSERT (HiiHandle != NULL);
864 ASSERT (StringId != 0);
865
866 //
867 // Initialize all allocated buffers to NULL
868 //
869 SupportedLanguages = NULL;
870 PlatformLanguage = NULL;
871 BestLanguage = NULL;
872 String = NULL;
873 Language = "";
874
875 //
876 // Get the languages that the package specified by HiiHandle supports
877 //
878 SupportedLanguages = GetSupportedLanguages (HiiHandle);
879 if (SupportedLanguages == NULL) {
880 goto Error;
881 }
882
883 //
884 // Get the current platform language setting
885 //
886 GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);
887
888 //
889 // Get the best matching language from SupportedLanguages
890 //
891 BestLanguage = GetBestLanguage (
892 SupportedLanguages,
893 FALSE, // RFC 4646 mode
894 Language, // Highest priority
895 PlatformLanguage != NULL ? PlatformLanguage : "", // Next highest priority
896 SupportedLanguages, // Lowest priority
897 NULL
898 );
899 if (BestLanguage == NULL) {
900 goto Error;
901 }
902
903 //
904 // Retrieve the size of the string in the string package for the BestLanguage
905 //
906 StringSize = 0;
907 Status = mPrivate.HiiString.GetString (
908 &mPrivate.HiiString,
909 BestLanguage,
910 HiiHandle,
911 StringId,
912 &TempString,
913 &StringSize,
914 NULL
915 );
916 //
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
921 //
922 if (Status != EFI_BUFFER_TOO_SMALL) {
923 goto Error;
924 }
925
926 //
927 // Allocate a buffer for the return string
928 //
929 String = AllocateZeroPool (StringSize);
930 if (String == NULL) {
931 goto Error;
932 }
933
934 //
935 // Retrieve the string from the string package
936 //
937 Status = mPrivate.HiiString.GetString (
938 &mPrivate.HiiString,
939 BestLanguage,
940 HiiHandle,
941 StringId,
942 String,
943 &StringSize,
944 NULL
945 );
946 if (EFI_ERROR (Status)) {
947 //
948 // Free the buffer and return NULL if the supported languages can not be retrieved.
949 //
950 FreePool (String);
951 String = NULL;
952 }
953
954 Error:
955 //
956 // Free allocated buffers
957 //
958 if (SupportedLanguages != NULL) {
959 FreePool (SupportedLanguages);
960 }
961 if (PlatformLanguage != NULL) {
962 FreePool (PlatformLanguage);
963 }
964 if (BestLanguage != NULL) {
965 FreePool (BestLanguage);
966 }
967
968 //
969 // Return the Null-terminated Unicode string
970 //
971 return String;
972 }
973
974 /**
975 This function checks VarOffset and VarWidth is in the block range.
976
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.
982
983 @retval TRUE This Var is in the block range.
984 @retval FALSE This Var is not in the block range.
985 **/
986 BOOLEAN
987 BlockArrayCheck (
988 IN IFR_BLOCK_DATA *RequestBlockArray,
989 IN UINT16 VarOffset,
990 IN UINT16 VarWidth,
991 IN BOOLEAN IsNameValueType,
992 IN EFI_HII_HANDLE HiiHandle
993 )
994 {
995 LIST_ENTRY *Link;
996 IFR_BLOCK_DATA *BlockData;
997 EFI_STRING Name;
998
999 //
1000 // No Request Block array, all vars are got.
1001 //
1002 if (RequestBlockArray == NULL) {
1003 return TRUE;
1004 }
1005
1006 //
1007 // Check the input var is in the request block range.
1008 //
1009 for (Link = RequestBlockArray->Entry.ForwardLink; Link != &RequestBlockArray->Entry; Link = Link->ForwardLink) {
1010 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);
1011
1012 if (IsNameValueType) {
1013 Name = InternalGetString (HiiHandle, VarOffset);
1014 ASSERT (Name != NULL);
1015
1016 if (StrnCmp (BlockData->Name, Name, StrLen (Name)) == 0) {
1017 FreePool (Name);
1018 return TRUE;
1019 }
1020 FreePool (Name);
1021 } else {
1022 if ((VarOffset >= BlockData->Offset) && ((VarOffset + VarWidth) <= (BlockData->Offset + BlockData->Width))) {
1023 return TRUE;
1024 }
1025 }
1026 }
1027
1028 return FALSE;
1029 }
1030
1031 /**
1032 Get form package data from data base.
1033
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.
1037
1038 **/
1039 EFI_STATUS
1040 GetFormPackageData (
1041 IN HII_DATABASE_RECORD *DataBaseRecord,
1042 IN OUT UINT8 **HiiFormPackage,
1043 OUT UINTN *PackageSize
1044 )
1045 {
1046 EFI_STATUS Status;
1047 UINTN Size;
1048 UINTN ResultSize;
1049
1050 if (DataBaseRecord == NULL || HiiFormPackage == NULL || PackageSize == NULL) {
1051 return EFI_INVALID_PARAMETER;
1052 }
1053
1054 Size = 0;
1055 ResultSize = 0;
1056 //
1057 // 0. Get Hii Form Package by HiiHandle
1058 //
1059 Status = ExportFormPackages (
1060 &mPrivate,
1061 DataBaseRecord->Handle,
1062 DataBaseRecord->PackageList,
1063 0,
1064 Size,
1065 HiiFormPackage,
1066 &ResultSize
1067 );
1068 if (EFI_ERROR (Status)) {
1069 return Status;
1070 }
1071
1072 (*HiiFormPackage) = AllocatePool (ResultSize);
1073 if (*HiiFormPackage == NULL) {
1074 Status = EFI_OUT_OF_RESOURCES;
1075 return Status;
1076 }
1077
1078 //
1079 // Get HiiFormPackage by HiiHandle
1080 //
1081 Size = ResultSize;
1082 ResultSize = 0;
1083 Status = ExportFormPackages (
1084 &mPrivate,
1085 DataBaseRecord->Handle,
1086 DataBaseRecord->PackageList,
1087 0,
1088 Size,
1089 *HiiFormPackage,
1090 &ResultSize
1091 );
1092 if (EFI_ERROR (Status)) {
1093 FreePool (*HiiFormPackage);
1094 }
1095
1096 *PackageSize = Size;
1097
1098 return Status;
1099 }
1100
1101
1102 /**
1103 This function parses Form Package to get the efi varstore info according to the request ConfigHdr.
1104
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.
1110 **/
1111 EFI_STATUS
1112 GetVarStoreType (
1113 IN HII_DATABASE_RECORD *DataBaseRecord,
1114 IN EFI_STRING ConfigHdr,
1115 OUT BOOLEAN *IsEfiVarstore,
1116 OUT EFI_IFR_VARSTORE_EFI **EfiVarStore
1117 )
1118 {
1119 EFI_STATUS Status;
1120 UINTN IfrOffset;
1121 UINTN PackageOffset;
1122 EFI_IFR_OP_HEADER *IfrOpHdr;
1123 CHAR16 *VarStoreName;
1124 EFI_STRING GuidStr;
1125 EFI_STRING NameStr;
1126 EFI_STRING TempStr;
1127 UINTN LengthString;
1128 UINT8 *HiiFormPackage;
1129 UINTN PackageSize;
1130 EFI_IFR_VARSTORE_EFI *IfrEfiVarStore;
1131 EFI_HII_PACKAGE_HEADER *PackageHeader;
1132
1133 HiiFormPackage = NULL;
1134 LengthString = 0;
1135 Status = EFI_SUCCESS;
1136 GuidStr = NULL;
1137 NameStr = NULL;
1138 TempStr = NULL;
1139 *IsEfiVarstore = FALSE;
1140
1141 Status = GetFormPackageData(DataBaseRecord, &HiiFormPackage, &PackageSize);
1142 if (EFI_ERROR (Status)) {
1143 return Status;
1144 }
1145
1146 IfrOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1147 PackageOffset = IfrOffset;
1148 PackageHeader = (EFI_HII_PACKAGE_HEADER *) HiiFormPackage;
1149
1150 while (IfrOffset < PackageSize) {
1151 //
1152 // More than one form packages exist.
1153 //
1154 if (PackageOffset >= PackageHeader->Length) {
1155 //
1156 // Process the new form package.
1157 //
1158 PackageOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1159 IfrOffset += PackageOffset;
1160 PackageHeader = (EFI_HII_PACKAGE_HEADER *) (HiiFormPackage + IfrOffset);
1161 }
1162
1163 IfrOpHdr = (EFI_IFR_OP_HEADER *) (HiiFormPackage + IfrOffset);
1164 IfrOffset += IfrOpHdr->Length;
1165 PackageOffset += IfrOpHdr->Length;
1166
1167 if (IfrOpHdr->OpCode == EFI_IFR_VARSTORE_EFI_OP ) {
1168 IfrEfiVarStore = (EFI_IFR_VARSTORE_EFI *) IfrOpHdr;
1169 //
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.
1173 //
1174 if (IfrOpHdr->Length < sizeof (EFI_IFR_VARSTORE_EFI)) {
1175 continue;
1176 }
1177
1178 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)IfrEfiVarStore->Name) * sizeof (CHAR16));
1179 if (VarStoreName == NULL) {
1180 Status = EFI_OUT_OF_RESOURCES;
1181 goto Done;
1182 }
1183 AsciiStrToUnicodeStr ((CHAR8 *) IfrEfiVarStore->Name, VarStoreName);
1184
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) {
1191 FreePool (GuidStr);
1192 FreePool (NameStr);
1193 FreePool (VarStoreName);
1194 Status = EFI_OUT_OF_RESOURCES;
1195 goto Done;
1196 }
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);
1203 FreePool (GuidStr);
1204 FreePool (NameStr);
1205 FreePool (TempStr);
1206 Status = EFI_OUT_OF_RESOURCES;
1207 goto Done;
1208 }
1209 *IsEfiVarstore = TRUE;
1210 CopyMem (*EfiVarStore, IfrEfiVarStore, IfrOpHdr->Length);
1211 }
1212
1213 //
1214 // Free alllocated temp string.
1215 //
1216 FreePool (VarStoreName);
1217 FreePool (GuidStr);
1218 FreePool (NameStr);
1219 FreePool (TempStr);
1220
1221 //
1222 // Already found the varstore, break;
1223 //
1224 if (*IsEfiVarstore) {
1225 break;
1226 }
1227 }
1228 }
1229 Done:
1230 if (HiiFormPackage != NULL) {
1231 FreePool (HiiFormPackage);
1232 }
1233
1234 return Status;
1235 }
1236
1237 /**
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.
1241
1242 @param ConfigRequest The input config request string.
1243
1244 @retval TRUE The input include config request elements.
1245 @retval FALSE The input string not includes.
1246
1247 **/
1248 BOOLEAN
1249 GetElementsFromRequest (
1250 IN EFI_STRING ConfigRequest
1251 )
1252 {
1253 EFI_STRING TmpRequest;
1254
1255 TmpRequest = StrStr (ConfigRequest, L"PATH=");
1256 ASSERT (TmpRequest != NULL);
1257
1258 if ((StrStr (TmpRequest, L"&OFFSET=") != NULL) || (StrStr (TmpRequest, L"&") != NULL)) {
1259 return TRUE;
1260 }
1261
1262 return FALSE;
1263 }
1264
1265 /**
1266 Check whether the this varstore is the request varstore.
1267
1268 @param VarstoreGuid Varstore guid.
1269 @param Name Varstore name.
1270 @param ConfigHdr Current configRequest info.
1271
1272 @retval TRUE This varstore is the requst one.
1273 @retval FALSE This varstore is not the requst one.
1274
1275 **/
1276 BOOLEAN
1277 IsThisVarstore (
1278 IN EFI_GUID *VarstoreGuid,
1279 IN CHAR16 *Name,
1280 IN CHAR16 *ConfigHdr
1281 )
1282 {
1283 EFI_STRING GuidStr;
1284 EFI_STRING NameStr;
1285 EFI_STRING TempStr;
1286 UINTN LengthString;
1287 BOOLEAN RetVal;
1288
1289 RetVal = FALSE;
1290 GuidStr = NULL;
1291 TempStr = NULL;
1292
1293 //
1294 // If ConfigHdr has name field and varstore not has name, return FALSE.
1295 //
1296 if (Name == NULL && ConfigHdr != NULL && StrStr (ConfigHdr, L"NAME=&") == NULL) {
1297 return FALSE;
1298 }
1299
1300 GenerateSubStr (L"GUID=", sizeof (EFI_GUID), (VOID *)VarstoreGuid, 1, &GuidStr);
1301 if (Name != NULL) {
1302 GenerateSubStr (L"NAME=", StrLen (Name) * sizeof (CHAR16), (VOID *) Name, 2, &NameStr);
1303 } else {
1304 GenerateSubStr (L"NAME=", 0, NULL, 2, &NameStr);
1305 }
1306 LengthString = StrLen (GuidStr);
1307 LengthString = LengthString + StrLen (NameStr) + 1;
1308 TempStr = AllocateZeroPool (LengthString * sizeof (CHAR16));
1309 if (TempStr == NULL) {
1310 goto Done;
1311 }
1312
1313 StrCpyS (TempStr, LengthString, GuidStr);
1314 StrCatS (TempStr, LengthString, NameStr);
1315
1316 if (ConfigHdr == NULL || StrnCmp (ConfigHdr, TempStr, StrLen (TempStr)) == 0) {
1317 RetVal = TRUE;
1318 }
1319
1320 Done:
1321 if (GuidStr != NULL) {
1322 FreePool (GuidStr);
1323 }
1324
1325 if (NameStr != NULL) {
1326 FreePool (NameStr);
1327 }
1328
1329 if (TempStr != NULL) {
1330 FreePool (TempStr);
1331 }
1332
1333 return RetVal;
1334 }
1335
1336 /**
1337 This function parses Form Package to get the efi varstore info according to the request ConfigHdr.
1338
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.
1344 **/
1345 BOOLEAN
1346 IsThisPackageList (
1347 IN HII_DATABASE_RECORD *DataBaseRecord,
1348 IN EFI_STRING ConfigHdr
1349 )
1350 {
1351 EFI_STATUS Status;
1352 UINTN IfrOffset;
1353 UINTN PackageOffset;
1354 EFI_IFR_OP_HEADER *IfrOpHdr;
1355 CHAR16 *VarStoreName;
1356 UINT8 *HiiFormPackage;
1357 UINTN PackageSize;
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;
1363
1364 HiiFormPackage = NULL;
1365 VarStoreName = NULL;
1366 Status = EFI_SUCCESS;
1367 FindVarstore = FALSE;
1368
1369 Status = GetFormPackageData(DataBaseRecord, &HiiFormPackage, &PackageSize);
1370 if (EFI_ERROR (Status)) {
1371 return FALSE;
1372 }
1373
1374 IfrOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1375 PackageOffset = IfrOffset;
1376 PackageHeader = (EFI_HII_PACKAGE_HEADER *) HiiFormPackage;
1377
1378 while (IfrOffset < PackageSize) {
1379 //
1380 // More than one form packages exist.
1381 //
1382 if (PackageOffset >= PackageHeader->Length) {
1383 //
1384 // Process the new form package.
1385 //
1386 PackageOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1387 IfrOffset += PackageOffset;
1388 PackageHeader = (EFI_HII_PACKAGE_HEADER *) (HiiFormPackage + IfrOffset);
1389 }
1390
1391 IfrOpHdr = (EFI_IFR_OP_HEADER *) (HiiFormPackage + IfrOffset);
1392 IfrOffset += IfrOpHdr->Length;
1393 PackageOffset += IfrOpHdr->Length;
1394
1395 switch (IfrOpHdr->OpCode) {
1396
1397 case EFI_IFR_VARSTORE_OP:
1398 IfrVarStore = (EFI_IFR_VARSTORE *) IfrOpHdr;
1399
1400 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)IfrVarStore->Name) * sizeof (CHAR16));
1401 if (VarStoreName == NULL) {
1402 goto Done;
1403 }
1404 AsciiStrToUnicodeStr ((CHAR8 *)IfrVarStore->Name, VarStoreName);
1405
1406 if (IsThisVarstore((VOID *)&IfrVarStore->Guid, VarStoreName, ConfigHdr)) {
1407 FindVarstore = TRUE;
1408 goto Done;
1409 }
1410 break;
1411
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) {
1416 goto Done;
1417 }
1418 AsciiStrToUnicodeStr ((CHAR8 *)IfrEfiVarStore->Name, VarStoreName);
1419
1420 if (IsThisVarstore (&IfrEfiVarStore->Guid, VarStoreName, ConfigHdr)) {
1421 FindVarstore = TRUE;
1422 goto Done;
1423 }
1424 break;
1425
1426 case EFI_IFR_VARSTORE_NAME_VALUE_OP:
1427 IfrNameValueVarStore = (EFI_IFR_VARSTORE_NAME_VALUE *) IfrOpHdr;
1428
1429 if (IsThisVarstore (&IfrNameValueVarStore->Guid, NULL, ConfigHdr)) {
1430 FindVarstore = TRUE;
1431 goto Done;
1432 }
1433 break;
1434
1435 case EFI_IFR_FORM_OP:
1436 case EFI_IFR_FORM_MAP_OP:
1437 //
1438 // No matched varstore is found and directly return.
1439 //
1440 goto Done;
1441
1442 default:
1443 break;
1444 }
1445 }
1446 Done:
1447 if (HiiFormPackage != NULL) {
1448 FreePool (HiiFormPackage);
1449 }
1450
1451 if (VarStoreName != NULL) {
1452 FreePool (VarStoreName);
1453 }
1454
1455 return FindVarstore;
1456 }
1457
1458 /**
1459 Check whether the this op code is required.
1460
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.
1467
1468 @retval EFI_SUCCESS This opcode is required.
1469 @retval Others This opcode is not required or error occur.
1470
1471 **/
1472 EFI_STATUS
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,
1478 IN UINT16 VarWidth,
1479 OUT IFR_BLOCK_DATA **ReturnData
1480 )
1481 {
1482 IFR_BLOCK_DATA *BlockData;
1483 UINT16 VarOffset;
1484 EFI_STRING_ID NameId;
1485 EFI_IFR_QUESTION_HEADER *IfrQuestionHdr;
1486
1487 NameId = 0;
1488 VarOffset = 0;
1489 IfrQuestionHdr = (EFI_IFR_QUESTION_HEADER *)((CHAR8 *) IfrOpHdr + sizeof (EFI_IFR_OP_HEADER));
1490
1491 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
1492 NameId = IfrQuestionHdr->VarStoreInfo.VarName;
1493
1494 //
1495 // Check whether this question is in requested block array.
1496 //
1497 if (!BlockArrayCheck (RequestBlockArray, NameId, 0, TRUE, HiiHandle)) {
1498 //
1499 // This question is not in the requested string. Skip it.
1500 //
1501 return EFI_SUCCESS;
1502 }
1503 } else {
1504 VarOffset = IfrQuestionHdr->VarStoreInfo.VarOffset;
1505
1506 //
1507 // Check whether this question is in requested block array.
1508 //
1509 if (!BlockArrayCheck (RequestBlockArray, VarOffset, VarWidth, FALSE, HiiHandle)) {
1510 //
1511 // This question is not in the requested string. Skip it.
1512 //
1513 return EFI_SUCCESS;
1514 }
1515
1516 //
1517 // Check this var question is in the var storage
1518 //
1519 if (((VarOffset + VarWidth) > VarStorageData->Size)) {
1520 return EFI_INVALID_PARAMETER;
1521 }
1522 }
1523
1524 BlockData = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));
1525 if (BlockData == NULL) {
1526 return EFI_OUT_OF_RESOURCES;
1527 }
1528
1529 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
1530 BlockData->Name = InternalGetString(HiiHandle, NameId);
1531 } else {
1532 BlockData->Offset = VarOffset;
1533 }
1534
1535 BlockData->Width = VarWidth;
1536 BlockData->QuestionId = IfrQuestionHdr->QuestionId;
1537 BlockData->OpCode = IfrOpHdr->OpCode;
1538 BlockData->Scope = IfrOpHdr->Scope;
1539 InitializeListHead (&BlockData->DefaultValueEntry);
1540 //
1541 // Add Block Data into VarStorageData BlockEntry
1542 //
1543 InsertBlockData (&VarStorageData->BlockEntry, &BlockData);
1544 *ReturnData = BlockData;
1545
1546 return EFI_SUCCESS;
1547 }
1548
1549 /**
1550 This function parses Form Package to get the block array and the default
1551 value array according to the request ConfigHdr.
1552
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.
1561
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
1564 are conflicted.
1565 @retval EFI_OUT_OF_RESOURCES No enough memory.
1566 **/
1567 EFI_STATUS
1568 EFIAPI
1569 ParseIfrData (
1570 IN EFI_HII_HANDLE HiiHandle,
1571 IN UINT8 *Package,
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
1577 )
1578 {
1579 EFI_STATUS Status;
1580 UINTN IfrOffset;
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;
1599 UINT16 VarWidth;
1600 UINT16 VarDefaultId;
1601 BOOLEAN FirstOneOfOption;
1602 LIST_ENTRY *LinkData;
1603 LIST_ENTRY *LinkDefault;
1604 EFI_IFR_VARSTORE_NAME_VALUE *IfrNameValueVarStore;
1605 EFI_HII_PACKAGE_HEADER *PackageHeader;
1606 EFI_VARSTORE_ID VarStoreId;
1607
1608 Status = EFI_SUCCESS;
1609 BlockData = NULL;
1610 DefaultDataPtr = NULL;
1611 FirstOneOfOption = FALSE;
1612 VarStoreId = 0;
1613 ZeroMem (&DefaultData, sizeof (IFR_DEFAULT_DATA));
1614
1615 //
1616 // Go through the form package to parse OpCode one by one.
1617 //
1618 PackageOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1619 PackageHeader = (EFI_HII_PACKAGE_HEADER *) Package;
1620 IfrOffset = PackageOffset;
1621 while (IfrOffset < PackageLength) {
1622
1623 //
1624 // More than one form package found.
1625 //
1626 if (PackageOffset >= PackageHeader->Length) {
1627 //
1628 // Already found varstore for this request, break;
1629 //
1630 if (VarStoreId != 0) {
1631 VarStoreId = 0;
1632 }
1633
1634 //
1635 // Get next package header info.
1636 //
1637 IfrOffset += sizeof (EFI_HII_PACKAGE_HEADER);
1638 PackageOffset = sizeof (EFI_HII_PACKAGE_HEADER);
1639 PackageHeader = (EFI_HII_PACKAGE_HEADER *) (Package + IfrOffset);
1640 }
1641
1642 IfrOpHdr = (EFI_IFR_OP_HEADER *) (Package + IfrOffset);
1643 switch (IfrOpHdr->OpCode) {
1644 case EFI_IFR_VARSTORE_OP:
1645 //
1646 // VarStore is found. Don't need to search any more.
1647 //
1648 if (VarStoreId != 0) {
1649 break;
1650 }
1651
1652 IfrVarStore = (EFI_IFR_VARSTORE *) IfrOpHdr;
1653
1654 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)IfrVarStore->Name) * sizeof (CHAR16));
1655 if (VarStoreName == NULL) {
1656 Status = EFI_OUT_OF_RESOURCES;
1657 goto Done;
1658 }
1659 AsciiStrToUnicodeStr ((CHAR8 *)IfrVarStore->Name, VarStoreName);
1660
1661 if (IsThisVarstore((VOID *)&IfrVarStore->Guid, VarStoreName, ConfigHdr)) {
1662 //
1663 // Find the matched VarStore
1664 //
1665 CopyGuid (&VarStorageData->Guid, (EFI_GUID *) (VOID *) &IfrVarStore->Guid);
1666 VarStorageData->Size = IfrVarStore->Size;
1667 VarStorageData->Name = VarStoreName;
1668 VarStorageData->Type = EFI_HII_VARSTORE_BUFFER;
1669 VarStoreId = IfrVarStore->VarStoreId;
1670 }
1671 break;
1672
1673 case EFI_IFR_VARSTORE_EFI_OP:
1674 //
1675 // VarStore is found. Don't need to search any more.
1676 //
1677 if (VarStoreId != 0) {
1678 break;
1679 }
1680
1681 IfrEfiVarStore = (EFI_IFR_VARSTORE_EFI *) IfrOpHdr;
1682
1683 //
1684 // If the length is small than the structure, this is from old efi
1685 // varstore definition. Old efi varstore get config directly from
1686 // GetVariable function.
1687 //
1688 if (IfrOpHdr->Length < sizeof (EFI_IFR_VARSTORE_EFI)) {
1689 break;
1690 }
1691
1692 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)IfrEfiVarStore->Name) * sizeof (CHAR16));
1693 if (VarStoreName == NULL) {
1694 Status = EFI_OUT_OF_RESOURCES;
1695 goto Done;
1696 }
1697 AsciiStrToUnicodeStr ((CHAR8 *)IfrEfiVarStore->Name, VarStoreName);
1698
1699 if (IsThisVarstore (&IfrEfiVarStore->Guid, VarStoreName, ConfigHdr)) {
1700 //
1701 // Find the matched VarStore
1702 //
1703 CopyGuid (&VarStorageData->Guid, (EFI_GUID *) (VOID *) &IfrEfiVarStore->Guid);
1704 VarStorageData->Size = IfrEfiVarStore->Size;
1705 VarStorageData->Name = VarStoreName;
1706 VarStorageData->Type = EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER;
1707 VarStoreId = IfrEfiVarStore->VarStoreId;
1708 }
1709 break;
1710
1711 case EFI_IFR_VARSTORE_NAME_VALUE_OP:
1712 //
1713 // VarStore is found. Don't need to search any more.
1714 //
1715 if (VarStoreId != 0) {
1716 break;
1717 }
1718
1719 IfrNameValueVarStore = (EFI_IFR_VARSTORE_NAME_VALUE *) IfrOpHdr;
1720
1721 if (IsThisVarstore (&IfrNameValueVarStore->Guid, NULL, ConfigHdr)) {
1722 //
1723 // Find the matched VarStore
1724 //
1725 CopyGuid (&VarStorageData->Guid, (EFI_GUID *) (VOID *) &IfrNameValueVarStore->Guid);
1726 VarStorageData->Type = EFI_HII_VARSTORE_NAME_VALUE;
1727 VarStoreId = IfrNameValueVarStore->VarStoreId;
1728 }
1729 break;
1730
1731 case EFI_IFR_DEFAULTSTORE_OP:
1732 //
1733 // Add new the map between default id and default name.
1734 //
1735 DefaultDataPtr = (IFR_DEFAULT_DATA *) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA));
1736 if (DefaultDataPtr == NULL) {
1737 Status = EFI_OUT_OF_RESOURCES;
1738 goto Done;
1739 }
1740 DefaultDataPtr->DefaultId = ((EFI_IFR_DEFAULTSTORE *) IfrOpHdr)->DefaultId;
1741 InsertTailList (&DefaultIdArray->Entry, &DefaultDataPtr->Entry);
1742 DefaultDataPtr = NULL;
1743 break;
1744
1745 case EFI_IFR_FORM_OP:
1746 case EFI_IFR_FORM_MAP_OP:
1747 //
1748 // No matched varstore is found and directly return.
1749 //
1750 if ( VarStoreId == 0) {
1751 Status = EFI_SUCCESS;
1752 goto Done;
1753 }
1754 break;
1755
1756 case EFI_IFR_REF_OP:
1757 //
1758 // Ref question is not in IFR Form. This IFR form is not valid.
1759 //
1760 if ( VarStoreId == 0) {
1761 Status = EFI_INVALID_PARAMETER;
1762 goto Done;
1763 }
1764 //
1765 // Check whether this question is for the requested varstore.
1766 //
1767 IfrRef = (EFI_IFR_REF4 *) IfrOpHdr;
1768 if (IfrRef->Question.VarStoreId != VarStoreId) {
1769 break;
1770 }
1771 VarWidth = (UINT16) (sizeof (EFI_HII_REF));
1772
1773 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
1774 if (EFI_ERROR (Status)) {
1775 goto Done;
1776 }
1777 break;
1778
1779 case EFI_IFR_ONE_OF_OP:
1780 case EFI_IFR_NUMERIC_OP:
1781 //
1782 // Numeric and OneOf has the same opcode structure.
1783 //
1784
1785 //
1786 // Numeric and OneOf question is not in IFR Form. This IFR form is not valid.
1787 //
1788 if (VarStoreId == 0) {
1789 Status = EFI_INVALID_PARAMETER;
1790 goto Done;
1791 }
1792 //
1793 // Check whether this question is for the requested varstore.
1794 //
1795 IfrOneOf = (EFI_IFR_ONE_OF *) IfrOpHdr;
1796 if (IfrOneOf->Question.VarStoreId != VarStoreId) {
1797 break;
1798 }
1799 VarWidth = (UINT16) (1 << (IfrOneOf->Flags & EFI_IFR_NUMERIC_SIZE));
1800
1801 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
1802 if (EFI_ERROR (Status)) {
1803 goto Done;
1804 }
1805
1806 if (BlockData == NULL) {
1807 //
1808 // BlockData == NULL means this opcode is not in the requst array.
1809 //
1810 break;
1811 }
1812
1813 if (IfrOpHdr->OpCode == EFI_IFR_ONE_OF_OP) {
1814 //
1815 // Set this flag to TRUE for the first oneof option.
1816 //
1817 FirstOneOfOption = TRUE;
1818 } else if (IfrOpHdr->OpCode == EFI_IFR_NUMERIC_OP) {
1819 //
1820 // Numeric minimum value will be used as default value when no default is specified.
1821 //
1822 DefaultData.Type = DefaultValueFromDefault;
1823 switch (IfrOneOf->Flags & EFI_IFR_NUMERIC_SIZE) {
1824 case EFI_IFR_NUMERIC_SIZE_1:
1825 DefaultData.Value.u8 = IfrOneOf->data.u8.MinValue;
1826 break;
1827
1828 case EFI_IFR_NUMERIC_SIZE_2:
1829 CopyMem (&DefaultData.Value.u16, &IfrOneOf->data.u16.MinValue, sizeof (UINT16));
1830 break;
1831
1832 case EFI_IFR_NUMERIC_SIZE_4:
1833 CopyMem (&DefaultData.Value.u32, &IfrOneOf->data.u32.MinValue, sizeof (UINT32));
1834 break;
1835
1836 case EFI_IFR_NUMERIC_SIZE_8:
1837 CopyMem (&DefaultData.Value.u64, &IfrOneOf->data.u64.MinValue, sizeof (UINT64));
1838 break;
1839
1840 default:
1841 Status = EFI_INVALID_PARAMETER;
1842 goto Done;
1843 }
1844 //
1845 // Set default value base on the DefaultId list get from IFR data.
1846 //
1847 for (LinkData = DefaultIdArray->Entry.ForwardLink; LinkData != &DefaultIdArray->Entry; LinkData = LinkData->ForwardLink) {
1848 DefaultDataPtr = BASE_CR (LinkData, IFR_DEFAULT_DATA, Entry);
1849 DefaultData.DefaultId = DefaultDataPtr->DefaultId;
1850 InsertDefaultValue (BlockData, &DefaultData);
1851 }
1852 }
1853 break;
1854
1855 case EFI_IFR_ORDERED_LIST_OP:
1856 //
1857 // offset by question header
1858 // width by EFI_IFR_ORDERED_LIST MaxContainers * OneofOption Type
1859 // no default value and default id, how to define its default value?
1860 //
1861
1862 //
1863 // OrderedList question is not in IFR Form. This IFR form is not valid.
1864 //
1865 if (VarStoreId == 0) {
1866 Status = EFI_INVALID_PARAMETER;
1867 goto Done;
1868 }
1869 //
1870 // Check whether this question is for the requested varstore.
1871 //
1872 IfrOrderedList = (EFI_IFR_ORDERED_LIST *) IfrOpHdr;
1873 if (IfrOrderedList->Question.VarStoreId != VarStoreId) {
1874 BlockData = NULL;
1875 break;
1876 }
1877 VarWidth = IfrOrderedList->MaxContainers;
1878 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
1879 if (EFI_ERROR (Status)) {
1880 goto Done;
1881 }
1882 break;
1883
1884 case EFI_IFR_CHECKBOX_OP:
1885 //
1886 // EFI_IFR_DEFAULT_OP
1887 // offset by question header
1888 // width is 1 sizeof (BOOLEAN)
1889 // default id by CheckBox Flags if CheckBox flags (Default or Mau) is set, the default value is 1 to be set.
1890 // value by DefaultOption
1891 // default id by DeaultOption DefaultId can override CheckBox Flags and Default value.
1892 //
1893
1894 //
1895 // CheckBox question is not in IFR Form. This IFR form is not valid.
1896 //
1897 if (VarStoreId == 0) {
1898 Status = EFI_INVALID_PARAMETER;
1899 goto Done;
1900 }
1901 //
1902 // Check whether this question is for the requested varstore.
1903 //
1904 IfrCheckBox = (EFI_IFR_CHECKBOX *) IfrOpHdr;
1905 if (IfrCheckBox->Question.VarStoreId != VarStoreId) {
1906 break;
1907 }
1908 VarWidth = (UINT16) sizeof (BOOLEAN);
1909 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
1910 if (EFI_ERROR (Status)) {
1911 goto Done;
1912 }
1913
1914 if (BlockData == NULL) {
1915 //
1916 // BlockData == NULL means this opcode is not in the requst array.
1917 //
1918 break;
1919 }
1920
1921 //
1922 // Add default value for standard ID by CheckBox Flag
1923 //
1924 VarDefaultId = EFI_HII_DEFAULT_CLASS_STANDARD;
1925 //
1926 // Prepare new DefaultValue
1927 //
1928 DefaultData.DefaultId = VarDefaultId;
1929 if ((IfrCheckBox->Flags & EFI_IFR_CHECKBOX_DEFAULT) == EFI_IFR_CHECKBOX_DEFAULT) {
1930 //
1931 // When flag is set, defautl value is TRUE.
1932 //
1933 DefaultData.Type = DefaultValueFromFlag;
1934 DefaultData.Value.b = TRUE;
1935 } else {
1936 //
1937 // When flag is not set, defautl value is FASLE.
1938 //
1939 DefaultData.Type = DefaultValueFromDefault;
1940 DefaultData.Value.b = FALSE;
1941 }
1942 //
1943 // Add DefaultValue into current BlockData
1944 //
1945 InsertDefaultValue (BlockData, &DefaultData);
1946
1947 //
1948 // Add default value for Manufacture ID by CheckBox Flag
1949 //
1950 VarDefaultId = EFI_HII_DEFAULT_CLASS_MANUFACTURING;
1951 //
1952 // Prepare new DefaultValue
1953 //
1954 DefaultData.DefaultId = VarDefaultId;
1955 if ((IfrCheckBox->Flags & EFI_IFR_CHECKBOX_DEFAULT_MFG) == EFI_IFR_CHECKBOX_DEFAULT_MFG) {
1956 //
1957 // When flag is set, defautl value is TRUE.
1958 //
1959 DefaultData.Type = DefaultValueFromFlag;
1960 DefaultData.Value.b = TRUE;
1961 } else {
1962 //
1963 // When flag is not set, defautl value is FASLE.
1964 //
1965 DefaultData.Type = DefaultValueFromDefault;
1966 DefaultData.Value.b = FALSE;
1967 }
1968 //
1969 // Add DefaultValue into current BlockData
1970 //
1971 InsertDefaultValue (BlockData, &DefaultData);
1972 break;
1973
1974 case EFI_IFR_DATE_OP:
1975 //
1976 // offset by question header
1977 // width MaxSize * sizeof (CHAR16)
1978 // no default value, only block array
1979 //
1980
1981 //
1982 // Date question is not in IFR Form. This IFR form is not valid.
1983 //
1984 if (VarStoreId == 0) {
1985 Status = EFI_INVALID_PARAMETER;
1986 goto Done;
1987 }
1988 //
1989 // Check whether this question is for the requested varstore.
1990 //
1991 IfrDate = (EFI_IFR_DATE *) IfrOpHdr;
1992 if (IfrDate->Question.VarStoreId != VarStoreId) {
1993 break;
1994 }
1995
1996 VarWidth = (UINT16) sizeof (EFI_HII_DATE);
1997 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
1998 if (EFI_ERROR (Status)) {
1999 goto Done;
2000 }
2001 break;
2002
2003 case EFI_IFR_TIME_OP:
2004 //
2005 // offset by question header
2006 // width MaxSize * sizeof (CHAR16)
2007 // no default value, only block array
2008 //
2009
2010 //
2011 // Time question is not in IFR Form. This IFR form is not valid.
2012 //
2013 if (VarStoreId == 0) {
2014 Status = EFI_INVALID_PARAMETER;
2015 goto Done;
2016 }
2017 //
2018 // Check whether this question is for the requested varstore.
2019 //
2020 IfrTime = (EFI_IFR_TIME *) IfrOpHdr;
2021 if (IfrTime->Question.VarStoreId != VarStoreId) {
2022 break;
2023 }
2024
2025 VarWidth = (UINT16) sizeof (EFI_HII_TIME);
2026 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
2027 if (EFI_ERROR (Status)) {
2028 goto Done;
2029 }
2030 break;
2031
2032 case EFI_IFR_STRING_OP:
2033 //
2034 // offset by question header
2035 // width MaxSize * sizeof (CHAR16)
2036 // no default value, only block array
2037 //
2038
2039 //
2040 // String question is not in IFR Form. This IFR form is not valid.
2041 //
2042 if (VarStoreId == 0) {
2043 Status = EFI_INVALID_PARAMETER;
2044 goto Done;
2045 }
2046 //
2047 // Check whether this question is for the requested varstore.
2048 //
2049 IfrString = (EFI_IFR_STRING *) IfrOpHdr;
2050 if (IfrString->Question.VarStoreId != VarStoreId) {
2051 break;
2052 }
2053
2054 VarWidth = (UINT16) (IfrString->MaxSize * sizeof (UINT16));
2055 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
2056 if (EFI_ERROR (Status)) {
2057 goto Done;
2058 }
2059
2060 //
2061 // No default value for string.
2062 //
2063 BlockData = NULL;
2064 break;
2065
2066 case EFI_IFR_PASSWORD_OP:
2067 //
2068 // offset by question header
2069 // width MaxSize * sizeof (CHAR16)
2070 // no default value, only block array
2071 //
2072
2073 //
2074 // Password question is not in IFR Form. This IFR form is not valid.
2075 //
2076 if (VarStoreId == 0) {
2077 Status = EFI_INVALID_PARAMETER;
2078 goto Done;
2079 }
2080 //
2081 // Check whether this question is for the requested varstore.
2082 //
2083 IfrPassword = (EFI_IFR_PASSWORD *) IfrOpHdr;
2084 if (IfrPassword->Question.VarStoreId != VarStoreId) {
2085 break;
2086 }
2087
2088 VarWidth = (UINT16) (IfrPassword->MaxSize * sizeof (UINT16));
2089 Status = IsThisOpcodeRequired(RequestBlockArray, HiiHandle, VarStorageData, IfrOpHdr, VarWidth, &BlockData);
2090 if (EFI_ERROR (Status)) {
2091 goto Done;
2092 }
2093
2094 //
2095 // No default value for string.
2096 //
2097 BlockData = NULL;
2098 break;
2099
2100 case EFI_IFR_ONE_OF_OPTION_OP:
2101 //
2102 // No matched block data is ignored.
2103 //
2104 if (BlockData == NULL || BlockData->Scope == 0) {
2105 break;
2106 }
2107
2108 IfrOneOfOption = (EFI_IFR_ONE_OF_OPTION *) IfrOpHdr;
2109 if (BlockData->OpCode == EFI_IFR_ORDERED_LIST_OP) {
2110 //
2111 // Get ordered list option data type.
2112 //
2113 if (IfrOneOfOption->Type == EFI_IFR_TYPE_NUM_SIZE_8 || IfrOneOfOption->Type == EFI_IFR_TYPE_BOOLEAN) {
2114 VarWidth = 1;
2115 } else if (IfrOneOfOption->Type == EFI_IFR_TYPE_NUM_SIZE_16) {
2116 VarWidth = 2;
2117 } else if (IfrOneOfOption->Type == EFI_IFR_TYPE_NUM_SIZE_32) {
2118 VarWidth = 4;
2119 } else if (IfrOneOfOption->Type == EFI_IFR_TYPE_NUM_SIZE_64) {
2120 VarWidth = 8;
2121 } else {
2122 //
2123 // Invalid ordered list option data type.
2124 //
2125 Status = EFI_INVALID_PARAMETER;
2126 if (BlockData->Name != NULL) {
2127 FreePool (BlockData->Name);
2128 }
2129 FreePool (BlockData);
2130 goto Done;
2131 }
2132
2133 //
2134 // Calculate Ordered list QuestionId width.
2135 //
2136 BlockData->Width = (UINT16) (BlockData->Width * VarWidth);
2137 //
2138 // Check whether this question is in requested block array.
2139 //
2140 if (!BlockArrayCheck (RequestBlockArray, BlockData->Offset, BlockData->Width, (BOOLEAN)(BlockData->Name != NULL), HiiHandle)) {
2141 //
2142 // This question is not in the requested string. Skip it.
2143 //
2144 if (BlockData->Name != NULL) {
2145 FreePool (BlockData->Name);
2146 }
2147 FreePool (BlockData);
2148 BlockData = NULL;
2149 break;
2150 }
2151 //
2152 // Check this var question is in the var storage
2153 //
2154 if ((BlockData->Name == NULL) && ((BlockData->Offset + BlockData->Width) > VarStorageData->Size)) {
2155 Status = EFI_INVALID_PARAMETER;
2156 if (BlockData->Name != NULL) {
2157 FreePool (BlockData->Name);
2158 }
2159 FreePool (BlockData);
2160 goto Done;
2161 }
2162 //
2163 // Add Block Data into VarStorageData BlockEntry
2164 //
2165 InsertBlockData (&VarStorageData->BlockEntry, &BlockData);
2166 //
2167 // No default data for OrderedList.
2168 //
2169 BlockData = NULL;
2170 break;
2171 }
2172
2173 //
2174 // 1. Set default value for OneOf option when flag field has default attribute.
2175 //
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)) {
2178 //
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.
2181 //
2182 FirstOneOfOption = FALSE;
2183
2184 // Prepare new DefaultValue
2185 //
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);
2191 }
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);
2195 }
2196 }
2197
2198 //
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.
2201 //
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;
2205
2206 //
2207 // Prepare new DefaultValue
2208 //
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);
2215 }
2216 }
2217 break;
2218
2219 case EFI_IFR_DEFAULT_OP:
2220 //
2221 // Update Current BlockData to the default value.
2222 //
2223 if (BlockData == NULL || BlockData->Scope == 0) {
2224 //
2225 // No matched block data is ignored.
2226 //
2227 break;
2228 }
2229
2230 if (BlockData->OpCode == EFI_IFR_ORDERED_LIST_OP) {
2231 //
2232 // OrderedList Opcode is no default value.
2233 //
2234 break;
2235 }
2236 //
2237 // Get the DefaultId
2238 //
2239 IfrDefault = (EFI_IFR_DEFAULT *) IfrOpHdr;
2240 VarDefaultId = IfrDefault->DefaultId;
2241 //
2242 // Prepare new DefaultValue
2243 //
2244 DefaultData.Type = DefaultValueFromOpcode;
2245 DefaultData.DefaultId = VarDefaultId;
2246 CopyMem (&DefaultData.Value, &IfrDefault->Value, IfrDefault->Header.Length - OFFSET_OF (EFI_IFR_DEFAULT, Value));
2247
2248 // If the value field is expression, set the cleaned flag.
2249 if (IfrDefault->Type == EFI_IFR_TYPE_OTHER) {
2250 DefaultData.Cleaned = TRUE;
2251 }
2252 //
2253 // Add DefaultValue into current BlockData
2254 //
2255 InsertDefaultValue (BlockData, &DefaultData);
2256
2257 //
2258 // After insert the default value, reset the cleaned value for next
2259 // time used. If not set here, need to set the value before everytime
2260 // use it.
2261 //
2262 DefaultData.Cleaned = FALSE;
2263 break;
2264
2265 case EFI_IFR_END_OP:
2266 //
2267 // End Opcode is for Var question.
2268 //
2269 if (BlockData != NULL) {
2270 if (BlockData->Scope > 0) {
2271 BlockData->Scope--;
2272 }
2273 if (BlockData->Scope == 0) {
2274 BlockData = NULL;
2275 }
2276 }
2277
2278 break;
2279
2280 default:
2281 if (BlockData != NULL) {
2282 if (BlockData->Scope > 0) {
2283 BlockData->Scope = (UINT8) (BlockData->Scope + IfrOpHdr->Scope);
2284 }
2285
2286 if (BlockData->Scope == 0) {
2287 BlockData = NULL;
2288 }
2289 }
2290 break;
2291 }
2292
2293 IfrOffset += IfrOpHdr->Length;
2294 PackageOffset += IfrOpHdr->Length;
2295 }
2296
2297 Done:
2298 for (LinkData = VarStorageData->BlockEntry.ForwardLink; LinkData != &VarStorageData->BlockEntry; LinkData = LinkData->ForwardLink) {
2299 BlockData = BASE_CR (LinkData, IFR_BLOCK_DATA, Entry);
2300 for (LinkDefault = BlockData->DefaultValueEntry.ForwardLink; LinkDefault != &BlockData->DefaultValueEntry; ) {
2301 DefaultDataPtr = BASE_CR (LinkDefault, IFR_DEFAULT_DATA, Entry);
2302 LinkDefault = LinkDefault->ForwardLink;
2303 if (DefaultDataPtr->Cleaned == TRUE) {
2304 RemoveEntryList (&DefaultDataPtr->Entry);
2305 FreePool (DefaultDataPtr);
2306 }
2307 }
2308 }
2309
2310 return Status;
2311 }
2312
2313 /**
2314 parse the configrequest string, get the elements.
2315
2316 @param ConfigRequest The input configrequest string.
2317 @param Progress Return the progress data.
2318
2319 @retval Block data pointer.
2320 **/
2321 IFR_BLOCK_DATA *
2322 GetBlockElement (
2323 IN EFI_STRING ConfigRequest,
2324 OUT EFI_STRING *Progress
2325 )
2326 {
2327 EFI_STRING StringPtr;
2328 IFR_BLOCK_DATA *BlockData;
2329 IFR_BLOCK_DATA *RequestBlockArray;
2330 EFI_STATUS Status;
2331 UINT8 *TmpBuffer;
2332 UINT16 Offset;
2333 UINT16 Width;
2334 LIST_ENTRY *Link;
2335 IFR_BLOCK_DATA *NextBlockData;
2336 UINTN Length;
2337
2338 TmpBuffer = NULL;
2339
2340 //
2341 // Init RequestBlockArray
2342 //
2343 RequestBlockArray = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));
2344 if (RequestBlockArray == NULL) {
2345 goto Done;
2346 }
2347 InitializeListHead (&RequestBlockArray->Entry);
2348
2349 //
2350 // Get the request Block array from the request string
2351 // Offset and Width
2352 //
2353
2354 //
2355 // Parse each <RequestElement> if exists
2356 // Only <BlockName> format is supported by this help function.
2357 // <BlockName> ::= &'OFFSET='<Number>&'WIDTH='<Number>
2358 //
2359 StringPtr = ConfigRequest;
2360 while (*StringPtr != 0 && StrnCmp (StringPtr, L"&OFFSET=", StrLen (L"&OFFSET=")) == 0) {
2361 //
2362 // Skip the OFFSET string
2363 //
2364 *Progress = StringPtr;
2365 StringPtr += StrLen (L"&OFFSET=");
2366 //
2367 // Get Offset
2368 //
2369 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
2370 if (EFI_ERROR (Status)) {
2371 goto Done;
2372 }
2373 Offset = 0;
2374 CopyMem (
2375 &Offset,
2376 TmpBuffer,
2377 (((Length + 1) / 2) < sizeof (UINT16)) ? ((Length + 1) / 2) : sizeof (UINT16)
2378 );
2379 FreePool (TmpBuffer);
2380
2381 StringPtr += Length;
2382 if (StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {
2383 goto Done;
2384 }
2385 StringPtr += StrLen (L"&WIDTH=");
2386
2387 //
2388 // Get Width
2389 //
2390 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
2391 if (EFI_ERROR (Status)) {
2392 goto Done;
2393 }
2394 Width = 0;
2395 CopyMem (
2396 &Width,
2397 TmpBuffer,
2398 (((Length + 1) / 2) < sizeof (UINT16)) ? ((Length + 1) / 2) : sizeof (UINT16)
2399 );
2400 FreePool (TmpBuffer);
2401
2402 StringPtr += Length;
2403 if (*StringPtr != 0 && *StringPtr != L'&') {
2404 goto Done;
2405 }
2406
2407 //
2408 // Set Block Data
2409 //
2410 BlockData = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));
2411 if (BlockData == NULL) {
2412 goto Done;
2413 }
2414 BlockData->Offset = Offset;
2415 BlockData->Width = Width;
2416 InsertBlockData (&RequestBlockArray->Entry, &BlockData);
2417
2418 //
2419 // Skip &VALUE string if &VALUE does exists.
2420 //
2421 if (StrnCmp (StringPtr, L"&VALUE=", StrLen (L"&VALUE=")) == 0) {
2422 StringPtr += StrLen (L"&VALUE=");
2423
2424 //
2425 // Get Value
2426 //
2427 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
2428 if (EFI_ERROR (Status)) {
2429 goto Done;
2430 }
2431
2432 StringPtr += Length;
2433 if (*StringPtr != 0 && *StringPtr != L'&') {
2434 goto Done;
2435 }
2436 }
2437 //
2438 // If '\0', parsing is finished.
2439 //
2440 if (*StringPtr == 0) {
2441 break;
2442 }
2443 }
2444
2445 //
2446 // Merge the requested block data.
2447 //
2448 Link = RequestBlockArray->Entry.ForwardLink;
2449 while ((Link != &RequestBlockArray->Entry) && (Link->ForwardLink != &RequestBlockArray->Entry)) {
2450 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);
2451 NextBlockData = BASE_CR (Link->ForwardLink, IFR_BLOCK_DATA, Entry);
2452 if ((NextBlockData->Offset >= BlockData->Offset) && (NextBlockData->Offset <= (BlockData->Offset + BlockData->Width))) {
2453 if ((NextBlockData->Offset + NextBlockData->Width) > (BlockData->Offset + BlockData->Width)) {
2454 BlockData->Width = (UINT16) (NextBlockData->Offset + NextBlockData->Width - BlockData->Offset);
2455 }
2456 RemoveEntryList (Link->ForwardLink);
2457 FreePool (NextBlockData);
2458 continue;
2459 }
2460 Link = Link->ForwardLink;
2461 }
2462
2463 return RequestBlockArray;
2464
2465 Done:
2466 if (RequestBlockArray != NULL) {
2467 //
2468 // Free Link Array RequestBlockArray
2469 //
2470 while (!IsListEmpty (&RequestBlockArray->Entry)) {
2471 BlockData = BASE_CR (RequestBlockArray->Entry.ForwardLink, IFR_BLOCK_DATA, Entry);
2472 RemoveEntryList (&BlockData->Entry);
2473 FreePool (BlockData);
2474 }
2475
2476 FreePool (RequestBlockArray);
2477 }
2478
2479 return NULL;
2480 }
2481
2482 /**
2483 parse the configrequest string, get the elements.
2484
2485 @param ConfigRequest The input config request string.
2486 @param Progress Return the progress data.
2487
2488 @retval return data block array.
2489 **/
2490 IFR_BLOCK_DATA *
2491 GetNameElement (
2492 IN EFI_STRING ConfigRequest,
2493 OUT EFI_STRING *Progress
2494 )
2495 {
2496 EFI_STRING StringPtr;
2497 EFI_STRING NextTag;
2498 IFR_BLOCK_DATA *BlockData;
2499 IFR_BLOCK_DATA *RequestBlockArray;
2500 BOOLEAN HasValue;
2501
2502 StringPtr = ConfigRequest;
2503
2504 //
2505 // Init RequestBlockArray
2506 //
2507 RequestBlockArray = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));
2508 if (RequestBlockArray == NULL) {
2509 goto Done;
2510 }
2511 InitializeListHead (&RequestBlockArray->Entry);
2512
2513 //
2514 // Get the request Block array from the request string
2515 //
2516
2517 //
2518 // Parse each <RequestElement> if exists
2519 // Only <BlockName> format is supported by this help function.
2520 // <BlockName> ::= &'Name***=***
2521 //
2522 while (StringPtr != NULL && *StringPtr == L'&') {
2523
2524 *Progress = StringPtr;
2525 //
2526 // Skip the L"&" string
2527 //
2528 StringPtr += 1;
2529
2530 HasValue = FALSE;
2531 if ((NextTag = StrStr (StringPtr, L"=")) != NULL) {
2532 *NextTag = L'\0';
2533 HasValue = TRUE;
2534 } else if ((NextTag = StrStr (StringPtr, L"&")) != NULL) {
2535 *NextTag = L'\0';
2536 }
2537
2538 //
2539 // Set Block Data
2540 //
2541 BlockData = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));
2542 if (BlockData == NULL) {
2543 goto Done;
2544 }
2545
2546 //
2547 // Get Name
2548 //
2549 BlockData->Name = AllocateCopyPool(StrSize (StringPtr), StringPtr);
2550 InsertBlockData (&RequestBlockArray->Entry, &BlockData);
2551
2552 if (HasValue) {
2553 //
2554 // If has value, skip the value.
2555 //
2556 StringPtr = NextTag + 1;
2557 *NextTag = L'=';
2558 StringPtr = StrStr (StringPtr, L"&");
2559 } else if (NextTag != NULL) {
2560 //
2561 // restore the '&' text.
2562 //
2563 StringPtr = NextTag;
2564 *NextTag = L'&';
2565 }
2566 }
2567
2568 return RequestBlockArray;
2569
2570 Done:
2571 if (RequestBlockArray != NULL) {
2572 //
2573 // Free Link Array RequestBlockArray
2574 //
2575 while (!IsListEmpty (&RequestBlockArray->Entry)) {
2576 BlockData = BASE_CR (RequestBlockArray->Entry.ForwardLink, IFR_BLOCK_DATA, Entry);
2577 RemoveEntryList (&BlockData->Entry);
2578 if (BlockData->Name != NULL) {
2579 FreePool (BlockData->Name);
2580 }
2581 FreePool (BlockData);
2582 }
2583
2584 FreePool (RequestBlockArray);
2585 }
2586
2587 return NULL;
2588 }
2589
2590 /**
2591 Generate ConfigRequest string base on the varstore info.
2592
2593 @param ConfigHdr The config header for this varstore.
2594 @param VarStorageData The varstore info.
2595 @param Status Return Status.
2596 @param ConfigRequest The ConfigRequest info may be return.
2597
2598 @retval TRUE Need to continue
2599 @retval Others NO need to continue or error occur.
2600 **/
2601 BOOLEAN
2602 GenerateConfigRequest (
2603 IN CHAR16 *ConfigHdr,
2604 IN IFR_VARSTORAGE_DATA *VarStorageData,
2605 OUT EFI_STATUS *Status,
2606 IN OUT EFI_STRING *ConfigRequest
2607 )
2608 {
2609 BOOLEAN DataExist;
2610 UINTN Length;
2611 LIST_ENTRY *Link;
2612 CHAR16 *FullConfigRequest;
2613 CHAR16 *StringPtr;
2614 IFR_BLOCK_DATA *BlockData;
2615
2616 //
2617 // Append VarStorageData BlockEntry into *Request string
2618 // Now support only one varstore in a form package.
2619 //
2620
2621 //
2622 // Go through all VarStorageData Entry and get BlockEntry for each one for the multiple varstore in a single form package
2623 // Then construct them all to return MultiRequest string : ConfigHdr BlockConfig
2624 //
2625
2626 //
2627 // Compute the length of the entire request starting with <ConfigHdr> and a
2628 // Null-terminator
2629 //
2630 DataExist = FALSE;
2631 Length = StrLen (ConfigHdr) + 1;
2632
2633 for (Link = VarStorageData->BlockEntry.ForwardLink; Link != &VarStorageData->BlockEntry; Link = Link->ForwardLink) {
2634 DataExist = TRUE;
2635 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);
2636 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2637 //
2638 // Add <BlockName> length for each Name
2639 //
2640 // <BlockName> ::= &Name1&Name2&...
2641 // |1| StrLen(Name1)
2642 //
2643 Length = Length + (1 + StrLen (BlockData->Name));
2644 } else {
2645 //
2646 // Add <BlockName> length for each Offset/Width pair
2647 //
2648 // <BlockName> ::= &OFFSET=1234&WIDTH=1234
2649 // | 8 | 4 | 7 | 4 |
2650 //
2651 Length = Length + (8 + 4 + 7 + 4);
2652 }
2653 }
2654 //
2655 // No any request block data is found. The request string can't be constructed.
2656 //
2657 if (!DataExist) {
2658 *Status = EFI_SUCCESS;
2659 return FALSE;
2660 }
2661
2662 //
2663 // Allocate buffer for the entire <ConfigRequest>
2664 //
2665 FullConfigRequest = AllocateZeroPool (Length * sizeof (CHAR16));
2666 if (FullConfigRequest == NULL) {
2667 *Status = EFI_OUT_OF_RESOURCES;
2668 return FALSE;
2669 }
2670 StringPtr = FullConfigRequest;
2671
2672 //
2673 // Start with <ConfigHdr>
2674 //
2675 StrCpyS (StringPtr, Length, ConfigHdr);
2676 StringPtr += StrLen (StringPtr);
2677
2678 //
2679 // Loop through all the Offset/Width pairs and append them to ConfigRequest
2680 //
2681 for (Link = VarStorageData->BlockEntry.ForwardLink; Link != &VarStorageData->BlockEntry; Link = Link->ForwardLink) {
2682 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);
2683 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2684 //
2685 // Append &Name1\0
2686 //
2687 UnicodeSPrint (
2688 StringPtr,
2689 (1 + StrLen (BlockData->Name) + 1) * sizeof (CHAR16),
2690 L"&%s",
2691 BlockData->Name
2692 );
2693 } else {
2694 //
2695 // Append &OFFSET=XXXX&WIDTH=YYYY\0
2696 //
2697 UnicodeSPrint (
2698 StringPtr,
2699 (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16),
2700 L"&OFFSET=%04X&WIDTH=%04X",
2701 BlockData->Offset,
2702 BlockData->Width
2703 );
2704 }
2705 StringPtr += StrLen (StringPtr);
2706 }
2707 //
2708 // Set to the got full request string.
2709 //
2710 HiiToLower (FullConfigRequest);
2711
2712 if (*ConfigRequest != NULL) {
2713 FreePool (*ConfigRequest);
2714 }
2715 *ConfigRequest = FullConfigRequest;
2716
2717 return TRUE;
2718 }
2719
2720 /**
2721 Generate ConfigRequest Header base on the varstore info.
2722
2723 @param VarStorageData The varstore info.
2724 @param DevicePath Device path for this varstore.
2725 @param ConfigHdr The config header for this varstore.
2726
2727 @retval EFI_SUCCESS Generate the header success.
2728 @retval EFI_OUT_OF_RESOURCES Allocate buffer fail.
2729 **/
2730 EFI_STATUS
2731 GenerateHdr (
2732 IN IFR_VARSTORAGE_DATA *VarStorageData,
2733 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
2734 OUT EFI_STRING *ConfigHdr
2735 )
2736 {
2737 EFI_STRING GuidStr;
2738 EFI_STRING NameStr;
2739 EFI_STRING PathStr;
2740 UINTN Length;
2741 EFI_STATUS Status;
2742
2743 Status = EFI_SUCCESS;
2744 NameStr = NULL;
2745 GuidStr = NULL;
2746 PathStr = NULL;
2747
2748 //
2749 // Construct <ConfigHdr> : "GUID=...&NAME=...&PATH=..." by VarStorageData Guid, Name and DriverHandle
2750 //
2751 GenerateSubStr (L"GUID=", sizeof (EFI_GUID), (VOID *) &VarStorageData->Guid, 1, &GuidStr);
2752 if (VarStorageData->Name != NULL) {
2753 GenerateSubStr (L"NAME=", StrLen (VarStorageData->Name) * sizeof (CHAR16), (VOID *) VarStorageData->Name, 2, &NameStr);
2754 } else {
2755 GenerateSubStr (L"NAME=", 0, NULL, 2, &NameStr);
2756 }
2757 GenerateSubStr (
2758 L"PATH=",
2759 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) DevicePath),
2760 (VOID *) DevicePath,
2761 1,
2762 &PathStr
2763 );
2764 Length = StrLen (GuidStr) + StrLen (NameStr) + StrLen (PathStr) + 1;
2765 if (VarStorageData->Name == NULL) {
2766 Length += 1;
2767 }
2768
2769 *ConfigHdr = AllocateZeroPool (Length * sizeof (CHAR16));
2770 if (*ConfigHdr == NULL) {
2771 Status = EFI_OUT_OF_RESOURCES;
2772 goto Done;
2773 }
2774 StrCpyS (*ConfigHdr, Length, GuidStr);
2775 StrCatS (*ConfigHdr, Length, NameStr);
2776 if (VarStorageData->Name == NULL) {
2777 StrCatS (*ConfigHdr, Length, L"&");
2778 }
2779 StrCatS (*ConfigHdr, Length, PathStr);
2780
2781 //
2782 // Remove the last character L'&'
2783 //
2784 *(*ConfigHdr + StrLen (*ConfigHdr) - 1) = L'\0';
2785
2786 Done:
2787 if (GuidStr != NULL) {
2788 FreePool (GuidStr);
2789 }
2790
2791 if (NameStr != NULL) {
2792 FreePool (NameStr);
2793 }
2794
2795 if (PathStr != NULL) {
2796 FreePool (PathStr);
2797 }
2798
2799 return Status;
2800 }
2801
2802 /**
2803 Get Data buffer size based on data type.
2804
2805 @param ValueType The input data type.
2806
2807 @retval The data buffer size for the input type.
2808 **/
2809 UINT16
2810 GetStorageWidth (
2811 IN UINT8 ValueType
2812 )
2813 {
2814 UINT16 StorageWidth;
2815
2816 switch (ValueType) {
2817 case EFI_IFR_NUMERIC_SIZE_1:
2818 case EFI_IFR_TYPE_BOOLEAN:
2819 StorageWidth = (UINT16) sizeof (UINT8);
2820 break;
2821
2822 case EFI_IFR_NUMERIC_SIZE_2:
2823 StorageWidth = (UINT16) sizeof (UINT16);
2824 break;
2825
2826 case EFI_IFR_NUMERIC_SIZE_4:
2827 StorageWidth = (UINT16) sizeof (UINT32);
2828 break;
2829
2830 case EFI_IFR_NUMERIC_SIZE_8:
2831 StorageWidth = (UINT16) sizeof (UINT64);
2832 break;
2833
2834 case EFI_IFR_TYPE_TIME:
2835 StorageWidth = (UINT16) sizeof (EFI_IFR_TIME);
2836 break;
2837
2838 case EFI_IFR_TYPE_DATE:
2839 StorageWidth = (UINT16) sizeof (EFI_IFR_DATE);
2840 break;
2841
2842 default:
2843 StorageWidth = 0;
2844 break;
2845 }
2846
2847 return StorageWidth;
2848 }
2849
2850 /**
2851 Generate ConfigAltResp string base on the varstore info.
2852
2853 @param ConfigHdr The config header for this varstore.
2854 @param VarStorageData The varstore info.
2855 @param DefaultIdArray The Default id array.
2856 @param DefaultAltCfgResp The DefaultAltCfgResp info may be return.
2857
2858 @retval TRUE Need to continue
2859 @retval Others NO need to continue or error occur.
2860 **/
2861 EFI_STATUS
2862 GenerateAltConfigResp (
2863 IN CHAR16 *ConfigHdr,
2864 IN IFR_VARSTORAGE_DATA *VarStorageData,
2865 IN IFR_DEFAULT_DATA *DefaultIdArray,
2866 IN OUT EFI_STRING *DefaultAltCfgResp
2867 )
2868 {
2869 BOOLEAN DataExist;
2870 UINTN Length;
2871 LIST_ENTRY *Link;
2872 LIST_ENTRY *LinkData;
2873 LIST_ENTRY *LinkDefault;
2874 LIST_ENTRY *ListEntry;
2875 CHAR16 *StringPtr;
2876 IFR_BLOCK_DATA *BlockData;
2877 IFR_DEFAULT_DATA *DefaultId;
2878 IFR_DEFAULT_DATA *DefaultValueData;
2879 UINTN Width;
2880 UINT8 *TmpBuffer;
2881
2882 BlockData = NULL;
2883 DataExist = FALSE;
2884
2885 //
2886 // Add length for <ConfigHdr> + '\0'
2887 //
2888 Length = StrLen (ConfigHdr) + 1;
2889
2890 for (Link = DefaultIdArray->Entry.ForwardLink; Link != &DefaultIdArray->Entry; Link = Link->ForwardLink) {
2891 DefaultId = BASE_CR (Link, IFR_DEFAULT_DATA, Entry);
2892 //
2893 // Add length for "&<ConfigHdr>&ALTCFG=XXXX"
2894 // |1| StrLen (ConfigHdr) | 8 | 4 |
2895 //
2896 Length += (1 + StrLen (ConfigHdr) + 8 + 4);
2897
2898 for (LinkData = VarStorageData->BlockEntry.ForwardLink; LinkData != &VarStorageData->BlockEntry; LinkData = LinkData->ForwardLink) {
2899 BlockData = BASE_CR (LinkData, IFR_BLOCK_DATA, Entry);
2900 ListEntry = &BlockData->DefaultValueEntry;
2901 for (LinkDefault = ListEntry->ForwardLink; LinkDefault != ListEntry; LinkDefault = LinkDefault->ForwardLink) {
2902 DefaultValueData = BASE_CR (LinkDefault, IFR_DEFAULT_DATA, Entry);
2903 if (DefaultValueData->DefaultId != DefaultId->DefaultId) {
2904 continue;
2905 }
2906 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2907 //
2908 // Add length for "&Name1=zzzzzzzzzzzz"
2909 // |1|Name|1|Value|
2910 //
2911 Length += (1 + StrLen (BlockData->Name) + 1 + BlockData->Width * 2);
2912 } else {
2913 //
2914 // Add length for "&OFFSET=XXXX&WIDTH=YYYY&VALUE=zzzzzzzzzzzz"
2915 // | 8 | 4 | 7 | 4 | 7 | Width * 2 |
2916 //
2917 Length += (8 + 4 + 7 + 4 + 7 + BlockData->Width * 2);
2918 }
2919 DataExist = TRUE;
2920 }
2921 }
2922 }
2923
2924 //
2925 // No default value is found. The default string doesn't exist.
2926 //
2927 if (!DataExist) {
2928 return EFI_SUCCESS;
2929 }
2930
2931 //
2932 // Allocate buffer for the entire <DefaultAltCfgResp>
2933 //
2934 *DefaultAltCfgResp = AllocateZeroPool (Length * sizeof (CHAR16));
2935 if (*DefaultAltCfgResp == NULL) {
2936 return EFI_OUT_OF_RESOURCES;
2937 }
2938 StringPtr = *DefaultAltCfgResp;
2939
2940 //
2941 // Start with <ConfigHdr>
2942 //
2943 StrCpyS (StringPtr, Length, ConfigHdr);
2944 StringPtr += StrLen (StringPtr);
2945
2946 for (Link = DefaultIdArray->Entry.ForwardLink; Link != &DefaultIdArray->Entry; Link = Link->ForwardLink) {
2947 DefaultId = BASE_CR (Link, IFR_DEFAULT_DATA, Entry);
2948 //
2949 // Add <AltConfigHdr> of the form "&<ConfigHdr>&ALTCFG=XXXX\0"
2950 // |1| StrLen (ConfigHdr) | 8 | 4 |
2951 //
2952 UnicodeSPrint (
2953 StringPtr,
2954 (1 + StrLen (ConfigHdr) + 8 + 4 + 1) * sizeof (CHAR16),
2955 L"&%s&ALTCFG=%04X",
2956 ConfigHdr,
2957 DefaultId->DefaultId
2958 );
2959 StringPtr += StrLen (StringPtr);
2960
2961 for (LinkData = VarStorageData->BlockEntry.ForwardLink; LinkData != &VarStorageData->BlockEntry; LinkData = LinkData->ForwardLink) {
2962 BlockData = BASE_CR (LinkData, IFR_BLOCK_DATA, Entry);
2963 ListEntry = &BlockData->DefaultValueEntry;
2964 for (LinkDefault = ListEntry->ForwardLink; LinkDefault != ListEntry; LinkDefault = LinkDefault->ForwardLink) {
2965 DefaultValueData = BASE_CR (LinkDefault, IFR_DEFAULT_DATA, Entry);
2966 if (DefaultValueData->DefaultId != DefaultId->DefaultId) {
2967 continue;
2968 }
2969 if (VarStorageData->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2970 UnicodeSPrint (
2971 StringPtr,
2972 (1 + StrLen (ConfigHdr) + 1) * sizeof (CHAR16),
2973 L"&%s=",
2974 BlockData->Name
2975 );
2976 StringPtr += StrLen (StringPtr);
2977 } else {
2978 //
2979 // Add <BlockConfig>
2980 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>
2981 //
2982 UnicodeSPrint (
2983 StringPtr,
2984 (8 + 4 + 7 + 4 + 7 + 1) * sizeof (CHAR16),
2985 L"&OFFSET=%04X&WIDTH=%04X&VALUE=",
2986 BlockData->Offset,
2987 BlockData->Width
2988 );
2989 StringPtr += StrLen (StringPtr);
2990 }
2991 Width = BlockData->Width;
2992 //
2993 // Convert Value to a hex string in "%x" format
2994 // NOTE: This is in the opposite byte that GUID and PATH use
2995 //
2996 TmpBuffer = (UINT8 *) &(DefaultValueData->Value);
2997 for (; Width > 0; Width--) {
2998 StringPtr += UnicodeValueToString (StringPtr, PREFIX_ZERO | RADIX_HEX, TmpBuffer[Width - 1], 2);
2999 }
3000 }
3001 }
3002 }
3003
3004 HiiToLower (*DefaultAltCfgResp);
3005
3006 return EFI_SUCCESS;
3007 }
3008
3009 /**
3010 This function gets the full request string and full default value string by
3011 parsing IFR data in HII form packages.
3012
3013 When Request points to NULL string, the request string and default value string
3014 for each varstore in form package will return.
3015
3016 @param DataBaseRecord The DataBaseRecord instance contains the found Hii handle and package.
3017 @param DevicePath Device Path which Hii Config Access Protocol is registered.
3018 @param Request Pointer to a null-terminated Unicode string in
3019 <ConfigRequest> format. When it doesn't contain
3020 any RequestElement, it will be updated to return
3021 the full RequestElement retrieved from IFR data.
3022 If it points to NULL, the request string for the first
3023 varstore in form package will be merged into a
3024 <MultiConfigRequest> format string and return.
3025 @param AltCfgResp Pointer to a null-terminated Unicode string in
3026 <ConfigAltResp> format. When the pointer is to NULL,
3027 the full default value string retrieved from IFR data
3028 will return. When the pinter is to a string, the
3029 full default value string retrieved from IFR data
3030 will be merged into the input string and return.
3031 When Request points to NULL, the default value string
3032 for each varstore in form package will be merged into
3033 a <MultiConfigAltResp> format string and return.
3034 @param PointerProgress Optional parameter, it can be be NULL.
3035 When it is not NULL, if Request is NULL, it returns NULL.
3036 On return, points to a character in the Request
3037 string. Points to the string's null terminator if
3038 request was successful. Points to the most recent
3039 & before the first failing name / value pair (or
3040 the beginning of the string if the failure is in
3041 the first name / value pair) if the request was
3042 not successful.
3043 @retval EFI_SUCCESS The Results string is set to the full request string.
3044 And AltCfgResp contains all default value string.
3045 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3046 @retval EFI_NOT_FOUND The varstore (Guid and Name) in Request string
3047 can't be found in Form package.
3048 @retval EFI_NOT_FOUND HiiPackage can't be got on the input HiiHandle.
3049 @retval EFI_INVALID_PARAMETER Request points to NULL.
3050
3051 **/
3052 EFI_STATUS
3053 EFIAPI
3054 GetFullStringFromHiiFormPackages (
3055 IN HII_DATABASE_RECORD *DataBaseRecord,
3056 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
3057 IN OUT EFI_STRING *Request,
3058 IN OUT EFI_STRING *AltCfgResp,
3059 OUT EFI_STRING *PointerProgress OPTIONAL
3060 )
3061 {
3062 EFI_STATUS Status;
3063 UINT8 *HiiFormPackage;
3064 UINTN PackageSize;
3065 IFR_BLOCK_DATA *RequestBlockArray;
3066 IFR_BLOCK_DATA *BlockData;
3067 IFR_DEFAULT_DATA *DefaultValueData;
3068 IFR_DEFAULT_DATA *DefaultId;
3069 IFR_DEFAULT_DATA *DefaultIdArray;
3070 IFR_VARSTORAGE_DATA *VarStorageData;
3071 EFI_STRING DefaultAltCfgResp;
3072 EFI_STRING ConfigHdr;
3073 EFI_STRING StringPtr;
3074 EFI_STRING Progress;
3075
3076 if (DataBaseRecord == NULL || DevicePath == NULL || Request == NULL || AltCfgResp == NULL) {
3077 return EFI_INVALID_PARAMETER;
3078 }
3079
3080 //
3081 // Initialize the local variables.
3082 //
3083 RequestBlockArray = NULL;
3084 DefaultIdArray = NULL;
3085 VarStorageData = NULL;
3086 DefaultAltCfgResp = NULL;
3087 ConfigHdr = NULL;
3088 HiiFormPackage = NULL;
3089 PackageSize = 0;
3090 Progress = *Request;
3091
3092 Status = GetFormPackageData (DataBaseRecord, &HiiFormPackage, &PackageSize);
3093 if (EFI_ERROR (Status)) {
3094 goto Done;
3095 }
3096
3097 //
3098 // 1. Get the request block array by Request String when Request string containts the block array.
3099 //
3100 StringPtr = NULL;
3101 if (*Request != NULL) {
3102 StringPtr = *Request;
3103 //
3104 // Jump <ConfigHdr>
3105 //
3106 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
3107 Status = EFI_INVALID_PARAMETER;
3108 goto Done;
3109 }
3110 StringPtr += StrLen (L"GUID=");
3111 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&NAME=", StrLen (L"&NAME=")) != 0) {
3112 StringPtr++;
3113 }
3114 if (*StringPtr == L'\0') {
3115 Status = EFI_INVALID_PARAMETER;
3116 goto Done;
3117 }
3118 StringPtr += StrLen (L"&NAME=");
3119 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&PATH=", StrLen (L"&PATH=")) != 0) {
3120 StringPtr++;
3121 }
3122 if (*StringPtr == L'\0') {
3123 Status = EFI_INVALID_PARAMETER;
3124 goto Done;
3125 }
3126 StringPtr += StrLen (L"&PATH=");
3127 while (*StringPtr != L'\0' && *StringPtr != L'&') {
3128 StringPtr ++;
3129 }
3130
3131 if (*StringPtr == L'\0') {
3132 //
3133 // No request block is found.
3134 //
3135 StringPtr = NULL;
3136 }
3137 }
3138
3139 //
3140 // If StringPtr != NULL, get the request elements.
3141 //
3142 if (StringPtr != NULL) {
3143 if (StrStr (StringPtr, L"&OFFSET=") != NULL) {
3144 RequestBlockArray = GetBlockElement(StringPtr, &Progress);
3145 } else {
3146 RequestBlockArray = GetNameElement(StringPtr, &Progress);
3147 }
3148
3149 if (RequestBlockArray == NULL) {
3150 Status = EFI_INVALID_PARAMETER;
3151 goto Done;
3152 }
3153 }
3154
3155 //
3156 // Initialize DefaultIdArray to store the map between DeaultId and DefaultName
3157 //
3158 DefaultIdArray = (IFR_DEFAULT_DATA *) AllocateZeroPool (sizeof (IFR_DEFAULT_DATA));
3159 if (DefaultIdArray == NULL) {
3160 Status = EFI_OUT_OF_RESOURCES;
3161 goto Done;
3162 }
3163 InitializeListHead (&DefaultIdArray->Entry);
3164
3165 //
3166 // Initialize VarStorageData to store the var store Block and Default value information.
3167 //
3168 VarStorageData = (IFR_VARSTORAGE_DATA *) AllocateZeroPool (sizeof (IFR_VARSTORAGE_DATA));
3169 if (VarStorageData == NULL) {
3170 Status = EFI_OUT_OF_RESOURCES;
3171 goto Done;
3172 }
3173 InitializeListHead (&VarStorageData->Entry);
3174 InitializeListHead (&VarStorageData->BlockEntry);
3175
3176 //
3177 // 2. Parse FormPackage to get BlockArray and DefaultId Array for the request BlockArray.
3178 //
3179
3180 //
3181 // Parse the opcode in form pacakge to get the default setting.
3182 //
3183 Status = ParseIfrData (DataBaseRecord->Handle,
3184 HiiFormPackage,
3185 (UINT32) PackageSize,
3186 *Request,
3187 RequestBlockArray,
3188 VarStorageData,
3189 DefaultIdArray);
3190 if (EFI_ERROR (Status)) {
3191 goto Done;
3192 }
3193
3194 //
3195 // No requested varstore in IFR data and directly return
3196 //
3197 if (VarStorageData->Type == 0 && VarStorageData->Name == NULL) {
3198 Status = EFI_SUCCESS;
3199 goto Done;
3200 }
3201
3202 //
3203 // 3. Construct Request Element (Block Name) for 2.1 and 2.2 case.
3204 //
3205 Status = GenerateHdr (VarStorageData, DevicePath, &ConfigHdr);
3206 if (EFI_ERROR (Status)) {
3207 goto Done;
3208 }
3209
3210 if (RequestBlockArray == NULL) {
3211 if (!GenerateConfigRequest(ConfigHdr, VarStorageData, &Status, Request)) {
3212 goto Done;
3213 }
3214 }
3215
3216 //
3217 // 4. Construct Default Value string in AltResp according to request element.
3218 // Go through all VarStorageData Entry and get the DefaultId array for each one
3219 // Then construct them all to : ConfigHdr AltConfigHdr ConfigBody AltConfigHdr ConfigBody
3220 //
3221 Status = GenerateAltConfigResp (ConfigHdr, VarStorageData, DefaultIdArray, &DefaultAltCfgResp);
3222 if (EFI_ERROR (Status)) {
3223 goto Done;
3224 }
3225
3226 //
3227 // 5. Merge string into the input AltCfgResp if the iput *AltCfgResp is not NULL.
3228 //
3229 if (*AltCfgResp != NULL && DefaultAltCfgResp != NULL) {
3230 Status = MergeDefaultString (AltCfgResp, DefaultAltCfgResp);
3231 FreePool (DefaultAltCfgResp);
3232 } else if (*AltCfgResp == NULL) {
3233 *AltCfgResp = DefaultAltCfgResp;
3234 }
3235
3236 Done:
3237 if (RequestBlockArray != NULL) {
3238 //
3239 // Free Link Array RequestBlockArray
3240 //
3241 while (!IsListEmpty (&RequestBlockArray->Entry)) {
3242 BlockData = BASE_CR (RequestBlockArray->Entry.ForwardLink, IFR_BLOCK_DATA, Entry);
3243 RemoveEntryList (&BlockData->Entry);
3244 if (BlockData->Name != NULL) {
3245 FreePool (BlockData->Name);
3246 }
3247 FreePool (BlockData);
3248 }
3249
3250 FreePool (RequestBlockArray);
3251 }
3252
3253 if (VarStorageData != NULL) {
3254 //
3255 // Free link array VarStorageData
3256 //
3257 while (!IsListEmpty (&VarStorageData->BlockEntry)) {
3258 BlockData = BASE_CR (VarStorageData->BlockEntry.ForwardLink, IFR_BLOCK_DATA, Entry);
3259 RemoveEntryList (&BlockData->Entry);
3260 if (BlockData->Name != NULL) {
3261 FreePool (BlockData->Name);
3262 }
3263 //
3264 // Free default value link array
3265 //
3266 while (!IsListEmpty (&BlockData->DefaultValueEntry)) {
3267 DefaultValueData = BASE_CR (BlockData->DefaultValueEntry.ForwardLink, IFR_DEFAULT_DATA, Entry);
3268 RemoveEntryList (&DefaultValueData->Entry);
3269 FreePool (DefaultValueData);
3270 }
3271 FreePool (BlockData);
3272 }
3273 FreePool (VarStorageData);
3274 }
3275
3276 if (DefaultIdArray != NULL) {
3277 //
3278 // Free DefaultId Array
3279 //
3280 while (!IsListEmpty (&DefaultIdArray->Entry)) {
3281 DefaultId = BASE_CR (DefaultIdArray->Entry.ForwardLink, IFR_DEFAULT_DATA, Entry);
3282 RemoveEntryList (&DefaultId->Entry);
3283 FreePool (DefaultId);
3284 }
3285 FreePool (DefaultIdArray);
3286 }
3287
3288 //
3289 // Free the allocated string
3290 //
3291 if (ConfigHdr != NULL) {
3292 FreePool (ConfigHdr);
3293 }
3294
3295 //
3296 // Free Pacakge data
3297 //
3298 if (HiiFormPackage != NULL) {
3299 FreePool (HiiFormPackage);
3300 }
3301
3302 if (PointerProgress != NULL) {
3303 if (*Request == NULL) {
3304 *PointerProgress = NULL;
3305 } else if (EFI_ERROR (Status)) {
3306 *PointerProgress = *Request;
3307 } else {
3308 *PointerProgress = *Request + StrLen (*Request);
3309 }
3310 }
3311
3312 return Status;
3313 }
3314
3315 /**
3316 This function gets the full request resp string by
3317 parsing IFR data in HII form packages.
3318
3319 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3320 instance.
3321 @param EfiVarStoreInfo The efi varstore info which is save in the EFI
3322 varstore data structure.
3323 @param Request Pointer to a null-terminated Unicode string in
3324 <ConfigRequest> format.
3325 @param RequestResp Pointer to a null-terminated Unicode string in
3326 <ConfigResp> format.
3327 @param AccessProgress On return, points to a character in the Request
3328 string. Points to the string's null terminator if
3329 request was successful. Points to the most recent
3330 & before the first failing name / value pair (or
3331 the beginning of the string if the failure is in
3332 the first name / value pair) if the request was
3333 not successful.
3334
3335 @retval EFI_SUCCESS The Results string is set to the full request string.
3336 And AltCfgResp contains all default value string.
3337 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3338 @retval EFI_INVALID_PARAMETER Request points to NULL.
3339
3340 **/
3341 EFI_STATUS
3342 GetConfigRespFromEfiVarStore (
3343 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
3344 IN EFI_IFR_VARSTORE_EFI *EfiVarStoreInfo,
3345 IN EFI_STRING Request,
3346 OUT EFI_STRING *RequestResp,
3347 OUT EFI_STRING *AccessProgress
3348 )
3349 {
3350 EFI_STATUS Status;
3351 EFI_STRING VarStoreName;
3352 UINT8 *VarStore;
3353 UINTN BufferSize;
3354
3355 Status = EFI_SUCCESS;
3356 BufferSize = 0;
3357 VarStore = NULL;
3358 VarStoreName = NULL;
3359 *AccessProgress = Request;
3360
3361 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)EfiVarStoreInfo->Name) * sizeof (CHAR16));
3362 if (VarStoreName == NULL) {
3363 Status = EFI_OUT_OF_RESOURCES;
3364 goto Done;
3365 }
3366 AsciiStrToUnicodeStr ((CHAR8 *) EfiVarStoreInfo->Name, VarStoreName);
3367
3368
3369 Status = gRT->GetVariable (VarStoreName, &EfiVarStoreInfo->Guid, NULL, &BufferSize, NULL);
3370 if (Status != EFI_BUFFER_TOO_SMALL) {
3371 goto Done;
3372 }
3373
3374 VarStore = AllocateZeroPool (BufferSize);
3375 ASSERT (VarStore != NULL);
3376 Status = gRT->GetVariable (VarStoreName, &EfiVarStoreInfo->Guid, NULL, &BufferSize, VarStore);
3377 if (EFI_ERROR (Status)) {
3378 goto Done;
3379 }
3380
3381 Status = HiiBlockToConfig(This, Request, VarStore, BufferSize, RequestResp, AccessProgress);
3382 if (EFI_ERROR (Status)) {
3383 goto Done;
3384 }
3385
3386 Done:
3387 if (VarStoreName != NULL) {
3388 FreePool (VarStoreName);
3389 }
3390
3391 if (VarStore != NULL) {
3392 FreePool (VarStore);
3393 }
3394
3395 return Status;
3396 }
3397
3398
3399 /**
3400 This function route the full request resp string for efi varstore.
3401
3402 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3403 instance.
3404 @param EfiVarStoreInfo The efi varstore info which is save in the EFI
3405 varstore data structure.
3406 @param RequestResp Pointer to a null-terminated Unicode string in
3407 <ConfigResp> format.
3408 @param Result Pointer to a null-terminated Unicode string in
3409 <ConfigResp> format.
3410
3411 @retval EFI_SUCCESS The Results string is set to the full request string.
3412 And AltCfgResp contains all default value string.
3413 @retval EFI_OUT_OF_RESOURCES Not enough memory for the return string.
3414 @retval EFI_INVALID_PARAMETER Request points to NULL.
3415
3416 **/
3417 EFI_STATUS
3418 RouteConfigRespForEfiVarStore (
3419 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
3420 IN EFI_IFR_VARSTORE_EFI *EfiVarStoreInfo,
3421 IN EFI_STRING RequestResp,
3422 OUT EFI_STRING *Result
3423 )
3424 {
3425 EFI_STATUS Status;
3426 EFI_STRING VarStoreName;
3427 UINT8 *VarStore;
3428 UINTN BufferSize;
3429 UINTN BlockSize;
3430
3431 Status = EFI_SUCCESS;
3432 BufferSize = 0;
3433 VarStore = NULL;
3434 VarStoreName = NULL;
3435
3436 VarStoreName = AllocateZeroPool (AsciiStrSize ((CHAR8 *)EfiVarStoreInfo->Name) * sizeof (CHAR16));
3437 if (VarStoreName == NULL) {
3438 Status = EFI_OUT_OF_RESOURCES;
3439 goto Done;
3440 }
3441 AsciiStrToUnicodeStr ((CHAR8 *) EfiVarStoreInfo->Name, VarStoreName);
3442
3443 Status = gRT->GetVariable (VarStoreName, &EfiVarStoreInfo->Guid, NULL, &BufferSize, NULL);
3444 if (Status != EFI_BUFFER_TOO_SMALL) {
3445 goto Done;
3446 }
3447
3448 BlockSize = BufferSize;
3449 VarStore = AllocateZeroPool (BufferSize);
3450 ASSERT (VarStore != NULL);
3451 Status = gRT->GetVariable (VarStoreName, &EfiVarStoreInfo->Guid, NULL, &BufferSize, VarStore);
3452 if (EFI_ERROR (Status)) {
3453 goto Done;
3454 }
3455
3456 Status = HiiConfigToBlock(This, RequestResp, VarStore, &BlockSize, Result);
3457 if (EFI_ERROR (Status)) {
3458 goto Done;
3459 }
3460
3461 Status = gRT->SetVariable (VarStoreName, &EfiVarStoreInfo->Guid, EfiVarStoreInfo->Attributes, BufferSize, VarStore);
3462 if (EFI_ERROR (Status)) {
3463 goto Done;
3464 }
3465
3466 Done:
3467 if (VarStoreName != NULL) {
3468 FreePool (VarStoreName);
3469 }
3470
3471 if (VarStore != NULL) {
3472 FreePool (VarStore);
3473 }
3474
3475 return Status;
3476 }
3477
3478 /**
3479 Validate the config request elements.
3480
3481 @param ConfigElements A null-terminated Unicode string in <ConfigRequest> format,
3482 without configHdr field.
3483
3484 @retval CHAR16 * THE first Name/value pair not correct.
3485 @retval NULL Success parse the name/value pair
3486 **/
3487 CHAR16 *
3488 OffsetWidthValidate (
3489 CHAR16 *ConfigElements
3490 )
3491 {
3492 CHAR16 *StringPtr;
3493 CHAR16 *RetVal;
3494
3495 StringPtr = ConfigElements;
3496
3497 while (1) {
3498 RetVal = StringPtr;
3499 if (StrnCmp (StringPtr, L"&OFFSET=", StrLen (L"&OFFSET=")) != 0) {
3500 return RetVal;
3501 }
3502
3503 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {
3504 StringPtr++;
3505 }
3506 if (*StringPtr == L'\0') {
3507 return RetVal;
3508 }
3509
3510 StringPtr += StrLen (L"&WIDTH=");
3511 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&OFFSET=", StrLen (L"&OFFSET=")) != 0) {
3512 StringPtr ++;
3513 }
3514
3515 if (*StringPtr == L'\0') {
3516 return NULL;
3517 }
3518 }
3519 }
3520
3521 /**
3522 Validate the config request elements.
3523
3524 @param ConfigElements A null-terminated Unicode string in <ConfigRequest> format,
3525 without configHdr field.
3526
3527 @retval CHAR16 * THE first Name/value pair not correct.
3528 @retval NULL Success parse the name/value pair
3529
3530 **/
3531 CHAR16 *
3532 NameValueValidate (
3533 CHAR16 *ConfigElements
3534 )
3535 {
3536 CHAR16 *StringPtr;
3537 CHAR16 *RetVal;
3538
3539 StringPtr = ConfigElements;
3540
3541 while (1) {
3542 RetVal = StringPtr;
3543 if (*StringPtr != L'&') {
3544 return RetVal;
3545 }
3546 StringPtr += 1;
3547
3548 StringPtr = StrStr (StringPtr, L"&");
3549
3550 if (StringPtr == NULL) {
3551 return NULL;
3552 }
3553 }
3554 }
3555
3556 /**
3557 Validate the config request string.
3558
3559 @param ConfigRequest A null-terminated Unicode string in <ConfigRequest> format.
3560
3561 @retval CHAR16 * THE first element not correct.
3562 @retval NULL Success parse the name/value pair
3563
3564 **/
3565 CHAR16 *
3566 ConfigRequestValidate (
3567 CHAR16 *ConfigRequest
3568 )
3569 {
3570 BOOLEAN HasNameField;
3571 CHAR16 *StringPtr;
3572
3573 HasNameField = TRUE;
3574 StringPtr = ConfigRequest;
3575
3576 //
3577 // Check <ConfigHdr>
3578 //
3579 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
3580 return ConfigRequest;
3581 }
3582 StringPtr += StrLen (L"GUID=");
3583 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&NAME=", StrLen (L"&NAME=")) != 0) {
3584 StringPtr++;
3585 }
3586 if (*StringPtr == L'\0') {
3587 return ConfigRequest;
3588 }
3589 StringPtr += StrLen (L"&NAME=");
3590 if (*StringPtr == L'&') {
3591 HasNameField = FALSE;
3592 }
3593 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&PATH=", StrLen (L"&PATH=")) != 0) {
3594 StringPtr++;
3595 }
3596 if (*StringPtr == L'\0') {
3597 return ConfigRequest;
3598 }
3599 StringPtr += StrLen (L"&PATH=");
3600 while (*StringPtr != L'\0' && *StringPtr != L'&') {
3601 StringPtr ++;
3602 }
3603
3604 if (*StringPtr == L'\0') {
3605 return NULL;
3606 }
3607
3608 if (HasNameField) {
3609 //
3610 // Should be Buffer varstore, config request should be "OFFSET/Width" pairs.
3611 //
3612 return OffsetWidthValidate(StringPtr);
3613 } else {
3614 //
3615 // Should be Name/Value varstore, config request should be "&name1&name2..." pairs.
3616 //
3617 return NameValueValidate(StringPtr);
3618 }
3619 }
3620
3621 /**
3622 This function allows a caller to extract the current configuration
3623 for one or more named elements from one or more drivers.
3624
3625 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3626 instance.
3627 @param Request A null-terminated Unicode string in
3628 <MultiConfigRequest> format.
3629 @param Progress On return, points to a character in the Request
3630 string. Points to the string's null terminator if
3631 request was successful. Points to the most recent
3632 & before the first failing name / value pair (or
3633 the beginning of the string if the failure is in
3634 the first name / value pair) if the request was
3635 not successful.
3636 @param Results Null-terminated Unicode string in
3637 <MultiConfigAltResp> format which has all values
3638 filled in for the names in the Request string.
3639 String to be allocated by the called function.
3640
3641 @retval EFI_SUCCESS The Results string is filled with the values
3642 corresponding to all requested names.
3643 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
3644 results that must be stored awaiting possible
3645 future protocols.
3646 @retval EFI_NOT_FOUND Routing data doesn't match any known driver.
3647 Progress set to the "G" in "GUID" of the routing
3648 header that doesn't match. Note: There is no
3649 requirement that all routing data be validated
3650 before any configuration extraction.
3651 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Request
3652 parameter would result in this type of error. The
3653 Progress parameter is set to NULL.
3654 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set to most recent &
3655 before the error or the beginning of the string.
3656 @retval EFI_INVALID_PARAMETER The ExtractConfig function of the underlying HII
3657 Configuration Access Protocol returned
3658 EFI_INVALID_PARAMETER. Progress set to most recent
3659 & before the error or the beginning of the string.
3660
3661 **/
3662 EFI_STATUS
3663 EFIAPI
3664 HiiConfigRoutingExtractConfig (
3665 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
3666 IN CONST EFI_STRING Request,
3667 OUT EFI_STRING *Progress,
3668 OUT EFI_STRING *Results
3669 )
3670 {
3671 HII_DATABASE_PRIVATE_DATA *Private;
3672 EFI_STRING StringPtr;
3673 EFI_STRING ConfigRequest;
3674 UINTN Length;
3675 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
3676 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
3677 EFI_STATUS Status;
3678 LIST_ENTRY *Link;
3679 HII_DATABASE_RECORD *Database;
3680 UINT8 *DevicePathPkg;
3681 UINT8 *CurrentDevicePath;
3682 EFI_HANDLE DriverHandle;
3683 EFI_HII_HANDLE HiiHandle;
3684 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
3685 EFI_STRING AccessProgress;
3686 EFI_STRING AccessResults;
3687 EFI_STRING DefaultResults;
3688 BOOLEAN FirstElement;
3689 BOOLEAN IfrDataParsedFlag;
3690 BOOLEAN IsEfiVarStore;
3691 EFI_IFR_VARSTORE_EFI *EfiVarStoreInfo;
3692 EFI_STRING ErrorPtr;
3693 UINTN DevicePathSize;
3694
3695 if (This == NULL || Progress == NULL || Results == NULL) {
3696 return EFI_INVALID_PARAMETER;
3697 }
3698
3699 if (Request == NULL) {
3700 *Progress = NULL;
3701 return EFI_INVALID_PARAMETER;
3702 }
3703
3704 Private = CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This);
3705 StringPtr = Request;
3706 *Progress = StringPtr;
3707 DefaultResults = NULL;
3708 ConfigRequest = NULL;
3709 Status = EFI_SUCCESS;
3710 AccessResults = NULL;
3711 AccessProgress = NULL;
3712 DevicePath = NULL;
3713 IfrDataParsedFlag = FALSE;
3714 IsEfiVarStore = FALSE;
3715 EfiVarStoreInfo = NULL;
3716
3717 //
3718 // The first element of <MultiConfigRequest> should be
3719 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
3720 //
3721 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
3722 return EFI_INVALID_PARAMETER;
3723 }
3724
3725 FirstElement = TRUE;
3726
3727 //
3728 // Allocate a fix length of memory to store Results. Reallocate memory for
3729 // Results if this fix length is insufficient.
3730 //
3731 *Results = (EFI_STRING) AllocateZeroPool (MAX_STRING_LENGTH);
3732 if (*Results == NULL) {
3733 return EFI_OUT_OF_RESOURCES;
3734 }
3735
3736 while (*StringPtr != 0 && StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) == 0) {
3737 //
3738 // If parsing error, set Progress to the beginning of the <MultiConfigRequest>
3739 // or most recent & before the error.
3740 //
3741 if (StringPtr == Request) {
3742 *Progress = StringPtr;
3743 } else {
3744 *Progress = StringPtr - 1;
3745 }
3746
3747 //
3748 // Process each <ConfigRequest> of <MultiConfigRequest>
3749 //
3750 Length = CalculateConfigStringLen (StringPtr);
3751 ConfigRequest = AllocateCopyPool ((Length + 1) * sizeof (CHAR16), StringPtr);
3752 if (ConfigRequest == NULL) {
3753 Status = EFI_OUT_OF_RESOURCES;
3754 goto Done;
3755 }
3756 *(ConfigRequest + Length) = 0;
3757
3758 //
3759 // Get the UEFI device path
3760 //
3761 Status = GetDevicePath (ConfigRequest, (UINT8 **) &DevicePath);
3762 if (EFI_ERROR (Status)) {
3763 goto Done;
3764 }
3765
3766 //
3767 // Find driver which matches the routing data.
3768 //
3769 DriverHandle = NULL;
3770 HiiHandle = NULL;
3771 Database = NULL;
3772 for (Link = Private->DatabaseList.ForwardLink;
3773 Link != &Private->DatabaseList;
3774 Link = Link->ForwardLink
3775 ) {
3776 Database = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);
3777 if ((DevicePathPkg = Database->PackageList->DevicePathPkg) != NULL) {
3778 CurrentDevicePath = DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER);
3779 DevicePathSize = GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) CurrentDevicePath);
3780 if ((CompareMem (DevicePath,CurrentDevicePath,DevicePathSize) == 0) && IsThisPackageList(Database, ConfigRequest)) {
3781 DriverHandle = Database->DriverHandle;
3782 HiiHandle = Database->Handle;
3783 break;
3784 }
3785 }
3786 }
3787
3788 //
3789 // Try to find driver handle by device path.
3790 //
3791 if (DriverHandle == NULL) {
3792 TempDevicePath = DevicePath;
3793 Status = gBS->LocateDevicePath (
3794 &gEfiDevicePathProtocolGuid,
3795 &TempDevicePath,
3796 &DriverHandle
3797 );
3798 if (EFI_ERROR (Status) || (DriverHandle == NULL)) {
3799 //
3800 // Routing data does not match any known driver.
3801 // Set Progress to the 'G' in "GUID" of the routing header.
3802 //
3803 *Progress = StringPtr;
3804 Status = EFI_NOT_FOUND;
3805 goto Done;
3806 }
3807 }
3808
3809 //
3810 // Validate ConfigRequest String.
3811 //
3812 ErrorPtr = ConfigRequestValidate(ConfigRequest);
3813 if (ErrorPtr != NULL) {
3814 *Progress = StrStr (StringPtr, ErrorPtr);
3815 Status = EFI_INVALID_PARAMETER;
3816 goto Done;
3817 }
3818
3819 //
3820 // Check whether ConfigRequest contains request string.
3821 //
3822 IfrDataParsedFlag = FALSE;
3823 if ((HiiHandle != NULL) && !GetElementsFromRequest(ConfigRequest)) {
3824 //
3825 // Get the full request string from IFR when HiiPackage is registered to HiiHandle
3826 //
3827 IfrDataParsedFlag = TRUE;
3828 Status = GetFullStringFromHiiFormPackages (Database, DevicePath, &ConfigRequest, &DefaultResults, &AccessProgress);
3829 if (EFI_ERROR (Status)) {
3830 //
3831 // AccessProgress indicates the parsing progress on <ConfigRequest>.
3832 // Map it to the progress on <MultiConfigRequest> then return it.
3833 //
3834 ASSERT (AccessProgress != NULL);
3835 *Progress = StrStr (StringPtr, AccessProgress);
3836 goto Done;
3837 }
3838 //
3839 // Not any request block is found.
3840 //
3841 if (!GetElementsFromRequest(ConfigRequest)) {
3842 AccessResults = AllocateCopyPool (StrSize (ConfigRequest), ConfigRequest);
3843 goto NextConfigString;
3844 }
3845 }
3846
3847 //
3848 // Check whether this ConfigRequest is search from Efi varstore type storage.
3849 //
3850 Status = GetVarStoreType(Database, ConfigRequest, &IsEfiVarStore, &EfiVarStoreInfo);
3851 if (EFI_ERROR (Status)) {
3852 goto Done;
3853 }
3854
3855 if (IsEfiVarStore) {
3856 //
3857 // Call the GetVariable function to extract settings.
3858 //
3859 Status = GetConfigRespFromEfiVarStore(This, EfiVarStoreInfo, ConfigRequest, &AccessResults, &AccessProgress);
3860 FreePool (EfiVarStoreInfo);
3861 } else {
3862 //
3863 // Call corresponding ConfigAccess protocol to extract settings
3864 //
3865 Status = gBS->HandleProtocol (
3866 DriverHandle,
3867 &gEfiHiiConfigAccessProtocolGuid,
3868 (VOID **) &ConfigAccess
3869 );
3870 ASSERT_EFI_ERROR (Status);
3871
3872 Status = ConfigAccess->ExtractConfig (
3873 ConfigAccess,
3874 ConfigRequest,
3875 &AccessProgress,
3876 &AccessResults
3877 );
3878 }
3879 if (EFI_ERROR (Status)) {
3880 //
3881 // AccessProgress indicates the parsing progress on <ConfigRequest>.
3882 // Map it to the progress on <MultiConfigRequest> then return it.
3883 //
3884 *Progress = StrStr (StringPtr, AccessProgress);
3885 goto Done;
3886 }
3887
3888 //
3889 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
3890 // which seperates the first <ConfigAltResp> and the following ones.
3891 //
3892 ASSERT (*AccessProgress == 0);
3893
3894 //
3895 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
3896 //
3897 if (!IfrDataParsedFlag && HiiHandle != NULL) {
3898 Status = GetFullStringFromHiiFormPackages (Database, DevicePath, &ConfigRequest, &DefaultResults, NULL);
3899 ASSERT_EFI_ERROR (Status);
3900 }
3901
3902 FreePool (DevicePath);
3903 DevicePath = NULL;
3904
3905 if (DefaultResults != NULL) {
3906 Status = MergeDefaultString (&AccessResults, DefaultResults);
3907 ASSERT_EFI_ERROR (Status);
3908 FreePool (DefaultResults);
3909 DefaultResults = NULL;
3910 }
3911
3912 NextConfigString:
3913 if (!FirstElement) {
3914 Status = AppendToMultiString (Results, L"&");
3915 ASSERT_EFI_ERROR (Status);
3916 }
3917
3918 Status = AppendToMultiString (Results, AccessResults);
3919 ASSERT_EFI_ERROR (Status);
3920
3921 FirstElement = FALSE;
3922
3923 FreePool (AccessResults);
3924 AccessResults = NULL;
3925 FreePool (ConfigRequest);
3926 ConfigRequest = NULL;
3927
3928 //
3929 // Go to next <ConfigRequest> (skip '&').
3930 //
3931 StringPtr += Length;
3932 if (*StringPtr == 0) {
3933 *Progress = StringPtr;
3934 break;
3935 }
3936
3937 StringPtr++;
3938 }
3939
3940 Done:
3941 if (EFI_ERROR (Status)) {
3942 FreePool (*Results);
3943 *Results = NULL;
3944 }
3945
3946 if (ConfigRequest != NULL) {
3947 FreePool (ConfigRequest);
3948 }
3949
3950 if (AccessResults != NULL) {
3951 FreePool (AccessResults);
3952 }
3953
3954 if (DefaultResults != NULL) {
3955 FreePool (DefaultResults);
3956 }
3957
3958 if (DevicePath != NULL) {
3959 FreePool (DevicePath);
3960 }
3961
3962 return Status;
3963 }
3964
3965
3966 /**
3967 This function allows the caller to request the current configuration for the
3968 entirety of the current HII database and returns the data in a
3969 null-terminated Unicode string.
3970
3971 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
3972 instance.
3973 @param Results Null-terminated Unicode string in
3974 <MultiConfigAltResp> format which has all values
3975 filled in for the entirety of the current HII
3976 database. String to be allocated by the called
3977 function. De-allocation is up to the caller.
3978
3979 @retval EFI_SUCCESS The Results string is filled with the values
3980 corresponding to all requested names.
3981 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
3982 results that must be stored awaiting possible
3983 future protocols.
3984 @retval EFI_INVALID_PARAMETER For example, passing in a NULL for the Results
3985 parameter would result in this type of error.
3986
3987 **/
3988 EFI_STATUS
3989 EFIAPI
3990 HiiConfigRoutingExportConfig (
3991 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
3992 OUT EFI_STRING *Results
3993 )
3994 {
3995 EFI_STATUS Status;
3996 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
3997 EFI_STRING AccessResults;
3998 EFI_STRING Progress;
3999 EFI_STRING StringPtr;
4000 EFI_STRING ConfigRequest;
4001 UINTN Index;
4002 EFI_HANDLE *ConfigAccessHandles;
4003 UINTN NumberConfigAccessHandles;
4004 BOOLEAN FirstElement;
4005 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
4006 EFI_HII_HANDLE HiiHandle;
4007 EFI_STRING DefaultResults;
4008 HII_DATABASE_PRIVATE_DATA *Private;
4009 LIST_ENTRY *Link;
4010 HII_DATABASE_RECORD *Database;
4011 UINT8 *DevicePathPkg;
4012 UINT8 *CurrentDevicePath;
4013 BOOLEAN IfrDataParsedFlag;
4014
4015 if (This == NULL || Results == NULL) {
4016 return EFI_INVALID_PARAMETER;
4017 }
4018
4019 Private = CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This);
4020
4021 //
4022 // Allocate a fix length of memory to store Results. Reallocate memory for
4023 // Results if this fix length is insufficient.
4024 //
4025 *Results = (EFI_STRING) AllocateZeroPool (MAX_STRING_LENGTH);
4026 if (*Results == NULL) {
4027 return EFI_OUT_OF_RESOURCES;
4028 }
4029
4030 NumberConfigAccessHandles = 0;
4031 Status = gBS->LocateHandleBuffer (
4032 ByProtocol,
4033 &gEfiHiiConfigAccessProtocolGuid,
4034 NULL,
4035 &NumberConfigAccessHandles,
4036 &ConfigAccessHandles
4037 );
4038 if (EFI_ERROR (Status)) {
4039 return Status;
4040 }
4041
4042 FirstElement = TRUE;
4043
4044 for (Index = 0; Index < NumberConfigAccessHandles; Index++) {
4045 Status = gBS->HandleProtocol (
4046 ConfigAccessHandles[Index],
4047 &gEfiHiiConfigAccessProtocolGuid,
4048 (VOID **) &ConfigAccess
4049 );
4050 if (EFI_ERROR (Status)) {
4051 continue;
4052 }
4053
4054 //
4055 // Get DevicePath and HiiHandle for this ConfigAccess driver handle
4056 //
4057 IfrDataParsedFlag = FALSE;
4058 Progress = NULL;
4059 HiiHandle = NULL;
4060 DefaultResults = NULL;
4061 Database = NULL;
4062 ConfigRequest = NULL;
4063 DevicePath = DevicePathFromHandle (ConfigAccessHandles[Index]);
4064 if (DevicePath != NULL) {
4065 for (Link = Private->DatabaseList.ForwardLink;
4066 Link != &Private->DatabaseList;
4067 Link = Link->ForwardLink
4068 ) {
4069 Database = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);
4070 if ((DevicePathPkg = Database->PackageList->DevicePathPkg) != NULL) {
4071 CurrentDevicePath = DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER);
4072 if (CompareMem (
4073 DevicePath,
4074 CurrentDevicePath,
4075 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) CurrentDevicePath)
4076 ) == 0) {
4077 HiiHandle = Database->Handle;
4078 break;
4079 }
4080 }
4081 }
4082 }
4083
4084 Status = ConfigAccess->ExtractConfig (
4085 ConfigAccess,
4086 NULL,
4087 &Progress,
4088 &AccessResults
4089 );
4090 if (EFI_ERROR (Status)) {
4091 //
4092 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
4093 //
4094 if (HiiHandle != NULL && DevicePath != NULL) {
4095 IfrDataParsedFlag = TRUE;
4096 Status = GetFullStringFromHiiFormPackages (Database, DevicePath, &ConfigRequest, &DefaultResults, NULL);
4097 //
4098 // Get the full request string to get the Current setting again.
4099 //
4100 if (!EFI_ERROR (Status) && ConfigRequest != NULL) {
4101 Status = ConfigAccess->ExtractConfig (
4102 ConfigAccess,
4103 ConfigRequest,
4104 &Progress,
4105 &AccessResults
4106 );
4107 FreePool (ConfigRequest);
4108 } else {
4109 Status = EFI_NOT_FOUND;
4110 }
4111 }
4112 }
4113
4114 if (!EFI_ERROR (Status)) {
4115 //
4116 // Update AccessResults by getting default setting from IFR when HiiPackage is registered to HiiHandle
4117 //
4118 if (!IfrDataParsedFlag && HiiHandle != NULL && DevicePath != NULL) {
4119 StringPtr = StrStr (AccessResults, L"&GUID=");
4120 if (StringPtr != NULL) {
4121 *StringPtr = 0;
4122 }
4123 if (GetElementsFromRequest (AccessResults)) {
4124 Status = GetFullStringFromHiiFormPackages (Database, DevicePath, &AccessResults, &DefaultResults, NULL);
4125 ASSERT_EFI_ERROR (Status);
4126 }
4127 if (StringPtr != NULL) {
4128 *StringPtr = L'&';
4129 }
4130 }
4131 //
4132 // Merge the default sting from IFR code into the got setting from driver.
4133 //
4134 if (DefaultResults != NULL) {
4135 Status = MergeDefaultString (&AccessResults, DefaultResults);
4136 ASSERT_EFI_ERROR (Status);
4137 FreePool (DefaultResults);
4138 DefaultResults = NULL;
4139 }
4140
4141 //
4142 // Attach this <ConfigAltResp> to a <MultiConfigAltResp>. There is a '&'
4143 // which seperates the first <ConfigAltResp> and the following ones.
4144 //
4145 if (!FirstElement) {
4146 Status = AppendToMultiString (Results, L"&");
4147 ASSERT_EFI_ERROR (Status);
4148 }
4149
4150 Status = AppendToMultiString (Results, AccessResults);
4151 ASSERT_EFI_ERROR (Status);
4152
4153 FirstElement = FALSE;
4154
4155 FreePool (AccessResults);
4156 AccessResults = NULL;
4157 }
4158 }
4159 FreePool (ConfigAccessHandles);
4160
4161 return EFI_SUCCESS;
4162 }
4163
4164
4165 /**
4166 This function processes the results of processing forms and routes it to the
4167 appropriate handlers or storage.
4168
4169 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4170 instance.
4171 @param Configuration A null-terminated Unicode string in
4172 <MulltiConfigResp> format.
4173 @param Progress A pointer to a string filled in with the offset of
4174 the most recent & before the first failing name /
4175 value pair (or the beginning of the string if the
4176 failure is in the first name / value pair) or the
4177 terminating NULL if all was successful.
4178
4179 @retval EFI_SUCCESS The results have been distributed or are awaiting
4180 distribution.
4181 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the
4182 results that must be stored awaiting possible
4183 future protocols.
4184 @retval EFI_INVALID_PARAMETER Passing in a NULL for the Configuration parameter
4185 would result in this type of error.
4186 @retval EFI_NOT_FOUND Target for the specified routing data was not
4187 found.
4188
4189 **/
4190 EFI_STATUS
4191 EFIAPI
4192 HiiConfigRoutingRouteConfig (
4193 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
4194 IN CONST EFI_STRING Configuration,
4195 OUT EFI_STRING *Progress
4196 )
4197 {
4198 HII_DATABASE_PRIVATE_DATA *Private;
4199 EFI_STRING StringPtr;
4200 EFI_STRING ConfigResp;
4201 UINTN Length;
4202 EFI_STATUS Status;
4203 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
4204 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
4205 LIST_ENTRY *Link;
4206 HII_DATABASE_RECORD *Database;
4207 UINT8 *DevicePathPkg;
4208 UINT8 *CurrentDevicePath;
4209 EFI_HANDLE DriverHandle;
4210 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
4211 EFI_STRING AccessProgress;
4212 EFI_IFR_VARSTORE_EFI *EfiVarStoreInfo;
4213 BOOLEAN IsEfiVarstore;
4214 UINTN DevicePathSize;
4215
4216 if (This == NULL || Progress == NULL) {
4217 return EFI_INVALID_PARAMETER;
4218 }
4219
4220 if (Configuration == NULL) {
4221 *Progress = NULL;
4222 return EFI_INVALID_PARAMETER;
4223 }
4224
4225 Private = CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This);
4226 StringPtr = Configuration;
4227 *Progress = StringPtr;
4228 Database = NULL;
4229 AccessProgress = NULL;
4230 EfiVarStoreInfo= NULL;
4231 IsEfiVarstore = FALSE;
4232
4233 //
4234 // The first element of <MultiConfigResp> should be
4235 // <GuidHdr>, which is in 'GUID='<Guid> syntax.
4236 //
4237 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
4238 return EFI_INVALID_PARAMETER;
4239 }
4240
4241 while (*StringPtr != 0 && StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) == 0) {
4242 //
4243 // If parsing error, set Progress to the beginning of the <MultiConfigResp>
4244 // or most recent & before the error.
4245 //
4246 if (StringPtr == Configuration) {
4247 *Progress = StringPtr;
4248 } else {
4249 *Progress = StringPtr - 1;
4250 }
4251
4252 //
4253 // Process each <ConfigResp> of <MultiConfigResp>
4254 //
4255 Length = CalculateConfigStringLen (StringPtr);
4256 ConfigResp = AllocateCopyPool ((Length + 1) * sizeof (CHAR16), StringPtr);
4257 if (ConfigResp == NULL) {
4258 return EFI_OUT_OF_RESOURCES;
4259 }
4260 //
4261 // Append '\0' to the end of ConfigRequest
4262 //
4263 *(ConfigResp + Length) = 0;
4264
4265 //
4266 // Get the UEFI device path
4267 //
4268 Status = GetDevicePath (ConfigResp, (UINT8 **) &DevicePath);
4269 if (EFI_ERROR (Status)) {
4270 FreePool (ConfigResp);
4271 return Status;
4272 }
4273
4274 //
4275 // Find driver which matches the routing data.
4276 //
4277 DriverHandle = NULL;
4278 for (Link = Private->DatabaseList.ForwardLink;
4279 Link != &Private->DatabaseList;
4280 Link = Link->ForwardLink
4281 ) {
4282 Database = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);
4283
4284 if ((DevicePathPkg = Database->PackageList->DevicePathPkg) != NULL) {
4285 CurrentDevicePath = DevicePathPkg + sizeof (EFI_HII_PACKAGE_HEADER);
4286 DevicePathSize = GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) CurrentDevicePath);
4287 if ((CompareMem (DevicePath,CurrentDevicePath,DevicePathSize) == 0) && IsThisPackageList(Database, ConfigResp)) {
4288 DriverHandle = Database->DriverHandle;
4289 break;
4290 }
4291 }
4292 }
4293
4294 //
4295 // Try to find driver handle by device path.
4296 //
4297 if (DriverHandle == NULL) {
4298 TempDevicePath = DevicePath;
4299 Status = gBS->LocateDevicePath (
4300 &gEfiDevicePathProtocolGuid,
4301 &TempDevicePath,
4302 &DriverHandle
4303 );
4304 if (EFI_ERROR (Status) || (DriverHandle == NULL)) {
4305 //
4306 // Routing data does not match any known driver.
4307 // Set Progress to the 'G' in "GUID" of the routing header.
4308 //
4309 FreePool (DevicePath);
4310 *Progress = StringPtr;
4311 FreePool (ConfigResp);
4312 return EFI_NOT_FOUND;
4313 }
4314 }
4315
4316 FreePool (DevicePath);
4317
4318 //
4319 // Check whether this ConfigRequest is search from Efi varstore type storage.
4320 //
4321 Status = GetVarStoreType(Database, ConfigResp, &IsEfiVarstore, &EfiVarStoreInfo);
4322 if (EFI_ERROR (Status)) {
4323 return Status;
4324 }
4325
4326 if (IsEfiVarstore) {
4327 //
4328 // Call the SetVariable function to route settings.
4329 //
4330 Status = RouteConfigRespForEfiVarStore(This, EfiVarStoreInfo, ConfigResp, &AccessProgress);
4331 FreePool (EfiVarStoreInfo);
4332 } else {
4333 //
4334 // Call corresponding ConfigAccess protocol to route settings
4335 //
4336 Status = gBS->HandleProtocol (
4337 DriverHandle,
4338 &gEfiHiiConfigAccessProtocolGuid,
4339 (VOID **) &ConfigAccess
4340 );
4341 ASSERT_EFI_ERROR (Status);
4342
4343 Status = ConfigAccess->RouteConfig (
4344 ConfigAccess,
4345 ConfigResp,
4346 &AccessProgress
4347 );
4348 }
4349 if (EFI_ERROR (Status)) {
4350 ASSERT (AccessProgress != NULL);
4351 //
4352 // AccessProgress indicates the parsing progress on <ConfigResp>.
4353 // Map it to the progress on <MultiConfigResp> then return it.
4354 //
4355 *Progress = StrStr (StringPtr, AccessProgress);
4356
4357 FreePool (ConfigResp);
4358 return Status;
4359 }
4360
4361 FreePool (ConfigResp);
4362 ConfigResp = NULL;
4363
4364 //
4365 // Go to next <ConfigResp> (skip '&').
4366 //
4367 StringPtr += Length;
4368 if (*StringPtr == 0) {
4369 *Progress = StringPtr;
4370 break;
4371 }
4372
4373 StringPtr++;
4374
4375 }
4376
4377 return EFI_SUCCESS;
4378 }
4379
4380
4381 /**
4382 This helper function is to be called by drivers to map configuration data
4383 stored in byte array ("block") formats such as UEFI Variables into current
4384 configuration strings.
4385
4386 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4387 instance.
4388 @param ConfigRequest A null-terminated Unicode string in
4389 <ConfigRequest> format.
4390 @param Block Array of bytes defining the block's configuration.
4391 @param BlockSize Length in bytes of Block.
4392 @param Config Filled-in configuration string. String allocated
4393 by the function. Returned only if call is
4394 successful. It is <ConfigResp> string format.
4395 @param Progress A pointer to a string filled in with the offset of
4396 the most recent & before the first failing
4397 name/value pair (or the beginning of the string if
4398 the failure is in the first name / value pair) or
4399 the terminating NULL if all was successful.
4400
4401 @retval EFI_SUCCESS The request succeeded. Progress points to the null
4402 terminator at the end of the ConfigRequest
4403 string.
4404 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
4405 points to the first character of ConfigRequest.
4406 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigRequest or
4407 Block parameter would result in this type of
4408 error. Progress points to the first character of
4409 ConfigRequest.
4410 @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.
4411 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted string.
4412 Block is left updated and Progress points at
4413 the "&" preceding the first non-<BlockName>.
4414
4415 **/
4416 EFI_STATUS
4417 EFIAPI
4418 HiiBlockToConfig (
4419 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
4420 IN CONST EFI_STRING ConfigRequest,
4421 IN CONST UINT8 *Block,
4422 IN CONST UINTN BlockSize,
4423 OUT EFI_STRING *Config,
4424 OUT EFI_STRING *Progress
4425 )
4426 {
4427 HII_DATABASE_PRIVATE_DATA *Private;
4428 EFI_STRING StringPtr;
4429 UINTN Length;
4430 EFI_STATUS Status;
4431 EFI_STRING TmpPtr;
4432 UINT8 *TmpBuffer;
4433 UINTN Offset;
4434 UINTN Width;
4435 UINT8 *Value;
4436 EFI_STRING ValueStr;
4437 EFI_STRING ConfigElement;
4438 UINTN Index;
4439 UINT8 *TemBuffer;
4440 CHAR16 *TemString;
4441 CHAR16 TemChar;
4442
4443 TmpBuffer = NULL;
4444
4445 if (This == NULL || Progress == NULL || Config == NULL) {
4446 return EFI_INVALID_PARAMETER;
4447 }
4448
4449 if (Block == NULL || ConfigRequest == NULL) {
4450 *Progress = ConfigRequest;
4451 return EFI_INVALID_PARAMETER;
4452 }
4453
4454
4455 Private = CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This);
4456 ASSERT (Private != NULL);
4457
4458 StringPtr = ConfigRequest;
4459 ValueStr = NULL;
4460 Value = NULL;
4461 ConfigElement = NULL;
4462
4463 //
4464 // Allocate a fix length of memory to store Results. Reallocate memory for
4465 // Results if this fix length is insufficient.
4466 //
4467 *Config = (EFI_STRING) AllocateZeroPool (MAX_STRING_LENGTH);
4468 if (*Config == NULL) {
4469 return EFI_OUT_OF_RESOURCES;
4470 }
4471
4472 //
4473 // Jump <ConfigHdr>
4474 //
4475 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
4476 *Progress = StringPtr;
4477 Status = EFI_INVALID_PARAMETER;
4478 goto Exit;
4479 }
4480 while (*StringPtr != 0 && StrnCmp (StringPtr, L"PATH=", StrLen (L"PATH=")) != 0) {
4481 StringPtr++;
4482 }
4483 if (*StringPtr == 0) {
4484 *Progress = StringPtr - 1;
4485 Status = EFI_INVALID_PARAMETER;
4486 goto Exit;
4487 }
4488
4489 while (*StringPtr != L'&' && *StringPtr != 0) {
4490 StringPtr++;
4491 }
4492 if (*StringPtr == 0) {
4493 *Progress = StringPtr;
4494
4495 AppendToMultiString(Config, ConfigRequest);
4496 HiiToLower (*Config);
4497
4498 return EFI_SUCCESS;
4499 }
4500 //
4501 // Skip '&'
4502 //
4503 StringPtr++;
4504
4505 //
4506 // Copy <ConfigHdr> and an additional '&' to <ConfigResp>
4507 //
4508 TemChar = *StringPtr;
4509 *StringPtr = '\0';
4510 AppendToMultiString(Config, ConfigRequest);
4511 *StringPtr = TemChar;
4512
4513 //
4514 // Parse each <RequestElement> if exists
4515 // Only <BlockName> format is supported by this help function.
4516 // <BlockName> ::= 'OFFSET='<Number>&'WIDTH='<Number>
4517 //
4518 while (*StringPtr != 0 && StrnCmp (StringPtr, L"OFFSET=", StrLen (L"OFFSET=")) == 0) {
4519 //
4520 // Back up the header of one <BlockName>
4521 //
4522 TmpPtr = StringPtr;
4523
4524 StringPtr += StrLen (L"OFFSET=");
4525 //
4526 // Get Offset
4527 //
4528 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
4529 if (EFI_ERROR (Status)) {
4530 *Progress = TmpPtr - 1;
4531 goto Exit;
4532 }
4533 Offset = 0;
4534 CopyMem (
4535 &Offset,
4536 TmpBuffer,
4537 (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)
4538 );
4539 FreePool (TmpBuffer);
4540
4541 StringPtr += Length;
4542 if (StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {
4543 *Progress = TmpPtr - 1;
4544 Status = EFI_INVALID_PARAMETER;
4545 goto Exit;
4546 }
4547 StringPtr += StrLen (L"&WIDTH=");
4548
4549 //
4550 // Get Width
4551 //
4552 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
4553 if (EFI_ERROR (Status)) {
4554 *Progress = TmpPtr - 1;
4555 goto Exit;
4556 }
4557 Width = 0;
4558 CopyMem (
4559 &Width,
4560 TmpBuffer,
4561 (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)
4562 );
4563 FreePool (TmpBuffer);
4564
4565 StringPtr += Length;
4566 if (*StringPtr != 0 && *StringPtr != L'&') {
4567 *Progress = TmpPtr - 1;
4568 Status = EFI_INVALID_PARAMETER;
4569 goto Exit;
4570 }
4571
4572 //
4573 // Calculate Value and convert it to hex string.
4574 //
4575 if (Offset + Width > BlockSize) {
4576 *Progress = StringPtr;
4577 Status = EFI_DEVICE_ERROR;
4578 goto Exit;
4579 }
4580
4581 Value = (UINT8 *) AllocateZeroPool (Width);
4582 if (Value == NULL) {
4583 *Progress = ConfigRequest;
4584 Status = EFI_OUT_OF_RESOURCES;
4585 goto Exit;
4586 }
4587
4588 CopyMem (Value, (UINT8 *) Block + Offset, Width);
4589
4590 Length = Width * 2 + 1;
4591 ValueStr = (EFI_STRING) AllocateZeroPool (Length * sizeof (CHAR16));
4592 if (ValueStr == NULL) {
4593 *Progress = ConfigRequest;
4594 Status = EFI_OUT_OF_RESOURCES;
4595 goto Exit;
4596 }
4597
4598 TemString = ValueStr;
4599 TemBuffer = Value + Width - 1;
4600 for (Index = 0; Index < Width; Index ++, TemBuffer --) {
4601 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
4602 }
4603
4604 FreePool (Value);
4605 Value = NULL;
4606
4607 //
4608 // Build a ConfigElement
4609 //
4610 Length += StringPtr - TmpPtr + 1 + StrLen (L"VALUE=");
4611 ConfigElement = (EFI_STRING) AllocateZeroPool (Length * sizeof (CHAR16));
4612 if (ConfigElement == NULL) {
4613 Status = EFI_OUT_OF_RESOURCES;
4614 goto Exit;
4615 }
4616 CopyMem (ConfigElement, TmpPtr, (StringPtr - TmpPtr + 1) * sizeof (CHAR16));
4617 if (*StringPtr == 0) {
4618 *(ConfigElement + (StringPtr - TmpPtr)) = L'&';
4619 }
4620 *(ConfigElement + (StringPtr - TmpPtr) + 1) = 0;
4621 StrCatS (ConfigElement, Length, L"VALUE=");
4622 StrCatS (ConfigElement, Length, ValueStr);
4623
4624 AppendToMultiString (Config, ConfigElement);
4625
4626 FreePool (ConfigElement);
4627 FreePool (ValueStr);
4628 ConfigElement = NULL;
4629 ValueStr = NULL;
4630
4631 //
4632 // If '\0', parsing is finished. Otherwise skip '&' to continue
4633 //
4634 if (*StringPtr == 0) {
4635 break;
4636 }
4637 AppendToMultiString (Config, L"&");
4638 StringPtr++;
4639
4640 }
4641
4642 if (*StringPtr != 0) {
4643 *Progress = StringPtr - 1;
4644 Status = EFI_INVALID_PARAMETER;
4645 goto Exit;
4646 }
4647
4648 HiiToLower (*Config);
4649 *Progress = StringPtr;
4650 return EFI_SUCCESS;
4651
4652 Exit:
4653 if (*Config != NULL) {
4654 FreePool (*Config);
4655 *Config = NULL;
4656 }
4657 if (ValueStr != NULL) {
4658 FreePool (ValueStr);
4659 }
4660 if (Value != NULL) {
4661 FreePool (Value);
4662 }
4663 if (ConfigElement != NULL) {
4664 FreePool (ConfigElement);
4665 }
4666
4667 return Status;
4668
4669 }
4670
4671
4672 /**
4673 This helper function is to be called by drivers to map configuration strings
4674 to configurations stored in byte array ("block") formats such as UEFI Variables.
4675
4676 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4677 instance.
4678 @param ConfigResp A null-terminated Unicode string in <ConfigResp>
4679 format.
4680 @param Block A possibly null array of bytes representing the
4681 current block. Only bytes referenced in the
4682 ConfigResp string in the block are modified. If
4683 this parameter is null or if the *BlockSize
4684 parameter is (on input) shorter than required by
4685 the Configuration string, only the BlockSize
4686 parameter is updated and an appropriate status
4687 (see below) is returned.
4688 @param BlockSize The length of the Block in units of UINT8. On
4689 input, this is the size of the Block. On output,
4690 if successful, contains the largest index of the
4691 modified byte in the Block, or the required buffer
4692 size if the Block is not large enough.
4693 @param Progress On return, points to an element of the ConfigResp
4694 string filled in with the offset of the most
4695 recent '&' before the first failing name / value
4696 pair (or the beginning of the string if the
4697 failure is in the first name / value pair) or the
4698 terminating NULL if all was successful.
4699
4700 @retval EFI_SUCCESS The request succeeded. Progress points to the null
4701 terminator at the end of the ConfigResp string.
4702 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress
4703 points to the first character of ConfigResp.
4704 @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or
4705 Block parameter would result in this type of
4706 error. Progress points to the first character of
4707 ConfigResp.
4708 @retval EFI_INVALID_PARAMETER Encountered non <BlockName> formatted name /
4709 value pair. Block is left updated and
4710 Progress points at the '&' preceding the first
4711 non-<BlockName>.
4712 @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined.
4713 BlockSize is updated with the required buffer size.
4714 @retval EFI_NOT_FOUND Target for the specified routing data was not found.
4715 Progress points to the "G" in "GUID" of the errant
4716 routing data.
4717
4718 **/
4719 EFI_STATUS
4720 EFIAPI
4721 HiiConfigToBlock (
4722 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
4723 IN CONST EFI_STRING ConfigResp,
4724 IN OUT UINT8 *Block,
4725 IN OUT UINTN *BlockSize,
4726 OUT EFI_STRING *Progress
4727 )
4728 {
4729 HII_DATABASE_PRIVATE_DATA *Private;
4730 EFI_STRING StringPtr;
4731 EFI_STRING TmpPtr;
4732 UINTN Length;
4733 EFI_STATUS Status;
4734 UINT8 *TmpBuffer;
4735 UINTN Offset;
4736 UINTN Width;
4737 UINT8 *Value;
4738 UINTN BufferSize;
4739 UINTN MaxBlockSize;
4740
4741 TmpBuffer = NULL;
4742
4743 if (This == NULL || BlockSize == NULL || Progress == NULL) {
4744 return EFI_INVALID_PARAMETER;
4745 }
4746
4747 *Progress = ConfigResp;
4748 if (ConfigResp == NULL) {
4749 return EFI_INVALID_PARAMETER;
4750 }
4751
4752 Private = CONFIG_ROUTING_DATABASE_PRIVATE_DATA_FROM_THIS (This);
4753 ASSERT (Private != NULL);
4754
4755 StringPtr = ConfigResp;
4756 BufferSize = *BlockSize;
4757 Value = NULL;
4758 MaxBlockSize = 0;
4759
4760 //
4761 // Jump <ConfigHdr>
4762 //
4763 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
4764 *Progress = StringPtr;
4765 Status = EFI_INVALID_PARAMETER;
4766 goto Exit;
4767 }
4768 while (*StringPtr != 0 && StrnCmp (StringPtr, L"PATH=", StrLen (L"PATH=")) != 0) {
4769 StringPtr++;
4770 }
4771 if (*StringPtr == 0) {
4772 *Progress = StringPtr;
4773 Status = EFI_INVALID_PARAMETER;
4774 goto Exit;
4775 }
4776
4777 while (*StringPtr != L'&' && *StringPtr != 0) {
4778 StringPtr++;
4779 }
4780 if (*StringPtr == 0) {
4781 *Progress = StringPtr;
4782 Status = EFI_INVALID_PARAMETER;
4783 goto Exit;
4784 }
4785
4786 //
4787 // Parse each <ConfigElement> if exists
4788 // Only '&'<BlockConfig> format is supported by this help function.
4789 // <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE='<Number>
4790 //
4791 while (*StringPtr != 0 && StrnCmp (StringPtr, L"&OFFSET=", StrLen (L"&OFFSET=")) == 0) {
4792 TmpPtr = StringPtr;
4793 StringPtr += StrLen (L"&OFFSET=");
4794 //
4795 // Get Offset
4796 //
4797 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
4798 if (EFI_ERROR (Status)) {
4799 *Progress = TmpPtr;
4800 goto Exit;
4801 }
4802 Offset = 0;
4803 CopyMem (
4804 &Offset,
4805 TmpBuffer,
4806 (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)
4807 );
4808 FreePool (TmpBuffer);
4809
4810 StringPtr += Length;
4811 if (StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {
4812 *Progress = TmpPtr;
4813 Status = EFI_INVALID_PARAMETER;
4814 goto Exit;
4815 }
4816 StringPtr += StrLen (L"&WIDTH=");
4817
4818 //
4819 // Get Width
4820 //
4821 Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);
4822 if (EFI_ERROR (Status)) {
4823 *Progress = TmpPtr;
4824 goto Exit;
4825 }
4826 Width = 0;
4827 CopyMem (
4828 &Width,
4829 TmpBuffer,
4830 (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)
4831 );
4832 FreePool (TmpBuffer);
4833
4834 StringPtr += Length;
4835 if (StrnCmp (StringPtr, L"&VALUE=", StrLen (L"&VALUE=")) != 0) {
4836 *Progress = TmpPtr;
4837 Status = EFI_INVALID_PARAMETER;
4838 goto Exit;
4839 }
4840 StringPtr += StrLen (L"&VALUE=");
4841
4842 //
4843 // Get Value
4844 //
4845 Status = GetValueOfNumber (StringPtr, &Value, &Length);
4846 if (EFI_ERROR (Status)) {
4847 *Progress = TmpPtr;
4848 goto Exit;
4849 }
4850
4851 StringPtr += Length;
4852 if (*StringPtr != 0 && *StringPtr != L'&') {
4853 *Progress = TmpPtr;
4854 Status = EFI_INVALID_PARAMETER;
4855 goto Exit;
4856 }
4857
4858 //
4859 // Update the Block with configuration info
4860 //
4861 if ((Block != NULL) && (Offset + Width <= BufferSize)) {
4862 CopyMem (Block + Offset, Value, Width);
4863 }
4864 if (Offset + Width > MaxBlockSize) {
4865 MaxBlockSize = Offset + Width;
4866 }
4867
4868 FreePool (Value);
4869 Value = NULL;
4870
4871 //
4872 // If '\0', parsing is finished.
4873 //
4874 if (*StringPtr == 0) {
4875 break;
4876 }
4877 }
4878
4879 //
4880 // The input string is not ConfigResp format, return error.
4881 //
4882 if (*StringPtr != 0) {
4883 *Progress = StringPtr;
4884 Status = EFI_INVALID_PARAMETER;
4885 goto Exit;
4886 }
4887
4888 *Progress = StringPtr + StrLen (StringPtr);
4889 *BlockSize = MaxBlockSize - 1;
4890
4891 if (MaxBlockSize > BufferSize) {
4892 *BlockSize = MaxBlockSize;
4893 if (Block != NULL) {
4894 return EFI_BUFFER_TOO_SMALL;
4895 }
4896 }
4897
4898 if (Block == NULL) {
4899 *Progress = ConfigResp;
4900 return EFI_INVALID_PARAMETER;
4901 }
4902
4903 return EFI_SUCCESS;
4904
4905 Exit:
4906
4907 if (Value != NULL) {
4908 FreePool (Value);
4909 }
4910 return Status;
4911 }
4912
4913
4914 /**
4915 This helper function is to be called by drivers to extract portions of
4916 a larger configuration string.
4917
4918 @param This A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL
4919 instance.
4920 @param Configuration A null-terminated Unicode string in
4921 <MultiConfigAltResp> format.
4922 @param Guid A pointer to the GUID value to search for in the
4923 routing portion of the ConfigResp string when
4924 retrieving the requested data. If Guid is NULL,
4925 then all GUID values will be searched for.
4926 @param Name A pointer to the NAME value to search for in the
4927 routing portion of the ConfigResp string when
4928 retrieving the requested data. If Name is NULL,
4929 then all Name values will be searched for.
4930 @param DevicePath A pointer to the PATH value to search for in the
4931 routing portion of the ConfigResp string when
4932 retrieving the requested data. If DevicePath is
4933 NULL, then all DevicePath values will be searched
4934 for.
4935 @param AltCfgId A pointer to the ALTCFG value to search for in the
4936 routing portion of the ConfigResp string when
4937 retrieving the requested data. If this parameter
4938 is NULL, then the current setting will be
4939 retrieved.
4940 @param AltCfgResp A pointer to a buffer which will be allocated by
4941 the function which contains the retrieved string
4942 as requested. This buffer is only allocated if
4943 the call was successful. It is <ConfigResp> format.
4944
4945 @retval EFI_SUCCESS The request succeeded. The requested data was
4946 extracted and placed in the newly allocated
4947 AltCfgResp buffer.
4948 @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp.
4949 @retval EFI_INVALID_PARAMETER Any parameter is invalid.
4950 @retval EFI_NOT_FOUND Target for the specified routing data was not
4951 found.
4952
4953 **/
4954 EFI_STATUS
4955 EFIAPI
4956 HiiGetAltCfg (
4957 IN CONST EFI_HII_CONFIG_ROUTING_PROTOCOL *This,
4958 IN CONST EFI_STRING Configuration,
4959 IN CONST EFI_GUID *Guid,
4960 IN CONST EFI_STRING Name,
4961 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
4962 IN CONST UINT16 *AltCfgId,
4963 OUT EFI_STRING *AltCfgResp
4964 )
4965 {
4966 EFI_STATUS Status;
4967 EFI_STRING StringPtr;
4968 EFI_STRING HdrStart;
4969 EFI_STRING HdrEnd;
4970 EFI_STRING TmpPtr;
4971 UINTN Length;
4972 EFI_STRING GuidStr;
4973 EFI_STRING NameStr;
4974 EFI_STRING PathStr;
4975 EFI_STRING AltIdStr;
4976 EFI_STRING Result;
4977 BOOLEAN GuidFlag;
4978 BOOLEAN NameFlag;
4979 BOOLEAN PathFlag;
4980
4981 HdrStart = NULL;
4982 HdrEnd = NULL;
4983 GuidStr = NULL;
4984 NameStr = NULL;
4985 PathStr = NULL;
4986 AltIdStr = NULL;
4987 Result = NULL;
4988 GuidFlag = FALSE;
4989 NameFlag = FALSE;
4990 PathFlag = FALSE;
4991
4992 if (This == NULL || Configuration == NULL || AltCfgResp == NULL) {
4993 return EFI_INVALID_PARAMETER;
4994 }
4995
4996 StringPtr = Configuration;
4997 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {
4998 return EFI_INVALID_PARAMETER;
4999 }
5000
5001 //
5002 // Generate the sub string for later matching.
5003 //
5004 GenerateSubStr (L"GUID=", sizeof (EFI_GUID), (VOID *) Guid, 1, &GuidStr);
5005 GenerateSubStr (
5006 L"PATH=",
5007 GetDevicePathSize ((EFI_DEVICE_PATH_PROTOCOL *) DevicePath),
5008 (VOID *) DevicePath,
5009 1,
5010 &PathStr
5011 );
5012 if (AltCfgId != NULL) {
5013 GenerateSubStr (L"ALTCFG=", sizeof (UINT16), (VOID *) AltCfgId, 3, &AltIdStr);
5014 }
5015 if (Name != NULL) {
5016 GenerateSubStr (L"NAME=", StrLen (Name) * sizeof (CHAR16), (VOID *) Name, 2, &NameStr);
5017 } else {
5018 GenerateSubStr (L"NAME=", 0, NULL, 2, &NameStr);
5019 }
5020
5021 while (*StringPtr != 0) {
5022 //
5023 // Try to match the GUID
5024 //
5025 if (!GuidFlag) {
5026 TmpPtr = StrStr (StringPtr, GuidStr);
5027 if (TmpPtr == NULL) {
5028 Status = EFI_NOT_FOUND;
5029 goto Exit;
5030 }
5031 HdrStart = TmpPtr;
5032
5033 //
5034 // Jump to <NameHdr>
5035 //
5036 if (Guid != NULL) {
5037 StringPtr = TmpPtr + StrLen (GuidStr);
5038 } else {
5039 StringPtr = StrStr (TmpPtr, L"NAME=");
5040 if (StringPtr == NULL) {
5041 Status = EFI_NOT_FOUND;
5042 goto Exit;
5043 }
5044 }
5045 GuidFlag = TRUE;
5046 }
5047
5048 //
5049 // Try to match the NAME
5050 //
5051 if (GuidFlag && !NameFlag) {
5052 if (StrnCmp (StringPtr, NameStr, StrLen (NameStr)) != 0) {
5053 GuidFlag = FALSE;
5054 } else {
5055 //
5056 // Jump to <PathHdr>
5057 //
5058 if (Name != NULL) {
5059 StringPtr += StrLen (NameStr);
5060 } else {
5061 StringPtr = StrStr (StringPtr, L"PATH=");
5062 if (StringPtr == NULL) {
5063 Status = EFI_NOT_FOUND;
5064 goto Exit;
5065 }
5066 }
5067 NameFlag = TRUE;
5068 }
5069 }
5070
5071 //
5072 // Try to match the DevicePath
5073 //
5074 if (GuidFlag && NameFlag && !PathFlag) {
5075 if (StrnCmp (StringPtr, PathStr, StrLen (PathStr)) != 0) {
5076 GuidFlag = FALSE;
5077 NameFlag = FALSE;
5078 } else {
5079 //
5080 // Jump to '&' before <DescHdr> or <ConfigBody>
5081 //
5082 if (DevicePath != NULL) {
5083 StringPtr += StrLen (PathStr);
5084 } else {
5085 StringPtr = StrStr (StringPtr, L"&");
5086 if (StringPtr == NULL) {
5087 Status = EFI_NOT_FOUND;
5088 goto Exit;
5089 }
5090 StringPtr ++;
5091 }
5092 PathFlag = TRUE;
5093 HdrEnd = StringPtr;
5094 }
5095 }
5096
5097 //
5098 // Try to match the AltCfgId
5099 //
5100 if (GuidFlag && NameFlag && PathFlag) {
5101 if (AltCfgId == NULL) {
5102 //
5103 // Return Current Setting when AltCfgId is NULL.
5104 //
5105 Status = OutputConfigBody (StringPtr, &Result);
5106 goto Exit;
5107 }
5108 //
5109 // Search the <ConfigAltResp> to get the <AltResp> with AltCfgId.
5110 //
5111 if (StrnCmp (StringPtr, AltIdStr, StrLen (AltIdStr)) != 0) {
5112 GuidFlag = FALSE;
5113 NameFlag = FALSE;
5114 PathFlag = FALSE;
5115 } else {
5116 //
5117 // Skip AltIdStr and &
5118 //
5119 StringPtr = StringPtr + StrLen (AltIdStr);
5120 Status = OutputConfigBody (StringPtr, &Result);
5121 goto Exit;
5122 }
5123 }
5124 }
5125
5126 Status = EFI_NOT_FOUND;
5127
5128 Exit:
5129 *AltCfgResp = NULL;
5130 if (!EFI_ERROR (Status) && (Result != NULL)) {
5131 //
5132 // Copy the <ConfigHdr> and <ConfigBody>
5133 //
5134 Length = HdrEnd - HdrStart + StrLen (Result) + 1;
5135 *AltCfgResp = AllocateZeroPool (Length * sizeof (CHAR16));
5136 if (*AltCfgResp == NULL) {
5137 Status = EFI_OUT_OF_RESOURCES;
5138 } else {
5139 StrnCpyS (*AltCfgResp, Length, HdrStart, HdrEnd - HdrStart);
5140 StrCatS (*AltCfgResp, Length, Result);
5141 Status = EFI_SUCCESS;
5142 }
5143 }
5144
5145 if (GuidStr != NULL) {
5146 FreePool (GuidStr);
5147 }
5148 if (NameStr != NULL) {
5149 FreePool (NameStr);
5150 }
5151 if (PathStr != NULL) {
5152 FreePool (PathStr);
5153 }
5154 if (AltIdStr != NULL) {
5155 FreePool (AltIdStr);
5156 }
5157 if (Result != NULL) {
5158 FreePool (Result);
5159 }
5160
5161 return Status;
5162
5163 }
5164
5165
EFI Development Kit II mirror for PVE