]>
Commit | Line | Data |
---|---|---|
286f0de7 | 1 | \r |
ebbd2793 | 2 | /**@file\r |
3 | This file contains functions related to Config Access Protocols installed by\r | |
4 | by HII Thunk Modules which is used to thunk UEFI Config Access Callback to \r | |
5 | Framework HII Callback.\r | |
6 | \r | |
7 | Copyright (c) 2008, Intel Corporation\r | |
8 | All rights reserved. This program and the accompanying materials\r | |
9 | are licensed and made available under the terms and conditions of the BSD License\r | |
10 | which accompanies this distribution. The full text of the license may be found at\r | |
11 | http://opensource.org/licenses/bsd-license.php\r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #include "HiiDatabase.h"\r | |
19 | \r | |
0368663f | 20 | BOOLEAN mHiiPackageListUpdated;\r |
21 | \r | |
22 | CONFIG_ACCESS_PRIVATE gConfigAccessPrivateTempate = {\r | |
23 | CONFIG_ACCESS_PRIVATE_SIGNATURE,\r | |
ebbd2793 | 24 | {\r |
25 | ThunkExtractConfig,\r | |
26 | ThunkRouteConfig,\r | |
27 | ThunkCallback\r | |
28 | }, //ConfigAccessProtocol\r | |
0368663f | 29 | NULL, //FormCallbackProtocol\r |
30 | {NULL, NULL}, //ConfigAccessStorageListHead\r | |
31 | NULL \r | |
ebbd2793 | 32 | };\r |
33 | \r | |
1a6cdbd9 | 34 | /**\r |
35 | Find and return the pointer to Package Header of the Form package\r | |
36 | in the Framework Package List. The Framework Package List is created\r | |
37 | by a module calling the Framework HII interface.\r | |
38 | The Framwork Package List contains package data \r | |
39 | generated by Intel's UEFI VFR Compiler and String gather tool. The data format\r | |
40 | of the package data is defined by TIANO_AUTOGEN_PACKAGES_HEADER.\r | |
41 | \r | |
42 | If the package list contains other type of packages such as KEYBOARD_LAYOUT,\r | |
43 | FONTS and IMAGES, the ASSERT. This is to make sure the caller is a \r | |
44 | Framework Module which does not include packages introduced by UEFI Specification\r | |
45 | or packages that is not supported by Thunk layer.\r | |
46 | \r | |
0368663f | 47 | @param Packages The Framework Package List\r |
1a6cdbd9 | 48 | \r |
0368663f | 49 | @retval EFI_HII_PACKAGE_HEADER* Return the Package Header of Form Package.\r |
50 | @retval NULL If no Form Package is found.\r | |
1a6cdbd9 | 51 | **/\r |
ebbd2793 | 52 | EFI_HII_PACKAGE_HEADER *\r |
53 | GetIfrFormSet (\r | |
54 | IN CONST EFI_HII_PACKAGES *Packages\r | |
55 | )\r | |
56 | {\r | |
57 | TIANO_AUTOGEN_PACKAGES_HEADER **TianoAutogenPackageHdrArray;\r | |
58 | EFI_HII_PACKAGE_HEADER *IfrPackage;\r | |
59 | UINTN Index;\r | |
60 | \r | |
61 | ASSERT (Packages != NULL);\r | |
62 | \r | |
63 | IfrPackage = NULL;\r | |
64 | \r | |
65 | TianoAutogenPackageHdrArray = (TIANO_AUTOGEN_PACKAGES_HEADER **) (((UINT8 *) &Packages->GuidId) + sizeof (Packages->GuidId));\r | |
66 | for (Index = 0; Index < Packages->NumberOfPackages; Index++) {\r | |
67 | //\r | |
68 | // BugBug: The current UEFI HII build tool generate a binary in the format defined in: \r | |
69 | // TIANO_AUTOGEN_PACKAGES_HEADER. We assume that all packages generated in\r | |
70 | // this binary is with same package type. So the returned IfrPackNum and StringPackNum\r | |
71 | // may not be the exact number of valid package number in the binary generated \r | |
72 | // by HII Build tool.\r | |
73 | //\r | |
74 | switch (TianoAutogenPackageHdrArray[Index]->PackageHeader.Type) {\r | |
4dd76ade | 75 | case EFI_HII_PACKAGE_FORMS:\r |
ebbd2793 | 76 | return &TianoAutogenPackageHdrArray[Index]->PackageHeader;\r |
77 | break;\r | |
78 | \r | |
79 | case EFI_HII_PACKAGE_STRINGS:\r | |
80 | case EFI_HII_PACKAGE_SIMPLE_FONTS:\r | |
81 | break;\r | |
82 | \r | |
83 | //\r | |
84 | // The following fonts are invalid for a module that using Framework to UEFI thunk layer.\r | |
85 | //\r | |
86 | case EFI_HII_PACKAGE_KEYBOARD_LAYOUT:\r | |
87 | case EFI_HII_PACKAGE_FONTS:\r | |
88 | case EFI_HII_PACKAGE_IMAGES:\r | |
89 | default:\r | |
90 | ASSERT (FALSE);\r | |
91 | break;\r | |
92 | }\r | |
93 | }\r | |
94 | \r | |
95 | return (EFI_HII_PACKAGE_HEADER *) NULL;\r | |
96 | }\r | |
97 | \r | |
1a6cdbd9 | 98 | /**\r |
99 | This function scan EFI_IFR_VARSTORE_OP in the Form Package.\r | |
100 | It create entries for these VARSTORE found and append the entry\r | |
101 | to a Link List.\r | |
102 | \r | |
103 | If FormSetPackage is not EFI_HII_PACKAGE_FORM, then ASSERT.\r | |
104 | If there is no linear buffer storage in this formset, then ASSERT.\r | |
105 | \r | |
0368663f | 106 | @param FormSetPackage The Form Package header.\r |
1a6cdbd9 | 107 | @param BufferStorageListHead The link list for the VARSTORE found in the form package.\r |
108 | \r | |
0368663f | 109 | @retval EFI_SUCCESS The function scan the form set and find one or more VARSTOREs.\r |
1a6cdbd9 | 110 | @retval EFI_OUT_OF_RESOURCES There is not enough memory to complete the function.\r |
111 | **/\r | |
ebbd2793 | 112 | EFI_STATUS\r |
113 | GetBufferStorage (\r | |
114 | IN CONST EFI_HII_PACKAGE_HEADER *FormSetPackage,\r | |
115 | OUT LIST_ENTRY *BufferStorageListHead\r | |
116 | )\r | |
117 | {\r | |
118 | UINTN OpCodeOffset;\r | |
119 | UINTN OpCodeLength;\r | |
120 | UINT8 *OpCodeData;\r | |
121 | UINT8 Operand;\r | |
122 | EFI_IFR_VARSTORE *VarStoreOpCode;\r | |
0368663f | 123 | BUFFER_STORAGE_ENTRY *BufferStorage;\r |
ebbd2793 | 124 | \r |
4dd76ade | 125 | ASSERT (FormSetPackage->Type == EFI_HII_PACKAGE_FORMS);\r |
1a6cdbd9 | 126 | \r |
ebbd2793 | 127 | OpCodeOffset = sizeof (EFI_HII_PACKAGE_HEADER);\r |
0368663f | 128 | //\r |
129 | // Scan all opcode for the FormSet Package for \r | |
130 | // EFI_IFR_VARSTORE_OP opcode.\r | |
131 | //\r | |
ebbd2793 | 132 | while (OpCodeOffset < FormSetPackage->Length) {\r |
133 | OpCodeData = (UINT8 *) FormSetPackage + OpCodeOffset;\r | |
134 | \r | |
135 | OpCodeLength = ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;\r | |
136 | OpCodeOffset += OpCodeLength;\r | |
137 | Operand = ((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode;\r | |
138 | \r | |
139 | if (Operand == EFI_IFR_VARSTORE_OP) {\r | |
140 | VarStoreOpCode = (EFI_IFR_VARSTORE *)OpCodeData;\r | |
0368663f | 141 | BufferStorage = AllocateZeroPool (sizeof (*BufferStorage));\r |
142 | if (BufferStorage == NULL) {\r | |
ebbd2793 | 143 | return EFI_OUT_OF_RESOURCES;\r |
144 | }\r | |
0368663f | 145 | //\r |
146 | // Record the attributes: GUID, Name, VarStoreId and Size.\r | |
147 | //\r | |
148 | CopyMem (&BufferStorage->Guid, &VarStoreOpCode->Guid, sizeof (EFI_GUID));\r | |
0915f6dc | 149 | \r |
0368663f | 150 | BufferStorage->Name = AllocateZeroPool (AsciiStrSize (VarStoreOpCode->Name) * 2);\r |
151 | AsciiStrToUnicodeStr (VarStoreOpCode->Name, BufferStorage->Name);\r | |
ebbd2793 | 152 | \r |
0368663f | 153 | BufferStorage->VarStoreId = VarStoreOpCode->VarStoreId;\r |
ebbd2793 | 154 | \r |
0368663f | 155 | BufferStorage->Size = VarStoreOpCode->Size;\r |
156 | BufferStorage->Signature = BUFFER_STORAGE_ENTRY_SIGNATURE;\r | |
ebbd2793 | 157 | \r |
0368663f | 158 | InsertTailList (BufferStorageListHead, &BufferStorage->Link);\r |
ebbd2793 | 159 | }\r |
160 | }\r | |
1a6cdbd9 | 161 | \r |
ebbd2793 | 162 | return EFI_SUCCESS;\r |
163 | }\r | |
0368663f | 164 | \r |
165 | \r | |
1a6cdbd9 | 166 | /**\r |
167 | This function installs a EFI_CONFIG_ACCESS_PROTOCOL instance for a form package registered\r | |
168 | by a module using Framework HII Protocol Interfaces.\r | |
169 | \r | |
170 | UEFI HII require EFI_HII_CONFIG_ACCESS_PROTOCOL to be installed on a EFI_HANDLE, so\r | |
171 | that Setup Utility can load the Buffer Storage using this protocol.\r | |
172 | \r | |
0368663f | 173 | @param Packages The framework package list.\r |
174 | @param ThunkContext The Thunk Layer Handle Mapping Database Entry.\r | |
1a6cdbd9 | 175 | \r |
0368663f | 176 | @retval EFI_SUCCESS The Config Access Protocol is installed successfully.\r |
177 | @retval EFI_OUT_RESOURCE There is not enough memory.\r | |
1a6cdbd9 | 178 | \r |
179 | **/\r | |
ebbd2793 | 180 | EFI_STATUS\r |
0368663f | 181 | InstallDefaultConfigAccessProtocol (\r |
182 | IN CONST EFI_HII_PACKAGES *Packages,\r | |
183 | IN OUT HII_THUNK_CONTEXT *ThunkContext\r | |
ebbd2793 | 184 | )\r |
185 | {\r | |
186 | EFI_HII_PACKAGE_HEADER *FormSetPackage;\r | |
187 | EFI_STATUS Status;\r | |
0368663f | 188 | CONFIG_ACCESS_PRIVATE *ConfigAccessInstance;\r |
ebbd2793 | 189 | \r |
0368663f | 190 | Status = HiiLibCreateHiiDriverHandle (&ThunkContext->UefiHiiDriverHandle);\r |
ebbd2793 | 191 | ConfigAccessInstance = AllocateCopyPool (\r |
0368663f | 192 | sizeof (CONFIG_ACCESS_PRIVATE), \r |
193 | &gConfigAccessPrivateTempate\r | |
ebbd2793 | 194 | );\r |
1a6cdbd9 | 195 | ASSERT (ConfigAccessInstance != NULL);\r |
0368663f | 196 | \r |
197 | InitializeListHead (&ConfigAccessInstance->BufferStorageListHead);\r | |
ebbd2793 | 198 | \r |
199 | //\r | |
200 | // We assume there is only one formset package in each Forms Package\r | |
201 | //\r | |
202 | FormSetPackage = GetIfrFormSet (Packages);\r | |
1a6cdbd9 | 203 | ASSERT (FormSetPackage != NULL);\r |
204 | \r | |
0368663f | 205 | Status = GetBufferStorage (FormSetPackage, &ConfigAccessInstance->BufferStorageListHead);\r |
ebbd2793 | 206 | if (EFI_ERROR (Status)) {\r |
207 | FreePool (ConfigAccessInstance);\r | |
208 | ASSERT (FALSE);\r | |
209 | return Status;\r | |
210 | }\r | |
211 | \r | |
212 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
0368663f | 213 | &ThunkContext->UefiHiiDriverHandle,\r |
ebbd2793 | 214 | &gEfiHiiConfigAccessProtocolGuid,\r |
215 | &ConfigAccessInstance->ConfigAccessProtocol,\r | |
216 | NULL\r | |
217 | );\r | |
0368663f | 218 | //\r |
219 | //BUGBUG: Remove when done.\r | |
220 | //\r | |
ebbd2793 | 221 | ASSERT_EFI_ERROR (Status);\r |
0368663f | 222 | \r |
ebbd2793 | 223 | if (EFI_ERROR (Status)) {\r |
224 | FreePool (ConfigAccessInstance);\r | |
225 | return Status;\r | |
226 | }\r | |
0368663f | 227 | \r |
228 | ConfigAccessInstance->ThunkContext = ThunkContext;\r | |
ebbd2793 | 229 | \r |
230 | return EFI_SUCCESS;\r | |
231 | }\r | |
232 | \r | |
0368663f | 233 | VOID\r |
234 | DestroyBufferStorageList (\r | |
235 | IN LIST_ENTRY *ListHead\r | |
236 | )\r | |
237 | {\r | |
238 | LIST_ENTRY *Link;\r | |
239 | BUFFER_STORAGE_ENTRY *Entry;\r | |
1a6cdbd9 | 240 | \r |
0368663f | 241 | while (!IsListEmpty (ListHead)) {\r |
242 | Link = GetFirstNode (ListHead);\r | |
243 | \r | |
244 | Entry = BUFFER_STORAGE_ENTRY_FROM_LINK(Link);\r | |
245 | \r | |
246 | FreePool (Entry->Name);\r | |
247 | Link = RemoveEntryList (Link);\r | |
248 | \r | |
249 | FreePool (Entry);\r | |
250 | }\r | |
251 | }\r | |
252 | \r | |
253 | VOID\r | |
254 | UninstallDefaultConfigAccessProtocol (\r | |
255 | IN HII_THUNK_CONTEXT *ThunkContext\r | |
ebbd2793 | 256 | )\r |
257 | {\r | |
0368663f | 258 | EFI_STATUS Status;\r |
259 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
260 | CONFIG_ACCESS_PRIVATE *ConfigAccessInstance;\r | |
261 | \r | |
262 | HiiLibDestroyHiiDriverHandle (ThunkContext->UefiHiiDriverHandle);\r | |
263 | \r | |
264 | Status = gBS->HandleProtocol (\r | |
265 | ThunkContext->UefiHiiDriverHandle,\r | |
266 | &gEfiHiiConfigAccessProtocolGuid,\r | |
267 | (VOID **) &ConfigAccess\r | |
268 | );\r | |
269 | \r | |
270 | ASSERT_EFI_ERROR (Status);\r | |
271 | \r | |
272 | Status = gBS->UninstallProtocolInterface (\r | |
273 | ThunkContext->UefiHiiDriverHandle,\r | |
274 | &gEfiHiiConfigAccessProtocolGuid,\r | |
275 | ConfigAccess\r | |
276 | );\r | |
277 | ASSERT_EFI_ERROR (Status);\r | |
278 | \r | |
279 | ConfigAccessInstance = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (ConfigAccess);\r | |
280 | \r | |
281 | DestroyBufferStorageList (&ConfigAccessInstance->BufferStorageListHead);\r | |
ebbd2793 | 282 | \r |
ebbd2793 | 283 | }\r |
0368663f | 284 | \r |
ebbd2793 | 285 | \r |
1a6cdbd9 | 286 | /**\r |
287 | Wrap the EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig to a call to EFI_FORM_CALLBACK_PROTOCOL.NvRead.\r | |
288 | \r | |
0368663f | 289 | @param BufferStorage The key with all attributes needed to call EFI_FORM_CALLBACK_PROTOCOL.NvRead.\r |
290 | @param FwFormCallBack The EFI_FORM_CALLBACK_PROTOCOL registered by Framework HII module.\r | |
291 | @param Data The data read.\r | |
292 | @param DataSize The size of data.\r | |
1a6cdbd9 | 293 | \r |
0368663f | 294 | @retval EFI_STATUS The status returned by the EFI_FORM_CALLBACK_PROTOCOL.NvWrite.\r |
1a6cdbd9 | 295 | @retval EFI_INVALID_PARAMETER If the EFI_FORM_CALLBACK_PROTOCOL.NvRead return the size information of the data\r |
0368663f | 296 | does not match what has been recorded early in he BUFFER_STORAGE_ENTRY.\r |
1a6cdbd9 | 297 | **/\r |
ebbd2793 | 298 | EFI_STATUS\r |
0368663f | 299 | CallFormCallBack (\r |
300 | IN BUFFER_STORAGE_ENTRY *BufferStorage,\r | |
301 | IN EFI_FORM_CALLBACK_PROTOCOL *FwFormCallBack,\r | |
ebbd2793 | 302 | OUT VOID **Data,\r |
303 | OUT UINTN *DataSize\r | |
304 | )\r | |
305 | {\r | |
306 | EFI_STATUS Status;\r | |
307 | \r | |
308 | *DataSize = 0;\r | |
309 | *Data = NULL;\r | |
310 | \r | |
0368663f | 311 | Status = FwFormCallBack->NvRead (\r |
312 | FwFormCallBack, \r | |
313 | BufferStorage->Name,\r | |
314 | &BufferStorage->Guid,\r | |
ebbd2793 | 315 | NULL,\r |
316 | DataSize,\r | |
317 | *Data\r | |
318 | );\r | |
319 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
0368663f | 320 | if (BufferStorage->Size != *DataSize) {\r |
ebbd2793 | 321 | ASSERT (FALSE);\r |
322 | return EFI_INVALID_PARAMETER;\r | |
323 | }\r | |
324 | \r | |
325 | *Data = AllocateZeroPool (*DataSize);\r | |
326 | if (Data == NULL) {\r | |
327 | return EFI_OUT_OF_RESOURCES;\r | |
328 | }\r | |
329 | \r | |
0368663f | 330 | FwFormCallBack->NvRead (\r |
331 | FwFormCallBack, \r | |
332 | BufferStorage->Name,\r | |
333 | &BufferStorage->Guid,\r | |
ebbd2793 | 334 | NULL,\r |
335 | DataSize,\r | |
336 | *Data\r | |
337 | );\r | |
338 | }\r | |
339 | \r | |
340 | return Status;\r | |
341 | }\r | |
342 | \r | |
1a6cdbd9 | 343 | \r |
344 | /**\r | |
345 | Wrap the EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig to a call to UEFI Variable Get Service.\r | |
346 | \r | |
0368663f | 347 | @param BufferStorage The key with all attributes needed to call a UEFI Variable Get Service.\r |
348 | @param Data The data read.\r | |
349 | @param DataSize The size of data.\r | |
1a6cdbd9 | 350 | \r |
351 | If the UEFI Variable Get Service return the size information of the data\r | |
0368663f | 352 | does not match what has been recorded early in he BUFFER_STORAGE_ENTRY.\r |
1a6cdbd9 | 353 | then ASSERT.\r |
354 | \r | |
0368663f | 355 | @retval EFI_STATUS The status returned by the UEFI Variable Get Service.\r |
1a6cdbd9 | 356 | @retval EFI_INVALID_PARAMETER If the UEFI Variable Get Service return the size information of the data\r |
0368663f | 357 | does not match what has been recorded early in he BUFFER_STORAGE_ENTRY.\r |
1a6cdbd9 | 358 | **/\r |
359 | \r | |
ebbd2793 | 360 | EFI_STATUS\r |
0368663f | 361 | GetUefiVariable (\r |
362 | IN BUFFER_STORAGE_ENTRY *BufferStorage,\r | |
ebbd2793 | 363 | OUT VOID **Data,\r |
364 | OUT UINTN *DataSize\r | |
365 | )\r | |
366 | {\r | |
367 | EFI_STATUS Status;\r | |
368 | \r | |
369 | *DataSize = 0;\r | |
370 | *Data = NULL;\r | |
371 | Status = gRT->GetVariable (\r | |
0368663f | 372 | BufferStorage->Name,\r |
373 | &BufferStorage->Guid,\r | |
ebbd2793 | 374 | NULL,\r |
375 | DataSize,\r | |
376 | *Data\r | |
377 | );\r | |
378 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
379 | \r | |
0368663f | 380 | if (BufferStorage->Size != *DataSize) {\r |
ebbd2793 | 381 | ASSERT (FALSE);\r |
382 | return EFI_INVALID_PARAMETER;\r | |
383 | }\r | |
384 | \r | |
385 | *Data = AllocateZeroPool (*DataSize);\r | |
386 | if (Data == NULL) {\r | |
387 | return EFI_OUT_OF_RESOURCES;\r | |
388 | }\r | |
389 | \r | |
390 | Status = gRT->GetVariable (\r | |
0368663f | 391 | BufferStorage->Name,\r |
392 | &BufferStorage->Guid,\r | |
ebbd2793 | 393 | NULL,\r |
394 | DataSize,\r | |
395 | *Data\r | |
396 | );\r | |
397 | }\r | |
398 | \r | |
399 | return Status;\r | |
400 | }\r | |
401 | \r | |
a3318eaf | 402 | BUFFER_STORAGE_ENTRY *\r |
403 | GetBufferStorageEntry (\r | |
404 | IN CONFIG_ACCESS_PRIVATE *ConfigAccess,\r | |
405 | IN UINT16 VarStoreId\r | |
406 | )\r | |
407 | {\r | |
408 | LIST_ENTRY *Link;\r | |
409 | BUFFER_STORAGE_ENTRY *BufferStorage;\r | |
410 | \r | |
411 | Link = GetFirstNode (&ConfigAccess->BufferStorageListHead);\r | |
412 | \r | |
413 | while (!IsNull (&ConfigAccess->BufferStorageListHead, Link)) {\r | |
414 | BufferStorage = BUFFER_STORAGE_ENTRY_FROM_LINK (Link);\r | |
415 | \r | |
416 | if (BufferStorage->VarStoreId == VarStoreId) {\r | |
417 | return BufferStorage;\r | |
418 | }\r | |
419 | \r | |
420 | Link = GetNextNode (&ConfigAccess->BufferStorageListHead, Link);\r | |
421 | }\r | |
422 | \r | |
423 | return NULL;\r | |
424 | }\r | |
425 | \r | |
426 | \r | |
1a6cdbd9 | 427 | /**\r |
428 | \r | |
429 | This function implement the EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig\r | |
430 | so that data can be read from the data storage such as UEFI Variable or module's\r | |
431 | customized storage exposed by EFI_FRAMEWORK_CALLBACK.\r | |
432 | \r | |
0368663f | 433 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL\r |
1a6cdbd9 | 434 | @param Request A null-terminated Unicode string in <ConfigRequest> format. Note that this\r |
0368663f | 435 | includes the routing information as well as the configurable name / value pairs. It is\r |
436 | invalid for this string to be in <MultiConfigRequest> format.\r | |
1a6cdbd9 | 437 | \r |
0368663f | 438 | @param Progress On return, points to a character in the Request string. Points to the string's null\r |
439 | terminator if request was successful. Points to the most recent '&' before the first\r | |
440 | failing name / value pair (or the beginning of the string if the failure is in the first\r | |
441 | name / value pair) if the request was not successful\r | |
1a6cdbd9 | 442 | @param Results A null-terminated Unicode string in <ConfigAltResp> format which has all\r |
0368663f | 443 | values filled in for the names in the Request string. String to be allocated by the called\r |
444 | function.\r | |
1a6cdbd9 | 445 | \r |
446 | @retval EFI_INVALID_PARAMETER If there is no Buffer Storage for this Config Access instance.\r | |
0368663f | 447 | @retval EFI_SUCCESS The setting is retrived successfully.\r |
448 | @retval !EFI_SUCCESS The error returned by UEFI Get Variable or Framework Form Callback Nvread.\r | |
1a6cdbd9 | 449 | **/\r |
ebbd2793 | 450 | EFI_STATUS\r |
451 | EFIAPI\r | |
452 | ThunkExtractConfig (\r | |
453 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
454 | IN CONST EFI_STRING Request,\r | |
455 | OUT EFI_STRING *Progress,\r | |
456 | OUT EFI_STRING *Results\r | |
457 | )\r | |
458 | {\r | |
459 | EFI_STATUS Status;\r | |
0368663f | 460 | CONFIG_ACCESS_PRIVATE *ConfigAccess;\r |
133a9dfb | 461 | BUFFER_STORAGE_ENTRY *BufferStorage;\r |
ebbd2793 | 462 | VOID *Data;\r |
463 | UINTN DataSize;\r | |
464 | \r | |
465 | Data = NULL;\r | |
0368663f | 466 | ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r |
ebbd2793 | 467 | \r |
1a6cdbd9 | 468 | //\r |
469 | // For now, only one var varstore is supported so that we don't need to parse the Configuration string.\r | |
470 | //\r | |
a3318eaf | 471 | BufferStorage = GetBufferStorageEntry (ConfigAccess, (UINT16) RESERVED_VARSTORE_ID);\r |
ebbd2793 | 472 | \r |
133a9dfb | 473 | if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r |
474 | if (ConfigAccess->FormCallbackProtocol == NULL ||\r | |
475 | ConfigAccess->FormCallbackProtocol->NvRead == NULL) {\r | |
476 | Status = GetUefiVariable (\r | |
477 | BufferStorage,\r | |
478 | &Data,\r | |
479 | &DataSize\r | |
480 | );\r | |
481 | } else {\r | |
482 | Status = CallFormCallBack (\r | |
483 | BufferStorage,\r | |
484 | ConfigAccess->FormCallbackProtocol,\r | |
485 | &Data,\r | |
486 | &DataSize\r | |
487 | );\r | |
488 | }\r | |
ebbd2793 | 489 | } else {\r |
133a9dfb | 490 | DataSize = BufferStorage->Size;\r |
491 | Data = AllocateCopyPool (DataSize, ConfigAccess->ThunkContext->NvMapOverride);\r | |
492 | \r | |
493 | if (Data != NULL) {\r | |
494 | Status = EFI_SUCCESS;\r | |
495 | } else {\r | |
496 | Status = EFI_OUT_OF_RESOURCES;\r | |
497 | }\r | |
ebbd2793 | 498 | }\r |
499 | \r | |
500 | if (!EFI_ERROR (Status)) {\r | |
59336178 | 501 | Status = mHiiConfigRoutingProtocol->BlockToConfig (\r |
502 | mHiiConfigRoutingProtocol,\r | |
ebbd2793 | 503 | Request,\r |
504 | Data,\r | |
505 | DataSize,\r | |
506 | Results,\r | |
507 | Progress\r | |
508 | );\r | |
509 | }\r | |
510 | \r | |
7001eaf8 | 511 | if (Data != NULL) {\r |
512 | FreePool (Data);\r | |
513 | }\r | |
ebbd2793 | 514 | return Status;\r |
515 | }\r | |
516 | \r | |
1a6cdbd9 | 517 | /**\r |
518 | \r | |
519 | This function implement the EFI_HII_CONFIG_ACCESS_PROTOCOL.RouteConfig\r | |
520 | so that data can be written to the data storage such as UEFI Variable or module's\r | |
521 | customized storage exposed by EFI_FRAMEWORK_CALLBACK.\r | |
522 | \r | |
0368663f | 523 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL\r |
524 | @param Configuration A null-terminated Unicode string in <ConfigResp> format.\r | |
fd0d281b | 525 | @param Progress A pointer to a string filled in with the offset of the most recent '&' before the first\r |
0368663f | 526 | failing name / value pair (or the beginning of the string if the failure is in the first\r |
527 | name / value pair) or the terminating NULL if all was successful.\r | |
1a6cdbd9 | 528 | \r |
529 | @retval EFI_INVALID_PARAMETER If there is no Buffer Storage for this Config Access instance.\r | |
0368663f | 530 | @retval EFI_SUCCESS The setting is saved successfully.\r |
531 | @retval !EFI_SUCCESS The error returned by UEFI Set Variable or Framework Form Callback Nvwrite.\r | |
1a6cdbd9 | 532 | **/ \r |
ebbd2793 | 533 | EFI_STATUS\r |
534 | EFIAPI\r | |
535 | ThunkRouteConfig (\r | |
536 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
537 | IN CONST EFI_STRING Configuration,\r | |
538 | OUT EFI_STRING *Progress\r | |
539 | )\r | |
540 | {\r | |
541 | EFI_STATUS Status;\r | |
0368663f | 542 | CONFIG_ACCESS_PRIVATE *ConfigAccess;\r |
0368663f | 543 | BUFFER_STORAGE_ENTRY *BufferStorage;\r |
544 | UINT8 *Data;\r | |
ebbd2793 | 545 | UINTN DataSize;\r |
0368663f | 546 | UINTN DataSize2;\r |
ebbd2793 | 547 | UINTN LastModifiedByteIndex;\r |
0368663f | 548 | BOOLEAN ResetRequired;\r |
549 | BOOLEAN DataAllocated;\r | |
ebbd2793 | 550 | \r |
551 | Data = NULL;\r | |
0368663f | 552 | ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r |
ebbd2793 | 553 | \r |
1a6cdbd9 | 554 | //\r |
555 | // For now, only one var varstore is supported so that we don't need to parse the Configuration string.\r | |
556 | //\r | |
a3318eaf | 557 | BufferStorage = GetBufferStorageEntry (ConfigAccess, (UINT16) RESERVED_VARSTORE_ID);\r |
ebbd2793 | 558 | \r |
0368663f | 559 | DataSize2 = BufferStorage->Size;\r |
560 | if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r | |
133a9dfb | 561 | DataAllocated = TRUE;\r |
0368663f | 562 | if (ConfigAccess->FormCallbackProtocol == NULL ||\r |
563 | ConfigAccess->FormCallbackProtocol->NvRead == NULL) {\r | |
564 | Status = GetUefiVariable (\r | |
565 | BufferStorage,\r | |
566 | &Data,\r | |
567 | &DataSize\r | |
568 | );\r | |
0368663f | 569 | } else {\r |
570 | Status = CallFormCallBack (\r | |
571 | BufferStorage,\r | |
572 | ConfigAccess->FormCallbackProtocol,\r | |
573 | &Data,\r | |
574 | &DataSize\r | |
575 | );\r | |
0368663f | 576 | }\r |
577 | } else {\r | |
133a9dfb | 578 | //\r |
579 | // ConfigToBlock will convert the Config String and update the NvMapOverride accordingly.\r | |
580 | //\r | |
0368663f | 581 | Status = EFI_SUCCESS;\r |
582 | Data = ConfigAccess->ThunkContext->NvMapOverride;\r | |
583 | DataSize = DataSize2;\r | |
584 | DataAllocated = FALSE;\r | |
585 | } \r | |
133a9dfb | 586 | if (EFI_ERROR (Status) || (DataSize2 != DataSize)) {\r |
587 | if (Data == NULL) {\r | |
588 | Data = AllocateZeroPool (DataSize2);\r | |
589 | }\r | |
ebbd2793 | 590 | }\r |
0368663f | 591 | \r |
59336178 | 592 | Status = mHiiConfigRoutingProtocol->ConfigToBlock (\r |
593 | mHiiConfigRoutingProtocol,\r | |
ebbd2793 | 594 | Configuration,\r |
595 | Data,\r | |
596 | &LastModifiedByteIndex,\r | |
597 | Progress\r | |
598 | );\r | |
ebbd2793 | 599 | if (EFI_ERROR (Status)) {\r |
600 | goto Done;\r | |
601 | }\r | |
602 | \r | |
133a9dfb | 603 | if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r |
604 | if (ConfigAccess->FormCallbackProtocol == NULL ||\r | |
605 | ConfigAccess->FormCallbackProtocol->NvWrite == NULL) {\r | |
606 | Status = gRT->SetVariable (\r | |
607 | BufferStorage->Name,\r | |
608 | &BufferStorage->Guid,\r | |
609 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
610 | DataSize2,\r | |
611 | Data\r | |
612 | );\r | |
613 | } else {\r | |
614 | Status = ConfigAccess->FormCallbackProtocol->NvWrite (\r | |
615 | ConfigAccess->FormCallbackProtocol, \r | |
616 | BufferStorage->Name,\r | |
617 | &BufferStorage->Guid,\r | |
618 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
619 | DataSize2,\r | |
620 | Data,\r | |
621 | &ResetRequired\r | |
622 | );\r | |
623 | \r | |
624 | }\r | |
ebbd2793 | 625 | }\r |
626 | \r | |
0368663f | 627 | Done: \r |
628 | if (DataAllocated && (Data != NULL)) {\r | |
629 | FreePool (Data);\r | |
630 | }\r | |
631 | \r | |
ebbd2793 | 632 | return Status;\r |
633 | }\r | |
634 | \r | |
0368663f | 635 | FRAMEWORK_EFI_IFR_DATA_ARRAY *\r |
636 | CreateIfrDataArray (\r | |
637 | IN CONFIG_ACCESS_PRIVATE *ConfigAccess,\r | |
638 | IN EFI_QUESTION_ID QuestionId,\r | |
639 | IN UINT8 Type,\r | |
640 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
641 | OUT BOOLEAN *NvMapAllocated\r | |
642 | )\r | |
643 | {\r | |
644 | FRAMEWORK_EFI_IFR_DATA_ARRAY *IfrDataArray;\r | |
645 | FRAMEWORK_EFI_IFR_DATA_ENTRY *IfrDataEntry;\r | |
646 | UINTN BrowserDataSize;\r | |
647 | BUFFER_STORAGE_ENTRY *BufferStorageEntry;\r | |
648 | LIST_ENTRY *Link;\r | |
133a9dfb | 649 | EFI_STATUS Status;\r |
286f0de7 | 650 | UINTN Size;\r |
651 | UINTN StringSize;\r | |
652 | EFI_STRING String;\r | |
653 | \r | |
654 | String = NULL;\r | |
0368663f | 655 | \r |
d4775f2a | 656 | Link = GetFirstNode (&ConfigAccess->BufferStorageListHead);\r |
657 | if (IsNull (&ConfigAccess->BufferStorageListHead, Link)) {\r | |
658 | return NULL;\r | |
659 | }\r | |
286f0de7 | 660 | \r |
661 | switch (Type) {\r | |
662 | case EFI_IFR_TYPE_NUM_SIZE_8:\r | |
663 | case EFI_IFR_TYPE_NUM_SIZE_16:\r | |
664 | case EFI_IFR_TYPE_NUM_SIZE_32:\r | |
665 | case EFI_IFR_TYPE_NUM_SIZE_64:\r | |
666 | case EFI_IFR_TYPE_BOOLEAN:\r | |
667 | Size = sizeof (*Value);\r | |
668 | break;\r | |
669 | \r | |
670 | case EFI_IFR_TYPE_STRING:\r | |
671 | StringSize = 0;\r | |
672 | Status = HiiLibGetString (ConfigAccess->ThunkContext->UefiHiiHandle, Value->string, String, &StringSize);\r | |
673 | ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r | |
674 | \r | |
675 | String = AllocateZeroPool (StringSize);\r | |
676 | ASSERT (String != NULL);\r | |
677 | \r | |
678 | Status = HiiLibGetString (ConfigAccess->ThunkContext->UefiHiiHandle, Value->string, String, &StringSize);\r | |
679 | ASSERT_EFI_ERROR (Status);\r | |
680 | \r | |
681 | Size = StringSize;\r | |
682 | break;\r | |
683 | \r | |
684 | default:\r | |
685 | ASSERT (FALSE);\r | |
686 | Size = 0;\r | |
687 | break;\r | |
688 | }\r | |
689 | \r | |
690 | IfrDataArray = AllocateZeroPool (sizeof (FRAMEWORK_EFI_IFR_DATA_ARRAY) + sizeof (FRAMEWORK_EFI_IFR_DATA_ENTRY) + Size);\r | |
0368663f | 691 | ASSERT (IfrDataArray != NULL);\r |
692 | \r | |
133a9dfb | 693 | BufferStorageEntry = BUFFER_STORAGE_ENTRY_FROM_LINK(Link);\r |
694 | BrowserDataSize = BufferStorageEntry->Size;\r | |
0368663f | 695 | \r |
133a9dfb | 696 | if (ConfigAccess->ThunkContext->NvMapOverride == NULL) {\r |
0368663f | 697 | *NvMapAllocated = TRUE;\r |
698 | IfrDataArray->NvRamMap = AllocateZeroPool (BrowserDataSize);\r | |
0368663f | 699 | } else {\r |
700 | *NvMapAllocated = FALSE;\r | |
701 | IfrDataArray->NvRamMap = ConfigAccess->ThunkContext->NvMapOverride;\r | |
702 | }\r | |
133a9dfb | 703 | \r |
704 | Status = GetBrowserData (NULL, NULL, &BrowserDataSize, IfrDataArray->NvRamMap);\r | |
705 | ASSERT_EFI_ERROR (Status);\r | |
0368663f | 706 | \r |
707 | IfrDataEntry = (FRAMEWORK_EFI_IFR_DATA_ENTRY *) (IfrDataArray + 1);\r | |
708 | \r | |
709 | switch (Type) {\r | |
710 | case EFI_IFR_TYPE_NUM_SIZE_8:\r | |
711 | case EFI_IFR_TYPE_NUM_SIZE_16:\r | |
712 | case EFI_IFR_TYPE_NUM_SIZE_32:\r | |
713 | case EFI_IFR_TYPE_NUM_SIZE_64:\r | |
714 | case EFI_IFR_TYPE_BOOLEAN:\r | |
715 | CopyMem (&IfrDataEntry->Data, &(Value->u8), sizeof (*Value));\r | |
716 | break;\r | |
717 | \r | |
286f0de7 | 718 | case EFI_IFR_TYPE_STRING:\r |
719 | ASSERT (String != NULL);\r | |
720 | StrCpy ((CHAR16 *) &IfrDataEntry->Data, String);\r | |
721 | FreePool (String);\r | |
722 | break;\r | |
0368663f | 723 | default:\r |
724 | ASSERT (FALSE);\r | |
725 | break;\r | |
726 | }\r | |
727 | \r | |
728 | return IfrDataArray;\r | |
729 | }\r | |
730 | \r | |
133a9dfb | 731 | VOID\r |
732 | SyncBrowserDataForNvMapOverride (\r | |
733 | IN CONFIG_ACCESS_PRIVATE *ConfigAccess\r | |
734 | )\r | |
735 | {\r | |
736 | BUFFER_STORAGE_ENTRY *BufferStorageEntry;\r | |
737 | LIST_ENTRY *Link;\r | |
738 | EFI_STATUS Status;\r | |
739 | UINTN BrowserDataSize;\r | |
740 | \r | |
741 | if (ConfigAccess->ThunkContext->NvMapOverride != NULL) {\r | |
742 | \r | |
743 | Link = GetFirstNode (&ConfigAccess->BufferStorageListHead);\r | |
744 | ASSERT (!IsNull (&ConfigAccess->BufferStorageListHead, Link));\r | |
745 | \r | |
746 | BufferStorageEntry = BUFFER_STORAGE_ENTRY_FROM_LINK(Link);\r | |
747 | BrowserDataSize = BufferStorageEntry->Size;\r | |
748 | \r | |
749 | Status = SetBrowserData (NULL, NULL, BrowserDataSize, ConfigAccess->ThunkContext->NvMapOverride, NULL);\r | |
750 | ASSERT_EFI_ERROR (Status);\r | |
751 | }\r | |
752 | \r | |
753 | }\r | |
754 | \r | |
0368663f | 755 | VOID\r |
756 | DestroyIfrDataArray (\r | |
757 | IN FRAMEWORK_EFI_IFR_DATA_ARRAY *Array,\r | |
758 | IN BOOLEAN NvMapAllocated\r | |
759 | )\r | |
760 | {\r | |
d4775f2a | 761 | if (Array != NULL) {\r |
762 | if (NvMapAllocated) {\r | |
763 | FreePool (Array->NvRamMap);\r | |
764 | }\r | |
0368663f | 765 | \r |
d4775f2a | 766 | FreePool (Array);\r |
767 | }\r | |
0368663f | 768 | }\r |
769 | \r | |
770 | \r | |
771 | ONE_OF_OPTION_MAP_ENTRY *\r | |
772 | GetOneOfOptionMapEntry (\r | |
773 | IN HII_THUNK_CONTEXT *ThunkContext,\r | |
774 | IN EFI_QUESTION_ID QuestionId,\r | |
775 | IN UINT8 Type,\r | |
776 | IN EFI_IFR_TYPE_VALUE *Value\r | |
777 | )\r | |
778 | {\r | |
779 | LIST_ENTRY *Link;\r | |
780 | LIST_ENTRY *Link2;\r | |
781 | ONE_OF_OPTION_MAP_ENTRY *OneOfOptionMapEntry;\r | |
782 | ONE_OF_OPTION_MAP *OneOfOptionMap;\r | |
783 | \r | |
784 | Link = GetFirstNode (&ThunkContext->OneOfOptionMapListHead);\r | |
785 | \r | |
786 | while (!IsNull (&ThunkContext->OneOfOptionMapListHead, Link)) {\r | |
787 | OneOfOptionMap = ONE_OF_OPTION_MAP_FROM_LINK(Link);\r | |
788 | if (OneOfOptionMap->QuestionId == QuestionId) {\r | |
789 | ASSERT (OneOfOptionMap->ValueType == Type);\r | |
790 | \r | |
791 | Link2 = GetFirstNode (&OneOfOptionMap->OneOfOptionMapEntryListHead);\r | |
792 | \r | |
793 | while (!IsNull (&OneOfOptionMap->OneOfOptionMapEntryListHead, Link2)) {\r | |
794 | OneOfOptionMapEntry = ONE_OF_OPTION_MAP_ENTRY_FROM_LINK (Link2);\r | |
795 | \r | |
796 | if (CompareMem (Value, &OneOfOptionMapEntry->Value, sizeof (EFI_IFR_TYPE_VALUE)) == 0) {\r | |
797 | return OneOfOptionMapEntry;\r | |
798 | }\r | |
799 | \r | |
800 | Link2 = GetNextNode (&OneOfOptionMap->OneOfOptionMapEntryListHead, Link2);\r | |
801 | }\r | |
802 | }\r | |
803 | \r | |
804 | Link = GetNextNode (&ThunkContext->OneOfOptionMapListHead, Link);\r | |
805 | }\r | |
806 | \r | |
807 | \r | |
808 | return NULL;\r | |
809 | }\r | |
810 | \r | |
811 | /**\r | |
812 | Functions which are registered to receive notification of\r | |
813 | database events have this prototype. The actual event is encoded\r | |
814 | in NotifyType. The following table describes how PackageType,\r | |
815 | PackageGuid, Handle, and Package are used for each of the\r | |
816 | notification types.\r | |
817 | \r | |
818 | @param PackageType Package type of the notification.\r | |
819 | \r | |
820 | @param PackageGuid If PackageType is\r | |
821 | EFI_HII_PACKAGE_TYPE_GUID, then this is\r | |
822 | the pointer to the GUID from the Guid\r | |
823 | field of EFI_HII_PACKAGE_GUID_HEADER.\r | |
824 | Otherwise, it must be NULL.\r | |
825 | \r | |
826 | @param Package Points to the package referred to by the\r | |
827 | notification Handle The handle of the package\r | |
828 | list which contains the specified package.\r | |
829 | \r | |
830 | @param Handle The HII handle.\r | |
831 | \r | |
832 | @param NotifyType The type of change concerning the\r | |
833 | database. See\r | |
834 | EFI_HII_DATABASE_NOTIFY_TYPE.\r | |
835 | \r | |
836 | **/\r | |
837 | EFI_STATUS\r | |
838 | EFIAPI\r | |
839 | FormUpdateNotify (\r | |
840 | IN UINT8 PackageType,\r | |
841 | IN CONST EFI_GUID *PackageGuid,\r | |
842 | IN CONST EFI_HII_PACKAGE_HEADER *Package,\r | |
843 | IN EFI_HII_HANDLE Handle,\r | |
844 | IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r | |
845 | )\r | |
846 | {\r | |
847 | mHiiPackageListUpdated = TRUE;\r | |
848 | \r | |
849 | return EFI_SUCCESS;\r | |
850 | }\r | |
851 | \r | |
1a6cdbd9 | 852 | /**\r |
853 | Wrap the EFI_HII_CONFIG_ACCESS_PROTOCOL.CallBack to EFI_FORM_CALLBACK_PROTOCOL.Callback. Therefor,\r | |
854 | the framework HII module willl do no porting (except some porting works needed for callback for EFI_ONE_OF_OPTION opcode)\r | |
855 | and still work with a UEFI HII SetupBrowser.\r | |
856 | \r | |
0368663f | 857 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r |
858 | @param Action Specifies the type of action taken by the browser. See EFI_BROWSER_ACTION_x.\r | |
1a6cdbd9 | 859 | @param QuestionId A unique value which is sent to the original exporting driver so that it can identify the\r |
0368663f | 860 | type of data to expect. The format of the data tends to vary based on the opcode that\r |
861 | generated the callback.\r | |
862 | @param Type The type of value for the question. See EFI_IFR_TYPE_x in\r | |
863 | EFI_IFR_ONE_OF_OPTION.\r | |
864 | @param Value A pointer to the data being sent to the original exporting driver. The type is specified\r | |
865 | by Type. Type EFI_IFR_TYPE_VALUE is defined in\r | |
866 | EFI_IFR_ONE_OF_OPTION.\r | |
1a6cdbd9 | 867 | @param ActionRequest On return, points to the action requested by the callback function. Type\r |
0368663f | 868 | EFI_BROWSER_ACTION_REQUEST is specified in SendForm() in the Form\r |
869 | Browser Protocol.\r | |
1a6cdbd9 | 870 | \r |
0368663f | 871 | @retval EFI_UNSUPPORTED If the Framework HII module does not register Callback although it specify the opcode under\r |
872 | focuse to be INTERRACTIVE.\r | |
1a6cdbd9 | 873 | @retval EFI_SUCCESS The callback complete successfully.\r |
874 | @retval !EFI_SUCCESS The error code returned by EFI_FORM_CALLBACK_PROTOCOL.Callback.\r | |
875 | \r | |
876 | **/\r | |
ebbd2793 | 877 | EFI_STATUS\r |
878 | EFIAPI\r | |
879 | ThunkCallback (\r | |
880 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
881 | IN EFI_BROWSER_ACTION Action,\r | |
882 | IN EFI_QUESTION_ID QuestionId,\r | |
883 | IN UINT8 Type,\r | |
884 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
885 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
886 | )\r | |
887 | {\r | |
888 | EFI_STATUS Status;\r | |
0368663f | 889 | CONFIG_ACCESS_PRIVATE *ConfigAccess;\r |
890 | EFI_FORM_CALLBACK_PROTOCOL *FormCallbackProtocol;\r | |
ebbd2793 | 891 | EFI_HII_CALLBACK_PACKET *Packet;\r |
0368663f | 892 | FRAMEWORK_EFI_IFR_DATA_ARRAY *Data;\r |
ebbd2793 | 893 | FRAMEWORK_EFI_IFR_DATA_ENTRY *DataEntry;\r |
0368663f | 894 | UINT16 KeyValue;\r |
895 | ONE_OF_OPTION_MAP_ENTRY *OneOfOptionMapEntry;\r | |
896 | EFI_HANDLE NotifyHandle;\r | |
897 | EFI_INPUT_KEY Key; \r | |
898 | BOOLEAN NvMapAllocated;\r | |
ebbd2793 | 899 | \r |
900 | ASSERT (This != NULL);\r | |
901 | ASSERT (Value != NULL);\r | |
902 | ASSERT (ActionRequest != NULL);\r | |
903 | \r | |
904 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
905 | \r | |
0368663f | 906 | ConfigAccess = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (This);\r |
ebbd2793 | 907 | \r |
0368663f | 908 | FormCallbackProtocol = ConfigAccess->FormCallbackProtocol;\r |
909 | if (FormCallbackProtocol == NULL) {\r | |
910 | ASSERT (FALSE);\r | |
ebbd2793 | 911 | return EFI_UNSUPPORTED;\r |
912 | }\r | |
ebbd2793 | 913 | \r |
0368663f | 914 | //\r |
915 | // Check if the QuestionId match a OneOfOption.\r | |
916 | //\r | |
917 | OneOfOptionMapEntry = GetOneOfOptionMapEntry (ConfigAccess->ThunkContext, QuestionId, Type, Value);\r | |
918 | \r | |
919 | if (OneOfOptionMapEntry == NULL) {\r | |
920 | //\r | |
921 | // This is not a One-Of-Option opcode. QuestionId is the KeyValue\r | |
922 | //\r | |
923 | KeyValue = QuestionId;\r | |
924 | } else {\r | |
925 | KeyValue = OneOfOptionMapEntry->FwKey;\r | |
926 | }\r | |
927 | \r | |
928 | //\r | |
929 | // Build the FRAMEWORK_EFI_IFR_DATA_ARRAY\r | |
930 | //\r | |
931 | Data = CreateIfrDataArray (ConfigAccess, QuestionId, Type, Value, &NvMapAllocated);\r | |
932 | \r | |
933 | Status = mHiiDatabase->RegisterPackageNotify (\r | |
934 | mHiiDatabase,\r | |
4dd76ade | 935 | EFI_HII_PACKAGE_FORMS,\r |
0368663f | 936 | NULL,\r |
937 | FormUpdateNotify,\r | |
938 | EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r | |
939 | &NotifyHandle\r | |
940 | );\r | |
941 | //\r | |
942 | //\r | |
943 | //\r | |
944 | Packet = NULL;\r | |
945 | Status = FormCallbackProtocol->Callback (\r | |
946 | FormCallbackProtocol,\r | |
947 | KeyValue,\r | |
948 | Data,\r | |
ebbd2793 | 949 | &Packet\r |
950 | );\r | |
133a9dfb | 951 | SyncBrowserDataForNvMapOverride (ConfigAccess);\r |
ebbd2793 | 952 | \r |
953 | //\r | |
954 | // Callback require browser to perform action\r | |
955 | //\r | |
0368663f | 956 | if (EFI_ERROR (Status)) {\r |
957 | if (Packet != NULL) {\r | |
0368663f | 958 | do {\r |
959 | IfrLibCreatePopUp (1, &Key, Packet->String);\r | |
0368663f | 960 | } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r |
ebbd2793 | 961 | }\r |
0368663f | 962 | //\r |
963 | // Error Code in Status is discarded.\r | |
964 | //\r | |
965 | } else {\r | |
966 | if (Packet != NULL) {\r | |
967 | if (Packet->DataArray.EntryCount == 1 && Packet->DataArray.NvRamMap == NULL) {\r | |
968 | DataEntry = (FRAMEWORK_EFI_IFR_DATA_ENTRY *) ((UINT8 *) Packet + sizeof (FRAMEWORK_EFI_IFR_DATA_ARRAY));\r | |
969 | if ((DataEntry->Flags & EXIT_REQUIRED) == EXIT_REQUIRED) {\r | |
970 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
971 | }\r | |
972 | \r | |
973 | if ((DataEntry->Flags & SAVE_REQUIRED) == SAVE_REQUIRED) {\r | |
974 | Status = ConfigAccess->ConfigAccessProtocol.RouteConfig (\r | |
975 | &ConfigAccess->ConfigAccessProtocol,\r | |
976 | NULL,\r | |
977 | NULL\r | |
978 | );\r | |
979 | }\r | |
980 | }\r | |
981 | FreePool (Packet);\r | |
982 | }\r | |
983 | }\r | |
984 | \r | |
985 | //\r | |
986 | // Unregister notify for Form package update\r | |
987 | //\r | |
988 | Status = mHiiDatabase->UnregisterPackageNotify (\r | |
989 | mHiiDatabase,\r | |
990 | NotifyHandle\r | |
991 | );\r | |
992 | //\r | |
a3318eaf | 993 | // UEFI SetupBrowser behaves differently with Framework SetupBrowser when call back function \r |
0368663f | 994 | // update any forms in HII database. UEFI SetupBrowser will re-parse the displaying form package and load\r |
995 | // the values from variable storages. Framework SetupBrowser will only re-parse the displaying form packages.\r | |
996 | // To make sure customer's previous changes is saved and the changing question behaves as expected, we\r | |
997 | // issue a EFI_BROWSER_ACTION_REQUEST_SUBMIT to ask UEFI SetupBrowser to save the changes proceed to re-parse\r | |
998 | // the form and load all the variable storages.\r | |
999 | //\r | |
1000 | if (*ActionRequest == EFI_BROWSER_ACTION_REQUEST_NONE && mHiiPackageListUpdated) {\r | |
1001 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r | |
fed39e58 | 1002 | } else {\r |
1003 | if (ConfigAccess->ThunkContext->FormSetSubClass == EFI_FRONT_PAGE_SUBCLASS ||\r | |
1004 | ConfigAccess->ThunkContext->FormSetSubClass == EFI_SINGLE_USE_SUBCLASS) {\r | |
1005 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
1006 | }\r | |
ebbd2793 | 1007 | }\r |
0368663f | 1008 | \r |
d4775f2a | 1009 | \r |
0368663f | 1010 | DestroyIfrDataArray (Data, NvMapAllocated);\r |
ebbd2793 | 1011 | \r |
1012 | return Status;\r | |
1013 | }\r | |
1014 | \r |