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