]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/UefiHiiLib/HiiLib.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Fix spelling error in comment
[mirror_edk2.git] / MdeModulePkg / Library / UefiHiiLib / HiiLib.c
CommitLineData
08e4b3cf 1/** @file\r
2 HII Library implementation that uses DXE protocols and services.\r
3\r
cd5ebaa0
HT		 4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
08e4b3cf 6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "InternalHiiLib.h"\r
16\r
84f9a9ec
LG		 17#define GUID_CONFIG_STRING_TYPE 0x00\r
18#define NAME_CONFIG_STRING_TYPE 0x01\r
19#define PATH_CONFIG_STRING_TYPE 0x02\r
20\r
21#define ACTION_SET_DEFAUTL_VALUE 0x01\r
22#define ACTION_VALIDATE_SETTING 0x02\r
23\r
24#define HII_LIB_DEFAULT_VARSTORE_SIZE 0x200\r
25\r
26typedef struct {\r
27 LIST_ENTRY Entry; // Link to Block array\r
28 UINT16 Offset;\r
29 UINT16 Width;\r
30 UINT8 OpCode;\r
31 UINT8 Scope;\r
32} IFR_BLOCK_DATA;\r
33\r
7e3bcccb
LG		 34//\r
35// <ConfigHdr> Template\r
36//\r
37GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR16 mConfigHdrTemplate[] = L"GUID=00000000000000000000000000000000&NAME=0000&PATH=00";\r
08e4b3cf 38\r
cb7d01c0 39EFI_FORM_BROWSER2_PROTOCOL *mUefiFormBrowser2 = NULL;\r
40\r
7e3bcccb 41//\r
cb7d01c0 42// Template used to mark the end of a list of packages \r
7e3bcccb 43//\r
cb7d01c0 44GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_HII_PACKAGE_HEADER mEndOfPakageList = {\r
45 sizeof (EFI_HII_PACKAGE_HEADER),\r
46 EFI_HII_PACKAGE_END\r
47};\r
08e4b3cf 48\r
84f9a9ec
LG		 49/**\r
50 Extract Hii package list GUID for given HII handle.\r
51\r
52 If HiiHandle could not be found in the HII database, then ASSERT.\r
53 If Guid is NULL, then ASSERT.\r
54\r
55 @param Handle Hii handle\r
56 @param Guid Package list GUID\r
57\r
58 @retval EFI_SUCCESS Successfully extract GUID from Hii database.\r
59\r
60**/\r
61EFI_STATUS\r
62EFIAPI\r
63InternalHiiExtractGuidFromHiiHandle (\r
64 IN EFI_HII_HANDLE Handle,\r
65 OUT EFI_GUID *Guid\r
66 )\r
67{\r
68 EFI_STATUS Status;\r
69 UINTN BufferSize;\r
70 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
71\r
72 ASSERT (Guid != NULL);\r
73 ASSERT (Handle != NULL);\r
74\r
75 //\r
76 // Get HII PackageList\r
77 //\r
78 BufferSize = 0;\r
79 HiiPackageList = NULL;\r
80\r
81 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
82 ASSERT (Status != EFI_NOT_FOUND);\r
83 \r
84 if (Status == EFI_BUFFER_TOO_SMALL) {\r
85 HiiPackageList = AllocatePool (BufferSize);\r
86 ASSERT (HiiPackageList != NULL);\r
87\r
88 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);\r
89 }\r
90 if (EFI_ERROR (Status)) {\r
91 FreePool (HiiPackageList);\r
92 return Status;\r
93 }\r
94\r
95 //\r
96 // Extract GUID\r
97 //\r
98 CopyGuid (Guid, &HiiPackageList->PackageListGuid);\r
99\r
100 FreePool (HiiPackageList);\r
101\r
102 return EFI_SUCCESS;\r
103}\r
104\r
08e4b3cf 105/**\r
cb7d01c0 106 Registers a list of packages in the HII Database and returns the HII Handle\r
107 associated with that registration. If an HII Handle has already been registered\r
aa2614b7 108 with the same PackageListGuid and DeviceHandle, then NULL is returned. If there\r
109 are not enough resources to perform the registration, then NULL is returned.\r
110 If an empty list of packages is passed in, then NULL is returned. If the size of\r
111 the list of package is 0, then NULL is returned.\r
cb7d01c0 112\r
113 The variable arguments are pointers which point to package header that defined \r
114 by UEFI VFR compiler and StringGather tool.\r
08e4b3cf 115\r
116 #pragma pack (push, 1)\r
117 typedef struct {\r
118 UINT32 BinaryLength;\r
119 EFI_HII_PACKAGE_HEADER PackageHeader;\r
120 } EDKII_AUTOGEN_PACKAGES_HEADER;\r
121 #pragma pack (pop)\r
cb7d01c0 122 \r
123 @param[in] PackageListGuid The GUID of the package list.\r
124 @param[in] DeviceHandle If not NULL, the Device Handle on which \r
125 an instance of DEVICE_PATH_PROTOCOL is installed.\r
126 This Device Handle uniquely defines the device that \r
127 the added packages are associated with.\r
128 @param[in] ... The variable argument list that contains pointers \r
129 to packages terminated by a NULL.\r
130\r
131 @retval NULL A HII Handle has already been registered in the HII Database with\r
132 the same PackageListGuid.\r
133 @retval NULL The HII Handle could not be created.\r
134 @retval NULL An empty list of packages was passed in.\r
135 @retval NULL All packages are empty.\r
136 @retval Other The HII Handle associated with the newly registered package list.\r
08e4b3cf 137\r
138**/\r
cb7d01c0 139EFI_HII_HANDLE\r
140EFIAPI\r
141HiiAddPackages (\r
142 IN CONST EFI_GUID *PackageListGuid,\r
143 IN EFI_HANDLE DeviceHandle OPTIONAL,\r
144 ...\r
08e4b3cf 145 )\r
146{\r
cb7d01c0 147 EFI_STATUS Status;\r
cb7d01c0 148 VA_LIST Args;\r
149 UINT32 *Package;\r
150 EFI_HII_PACKAGE_LIST_HEADER *PackageListHeader;\r
151 EFI_HII_HANDLE HiiHandle;\r
152 UINT32 Length;\r
153 UINT8 *Data;\r
08e4b3cf 154\r
cb7d01c0 155 ASSERT (PackageListGuid != NULL);\r
08e4b3cf 156\r
08e4b3cf 157 //\r
cb7d01c0 158 // Calculate the length of all the packages in the variable argument list\r
08e4b3cf 159 //\r
cb7d01c0 160 for (Length = 0, VA_START (Args, DeviceHandle); (Package = VA_ARG (Args, UINT32 *)) != NULL; ) {\r
161 Length += (ReadUnaligned32 (Package) - sizeof (UINT32));\r
162 }\r
163 VA_END (Args);\r
08e4b3cf 164\r
08e4b3cf 165 //\r
cb7d01c0 166 // If there are no packages in the variable argument list or all the packages \r
167 // are empty, then return a NULL HII Handle\r
08e4b3cf 168 //\r
cb7d01c0 169 if (Length == 0) {\r
170 return NULL;\r
08e4b3cf 171 }\r
172\r
173 //\r
cb7d01c0 174 // Add the length of the Package List Header and the terminating Package Header \r
08e4b3cf 175 //\r
cb7d01c0 176 Length += sizeof (EFI_HII_PACKAGE_LIST_HEADER) + sizeof (EFI_HII_PACKAGE_HEADER);\r
08e4b3cf 177\r
cb7d01c0 178 //\r
179 // Allocate the storage for the entire Package List\r
180 //\r
181 PackageListHeader = AllocateZeroPool (Length);\r
08e4b3cf 182\r
cb7d01c0 183 //\r
aa2614b7 184 // If the Package List can not be allocated, then return a NULL HII Handle\r
cb7d01c0 185 //\r
186 if (PackageListHeader == NULL) {\r
187 return NULL;\r
188 }\r
08e4b3cf 189\r
cb7d01c0 190 //\r
191 // Fill in the GUID and Length of the Package List Header\r
192 //\r
193 CopyGuid (&PackageListHeader->PackageListGuid, PackageListGuid);\r
194 PackageListHeader->PackageLength = Length;\r
08e4b3cf 195\r
cb7d01c0 196 //\r
197 // Initialize a pointer to the beginning if the Package List data\r
198 //\r
199 Data = (UINT8 *)(PackageListHeader + 1);\r
08e4b3cf 200\r
cb7d01c0 201 //\r
202 // Copy the data from each package in the variable argument list\r
203 //\r
204 for (VA_START (Args, DeviceHandle); (Package = VA_ARG (Args, UINT32 *)) != NULL; ) {\r
205 Length = ReadUnaligned32 (Package) - sizeof (UINT32);\r
206 CopyMem (Data, Package + 1, Length);\r
207 Data += Length;\r
208 }\r
209 VA_END (Args);\r
08e4b3cf 210\r
cb7d01c0 211 //\r
212 // Append a package of type EFI_HII_PACKAGE_END to mark the end of the package list\r
213 //\r
214 CopyMem (Data, &mEndOfPakageList, sizeof (mEndOfPakageList));\r
08e4b3cf 215\r
cb7d01c0 216 //\r
217 // Register the package list with the HII Database\r
218 //\r
219 Status = gHiiDatabase->NewPackageList (\r
220 gHiiDatabase, \r
221 PackageListHeader, \r
222 DeviceHandle, \r
223 &HiiHandle\r
224 );\r
225 if (EFI_ERROR (Status)) {\r
226 HiiHandle = NULL;\r
08e4b3cf 227 }\r
228\r
cb7d01c0 229 //\r
230 // Free the allocated package list\r
231 //\r
08e4b3cf 232 FreePool (PackageListHeader);\r
cb7d01c0 233\r
234 //\r
235 // Return the new HII Handle\r
236 //\r
237 return HiiHandle;\r
08e4b3cf 238}\r
239\r
240/**\r
cb7d01c0 241 Removes a package list from the HII database.\r
08e4b3cf 242\r
243 If HiiHandle is NULL, then ASSERT.\r
cb7d01c0 244 If HiiHandle is not a valid EFI_HII_HANDLE in the HII database, then ASSERT.\r
08e4b3cf 245\r
cb7d01c0 246 @param[in] HiiHandle The handle that was previously registered in the HII database\r
08e4b3cf 247\r
248**/\r
249VOID\r
250EFIAPI\r
cb7d01c0 251HiiRemovePackages (\r
08e4b3cf 252 IN EFI_HII_HANDLE HiiHandle\r
253 )\r
254{\r
255 EFI_STATUS Status;\r
08e4b3cf 256\r
cb7d01c0 257 ASSERT (HiiHandle != NULL);\r
7e3bcccb 258 Status = gHiiDatabase->RemovePackageList (gHiiDatabase, HiiHandle);\r
08e4b3cf 259 ASSERT_EFI_ERROR (Status);\r
260}\r
261\r
262\r
263/**\r
7992c0b0 264 Retrieves the array of all the HII Handles or the HII handles of a specific\r
265 package list GUID in the HII Database.\r
cb7d01c0 266 This array is terminated with a NULL HII Handle.\r
267 This function allocates the returned array using AllocatePool().\r
268 The caller is responsible for freeing the array with FreePool().\r
269\r
270 @param[in] PackageListGuid An optional parameter that is used to request \r
7992c0b0 271 HII Handles associated with a specific\r
272 Package List GUID. If this parameter is NULL,\r
cb7d01c0 273 then all the HII Handles in the HII Database\r
7992c0b0 274 are returned. If this parameter is not NULL,\r
275 then zero or more HII Handles associated with \r
276 PackageListGuid are returned.\r
cb7d01c0 277\r
278 @retval NULL No HII handles were found in the HII database\r
279 @retval NULL The array of HII Handles could not be retrieved\r
280 @retval Other A pointer to the NULL terminated array of HII Handles\r
08e4b3cf 281\r
282**/\r
cb7d01c0 283EFI_HII_HANDLE *\r
08e4b3cf 284EFIAPI\r
cb7d01c0 285HiiGetHiiHandles (\r
286 IN CONST EFI_GUID *PackageListGuid OPTIONAL\r
08e4b3cf 287 )\r
288{\r
cb7d01c0 289 EFI_STATUS Status;\r
290 UINTN HandleBufferLength;\r
291 EFI_HII_HANDLE TempHiiHandleBuffer;\r
292 EFI_HII_HANDLE *HiiHandleBuffer;\r
293 EFI_GUID Guid;\r
7992c0b0 294 UINTN Index1;\r
295 UINTN Index2;\r
cb7d01c0 296\r
297 //\r
298 // Retrieve the size required for the buffer of all HII handles.\r
299 //\r
300 HandleBufferLength = 0;\r
301 Status = gHiiDatabase->ListPackageLists (\r
302 gHiiDatabase,\r
303 EFI_HII_PACKAGE_TYPE_ALL,\r
304 NULL,\r
305 &HandleBufferLength,\r
306 &TempHiiHandleBuffer\r
307 );\r
08e4b3cf 308\r
cb7d01c0 309 //\r
310 // If ListPackageLists() returns EFI_SUCCESS for a zero size, \r
311 // then there are no HII handles in the HII database. If ListPackageLists() \r
312 // returns an error other than EFI_BUFFER_TOO_SMALL, then there are no HII \r
313 // handles in the HII database.\r
314 //\r
315 if (Status != EFI_BUFFER_TOO_SMALL) {\r
316 //\r
317 // Return NULL if the size can not be retrieved, or if there are no HII \r
318 // handles in the HII Database\r
319 //\r
320 return NULL;\r
321 }\r
08e4b3cf 322\r
cb7d01c0 323 //\r
324 // Allocate the array of HII handles to hold all the HII Handles and a NULL terminator\r
325 //\r
326 HiiHandleBuffer = AllocateZeroPool (HandleBufferLength + sizeof (EFI_HII_HANDLE));\r
327 if (HiiHandleBuffer == NULL) {\r
328 //\r
329 // Return NULL if allocation fails.\r
330 //\r
331 return NULL;\r
332 }\r
08e4b3cf 333\r
334 //\r
cb7d01c0 335 // Retrieve the array of HII Handles in the HII Database\r
08e4b3cf 336 //\r
7e3bcccb 337 Status = gHiiDatabase->ListPackageLists (\r
cb7d01c0 338 gHiiDatabase,\r
339 EFI_HII_PACKAGE_TYPE_ALL,\r
340 NULL,\r
341 &HandleBufferLength,\r
342 HiiHandleBuffer\r
343 );\r
344 if (EFI_ERROR (Status)) {\r
345 //\r
346 // Free the buffer and return NULL if the HII handles can not be retrieved.\r
347 //\r
348 FreePool (HiiHandleBuffer);\r
349 return NULL;\r
fa7b3168 350 }\r
08e4b3cf 351\r
cb7d01c0 352 if (PackageListGuid == NULL) {\r
353 //\r
354 // Return the NULL terminated array of HII handles in the HII Database\r
355 //\r
356 return HiiHandleBuffer;\r
357 } else {\r
7992c0b0 358 for (Index1 = 0, Index2 = 0; HiiHandleBuffer[Index1] != NULL; Index1++) {\r
359 Status = InternalHiiExtractGuidFromHiiHandle (HiiHandleBuffer[Index1], &Guid);\r
cb7d01c0 360 ASSERT_EFI_ERROR (Status);\r
361 if (CompareGuid (&Guid, PackageListGuid)) {\r
7992c0b0 362 HiiHandleBuffer[Index2++] = HiiHandleBuffer[Index1]; \r
cb7d01c0 363 }\r
364 }\r
7992c0b0 365 if (Index2 > 0) {\r
366 HiiHandleBuffer[Index2] = NULL;\r
367 return HiiHandleBuffer;\r
368 } else {\r
369 FreePool (HiiHandleBuffer);\r
370 return NULL;\r
371 }\r
cb7d01c0 372 }\r
08e4b3cf 373}\r
374\r
7e3bcccb
LG		 375/**\r
376 Converts all hex dtring characters in range ['A'..'F'] to ['a'..'f'] for \r
377 hex digits that appear between a '=' and a '&' in a config string.\r
378\r
84213069 379 If ConfigString is NULL, then ASSERT().\r
7e3bcccb 380\r
84213069 381 @param[in] ConfigString Pointer to a Null-terminated Unicode string.\r
7e3bcccb
LG		 382\r
383 @return Pointer to the Null-terminated Unicode result string.\r
384\r
385**/\r
386EFI_STRING\r
387EFIAPI\r
388InternalHiiLowerConfigString (\r
389 IN EFI_STRING ConfigString\r
390 )\r
391{\r
392 EFI_STRING String;\r
393 BOOLEAN Lower;\r
394\r
395 ASSERT (ConfigString != NULL);\r
396\r
397 //\r
398 // Convert all hex digits in range [A-F] in the configuration header to [a-f]\r
399 //\r
400 for (String = ConfigString, Lower = FALSE; *String != L'\0'; String++) {\r
401 if (*String == L'=') {\r
402 Lower = TRUE;\r
403 } else if (*String == L'&') {\r
404 Lower = FALSE;\r
3e3f86e0 405 } else if (Lower && *String >= L'A' && *String <= L'F') {\r
5c1ebff6 406 *String = (CHAR16) (*String - L'A' + L'a');\r
7e3bcccb
LG		 407 }\r
408 }\r
409\r
410 return ConfigString;\r
411}\r
412\r
413/**\r
414 Uses the BlockToConfig() service of the Config Routing Protocol to \r
415 convert <ConfigRequest> and a buffer to a <ConfigResp>\r
416\r
417 If ConfigRequest is NULL, then ASSERT().\r
418 If Block is NULL, then ASSERT().\r
419\r
420 @param[in] ConfigRequest Pointer to a Null-terminated Unicode string.\r
421 @param[in] Block Pointer to a block of data.\r
422 @param[in] BlockSize The zie, in bytes, of Block.\r
423\r
424 @retval NULL The <ConfigResp> string could not be generated.\r
425 @retval Other Pointer to the Null-terminated Unicode <ConfigResp> string.\r
426\r
427**/\r
428EFI_STRING\r
429EFIAPI\r
430InternalHiiBlockToConfig (\r
431 IN CONST EFI_STRING ConfigRequest,\r
432 IN CONST UINT8 *Block,\r
433 IN UINTN BlockSize\r
434 )\r
435{\r
436 EFI_STATUS Status;\r
437 EFI_STRING ConfigResp;\r
438 CHAR16 *Progress;\r
439\r
440 ASSERT (ConfigRequest != NULL);\r
441 ASSERT (Block != NULL);\r
442\r
443 //\r
444 // Convert <ConfigRequest> to <ConfigResp>\r
445 //\r
446 Status = gHiiConfigRouting->BlockToConfig (\r
447 gHiiConfigRouting,\r
448 ConfigRequest,\r
449 Block,\r
450 BlockSize,\r
451 &ConfigResp,\r
452 &Progress\r
453 );\r
454 if (EFI_ERROR (Status)) {\r
455 return NULL;\r
456 }\r
457 return ConfigResp;\r
458}\r
459\r
7e3bcccb
LG		 460/**\r
461 Uses the BrowserCallback() service of the Form Browser Protocol to retrieve \r
462 or set uncommitted data. If sata i being retrieved, then the buffer is \r
463 allocated using AllocatePool(). The caller is then responsible for freeing \r
464 the buffer using FreePool().\r
465\r
7e3bcccb
LG		 466 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional \r
467 parameter that may be NULL.\r
84213069
LG		 468 @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
469 is an optional parameter that may be NULL.\r
7e3bcccb
LG		 470 @param[in] SetResultsData If not NULL, then this parameter specified the buffer\r
471 of uncommited data to set. If this parameter is NULL,\r
472 then the caller is requesting to get the uncommited data\r
473 from the Form Browser.\r
474\r
475 @retval NULL The uncommitted data could not be retrieved.\r
476 @retval Other A pointer to a buffer containing the uncommitted data.\r
477\r
478**/\r
479EFI_STRING\r
480EFIAPI\r
481InternalHiiBrowserCallback (\r
482 IN CONST EFI_GUID *VariableGuid, OPTIONAL\r
483 IN CONST CHAR16 *VariableName, OPTIONAL\r
484 IN CONST EFI_STRING SetResultsData OPTIONAL\r
485 )\r
486{\r
487 EFI_STATUS Status;\r
488 UINTN ResultsDataSize;\r
489 EFI_STRING ResultsData;\r
490 CHAR16 TempResultsData;\r
491\r
492 //\r
493 // Locate protocols\r
494 //\r
3c7449e4
LG		 495 if (mUefiFormBrowser2 == NULL) {\r
496 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &mUefiFormBrowser2);\r
497 if (EFI_ERROR (Status) || mUefiFormBrowser2 == NULL) {\r
7e3bcccb
LG		 498 return NULL;\r
499 }\r
500 }\r
501\r
502 ResultsDataSize = 0;\r
503\r
504 if (SetResultsData != NULL) {\r
505 //\r
506 // Request to to set data in the uncommitted browser state information\r
507 //\r
508 ResultsData = SetResultsData;\r
509 } else {\r
510 //\r
511 // Retrieve the length of the buffer required ResultsData from the Browser Callback\r
512 //\r
3c7449e4
LG		 513 Status = mUefiFormBrowser2->BrowserCallback (\r
514 mUefiFormBrowser2,\r
7e3bcccb
LG		 515 &ResultsDataSize,\r
516 &TempResultsData,\r
517 TRUE,\r
518 VariableGuid,\r
519 VariableName\r
520 );\r
6412128a
LG		 521 \r
522 if (!EFI_ERROR (Status)) {\r
523 //\r
524 // No Resluts Data, only allocate one char for '\0'\r
525 //\r
526 ResultsData = AllocateZeroPool (sizeof (CHAR16));\r
527 return ResultsData;\r
528 }\r
529\r
7e3bcccb
LG		 530 if (Status != EFI_BUFFER_TOO_SMALL) {\r
531 return NULL;\r
532 }\r
533\r
534 //\r
535 // Allocate the ResultsData buffer\r
536 //\r
537 ResultsData = AllocateZeroPool (ResultsDataSize);\r
538 if (ResultsData == NULL) {\r
539 return NULL;\r
540 }\r
541 }\r
542\r
543 //\r
544 // Retrieve or set the ResultsData from the Browser Callback\r
545 //\r
3c7449e4
LG		 546 Status = mUefiFormBrowser2->BrowserCallback (\r
547 mUefiFormBrowser2,\r
7e3bcccb
LG		 548 &ResultsDataSize,\r
549 ResultsData,\r
550 (BOOLEAN)(SetResultsData == NULL),\r
551 VariableGuid,\r
552 VariableName\r
553 );\r
554 if (EFI_ERROR (Status)) {\r
555 return NULL;\r
556 }\r
557\r
558 return ResultsData;\r
559}\r
560\r
561/**\r
562 Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing \r
563 information that includes a GUID, an optional Unicode string name, and a device\r
564 path. The string returned is allocated with AllocatePool(). The caller is \r
565 responsible for freeing the allocated string with FreePool().\r
566 \r
567 The format of a <ConfigHdr> is as follows:\r
568\r
569 GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>\r
570\r
571 @param[in] Guid Pointer to an EFI_GUID that is the routing information\r
572 GUID. Each of the 16 bytes in Guid is converted to \r
573 a 2 Unicode character hexidecimal string. This is \r
574 an optional parameter that may be NULL.\r
575 @param[in] Name Pointer to a Null-terminated Unicode string that is \r
576 the routing information NAME. This is an optional \r
577 parameter that may be NULL. Each 16-bit Unicode \r
578 character in Name is converted to a 4 character Unicode \r
579 hexidecimal string. \r
580 @param[in] DriverHandle The driver handle which supports a Device Path Protocol\r
581 that is the routing information PATH. Each byte of\r
582 the Device Path associated with DriverHandle is converted\r
583 to a 2 Unicode character hexidecimal string.\r
584\r
7e3bcccb
LG		 585 @retval NULL DriverHandle does not support the Device Path Protocol.\r
586 @retval Other A pointer to the Null-terminate Unicode <ConfigHdr> string\r
587\r
588**/\r
589EFI_STRING\r
590EFIAPI\r
591HiiConstructConfigHdr (\r
592 IN CONST EFI_GUID *Guid, OPTIONAL\r
593 IN CONST CHAR16 *Name, OPTIONAL\r
594 IN EFI_HANDLE DriverHandle\r
595 )\r
596{\r
597 UINTN NameLength;\r
598 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
599 UINTN DevicePathSize;\r
600 CHAR16 *String;\r
601 CHAR16 *ReturnString;\r
602 UINTN Index;\r
603 UINT8 *Buffer;\r
604\r
605 //\r
606 // Compute the length of Name in Unicode characters. \r
607 // If Name is NULL, then the length is 0.\r
608 //\r
609 NameLength = 0;\r
610 if (Name != NULL) {\r
611 NameLength = StrLen (Name);\r
612 }\r
613\r
3e3f86e0
LG		 614 DevicePath = NULL;\r
615 DevicePathSize = 0;\r
7e3bcccb
LG		 616 //\r
617 // Retrieve DevicePath Protocol associated with DriverHandle\r
618 //\r
3e3f86e0
LG		 619 if (DriverHandle != NULL) {\r
620 DevicePath = DevicePathFromHandle (DriverHandle);\r
621 if (DevicePath == NULL) {\r
622 return NULL;\r
623 }\r
624 //\r
625 // Compute the size of the device path in bytes\r
626 //\r
627 DevicePathSize = GetDevicePathSize (DevicePath);\r
7e3bcccb
LG		 628 }\r
629\r
7e3bcccb
LG		 630 //\r
631 // GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize <Null>\r
632 // | 5 | sizeof (EFI_GUID) * 2 | 6 | NameStrLen*4 | 6 | DevicePathSize * 2 | 1 |\r
633 //\r
634 String = AllocateZeroPool ((5 + sizeof (EFI_GUID) * 2 + 6 + NameLength * 4 + 6 + DevicePathSize * 2 + 1) * sizeof (CHAR16));\r
635 if (String == NULL) {\r
636 return NULL;\r
637 }\r
638\r
639 //\r
640 // Start with L"GUID="\r
641 //\r
642 ReturnString = StrCpy (String, L"GUID=");\r
643 String += StrLen (String);\r
644\r
645 if (Guid != NULL) {\r
646 //\r
647 // Append Guid converted to <HexCh>32\r
648 //\r
649 for (Index = 0, Buffer = (UINT8 *)Guid; Index < sizeof (EFI_GUID); Index++) {\r
650 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
651 }\r
652 }\r
653 \r
654 //\r
655 // Append L"&NAME="\r
656 //\r
657 StrCpy (String, L"&NAME=");\r
658 String += StrLen (String);\r
659\r
660 if (Name != NULL) {\r
661 //\r
662 // Append Name converted to <Char>NameLength\r
663 //\r
664 for (; *Name != L'\0'; Name++) {\r
665 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *Name, 4);\r
666 }\r
667 }\r
668\r
669 //\r
670 // Append L"&PATH="\r
671 //\r
672 StrCpy (String, L"&PATH=");\r
673 String += StrLen (String);\r
674\r
675 //\r
676 // Append the device path associated with DriverHandle converted to <HexChar>DevicePathSize\r
677 //\r
678 for (Index = 0, Buffer = (UINT8 *)DevicePath; Index < DevicePathSize; Index++) {\r
679 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(Buffer++), 2);\r
680 }\r
681\r
682 //\r
683 // Null terminate the Unicode string\r
684 //\r
685 *String = L'\0';\r
686\r
687 //\r
688 // Convert all hex digits in range [A-F] in the configuration header to [a-f]\r
689 //\r
690 return InternalHiiLowerConfigString (ReturnString);\r
691}\r
692\r
84f9a9ec
LG		 693/**\r
694 Convert the hex UNICODE encoding string of UEFI GUID, NAME or device path \r
695 to binary buffer from <ConfigHdr>.\r
696\r
697 This is a internal function.\r
698\r
699 @param String UEFI configuration string.\r
700 @param Flag Flag specifies what type buffer will be retrieved.\r
701 @param Buffer Binary of Guid, Name or Device path.\r
702\r
703 @retval EFI_INVALID_PARAMETER Any incoming parameter is invalid.\r
704 @retval EFI_OUT_OF_RESOURCES Lake of resources to store neccesary structures.\r
705 @retval EFI_SUCCESS The buffer data is retrieved and translated to\r
706 binary format.\r
707\r
708**/\r
709EFI_STATUS\r
710InternalHiiGetBufferFromString (\r
711 IN EFI_STRING String,\r
712 IN UINT8 Flag,\r
713 OUT UINT8 **Buffer\r
714 )\r
715{\r
716 UINTN Length;\r
717 EFI_STRING ConfigHdr;\r
718 CHAR16 *StringPtr;\r
719 UINT8 *DataBuffer;\r
720 CHAR16 TemStr[5];\r
721 UINTN Index;\r
722 UINT8 DigitUint8;\r
723\r
724 if (String == NULL || Buffer == NULL) {\r
725 return EFI_INVALID_PARAMETER;\r
726 }\r
727 \r
728 DataBuffer = NULL;\r
729 StringPtr = NULL;\r
730 ConfigHdr = String;\r
731 //\r
732 // The content between 'GUID', 'NAME', 'PATH' of <ConfigHdr> and '&' of next element\r
733 // or '\0' (end of configuration string) is the UNICODE %02x bytes encoding string.\r
734 //\r
735 for (Length = 0; *String != 0 && *String != L'&'; String++, Length++);\r
736\r
737 switch (Flag) {\r
738 case GUID_CONFIG_STRING_TYPE:\r
739 case PATH_CONFIG_STRING_TYPE:\r
740 //\r
741 // The data in <ConfigHdr> is encoded as hex UNICODE %02x bytes in the same order\r
742 // as the device path and Guid resides in RAM memory.\r
743 // Translate the data into binary.\r
744 //\r
745 DataBuffer = (UINT8 *) AllocateZeroPool ((Length + 1) / 2);\r
746 if (DataBuffer == NULL) {\r
747 return EFI_OUT_OF_RESOURCES;\r
748 }\r
749 //\r
750 // Convert binary byte one by one\r
751 //\r
752 ZeroMem (TemStr, sizeof (TemStr));\r
753 for (Index = 0; Index < Length; Index ++) {\r
754 TemStr[0] = ConfigHdr[Index];\r
755 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
756 if ((Index & 1) == 0) {\r
757 DataBuffer [Index/2] = DigitUint8;\r
758 } else {\r
759 DataBuffer [Index/2] = (UINT8) ((DataBuffer [Index/2] << 4) + DigitUint8);\r
760 }\r
761 }\r
762 \r
763 *Buffer = DataBuffer;\r
764 break;\r
765\r
766 case NAME_CONFIG_STRING_TYPE:\r
767 //\r
768 // Convert Config String to Unicode String, e.g. "0041004200430044" => "ABCD"\r
769 // \r
770\r
771 //\r
772 // Add the tailling char L'\0'\r
773 //\r
774 DataBuffer = (UINT8 *) AllocateZeroPool ((Length/4 + 1) * sizeof (CHAR16));\r
775 if (DataBuffer == NULL) {\r
776 return EFI_OUT_OF_RESOURCES;\r
777 }\r
778 //\r
779 // Convert character one by one\r
780 //\r
781 StringPtr = (CHAR16 *) DataBuffer;\r
782 ZeroMem (TemStr, sizeof (TemStr));\r
783 for (Index = 0; Index < Length; Index += 4) {\r
784 StrnCpy (TemStr, ConfigHdr + Index, 4);\r
785 StringPtr[Index/4] = (CHAR16) StrHexToUint64 (TemStr);\r
786 }\r
787 //\r
788 // Add tailing L'\0' character\r
789 //\r
790 StringPtr[Index/4] = L'\0';\r
791\r
792 *Buffer = DataBuffer;\r
793 break;\r
794\r
795 default:\r
796 return EFI_INVALID_PARAMETER;\r
797 break;\r
798 }\r
799\r
800 return EFI_SUCCESS;\r
801}\r
802\r
803/**\r
804 This function checks VarOffset and VarWidth is in the block range.\r
805\r
806 @param BlockArray The block array is to be checked. \r
807 @param VarOffset Offset of var to the structure\r
808 @param VarWidth Width of var.\r
809 \r
810 @retval TRUE This Var is in the block range.\r
811 @retval FALSE This Var is not in the block range.\r
812**/\r
813BOOLEAN\r
814BlockArrayCheck (\r
815 IN IFR_BLOCK_DATA *BlockArray,\r
816 IN UINT16 VarOffset,\r
817 IN UINT16 VarWidth\r
818 )\r
819{\r
820 LIST_ENTRY *Link;\r
821 IFR_BLOCK_DATA *BlockData;\r
822 \r
823 //\r
824 // No Request Block array, all vars are got.\r
825 //\r
826 if (BlockArray == NULL) {\r
827 return TRUE;\r
828 }\r
829 \r
830 //\r
831 // Check the input var is in the request block range.\r
832 //\r
833 for (Link = BlockArray->Entry.ForwardLink; Link != &BlockArray->Entry; Link = Link->ForwardLink) {\r
834 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);\r
835 if ((VarOffset >= BlockData->Offset) && ((VarOffset + VarWidth) <= (BlockData->Offset + BlockData->Width))) {\r
836 return TRUE;\r
837 }\r
838 }\r
839\r
840 return FALSE;\r
841}\r
842\r
843/**\r
844 Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET\r
845 or WIDTH or VALUE.\r
846 <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>\r
847\r
848 @param ValueString String in <BlockConfig> format and points to the\r
849 first character of <Number>.\r
850 @param ValueData The output value. Caller takes the responsibility\r
851 to free memory.\r
852 @param ValueLength Length of the <Number>, in characters.\r
853\r
854 @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary\r
855 structures.\r
856 @retval EFI_SUCCESS Value of <Number> is outputted in Number\r
857 successfully.\r
858\r
859**/\r
860EFI_STATUS\r
861EFIAPI\r
862InternalHiiGetValueOfNumber (\r
863 IN EFI_STRING ValueString,\r
864 OUT UINT8 **ValueData,\r
865 OUT UINTN *ValueLength\r
866 )\r
867{\r
868 EFI_STRING StringPtr;\r
869 UINTN Length;\r
870 UINT8 *Buf;\r
871 UINT8 DigitUint8;\r
872 UINTN Index;\r
873 CHAR16 TemStr[2];\r
874\r
875 ASSERT (ValueString != NULL && ValueData != NULL && ValueLength != NULL);\r
876 ASSERT (*ValueString != L'\0');\r
877\r
878 //\r
879 // Get the length of value string\r
880 //\r
881 StringPtr = ValueString;\r
882 while (*StringPtr != L'\0' && *StringPtr != L'&') {\r
883 StringPtr++;\r
884 }\r
885 Length = StringPtr - ValueString;\r
886 \r
887 //\r
888 // Allocate buffer to store the value\r
889 //\r
890 Buf = (UINT8 *) AllocateZeroPool ((Length + 1) / 2);\r
891 if (Buf == NULL) {\r
892 return EFI_OUT_OF_RESOURCES;\r
893 }\r
894 \r
895 //\r
896 // Convert character one by one to the value buffer\r
897 //\r
898 ZeroMem (TemStr, sizeof (TemStr));\r
899 for (Index = 0; Index < Length; Index ++) {\r
900 TemStr[0] = ValueString[Length - Index - 1];\r
901 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
902 if ((Index & 1) == 0) {\r
903 Buf [Index/2] = DigitUint8;\r
904 } else {\r
905 Buf [Index/2] = (UINT8) ((DigitUint8 << 4) + Buf [Index/2]);\r
906 }\r
907 }\r
908 \r
909 //\r
910 // Set the converted value and string length.\r
911 //\r
912 *ValueData = Buf;\r
913 *ValueLength = Length;\r
914 return EFI_SUCCESS;\r
915}\r
916\r
917/**\r
8567300a
LG		 918 This internal function parses IFR data to validate current setting.\r
919\r
920 @param ConfigResp ConfigResp string contains the current setting.\r
921 @param HiiPackageList Point to Hii package list.\r
922 @param PackageListLength The length of the pacakge.\r
923 @param VarGuid Guid of the buffer storage.\r
924 @param VarName Name of the buffer storage.\r
84f9a9ec 925 \r
8567300a
LG		 926 @retval EFI_SUCCESS The current setting is valid.\r
927 @retval EFI_OUT_OF_RESOURCES The memory is not enough.\r
928 @retval EFI_INVALID_PARAMETER The config string or the Hii package is invalid.\r
84f9a9ec
LG		 929**/\r
930EFI_STATUS\r
931EFIAPI\r
932InternalHiiValidateCurrentSetting (\r
933 IN EFI_STRING ConfigResp,\r
934 IN EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,\r
935 IN UINTN PackageListLength,\r
936 IN EFI_GUID *VarGuid,\r
937 IN CHAR16 *VarName\r
938 )\r
939{ \r
940 IFR_BLOCK_DATA *CurrentBlockArray;\r
941 IFR_BLOCK_DATA *BlockData;\r
942 IFR_BLOCK_DATA *NewBlockData;\r
943 IFR_BLOCK_DATA VarBlockData;\r
944 EFI_STRING StringPtr;\r
945 UINTN Length;\r
946 UINT8 *TmpBuffer;\r
947 UINT16 Offset;\r
948 UINT16 Width;\r
949 UINT64 VarValue;\r
950 LIST_ENTRY *Link;\r
951 UINT8 *VarBuffer;\r
952 UINTN MaxBufferSize;\r
953 EFI_STATUS Status;\r
954 EFI_HII_PACKAGE_HEADER PacakgeHeader;\r
955 UINT32 PackageOffset;\r
956 UINT8 *PackageData;\r
957 UINTN IfrOffset;\r
958 EFI_IFR_OP_HEADER *IfrOpHdr;\r
959 EFI_IFR_VARSTORE *IfrVarStore;\r
960 EFI_IFR_ONE_OF *IfrOneOf;\r
961 EFI_IFR_NUMERIC *IfrNumeric;\r
962 EFI_IFR_ONE_OF_OPTION *IfrOneOfOption;\r
963 EFI_IFR_CHECKBOX *IfrCheckBox;\r
964 EFI_IFR_STRING *IfrString;\r
965 CHAR8 *VarStoreName;\r
966 UINTN Index;\r
967 \r
968 //\r
969 // 1. Get the current setting to current block data array and Convert them into VarBuffer\r
970 //\r
971\r
972 //\r
973 // Skip ConfigHdr string\r
974 //\r
975 StringPtr = ConfigResp;\r
976 StringPtr = StrStr (ConfigResp, L"&OFFSET");\r
977 if (StringPtr == NULL) {\r
978 //\r
84213069 979 // No ConfigBlock value is required to be validated.\r
84f9a9ec
LG		 980 // EFI_SUCCESS directly return.\r
981 //\r
982 return EFI_SUCCESS;\r
983 }\r
984 \r
985 //\r
986 // Initialize the local variables.\r
987 //\r
988 Index = 0;\r
989 VarStoreName = NULL;\r
990 Status = EFI_SUCCESS;\r
991 BlockData = NULL;\r
992 NewBlockData = NULL;\r
993 TmpBuffer = NULL;\r
994 MaxBufferSize = HII_LIB_DEFAULT_VARSTORE_SIZE;\r
995 VarBuffer = AllocateZeroPool (MaxBufferSize);\r
996 if (VarBuffer == NULL) {\r
997 return EFI_OUT_OF_RESOURCES;\r
998 }\r
999\r
1000 //\r
1001 // Init CurrentBlockArray\r
1002 //\r
1003 CurrentBlockArray = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));\r
1004 if (CurrentBlockArray == NULL) {\r
1005 Status = EFI_OUT_OF_RESOURCES;\r
1006 goto Done;\r
1007 }\r
1008 InitializeListHead (&CurrentBlockArray->Entry);\r
1009 \r
1010 //\r
1011 // Parse each <RequestElement> if exists\r
1012 // Only <BlockName> format is supported by this help function.\r
1013 // <BlockName> ::= &'OFFSET='<Number>&'WIDTH='<Number>\r
1014 //\r
1015 while (*StringPtr != 0 && StrnCmp (StringPtr, L"&OFFSET=", StrLen (L"&OFFSET=")) == 0) {\r
1016 //\r
1017 // Skip the &OFFSET= string\r
1018 // \r
1019 StringPtr += StrLen (L"&OFFSET=");\r
1020\r
1021 //\r
1022 // Get Offset\r
1023 //\r
1024 Status = InternalHiiGetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
1025 if (EFI_ERROR (Status)) {\r
1026 goto Done;\r
1027 }\r
1028 Offset = 0;\r
1029 CopyMem (\r
1030 &Offset,\r
1031 TmpBuffer,\r
1032 (((Length + 1) / 2) < sizeof (UINT16)) ? ((Length + 1) / 2) : sizeof (UINT16)\r
1033 );\r
1034 FreePool (TmpBuffer);\r
1035 TmpBuffer = NULL;\r
1036\r
1037 StringPtr += Length;\r
1038 if (StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {\r
1039 Status = EFI_INVALID_PARAMETER;\r
1040 goto Done;\r
1041 }\r
1042 StringPtr += StrLen (L"&WIDTH=");\r
1043\r
1044 //\r
1045 // Get Width\r
1046 //\r
1047 Status = InternalHiiGetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
1048 if (EFI_ERROR (Status)) {\r
1049 goto Done;\r
1050 }\r
1051 Width = 0;\r
1052 CopyMem (\r
1053 &Width,\r
1054 TmpBuffer,\r
1055 (((Length + 1) / 2) < sizeof (UINT16)) ? ((Length + 1) / 2) : sizeof (UINT16)\r
1056 );\r
1057 FreePool (TmpBuffer);\r
1058 TmpBuffer = NULL;\r
1059\r
1060 StringPtr += Length;\r
1061 if (*StringPtr != 0 && *StringPtr != L'&') {\r
1062 Status = EFI_INVALID_PARAMETER;\r
1063 goto Done;\r
1064 }\r
1065\r
1066 if (StrnCmp (StringPtr, L"&VALUE=", StrLen (L"&VALUE=")) != 0) {\r
1067 Status = EFI_INVALID_PARAMETER;\r
1068 goto Done;\r
1069 }\r
1070 StringPtr += StrLen (L"&VALUE=");\r
1071\r
1072 //\r
1073 // Get Value\r
1074 //\r
1075 Status = InternalHiiGetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
1076 if (EFI_ERROR (Status)) {\r
1077 goto Done;\r
1078 }\r
1079\r
1080 StringPtr += Length;\r
1081 if (*StringPtr != 0 && *StringPtr != L'&') {\r
1082 Status = EFI_INVALID_PARAMETER;\r
1083 goto Done;\r
1084 }\r
1085\r
1086 //\r
1087 // Check whether VarBuffer is enough\r
1088 //\r
1089 if ((UINTN) (Offset + Width) > MaxBufferSize) {\r
1090 VarBuffer = ReallocatePool (\r
1091 MaxBufferSize,\r
1092 Offset + Width + HII_LIB_DEFAULT_VARSTORE_SIZE,\r
1093 VarBuffer\r
1094 );\r
1095 if (VarBuffer == NULL) {\r
1096 Status = EFI_OUT_OF_RESOURCES;\r
1097 goto Done;\r
1098 }\r
1099 MaxBufferSize = Offset + Width + HII_LIB_DEFAULT_VARSTORE_SIZE;\r
1100 }\r
1101\r
1102 //\r
1103 // Update the Block with configuration info\r
1104 //\r
1105 CopyMem (VarBuffer + Offset, TmpBuffer, Width);\r
1106 FreePool (TmpBuffer);\r
1107 TmpBuffer = NULL;\r
1108\r
1109 //\r
1110 // Set new Block Data\r
1111 //\r
1112 NewBlockData = (IFR_BLOCK_DATA *) AllocateZeroPool (sizeof (IFR_BLOCK_DATA));\r
1113 if (NewBlockData == NULL) {\r
1114 Status = EFI_OUT_OF_RESOURCES;\r
1115 goto Done;\r
1116 }\r
1117 NewBlockData->Offset = Offset;\r
1118 NewBlockData->Width = Width;\r
1119\r
1120 //\r
1121 // Insert the new block data into the block data array.\r
1122 //\r
1123 for (Link = CurrentBlockArray->Entry.ForwardLink; Link != &CurrentBlockArray->Entry; Link = Link->ForwardLink) {\r
1124 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);\r
1125 if (NewBlockData->Offset == BlockData->Offset) {\r
1126 if (NewBlockData->Width > BlockData->Width) {\r
1127 BlockData->Width = NewBlockData->Width;\r
1128 }\r
1129 FreePool (NewBlockData);\r
1130 break;\r
1131 } else if (NewBlockData->Offset < BlockData->Offset) {\r
1132 //\r
1133 // Insert new block data as the previous one of this link.\r
1134 //\r
1135 InsertTailList (Link, &NewBlockData->Entry);\r
1136 break;\r
1137 }\r
1138 }\r
1139\r
1140 //\r
1141 // Insert new block data into the array tail.\r
1142 //\r
1143 if (Link == &CurrentBlockArray->Entry) {\r
1144 InsertTailList (Link, &NewBlockData->Entry);\r
1145 }\r
1146\r
1147 //\r
1148 // If '\0', parsing is finished. \r
1149 //\r
1150 if (*StringPtr == 0) {\r
1151 break;\r
1152 }\r
1153 //\r
1154 // Go to next ConfigBlock \r
1155 //\r
1156 }\r
1157\r
1158 //\r
1159 // Merge the aligned block data into the single block data.\r
1160 //\r
1161 Link = CurrentBlockArray->Entry.ForwardLink;\r
1162 while ((Link != &CurrentBlockArray->Entry) && (Link->ForwardLink != &CurrentBlockArray->Entry)) {\r
1163 BlockData = BASE_CR (Link, IFR_BLOCK_DATA, Entry);\r
1164 NewBlockData = BASE_CR (Link->ForwardLink, IFR_BLOCK_DATA, Entry);\r
1165 if ((NewBlockData->Offset >= BlockData->Offset) && (NewBlockData->Offset <= (BlockData->Offset + BlockData->Width))) {\r
1166 if ((NewBlockData->Offset + NewBlockData->Width) > (BlockData->Offset + BlockData->Width)) {\r
1167 BlockData->Width = (UINT16) (NewBlockData->Offset + NewBlockData->Width - BlockData->Offset);\r
1168 }\r
1169 RemoveEntryList (Link->ForwardLink);\r
1170 FreePool (NewBlockData);\r
1171 continue;\r
1172 }\r
1173 Link = Link->ForwardLink; \r
1174 }\r
76c24251
LG		 1175 \r
1176 if (IsListEmpty (&CurrentBlockArray->Entry)) {\r
1177 Status = EFI_SUCCESS;\r
1178 goto Done;\r
1179 }\r
84f9a9ec
LG		 1180\r
1181 //\r
84213069 1182 // 2. Check IFR value is in block data, then Validate Value\r
84f9a9ec
LG		 1183 //\r
1184 ZeroMem (&VarBlockData, sizeof (VarBlockData));\r
1185 VarValue = 0;\r
1186 IfrVarStore = NULL;\r
1187 PackageOffset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
1188 while (PackageOffset < PackageListLength) {\r
1189 CopyMem (&PacakgeHeader, (UINT8 *) HiiPackageList + PackageOffset, sizeof (PacakgeHeader));\r
1190 \r
1191 //\r
1192 // Parse IFR opcode from the form package.\r
1193 //\r
1194 if (PacakgeHeader.Type == EFI_HII_PACKAGE_FORMS) {\r
1195 IfrOffset = sizeof (PacakgeHeader);\r
1196 PackageData = (UINT8 *) HiiPackageList + PackageOffset;\r
1197 while (IfrOffset < PacakgeHeader.Length) {\r
1198 IfrOpHdr = (EFI_IFR_OP_HEADER *) (PackageData + IfrOffset);\r
1199 //\r
1200 // Validate current setting to the value built in IFR opcode\r
1201 //\r
1202 switch (IfrOpHdr->OpCode) {\r
1203 case EFI_IFR_VARSTORE_OP: \r
1204 //\r
1205 // VarStoreId has been found. No further found.\r
1206 //\r
1207 if (IfrVarStore != NULL) {\r
1208 break;\r
1209 }\r
1210 //\r
1211 // Find the matched VarStoreId to the input VarGuid and VarName\r
8567300a 1212 //\r
84f9a9ec
LG		 1213 IfrVarStore = (EFI_IFR_VARSTORE *) IfrOpHdr;\r
1214 if (CompareGuid ((EFI_GUID *) (VOID *) &IfrVarStore->Guid, VarGuid)) {\r
1215 VarStoreName = (CHAR8 *) IfrVarStore->Name;\r
1216 for (Index = 0; VarStoreName[Index] != 0; Index ++) {\r
1217 if ((CHAR16) VarStoreName[Index] != VarName[Index]) {\r
1218 break;\r
1219 }\r
1220 }\r
1221 //\r
1222 // The matched VarStore is found.\r
1223 //\r
1224 if ((VarStoreName[Index] != 0) || (VarName[Index] != 0)) {\r
1225 IfrVarStore = NULL;\r
1226 }\r
1227 } else {\r
1228 IfrVarStore = NULL;\r
1229 }\r
1230 break;\r
1231 case EFI_IFR_FORM_OP:\r
2573712e 1232 case EFI_IFR_FORM_MAP_OP:\r
84f9a9ec
LG		 1233 //\r
1234 // Check the matched VarStoreId is found.\r
1235 //\r
1236 if (IfrVarStore == NULL) {\r
76c24251 1237 Status = EFI_SUCCESS;\r
84f9a9ec
LG		 1238 goto Done;\r
1239 }\r
1240 break;\r
1241 case EFI_IFR_ONE_OF_OP:\r
1242 //\r
8567300a 1243 // Check whether current value is the one of option.\r
84f9a9ec
LG		 1244 //\r
1245\r
1246 //\r
8567300a
LG		 1247 // OneOf question is not in IFR Form. This IFR form is not valid. \r
1248 //\r
1249 if (IfrVarStore == NULL) {\r
1250 Status = EFI_INVALID_PARAMETER;\r
1251 goto Done;\r
1252 }\r
1253 // \r
84f9a9ec
LG		 1254 // Check whether this question is for the requested varstore.\r
1255 //\r
1256 IfrOneOf = (EFI_IFR_ONE_OF *) IfrOpHdr;\r
1257 if (IfrOneOf->Question.VarStoreId != IfrVarStore->VarStoreId) {\r
1258 break;\r
1259 }\r
1260 \r
1261 //\r
1262 // Get Offset by Question header and Width by DataType Flags\r
1263 //\r
1264 Offset = IfrOneOf->Question.VarStoreInfo.VarOffset;\r
1265 Width = (UINT16) (1 << (IfrOneOf->Flags & EFI_IFR_NUMERIC_SIZE));\r
1266 //\r
1267 // Check whether this question is in current block array.\r
1268 //\r
1269 if (!BlockArrayCheck (CurrentBlockArray, Offset, Width)) {\r
1270 //\r
1271 // This question is not in the current configuration string. Skip it.\r
1272 //\r
1273 break;\r
1274 }\r
1275 //\r
1276 // Check this var question is in the var storage \r
1277 //\r
1278 if ((Offset + Width) > IfrVarStore->Size) {\r
1279 //\r
1280 // This question exceeds the var store size. \r
1281 //\r
1282 Status = EFI_INVALID_PARAMETER;\r
1283 goto Done;\r
1284 }\r
1285\r
1286 //\r
1287 // Get the current value for oneof opcode\r
1288 //\r
1289 VarValue = 0;\r
1290 CopyMem (&VarValue, VarBuffer + Offset, Width);\r
1291 //\r
1292 // Set Block Data, to be checked in the following Oneof option opcode.\r
1293 //\r
1294 VarBlockData.Offset = Offset;\r
1295 VarBlockData.Width = Width;\r
1296 VarBlockData.OpCode = IfrOpHdr->OpCode;\r
1297 VarBlockData.Scope = IfrOpHdr->Scope;\r
1298 break;\r
1299 case EFI_IFR_NUMERIC_OP:\r
1300 //\r
1301 // Check the current value is in the numeric range.\r
1302 //\r
1303\r
8567300a
LG		 1304 //\r
1305 // Numeric question is not in IFR Form. This IFR form is not valid. \r
1306 //\r
1307 if (IfrVarStore == NULL) {\r
1308 Status = EFI_INVALID_PARAMETER;\r
1309 goto Done;\r
1310 }\r
84f9a9ec
LG		 1311 //\r
1312 // Check whether this question is for the requested varstore.\r
1313 //\r
1314 IfrNumeric = (EFI_IFR_NUMERIC *) IfrOpHdr;\r
1315 if (IfrNumeric->Question.VarStoreId != IfrVarStore->VarStoreId) {\r
1316 break;\r
1317 }\r
1318 \r
1319 //\r
1320 // Get Offset by Question header and Width by DataType Flags\r
1321 //\r
1322 Offset = IfrNumeric->Question.VarStoreInfo.VarOffset;\r
1323 Width = (UINT16) (1 << (IfrNumeric->Flags & EFI_IFR_NUMERIC_SIZE));\r
1324 //\r
1325 // Check whether this question is in current block array.\r
1326 //\r
1327 if (!BlockArrayCheck (CurrentBlockArray, Offset, Width)) {\r
1328 //\r
1329 // This question is not in the current configuration string. Skip it.\r
1330 //\r
1331 break;\r
1332 }\r
1333 //\r
1334 // Check this var question is in the var storage \r
1335 //\r
1336 if ((Offset + Width) > IfrVarStore->Size) {\r
1337 //\r
1338 // This question exceeds the var store size. \r
1339 //\r
1340 Status = EFI_INVALID_PARAMETER;\r
1341 goto Done;\r
1342 }\r
1343\r
1344 //\r
1345 // Check the current value is in the numeric range.\r
1346 //\r
1347 VarValue = 0;\r
1348 CopyMem (&VarValue, VarBuffer + Offset, Width);\r
1349 switch (IfrNumeric->Flags & EFI_IFR_NUMERIC_SIZE) {\r
1350 case EFI_IFR_NUMERIC_SIZE_1:\r
1351 if ((UINT8) VarValue < IfrNumeric->data.u8.MinValue || (UINT8) VarValue > IfrNumeric->data.u8.MaxValue) {\r
1352 //\r
1353 // Not in the valid range.\r
1354 //\r
1355 Status = EFI_INVALID_PARAMETER;\r
1356 goto Done;\r
1357 }\r
1358 break;\r
1359 case EFI_IFR_NUMERIC_SIZE_2:\r
1360 if ((UINT16) VarValue < IfrNumeric->data.u16.MinValue || (UINT16) VarValue > IfrNumeric->data.u16.MaxValue) {\r
1361 //\r
1362 // Not in the valid range.\r
1363 //\r
1364 Status = EFI_INVALID_PARAMETER;\r
1365 goto Done;\r
1366 }\r
1367 break;\r
1368 case EFI_IFR_NUMERIC_SIZE_4:\r
1369 if ((UINT32) VarValue < IfrNumeric->data.u32.MinValue || (UINT32) VarValue > IfrNumeric->data.u32.MaxValue) {\r
1370 //\r
1371 // Not in the valid range.\r
1372 //\r
1373 Status = EFI_INVALID_PARAMETER;\r
1374 goto Done;\r
1375 }\r
1376 break;\r
1377 case EFI_IFR_NUMERIC_SIZE_8:\r
1378 if ((UINT64) VarValue < IfrNumeric->data.u64.MinValue || (UINT64) VarValue > IfrNumeric->data.u64.MaxValue) {\r
1379 //\r
1380 // Not in the valid range.\r
1381 //\r
1382 Status = EFI_INVALID_PARAMETER;\r
1383 goto Done;\r
1384 }\r
1385 break;\r
1386 }\r
1387\r
1388 break;\r
1389 case EFI_IFR_CHECKBOX_OP:\r
1390 //\r
1391 // Check value is BOOLEAN type, only 0 and 1 is valid.\r
1392 //\r
1393\r
8567300a
LG		 1394 //\r
1395 // CheckBox question is not in IFR Form. This IFR form is not valid. \r
1396 //\r
1397 if (IfrVarStore == NULL) {\r
1398 Status = EFI_INVALID_PARAMETER;\r
1399 goto Done;\r
1400 }\r
1401\r
84f9a9ec
LG		 1402 //\r
1403 // Check whether this question is for the requested varstore.\r
1404 //\r
1405 IfrCheckBox = (EFI_IFR_CHECKBOX *) IfrOpHdr;\r
1406 if (IfrCheckBox->Question.VarStoreId != IfrVarStore->VarStoreId) {\r
1407 break;\r
1408 }\r
1409 \r
1410 //\r
1411 // Get Offset by Question header\r
1412 //\r
1413 Offset = IfrCheckBox->Question.VarStoreInfo.VarOffset;\r
19550383 1414 Width = (UINT16) sizeof (BOOLEAN);\r
84f9a9ec
LG		 1415 //\r
1416 // Check whether this question is in current block array.\r
1417 //\r
1418 if (!BlockArrayCheck (CurrentBlockArray, Offset, Width)) {\r
1419 //\r
1420 // This question is not in the current configuration string. Skip it.\r
1421 //\r
1422 break;\r
1423 }\r
1424 //\r
1425 // Check this var question is in the var storage \r
1426 //\r
1427 if ((Offset + Width) > IfrVarStore->Size) {\r
1428 //\r
1429 // This question exceeds the var store size. \r
1430 //\r
1431 Status = EFI_INVALID_PARAMETER;\r
1432 goto Done;\r
1433 }\r
1434\r
1435 //\r
1436 // Boolean type, only 1 and 0 is valid.\r
1437 //\r
1438 if (*(VarBuffer + Offset) > 1) {\r
1439 Status = EFI_INVALID_PARAMETER;\r
1440 goto Done; \r
1441 }\r
1442 \r
1443 break;\r
1444 case EFI_IFR_STRING_OP:\r
1445 //\r
1446 // Check current string length is less than maxsize\r
1447 //\r
1448\r
8567300a
LG		 1449 //\r
1450 // CheckBox question is not in IFR Form. This IFR form is not valid. \r
1451 //\r
1452 if (IfrVarStore == NULL) {\r
1453 Status = EFI_INVALID_PARAMETER;\r
1454 goto Done;\r
1455 }\r
1456\r
84f9a9ec
LG		 1457 //\r
1458 // Check whether this question is for the requested varstore.\r
1459 //\r
1460 IfrString = (EFI_IFR_STRING *) IfrOpHdr;\r
1461 if (IfrString->Question.VarStoreId != IfrVarStore->VarStoreId) {\r
1462 break;\r
1463 }\r
1464 \r
1465 //\r
1466 // Get Offset/Width by Question header and OneOf Flags\r
1467 //\r
1468 Offset = IfrString->Question.VarStoreInfo.VarOffset;\r
1469 Width = (UINT16) (IfrString->MaxSize * sizeof (UINT16));\r
1470 //\r
1471 // Check whether this question is in current block array.\r
1472 //\r
1473 if (!BlockArrayCheck (CurrentBlockArray, Offset, Width)) {\r
1474 //\r
1475 // This question is not in the current configuration string. Skip it.\r
1476 //\r
1477 break;\r
1478 }\r
1479 //\r
1480 // Check this var question is in the var storage \r
1481 //\r
1482 if ((Offset + Width) > IfrVarStore->Size) {\r
1483 //\r
1484 // This question exceeds the var store size. \r
1485 //\r
1486 Status = EFI_INVALID_PARAMETER;\r
1487 goto Done;\r
1488 }\r
1489 \r
1490 //\r
1491 // Check current string length is less than maxsize\r
1492 //\r
1493 if (StrSize ((CHAR16 *) (VarBuffer + Offset)) > Width) {\r
1494 Status = EFI_INVALID_PARAMETER;\r
1495 goto Done; \r
1496 }\r
1497 break;\r
1498 case EFI_IFR_ONE_OF_OPTION_OP:\r
1499 //\r
1500 // Opcode Scope is zero. This one of option is not to be checked. \r
1501 //\r
1502 if (VarBlockData.Scope == 0) {\r
1503 break;\r
1504 }\r
1505\r
1506 //\r
1507 // Only check for OneOf and OrderList opcode\r
1508 //\r
1509 IfrOneOfOption = (EFI_IFR_ONE_OF_OPTION *) IfrOpHdr;\r
1510 if (VarBlockData.OpCode == EFI_IFR_ONE_OF_OP) {\r
1511 //\r
1512 // Check current value is the value of one of option.\r
1513 //\r
1514 if (VarValue == IfrOneOfOption->Value.u64) {\r
1515 //\r
1516 // The value is one of option value.\r
1517 // Set OpCode to Zero, don't need check again.\r
1518 //\r
1519 VarBlockData.OpCode = 0;\r
1520 }\r
1521 }\r
1522\r
1523 break;\r
1524 case EFI_IFR_END_OP:\r
1525 //\r
1526 // Decrease opcode scope for the validated opcode\r
1527 //\r
1528 if (VarBlockData.Scope > 0) {\r
1529 VarBlockData.Scope --;\r
1530 }\r
1531\r
1532 //\r
1533 // OneOf value doesn't belong to one of option value. \r
1534 //\r
62b658dd 1535 if ((VarBlockData.Scope == 0) && (VarBlockData.OpCode == EFI_IFR_ONE_OF_OP)) {\r
84f9a9ec
LG		 1536 Status = EFI_INVALID_PARAMETER;\r
1537 goto Done;\r
1538 }\r
1539 break;\r
1540 default:\r
1541 //\r
1542 // Increase Scope for the validated opcode\r
1543 //\r
1544 if (VarBlockData.Scope > 0) {\r
1545 VarBlockData.Scope = (UINT8) (VarBlockData.Scope + IfrOpHdr->Scope);\r
1546 }\r
1547 break;\r
1548 }\r
1549 //\r
1550 // Go to the next opcode\r
1551 //\r
1552 IfrOffset += IfrOpHdr->Length;\r
1553 }\r
1554 //\r
1555 // Only one form is in a package list.\r
1556 //\r
1557 break;\r
1558 }\r
1559 \r
1560 //\r
1561 // Go to next package.\r
1562 //\r
1563 PackageOffset += PacakgeHeader.Length; \r
1564 }\r
1565\r
1566Done:\r
1567 if (VarBuffer != NULL) {\r
1568 FreePool (VarBuffer);\r
1569 }\r
1570 \r
1571 if (CurrentBlockArray != NULL) {\r
1572 //\r
1573 // Free Link Array CurrentBlockArray\r
1574 //\r
1575 while (!IsListEmpty (&CurrentBlockArray->Entry)) {\r
1576 BlockData = BASE_CR (CurrentBlockArray->Entry.ForwardLink, IFR_BLOCK_DATA, Entry);\r
1577 RemoveEntryList (&BlockData->Entry);\r
1578 FreePool (BlockData);\r
1579 }\r
1580 FreePool (CurrentBlockArray); \r
1581 }\r
1582\r
1583 return Status;\r
1584}\r
1585\r
1586/**\r
8567300a
LG		 1587 This function parses the input ConfigRequest string and its matched IFR code\r
1588 string for setting default value and validating current setting.\r
1589\r
84f9a9ec
LG		 1590 1. For setting default action, Reset the default value specified by DefaultId \r
1591 to the driver configuration got by Request string.\r
1592 2. For validating current setting, Validate the current configuration \r
1593 by parsing HII form IFR opcode.\r
1594\r
1595 NULL request string support depends on the ExportConfig interface of\r
1596 HiiConfigRouting protocol in UEFI specification.\r
1597 \r
1598 @param Request A null-terminated Unicode string in \r
1599 <MultiConfigRequest> format. It can be NULL.\r
1600 If it is NULL, all current configuration for the\r
1601 entirety of the current HII database will be validated.\r
1602 If it is NULL, all configuration for the\r
1603 entirety of the current HII database will be reset.\r
1604 @param DefaultId Specifies the type of defaults to retrieve only for setting default action.\r
1605 @param ActionType Action supports setting defaults and validate current setting.\r
1606 \r
1607 @retval TURE Action runs successfully.\r
1608 @retval FALSE Action is not valid or Action can't be executed successfully..\r
1609**/\r
1610BOOLEAN\r
1611EFIAPI\r
1612InternalHiiIfrValueAction (\r
1613 IN CONST EFI_STRING Request, OPTIONAL\r
76c24251 1614 IN UINT16 DefaultId,\r
84f9a9ec
LG		 1615 IN UINT8 ActionType\r
1616 )\r
1617{\r
1618 EFI_STRING ConfigAltResp;\r
1619 EFI_STRING ConfigAltHdr;\r
1620 EFI_STRING ConfigResp;\r
1621 EFI_STRING Progress;\r
1622 EFI_STRING StringPtr;\r
1623 EFI_STRING StringHdr;\r
1624 EFI_STATUS Status;\r
1625 EFI_HANDLE DriverHandle;\r
1626 EFI_HANDLE TempDriverHandle;\r
1627 EFI_HII_HANDLE *HiiHandleBuffer;\r
1628 EFI_HII_HANDLE HiiHandle;\r
1629 UINT32 Index;\r
1630 EFI_GUID *VarGuid;\r
1631 EFI_STRING VarName;\r
1632 EFI_STRING_ID DefaultName;\r
1633\r
1634 UINT8 *PackageData;\r
1635 UINTN IfrOffset;\r
1636 EFI_IFR_OP_HEADER *IfrOpHdr;\r
1637 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
1638 UINT32 PackageOffset; \r
1639 UINTN PackageListLength;\r
1640 EFI_HII_PACKAGE_HEADER PacakgeHeader;\r
1641 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
1642 EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
1643 \r
1644 ConfigAltResp = NULL;\r
1645 ConfigResp = NULL;\r
1646 VarGuid = NULL;\r
1647 VarName = NULL;\r
1648 DevicePath = NULL;\r
1649 ConfigAltHdr = NULL;\r
1650 HiiHandleBuffer = NULL;\r
1651 Index = 0;\r
1652 TempDriverHandle = NULL;\r
1653 HiiHandle = NULL;\r
1654 PackageData = NULL;\r
1655 HiiPackageList = NULL;\r
1656 \r
1657 //\r
1658 // Only support set default and validate setting action.\r
1659 //\r
1660 if ((ActionType != ACTION_SET_DEFAUTL_VALUE) && (ActionType != ACTION_VALIDATE_SETTING)) {\r
1661 return FALSE;\r
1662 }\r
1663\r
1664 //\r
1665 // Get the full requested value and deault value string.\r
1666 //\r
1667 if (Request != NULL) {\r
1668 Status = gHiiConfigRouting->ExtractConfig (\r
1669 gHiiConfigRouting,\r
1670 Request,\r
1671 &Progress,\r
1672 &ConfigAltResp\r
1673 );\r
1674 } else {\r
1675 Status = gHiiConfigRouting->ExportConfig (\r
1676 gHiiConfigRouting,\r
1677 &ConfigAltResp\r
1678 );\r
1679 }\r
1680 \r
1681 if (EFI_ERROR (Status)) {\r
1682 return FALSE;\r
1683 }\r
1684 \r
1685 StringPtr = ConfigAltResp;\r
1686 \r
1687 while (StringPtr != L'\0') {\r
1688 //\r
1689 // 1. Find <ConfigHdr> GUID=...&NAME=...&PATH=...\r
1690 //\r
1691 StringHdr = StringPtr;\r
1692\r
1693 //\r
1694 // Get Guid value\r
1695 //\r
1696 if (StrnCmp (StringPtr, L"GUID=", StrLen (L"GUID=")) != 0) {\r
1697 Status = EFI_INVALID_PARAMETER;\r
1698 goto Done;\r
1699 }\r
1700 StringPtr += StrLen (L"GUID=");\r
1701 Status = InternalHiiGetBufferFromString (StringPtr, GUID_CONFIG_STRING_TYPE, (UINT8 **) &VarGuid);\r
1702 if (EFI_ERROR (Status)) {\r
1703 goto Done;\r
1704 }\r
1705\r
1706 //\r
1707 // Get Name value VarName\r
1708 //\r
1709 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&NAME=", StrLen (L"&NAME=")) != 0) {\r
1710 StringPtr++;\r
1711 }\r
1712 if (*StringPtr == L'\0') {\r
1713 Status = EFI_INVALID_PARAMETER;\r
1714 goto Done;\r
1715 }\r
1716 StringPtr += StrLen (L"&NAME=");\r
1717 Status = InternalHiiGetBufferFromString (StringPtr, NAME_CONFIG_STRING_TYPE, (UINT8 **) &VarName);\r
1718 if (EFI_ERROR (Status)) {\r
1719 goto Done;\r
1720 }\r
1721 \r
1722 //\r
1723 // Get Path value DevicePath\r
1724 //\r
1725 while (*StringPtr != L'\0' && StrnCmp (StringPtr, L"&PATH=", StrLen (L"&PATH=")) != 0) {\r
1726 StringPtr++;\r
1727 }\r
1728 if (*StringPtr == L'\0') {\r
1729 Status = EFI_INVALID_PARAMETER;\r
1730 goto Done;\r
1731 }\r
1732 StringPtr += StrLen (L"&PATH=");\r
1733 Status = InternalHiiGetBufferFromString (StringPtr, PATH_CONFIG_STRING_TYPE, (UINT8 **) &DevicePath);\r
1734 if (EFI_ERROR (Status)) {\r
1735 goto Done;\r
1736 }\r
1737\r
1738 //\r
1739 // Get the Driver handle by the got device path.\r
1740 //\r
1741 TempDevicePath = DevicePath;\r
1742 Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &TempDevicePath, &DriverHandle);\r
1743 if (EFI_ERROR (Status)) {\r
1744 goto Done;\r
1745 }\r
1746 \r
1747 //\r
1748 // Find the matched Hii Handle for the found Driver handle\r
1749 //\r
1750 HiiHandleBuffer = HiiGetHiiHandles (NULL);\r
1751 if (HiiHandleBuffer == NULL) {\r
1752 Status = EFI_NOT_FOUND;\r
1753 goto Done;\r
1754 }\r
1755\r
1756 for (Index = 0; HiiHandleBuffer[Index] != NULL; Index ++) {\r
1757 gHiiDatabase->GetPackageListHandle (gHiiDatabase, HiiHandleBuffer[Index], &TempDriverHandle);\r
1758 if (TempDriverHandle == DriverHandle) {\r
1759 break;\r
1760 }\r
1761 }\r
1762\r
1763 HiiHandle = HiiHandleBuffer[Index];\r
1764 FreePool (HiiHandleBuffer);\r
1765\r
1766 if (HiiHandle == NULL) {\r
1767 //\r
1768 // This request string has no its Hii package.\r
1769 // Its default value and validating can't execute by parsing IFR data.\r
1770 // Directly jump into the next ConfigAltResp string for another pair Guid, Name, and Path. \r
1771 //\r
4e069e8b 1772 Status = EFI_SUCCESS;\r
84f9a9ec
LG		 1773 goto NextConfigAltResp;\r
1774 }\r
1775 \r
1776 //\r
1777 // 2. Get DefaultName string ID by parsing the PacakgeList \r
1778 //\r
1779\r
1780 //\r
1781 // Get HiiPackage by HiiHandle\r
1782 //\r
1783 PackageListLength = 0;\r
1784 HiiPackageList = NULL;\r
1785 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, HiiHandle, &PackageListLength, HiiPackageList);\r
1786 \r
1787 //\r
1788 // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.\r
1789 //\r
1790 if (Status != EFI_BUFFER_TOO_SMALL) {\r
1791 Status = EFI_INVALID_PARAMETER;\r
1792 goto Done;\r
1793 }\r
1794 \r
1795 HiiPackageList = AllocatePool (PackageListLength);\r
1796 if (HiiPackageList == NULL) {\r
1797 Status = EFI_OUT_OF_RESOURCES;\r
1798 goto Done;\r
1799 }\r
1800 \r
1801 //\r
1802 // Get PackageList on HiiHandle\r
1803 //\r
1804 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, HiiHandle, &PackageListLength, HiiPackageList);\r
1805 if (EFI_ERROR (Status)) {\r
1806 goto Done;\r
1807 }\r
1808 \r
1809 //\r
1810 // Parse the form package and get the default name string ID.\r
1811 //\r
1812 if (ActionType == ACTION_SET_DEFAUTL_VALUE) {\r
1813 PackageOffset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
1814 Status = EFI_NOT_FOUND;\r
1815 while (PackageOffset < PackageListLength) {\r
1816 CopyMem (&PacakgeHeader, (UINT8 *) HiiPackageList + PackageOffset, sizeof (PacakgeHeader));\r
1817 \r
1818 //\r
1819 // Parse IFR opcode to get default store opcode\r
1820 //\r
1821 if (PacakgeHeader.Type == EFI_HII_PACKAGE_FORMS) {\r
1822 IfrOffset = sizeof (PacakgeHeader);\r
1823 PackageData = (UINT8 *) HiiPackageList + PackageOffset;\r
1824 while (IfrOffset < PacakgeHeader.Length) {\r
1825 IfrOpHdr = (EFI_IFR_OP_HEADER *) (PackageData + IfrOffset);\r
1826 //\r
1827 // Match DefaultId to find its DefaultName\r
1828 //\r
1829 if (IfrOpHdr->OpCode == EFI_IFR_DEFAULTSTORE_OP) {\r
1830 if (((EFI_IFR_DEFAULTSTORE *) IfrOpHdr)->DefaultId == DefaultId) {\r
1831 DefaultName = ((EFI_IFR_DEFAULTSTORE *) IfrOpHdr)->DefaultName;\r
1832 Status = EFI_SUCCESS;\r
1833 break;\r
1834 }\r
1835 }\r
1836 IfrOffset += IfrOpHdr->Length;\r
1837 }\r
1838 //\r
1839 // Only one form is in a package list.\r
1840 //\r
1841 break;\r
1842 }\r
1843 \r
1844 //\r
1845 // Go to next package.\r
1846 //\r
1847 PackageOffset += PacakgeHeader.Length; \r
1848 }\r
1849 \r
1850 //\r
1851 // Not found the matched default string ID\r
1852 //\r
1853 if (EFI_ERROR (Status)) {\r
76c24251
LG		 1854 Status = EFI_SUCCESS;\r
1855 goto NextConfigAltResp;\r
84f9a9ec
LG		 1856 }\r
1857 }\r
1858 \r
1859 //\r
1860 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)\r
84213069 1861 // Get the default configuration string according to the found default name string ID.\r
84f9a9ec
LG		 1862 //\r
1863 Status = gHiiConfigRouting->GetAltConfig (\r
1864 gHiiConfigRouting,\r
1865 ConfigAltResp,\r
1866 VarGuid,\r
1867 VarName,\r
1868 DevicePath,\r
1869 (ActionType == ACTION_SET_DEFAUTL_VALUE) ? &DefaultName:NULL, // it can be NULL to get the current setting.\r
1870 &ConfigResp\r
1871 );\r
1f1cb2f2
LG		 1872 \r
1873 //\r
1874 // The required setting can't be found. So, it is not required to be validated and set.\r
1875 //\r
84f9a9ec 1876 if (EFI_ERROR (Status)) {\r
76c24251
LG		 1877 Status = EFI_SUCCESS;\r
1878 goto NextConfigAltResp;\r
84f9a9ec 1879 }\r
1f1cb2f2
LG		 1880 //\r
1881 // Only the ConfigHdr is found. Not any block data is found. No data is required to be validated and set.\r
1882 //\r
1883 if (StrStr (ConfigResp, L"&OFFSET=") == NULL) {\r
1884 goto NextConfigAltResp;\r
1885 }\r
84f9a9ec
LG		 1886 \r
1887 //\r
1888 // 4. Set the default configuration information or Validate current setting by parse IFR code.\r
1889 // Current Setting is in ConfigResp, will be set into buffer, then check it again.\r
1890 //\r
1891 if (ActionType == ACTION_SET_DEFAUTL_VALUE) {\r
1892 //\r
1893 // Set the default configuration information.\r
1894 //\r
1895 Status = gHiiConfigRouting->RouteConfig (gHiiConfigRouting, ConfigResp, &Progress);\r
1896 } else {\r
1897 //\r
1898 // Current Setting is in ConfigResp, will be set into buffer, then check it again.\r
1899 //\r
1900 Status = InternalHiiValidateCurrentSetting (ConfigResp, HiiPackageList, PackageListLength, VarGuid, VarName);\r
1901 }\r
1902\r
1903 if (EFI_ERROR (Status)) {\r
1904 goto Done;\r
1905 }\r
1906\r
76c24251 1907NextConfigAltResp:\r
84f9a9ec
LG		 1908 //\r
1909 // Free the allocated pacakge buffer and the got ConfigResp string.\r
1910 //\r
1911 if (HiiPackageList != NULL) {\r
1912 FreePool (HiiPackageList);\r
1913 HiiPackageList = NULL;\r
1914 }\r
76c24251 1915 \r
1f1cb2f2
LG		 1916 if (ConfigResp != NULL) {\r
1917 FreePool (ConfigResp);\r
1918 ConfigResp = NULL;\r
1919 }\r
84f9a9ec 1920\r
84f9a9ec
LG		 1921 //\r
1922 // Free the allocated buffer.\r
1923 //\r
1924 FreePool (VarGuid);\r
1925 VarGuid = NULL;\r
1926 \r
1927 FreePool (VarName);\r
1928 VarName = NULL;\r
1929 \r
1930 FreePool (DevicePath);\r
1931 DevicePath = NULL;\r
1932\r
1933 //\r
1934 // 5. Jump to next ConfigAltResp for another Guid, Name, Path.\r
1935 //\r
1936\r
1937 //\r
1938 // Get and Skip ConfigHdr\r
1939 //\r
1940 while (*StringPtr != L'\0' && *StringPtr != L'&') {\r
1941 StringPtr++;\r
1942 }\r
1943 if (*StringPtr == L'\0') {\r
1944 break;\r
1945 }\r
1946 \r
1947 //\r
1948 // Construct ConfigAltHdr string "&<ConfigHdr>&ALTCFG=\0" \r
1949 // | 1 | StrLen (ConfigHdr) | 8 | 1 |\r
1950 //\r
1951 ConfigAltHdr = AllocateZeroPool ((1 + StringPtr - StringHdr + 8 + 1) * sizeof (CHAR16));\r
1952 if (ConfigAltHdr == NULL) {\r
1953 Status = EFI_OUT_OF_RESOURCES;\r
1954 goto Done;\r
1955 }\r
1956 StrCpy (ConfigAltHdr, L"&");\r
1957 StrnCat (ConfigAltHdr, StringHdr, StringPtr - StringHdr);\r
1958 StrCat (ConfigAltHdr, L"&ALTCFG=");\r
1959 \r
1960 //\r
1961 // Skip all AltResp (AltConfigHdr ConfigBody) for the same ConfigHdr\r
1962 //\r
1963 while ((StringHdr = StrStr (StringPtr, ConfigAltHdr)) != NULL) {\r
1964 StringPtr = StringHdr + StrLen (ConfigAltHdr);\r
1965 if (*StringPtr == L'\0') {\r
1966 break;\r
1967 }\r
1968 }\r
1969 \r
1970 //\r
1971 // Free the allocated ConfigAltHdr string\r
1972 //\r
1973 FreePool (ConfigAltHdr);\r
1974 if (*StringPtr == L'\0') {\r
1975 break;\r
1976 }\r
1977 \r
1978 //\r
1979 // Find &GUID as the next ConfigHdr\r
1980 //\r
1981 StringPtr = StrStr (StringPtr, L"&GUID");\r
1982 if (StringPtr == NULL) {\r
1983 break;\r
1984 }\r
1985\r
1986 //\r
1987 // Skip char '&'\r
1988 //\r
1989 StringPtr ++;\r
1990 }\r
1991 \r
1992Done:\r
1993 if (VarGuid != NULL) {\r
1994 FreePool (VarGuid);\r
1995 }\r
1996\r
1997 if (VarName != NULL) {\r
1998 FreePool (VarName);\r
1999 }\r
2000\r
2001 if (DevicePath != NULL) {\r
2002 FreePool (DevicePath);\r
2003 }\r
2004\r
2005 if (ConfigResp != NULL) {\r
2006 FreePool (ConfigResp);\r
2007 }\r
2008\r
2009 if (ConfigAltResp != NULL) {\r
2010 FreePool (ConfigAltResp);\r
2011 }\r
2012 \r
2013 if (HiiPackageList != NULL) {\r
2014 FreePool (HiiPackageList);\r
2015 }\r
2016 \r
2017 if (EFI_ERROR (Status)) {\r
2018 return FALSE;\r
2019 }\r
2020\r
2021 return TRUE;\r
2022}\r
2023\r
2024/**\r
2025 Validate the current configuration by parsing HII form IFR opcode.\r
2026\r
4e069e8b 2027 NULL request string support depends on the ExportConfig interface of\r
84f9a9ec
LG		 2028 HiiConfigRouting protocol in UEFI specification.\r
2029 \r
2030 @param Request A null-terminated Unicode string in \r
2031 <MultiConfigRequest> format. It can be NULL.\r
2032 If it is NULL, all current configuration for the\r
2033 entirety of the current HII database will be validated.\r
2034 \r
9035e118 2035 @retval TRUE Current configuration is valid.\r
84f9a9ec
LG		 2036 @retval FALSE Current configuration is invalid.\r
2037**/\r
2038BOOLEAN\r
2039EFIAPI \r
2040HiiValidateSettings (\r
2041 IN CONST EFI_STRING Request OPTIONAL\r
2042 )\r
2043{\r
2044 return InternalHiiIfrValueAction (Request, 0, ACTION_VALIDATE_SETTING);\r
2045}\r
2046\r
2047/**\r
2048 Reset the default value specified by DefaultId to the driver\r
2049 configuration got by Request string. \r
2050\r
2051 NULL request string support depends on the ExportConfig interface of\r
2052 HiiConfigRouting protocol in UEFI specification.\r
2053 \r
2054 @param Request A null-terminated Unicode string in \r
2055 <MultiConfigRequest> format. It can be NULL.\r
2056 If it is NULL, all configuration for the\r
2057 entirety of the current HII database will be reset.\r
2058 @param DefaultId Specifies the type of defaults to retrieve.\r
2059 \r
2060 @retval TURE The default value is set successfully.\r
2061 @retval FALSE The default value can't be found and set.\r
2062**/\r
2063BOOLEAN\r
2064EFIAPI\r
2065HiiSetToDefaults (\r
2066 IN CONST EFI_STRING Request, OPTIONAL\r
2067 IN UINT16 DefaultId\r
2068 )\r
2069{\r
2070 return InternalHiiIfrValueAction (Request, DefaultId, ACTION_SET_DEFAUTL_VALUE);\r
2071}\r
2072\r
7e3bcccb
LG		 2073/**\r
2074 Determines if two values in config strings match.\r
2075\r
2076 Compares the substring between StartSearchString and StopSearchString in \r
2077 FirstString to the substring between StartSearchString and StopSearchString \r
2078 in SecondString. If the two substrings match, then TRUE is returned. If the\r
2079 two substrings do not match, then FALSE is returned.\r
2080\r
2081 If FirstString is NULL, then ASSERT().\r
2082 If SecondString is NULL, then ASSERT().\r
2083 If StartSearchString is NULL, then ASSERT().\r
2084 If StopSearchString is NULL, then ASSERT().\r
2085\r
2086 @param FirstString Pointer to the first Null-terminated Unicode string.\r
2087 @param SecondString Pointer to the second Null-terminated Unicode string.\r
2088 @param StartSearchString Pointer to the Null-terminated Unicode string that \r
2089 marks the start of the value string to compare.\r
2090 @param StopSearchString Pointer to the Null-terminated Unicode string that \r
84213069 2091 marks the end of the value string to compare.\r
7e3bcccb
LG		 2092\r
2093 @retval FALSE StartSearchString is not present in FirstString. \r
2094 @retval FALSE StartSearchString is not present in SecondString.\r
2095 @retval FALSE StopSearchString is not present in FirstString. \r
2096 @retval FALSE StopSearchString is not present in SecondString.\r
2097 @retval FALSE The length of the substring in FirstString is not the \r
2098 same length as the substring in SecondString.\r
2099 @retval FALSE The value string in FirstString does not matche the \r
2100 value string in SecondString.\r
2101 @retval TRUE The value string in FirstString matches the value \r
2102 string in SecondString.\r
2103\r
2104**/\r
2105BOOLEAN\r
2106EFIAPI\r
2107InternalHiiCompareSubString (\r
2108 IN CHAR16 *FirstString,\r
2109 IN CHAR16 *SecondString,\r
2110 IN CHAR16 *StartSearchString,\r
2111 IN CHAR16 *StopSearchString\r
2112 )\r
2113{\r
2114 CHAR16 *EndFirstString;\r
2115 CHAR16 *EndSecondString;\r
2116\r
2117 ASSERT (FirstString != NULL);\r
2118 ASSERT (SecondString != NULL);\r
2119 ASSERT (StartSearchString != NULL);\r
2120 ASSERT (StopSearchString != NULL);\r
2121\r
2122 FirstString = StrStr (FirstString, StartSearchString);\r
2123 if (FirstString == NULL) {\r
2124 return FALSE;\r
2125 }\r
2126\r
2127 SecondString = StrStr (SecondString, StartSearchString);\r
2128 if (SecondString == NULL) {\r
2129 return FALSE;\r
2130 }\r
2131\r
2132 EndFirstString = StrStr (FirstString, StopSearchString);\r
2133 if (EndFirstString == NULL) {\r
2134 return FALSE;\r
2135 }\r
2136\r
2137 EndSecondString = StrStr (SecondString, StopSearchString);\r
2138 if (EndSecondString == NULL) {\r
2139 return FALSE;\r
2140 }\r
2141\r
2142 if ((EndFirstString - FirstString) != (EndSecondString - SecondString)) {\r
2143 return FALSE;\r
2144 }\r
2145\r
2146 return (BOOLEAN)(StrnCmp (FirstString, SecondString, EndFirstString - FirstString) == 0);\r
2147}\r
2148\r
2149/**\r
2150 Determines if the routing data specified by GUID and NAME match a <ConfigHdr>.\r
2151\r
2152 If ConfigHdr is NULL, then ASSERT().\r
2153\r
2154 @param[in] ConfigHdr Either <ConfigRequest> or <ConfigResp>.\r
2155 @param[in] Guid GUID of the storage.\r
2156 @param[in] Name NAME of the storage.\r
2157\r
2158 @retval TRUE Routing information matches <ConfigHdr>.\r
2159 @retval FALSE Routing information does not match <ConfigHdr>.\r
2160\r
2161**/\r
2162BOOLEAN\r
2163EFIAPI\r
2164HiiIsConfigHdrMatch (\r
2165 IN CONST EFI_STRING ConfigHdr,\r
2166 IN CONST EFI_GUID *Guid, OPTIONAL\r
2167 IN CONST CHAR16 *Name OPTIONAL\r
2168 )\r
2169{\r
2170 EFI_STRING CompareConfigHdr;\r
2171 BOOLEAN Result;\r
2172\r
2173 ASSERT (ConfigHdr != NULL);\r
2174\r
2175 //\r
2176 // Use Guid and Name to generate a <ConfigHdr> string\r
2177 //\r
2178 CompareConfigHdr = HiiConstructConfigHdr (Guid, Name, NULL);\r
2179 if (CompareConfigHdr == NULL) {\r
2180 return FALSE;\r
2181 }\r
2182\r
2183 Result = TRUE;\r
2184 if (Guid != NULL) {\r
2185 //\r
2186 // Compare GUID value strings\r
2187 //\r
2188 Result = InternalHiiCompareSubString (ConfigHdr, CompareConfigHdr, L"GUID=", L"&NAME=");\r
2189 }\r
2190\r
2191 if (Result && Name != NULL) {\r
2192 //\r
2193 // Compare NAME value strings\r
2194 //\r
2195 Result = InternalHiiCompareSubString (ConfigHdr, CompareConfigHdr, L"&NAME=", L"&PATH=");\r
2196 }\r
2197\r
2198 //\r
2199 // Free the <ConfigHdr> string\r
2200 //\r
2201 FreePool (CompareConfigHdr);\r
2202\r
2203 return Result;\r
2204}\r
2205\r
2206/**\r
84213069 2207 Retrieves uncommitted data from the Form Browser and converts it to a binary\r
1d451ff9 2208 buffer.\r
7e3bcccb 2209\r
1d451ff9
LG		 2210 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional \r
2211 parameter that may be NULL.\r
84213069
LG		 2212 @param[in] VariableName Pointer to a Null-terminated Unicode string. This \r
2213 is an optional parameter that may be NULL.\r
2214 @param[in] BufferSize Length in bytes of buffer to hold retrieved data. \r
2215 @param[out] Buffer Buffer of data to be updated.\r
7e3bcccb 2216\r
1d451ff9
LG		 2217 @retval FALSE The uncommitted data could not be retrieved.\r
2218 @retval TRUE The uncommitted data was retrieved.\r
7e3bcccb
LG		 2219\r
2220**/\r
1d451ff9 2221BOOLEAN\r
7e3bcccb
LG		 2222EFIAPI\r
2223HiiGetBrowserData (\r
2224 IN CONST EFI_GUID *VariableGuid, OPTIONAL\r
2225 IN CONST CHAR16 *VariableName, OPTIONAL\r
84213069
LG		 2226 IN UINTN BufferSize,\r
2227 OUT UINT8 *Buffer\r
7e3bcccb
LG		 2228 )\r
2229{\r
2230 EFI_STRING ResultsData;\r
2231 UINTN Size;\r
2232 EFI_STRING ConfigResp;\r
1d451ff9
LG		 2233 EFI_STATUS Status;\r
2234 CHAR16 *Progress;\r
7e3bcccb
LG		 2235\r
2236 //\r
2237 // Retrieve the results data from the Browser Callback\r
2238 //\r
2239 ResultsData = InternalHiiBrowserCallback (VariableGuid, VariableName, NULL);\r
2240 if (ResultsData == NULL) {\r
1d451ff9 2241 return FALSE;\r
7e3bcccb
LG		 2242 }\r
2243\r
2244 //\r
5c1ebff6 2245 // Construct <ConfigResp> mConfigHdrTemplate L'&' ResultsData L'\0'\r
7e3bcccb 2246 //\r
5c1ebff6
LG		 2247 Size = (StrLen (mConfigHdrTemplate) + 1) * sizeof (CHAR16);\r
2248 Size = Size + (StrLen (ResultsData) + 1) * sizeof (CHAR16);\r
7e3bcccb
LG		 2249 ConfigResp = AllocateZeroPool (Size);\r
2250 UnicodeSPrint (ConfigResp, Size, L"%s&%s", mConfigHdrTemplate, ResultsData);\r
2251 \r
2252 //\r
2253 // Free the allocated buffer\r
2254 //\r
2255 FreePool (ResultsData);\r
2256 if (ConfigResp == NULL) {\r
1d451ff9 2257 return FALSE;\r
7e3bcccb
LG		 2258 }\r
2259\r
2260 //\r
2261 // Convert <ConfigResp> to a buffer\r
2262 //\r
1d451ff9
LG		 2263 Status = gHiiConfigRouting->ConfigToBlock (\r
2264 gHiiConfigRouting,\r
2265 ConfigResp,\r
84213069
LG		 2266 Buffer,\r
2267 &BufferSize,\r
1d451ff9
LG		 2268 &Progress\r
2269 );\r
2270 //\r
2271 // Free the allocated buffer\r
2272 //\r
7e3bcccb
LG		 2273 FreePool (ConfigResp);\r
2274\r
1d451ff9
LG		 2275 if (EFI_ERROR (Status)) {\r
2276 return FALSE;\r
2277 }\r
2278\r
2279 return TRUE;\r
7e3bcccb
LG		 2280}\r
2281\r
2282/**\r
2283 Updates uncommitted data in the Form Browser.\r
2284\r
2285 If Buffer is NULL, then ASSERT().\r
2286\r
7e3bcccb
LG		 2287 @param[in] VariableGuid Pointer to an EFI_GUID structure. This is an optional\r
2288 parameter that may be NULL.\r
84213069
LG		 2289 @param[in] VariableName Pointer to a Null-terminated Unicode string. This\r
2290 is an optional parameter that may be NULL.\r
7e3bcccb
LG		 2291 @param[in] BufferSize Length, in bytes, of Buffer.\r
2292 @param[in] Buffer Buffer of data to commit.\r
2293 @param[in] RequestElement An optional field to specify which part of the\r
2294 buffer data will be send back to Browser. If NULL,\r
2295 the whole buffer of data will be committed to\r
2296 Browser. \r
2297 <RequestElement> ::= &OFFSET=<Number>&WIDTH=<Number>*\r
2298\r
2299 @retval FALSE The uncommitted data could not be updated.\r
2300 @retval TRUE The uncommitted data was updated.\r
2301\r
2302**/\r
2303BOOLEAN\r
2304EFIAPI\r
2305HiiSetBrowserData (\r
2306 IN CONST EFI_GUID *VariableGuid, OPTIONAL\r
2307 IN CONST CHAR16 *VariableName, OPTIONAL\r
2308 IN UINTN BufferSize,\r
2309 IN CONST UINT8 *Buffer,\r
2310 IN CONST CHAR16 *RequestElement OPTIONAL\r
2311 )\r
2312{\r
2313 UINTN Size;\r
2314 EFI_STRING ConfigRequest;\r
2315 EFI_STRING ConfigResp;\r
2316 EFI_STRING ResultsData;\r
2317\r
2318 ASSERT (Buffer != NULL);\r
2319\r
2320 //\r
2321 // Construct <ConfigRequest>\r
2322 //\r
2323 if (RequestElement == NULL) {\r
2324 //\r
2325 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r
2326 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
2327 //\r
2328 Size = (StrLen (mConfigHdrTemplate) + 32 + 1) * sizeof (CHAR16);\r
2329 ConfigRequest = AllocateZeroPool (Size);\r
2330 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", mConfigHdrTemplate, (UINT64)BufferSize);\r
2331 } else {\r
2332 //\r
2333 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r
2334 // followed by <RequestElement> followed by a Null-terminator\r
2335 //\r
5c1ebff6
LG		 2336 Size = StrLen (mConfigHdrTemplate) * sizeof (CHAR16);\r
2337 Size = Size + (StrLen (RequestElement) + 1) * sizeof (CHAR16);\r
7e3bcccb
LG		 2338 ConfigRequest = AllocateZeroPool (Size);\r
2339 UnicodeSPrint (ConfigRequest, Size, L"%s%s", mConfigHdrTemplate, RequestElement);\r
2340 }\r
2341 if (ConfigRequest == NULL) {\r
2342 return FALSE;\r
2343 }\r
2344\r
2345 //\r
2346 // Convert <ConfigRequest> to <ConfigResp>\r
2347 //\r
2348 ConfigResp = InternalHiiBlockToConfig (ConfigRequest, Buffer, BufferSize);\r
2349 FreePool (ConfigRequest);\r
2350 if (ConfigResp == NULL) {\r
2351 return FALSE;\r
2352 }\r
2353\r
2354 //\r
2355 // Set data in the uncommitted browser state information\r
2356 //\r
2357 ResultsData = InternalHiiBrowserCallback (VariableGuid, VariableName, ConfigResp + StrLen(mConfigHdrTemplate) + 1);\r
2358 FreePool (ConfigResp);\r
2359\r
2360 return (BOOLEAN)(ResultsData != NULL);\r
2361}\r
2362\r
2363/////////////////////////////////////////\r
2364/////////////////////////////////////////\r
2365/// IFR Functions\r
2366/////////////////////////////////////////\r
2367/////////////////////////////////////////\r
2368\r
2369#define HII_LIB_OPCODE_ALLOCATION_SIZE 0x200\r
2370\r
2371typedef struct {\r
2372 UINT8 *Buffer;\r
2373 UINTN BufferSize;\r
2374 UINTN Position;\r
2375} HII_LIB_OPCODE_BUFFER;\r
2376\r
2377///\r
2378/// Lookup table that converts EFI_IFR_TYPE_X enum values to a width in bytes\r
2379///\r
2380GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 mHiiDefaultTypeToWidth[] = {\r
2381 1, // EFI_IFR_TYPE_NUM_SIZE_8\r
2382 2, // EFI_IFR_TYPE_NUM_SIZE_16\r
2383 4, // EFI_IFR_TYPE_NUM_SIZE_32\r
2384 8, // EFI_IFR_TYPE_NUM_SIZE_64\r
2385 1, // EFI_IFR_TYPE_BOOLEAN\r
2386 3, // EFI_IFR_TYPE_TIME\r
2387 4, // EFI_IFR_TYPE_DATE\r
2388 2 // EFI_IFR_TYPE_STRING\r
2389};\r
2390\r
2391/**\r
2392 Allocates and returns a new OpCode Handle. OpCode Handles must be freed with \r
2393 HiiFreeOpCodeHandle().\r
2394\r
2395 @retval NULL There are not enough resources to allocate a new OpCode Handle.\r
2396 @retval Other A new OpCode handle.\r
2397\r
2398**/\r
2399VOID *\r
2400EFIAPI\r
2401HiiAllocateOpCodeHandle (\r
2402 VOID\r
2403 )\r
2404{\r
2405 HII_LIB_OPCODE_BUFFER *OpCodeBuffer;\r
2406\r
2407 OpCodeBuffer = (HII_LIB_OPCODE_BUFFER *)AllocatePool (sizeof (HII_LIB_OPCODE_BUFFER));\r
2408 if (OpCodeBuffer == NULL) {\r
2409 return NULL;\r
2410 }\r
2411 OpCodeBuffer->Buffer = (UINT8 *)AllocatePool (HII_LIB_OPCODE_ALLOCATION_SIZE);\r
2412 if (OpCodeBuffer->Buffer == NULL) {\r
2413 FreePool (OpCodeBuffer);\r
2414 return NULL;\r
2415 }\r
2416 OpCodeBuffer->BufferSize = HII_LIB_OPCODE_ALLOCATION_SIZE;\r
2417 OpCodeBuffer->Position = 0;\r
2418 return (VOID *)OpCodeBuffer;\r
2419}\r
2420\r
2421/**\r
84213069 2422 Frees an OpCode Handle that was previously allocated with HiiAllocateOpCodeHandle().\r
7e3bcccb
LG		 2423 When an OpCode Handle is freed, all of the opcodes associated with the OpCode\r
2424 Handle are also freed.\r
2425\r
2426 If OpCodeHandle is NULL, then ASSERT().\r
2427\r
84213069
LG		 2428 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2429\r
7e3bcccb
LG		 2430**/\r
2431VOID\r
2432EFIAPI\r
2433HiiFreeOpCodeHandle (\r
2434 VOID *OpCodeHandle\r
2435 )\r
2436{\r
2437 HII_LIB_OPCODE_BUFFER *OpCodeBuffer;\r
2438\r
2439 ASSERT (OpCodeHandle != NULL);\r
2440\r
2441 OpCodeBuffer = (HII_LIB_OPCODE_BUFFER *)OpCodeHandle;\r
2442 if (OpCodeBuffer->Buffer != NULL) {\r
2443 FreePool (OpCodeBuffer->Buffer);\r
2444 }\r
2445 FreePool (OpCodeBuffer);\r
2446}\r
2447\r
84213069
LG		 2448/**\r
2449 Internal function gets the current position of opcode buffer.\r
2450 \r
2451 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2452\r
2453 @return Current position of opcode buffer.\r
2454**/\r
7e3bcccb
LG		 2455UINTN\r
2456EFIAPI\r
2457InternalHiiOpCodeHandlePosition (\r
2458 IN VOID *OpCodeHandle\r
2459 )\r
2460{\r
2461 return ((HII_LIB_OPCODE_BUFFER *)OpCodeHandle)->Position;\r
2462}\r
2463\r
84213069
LG		 2464/**\r
2465 Internal function gets the start pointer of opcode buffer.\r
2466 \r
2467 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2468\r
2469 @return Pointer to the opcode buffer base.\r
2470**/\r
7e3bcccb
LG		 2471UINT8 *\r
2472EFIAPI\r
2473InternalHiiOpCodeHandleBuffer (\r
2474 IN VOID *OpCodeHandle\r
2475 )\r
2476{\r
2477 return ((HII_LIB_OPCODE_BUFFER *)OpCodeHandle)->Buffer;\r
2478}\r
2479\r
84213069
LG		 2480/**\r
2481 Internal function reserves the enough buffer for current opcode.\r
2482 When the buffer is not enough, Opcode buffer will be extended.\r
2483 \r
2484 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2485 @param[in] Size Size of current opcode.\r
2486\r
2487 @return Pointer to the current opcode.\r
2488**/\r
7e3bcccb
LG		 2489UINT8 *\r
2490EFIAPI\r
2491InternalHiiGrowOpCodeHandle (\r
84213069
LG		 2492 IN VOID *OpCodeHandle,\r
2493 IN UINTN Size\r
7e3bcccb
LG		 2494 )\r
2495{\r
2496 HII_LIB_OPCODE_BUFFER *OpCodeBuffer;\r
2497 UINT8 *Buffer;\r
2498\r
2499 ASSERT (OpCodeHandle != NULL);\r
2500\r
2501 OpCodeBuffer = (HII_LIB_OPCODE_BUFFER *)OpCodeHandle;\r
2502 if (OpCodeBuffer->Position + Size > OpCodeBuffer->BufferSize) {\r
2503 Buffer = ReallocatePool (\r
2504 OpCodeBuffer->BufferSize, \r
2505 OpCodeBuffer->BufferSize + (Size + HII_LIB_OPCODE_ALLOCATION_SIZE),\r
2506 OpCodeBuffer->Buffer\r
2507 );\r
2508 if (Buffer == NULL) {\r
2509 return NULL;\r
2510 }\r
2511 OpCodeBuffer->Buffer = Buffer;\r
2512 OpCodeBuffer->BufferSize += (Size + HII_LIB_OPCODE_ALLOCATION_SIZE);\r
2513 }\r
2514 Buffer = OpCodeBuffer->Buffer + OpCodeBuffer->Position;\r
2515 OpCodeBuffer->Position += Size;\r
2516 return Buffer;\r
2517}\r
2518\r
84213069
LG		 2519/**\r
2520 Internal function creates opcode based on the template opcode.\r
2521 \r
2522 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2523 @param[in] OpCodeTemplate Pointer to the template buffer of opcode.\r
2524 @param[in] OpCode OpCode IFR value.\r
2525 @param[in] OpCodeSize Size of opcode.\r
2526 @param[in] ExtensionSize Size of extended opcode.\r
2527 @param[in] Scope Scope bit of opcode.\r
2528\r
2529 @return Pointer to the current opcode with opcode data.\r
2530**/\r
7e3bcccb
LG		 2531UINT8 *\r
2532EFIAPI\r
2533InternalHiiCreateOpCodeExtended (\r
2534 IN VOID *OpCodeHandle,\r
2535 IN VOID *OpCodeTemplate,\r
2536 IN UINT8 OpCode,\r
2537 IN UINTN OpCodeSize,\r
2538 IN UINTN ExtensionSize,\r
2539 IN UINT8 Scope\r
2540 )\r
2541{\r
2542 EFI_IFR_OP_HEADER *Header;\r
2543 UINT8 *Buffer;\r
2544\r
2545 ASSERT (OpCodeTemplate != NULL);\r
2546 ASSERT ((OpCodeSize + ExtensionSize) <= 0x7F);\r
2547\r
2548 Header = (EFI_IFR_OP_HEADER *)OpCodeTemplate;\r
2549 Header->OpCode = OpCode;\r
2550 Header->Scope = Scope;\r
2551 Header->Length = (UINT8)(OpCodeSize + ExtensionSize);\r
2552 Buffer = InternalHiiGrowOpCodeHandle (OpCodeHandle, Header->Length);\r
2553 return (UINT8 *)CopyMem (Buffer, Header, OpCodeSize);\r
2554}\r
2555\r
84213069
LG		 2556/**\r
2557 Internal function creates opcode based on the template opcode for the normal opcode.\r
2558 \r
2559 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2560 @param[in] OpCodeTemplate Pointer to the template buffer of opcode.\r
2561 @param[in] OpCode OpCode IFR value.\r
2562 @param[in] OpCodeSize Size of opcode.\r
2563\r
2564 @return Pointer to the current opcode with opcode data.\r
2565**/\r
7e3bcccb
LG		 2566UINT8 *\r
2567EFIAPI\r
2568InternalHiiCreateOpCode (\r
2569 IN VOID *OpCodeHandle,\r
2570 IN VOID *OpCodeTemplate,\r
2571 IN UINT8 OpCode,\r
2572 IN UINTN OpCodeSize\r
2573 )\r
2574{\r
2575 return InternalHiiCreateOpCodeExtended (OpCodeHandle, OpCodeTemplate, OpCode, OpCodeSize, 0, 0);\r
2576}\r
2577\r
2578/**\r
2579 Append raw opcodes to an OpCodeHandle.\r
2580\r
2581 If OpCodeHandle is NULL, then ASSERT().\r
2582 If RawBuffer is NULL, then ASSERT();\r
2583\r
2584 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2585 @param[in] RawBuffer Buffer of opcodes to append.\r
2586 @param[in] RawBufferSize The size, in bytes, of Buffer.\r
2587\r
2588 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2589 @retval Other A pointer to the appended opcodes.\r
2590\r
2591**/\r
2592UINT8 *\r
2593EFIAPI\r
278663ab 2594HiiCreateRawOpCodes (\r
7e3bcccb
LG		 2595 IN VOID *OpCodeHandle,\r
2596 IN UINT8 *RawBuffer,\r
2597 IN UINTN RawBufferSize\r
2598 )\r
2599{\r
2600 UINT8 *Buffer;\r
2601\r
2602 ASSERT (RawBuffer != NULL);\r
2603\r
2604 Buffer = InternalHiiGrowOpCodeHandle (OpCodeHandle, RawBufferSize);\r
2605 return (UINT8 *)CopyMem (Buffer, RawBuffer, RawBufferSize);\r
2606}\r
2607\r
2608/**\r
2609 Append opcodes from one OpCode Handle to another OpCode handle.\r
2610\r
2611 If OpCodeHandle is NULL, then ASSERT().\r
2612 If RawOpCodeHandle is NULL, then ASSERT();\r
2613\r
2614 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2615 @param[in] RawOpCodeHandle Handle to the buffer of opcodes.\r
2616\r
2617 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2618 @retval Other A pointer to the appended opcodes.\r
2619\r
2620**/\r
2621UINT8 *\r
2622EFIAPI\r
2623InternalHiiAppendOpCodes (\r
2624 IN VOID *OpCodeHandle,\r
2625 IN VOID *RawOpCodeHandle\r
2626 )\r
2627{\r
2628 HII_LIB_OPCODE_BUFFER *RawOpCodeBuffer;\r
2629\r
2630 ASSERT (RawOpCodeHandle != NULL);\r
2631\r
2632 RawOpCodeBuffer = (HII_LIB_OPCODE_BUFFER *)RawOpCodeHandle;\r
278663ab 2633 return HiiCreateRawOpCodes (OpCodeHandle, RawOpCodeBuffer->Buffer, RawOpCodeBuffer->Position);\r
7e3bcccb
LG		 2634}\r
2635\r
2636/**\r
2637 Create EFI_IFR_END_OP opcode.\r
2638\r
2639 If OpCodeHandle is NULL, then ASSERT().\r
2640\r
2641 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2642\r
2643 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2644 @retval Other A pointer to the created opcode.\r
2645\r
2646**/\r
2647UINT8 *\r
2648EFIAPI\r
2649HiiCreateEndOpCode (\r
2650 IN VOID *OpCodeHandle\r
2651 )\r
2652{\r
2653 EFI_IFR_END OpCode;\r
2654\r
2655 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_END_OP, sizeof (OpCode));\r
2656}\r
2657\r
2658/**\r
2659 Create EFI_IFR_ONE_OF_OPTION_OP opcode.\r
2660\r
2661 If OpCodeHandle is NULL, then ASSERT().\r
2662 If Type is invalid, then ASSERT().\r
2663 If Flags is invalid, then ASSERT().\r
2664\r
2665 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2666 @param[in] StringId StringId for the option\r
2667 @param[in] Flags Flags for the option\r
2668 @param[in] Type Type for the option\r
2669 @param[in] Value Value for the option\r
2670\r
2671 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2672 @retval Other A pointer to the created opcode.\r
2673\r
2674**/\r
2675UINT8 *\r
2676EFIAPI\r
2677HiiCreateOneOfOptionOpCode (\r
2678 IN VOID *OpCodeHandle,\r
2679 IN UINT16 StringId,\r
2680 IN UINT8 Flags,\r
2681 IN UINT8 Type,\r
2682 IN UINT64 Value\r
2683 )\r
2684{\r
2685 EFI_IFR_ONE_OF_OPTION OpCode;\r
2686\r
2687 ASSERT (Type < EFI_IFR_TYPE_OTHER);\r
2688\r
2689 ZeroMem (&OpCode, sizeof (OpCode));\r
2690 OpCode.Option = StringId;\r
2691 OpCode.Flags = (UINT8) (Flags & (EFI_IFR_OPTION_DEFAULT | EFI_IFR_OPTION_DEFAULT_MFG));\r
2692 OpCode.Type = Type;\r
2693 CopyMem (&OpCode.Value, &Value, mHiiDefaultTypeToWidth[Type]);\r
2694\r
2695 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_ONE_OF_OPTION_OP, sizeof (OpCode));\r
2696}\r
2697\r
2698/**\r
2699 Create EFI_IFR_DEFAULT_OP opcode.\r
2700\r
2701 If OpCodeHandle is NULL, then ASSERT().\r
2702 If Type is invalid, then ASSERT().\r
2703\r
2704 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2705 @param[in] DefaultId DefaultId for the default\r
2706 @param[in] Type Type for the default\r
2707 @param[in] Value Value for the default\r
2708\r
2709 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2710 @retval Other A pointer to the created opcode.\r
2711\r
2712**/\r
2713UINT8 *\r
2714EFIAPI\r
2715HiiCreateDefaultOpCode (\r
2716 IN VOID *OpCodeHandle,\r
2717 IN UINT16 DefaultId,\r
2718 IN UINT8 Type,\r
2719 IN UINT64 Value\r
2720 )\r
2721{\r
2722 EFI_IFR_DEFAULT OpCode;\r
2723\r
2724 ASSERT (Type < EFI_IFR_TYPE_OTHER);\r
2725\r
2726 ZeroMem (&OpCode, sizeof (OpCode));\r
2727 OpCode.Type = Type;\r
2728 OpCode.DefaultId = DefaultId;\r
2729 CopyMem (&OpCode.Value, &Value, mHiiDefaultTypeToWidth[Type]);\r
2730\r
2731 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_DEFAULT_OP, sizeof (OpCode));\r
2732}\r
2733\r
2734/**\r
2735 Create EFI_IFR_GUID opcode.\r
2736\r
2737 If OpCodeHandle is NULL, then ASSERT().\r
2738 If Guid is NULL, then ASSERT().\r
2739 If OpCodeSize < sizeof (EFI_IFR_GUID), then ASSERT().\r
2740\r
2741 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2742 @param[in] Guid Pointer to EFI_GUID of this guided opcode.\r
2743 @param[in] GuidOpCode Pointer to an EFI_IFR_GUID opcode. This is an \r
2744 optional parameter that may be NULL. If this\r
2745 parameter is NULL, then the GUID extension \r
2746 region of the created opcode is filled with zeros.\r
2747 If this parameter is not NULL, then the GUID \r
2748 extension region of GuidData will be copied to \r
2749 the GUID extension region of the created opcode.\r
2750 @param[in] OpCodeSize The size, in bytes, of created opcode. This value \r
2751 must be >= sizeof(EFI_IFR_GUID).\r
2752\r
2753 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2754 @retval Other A pointer to the created opcode.\r
2755\r
2756**/\r
2757UINT8 *\r
2758EFIAPI\r
2759HiiCreateGuidOpCode (\r
2760 IN VOID *OpCodeHandle,\r
2761 IN CONST EFI_GUID *Guid,\r
2762 IN CONST VOID *GuidOpCode, OPTIONAL\r
2763 IN UINTN OpCodeSize\r
2764 )\r
2765{\r
2766 EFI_IFR_GUID OpCode;\r
2767 EFI_IFR_GUID *OpCodePointer;\r
2768\r
2769 ASSERT (Guid != NULL);\r
2770 ASSERT (OpCodeSize >= sizeof (OpCode));\r
2771\r
2772 ZeroMem (&OpCode, sizeof (OpCode));\r
5c1ebff6 2773 CopyGuid ((EFI_GUID *)(VOID *)&OpCode.Guid, Guid);\r
7e3bcccb
LG		 2774\r
2775 OpCodePointer = (EFI_IFR_GUID *)InternalHiiCreateOpCodeExtended (\r
2776 OpCodeHandle, \r
2777 &OpCode,\r
2778 EFI_IFR_GUID_OP,\r
2779 sizeof (OpCode),\r
2780 OpCodeSize - sizeof (OpCode),\r
2781 0\r
2782 );\r
2783 if (OpCodePointer != NULL && GuidOpCode != NULL) {\r
2784 CopyMem (OpCodePointer + 1, (EFI_IFR_GUID *)GuidOpCode + 1, OpCodeSize - sizeof (OpCode));\r
2785 }\r
2786 return (UINT8 *)OpCodePointer;\r
2787}\r
2788\r
2789/**\r
2790 Create EFI_IFR_ACTION_OP opcode.\r
2791\r
2792 If OpCodeHandle is NULL, then ASSERT().\r
2793 If any reserved bits are set in QuestionFlags, then ASSERT().\r
2794\r
2795 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2796 @param[in] QuestionId Question ID\r
2797 @param[in] Prompt String ID for Prompt\r
2798 @param[in] Help String ID for Help\r
2799 @param[in] QuestionFlags Flags in Question Header\r
2800 @param[in] QuestionConfig String ID for configuration\r
2801\r
2802 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2803 @retval Other A pointer to the created opcode.\r
2804\r
2805**/\r
2806UINT8 *\r
2807EFIAPI\r
2808HiiCreateActionOpCode (\r
2809 IN VOID *OpCodeHandle,\r
2810 IN EFI_QUESTION_ID QuestionId,\r
2811 IN EFI_STRING_ID Prompt,\r
2812 IN EFI_STRING_ID Help,\r
2813 IN UINT8 QuestionFlags,\r
2814 IN EFI_STRING_ID QuestionConfig\r
2815 )\r
2816{\r
2817 EFI_IFR_ACTION OpCode;\r
2818\r
e22812c7 2819 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
7e3bcccb
LG		 2820\r
2821 ZeroMem (&OpCode, sizeof (OpCode));\r
2822 OpCode.Question.QuestionId = QuestionId;\r
2823 OpCode.Question.Header.Prompt = Prompt;\r
2824 OpCode.Question.Header.Help = Help;\r
2825 OpCode.Question.Flags = QuestionFlags;\r
2826 OpCode.QuestionConfig = QuestionConfig;\r
2827\r
2828 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_ACTION_OP, sizeof (OpCode));\r
2829}\r
2830\r
2831/**\r
2832 Create EFI_IFR_SUBTITLE_OP opcode.\r
2833\r
2834 If OpCodeHandle is NULL, then ASSERT().\r
2835 If any reserved bits are set in Flags, then ASSERT().\r
2836 If Scope > 1, then ASSERT().\r
2837\r
2838 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2839 @param[in] Prompt String ID for Prompt\r
2840 @param[in] Help String ID for Help\r
2841 @param[in] Flags Subtitle opcode flags\r
2842 @param[in] Scope 1 if this opcpde is the beginning of a new scope.\r
2843 0 if this opcode is within the current scope.\r
2844\r
2845 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2846 @retval Other A pointer to the created opcode.\r
2847\r
2848**/\r
2849UINT8 *\r
2850EFIAPI\r
2851HiiCreateSubTitleOpCode (\r
2852 IN VOID *OpCodeHandle,\r
2853 IN EFI_STRING_ID Prompt,\r
2854 IN EFI_STRING_ID Help,\r
2855 IN UINT8 Flags,\r
2856 IN UINT8 Scope\r
2857 )\r
2858{\r
2859 EFI_IFR_SUBTITLE OpCode;\r
2860\r
2861 ASSERT (Scope <= 1);\r
2862 ASSERT ((Flags & (~(EFI_IFR_FLAGS_HORIZONTAL))) == 0);\r
2863\r
2864 ZeroMem (&OpCode, sizeof (OpCode));\r
2865 OpCode.Statement.Prompt = Prompt;\r
2866 OpCode.Statement.Help = Help;\r
2867 OpCode.Flags = Flags;\r
2868\r
2869 return InternalHiiCreateOpCodeExtended (\r
2870 OpCodeHandle, \r
2871 &OpCode,\r
2872 EFI_IFR_SUBTITLE_OP, \r
2873 sizeof (OpCode), \r
2874 0, \r
2875 Scope\r
2876 );\r
2877}\r
2878\r
2879/**\r
2880 Create EFI_IFR_REF_OP opcode.\r
2881\r
2882 If OpCodeHandle is NULL, then ASSERT().\r
2883 If any reserved bits are set in QuestionFlags, then ASSERT().\r
2884\r
2885 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2886 @param[in] FormId Destination Form ID\r
2887 @param[in] Prompt String ID for Prompt\r
2888 @param[in] Help String ID for Help\r
2889 @param[in] QuestionFlags Flags in Question Header\r
2890 @param[in] QuestionId Question ID\r
2891\r
2892 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2893 @retval Other A pointer to the created opcode.\r
2894\r
2895**/\r
2896UINT8 *\r
2897EFIAPI\r
2898HiiCreateGotoOpCode (\r
2899 IN VOID *OpCodeHandle,\r
2900 IN EFI_FORM_ID FormId,\r
2901 IN EFI_STRING_ID Prompt,\r
2902 IN EFI_STRING_ID Help,\r
2903 IN UINT8 QuestionFlags,\r
2904 IN EFI_QUESTION_ID QuestionId\r
2905 )\r
2906{\r
2907 EFI_IFR_REF OpCode;\r
2908\r
e22812c7 2909 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
7e3bcccb
LG		 2910\r
2911 ZeroMem (&OpCode, sizeof (OpCode));\r
2912 OpCode.Question.Header.Prompt = Prompt;\r
2913 OpCode.Question.Header.Help = Help;\r
2914 OpCode.Question.QuestionId = QuestionId;\r
2915 OpCode.Question.Flags = QuestionFlags;\r
2916 OpCode.FormId = FormId;\r
2917\r
2918 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_REF_OP, sizeof (OpCode));\r
2919}\r
2920\r
2921/**\r
2922 Create EFI_IFR_CHECKBOX_OP opcode.\r
2923\r
2924 If OpCodeHandle is NULL, then ASSERT().\r
2925 If any reserved bits are set in QuestionFlags, then ASSERT().\r
2926 If any reserved bits are set in CheckBoxFlags, then ASSERT().\r
2927\r
2928 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2929 @param[in] QuestionId Question ID\r
2930 @param[in] VarStoreId Storage ID\r
2931 @param[in] VarOffset Offset in Storage\r
2932 @param[in] Prompt String ID for Prompt\r
2933 @param[in] Help String ID for Help\r
2934 @param[in] QuestionFlags Flags in Question Header\r
2935 @param[in] CheckBoxFlags Flags for checkbox opcode\r
2936 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
2937 is an optional parameter that may be NULL.\r
2938\r
2939 @retval NULL There is not enough space left in Buffer to add the opcode.\r
2940 @retval Other A pointer to the created opcode.\r
2941\r
2942**/\r
2943UINT8 *\r
2944EFIAPI\r
2945HiiCreateCheckBoxOpCode (\r
2946 IN VOID *OpCodeHandle,\r
2947 IN EFI_QUESTION_ID QuestionId,\r
2948 IN EFI_VARSTORE_ID VarStoreId,\r
2949 IN UINT16 VarOffset,\r
2950 IN EFI_STRING_ID Prompt,\r
2951 IN EFI_STRING_ID Help,\r
2952 IN UINT8 QuestionFlags,\r
2953 IN UINT8 CheckBoxFlags,\r
2954 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
2955 )\r
2956{\r
2957 EFI_IFR_CHECKBOX OpCode;\r
2958 UINTN Position;\r
2959\r
e22812c7 2960 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
7e3bcccb
LG		 2961\r
2962 ZeroMem (&OpCode, sizeof (OpCode));\r
2963 OpCode.Question.QuestionId = QuestionId;\r
2964 OpCode.Question.VarStoreId = VarStoreId;\r
2965 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
2966 OpCode.Question.Header.Prompt = Prompt;\r
2967 OpCode.Question.Header.Help = Help;\r
2968 OpCode.Question.Flags = QuestionFlags;\r
2969 OpCode.Flags = CheckBoxFlags;\r
2970\r
2971 if (DefaultsOpCodeHandle == NULL) {\r
2972 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_CHECKBOX_OP, sizeof (OpCode));\r
2973 }\r
2974\r
2975 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
2976 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_CHECKBOX_OP, sizeof (OpCode), 0, 1);\r
2977 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
2978 HiiCreateEndOpCode (OpCodeHandle);\r
2979 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
2980}\r
2981\r
2982/**\r
2983 Create EFI_IFR_NUMERIC_OP opcode.\r
2984\r
2985 If OpCodeHandle is NULL, then ASSERT().\r
2986 If any reserved bits are set in QuestionFlags, then ASSERT().\r
2987 If any reserved bits are set in NumericFlags, then ASSERT().\r
2988\r
2989 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
2990 @param[in] QuestionId Question ID\r
2991 @param[in] VarStoreId Storage ID\r
2992 @param[in] VarOffset Offset in Storage\r
2993 @param[in] Prompt String ID for Prompt\r
2994 @param[in] Help String ID for Help\r
2995 @param[in] QuestionFlags Flags in Question Header\r
2996 @param[in] NumericFlags Flags for numeric opcode\r
2997 @param[in] Minimum Numeric minimum value\r
2998 @param[in] Maximum Numeric maximum value\r
2999 @param[in] Step Numeric step for edit\r
3000 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3001 is an optional parameter that may be NULL.\r
3002\r
3003 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3004 @retval Other A pointer to the created opcode.\r
3005\r
3006**/\r
3007UINT8 *\r
3008EFIAPI\r
3009HiiCreateNumericOpCode (\r
3010 IN VOID *OpCodeHandle,\r
3011 IN EFI_QUESTION_ID QuestionId,\r
3012 IN EFI_VARSTORE_ID VarStoreId,\r
3013 IN UINT16 VarOffset,\r
3014 IN EFI_STRING_ID Prompt,\r
3015 IN EFI_STRING_ID Help,\r
3016 IN UINT8 QuestionFlags,\r
3017 IN UINT8 NumericFlags,\r
3018 IN UINT64 Minimum,\r
3019 IN UINT64 Maximum,\r
3020 IN UINT64 Step,\r
3021 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3022 )\r
3023{\r
3024 EFI_IFR_NUMERIC OpCode;\r
3025 UINTN Position;\r
3026\r
e22812c7 3027 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
7e3bcccb
LG		 3028\r
3029 ZeroMem (&OpCode, sizeof (OpCode));\r
3030 OpCode.Question.QuestionId = QuestionId;\r
3031 OpCode.Question.VarStoreId = VarStoreId;\r
3032 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3033 OpCode.Question.Header.Prompt = Prompt;\r
3034 OpCode.Question.Header.Help = Help;\r
3035 OpCode.Question.Flags = QuestionFlags;\r
3036 OpCode.Flags = NumericFlags;\r
3037\r
3038 switch (NumericFlags & EFI_IFR_NUMERIC_SIZE) {\r
3039 case EFI_IFR_NUMERIC_SIZE_1:\r
3040 OpCode.data.u8.MinValue = (UINT8)Minimum;\r
3041 OpCode.data.u8.MaxValue = (UINT8)Maximum;\r
3042 OpCode.data.u8.Step = (UINT8)Step;\r
3043 break;\r
3044\r
3045 case EFI_IFR_NUMERIC_SIZE_2:\r
3046 OpCode.data.u16.MinValue = (UINT16)Minimum;\r
3047 OpCode.data.u16.MaxValue = (UINT16)Maximum;\r
3048 OpCode.data.u16.Step = (UINT16)Step;\r
3049 break;\r
3050\r
3051 case EFI_IFR_NUMERIC_SIZE_4:\r
3052 OpCode.data.u32.MinValue = (UINT32)Minimum;\r
3053 OpCode.data.u32.MaxValue = (UINT32)Maximum;\r
3054 OpCode.data.u32.Step = (UINT32)Step;\r
3055 break;\r
3056\r
3057 case EFI_IFR_NUMERIC_SIZE_8:\r
3058 OpCode.data.u64.MinValue = Minimum;\r
3059 OpCode.data.u64.MaxValue = Maximum;\r
3060 OpCode.data.u64.Step = Step;\r
3061 break;\r
3062 }\r
3063\r
3064 if (DefaultsOpCodeHandle == NULL) {\r
3065 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_NUMERIC_OP, sizeof (OpCode));\r
3066 }\r
3067\r
3068 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3069 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_NUMERIC_OP, sizeof (OpCode), 0, 1);\r
3070 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3071 HiiCreateEndOpCode (OpCodeHandle);\r
3072 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3073}\r
3074\r
3075/**\r
3076 Create EFI_IFR_STRING_OP opcode.\r
3077\r
3078 If OpCodeHandle is NULL, then ASSERT().\r
3079 If any reserved bits are set in QuestionFlags, then ASSERT().\r
3080 If any reserved bits are set in StringFlags, then ASSERT().\r
3081\r
3082 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3083 @param[in] QuestionId Question ID\r
3084 @param[in] VarStoreId Storage ID\r
3085 @param[in] VarOffset Offset in Storage\r
3086 @param[in] Prompt String ID for Prompt\r
3087 @param[in] Help String ID for Help\r
3088 @param[in] QuestionFlags Flags in Question Header\r
3089 @param[in] StringFlags Flags for string opcode\r
3090 @param[in] MinSize String minimum length\r
3091 @param[in] MaxSize String maximum length\r
3092 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3093 is an optional parameter that may be NULL.\r
3094\r
3095 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3096 @retval Other A pointer to the created opcode.\r
3097\r
3098**/\r
3099UINT8 *\r
3100EFIAPI\r
3101HiiCreateStringOpCode (\r
3102 IN VOID *OpCodeHandle,\r
3103 IN EFI_QUESTION_ID QuestionId,\r
3104 IN EFI_VARSTORE_ID VarStoreId,\r
3105 IN UINT16 VarOffset,\r
3106 IN EFI_STRING_ID Prompt,\r
3107 IN EFI_STRING_ID Help,\r
3108 IN UINT8 QuestionFlags,\r
3109 IN UINT8 StringFlags,\r
3110 IN UINT8 MinSize,\r
3111 IN UINT8 MaxSize,\r
3112 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3113 )\r
3114{\r
3115 EFI_IFR_STRING OpCode;\r
3116 UINTN Position;\r
3117\r
e22812c7 3118 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
7e3bcccb
LG		 3119\r
3120 ZeroMem (&OpCode, sizeof (OpCode));\r
3121 OpCode.Question.Header.Prompt = Prompt;\r
3122 OpCode.Question.Header.Help = Help;\r
3123 OpCode.Question.QuestionId = QuestionId;\r
3124 OpCode.Question.VarStoreId = VarStoreId;\r
3125 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3126 OpCode.Question.Flags = QuestionFlags;\r
3127 OpCode.MinSize = MinSize;\r
3128 OpCode.MaxSize = MaxSize;\r
3129 OpCode.Flags = (UINT8) (StringFlags & EFI_IFR_STRING_MULTI_LINE);\r
3130\r
3131 if (DefaultsOpCodeHandle == NULL) {\r
3132 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_STRING_OP, sizeof (OpCode));\r
3133 }\r
3134\r
3135 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3136 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_STRING_OP, sizeof (OpCode), 0, 1);\r
3137 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3138 HiiCreateEndOpCode (OpCodeHandle);\r
3139 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3140}\r
3141\r
3142/**\r
3143 Create EFI_IFR_ONE_OF_OP opcode.\r
3144\r
3145 If OpCodeHandle is NULL, then ASSERT().\r
3146 If any reserved bits are set in QuestionFlags, then ASSERT().\r
3147 If any reserved bits are set in OneOfFlags, then ASSERT().\r
3148\r
3149 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3150 @param[in] QuestionId Question ID\r
3151 @param[in] VarStoreId Storage ID\r
3152 @param[in] VarOffset Offset in Storage\r
3153 @param[in] Prompt String ID for Prompt\r
3154 @param[in] Help String ID for Help\r
3155 @param[in] QuestionFlags Flags in Question Header\r
3156 @param[in] OneOfFlags Flags for oneof opcode\r
3157 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.\r
3158 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3159 is an optional parameter that may be NULL.\r
3160\r
3161 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3162 @retval Other A pointer to the created opcode.\r
3163\r
3164**/\r
3165UINT8 *\r
3166EFIAPI\r
3167HiiCreateOneOfOpCode (\r
3168 IN VOID *OpCodeHandle,\r
3169 IN EFI_QUESTION_ID QuestionId,\r
3170 IN EFI_VARSTORE_ID VarStoreId,\r
3171 IN UINT16 VarOffset,\r
3172 IN EFI_STRING_ID Prompt,\r
3173 IN EFI_STRING_ID Help,\r
3174 IN UINT8 QuestionFlags,\r
3175 IN UINT8 OneOfFlags,\r
3176 IN VOID *OptionsOpCodeHandle,\r
3177 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3178 )\r
3179{\r
3180 EFI_IFR_ONE_OF OpCode;\r
3181 UINTN Position;\r
3182\r
3183 ASSERT (OptionsOpCodeHandle != NULL);\r
3184 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY))) == 0);\r
3185\r
3186 ZeroMem (&OpCode, sizeof (OpCode));\r
3187 OpCode.Question.Header.Prompt = Prompt;\r
3188 OpCode.Question.Header.Help = Help;\r
3189 OpCode.Question.QuestionId = QuestionId;\r
3190 OpCode.Question.VarStoreId = VarStoreId;\r
3191 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3192 OpCode.Question.Flags = QuestionFlags;\r
3193 OpCode.Flags = OneOfFlags;\r
3194\r
3195 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3196 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_ONE_OF_OP, sizeof (OpCode), 0, 1);\r
3197 InternalHiiAppendOpCodes (OpCodeHandle, OptionsOpCodeHandle);\r
3198 if (DefaultsOpCodeHandle != NULL) {\r
3199 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3200 }\r
3201 HiiCreateEndOpCode (OpCodeHandle);\r
3202 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3203}\r
3204\r
3205/**\r
3206 Create EFI_IFR_ORDERED_LIST_OP opcode.\r
3207\r
3208 If OpCodeHandle is NULL, then ASSERT().\r
3209 If any reserved bits are set in QuestionFlags, then ASSERT().\r
3210 If any reserved bits are set in OrderedListFlags, then ASSERT().\r
3211\r
3212 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3213 @param[in] QuestionId Question ID\r
3214 @param[in] VarStoreId Storage ID\r
3215 @param[in] VarOffset Offset in Storage\r
3216 @param[in] Prompt String ID for Prompt\r
3217 @param[in] Help String ID for Help\r
3218 @param[in] QuestionFlags Flags in Question Header\r
3219 @param[in] OrderedListFlags Flags for ordered list opcode\r
3220 @param[in] DataType Type for option value\r
3221 @param[in] MaxContainers Maximum count for options in this ordered list\r
3222 @param[in] OptionsOpCodeHandle Handle for a buffer of ONE_OF_OPTION opcodes.\r
3223 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3224 is an optional parameter that may be NULL.\r
3225\r
3226 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3227 @retval Other A pointer to the created opcode.\r
3228\r
3229**/\r
3230UINT8 *\r
3231EFIAPI\r
3232HiiCreateOrderedListOpCode (\r
3233 IN VOID *OpCodeHandle,\r
3234 IN EFI_QUESTION_ID QuestionId,\r
3235 IN EFI_VARSTORE_ID VarStoreId,\r
3236 IN UINT16 VarOffset,\r
3237 IN EFI_STRING_ID Prompt,\r
3238 IN EFI_STRING_ID Help,\r
3239 IN UINT8 QuestionFlags,\r
3240 IN UINT8 OrderedListFlags,\r
3241 IN UINT8 DataType,\r
3242 IN UINT8 MaxContainers,\r
3243 IN VOID *OptionsOpCodeHandle,\r
3244 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3245 )\r
3246{\r
3247 EFI_IFR_ORDERED_LIST OpCode;\r
3248 UINTN Position;\r
3249\r
3250 ASSERT (OptionsOpCodeHandle != NULL);\r
3251 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY))) == 0);\r
3252\r
3253 ZeroMem (&OpCode, sizeof (OpCode));\r
3254 OpCode.Question.Header.Prompt = Prompt;\r
3255 OpCode.Question.Header.Help = Help;\r
3256 OpCode.Question.QuestionId = QuestionId;\r
3257 OpCode.Question.VarStoreId = VarStoreId;\r
3258 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3259 OpCode.Question.Flags = QuestionFlags;\r
3260 OpCode.MaxContainers = MaxContainers;\r
3261 OpCode.Flags = OrderedListFlags;\r
3262\r
3263 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3264 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_ORDERED_LIST_OP, sizeof (OpCode), 0, 1);\r
3265 InternalHiiAppendOpCodes (OpCodeHandle, OptionsOpCodeHandle);\r
3266 if (DefaultsOpCodeHandle != NULL) {\r
3267 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3268 }\r
3269 HiiCreateEndOpCode (OpCodeHandle);\r
e22812c7
LG		 3270 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3271}\r
3272\r
3273/**\r
3274 Create EFI_IFR_TEXT_OP opcode.\r
3275\r
3276 If OpCodeHandle is NULL, then ASSERT().\r
3277\r
3278 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3279 @param[in] Prompt String ID for Prompt.\r
3280 @param[in] Help String ID for Help.\r
3281 @param[in] TextTwo String ID for TextTwo.\r
3282\r
3283 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3284 @retval Other A pointer to the created opcode.\r
3285\r
3286**/\r
3287UINT8 *\r
3288EFIAPI\r
3289HiiCreateTextOpCode (\r
3290 IN VOID *OpCodeHandle,\r
3291 IN EFI_STRING_ID Prompt,\r
3292 IN EFI_STRING_ID Help,\r
3293 IN EFI_STRING_ID TextTwo\r
3294 )\r
3295{\r
3296 EFI_IFR_TEXT OpCode;\r
3297\r
3298 ZeroMem (&OpCode, sizeof (OpCode));\r
3299 OpCode.Statement.Prompt = Prompt;\r
3300 OpCode.Statement.Help = Help;\r
3301 OpCode.TextTwo = TextTwo;\r
3302\r
3303 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_TEXT_OP, sizeof (OpCode));\r
3304}\r
3305\r
3306/**\r
3307 Create EFI_IFR_DATE_OP opcode.\r
3308\r
3309 If OpCodeHandle is NULL, then ASSERT().\r
3310 If any reserved bits are set in QuestionFlags, then ASSERT().\r
3311 If any reserved bits are set in DateFlags, then ASSERT().\r
3312\r
3313 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3314 @param[in] QuestionId Question ID\r
3315 @param[in] VarStoreId Storage ID, optional. If DateFlags is not\r
3316 QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
3317 @param[in] VarOffset Offset in Storage, optional. If DateFlags is not\r
3318 QF_DATE_STORAGE_NORMAL, this parameter is ignored.\r
3319 @param[in] Prompt String ID for Prompt\r
3320 @param[in] Help String ID for Help\r
3321 @param[in] QuestionFlags Flags in Question Header\r
3322 @param[in] DateFlags Flags for date opcode\r
3323 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3324 is an optional parameter that may be NULL.\r
3325\r
3326 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3327 @retval Other A pointer to the created opcode.\r
3328\r
3329**/\r
3330UINT8 *\r
3331EFIAPI\r
3332HiiCreateDateOpCode (\r
3333 IN VOID *OpCodeHandle,\r
3334 IN EFI_QUESTION_ID QuestionId,\r
3335 IN EFI_VARSTORE_ID VarStoreId, OPTIONAL\r
3336 IN UINT16 VarOffset, OPTIONAL\r
3337 IN EFI_STRING_ID Prompt,\r
3338 IN EFI_STRING_ID Help,\r
3339 IN UINT8 QuestionFlags,\r
3340 IN UINT8 DateFlags,\r
3341 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3342 )\r
3343{\r
3344 EFI_IFR_DATE OpCode;\r
3345 UINTN Position;\r
3346\r
3347 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
3348 ASSERT ((DateFlags & (~(EFI_QF_DATE_YEAR_SUPPRESS | EFI_QF_DATE_MONTH_SUPPRESS | EFI_QF_DATE_DAY_SUPPRESS | EFI_QF_DATE_STORAGE))) == 0);\r
3349\r
3350 ZeroMem (&OpCode, sizeof (OpCode));\r
3351 OpCode.Question.Header.Prompt = Prompt;\r
3352 OpCode.Question.Header.Help = Help;\r
3353 OpCode.Question.QuestionId = QuestionId;\r
3354 OpCode.Question.VarStoreId = VarStoreId;\r
3355 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3356 OpCode.Question.Flags = QuestionFlags;\r
3357 OpCode.Flags = DateFlags;\r
3358\r
3359 if (DefaultsOpCodeHandle == NULL) {\r
3360 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_DATE_OP, sizeof (OpCode));\r
3361 }\r
3362\r
3363 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3364 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_DATE_OP, sizeof (OpCode), 0, 1);\r
3365 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3366 HiiCreateEndOpCode (OpCodeHandle);\r
3367 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3368}\r
3369\r
3370/**\r
3371 Create EFI_IFR_TIME_OP opcode.\r
3372\r
3373 If OpCodeHandle is NULL, then ASSERT().\r
3374 If any reserved bits are set in QuestionFlags, then ASSERT().\r
3375 If any reserved bits are set in TimeFlags, then ASSERT().\r
3376\r
3377 @param[in] OpCodeHandle Handle to the buffer of opcodes.\r
3378 @param[in] QuestionId Question ID\r
3379 @param[in] VarStoreId Storage ID, optional. If TimeFlags is not\r
3380 QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
3381 @param[in] VarOffset Offset in Storage, optional. If TimeFlags is not\r
3382 QF_TIME_STORAGE_NORMAL, this parameter is ignored.\r
3383 @param[in] Prompt String ID for Prompt\r
3384 @param[in] Help String ID for Help\r
3385 @param[in] QuestionFlags Flags in Question Header\r
3386 @param[in] TimeFlags Flags for time opcode\r
3387 @param[in] DefaultsOpCodeHandle Handle for a buffer of DEFAULT opcodes. This\r
3388 is an optional parameter that may be NULL.\r
3389\r
3390 @retval NULL There is not enough space left in Buffer to add the opcode.\r
3391 @retval Other A pointer to the created opcode.\r
3392\r
3393**/\r
3394UINT8 *\r
3395EFIAPI\r
3396HiiCreateTimeOpCode (\r
3397 IN VOID *OpCodeHandle,\r
3398 IN EFI_QUESTION_ID QuestionId,\r
3399 IN EFI_VARSTORE_ID VarStoreId, OPTIONAL\r
3400 IN UINT16 VarOffset, OPTIONAL\r
3401 IN EFI_STRING_ID Prompt,\r
3402 IN EFI_STRING_ID Help,\r
3403 IN UINT8 QuestionFlags,\r
3404 IN UINT8 TimeFlags,\r
3405 IN VOID *DefaultsOpCodeHandle OPTIONAL\r
3406 )\r
3407{\r
3408 EFI_IFR_TIME OpCode;\r
3409 UINTN Position;\r
3410\r
3411 ASSERT ((QuestionFlags & (~(EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED))) == 0);\r
3412 ASSERT ((TimeFlags & (~(QF_TIME_HOUR_SUPPRESS | QF_TIME_MINUTE_SUPPRESS | QF_TIME_SECOND_SUPPRESS | QF_TIME_STORAGE))) == 0);\r
3413\r
3414 ZeroMem (&OpCode, sizeof (OpCode));\r
3415 OpCode.Question.Header.Prompt = Prompt;\r
3416 OpCode.Question.Header.Help = Help;\r
3417 OpCode.Question.QuestionId = QuestionId;\r
3418 OpCode.Question.VarStoreId = VarStoreId;\r
3419 OpCode.Question.VarStoreInfo.VarOffset = VarOffset;\r
3420 OpCode.Question.Flags = QuestionFlags;\r
3421 OpCode.Flags = TimeFlags;\r
3422\r
3423 if (DefaultsOpCodeHandle == NULL) {\r
3424 return InternalHiiCreateOpCode (OpCodeHandle, &OpCode, EFI_IFR_TIME_OP, sizeof (OpCode));\r
3425 }\r
3426\r
3427 Position = InternalHiiOpCodeHandlePosition (OpCodeHandle);\r
3428 InternalHiiCreateOpCodeExtended (OpCodeHandle, &OpCode, EFI_IFR_TIME_OP, sizeof (OpCode), 0, 1);\r
3429 InternalHiiAppendOpCodes (OpCodeHandle, DefaultsOpCodeHandle);\r
3430 HiiCreateEndOpCode (OpCodeHandle);\r
7e3bcccb
LG		 3431 return InternalHiiOpCodeHandleBuffer (OpCodeHandle) + Position;\r
3432}\r
3433\r
3434/**\r
3435 This is the internal worker function to update the data in\r
3436 a form specified by FormSetGuid, FormId and Label.\r
3437\r
84213069
LG		 3438 @param[in] FormSetGuid The optional Formset GUID.\r
3439 @param[in] FormId The Form ID.\r
3440 @param[in] Package The package header.\r
3441 @param[in] OpCodeBufferStart An OpCode buffer that contains the set of IFR \r
3442 opcodes to be inserted or replaced in the form.\r
3443 @param[in] OpCodeBufferEnd An OpCcode buffer that contains the IFR opcode\r
3444 that marks the end of a replace operation in the form.\r
3445 @param[out] TempPackage The resultant package.\r
7e3bcccb
LG		 3446\r
3447 @retval EFI_SUCCESS The function completes successfully.\r
84213069 3448 @retval EFI_NOT_FOUND The updated opcode or endopcode is not found.\r
7e3bcccb
LG		 3449\r
3450**/\r
3451EFI_STATUS\r
3452EFIAPI\r
3453InternalHiiUpdateFormPackageData (\r
3454 IN EFI_GUID *FormSetGuid, OPTIONAL\r
3455 IN EFI_FORM_ID FormId,\r
3456 IN EFI_HII_PACKAGE_HEADER *Package,\r
3457 IN HII_LIB_OPCODE_BUFFER *OpCodeBufferStart,\r
3458 IN HII_LIB_OPCODE_BUFFER *OpCodeBufferEnd, OPTIONAL\r
3459 OUT EFI_HII_PACKAGE_HEADER *TempPackage\r
3460 )\r
3461{\r
3462 UINTN AddSize;\r
3463 UINT8 *BufferPos;\r
3464 EFI_HII_PACKAGE_HEADER PackageHeader;\r
3465 UINTN Offset;\r
3466 EFI_IFR_OP_HEADER *IfrOpHdr;\r
3467 EFI_IFR_OP_HEADER *UpdateIfrOpHdr;\r
3468 BOOLEAN GetFormSet;\r
3469 BOOLEAN GetForm;\r
3470 BOOLEAN Updated;\r
d91c7bf9 3471 UINTN UpdatePackageLength;\r
7e3bcccb
LG		 3472\r
3473 CopyMem (TempPackage, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
3474 UpdatePackageLength = sizeof (EFI_HII_PACKAGE_HEADER);\r
3475 BufferPos = (UINT8 *) (TempPackage + 1);\r
3476\r
3477 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
3478 IfrOpHdr = (EFI_IFR_OP_HEADER *)((UINT8 *) Package + sizeof (EFI_HII_PACKAGE_HEADER));\r
3479 Offset = sizeof (EFI_HII_PACKAGE_HEADER);\r
3480 GetFormSet = (BOOLEAN) ((FormSetGuid == NULL) ? TRUE : FALSE);\r
3481 GetForm = FALSE;\r
3482 Updated = FALSE;\r
3483\r
3484 while (Offset < PackageHeader.Length) {\r
3485 CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
3486 BufferPos += IfrOpHdr->Length;\r
3487 UpdatePackageLength += IfrOpHdr->Length;\r
3488 \r
3489 //\r
3490 // Find the matched FormSet and Form\r
3491 //\r
3492 if ((IfrOpHdr->OpCode == EFI_IFR_FORM_SET_OP) && (FormSetGuid != NULL)) {\r
3493 if (CompareGuid((GUID *)(VOID *)&((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, FormSetGuid)) {\r
3494 GetFormSet = TRUE;\r
3495 } else {\r
3496 GetFormSet = FALSE;\r
3497 }\r
2573712e 3498 } else if (IfrOpHdr->OpCode == EFI_IFR_FORM_OP || IfrOpHdr->OpCode == EFI_IFR_FORM_MAP_OP) {\r
7e3bcccb
LG		 3499 if (CompareMem (&((EFI_IFR_FORM *) IfrOpHdr)->FormId, &FormId, sizeof (EFI_FORM_ID)) == 0) {\r
3500 GetForm = TRUE;\r
3501 } else {\r
3502 GetForm = FALSE;\r
3503 }\r
3504 }\r
3505 \r
3506 //\r
3507 // The matched Form is found, and Update data in this form\r
3508 //\r
d91c7bf9 3509 if (GetFormSet && GetForm) {\r
7e3bcccb
LG		 3510 UpdateIfrOpHdr = (EFI_IFR_OP_HEADER *) OpCodeBufferStart->Buffer;\r
3511 if ((UpdateIfrOpHdr->Length == IfrOpHdr->Length) && \\r
3512 (CompareMem (IfrOpHdr, UpdateIfrOpHdr, UpdateIfrOpHdr->Length) == 0)) {\r
3513 //\r
3514 // Remove the original data when End OpCode buffer exist.\r
3515 //\r
3516 if (OpCodeBufferEnd != NULL) {\r
3517 Offset += IfrOpHdr->Length;\r
3518 IfrOpHdr = (EFI_IFR_OP_HEADER *) ((UINT8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
3519 UpdateIfrOpHdr = (EFI_IFR_OP_HEADER *) OpCodeBufferEnd->Buffer;\r
3520 while (Offset < PackageHeader.Length) {\r
3521 //\r
3522 // Search the matched end opcode\r
3523 //\r
3524 if ((UpdateIfrOpHdr->Length == IfrOpHdr->Length) && \\r
3525 (CompareMem (IfrOpHdr, UpdateIfrOpHdr, UpdateIfrOpHdr->Length) == 0)) {\r
3526 break;\r
3527 }\r
3528 //\r
3529 // Go to the next Op-Code\r
3530 //\r
3531 Offset += IfrOpHdr->Length;\r
3532 IfrOpHdr = (EFI_IFR_OP_HEADER *) ((UINT8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
3533 }\r
3534 \r
3535 if (Offset >= PackageHeader.Length) {\r
3536 //\r
3537 // The end opcode is not found.\r
3538 //\r
3539 return EFI_NOT_FOUND;\r
3540 }\r
3541 }\r
d91c7bf9 3542\r
7e3bcccb
LG		 3543 //\r
3544 // Insert the updated data\r
3545 //\r
d91c7bf9
LG		 3546 AddSize = ((EFI_IFR_OP_HEADER *) OpCodeBufferStart->Buffer)->Length;\r
3547 CopyMem (BufferPos, OpCodeBufferStart->Buffer + AddSize, OpCodeBufferStart->Position - AddSize);\r
3548 BufferPos += OpCodeBufferStart->Position - AddSize;\r
3549 UpdatePackageLength += OpCodeBufferStart->Position - AddSize;\r
b8215f46 3550\r
7e3bcccb
LG		 3551 if (OpCodeBufferEnd != NULL) {\r
3552 //\r
3553 // Add the end opcode\r
3554 //\r
3555 CopyMem (BufferPos, IfrOpHdr, IfrOpHdr->Length);\r
3556 BufferPos += IfrOpHdr->Length;\r
3557 UpdatePackageLength += IfrOpHdr->Length;\r
3558 }\r
d91c7bf9
LG		 3559\r
3560 //\r
3561 // Copy the left package data.\r
3562 //\r
3563 Offset += IfrOpHdr->Length;\r
3564 CopyMem (BufferPos, (UINT8 *) Package + Offset, PackageHeader.Length - Offset);\r
3565 UpdatePackageLength += PackageHeader.Length - Offset;\r
3566\r
7e3bcccb
LG		 3567 //\r
3568 // Set update flag\r
3569 //\r
3570 Updated = TRUE;\r
d91c7bf9 3571 break;\r
7e3bcccb
LG		 3572 }\r
3573 }\r
3574\r
3575 //\r
3576 // Go to the next Op-Code\r
3577 //\r
3578 Offset += IfrOpHdr->Length;\r
3579 IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r
3580 }\r
3581 \r
3582 if (!Updated) {\r
3583 //\r
3584 // The updated opcode buffer is not found.\r
3585 //\r
3586 return EFI_NOT_FOUND;\r
3587 }\r
3588 //\r
3589 // Update the package length.\r
3590 //\r
d91c7bf9 3591 PackageHeader.Length = (UINT32) UpdatePackageLength;\r
7e3bcccb
LG		 3592 CopyMem (TempPackage, &PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));\r
3593\r
3594 return EFI_SUCCESS;\r
3595}\r
3596\r
3597/**\r
3598 This function updates a form that has previously been registered with the HII \r
3599 Database. This function will perform at most one update operation.\r
3600 \r
3601 The form to update is specified by Handle, FormSetGuid, and FormId. Binary \r
3602 comparisons of IFR opcodes are performed from the beginning of the form being \r
3603 updated until an IFR opcode is found that exactly matches the first IFR opcode \r
84213069 3604 specified by StartOpCodeHandle. The following rules are used to determine if\r
7e3bcccb
LG		 3605 an insert, replace, or delete operation is performed.\r
3606 \r
3607 1) If no matches are found, then NULL is returned. \r
3608 2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes\r
84213069
LG		 3609 from StartOpCodeHandle except the first opcode are inserted immediately after \r
3610 the matching IFR opcode in the form to be updated.\r
7e3bcccb 3611 3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made \r
84213069 3612 from the matching IFR opcode until an IFR opcode exactly matches the first \r
7e3bcccb
LG		 3613 IFR opcode specified by EndOpCodeHandle. If no match is found for the first\r
3614 IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match\r
3615 is found, then all of the IFR opcodes between the start match and the end \r
3616 match are deleted from the form being updated and all of the IFR opcodes\r
84213069 3617 from StartOpCodeHandle except the first opcode are inserted immediately after \r
7e3bcccb 3618 the matching start IFR opcode. If StartOpCcodeHandle only contains one\r
84213069 3619 IFR instruction, then the result of this operation will delete all of the IFR\r
7e3bcccb
LG		 3620 opcodes between the start end matches.\r
3621\r
3622 If HiiHandle is NULL, then ASSERT().\r
3623 If StartOpCodeHandle is NULL, then ASSERT().\r
3624\r
3625 @param[in] HiiHandle The HII Handle of the form to update.\r
3626 @param[in] FormSetGuid The Formset GUID of the form to update. This\r
3627 is an optional parameter that may be NULL.\r
3628 If it is NULL, all FormSet will be updated.\r
3629 @param[in] FormId The ID of the form to update.\r
3630 @param[in] StartOpCodeHandle An OpCode Handle that contains the set of IFR \r
3631 opcodes to be inserted or replaced in the form.\r
3632 The first IFR instruction in StartOpCodeHandle \r
3633 is used to find matching IFR opcode in the \r
3634 form. \r
3635 @param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode\r
3636 that marks the end of a replace operation in\r
3637 the form. This is an optional parameter that\r
3638 may be NULL. If it is NULL, then an the IFR\r
3639 opcodes specified by StartOpCodeHandle are \r
3640 inserted into the form.\r
3641 \r
3642 @retval EFI_OUT_OF_RESOURCES No enough memory resource is allocated.\r
3643 @retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND.\r
3644 1) The form specified by HiiHandle, FormSetGuid, \r
3645 and FormId could not be found in the HII Database.\r
3646 2) No IFR opcodes in the target form match the first\r
3647 IFR opcode in StartOpCodeHandle.\r
3648 3) EndOpCOde is not NULL, and no IFR opcodes in the \r
3649 target form following a matching start opcode match \r
3650 the first IFR opcode in EndOpCodeHandle.\r
3651 @retval EFI_SUCCESS The matched form is updated by StartOpcode.\r
3652\r
3653**/\r
3654EFI_STATUS\r
3655EFIAPI\r
3656HiiUpdateForm (\r
3657 IN EFI_HII_HANDLE HiiHandle, \r
3658 IN EFI_GUID *FormSetGuid, OPTIONAL\r
3659 IN EFI_FORM_ID FormId,\r
84213069
LG		 3660 IN VOID *StartOpCodeHandle,\r
3661 IN VOID *EndOpCodeHandle OPTIONAL\r
7e3bcccb
LG		 3662 )\r
3663{\r
3664 EFI_STATUS Status;\r
3665 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r
3666 UINT32 PackageListLength; \r
3667 UINT32 Offset;\r
3668 EFI_HII_PACKAGE_LIST_HEADER *UpdatePackageList;\r
3669 UINTN BufferSize;\r
3670 UINT8 *UpdateBufferPos;\r
3671 EFI_HII_PACKAGE_HEADER *Package;\r
3672 EFI_HII_PACKAGE_HEADER *TempPacakge;\r
3673 EFI_HII_PACKAGE_HEADER PackageHeader;\r
3674 BOOLEAN Updated;\r
3675 HII_LIB_OPCODE_BUFFER *OpCodeBufferStart;\r
3676 HII_LIB_OPCODE_BUFFER *OpCodeBufferEnd;\r
3677 \r
3678 //\r
3679 // Input update data can't be NULL.\r
3680 //\r
3681 ASSERT (HiiHandle != NULL);\r
84213069 3682 ASSERT (StartOpCodeHandle != NULL);\r
7e3bcccb
LG		 3683 UpdatePackageList = NULL;\r
3684 TempPacakge = NULL;\r
3685 HiiPackageList = NULL;\r
3686 \r
3687 //\r
84213069 3688 // Retrieve buffer data from Opcode Handle\r
7e3bcccb 3689 //\r
84213069
LG		 3690 OpCodeBufferStart = (HII_LIB_OPCODE_BUFFER *) StartOpCodeHandle;\r
3691 OpCodeBufferEnd = (HII_LIB_OPCODE_BUFFER *) EndOpCodeHandle;\r
7e3bcccb
LG		 3692 \r
3693 //\r
84213069 3694 // Get the original package list\r
7e3bcccb
LG		 3695 //\r
3696 BufferSize = 0;\r
3697 HiiPackageList = NULL;\r
3698 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, HiiHandle, &BufferSize, HiiPackageList);\r
3699 //\r
3700 // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.\r
3701 //\r
3702 if (Status != EFI_BUFFER_TOO_SMALL) {\r
3703 return Status;\r
3704 }\r
3705\r
3706 HiiPackageList = AllocatePool (BufferSize);\r
3707 if (HiiPackageList == NULL) {\r
3708 Status = EFI_OUT_OF_RESOURCES;\r
3709 goto Finish;\r
3710 }\r
3711\r
3712 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, HiiHandle, &BufferSize, HiiPackageList);\r
3713 if (EFI_ERROR (Status)) {\r
3714 goto Finish;\r
3715 }\r
3716\r
3717 //\r
3718 // Calculate and allocate space for retrieval of IFR data\r
3719 //\r
3720 BufferSize += OpCodeBufferStart->Position;\r
3721 UpdatePackageList = AllocateZeroPool (BufferSize);\r
3722 if (UpdatePackageList == NULL) {\r
3723 Status = EFI_OUT_OF_RESOURCES;\r
3724 goto Finish;\r
3725 }\r
3726 \r
3727 //\r
3728 // Allocate temp buffer to store the temp updated package buffer\r
3729 //\r
3730 TempPacakge = AllocateZeroPool (BufferSize);\r
3731 if (TempPacakge == NULL) {\r
3732 Status = EFI_OUT_OF_RESOURCES;\r
3733 goto Finish;\r
3734 }\r
3735\r
3736 UpdateBufferPos = (UINT8 *) UpdatePackageList;\r
3737\r
3738 //\r
3739 // Copy the package list header\r
3740 //\r
3741 CopyMem (UpdateBufferPos, HiiPackageList, sizeof (EFI_HII_PACKAGE_LIST_HEADER));\r
3742 UpdateBufferPos += sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
3743 \r
3744 //\r
84213069 3745 // Go through each package to find the matched package and update one by one\r
7e3bcccb
LG		 3746 //\r
3747 Updated = FALSE;\r
3748 Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r
3749 PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);\r
3750 while (Offset < PackageListLength) {\r
3751 Package = (EFI_HII_PACKAGE_HEADER *) (((UINT8 *) HiiPackageList) + Offset);\r
3752 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
3753 Offset += Package->Length;\r
3754\r
3755 if (Package->Type == EFI_HII_PACKAGE_FORMS) {\r
3756 //\r
3757 // Check this package is the matched package.\r
3758 //\r
3759 Status = InternalHiiUpdateFormPackageData (FormSetGuid, FormId, Package, OpCodeBufferStart, OpCodeBufferEnd, TempPacakge);\r
3760 //\r
84213069 3761 // The matched package is found. Its package buffer will be updated by the input new data.\r
7e3bcccb
LG		 3762 //\r
3763 if (!EFI_ERROR(Status)) {\r
3764 //\r
3765 // Set Update Flag\r
3766 // \r
3767 Updated = TRUE;\r
3768 //\r
3769 // Add updated package buffer\r
3770 //\r
3771 Package = TempPacakge;\r
3772 }\r
3773 }\r
3774\r
3775 //\r
3776 // Add pacakge buffer\r
3777 //\r
3778 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r
3779 CopyMem (UpdateBufferPos, Package, PackageHeader.Length);\r
3780 UpdateBufferPos += PackageHeader.Length;\r
3781 }\r
3782 \r
3783 if (Updated) {\r
3784 //\r
3785 // Update package list length\r
3786 //\r
3787 BufferSize = UpdateBufferPos - (UINT8 *) UpdatePackageList;\r
3788 WriteUnaligned32 (&UpdatePackageList->PackageLength, (UINT32) BufferSize);\r
3789 \r
3790 //\r
84213069 3791 // Update Package to show form\r
7e3bcccb
LG		 3792 //\r
3793 Status = gHiiDatabase->UpdatePackageList (gHiiDatabase, HiiHandle, UpdatePackageList);\r
3794 } else {\r
3795 //\r
3796 // Not matched form is found and updated.\r
3797 //\r
3798 Status = EFI_NOT_FOUND;\r
3799 }\r
3800\r
3801Finish:\r
3802 if (HiiPackageList != NULL) {\r
3803 FreePool (HiiPackageList);\r
3804 }\r
3805 \r
3806 if (UpdatePackageList != NULL) {\r
3807 FreePool (UpdatePackageList);\r
3808 }\r
3809 \r
3810 if (TempPacakge != NULL) {\r
3811 FreePool (TempPacakge);\r
3812 }\r
3813\r
3814 return Status; \r
3815}\r
EFI Development Kit II mirror for PVE