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