]>
Commit | Line | Data |
---|---|---|
93e3992d | 1 | /** @file\r |
53cf48e0 | 2 | This is an example of how a driver might export data to the HII protocol to be\r |
3 | later utilized by the Setup Protocol\r | |
4 | \r | |
8d00a0f1 | 5 | Copyright (c) 2004 - 2008, Intel Corporation\r |
93e3992d | 6 | All rights reserved. This program and the accompanying materials\r |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
93e3992d | 14 | **/\r |
15 | \r | |
16 | \r | |
17 | #include "DriverSample.h"\r | |
18 | \r | |
7e3bcccb | 19 | #define DISPLAY_ONLY_MY_ITEM 0x0002\r |
93e3992d | 20 | \r |
21 | EFI_GUID mFormSetGuid = FORMSET_GUID;\r | |
22 | EFI_GUID mInventoryGuid = INVENTORY_GUID;\r | |
23 | \r | |
24 | CHAR16 VariableName[] = L"MyIfrNVData";\r | |
de482998 LG |
25 | //\r |
26 | // <ConfigHdr> Template\r | |
27 | //\r | |
28 | CONST CHAR16 mDriverSampleConfigHdr[] = L"GUID=00000000000000000000000000000000&NAME=0000&PATH=00";\r | |
93e3992d | 29 | \r |
2f3065c0 LG |
30 | EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r |
31 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;\r | |
32 | \r | |
33 | HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {\r | |
f6f910dd | 34 | {\r |
35 | {\r | |
36 | HARDWARE_DEVICE_PATH,\r | |
37 | HW_VENDOR_DP,\r | |
38 | {\r | |
39 | (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r | |
40 | (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r | |
41 | }\r | |
42 | },\r | |
43 | //\r | |
44 | // {C153B68D-EBFC-488e-B110-662867745B87}\r | |
45 | //\r | |
46 | { 0xc153b68d, 0xebfc, 0x488e, { 0xb1, 0x10, 0x66, 0x28, 0x67, 0x74, 0x5b, 0x87 } }\r | |
47 | },\r | |
48 | {\r | |
49 | END_DEVICE_PATH_TYPE,\r | |
50 | END_ENTIRE_DEVICE_PATH_SUBTYPE,\r | |
51 | { \r | |
52 | (UINT8) (END_DEVICE_PATH_LENGTH),\r | |
53 | (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r | |
54 | }\r | |
55 | }\r | |
56 | };\r | |
57 | \r | |
2f3065c0 | 58 | HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1 = {\r |
f6f910dd | 59 | {\r |
60 | {\r | |
61 | HARDWARE_DEVICE_PATH,\r | |
62 | HW_VENDOR_DP,\r | |
63 | {\r | |
64 | (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r | |
65 | (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r | |
66 | }\r | |
67 | },\r | |
68 | //\r | |
69 | // {06F37F07-0C48-40e9-8436-0A08A0BB76B0}\r | |
70 | //\r | |
71 | { 0x6f37f07, 0xc48, 0x40e9, { 0x84, 0x36, 0xa, 0x8, 0xa0, 0xbb, 0x76, 0xb0 } }\r | |
72 | },\r | |
73 | {\r | |
74 | END_DEVICE_PATH_TYPE,\r | |
75 | END_ENTIRE_DEVICE_PATH_SUBTYPE,\r | |
76 | { \r | |
77 | (UINT8) (END_DEVICE_PATH_LENGTH),\r | |
78 | (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r | |
79 | }\r | |
80 | }\r | |
81 | };\r | |
82 | \r | |
7064c0a5 | 83 | /**\r |
84 | Encode the password using a simple algorithm.\r | |
85 | \r | |
86 | @param Password The string to be encoded.\r | |
87 | @param MaxSize The size of the string.\r | |
88 | \r | |
89 | **/\r | |
93e3992d | 90 | VOID\r |
91 | EncodePassword (\r | |
92 | IN CHAR16 *Password,\r | |
5a829f56 | 93 | IN UINTN MaxSize\r |
93e3992d | 94 | )\r |
95 | {\r | |
96 | UINTN Index;\r | |
97 | UINTN Loop;\r | |
98 | CHAR16 *Buffer;\r | |
99 | CHAR16 *Key;\r | |
100 | \r | |
101 | Key = L"MAR10648567";\r | |
102 | Buffer = AllocateZeroPool (MaxSize);\r | |
103 | ASSERT (Buffer != NULL);\r | |
104 | \r | |
105 | for (Index = 0; Key[Index] != 0; Index++) {\r | |
106 | for (Loop = 0; Loop < (UINT8) (MaxSize / 2); Loop++) {\r | |
107 | Buffer[Loop] = (CHAR16) (Password[Loop] ^ Key[Index]);\r | |
108 | }\r | |
109 | }\r | |
110 | \r | |
111 | CopyMem (Password, Buffer, MaxSize);\r | |
112 | \r | |
53cf48e0 | 113 | FreePool (Buffer);\r |
93e3992d | 114 | return ;\r |
115 | }\r | |
116 | \r | |
7064c0a5 | 117 | /**\r |
118 | Validate the user's password.\r | |
119 | \r | |
120 | @param PrivateData This driver's private context data.\r | |
121 | @param StringId The user's input.\r | |
122 | \r | |
123 | @retval EFI_SUCCESS The user's input matches the password.\r | |
124 | @retval EFI_NOT_READY The user's input does not match the password.\r | |
125 | **/\r | |
93e3992d | 126 | EFI_STATUS\r |
127 | ValidatePassword (\r | |
7064c0a5 | 128 | IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r |
129 | IN EFI_STRING_ID StringId\r | |
93e3992d | 130 | )\r |
131 | {\r | |
132 | EFI_STATUS Status;\r | |
133 | UINTN Index;\r | |
134 | UINTN BufferSize;\r | |
84f9a9ec | 135 | UINTN PasswordMaxSize;\r |
93e3992d | 136 | CHAR16 *Password;\r |
137 | CHAR16 *EncodedPassword;\r | |
138 | BOOLEAN OldPassword;\r | |
139 | \r | |
140 | //\r | |
141 | // Get encoded password first\r | |
142 | //\r | |
143 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
144 | Status = gRT->GetVariable (\r | |
145 | VariableName,\r | |
146 | &mFormSetGuid,\r | |
147 | NULL,\r | |
148 | &BufferSize,\r | |
149 | &PrivateData->Configuration\r | |
150 | );\r | |
151 | if (EFI_ERROR (Status)) {\r | |
152 | //\r | |
153 | // Old password not exist, prompt for new password\r | |
154 | //\r | |
155 | return EFI_SUCCESS;\r | |
156 | }\r | |
157 | \r | |
158 | OldPassword = FALSE;\r | |
84f9a9ec | 159 | PasswordMaxSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r |
93e3992d | 160 | //\r |
161 | // Check whether we have any old password set\r | |
162 | //\r | |
84f9a9ec | 163 | for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {\r |
93e3992d | 164 | if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {\r |
165 | OldPassword = TRUE;\r | |
166 | break;\r | |
167 | }\r | |
168 | }\r | |
169 | if (!OldPassword) {\r | |
170 | //\r | |
171 | // Old password not exist, return EFI_SUCCESS to prompt for new password\r | |
172 | //\r | |
173 | return EFI_SUCCESS;\r | |
174 | }\r | |
175 | \r | |
176 | //\r | |
177 | // Get user input password\r | |
178 | //\r | |
cb7d01c0 | 179 | Password = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r |
180 | if (Password == NULL) {\r | |
181 | return EFI_NOT_READY;\r | |
182 | }\r | |
84f9a9ec | 183 | if (StrSize (Password) > PasswordMaxSize) {\r |
53cf48e0 | 184 | FreePool (Password);\r |
cb7d01c0 | 185 | return EFI_NOT_READY;\r |
93e3992d | 186 | }\r |
187 | \r | |
188 | //\r | |
189 | // Validate old password\r | |
190 | //\r | |
84f9a9ec | 191 | EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r |
93e3992d | 192 | ASSERT (EncodedPassword != NULL);\r |
84f9a9ec LG |
193 | StrnCpy (EncodedPassword, Password, StrLen (Password));\r |
194 | EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));\r | |
195 | if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, StrLen (EncodedPassword) * sizeof (CHAR16)) != 0) {\r | |
93e3992d | 196 | //\r |
197 | // Old password mismatch, return EFI_NOT_READY to prompt for error message\r | |
198 | //\r | |
199 | Status = EFI_NOT_READY;\r | |
200 | } else {\r | |
201 | Status = EFI_SUCCESS;\r | |
202 | }\r | |
203 | \r | |
53cf48e0 | 204 | FreePool (Password);\r |
205 | FreePool (EncodedPassword);\r | |
93e3992d | 206 | \r |
207 | return Status;\r | |
208 | }\r | |
209 | \r | |
7064c0a5 | 210 | /**\r |
211 | Encode the password using a simple algorithm.\r | |
212 | \r | |
213 | @param PrivateData This driver's private context data.\r | |
214 | @param StringId The password from User.\r | |
215 | \r | |
216 | @retval EFI_SUCESS The operation is successful.\r | |
217 | @return Other value if gRT->SetVariable () fails.\r | |
218 | \r | |
219 | **/\r | |
93e3992d | 220 | EFI_STATUS\r |
221 | SetPassword (\r | |
7064c0a5 | 222 | IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r |
223 | IN EFI_STRING_ID StringId\r | |
93e3992d | 224 | )\r |
225 | {\r | |
226 | EFI_STATUS Status;\r | |
93e3992d | 227 | CHAR16 *Password;\r |
cb7d01c0 | 228 | CHAR16 *TempPassword;\r |
5a829f56 | 229 | UINTN PasswordSize;\r |
93e3992d | 230 | DRIVER_SAMPLE_CONFIGURATION *Configuration;\r |
7e3bcccb | 231 | UINTN BufferSize;\r |
93e3992d | 232 | \r |
233 | //\r | |
234 | // Get Buffer Storage data from EFI variable\r | |
235 | //\r | |
236 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
237 | Status = gRT->GetVariable (\r | |
238 | VariableName,\r | |
239 | &mFormSetGuid,\r | |
240 | NULL,\r | |
241 | &BufferSize,\r | |
242 | &PrivateData->Configuration\r | |
243 | );\r | |
244 | if (EFI_ERROR (Status)) {\r | |
245 | return Status;\r | |
246 | }\r | |
247 | \r | |
248 | //\r | |
249 | // Get user input password\r | |
250 | //\r | |
251 | Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r | |
cb7d01c0 | 252 | PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2); \r |
5a829f56 | 253 | ZeroMem (Password, PasswordSize);\r |
cb7d01c0 | 254 | \r |
255 | TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r | |
256 | if (TempPassword == NULL) {\r | |
257 | return EFI_NOT_READY;\r | |
258 | }\r | |
84f9a9ec | 259 | if (StrSize (TempPassword) > PasswordSize) {\r |
cb7d01c0 | 260 | FreePool (TempPassword);\r |
261 | return EFI_NOT_READY;\r | |
93e3992d | 262 | }\r |
84f9a9ec | 263 | StrnCpy (Password, TempPassword, StrLen (TempPassword));\r |
cb7d01c0 | 264 | FreePool (TempPassword);\r |
93e3992d | 265 | \r |
266 | //\r | |
267 | // Retrive uncommitted data from Browser\r | |
268 | //\r | |
1d451ff9 LG |
269 | Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r |
270 | ASSERT (Configuration != NULL);\r | |
271 | if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r | |
93e3992d | 272 | //\r |
273 | // Update password's clear text in the screen\r | |
274 | //\r | |
84f9a9ec | 275 | CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r |
93e3992d | 276 | \r |
277 | //\r | |
278 | // Update uncommitted data of Browser\r | |
279 | //\r | |
7e3bcccb LG |
280 | HiiSetBrowserData (\r |
281 | &mFormSetGuid,\r | |
282 | VariableName,\r | |
283 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
284 | (UINT8 *) Configuration,\r | |
285 | NULL\r | |
286 | );\r | |
93e3992d | 287 | }\r |
7e3bcccb | 288 | \r |
1d451ff9 LG |
289 | //\r |
290 | // Free Configuration Buffer\r | |
291 | //\r | |
292 | FreePool (Configuration);\r | |
293 | \r | |
93e3992d | 294 | \r |
295 | //\r | |
296 | // Set password\r | |
297 | //\r | |
84f9a9ec | 298 | EncodePassword (Password, StrLen (Password) * 2);\r |
93e3992d | 299 | Status = gRT->SetVariable(\r |
300 | VariableName,\r | |
301 | &mFormSetGuid,\r | |
302 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
303 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
304 | &PrivateData->Configuration\r | |
305 | );\r | |
306 | return Status;\r | |
307 | }\r | |
308 | \r | |
309 | \r | |
310 | /**\r | |
311 | This function allows a caller to extract the current configuration for one\r | |
312 | or more named elements from the target driver.\r | |
313 | \r | |
314 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
315 | @param Request A null-terminated Unicode string in\r | |
316 | <ConfigRequest> format.\r | |
317 | @param Progress On return, points to a character in the Request\r | |
318 | string. Points to the string's null terminator if\r | |
319 | request was successful. Points to the most recent\r | |
320 | '&' before the first failing name/value pair (or\r | |
321 | the beginning of the string if the failure is in\r | |
322 | the first name/value pair) if the request was not\r | |
323 | successful.\r | |
324 | @param Results A null-terminated Unicode string in\r | |
325 | <ConfigAltResp> format which has all values filled\r | |
326 | in for the names in the Request string. String to\r | |
327 | be allocated by the called function.\r | |
328 | \r | |
329 | @retval EFI_SUCCESS The Results is filled with the requested values.\r | |
330 | @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r | |
331 | @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r | |
332 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r | |
333 | driver.\r | |
334 | \r | |
335 | **/\r | |
336 | EFI_STATUS\r | |
337 | EFIAPI\r | |
338 | ExtractConfig (\r | |
339 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
340 | IN CONST EFI_STRING Request,\r | |
341 | OUT EFI_STRING *Progress,\r | |
342 | OUT EFI_STRING *Results\r | |
343 | )\r | |
344 | {\r | |
345 | EFI_STATUS Status;\r | |
346 | UINTN BufferSize;\r | |
347 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
348 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
84f9a9ec LG |
349 | EFI_STRING ConfigRequest;\r |
350 | UINTN Size;\r | |
ae79d2f9 LG |
351 | \r |
352 | if (Progress == NULL || Results == NULL) {\r | |
353 | return EFI_INVALID_PARAMETER;\r | |
354 | }\r | |
84f9a9ec LG |
355 | //\r |
356 | // Initialize the local variables.\r | |
357 | //\r | |
84f9a9ec LG |
358 | ConfigRequest = NULL;\r |
359 | Size = 0;\r | |
360 | *Progress = Request;\r | |
93e3992d | 361 | \r |
362 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r | |
363 | HiiConfigRouting = PrivateData->HiiConfigRouting;\r | |
364 | \r | |
8d00a0f1 | 365 | //\r |
84f9a9ec LG |
366 | // Get Buffer Storage data from EFI variable.\r |
367 | // Try to get the current setting from variable.\r | |
93e3992d | 368 | //\r |
369 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
04da0b4a LG |
370 | Status = gRT->GetVariable (\r |
371 | VariableName,\r | |
372 | &mFormSetGuid,\r | |
373 | NULL,\r | |
374 | &BufferSize,\r | |
375 | &PrivateData->Configuration\r | |
376 | );\r | |
377 | if (EFI_ERROR (Status)) {\r | |
de482998 | 378 | return EFI_NOT_FOUND;\r |
04da0b4a | 379 | }\r |
84f9a9ec | 380 | \r |
8d00a0f1 | 381 | if (Request == NULL) {\r |
382 | //\r | |
84f9a9ec | 383 | // Request is set to NULL, construct full request string.\r |
7e3bcccb | 384 | //\r |
84f9a9ec | 385 | \r |
84f9a9ec LG |
386 | //\r |
387 | // Allocate and fill a buffer large enough to hold the <ConfigHdr> template \r | |
388 | // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r | |
389 | //\r | |
de482998 | 390 | Size = (StrLen (mDriverSampleConfigHdr) + 32 + 1) * sizeof (CHAR16);\r |
84f9a9ec | 391 | ConfigRequest = AllocateZeroPool (Size);\r |
de482998 | 392 | UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", mDriverSampleConfigHdr, (UINT64)BufferSize);\r |
84f9a9ec | 393 | } else {\r |
de482998 LG |
394 | //\r |
395 | // Check routing data in <ConfigHdr>.\r | |
396 | // Note: if only one Storage is used, then this checking could be skipped.\r | |
397 | //\r | |
398 | if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, VariableName)) {\r | |
399 | return EFI_NOT_FOUND;\r | |
84f9a9ec | 400 | }\r |
de482998 | 401 | ConfigRequest = Request;\r |
8d00a0f1 | 402 | }\r |
403 | \r | |
93e3992d | 404 | //\r |
405 | // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r | |
406 | //\r | |
407 | Status = HiiConfigRouting->BlockToConfig (\r | |
408 | HiiConfigRouting,\r | |
84f9a9ec | 409 | ConfigRequest,\r |
93e3992d | 410 | (UINT8 *) &PrivateData->Configuration,\r |
411 | BufferSize,\r | |
412 | Results,\r | |
413 | Progress\r | |
414 | );\r | |
84f9a9ec LG |
415 | \r |
416 | if (Request == NULL) {\r | |
417 | FreePool (ConfigRequest);\r | |
1f1cb2f2 | 418 | *Progress = NULL;\r |
84f9a9ec LG |
419 | }\r |
420 | \r | |
93e3992d | 421 | return Status;\r |
422 | }\r | |
423 | \r | |
424 | \r | |
425 | /**\r | |
426 | This function processes the results of changes in configuration.\r | |
427 | \r | |
428 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
429 | @param Configuration A null-terminated Unicode string in <ConfigResp>\r | |
430 | format.\r | |
431 | @param Progress A pointer to a string filled in with the offset of\r | |
432 | the most recent '&' before the first failing\r | |
433 | name/value pair (or the beginning of the string if\r | |
434 | the failure is in the first name/value pair) or\r | |
435 | the terminating NULL if all was successful.\r | |
436 | \r | |
437 | @retval EFI_SUCCESS The Results is processed successfully.\r | |
438 | @retval EFI_INVALID_PARAMETER Configuration is NULL.\r | |
439 | @retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r | |
440 | driver.\r | |
441 | \r | |
442 | **/\r | |
443 | EFI_STATUS\r | |
444 | EFIAPI\r | |
445 | RouteConfig (\r | |
446 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
447 | IN CONST EFI_STRING Configuration,\r | |
448 | OUT EFI_STRING *Progress\r | |
449 | )\r | |
450 | {\r | |
451 | EFI_STATUS Status;\r | |
452 | UINTN BufferSize;\r | |
453 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
454 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
455 | \r | |
8d00a0f1 | 456 | if (Configuration == NULL) {\r |
457 | return EFI_INVALID_PARAMETER;\r | |
458 | }\r | |
459 | \r | |
93e3992d | 460 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r |
461 | HiiConfigRouting = PrivateData->HiiConfigRouting;\r | |
462 | \r | |
84f9a9ec | 463 | //\r |
8d00a0f1 | 464 | // Check routing data in <ConfigHdr>.\r |
465 | // Note: if only one Storage is used, then this checking could be skipped.\r | |
466 | //\r | |
7e3bcccb | 467 | if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, VariableName)) {\r |
8d00a0f1 | 468 | *Progress = Configuration;\r |
469 | return EFI_NOT_FOUND;\r | |
470 | }\r | |
471 | \r | |
93e3992d | 472 | //\r |
473 | // Get Buffer Storage data from EFI variable\r | |
474 | //\r | |
475 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
04da0b4a LG |
476 | Status = gRT->GetVariable (\r |
477 | VariableName,\r | |
478 | &mFormSetGuid,\r | |
479 | NULL,\r | |
480 | &BufferSize,\r | |
481 | &PrivateData->Configuration\r | |
482 | );\r | |
483 | if (EFI_ERROR (Status)) {\r | |
484 | return Status;\r | |
485 | }\r | |
93e3992d | 486 | \r |
487 | //\r | |
488 | // Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r | |
489 | //\r | |
490 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r | |
491 | Status = HiiConfigRouting->ConfigToBlock (\r | |
492 | HiiConfigRouting,\r | |
493 | Configuration,\r | |
494 | (UINT8 *) &PrivateData->Configuration,\r | |
495 | &BufferSize,\r | |
496 | Progress\r | |
497 | );\r | |
498 | if (EFI_ERROR (Status)) {\r | |
499 | return Status;\r | |
500 | }\r | |
501 | \r | |
502 | //\r | |
503 | // Store Buffer Storage back to EFI variable\r | |
504 | //\r | |
505 | Status = gRT->SetVariable(\r | |
506 | VariableName,\r | |
507 | &mFormSetGuid,\r | |
508 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
509 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
510 | &PrivateData->Configuration\r | |
511 | );\r | |
512 | \r | |
513 | return Status;\r | |
514 | }\r | |
515 | \r | |
516 | \r | |
517 | /**\r | |
518 | This function processes the results of changes in configuration.\r | |
519 | \r | |
520 | @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r | |
521 | @param Action Specifies the type of action taken by the browser.\r | |
522 | @param QuestionId A unique value which is sent to the original\r | |
523 | exporting driver so that it can identify the type\r | |
524 | of data to expect.\r | |
525 | @param Type The type of value for the question.\r | |
526 | @param Value A pointer to the data being sent to the original\r | |
527 | exporting driver.\r | |
528 | @param ActionRequest On return, points to the action requested by the\r | |
529 | callback function.\r | |
530 | \r | |
531 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
532 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the\r | |
533 | variable and its data.\r | |
534 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
535 | @retval EFI_UNSUPPORTED The specified Action is not supported by the\r | |
536 | callback.\r | |
537 | \r | |
538 | **/\r | |
539 | EFI_STATUS\r | |
540 | EFIAPI\r | |
541 | DriverCallback (\r | |
542 | IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r | |
543 | IN EFI_BROWSER_ACTION Action,\r | |
544 | IN EFI_QUESTION_ID QuestionId,\r | |
545 | IN UINT8 Type,\r | |
546 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
547 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
548 | )\r | |
549 | {\r | |
550 | DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r | |
551 | EFI_STATUS Status;\r | |
8d00a0f1 | 552 | UINT8 MyVar;\r |
7e3bcccb LG |
553 | VOID *StartOpCodeHandle;\r |
554 | VOID *OptionsOpCodeHandle;\r | |
555 | EFI_IFR_GUID_LABEL *StartLabel;\r | |
556 | VOID *EndOpCodeHandle;\r | |
557 | EFI_IFR_GUID_LABEL *EndLabel;\r | |
93e3992d | 558 | \r |
559 | if ((Value == NULL) || (ActionRequest == NULL)) {\r | |
560 | return EFI_INVALID_PARAMETER;\r | |
561 | }\r | |
84f9a9ec LG |
562 | \r |
563 | if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0)) {\r | |
564 | return EFI_INVALID_PARAMETER;\r | |
565 | }\r | |
566 | \r | |
93e3992d | 567 | \r |
568 | Status = EFI_SUCCESS;\r | |
569 | PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r | |
570 | \r | |
571 | switch (QuestionId) {\r | |
572 | case 0x1234:\r | |
573 | //\r | |
8d00a0f1 | 574 | // Initialize the container for dynamic opcodes\r |
93e3992d | 575 | //\r |
7e3bcccb LG |
576 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r |
577 | ASSERT (StartOpCodeHandle != NULL);\r | |
578 | \r | |
579 | EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
580 | ASSERT (EndOpCodeHandle != NULL);\r | |
581 | \r | |
582 | //\r | |
583 | // Create Hii Extend Label OpCode as the start opcode\r | |
584 | //\r | |
585 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
586 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
587 | StartLabel->Number = LABEL_UPDATE1;\r | |
588 | \r | |
589 | //\r | |
590 | // Create Hii Extend Label OpCode as the end opcode\r | |
591 | //\r | |
592 | EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
593 | EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
594 | EndLabel->Number = LABEL_END;\r | |
595 | \r | |
596 | HiiCreateActionOpCode (\r | |
597 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
598 | 0x1237, // Question ID\r | |
599 | STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r | |
600 | STRING_TOKEN(STR_EXIT_TEXT), // Help text\r | |
601 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
602 | 0 // Action String ID\r | |
603 | );\r | |
604 | \r | |
605 | //\r | |
606 | // Create Option OpCode\r | |
607 | //\r | |
608 | OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
609 | ASSERT (OptionsOpCodeHandle != NULL);\r | |
610 | \r | |
611 | HiiCreateOneOfOptionOpCode (\r | |
612 | OptionsOpCodeHandle,\r | |
613 | STRING_TOKEN (STR_BOOT_OPTION1),\r | |
614 | 0,\r | |
615 | EFI_IFR_NUMERIC_SIZE_1,\r | |
616 | 1\r | |
617 | );\r | |
618 | \r | |
619 | HiiCreateOneOfOptionOpCode (\r | |
620 | OptionsOpCodeHandle,\r | |
621 | STRING_TOKEN (STR_BOOT_OPTION2),\r | |
622 | 0,\r | |
623 | EFI_IFR_NUMERIC_SIZE_1,\r | |
624 | 2\r | |
625 | );\r | |
626 | \r | |
627 | //\r | |
628 | // Prepare initial value for the dynamic created oneof Question\r | |
629 | //\r | |
630 | PrivateData->Configuration.DynamicOneof = 2;\r | |
631 | Status = gRT->SetVariable(\r | |
632 | VariableName,\r | |
633 | &mFormSetGuid,\r | |
634 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
635 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
636 | &PrivateData->Configuration\r | |
637 | );\r | |
638 | \r | |
639 | HiiCreateOneOfOpCode (\r | |
640 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
641 | 0x8001, // Question ID (or call it "key")\r | |
642 | CONFIGURATION_VARSTORE_ID, // VarStore ID\r | |
643 | (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage\r | |
644 | STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text\r | |
645 | STRING_TOKEN (STR_ONE_OF_HELP), // Question help text\r | |
646 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
647 | EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value\r | |
648 | OptionsOpCodeHandle, // Option Opcode list\r | |
649 | NULL // Default Opcode is NULl\r | |
650 | );\r | |
651 | \r | |
652 | HiiCreateOrderedListOpCode (\r | |
653 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
654 | 0x8002, // Question ID\r | |
655 | CONFIGURATION_VARSTORE_ID, // VarStore ID\r | |
656 | (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage\r | |
657 | STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text\r | |
658 | STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text\r | |
659 | EFI_IFR_FLAG_RESET_REQUIRED, // Question flag\r | |
660 | 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET\r | |
661 | EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value\r | |
662 | 5, // Maximum container\r | |
663 | OptionsOpCodeHandle, // Option Opcode list\r | |
664 | NULL // Default Opcode is NULl\r | |
665 | );\r | |
666 | \r | |
667 | HiiCreateGotoOpCode (\r | |
668 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
669 | 1, // Target Form ID\r | |
670 | STRING_TOKEN (STR_GOTO_FORM1), // Prompt text\r | |
671 | STRING_TOKEN (STR_GOTO_HELP), // Help text\r | |
672 | 0, // Question flag\r | |
673 | 0x8003 // Question ID\r | |
674 | );\r | |
675 | \r | |
676 | HiiUpdateForm (\r | |
677 | PrivateData->HiiHandle[0], // HII handle\r | |
678 | &mFormSetGuid, // Formset GUID\r | |
679 | 0x1234, // Form ID\r | |
680 | StartOpCodeHandle, // Label for where to insert opcodes\r | |
681 | EndOpCodeHandle // Replace data\r | |
682 | );\r | |
683 | \r | |
684 | HiiFreeOpCodeHandle (StartOpCodeHandle);\r | |
685 | HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r | |
686 | break;\r | |
8d00a0f1 | 687 | \r |
7e3bcccb LG |
688 | case 0x5678:\r |
689 | //\r | |
690 | // We will reach here once the Question is refreshed\r | |
691 | //\r | |
692 | \r | |
693 | //\r | |
694 | // Initialize the container for dynamic opcodes\r | |
695 | //\r | |
696 | StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r | |
697 | ASSERT (StartOpCodeHandle != NULL);\r | |
698 | \r | |
699 | //\r | |
700 | // Create Hii Extend Label OpCode as the start opcode\r | |
701 | //\r | |
702 | StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r | |
703 | StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r | |
704 | StartLabel->Number = LABEL_UPDATE2;\r | |
705 | \r | |
706 | HiiCreateActionOpCode (\r | |
707 | StartOpCodeHandle, // Container for dynamic created opcodes\r | |
708 | 0x1237, // Question ID\r | |
709 | STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r | |
710 | STRING_TOKEN(STR_EXIT_TEXT), // Help text\r | |
711 | EFI_IFR_FLAG_CALLBACK, // Question flag\r | |
712 | 0 // Action String ID\r | |
713 | );\r | |
8d00a0f1 | 714 | \r |
7e3bcccb LG |
715 | HiiUpdateForm (\r |
716 | PrivateData->HiiHandle[0], // HII handle\r | |
717 | &mFormSetGuid, // Formset GUID\r | |
718 | 0x3, // Form ID\r | |
719 | StartOpCodeHandle, // Label for where to insert opcodes\r | |
720 | NULL // Insert data\r | |
721 | );\r | |
722 | \r | |
723 | HiiFreeOpCodeHandle (StartOpCodeHandle); \r | |
724 | \r | |
725 | //\r | |
726 | // Refresh the Question value\r | |
727 | //\r | |
728 | PrivateData->Configuration.DynamicRefresh++;\r | |
729 | Status = gRT->SetVariable(\r | |
730 | VariableName,\r | |
731 | &mFormSetGuid,\r | |
732 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
733 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
734 | &PrivateData->Configuration\r | |
735 | );\r | |
736 | \r | |
737 | //\r | |
738 | // Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause\r | |
739 | // the first statement in Form 3 be suppressed\r | |
740 | //\r | |
741 | MyVar = 111;\r | |
742 | Status = gRT->SetVariable(\r | |
743 | L"MyVar",\r | |
744 | &mFormSetGuid,\r | |
745 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
746 | 1,\r | |
747 | &MyVar\r | |
748 | );\r | |
93e3992d | 749 | break;\r |
750 | \r | |
751 | case 0x1237:\r | |
752 | //\r | |
753 | // User press "Exit now", request Browser to exit\r | |
754 | //\r | |
755 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r | |
756 | break;\r | |
757 | \r | |
758 | case 0x1238:\r | |
759 | //\r | |
760 | // User press "Save now", request Browser to save the uncommitted data.\r | |
761 | //\r | |
762 | *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r | |
763 | break;\r | |
764 | \r | |
765 | case 0x2000:\r | |
766 | //\r | |
767 | // When try to set a new password, user will be chanlleged with old password.\r | |
768 | // The Callback is responsible for validating old password input by user,\r | |
769 | // If Callback return EFI_SUCCESS, it indicates validation pass.\r | |
770 | //\r | |
771 | switch (PrivateData->PasswordState) {\r | |
772 | case BROWSER_STATE_VALIDATE_PASSWORD:\r | |
773 | Status = ValidatePassword (PrivateData, Value->string);\r | |
774 | if (Status == EFI_SUCCESS) {\r | |
775 | PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;\r | |
776 | }\r | |
777 | break;\r | |
778 | \r | |
779 | case BROWSER_STATE_SET_PASSWORD:\r | |
780 | Status = SetPassword (PrivateData, Value->string);\r | |
781 | PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r | |
782 | break;\r | |
783 | \r | |
784 | default:\r | |
785 | break;\r | |
786 | }\r | |
787 | \r | |
788 | break;\r | |
789 | \r | |
790 | default:\r | |
791 | break;\r | |
792 | }\r | |
793 | \r | |
794 | return Status;\r | |
795 | }\r | |
796 | \r | |
7064c0a5 | 797 | /**\r |
798 | Main entry for this driver.\r | |
799 | \r | |
800 | @param ImageHandle Image handle this driver.\r | |
801 | @param SystemTable Pointer to SystemTable.\r | |
802 | \r | |
803 | @retval EFI_SUCESS This function always complete successfully.\r | |
804 | \r | |
805 | **/\r | |
93e3992d | 806 | EFI_STATUS\r |
807 | EFIAPI\r | |
808 | DriverSampleInit (\r | |
809 | IN EFI_HANDLE ImageHandle,\r | |
810 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
811 | )\r | |
812 | {\r | |
813 | EFI_STATUS Status;\r | |
93e3992d | 814 | EFI_HII_HANDLE HiiHandle[2];\r |
93e3992d | 815 | EFI_SCREEN_DESCRIPTOR Screen;\r |
816 | EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r | |
817 | EFI_HII_STRING_PROTOCOL *HiiString;\r | |
818 | EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r | |
819 | EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r | |
820 | CHAR16 *NewString;\r | |
821 | UINTN BufferSize;\r | |
822 | DRIVER_SAMPLE_CONFIGURATION *Configuration;\r | |
84f9a9ec LG |
823 | BOOLEAN ActionFlag;\r |
824 | EFI_STRING ConfigRequestHdr; \r | |
93e3992d | 825 | \r |
826 | //\r | |
84f9a9ec | 827 | // Initialize the local variables.\r |
93e3992d | 828 | //\r |
84f9a9ec | 829 | ConfigRequestHdr = NULL;\r |
93e3992d | 830 | //\r |
831 | // Initialize screen dimensions for SendForm().\r | |
832 | // Remove 3 characters from top and bottom\r | |
833 | //\r | |
834 | ZeroMem (&Screen, sizeof (EFI_SCREEN_DESCRIPTOR));\r | |
835 | gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &Screen.RightColumn, &Screen.BottomRow);\r | |
836 | \r | |
837 | Screen.TopRow = 3;\r | |
838 | Screen.BottomRow = Screen.BottomRow - 3;\r | |
839 | \r | |
840 | //\r | |
841 | // Initialize driver private data\r | |
842 | //\r | |
843 | PrivateData = AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r | |
844 | if (PrivateData == NULL) {\r | |
845 | return EFI_OUT_OF_RESOURCES;\r | |
846 | }\r | |
847 | \r | |
848 | PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r | |
849 | \r | |
850 | PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r | |
851 | PrivateData->ConfigAccess.RouteConfig = RouteConfig;\r | |
852 | PrivateData->ConfigAccess.Callback = DriverCallback;\r | |
853 | PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r | |
854 | \r | |
855 | //\r | |
856 | // Locate Hii Database protocol\r | |
857 | //\r | |
858 | Status = gBS->LocateProtocol (&gEfiHiiDatabaseProtocolGuid, NULL, (VOID **) &HiiDatabase);\r | |
859 | if (EFI_ERROR (Status)) {\r | |
860 | return Status;\r | |
861 | }\r | |
862 | PrivateData->HiiDatabase = HiiDatabase;\r | |
863 | \r | |
864 | //\r | |
865 | // Locate HiiString protocol\r | |
866 | //\r | |
867 | Status = gBS->LocateProtocol (&gEfiHiiStringProtocolGuid, NULL, (VOID **) &HiiString);\r | |
868 | if (EFI_ERROR (Status)) {\r | |
869 | return Status;\r | |
870 | }\r | |
871 | PrivateData->HiiString = HiiString;\r | |
872 | \r | |
873 | //\r | |
874 | // Locate Formbrowser2 protocol\r | |
875 | //\r | |
876 | Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &FormBrowser2);\r | |
877 | if (EFI_ERROR (Status)) {\r | |
878 | return Status;\r | |
879 | }\r | |
880 | PrivateData->FormBrowser2 = FormBrowser2;\r | |
881 | \r | |
882 | //\r | |
883 | // Locate ConfigRouting protocol\r | |
884 | //\r | |
885 | Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &HiiConfigRouting);\r | |
886 | if (EFI_ERROR (Status)) {\r | |
887 | return Status;\r | |
888 | }\r | |
889 | PrivateData->HiiConfigRouting = HiiConfigRouting;\r | |
890 | \r | |
f6f910dd | 891 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
93e3992d | 892 | &DriverHandle[0],\r |
f6f910dd | 893 | &gEfiDevicePathProtocolGuid,\r |
2f3065c0 | 894 | &mHiiVendorDevicePath0,\r |
93e3992d | 895 | &gEfiHiiConfigAccessProtocolGuid,\r |
f6f910dd | 896 | &PrivateData->ConfigAccess,\r |
897 | NULL\r | |
93e3992d | 898 | );\r |
899 | ASSERT_EFI_ERROR (Status);\r | |
900 | \r | |
f6f910dd | 901 | PrivateData->DriverHandle[0] = DriverHandle[0];\r |
902 | \r | |
93e3992d | 903 | //\r |
904 | // Publish our HII data\r | |
905 | //\r | |
cb7d01c0 | 906 | HiiHandle[0] = HiiAddPackages (\r |
907 | &mFormSetGuid,\r | |
908 | DriverHandle[0],\r | |
909 | DriverSampleStrings,\r | |
910 | VfrBin,\r | |
911 | NULL\r | |
912 | );\r | |
913 | if (HiiHandle[0] == NULL) {\r | |
93e3992d | 914 | return EFI_OUT_OF_RESOURCES;\r |
915 | }\r | |
916 | \r | |
93e3992d | 917 | PrivateData->HiiHandle[0] = HiiHandle[0];\r |
918 | \r | |
919 | //\r | |
920 | // Publish another Fromset\r | |
921 | //\r | |
f6f910dd | 922 | Status = gBS->InstallMultipleProtocolInterfaces (\r |
923 | &DriverHandle[1],\r | |
924 | &gEfiDevicePathProtocolGuid,\r | |
2f3065c0 | 925 | &mHiiVendorDevicePath1,\r |
f6f910dd | 926 | NULL\r |
927 | );\r | |
928 | ASSERT_EFI_ERROR (Status);\r | |
929 | \r | |
93e3992d | 930 | PrivateData->DriverHandle[1] = DriverHandle[1];\r |
931 | \r | |
cb7d01c0 | 932 | HiiHandle[1] = HiiAddPackages (\r |
933 | &mInventoryGuid,\r | |
934 | DriverHandle[1],\r | |
935 | DriverSampleStrings,\r | |
936 | InventoryBin,\r | |
937 | NULL\r | |
938 | );\r | |
939 | if (HiiHandle[1] == NULL) {\r | |
93e3992d | 940 | return EFI_OUT_OF_RESOURCES;\r |
941 | }\r | |
942 | \r | |
93e3992d | 943 | PrivateData->HiiHandle[1] = HiiHandle[1];\r |
944 | \r | |
945 | //\r | |
946 | // Very simple example of how one would update a string that is already\r | |
947 | // in the HII database\r | |
948 | //\r | |
949 | NewString = L"700 Mhz";\r | |
950 | \r | |
cb7d01c0 | 951 | if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {\r |
952 | return EFI_OUT_OF_RESOURCES;\r | |
93e3992d | 953 | }\r |
954 | \r | |
955 | //\r | |
956 | // Initialize configuration data\r | |
957 | //\r | |
958 | Configuration = &PrivateData->Configuration;\r | |
959 | ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r | |
960 | \r | |
961 | //\r | |
962 | // Try to read NV config EFI variable first\r | |
963 | //\r | |
84f9a9ec LG |
964 | ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r |
965 | ASSERT (ConfigRequestHdr != NULL);\r | |
966 | \r | |
93e3992d | 967 | BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r |
968 | Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r | |
84f9a9ec | 969 | if (EFI_ERROR (Status)) {\r |
04da0b4a LG |
970 | //\r |
971 | // Store zero data Buffer Storage to EFI variable\r | |
972 | //\r | |
973 | Status = gRT->SetVariable(\r | |
974 | VariableName,\r | |
975 | &mFormSetGuid,\r | |
976 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
977 | sizeof (DRIVER_SAMPLE_CONFIGURATION),\r | |
978 | Configuration\r | |
979 | );\r | |
980 | ASSERT (Status == EFI_SUCCESS);\r | |
93e3992d | 981 | //\r |
982 | // EFI variable for NV config doesn't exit, we should build this variable\r | |
983 | // based on default values stored in IFR\r | |
984 | //\r | |
84f9a9ec LG |
985 | ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r |
986 | ASSERT (ActionFlag);\r | |
987 | } else {\r | |
988 | //\r | |
989 | // EFI variable does exist and Validate Current Setting\r | |
990 | //\r | |
991 | ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r | |
992 | ASSERT (ActionFlag);\r | |
93e3992d | 993 | }\r |
84f9a9ec LG |
994 | \r |
995 | FreePool (ConfigRequestHdr);\r | |
996 | \r | |
93e3992d | 997 | \r |
998 | //\r | |
84f9a9ec | 999 | // In default, this driver is built into Flash device image, \r |
7e3bcccb | 1000 | // the following code doesn't run.\r |
93e3992d | 1001 | //\r |
7e3bcccb | 1002 | \r |
2f3065c0 | 1003 | //\r |
7e3bcccb LG |
1004 | // Example of how to display only the item we sent to HII\r |
1005 | // When this driver is not built into Flash device image, \r | |
1006 | // it need to call SendForm to show front page by itself.\r | |
2f3065c0 | 1007 | //\r |
7e3bcccb LG |
1008 | if (DISPLAY_ONLY_MY_ITEM <= 1) {\r |
1009 | //\r | |
1010 | // Have the browser pull out our copy of the data, and only display our data\r | |
1011 | //\r | |
1012 | Status = FormBrowser2->SendForm (\r | |
1013 | FormBrowser2,\r | |
1014 | &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),\r | |
1015 | 1,\r | |
1016 | NULL,\r | |
1017 | 0,\r | |
1018 | NULL,\r | |
1019 | NULL\r | |
1020 | );\r | |
7e3bcccb | 1021 | \r |
14d59fa1 | 1022 | HiiRemovePackages (HiiHandle[0]);\r |
7e3bcccb | 1023 | \r |
14d59fa1 | 1024 | HiiRemovePackages (HiiHandle[1]);\r |
2f3065c0 LG |
1025 | }\r |
1026 | \r | |
84f9a9ec | 1027 | return EFI_SUCCESS;\r |
2f3065c0 LG |
1028 | }\r |
1029 | \r | |
1030 | /**\r | |
1031 | Unloads the application and its installed protocol.\r | |
1032 | \r | |
1033 | @param[in] ImageHandle Handle that identifies the image to be unloaded.\r | |
1034 | \r | |
1035 | @retval EFI_SUCCESS The image has been unloaded.\r | |
1036 | **/\r | |
1037 | EFI_STATUS\r | |
1038 | EFIAPI\r | |
1039 | DriverSampleUnload (\r | |
1040 | IN EFI_HANDLE ImageHandle\r | |
1041 | )\r | |
1042 | {\r | |
1043 | if (DriverHandle[0] != NULL) {\r | |
1044 | gBS->UninstallMultipleProtocolInterfaces (\r | |
1045 | DriverHandle[0],\r | |
1046 | &gEfiDevicePathProtocolGuid,\r | |
1047 | &mHiiVendorDevicePath0,\r | |
1048 | &gEfiHiiConfigAccessProtocolGuid,\r | |
1049 | &PrivateData->ConfigAccess,\r | |
1050 | NULL\r | |
1051 | );\r | |
1052 | }\r | |
1053 | \r | |
1054 | if (DriverHandle[1] != NULL) {\r | |
1055 | gBS->UninstallMultipleProtocolInterfaces (\r | |
1056 | DriverHandle[1],\r | |
1057 | &gEfiDevicePathProtocolGuid,\r | |
1058 | &mHiiVendorDevicePath1,\r | |
1059 | NULL\r | |
1060 | );\r | |
1061 | }\r | |
1062 | \r | |
14d59fa1 LG |
1063 | if (PrivateData->HiiHandle[0] != NULL) {\r |
1064 | HiiRemovePackages (PrivateData->HiiHandle[0]);\r | |
1065 | }\r | |
1066 | \r | |
1067 | if (PrivateData->HiiHandle[1] != NULL) {\r | |
1068 | HiiRemovePackages (PrivateData->HiiHandle[1]);\r | |
1069 | }\r | |
1070 | \r | |
2f3065c0 LG |
1071 | if (PrivateData != NULL) {\r |
1072 | FreePool (PrivateData);\r | |
93e3992d | 1073 | }\r |
1074 | \r | |
1075 | return EFI_SUCCESS;\r | |
1076 | }\r |