]>
Commit | Line | Data |
---|---|---|
4259256b | 1 | /**@file\r |
2 | This file contains the form processing code to the HII database.\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r | |
5 | All rights reserved. This program and the accompanying materials\r | |
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 | \r | |
16 | #include "HiiDatabase.h"\r | |
59336178 | 17 | #include "UefiIfrDefault.h"\r |
4259256b | 18 | \r |
0368663f | 19 | //\r |
20 | // This structure is only intended to be used in this file.\r | |
21 | //\r | |
88b6bcec | 22 | #pragma pack(1)\r |
ea58467b | 23 | typedef struct {\r |
24 | EFI_HII_PACK_HEADER PackageHeader;\r | |
25 | FRAMEWORK_EFI_IFR_FORM_SET FormSet;\r | |
aa2ebe0f | 26 | EFI_IFR_END_FORM_SET EndFormSet;\r |
0368663f | 27 | } FW_HII_FORMSET_TEMPLATE;\r |
88b6bcec | 28 | #pragma pack()\r |
ea58467b | 29 | \r |
0368663f | 30 | FW_HII_FORMSET_TEMPLATE FormSetTemplate = {\r |
ea58467b | 31 | {\r |
0368663f | 32 | sizeof (FW_HII_FORMSET_TEMPLATE),\r |
ea58467b | 33 | EFI_HII_IFR\r |
34 | },\r | |
35 | {\r | |
36 | {\r | |
37 | FRAMEWORK_EFI_IFR_FORM_SET_OP,\r | |
38 | sizeof (FRAMEWORK_EFI_IFR_FORM_SET)\r | |
39 | },\r | |
a3318eaf | 40 | {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}}, //Guid\r |
ea58467b | 41 | 0,\r |
42 | 0,\r | |
43 | 0,\r | |
44 | 0,\r | |
45 | 0,\r | |
46 | 0\r | |
47 | },\r | |
48 | {\r | |
d7152a15 | 49 | {\r |
aa2ebe0f LG |
50 | EFI_IFR_END_FORM_SET_OP,\r |
51 | sizeof (EFI_IFR_END_FORM_SET)\r | |
d7152a15 | 52 | }\r |
ea58467b | 53 | }\r |
54 | };\r | |
55 | \r | |
4259256b | 56 | \r |
a9d85320 | 57 | EFI_GUID mTianoHiiIfrGuid = EFI_IFR_TIANO_GUID;\r |
58 | \r | |
0368663f | 59 | /**\r |
4259256b | 60 | \r |
0368663f | 61 | This thunk module only handles UEFI HII packages. The caller of this function \r |
1910fbaf | 62 | won't be able to parse the content. Therefore, it is not supported.\r |
0368663f | 63 | \r |
64 | This function will ASSERT and return EFI_UNSUPPORTED.\r | |
4259256b | 65 | \r |
0368663f | 66 | @param This N.A.\r |
67 | @param Handle N.A.\r | |
68 | @param BufferSize N.A.\r | |
69 | @param Buffer N.A.\r | |
4259256b | 70 | \r |
0368663f | 71 | @retval EFI_UNSUPPORTED\r |
4259256b | 72 | \r |
0368663f | 73 | **/\r |
74 | EFI_STATUS\r | |
75 | EFIAPI\r | |
76 | HiiExportDatabase (\r | |
77 | IN EFI_HII_PROTOCOL *This,\r | |
78 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
79 | IN OUT UINTN *BufferSize,\r | |
80 | OUT VOID *Buffer\r | |
81 | )\r | |
82 | {\r | |
83 | ASSERT (FALSE);\r | |
84 | return EFI_UNSUPPORTED;\r | |
85 | }\r | |
4259256b | 86 | \r |
4259256b | 87 | \r |
0368663f | 88 | /**\r |
89 | This function allows a program to extract a form or form package that has\r | |
90 | previously been registered with the EFI HII database.\r | |
4259256b | 91 | \r |
0368663f | 92 | In this thunk module, this function will create a IFR Package with only \r |
93 | one Formset. Effectively, only the GUID of the Formset is updated and return\r | |
94 | in this IFR package to caller. This is enable the Framework modules which call \r | |
95 | a API named GetStringFromToken. GetStringFromToken retieves a String based on\r | |
96 | a String Token from a Package List known only by the Formset GUID.\r | |
97 | \r | |
4259256b | 98 | \r |
4259256b | 99 | \r |
0368663f | 100 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r |
101 | @param Handle Handle on which the form resides. Type FRAMEWORK_EFI_HII_HANDLE is defined in\r | |
102 | EFI_HII_PROTOCOL.NewPack() in the Packages section.\r | |
103 | @param FormId Ignored by this implementation.\r | |
104 | @param BufferLengthTemp On input, the size of input buffer. On output, it\r | |
105 | is the size of FW_HII_FORMSET_TEMPLATE.\r | |
106 | @param Buffer The buffer designed to receive the form(s).\r | |
4259256b | 107 | \r |
0368663f | 108 | @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength\r |
109 | was updated.\r | |
110 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
111 | @retval EFI_NOT_FOUND A form on the requested handle cannot be found with the\r | |
112 | requested FormId.\r | |
113 | @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to allow the form to be stored.\r | |
4259256b | 114 | \r |
0368663f | 115 | **/\r |
116 | EFI_STATUS\r | |
117 | EFIAPI\r | |
118 | HiiGetForms (\r | |
a3318eaf | 119 | IN EFI_HII_PROTOCOL *This,\r |
120 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
121 | IN EFI_FORM_ID FormId,\r | |
122 | IN OUT UINTN *BufferLengthTemp,\r | |
123 | OUT UINT8 *Buffer\r | |
0368663f | 124 | )\r |
4259256b | 125 | {\r |
0368663f | 126 | HII_THUNK_PRIVATE_DATA *Private;\r |
127 | HII_THUNK_CONTEXT *ThunkContext;\r | |
128 | FW_HII_FORMSET_TEMPLATE *OutputFormSet;\r | |
ea58467b | 129 | \r |
0368663f | 130 | if (*BufferLengthTemp < sizeof(FW_HII_FORMSET_TEMPLATE)) {\r |
131 | *BufferLengthTemp = sizeof(FW_HII_FORMSET_TEMPLATE);\r | |
ea58467b | 132 | return EFI_BUFFER_TOO_SMALL;\r |
133 | }\r | |
134 | \r | |
0368663f | 135 | Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r |
ea58467b | 136 | \r |
0368663f | 137 | ThunkContext = FwHiiHandleToThunkContext (Private, Handle);\r |
ea58467b | 138 | \r |
0368663f | 139 | if (ThunkContext == NULL) {\r |
ea58467b | 140 | return EFI_NOT_FOUND;\r |
141 | }\r | |
142 | \r | |
0368663f | 143 | OutputFormSet = (FW_HII_FORMSET_TEMPLATE *) Buffer;\r |
ea58467b | 144 | \r |
0368663f | 145 | CopyMem (OutputFormSet, &FormSetTemplate, sizeof (FW_HII_FORMSET_TEMPLATE));\r |
146 | CopyMem (&OutputFormSet->FormSet.Guid, &ThunkContext->TagGuid, sizeof (EFI_GUID)); \r | |
147 | \r | |
a9d85320 | 148 | if (ThunkContext->FormSet != NULL) {\r |
149 | OutputFormSet->FormSet.Class = ThunkContext->FormSet->Class;\r | |
150 | OutputFormSet->FormSet.SubClass = ThunkContext->FormSet->SubClass;\r | |
151 | OutputFormSet->FormSet.Help = ThunkContext->FormSet->Help;\r | |
152 | OutputFormSet->FormSet.FormSetTitle = ThunkContext->FormSet->FormSetTitle;\r | |
153 | }\r | |
0368663f | 154 | \r |
ea58467b | 155 | return EFI_SUCCESS;\r |
4259256b | 156 | }\r |
157 | \r | |
59336178 | 158 | \r |
0368663f | 159 | /**\r |
4259256b | 160 | \r |
161 | This function allows a program to extract the NV Image\r | |
162 | that represents the default storage image\r | |
163 | \r | |
0368663f | 164 | \r |
165 | @param This A pointer to the EFI_HII_PROTOCOL instance.\r | |
166 | @param Handle The HII handle from which will have default data retrieved.\r | |
167 | UINTN - Mask used to retrieve the default image.\r | |
168 | @param DefaultMask EDES_TODO: Add parameter description\r | |
169 | @param VariablePackList Callee allocated, tightly-packed, link list data\r | |
4259256b | 170 | structure that contain all default varaible packs\r |
171 | from the Hii Database.\r | |
172 | \r | |
0368663f | 173 | @retval EFI_NOT_FOUND If Hii database does not contain any default images.\r |
174 | @retval EFI_INVALID_PARAMETER Invalid input parameter.\r | |
175 | @retval EFI_SUCCESS Operation successful.\r | |
4259256b | 176 | \r |
0368663f | 177 | **/\r |
178 | EFI_STATUS\r | |
179 | EFIAPI\r | |
180 | HiiGetDefaultImage (\r | |
181 | IN EFI_HII_PROTOCOL *This,\r | |
182 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r | |
183 | IN UINTN DefaultMask,\r | |
184 | OUT EFI_HII_VARIABLE_PACK_LIST **VariablePackList\r | |
185 | )\r | |
4259256b | 186 | {\r |
59336178 | 187 | LIST_ENTRY *UefiDefaults;\r |
59336178 | 188 | EFI_STATUS Status;\r |
0368663f | 189 | HII_THUNK_PRIVATE_DATA *Private;\r |
a9d85320 | 190 | HII_THUNK_CONTEXT *ThunkContext;\r |
59336178 | 191 | \r |
0368663f | 192 | Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r |
59336178 | 193 | \r |
a9d85320 | 194 | ThunkContext = FwHiiHandleToThunkContext (Private, Handle);\r |
195 | if (ThunkContext == NULL) {\r | |
59336178 | 196 | ASSERT (FALSE);\r |
197 | return EFI_INVALID_PARAMETER;\r | |
198 | }\r | |
199 | \r | |
200 | UefiDefaults = NULL;\r | |
a9d85320 | 201 | Status = UefiIfrGetBufferTypeDefaults (ThunkContext, &UefiDefaults);\r |
59336178 | 202 | if (EFI_ERROR (Status)) {\r |
203 | goto Done;\r | |
204 | }\r | |
205 | \r | |
a9d85320 | 206 | Status = UefiDefaultsToFwDefaults (UefiDefaults, DefaultMask, ThunkContext->FormSet->DefaultVarStoreId, VariablePackList);\r |
59336178 | 207 | \r |
208 | Done:\r | |
209 | FreeDefaultList (UefiDefaults);\r | |
210 | \r | |
211 | return Status;\r | |
4259256b | 212 | }\r |
213 | \r | |
0368663f | 214 | /**\r |
a9d85320 | 215 | This function update the FormCallbackProtocol cached in Config Access\r |
216 | private context data.\r | |
0368663f | 217 | \r |
a9d85320 | 218 | @param CallbackHandle The EFI Handle on which the Framework FormCallbackProtocol is \r |
219 | installed.\r | |
220 | @param ThunkContext The Thunk Context.\r | |
0368663f | 221 | \r |
a9d85320 | 222 | @retval EFI_SUCCESS The update is successful.\r |
223 | @retval EFI_INVALID_PARAMETER If no Framework FormCallbackProtocol is located on CallbackHandle.\r | |
0368663f | 224 | \r |
225 | **/\r | |
ebbd2793 | 226 | EFI_STATUS\r |
0368663f | 227 | UpdateFormCallBack (\r |
ebbd2793 | 228 | IN EFI_HANDLE CallbackHandle,\r |
0368663f | 229 | IN CONST HII_THUNK_CONTEXT *ThunkContext\r |
ebbd2793 | 230 | )\r |
231 | {\r | |
232 | EFI_STATUS Status;\r | |
0368663f | 233 | EFI_FORM_CALLBACK_PROTOCOL *FormCallbackProtocol;\r |
ebbd2793 | 234 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccessProtocol;\r |
235 | EFI_HANDLE UefiDriverHandle;\r | |
0368663f | 236 | CONFIG_ACCESS_PRIVATE *ConfigAccessPrivate;\r |
ebbd2793 | 237 | \r |
238 | Status = gBS->HandleProtocol (\r | |
239 | CallbackHandle,\r | |
240 | &gEfiFormCallbackProtocolGuid,\r | |
0368663f | 241 | (VOID **) &FormCallbackProtocol\r |
ebbd2793 | 242 | );\r |
243 | if (EFI_ERROR (Status)) {\r | |
244 | return EFI_INVALID_PARAMETER;\r | |
245 | }\r | |
246 | \r | |
59336178 | 247 | Status = mHiiDatabase->GetPackageListHandle (\r |
248 | mHiiDatabase,\r | |
0368663f | 249 | ThunkContext->UefiHiiHandle,\r |
ebbd2793 | 250 | &UefiDriverHandle\r |
251 | );\r | |
252 | ASSERT_EFI_ERROR (Status);\r | |
253 | Status = gBS->HandleProtocol (\r | |
254 | UefiDriverHandle,\r | |
255 | &gEfiHiiConfigAccessProtocolGuid,\r | |
256 | (VOID **) &ConfigAccessProtocol\r | |
257 | );\r | |
258 | ASSERT_EFI_ERROR (Status);\r | |
259 | \r | |
0368663f | 260 | ConfigAccessPrivate = CONFIG_ACCESS_PRIVATE_FROM_PROTOCOL (ConfigAccessProtocol);\r |
ebbd2793 | 261 | \r |
0368663f | 262 | ConfigAccessPrivate->FormCallbackProtocol = FormCallbackProtocol;\r |
ebbd2793 | 263 | \r |
264 | return EFI_SUCCESS;\r | |
265 | }\r | |
4259256b | 266 | \r |
59336178 | 267 | \r |
0368663f | 268 | /**\r |
a9d85320 | 269 | Get the package data from the Package List.\r |
0368663f | 270 | \r |
a9d85320 | 271 | @param HiiPackageList Package List.\r |
272 | @param PackageIndex The index of the Package in the Package List.\r | |
273 | @param BufferLen The Length of the Pacage data.\r | |
274 | @param Buffer On output, the Package data.\r | |
0368663f | 275 | \r |
a9d85320 | 276 | @return EFI_NOT_FOUND No Package is found for PackageIndex.\r |
277 | @return EFI_SUCCESS The package data is returned.\r | |
0368663f | 278 | \r |
279 | **/\r | |
59336178 | 280 | EFI_STATUS\r |
0368663f | 281 | GetPackageData (\r |
59336178 | 282 | IN EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,\r |
283 | IN UINT32 PackageIndex,\r | |
284 | OUT UINT32 *BufferLen,\r | |
285 | OUT EFI_HII_PACKAGE_HEADER **Buffer\r | |
286 | )\r | |
287 | {\r | |
288 | UINT32 Index;\r | |
289 | EFI_HII_PACKAGE_HEADER *Package;\r | |
290 | UINT32 Offset;\r | |
291 | UINT32 PackageListLength;\r | |
292 | EFI_HII_PACKAGE_HEADER PackageHeader = {0, 0};\r | |
293 | \r | |
294 | ASSERT(HiiPackageList != NULL);\r | |
295 | \r | |
296 | if ((BufferLen == NULL) || (Buffer == NULL)) {\r | |
297 | return EFI_INVALID_PARAMETER;\r | |
298 | }\r | |
299 | \r | |
300 | Package = NULL;\r | |
301 | Index = 0;\r | |
302 | Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);\r | |
303 | CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));\r | |
304 | while (Offset < PackageListLength) {\r | |
305 | Package = (EFI_HII_PACKAGE_HEADER *) (((UINT8 *) HiiPackageList) + Offset);\r | |
306 | CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r | |
307 | if (Index == PackageIndex) {\r | |
308 | break;\r | |
309 | }\r | |
310 | Offset += PackageHeader.Length;\r | |
311 | Index++;\r | |
312 | }\r | |
313 | if (Offset >= PackageListLength) {\r | |
314 | //\r | |
315 | // no package found in this Package List\r | |
316 | //\r | |
317 | return EFI_NOT_FOUND;\r | |
318 | }\r | |
319 | \r | |
320 | *BufferLen = PackageHeader.Length;\r | |
321 | *Buffer = Package;\r | |
322 | return EFI_SUCCESS;\r | |
323 | }\r | |
324 | \r | |
325 | /**\r | |
a9d85320 | 326 | Check if Label exist in the IFR form package and return the FormSet GUID\r |
327 | and Form ID.\r | |
59336178 | 328 | \r |
a9d85320 | 329 | @param Package The Package Header.\r |
330 | @param Label The Label ID.\r | |
331 | @param FormsetGuid Returns the FormSet GUID.\r | |
332 | @param FormId Returns the Form ID.\r | |
59336178 | 333 | \r |
a9d85320 | 334 | @retval EFI_SUCCESS The FORM ID is found.\r |
335 | @retval EFI_NOT_FOUND The FORM ID is not found.\r | |
59336178 | 336 | **/\r |
337 | EFI_STATUS\r | |
338 | LocateLabel (\r | |
339 | IN CONST EFI_HII_PACKAGE_HEADER *Package,\r | |
340 | IN EFI_FORM_LABEL Label,\r | |
341 | OUT EFI_GUID *FormsetGuid,\r | |
342 | OUT EFI_FORM_ID *FormId\r | |
343 | )\r | |
344 | {\r | |
345 | UINTN Offset;\r | |
346 | EFI_IFR_OP_HEADER *IfrOpHdr;\r | |
59336178 | 347 | EFI_GUID InternalFormSetGuid;\r |
348 | EFI_FORM_ID InternalFormId;\r | |
349 | BOOLEAN GetFormSet;\r | |
350 | BOOLEAN GetForm;\r | |
a9d85320 | 351 | EFI_IFR_GUID_LABEL *LabelOpcode;\r |
59336178 | 352 | \r |
353 | IfrOpHdr = (EFI_IFR_OP_HEADER *)((UINT8 *) Package + sizeof (EFI_HII_PACKAGE_HEADER));\r | |
354 | Offset = sizeof (EFI_HII_PACKAGE_HEADER);\r | |
355 | \r | |
356 | InternalFormId= 0;\r | |
357 | ZeroMem (&InternalFormSetGuid, sizeof (EFI_GUID));\r | |
358 | GetFormSet = FALSE;\r | |
359 | GetForm = FALSE;\r | |
360 | \r | |
361 | while (Offset < Package->Length) {\r | |
362 | switch (IfrOpHdr->OpCode) {\r | |
363 | case EFI_IFR_FORM_SET_OP :\r | |
364 | CopyMem (&InternalFormSetGuid, &((EFI_IFR_FORM_SET *) IfrOpHdr)->Guid, sizeof (EFI_GUID));\r | |
365 | GetFormSet = TRUE;\r | |
366 | break;\r | |
367 | \r | |
368 | case EFI_IFR_FORM_OP:\r | |
369 | CopyMem (&InternalFormId, &((EFI_IFR_FORM *) IfrOpHdr)->FormId, sizeof (EFI_FORM_ID));\r | |
370 | GetForm = TRUE;\r | |
371 | break;\r | |
372 | \r | |
373 | case EFI_IFR_GUID_OP :\r | |
a9d85320 | 374 | LabelOpcode = (EFI_IFR_GUID_LABEL *) IfrOpHdr;\r |
375 | //\r | |
376 | // If it is an Label opcode.\r | |
377 | //\r | |
378 | if ((LabelOpcode->ExtendOpCode == EFI_IFR_EXTEND_OP_LABEL) && (CompareMem (&LabelOpcode->Guid, &mTianoHiiIfrGuid, sizeof (EFI_GUID)) == 0)) {\r | |
379 | if (CompareMem (&Label, &LabelOpcode->Number, sizeof (UINT16)) == 0) {\r | |
380 | ASSERT (GetForm && GetFormSet);\r | |
381 | CopyGuid (FormsetGuid, &InternalFormSetGuid);\r | |
382 | *FormId = InternalFormId;\r | |
383 | return EFI_SUCCESS;\r | |
384 | }\r | |
59336178 | 385 | }\r |
59336178 | 386 | break;\r |
387 | default :\r | |
388 | break;\r | |
389 | }\r | |
390 | \r | |
391 | //\r | |
392 | // Go to the next Op-Code\r | |
393 | //\r | |
394 | Offset += IfrOpHdr->Length;\r | |
395 | IfrOpHdr = (EFI_IFR_OP_HEADER *) ((CHAR8 *) (IfrOpHdr) + IfrOpHdr->Length);\r | |
396 | }\r | |
397 | \r | |
398 | return EFI_NOT_FOUND;\r | |
399 | }\r | |
400 | \r | |
401 | /**\r | |
402 | Find the first EFI_FORM_LABEL in FormSets for a given EFI_HII_HANLDE defined.\r | |
403 | \r | |
404 | EFI_FORM_LABEL is a specific to Tiano implementation. The current implementation\r | |
405 | does not restrict labels with same label value to be duplicated in either FormSet \r | |
406 | scope or Form scope. This function will only locate the FIRST EFI_FORM_LABEL\r | |
407 | with value as the same as the input Label in the Formset registered with UefiHiiHandle. The FormSet GUID \r | |
408 | and Form ID is returned if such Label is found.\r | |
409 | \r | |
410 | \r | |
411 | @retval EFI_INVALID_PARAMETER If UefiHiiHandle is not a valid handle.\r | |
412 | @retval EFI_NOT_FOUND The package list identified by UefiHiiHandle deos not contain FormSet or\r | |
413 | There is no Form ID with value Label found in all Form Sets in the pacakge\r | |
414 | list.\r | |
415 | \r | |
416 | @retval EFI_SUCCESS The first found Form ID is returned in FormId.\r | |
417 | **/\r | |
418 | EFI_STATUS\r | |
0368663f | 419 | LocateFormId (\r |
59336178 | 420 | IN EFI_HII_HANDLE Handle,\r |
421 | IN EFI_FORM_LABEL Label,\r | |
422 | OUT EFI_GUID *FormsetGuid,\r | |
423 | OUT EFI_FORM_ID *FormId\r | |
424 | )\r | |
425 | {\r | |
426 | EFI_STATUS Status;\r | |
427 | EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;\r | |
428 | UINT32 Index;\r | |
429 | UINTN BufferSize;\r | |
430 | EFI_HII_PACKAGE_HEADER PackageHeader;\r | |
431 | EFI_HII_PACKAGE_HEADER *Package;\r | |
432 | UINT32 PackageLength;\r | |
433 | \r | |
434 | BufferSize = 0;\r | |
435 | HiiPackageList = NULL;\r | |
436 | Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);\r | |
437 | if (Status == EFI_BUFFER_TOO_SMALL) {\r | |
438 | HiiPackageList = AllocatePool (BufferSize);\r | |
439 | ASSERT (HiiPackageList != NULL);\r | |
440 | \r | |
441 | Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);\r | |
442 | if (EFI_ERROR (Status)) {\r | |
443 | goto Done;\r | |
444 | }\r | |
445 | }\r | |
446 | \r | |
447 | for (Index = 0; ; Index++) {\r | |
0368663f | 448 | Status = GetPackageData (HiiPackageList, Index, &PackageLength, &Package);\r |
59336178 | 449 | if (!EFI_ERROR (Status)) {\r |
450 | CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));\r | |
4dd76ade | 451 | if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {\r |
59336178 | 452 | Status = LocateLabel (Package, Label, FormsetGuid, FormId);\r |
453 | if (!EFI_ERROR(Status)) {\r | |
454 | break;\r | |
455 | }\r | |
456 | }\r | |
457 | } else {\r | |
458 | break;\r | |
459 | }\r | |
460 | }\r | |
461 | \r | |
462 | \r | |
463 | Done:\r | |
464 | FreePool (HiiPackageList);\r | |
465 | \r | |
466 | return Status;\r | |
467 | }\r | |
a9d85320 | 468 | \r |
0368663f | 469 | /**\r |
470 | This function allows the caller to update a form that has\r | |
471 | previously been registered with the EFI HII database.\r | |
472 | \r | |
473 | \r | |
474 | @param This EDES_TODO: Add parameter description\r | |
475 | @param Handle Hii Handle associated with the Formset to modify\r | |
476 | @param Label Update information starting immediately after this label in the IFR\r | |
477 | @param AddData If TRUE, add data. If FALSE, remove data\r | |
478 | @param Data If adding data, this is the pointer to the data to add\r | |
479 | \r | |
480 | @retval EFI_SUCCESS Update success.\r | |
481 | @retval Other Update fail.\r | |
482 | \r | |
483 | **/\r | |
4259256b | 484 | EFI_STATUS\r |
485 | EFIAPI\r | |
cdaf7905 | 486 | HiiThunkUpdateForm (\r |
0368663f | 487 | IN EFI_HII_PROTOCOL *This,\r |
4259256b | 488 | IN FRAMEWORK_EFI_HII_HANDLE Handle,\r |
0368663f | 489 | IN EFI_FORM_LABEL Label,\r |
490 | IN BOOLEAN AddData,\r | |
2d630302 | 491 | IN EFI_HII_UPDATE_DATA *Data\r |
4259256b | 492 | )\r |
4259256b | 493 | {\r |
ebbd2793 | 494 | EFI_STATUS Status;\r |
0368663f | 495 | HII_THUNK_PRIVATE_DATA *Private;\r |
a5420536 | 496 | HII_THUNK_CONTEXT *ThunkContext;\r |
99a83b4c | 497 | EFI_HII_HANDLE UefiHiiHandle;\r |
59336178 | 498 | EFI_GUID FormsetGuid;\r |
499 | EFI_FORM_ID FormId;\r | |
0368663f | 500 | EFI_TPL OldTpl;\r |
a5420536 LG |
501 | VOID *StartOpCodeHandle;\r |
502 | VOID *EndOpCodeHandle;\r | |
503 | EFI_IFR_GUID_LABEL *StartLabel;\r | |
504 | EFI_IFR_GUID_LABEL *EndLabel;\r | |
99a83b4c | 505 | \r |
0368663f | 506 | OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r |
507 | \r | |
508 | mInFrameworkUpdatePakcage = TRUE;\r | |
99a83b4c | 509 | Status = EFI_SUCCESS;\r |
ebbd2793 | 510 | \r |
0368663f | 511 | Private = HII_THUNK_PRIVATE_DATA_FROM_THIS(This);\r |
ebbd2793 | 512 | \r |
0368663f | 513 | ThunkContext = FwHiiHandleToThunkContext (Private, Handle);\r |
514 | \r | |
515 | if (ThunkContext == NULL) {\r | |
516 | Status = EFI_NOT_FOUND;\r | |
517 | goto Done;\r | |
ebbd2793 | 518 | }\r |
519 | \r | |
520 | if (Data->FormSetUpdate) {\r | |
0368663f | 521 | Status = UpdateFormCallBack ((EFI_HANDLE) (UINTN) Data->FormCallbackHandle, ThunkContext);\r |
ebbd2793 | 522 | if (EFI_ERROR (Status)) {\r |
0368663f | 523 | goto Done;\r |
ebbd2793 | 524 | }\r |
525 | }\r | |
99a83b4c | 526 | \r |
8ea58c07 | 527 | if (ThunkContext->IfrPackageCount == 0) {\r |
528 | ASSERT (FALSE);\r | |
529 | Status = EFI_INVALID_PARAMETER;\r | |
530 | goto Done;\r | |
f274810c | 531 | } else {\r |
0368663f | 532 | UefiHiiHandle = ThunkContext->UefiHiiHandle;\r |
f274810c | 533 | }\r |
99a83b4c | 534 | \r |
0368663f | 535 | Status = LocateFormId (UefiHiiHandle, Label, &FormsetGuid, &FormId);\r |
536 | if (EFI_ERROR (Status)) {\r | |
537 | //\r | |
538 | // Can't find the label.\r | |
539 | //\r | |
540 | goto Done;\r | |
541 | }\r | |
f274810c | 542 | \r |
a5420536 LG |
543 | //\r |
544 | // Init OpCode Handle\r | |
545 | //\r | |
546 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
547 | ASSERT (StartOpCodeHandle != NULL);\r | |
548 | \r | |
549 | EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
550 | ASSERT (EndOpCodeHandle != NULL);\r | |
551 | \r | |
552 | //\r | |
553 | // Create Hii Extend Label OpCode as the start opcode\r | |
554 | //\r | |
555 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
556 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
557 | StartLabel->Number = Label;\r | |
558 | \r | |
559 | //\r | |
560 | // Create Hii Extend Label OpCode as the end opcode\r | |
561 | //\r | |
562 | EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
563 | EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
564 | EndLabel->Number = 0xffff;\r | |
565 | \r | |
f274810c | 566 | if (AddData) {\r |
567 | if (Data->DataCount != 0) {\r | |
f274810c | 568 | \r |
0368663f | 569 | ThunkContext = UefiHiiHandleToThunkContext (Private, UefiHiiHandle);\r |
a5420536 | 570 | Status = FwUpdateDataToUefiUpdateData (ThunkContext, Data, StartOpCodeHandle);\r |
f274810c | 571 | ASSERT_EFI_ERROR (Status);\r |
572 | \r | |
a5420536 | 573 | Status = HiiUpdateForm (UefiHiiHandle, &FormsetGuid, FormId, StartOpCodeHandle, NULL);\r |
f274810c | 574 | ASSERT_EFI_ERROR (Status);\r |
a5420536 | 575 | }\r |
f274810c | 576 | } else {\r |
f274810c | 577 | //\r |
578 | // Delete Opcode starting from Labe in FormId found\r | |
579 | //\r | |
a5420536 | 580 | Status = HiiUpdateForm (UefiHiiHandle, &FormsetGuid, FormId, StartOpCodeHandle, EndOpCodeHandle);\r |
f274810c | 581 | ASSERT_EFI_ERROR (Status);\r |
582 | }\r | |
583 | \r | |
a5420536 LG |
584 | HiiFreeOpCodeHandle (StartOpCodeHandle);\r |
585 | HiiFreeOpCodeHandle (EndOpCodeHandle);\r | |
586 | \r | |
0368663f | 587 | Done:\r |
99a83b4c | 588 | \r |
0368663f | 589 | mInFrameworkUpdatePakcage = FALSE; \r |
590 | \r | |
591 | gBS->RestoreTPL (OldTpl);\r | |
592 | \r | |
99a83b4c | 593 | return Status;\r |
4259256b | 594 | }\r |